fix(cc-sdk): fixed-websocket-on-message-event-remove-logout #4044

adhmenon · 2025-01-06T14:19:39Z

COMPLETES #< SPARK-592068 >

This pull request addresses

Currently, in the widgets, whenever we login and then logout and once again login to the widget, we are unable to get any message events.
This is causing an issue with the agent status and timer as shown in this PR - feat(widgets): shifted-timer-to-worker widgets#352

by making the following changes

Changed the code so that we now listen to websocket messages (again only used in widgets as of now) whenever we login/ relogin and stop listening whenever we do logout.

Vidcast of working widgets - https://app.vidcast.io/share/a1cac1b3-83ec-450d-9e63-4a3066287b93

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

Tested out the code by locally linking to the widgets repo.
Tested the code in the sdk sample app to ensure no older behaviour is broken.

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 · 2025-01-06T14:19:47Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 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. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

adhmenon · 2025-01-06T14:21:10Z

packages/@webex/plugin-cc/src/cc.ts

@@ -194,6 +194,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter

      await loginResponse;

+      this.services.webSocketManager.on('message', this.handleWebSocketMessage);


This change will not affect any other functionality as it is only handling AGENT_STATE_CHANGE event. We were earlier listening to web socket events during register which would not have worked.
Checked that it works cleanly in the sample app.

adhmenon · 2025-01-06T14:21:23Z

packages/@webex/plugin-cc/src/cc.ts

@@ -355,6 +355,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter

      await this.handleDeviceType(deviceType as LoginOption, dn);
      this.agentConfig.isAgentLoggedIn = true;
+      this.services.webSocketManager.on('message', this.handleWebSocketMessage);


Need to add this for relogin as well (in those cases).

mkesavan13

Thanks a lot, Adhwaith. Looks good to me. A test for the exact case where you found the issue: "Doing a station logout and logging in back didn't listen to the event" would be a good addition

Kesari3008 · 2025-01-06T16:52:38Z

packages/@webex/plugin-cc/src/cc.ts

@@ -194,6 +194,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter

      await loginResponse;

+      this.services.webSocketManager.on('message', this.handleWebSocketMessage);


Where would we be switching off these listeners? Is that already taken care of somewhere?

It's already being switched off on logout.

feat(cc-sdk): fixed-event-removed-on-logout

6c19a9b

adhmenon requested a review from a team as a code owner January 6, 2025 14:19

adhmenon commented Jan 6, 2025

View reviewed changes

adhmenon added the validated If the pull request is validated for automation. label Jan 6, 2025

mkesavan13 approved these changes Jan 6, 2025

View reviewed changes

Kesari3008 reviewed Jan 6, 2025

View reviewed changes

adhmenon requested a review from Kesari3008 January 6, 2025 17:14

Kesari3008 approved these changes Jan 7, 2025

View reviewed changes

adhmenon merged commit 4f14698 into webex:wxcc Jan 7, 2025
21 of 22 checks passed

adhmenon deleted the dev/adhmenon-SPARK-592068 branch January 7, 2025 07:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(cc-sdk): fixed-websocket-on-message-event-remove-logout #4044

fix(cc-sdk): fixed-websocket-on-message-event-remove-logout #4044

adhmenon commented Jan 6, 2025

coderabbitai bot commented Jan 6, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

adhmenon Jan 6, 2025

adhmenon Jan 6, 2025

mkesavan13 left a comment

Kesari3008 Jan 6, 2025 •

edited

Loading

adhmenon Jan 6, 2025

		@@ -194,6 +194,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter

		await loginResponse;

		this.services.webSocketManager.on('message', this.handleWebSocketMessage);

fix(cc-sdk): fixed-websocket-on-message-event-remove-logout #4044

fix(cc-sdk): fixed-websocket-on-message-event-remove-logout #4044

Conversation

adhmenon commented Jan 6, 2025

COMPLETES #< SPARK-592068 >

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

I certified that

coderabbitai bot commented Jan 6, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

adhmenon Jan 6, 2025

Choose a reason for hiding this comment

adhmenon Jan 6, 2025

Choose a reason for hiding this comment

mkesavan13 left a comment

Choose a reason for hiding this comment

Kesari3008 Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

adhmenon Jan 6, 2025

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)

Kesari3008 Jan 6, 2025 •

edited

Loading