feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

antsukanova · 2024-10-28T22:06:19Z

COMPLETES # SPARK-559645

This pull request addresses

Introduce SDK changes to call WCME and Locus APIs when the current user steps away or returns.

Related PRs:

PR-3942: Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns
PR-3946: Step Away feature unit tests

by making the following changes

This PR only contains updates for SDK logic for the sender mostly.
Since the PR is still under development with unit tests (https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-574651), it will be presented as a draft.
Also, for now, it will contain local linking "link:../../../../webrtc-media-core" for better dx until WCME changes will be ready and release.

Also, either this PR or a separate one will be updated logic for test-app.

How to test:

Create PMR with guest join from SDK and native/web from your user.
Click on the Be right back true / Be right back false buttons in "Participants, Breakout Sessions, and Events published" section. Check the console with data about Be right back requests (for example locus-info:updateSelf->event#SELF_MEETING_BRB_CHANGED)

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 flow with good/bad requests using a sample app.
tested flow with native / web clients and a sample app.

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 · 2024-10-28T22:06:25Z

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 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.

packages/@webex/media-helpers/package.json

packages/@webex/plugin-meetings/src/locus-info/index.ts

packages/@webex/plugin-meetings/src/meeting/request.ts

SomeBody16

With 2 comments

packages/@webex/plugin-meetings/src/locus-info/selfUtils.ts

docs/samples/browser-plugin-meetings/app.js

brycetham

Overall looks good! I left a rather lengthy comment about the timing of sending the "away" state. Ideally, we'd like to send the "away" state as soon as possible, and with how it is right now, I suspect we'd see a noticeable delay.

packages/@webex/plugin-meetings/src/meeting/index.ts

brycetham

I agree with Marcin about checking transcoded meetings, though we don't have to do it in this PR (as long as you stick a TODO in there). Left a small question about the event we're emitting but other than that looks good.

packages/@webex/plugin-meetings/src/meeting/index.ts

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

brycetham · 2024-11-12T18:52:57Z

docs/samples/browser-plugin-meetings/index.html

+              <div>
+                <fieldset>
+                  <legend>Step Away</legend>
+                  <input type="checkbox" id="brb" onclick="toggleBrb()">


I feel like this should be a button and not a checkbox, since it'll be a button in the web client. The button should reflect the brb status of the current user, and would be a good way for us to test whether we are able to accurately show our brb status in the UI, as well as handle any potential race condition that might occur because of it.

It's a good comment, and I believe it's worth changing. We can improve this part in this task and not block the RP with this issue. https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-574653

packages/@webex/plugin-meetings/src/multistream/sendSlotManager.ts

packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

docs/samples/browser-plugin-meetings/app.js

packages/@webex/plugin-meetings/src/meeting/index.ts

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

docs/samples/browser-plugin-meetings/app.js

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

antsukanova · 2024-11-13T13:04:05Z

@SomeBody16 @edvujic added small final (hope so) comments, but overall I feel good with changes, thanks for the updates so far!

packages/@webex/plugin-meetings/src/meeting/index.ts

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

packages/@webex/plugin-meetings/src/meeting/index.ts

packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

packages/@webex/plugin-meetings/src/meeting/index.ts

packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js

brycetham · 2024-11-15T16:20:18Z

packages/@webex/plugin-meetings/src/meeting/index.ts

+        'Meeting:index#beRightBack --> WebRTC media connection is not defined'
+      );
+
+      return;


Why do we need to return here? Shouldn't LoggerProxy.logger.error throw and therefore we don't need a return?

brycetham · 2024-11-15T16:20:28Z

packages/@webex/plugin-meetings/src/meeting/index.ts

