Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

socket-mode: prep for major release #1732

Merged
merged 5 commits into from
Jan 25, 2024
Merged

socket-mode: prep for major release #1732

merged 5 commits into from
Jan 25, 2024

Conversation

filmaj
Copy link
Contributor

@filmaj filmaj commented Jan 19, 2024

  • bump minimum node version to 18
  • remove unused p-* dependencies
  • add a .nycrc.json file as other packages in this repo use, for holding code coverage configuration
  • code changes to move to new major version of ws and web-api dependencies
    • I went through this breaking changes list for ws and made the updates in here based on that. In summary, raw string buffers are passed to handler methods now (previously, ws would decode the string on your behalf automatically). Presumably to support binary payloads.
    • Related: do we need to worry about binary payloads being provided over websocket messages?

- bump minimum node version to 18
- remove unused p-* dependencies
- code changes to move to new major version of ws and web-api dependencies
@filmaj filmaj added semver:major pkg:socket-mode applies to `@slack/socket-mode` labels Jan 19, 2024
@filmaj filmaj requested review from seratch and a team January 19, 2024 21:00
@filmaj filmaj self-assigned this Jan 19, 2024
@seratch
Copy link
Member

seratch commented Jan 19, 2024

@filmaj

Related: do we need to worry about binary payloads being provided over websocket messages?

A Socket Mode client never receives binary payloads. You can safely assume that WS message payloads are always JSON format text data.

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Left a minor comment about data value existence. If we don't need to worry about it, please ignore it.

packages/socket-mode/package.json Show resolved Hide resolved
packages/socket-mode/src/SocketModeClient.ts Show resolved Hide resolved
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Left a few minor comments.

packages/socket-mode/src/SocketModeClient.ts Show resolved Hide resolved
packages/socket-mode/test/integration.spec.js Outdated Show resolved Hide resolved
…terface requirements. Tweak `start` behaviour to return once the client is connected rather than when authenticated (and still connecting). Binary and malformed JSON messages are raised now as DEBUG level logs. Added integration tests assuring the documented lifecycle events are raised.
@filmaj filmaj requested a review from seratch January 24, 2024 16:59
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you; Looks good to me

packages/socket-mode/src/SocketModeClient.ts Show resolved Hide resolved
@filmaj
Copy link
Contributor Author

filmaj commented Jan 25, 2024

Thank you so much for your patience and consistent reviews Kaz 🙇

@filmaj filmaj merged commit a6f2b28 into main Jan 25, 2024
15 checks passed
@filmaj filmaj deleted the prep-socket-mode-major branch January 25, 2024 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg:socket-mode applies to `@slack/socket-mode` semver:major
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants