revert: mercury plugin changes of cc websocket

[rsarika]

COMPLETES #< INSERT LINK TO ISSUE >

This pull request addresses

This is to revert changes of mercury which were done as part of cc sdk but no longer needed as we are using websocket directly.

by making the following changes

Change Type

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update
• Tooling change
• Internal code refactor

The following scenarios were tested

Test login and loading of messages, replying to messages and creating threads, reactions
Start a meeting and check for audio and video 2 ways
Start whiteboard in the meeting (this is what broke in the web client)
Try breakout rooms and other features like muting, unmuting other participants, locking and unlocking the meeting. Recording the meeting
Go to your meetings tab in web client and see if the new recording was listed and you're able to access it (open the link and play it)
< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >
https://app.vidcast.io/share/d21bec15-2bda-4415-98da-77de5007d0b3

I certified that

• I have read and followed contributing guidelines

• I discussed changes with code owners prior to submitting this pull request

• I have not skipped any automated checks

• All existing and new tests passed

• I have updated the documentation accordingly

---

Make sure to have followed the contributing guidelines before submitting.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request removes the authorizationRequired and acknowledgementRequired options from the connection flow in the Mercury and Socket modules. In the Mercury module, the _attemptConnection method no longer includes these properties when setting up a connection, and the _getEventHandlers and _onmessage methods have been streamlined by eliminating redundant checks based on the presence of an event type. In the Socket module, the optional parameters are removed from the constructor and the open method, resulting in the unconditional invocation of the _authorize and _acknowledge methods during connection events. Additionally, related test cases that previously validated behavior based on these options have been removed, leaving the underlying functionality intact while simplifying the overall connection and message handling logic.

Possibly related PRs

• feat(llm): force close mercury before reconnect a new data channel #4150: Involved removal of the authorizationRequired and acknowledgementRequired properties, directly affecting connection handling logic.
• fix: locus DTOs not handled if an earlier one causes an error #3982: Addressed modifications in the Mercury module, specifically streamlining connection options and event error management in _onmessage and _emit.
• fix(mercury): add client timestamp #3993: Focused on changing the _attemptConnection method by eliminating the handling of the removed connection options.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > [email protected]: Glob versions prior to v9 are no longer supported
warning [email protected]: Glob versions prior to v9 are no longer supported
warning intern > [email protected]: Glob versions prior to v9 are no longer supported
warning intern > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning jasmine > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-config > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-runtime > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > [email protected]: Glob versions prior to v9 are no longer supported
warning mocha > [email protected]: Glob versions prior to v9 are no longer supported
warning mocha > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning [email protected]: 16.1.1
warning sinon > @sinonjs/samsam > [email protected]: This package is deprecated. Use the optional chaining (?.) operator instead.
warning wd > [email protected]: request has been deprecated, see request/request#3142
warning wd > archiver > [email protected]: Glob versions prior to v9 are no longer supported
warning wd > [email protected]: You or someone you depend on is using Q, the JavaScript Promise library that gave JavaScript developers strong feelings about promises. They can almost certainly migrate to the native JavaScript promise now. Thank you literally everyone for joining me in this bet against the odds. Be excellent to each other.