+      );
+
+      return;
+    }
    if (this.isMultistream && this.mediaProperties.webrtcMediaConnection) {


I don't think we need this if statement anymore.

brycetham · 2024-11-15T16:20:35Z

packages/@webex/plugin-meetings/src/meeting/index.ts

    if (this.isMultistream && this.mediaProperties.webrtcMediaConnection) {
+      // eslint-disable-next-line consistent-return


Why is this needed?

feat: introduce step away in sdk and test-app

fc570e9

antsukanova added the validated If the pull request is validated for automation. label Oct 28, 2024

antsukanova self-assigned this Oct 28, 2024

antsukanova commented Oct 28, 2024

View reviewed changes

packages/@webex/media-helpers/package.json Outdated Show resolved Hide resolved

antsukanova requested review from szotrabh, brycetham, SomeBody16, k-wasniowski and edvujic October 28, 2024 22:48

brycetham reviewed Oct 30, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/locus-info/index.ts Show resolved Hide resolved

packages/@webex/plugin-meetings/src/meeting/request.ts Outdated Show resolved Hide resolved

antsukanova changed the base branch from next to stepAway October 31, 2024 08:57

SomeBody16 mentioned this pull request Oct 31, 2024

[WIP] feat: Step Away feature unit tests #3946

Merged

11 tasks

fnowakow and others added 3 commits October 31, 2024 15:12

fix(plugin-meetings): added unit tests

ac86df9

fix(plugin-meetings): added NOT unit test

3cbb587

chore: rename functions, update wcme

faf4a73

antsukanova marked this pull request as ready for review November 4, 2024 14:00

antsukanova requested review from a team as code owners November 4, 2024 14:00

antsukanova requested a review from brycetham November 4, 2024 14:00

SomeBody16 requested changes Nov 4, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/locus-info/selfUtils.ts Outdated Show resolved Hide resolved

docs/samples/browser-plugin-meetings/app.js Outdated Show resolved Hide resolved

chore: update brbChanged SelfUtils

c9dd4d3

brycetham reviewed Nov 4, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

chore: update beRightBack, add todo

48caff9

antsukanova requested a review from SomeBody16 November 5, 2024 14:12

chore: add todo

1300726

marcin-bazyl reviewed Nov 5, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

brycetham reviewed Nov 6, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

fnowakow added 2 commits November 7, 2024 10:36

fix(plugin-meetings): fix beRightBack sourceStateOverride

317e1b7

fix(plugin-meetings): audio/video (un)mute fix

7ec0182

antsukanova commented Nov 12, 2024

View reviewed changes

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Outdated Show resolved Hide resolved

antsukanova requested a review from brycetham November 12, 2024 15:28

brycetham reviewed Nov 12, 2024

View reviewed changes

test(plugin-meetings): update brb tests

108d3ad

edvujic reviewed Nov 13, 2024

View reviewed changes

antsukanova commented Nov 13, 2024

View reviewed changes

docs/samples/browser-plugin-meetings/app.js Outdated Show resolved Hide resolved

chore: nit updates for logs

6ab2870

antsukanova commented Nov 13, 2024

View reviewed changes

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Outdated Show resolved Hide resolved

antsukanova requested review from edvujic and brycetham November 13, 2024 13:04

test(plugin-meetings): update brb test names

550c66a

SomeBody16 reviewed Nov 13, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

chore: update beRightBack api logic

d20f826

antsukanova requested a review from SomeBody16 November 13, 2024 15:51

evujici added 3 commits November 14, 2024 09:30

test(plugin-meetings): check brb for both multistream and transcoded

231698f

test(plugin-meetings): finalize brb tests

bd6f757

test(plugin-meetings): remove unnecessary stub

31dac59

edvujic reviewed Nov 14, 2024

View reviewed changes

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Show resolved Hide resolved

edvujic reviewed Nov 14, 2024

View reviewed changes

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Show resolved Hide resolved

antsukanova commented Nov 14, 2024

View reviewed changes

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Show resolved Hide resolved

antsukanova commented Nov 14, 2024

View reviewed changes

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Outdated Show resolved Hide resolved

evujici added 2 commits November 14, 2024 14:36

test(plugin-meetings): re-arrange test and add afterEach

1685a02

test(plugin-meetings): remove only

4ca7e41

brycetham reviewed Nov 14, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js Outdated Show resolved Hide resolved

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js Outdated Show resolved Hide resolved

evujici added 2 commits November 14, 2024 16:21

fix(plugin-meetings): log error

0056acf

fix(plugin-meetings): rever to return statement

7d58d02

brycetham reviewed Nov 14, 2024

View reviewed changes

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved

packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js Outdated Show resolved Hide resolved

fix(plugin-meetings): throw and log error

88d1bb1

brycetham reviewed Nov 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

antsukanova commented Oct 28, 2024 •

edited

Loading

coderabbitai bot commented Oct 28, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

SomeBody16 left a comment

brycetham left a comment

brycetham left a comment

brycetham Nov 12, 2024

antsukanova Nov 13, 2024

antsukanova commented Nov 13, 2024

brycetham Nov 15, 2024

brycetham Nov 15, 2024

brycetham Nov 15, 2024

		if (this.isMultistream && this.mediaProperties.webrtcMediaConnection) {
		// eslint-disable-next-line consistent-return

feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

Are you sure you want to change the base?

feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

Conversation

antsukanova commented Oct 28, 2024 • edited Loading

COMPLETES # SPARK-559645

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

I certified that

coderabbitai bot commented Oct 28, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

SomeBody16 left a comment

Choose a reason for hiding this comment

brycetham left a comment

Choose a reason for hiding this comment

brycetham left a comment

Choose a reason for hiding this comment

brycetham Nov 12, 2024

Choose a reason for hiding this comment

antsukanova Nov 13, 2024

Choose a reason for hiding this comment

antsukanova commented Nov 13, 2024

brycetham Nov 15, 2024

Choose a reason for hiding this comment

brycetham Nov 15, 2024

Choose a reason for hiding this comment

brycetham Nov 15, 2024

Choose a reason for hiding this comment

antsukanova commented Oct 28, 2024 •

edited

Loading

coderabbitai bot commented Oct 28, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)