You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR replaces the error factory-function pattern in @slack/socket-mode with proper Error subclasses, bringing it in line with the same change already applied to @slack/web-api in #2593.
What changed
The old approach used interfaces (e.g. SMWebsocketError, SMPlatformError) and factory functions (e.g. websocketErrorWithOriginal(), platformErrorFromEvent()) that mutated plain Error objects by attaching a code property. This made instanceof checks unreliable.
The new approach defines real ES6 class subclasses of Error:
Additionally, the SocketModeClient now uses proper instanceof checks when classifying errors from apps.connections.open to decide whether to auto-reconnect.
Requirements
I've read and understood the Contributing Guidelines and have done my best effort to follow them.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
✅ All modified and coverable lines are covered by tests. ⚠️ Please upload report for BASE (v8@187594b). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bugM-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documentedpkg:socket-modeapplies to `@slack/socket-mode`
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR replaces the error factory-function pattern in
@slack/socket-modewith proper Error subclasses, bringing it in line with the same change already applied to @slack/web-api in #2593.What changed
The old approach used interfaces (e.g.
SMWebsocketError,SMPlatformError) and factory functions (e.g.websocketErrorWithOriginal(),platformErrorFromEvent()) that mutated plain Error objects by attaching a code property. This madeinstanceofchecks unreliable.The new approach defines real ES6 class subclasses of Error:
SMWebsocketErrorSMPlatformErrorSMNoReplyReceivedErrorSMSendWhileDisconnectedErrorSMSendWhileNotReadyErrorHow users can take advantage of these changes
Before (fragile string-based check):
After (type-safe instanceof check):
Catching send errors:
Checking connection errors during start():
Additionally, the SocketModeClient now uses proper
instanceofchecks when classifying errors fromapps.connections.opento decide whether to auto-reconnect.Requirements