(For a CapTP with native promises, see @endo/eventual-send and @endo/captp)
warning wd > request > [email protected]: Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.
warning wd > archiver > archiver-utils > [email protected]: Glob versions prior to v9 are no longer supported
warning wd > request > [email protected]: this library is no longer supported
warning @babel/cli > [email protected]: Glob versions prior to v9 are no longer supported
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-export-namespace-from instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning @babel/[email protected]: 🚨 This package has been deprecated in favor of separate inclusion of a polyfill and regenerator-runtime (when needed). See the @babel/polyfill docs (https://babeljs.io/docs/en/babel-polyfill) for more information.
warning @babel/polyfill > [email protected]: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.
warning @babel/runtime-corejs2 > [email protected]: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.
warning babel-plugin-lodash > [email protected]: Glob versions prior to v9 are no longer supported
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > [email protected]: Glob versions prior to v9 are no longer supported
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > [email protected]: 16.1.1
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-export-namespace-from instead.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning workspace-aggregator-59a77342-d909-4bcc-bc5d-13970c19d5c3 > @babel/[email protected]: 🚨 This package has been deprecated in favor of separate inclusion of a polyfill and regenerator-runtime (when needed). See the @babel/polyfill docs (https://babeljs.io/docs/en/babel-polyfill) for more information.
[2/4] Fetching packages...
error [email protected]: The engine "node" is incompatible with this module. Expected version "^14 || ^16 || ^17 || ^18 || ^19". Got "22.9.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e16a681 and 4b43ad1.

📒 Files selected for processing (4)

• packages/@webex/internal-plugin-mercury/src/mercury.js (2 hunks)
• packages/@webex/internal-plugin-mercury/src/socket/socket-base.js (3 hunks)
• packages/@webex/internal-plugin-mercury/test/unit/spec/mercury.js (0 hunks)
• packages/@webex/internal-plugin-mercury/test/unit/spec/socket.js (0 hunks)

💤 Files with no reviewable changes (2)

• packages/@webex/internal-plugin-mercury/test/unit/spec/mercury.js
• packages/@webex/internal-plugin-mercury/test/unit/spec/socket.js

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Build Packages
• GitHub Check: AWS Amplify Console Web Preview

🔇 Additional comments (5)

packages/@webex/internal-plugin-mercury/src/mercury.js (2)

427-428: Simplification of event handler initialization.

The code now unconditionally initializes the handlers array without an early return check for eventType presence. This change assumes that subsequent code properly handles potentially undefined or empty eventType values.

---

540-547:

❓ Verification inconclusive

Improved event emission handling logic.

The code now unconditionally processes the namespace from data.eventType without first checking if eventType exists. This simplification assumes data.eventType will always be present in the message payload. This change aligns with the PR objective of reverting previous CC websocket changes.

---

🏁 Script executed:

#!/bin/bash
# Check if there are any instances where data.eventType might be undefined
rg "data\s*=\s*envelope" -A 10 packages/@webex/internal-plugin-mercury/src/mercury.js

Length of output: 87

---

Attention: Verify data.eventType Assumption

The refactored code now unconditionally extracts the namespace by splitting data.eventType, relying on the assumption that this field is always present and formatted correctly. This change aligns with the PR’s objective of reverting the prior CC websocket changes by simplifying the logic. However, given that our scripted search did not reveal any explicit guards against data.eventType being undefined, please ensure through manual verification that every message payload reliably provides a valid eventType—otherwise, this change might lead to runtime errors.

• File: packages/@webex/internal-plugin-mercury/src/mercury.js (Lines 540–547)
• Concern: The absence of checks for an undefined or improperly formatted data.eventType
• Action: Confirm that upstream message handlers always supply a proper eventType before merging this change

packages/@webex/internal-plugin-mercury/src/socket/socket-base.js (3)

209-214: Property assignment simplification.

The code now directly assigns all properties from options to the socket instance without special handling for authorizationRequired and acknowledgementRequired properties. This aligns with the removal of these configuration options throughout the module.

---

247-256: Socket authorization made unconditional.

The socket will now always attempt authorization when connected, removing the previous conditional check based on the authorizationRequired option. This simplifies the connection flow but removes the flexibility to skip authorization.

---

309-312: Socket message acknowledgment made unconditional.

Two significant changes:

1. All messages are now acknowledged without a conditional check
2. Only messages with data.type === 'pong' emit a 'pong' event (previously it might have included 'ping' type as well)

These changes simplify the message handling logic while ensuring all messages are properly acknowledged.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[aws-amplify-us-east-2]

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-4166.d3m3l2kee0btzx.amplifyapp.com

[rsarika]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[adhmenon]

Let us test on web client and ensure it does no break anything

[Kesari3008]

1. Please test in the latest next and then with web client as well and attach screenrecording of the testing for reference.
2. Update the description with more details and I believe there was a JIRA for this which was close but it's good to attach it here

[sreenara]

1. Please test in the latest next and then with web client as well and attach screenrecording of the testing for reference.
2. Update the description with more details and I believe there was a JIRA for this which was close but it's good to attach it here

@rsarika we were discussing this yesterday, it would be good if you could link locally with the web client and do the following:

1. Test login and loading of messages, replying to messages and creating threads, reactions
2. Start a meeting and check for audio and video 2 ways
3. Start whiteboard in the meeting (this is what broke in the web client)
4. Try breakout rooms and other features like muting, unmuting other participants, locking and unlocking the meeting. Recording the meeting
5. Go to your meetings tab in web client and see if the new recording was listed and you're able to access it (open the link and play it)

Post this, we can merge and let's raise a PR on the web client with this latest next release and ensure it all passes.