bolt v4 #2254
bolt v4 #2254
Conversation
filmaj
added
semver:major
draft
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2254 +/- ##
===========================================
+ Coverage 81.21% 92.47% +11.26%
===========================================
Files 21 36 +15
Lines 1799 7453 +5654
Branches 498 646 +148
===========================================
+ Hits 1461 6892 +5431
- Misses 218 553 +335
+ Partials 120 8 -112 ☔ View full report in Codecov by Sentry. |
filmaj
removed
the
draft
| // Filter out any non-actions | ||
| if (action === undefined) { | ||
| return; | ||
| export const onlyActions: Middleware<AnyMiddlewareArgs> = async (args) => { |
There was a problem hiding this comment.
Breaking change: no longer need to call this as onlyActions(), instead, it is a middleware itself and can be simply passed as onlyActions. The wrapping closure within was unnecessary. This lines it up with other, non-parameterized middleware in this module.
| if (action === undefined) { | ||
| return; | ||
| export const onlyActions: Middleware<AnyMiddlewareArgs> = async (args) => { | ||
| if ('action' in args && args.action) { |
There was a problem hiding this comment.
Instead of casting, in TS we should be using more of 'property' in object style checks and let TS do the type narrowing for us.
| // Filter out any non-shortcuts | ||
| if (shortcut === undefined) { | ||
| return; | ||
| export const onlyShortcuts: Middleware<AnyMiddlewareArgs> = async (args) => { |
There was a problem hiding this comment.
Another breaking change: this is a middleware, no need for extra internal closure.
| // Filter out any non-commands | ||
| if (command === undefined) { | ||
| return; | ||
| export const onlyCommands: Middleware<AnyMiddlewareArgs> = async (args) => { |
There was a problem hiding this comment.
Same deal! This is middleware, remove internal closure.
| // Filter out any non-options requests | ||
| if (options === undefined) { | ||
| return; | ||
| export const onlyOptions: Middleware<AnyMiddlewareArgs> = async (args) => { |
There was a problem hiding this comment.
Broken record: middleware, remove internal closure.
| // Filter out any non-events | ||
| if (event === undefined) { | ||
| return; | ||
| export const onlyEvents: Middleware<AnyMiddlewareArgs> = async (args) => { |
There was a problem hiding this comment.
You guessed it: middleware, 🔪 closure
| // Filter out anything that doesn't have a view | ||
| if (view === undefined) { | ||
| return; | ||
| export const onlyViewActions: Middleware<AnyMiddlewareArgs> = async (args) => { |
| return; | ||
| } | ||
| } | ||
| export const ignoreSelf: Middleware<AnyMiddlewareArgs> = async (args) => { |
There was a problem hiding this comment.
Same: 🔪 internal closure since we don't use any of the outer function's parameters.
| if (isMessageEventArgs(args)) { | ||
| const { message } = args; | ||
| // Look for an event that is identified as a bot message from the same bot ID as this app, and return to skip | ||
| if (message.subtype === 'bot_message' && message.bot_id === botId) { |
There was a problem hiding this comment.
The combination of cleaning up the middleware types and use of type predicates lets us clean up the type casting and simplify the logic in this method ❤️
| | GlobalShortcut | ||
| | InteractiveMessageSuggestion | ||
| | DialogSuggestion; | ||
| export const directMention: Middleware<SlackEventMiddlewareArgs<'message'>> = async ({ message, context, next }) => { |
There was a problem hiding this comment.
🔪 closure, straight middleware
| @@ -529,7 +529,7 @@ describe('ExpressReceiver', function () { | |||
| // Act | |||
| const req = { body: { }, url: 'http://localhost/slack/oauth_redirect', method: 'GET' } as Request; | |||
| const resp = { send: () => { } } as Response; | |||
| (receiver.router as any).handle(req, resp); | |||
| (receiver.router as any).handle(req, resp, () => {}); | |||
There was a problem hiding this comment.
A change that was required as part of the move from express v4 -> v5
…e invoked as a method to return middleware; instead, they are directly middleware, like other built-in middleware functions.
…e `message` parameter. THIS FIXES SO MUCH! shouts to jcalz on stackoverflow
…ntMiddlewareArgs when event contains channel information.
…ionMiddlewareArgs when a non-dialog or step from app action
…rtcutMiddlewareArgs when a non-dialog or step from app action. also TODOs
… flat map of strings to strings
…inder removal todos for eventual removal
Summary
bolt-js v4 release PR. Breaking changes are planned for this release!
This PR is currently published under the
4.0.0-rc.4version on npm. Feel free to give it a spin and give us feedback!Breaking Changes
Middleware Type Changes
This one I'm particularly excited about! In bolt we have a set of
Slack*MiddlewareArgstypes: for events, shortcuts, commands, and so on. They 'wrap' the underlying event payloads with additional middleware-relevant bits like anext()method, acontextobject for devs to augment, and so on.Many of these types, for example the
SlackEventMiddlewareArgstype, previously used a conditional to sometimes define particular additional helper utilities on the middleware arguments. For example, thesayutility, or tacking on a conveniencemessageproperty for message-event-related payloads. This was problematic in practice in TypeScript situations, not just internally (this change fixes #2135) within the bolt codebase but for developers as well: when the payload was not of a type that required the extra utility, these properties would be required to exist on the middleware arguments but have a value ofundefined. Those of us trying to build generic middleware utilities would have to deal with TS compilation errors and needing to liberally type-cast to avoid these conditional mismatches withundefined.Instead, these
MiddlewareArgstypes now conditionally create a type intersection when appropriate in order to provide this conditional-utility-extension mechanism. In practice that looks something like:With the above, now when a message payload is wrapped up into middleware arguments, it will contain an appropriate
messageproperty, whereas a non-message payload will be intersected withunknown- effectively a type "noop." No more e.g.say: undefinedormessage: undefinedto deal with!Other Breaking Changes
expressto v4->v5;ExpressReceiverusers will be exposed to express v4 -> v5 breaking changes@slack/socket-modev2;SocketModeReceiverusers who have attached custom event listeners to the publicsocketModeClientdirectly should read the v1 -> v2 migration guide in case the major upgrade could affect them@slack/web-apiv7; all users should read the web-api v6->v7 migration guide to see what the scope of breaking changes theclientwithin listeners is affected byKnownKeys@slack/typesnow exist under a named exporttypes.SocketModeFunctionsclass that had a single static method on it and instead directly exposed thedefaultProcessEventErrorHandlermethod from it.ignoreSelfanddirectMentionnow no longer must be invoked as a method in order to return middleware; instead they are middleware to be used directly. this lines up the API for these built-in middlewares to match the other builtins.AwsEventinterface now models event payloads a bit differently; we now properly model AWS API Gateway v1 and v2 payloads separately.OptionsRequestinterfaceauthed_usersandauthed_teamsfrom event payload enveloperender-html-for-install-pathmoduleverifyandVerifyOptionsfrom theverify-requestmodulesrc/receivers/http-utils.tsmoduleNon-breaking Changes
tsconfig.jsonswitchstatements, removed that fromtsconfig.json; the alternative of using@ts-ignorecomments in places where we do is dangerous, as non-fallthrough-in-switch type errors are also ignored from itmap)processEvent@slack/web-apidependency under thewebApinamed exportraw-bodyto v3@slack/oauthto v3promise.allsettledsince that is natively supported in node since v14@types/tsscmpto dev dependencies since that is not exposed to developersTODO
Post-release TODO