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

fix: end meeting for all getCurUserType type issue #4038

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

rsarika
Copy link
Contributor

@rsarika rsarika commented Dec 20, 2024

COMPLETES # CSCwn60262

This pull request addresses

fixing Console error when we call meeting.EndMeetingForAll()

by making the following changes

Added below properties and function to BasicMeetingInformation type so that they will be accessible after ending the meeting as well.

roles: string[];
getCurUserType: () => string | null;
callStateForMetrics: CallStateForMetrics;

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

Joined meeting as host in sample app and called endMeetingForAll() => there were no errors observed.

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.

Summary by CodeRabbit

  • New Features

    • Enhanced meeting data structure to retain user roles and type information after a meeting is deleted.
    • Added new properties for improved meeting state management.
  • Bug Fixes

    • Improved handling of user scenarios in meeting functionality tests, including guest users and incomplete data.
  • Tests

    • Refined test cases and added new assertions to ensure accurate validation of meeting functionalities and metrics handling.

@rsarika rsarika requested review from a team as code owners December 20, 2024 10:06
Copy link

coderabbitai bot commented Dec 20, 2024

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.

warning eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: 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 > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning glob@7.2.3: Glob versions prior to v9 are no longer supported
warning intern > glob@7.1.7: Glob versions prior to v9 are no longer supported
warning intern > glob > inflight@1.0.6: 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 > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > jest-cli > jest-config > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-runtime > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning mocha > glob@7.2.0: Glob versions prior to v9 are no longer supported
warning mocha > glob > inflight@1.0.6: 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 sinon@9.2.4: 16.1.1
warning wd > archiver > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning wd > q@1.5.1: 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@2.88.0: request has been deprecated, see request/request#3142
warning wd > archiver > archiver-utils > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning wd > request > uuid@3.4.0: 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 > request > har-validator@5.1.5: this library is no longer supported
warning @babel/cli > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning @babel/plugin-proposal-async-generator-functions@7.20.7: 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/plugin-proposal-class-properties@7.18.6: 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/plugin-proposal-export-namespace-from@7.18.9: 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/plugin-proposal-nullish-coalescing-operator@7.18.6: 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/plugin-proposal-object-rest-spread@7.20.7: 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/plugin-proposal-optional-chaining@7.21.0: 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/polyfill@7.12.1: 🚨 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 > core-js@2.6.12: 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 > core-js@2.6.12: 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 > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning workspace-aggregator-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning workspace-aggregator-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning workspace-aggregator-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > sinon@9.2.4: 16.1.1
warning workspace-aggregator-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/plugin-proposal-async-generator-functions@7.20.7: 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-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/plugin-proposal-class-properties@7.18.6: 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-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/plugin-proposal-export-namespace-from@7.18.9: 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-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/plugin-proposal-nullish-coalescing-operator@7.18.6: 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-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/plugin-proposal-object-rest-spread@7.20.7: 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-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/plugin-proposal-optional-chaining@7.21.0: 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-ef0278ec-ea80-4d78-b5d7-8c8933b69d55 > @babel/polyfill@7.12.1: 🚨 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.
error eslint-plugin-jsdoc@40.3.0: The engine "node" is incompatible with this module. Expected version "^14 || ^16 || ^17 || ^18 || ^19". Got "22.9.0"
error Found incompatible module.

Walkthrough

The pull request introduces modifications to the Meetings class in the plugin-meetings package. The changes primarily focus on enhancing the BasicMeetingInformation type by adding new properties like roles and getCurUserType. The destroy method has been updated to preserve these new properties when storing information about deleted meetings. The accompanying test suite has been refined to validate these new functionalities, ensuring robust handling of meeting lifecycle events and user interactions.

Changes

File Change Summary
packages/@webex/plugin-meetings/src/meetings/index.ts - Updated BasicMeetingInformation type with roles: string[] and getCurUserType: () => string | null
- Modified destroy method to retain roles and call state metrics for deleted meetings
packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js - Updated test setup for user preferences
- Added assertions for meeting roles and call state metrics
- Refined test cases for destroy and uploadLogs methods

Possibly related PRs

Suggested reviewers

  • marcin-bazyl
  • szotrabh
  • k-wasniowski

Poem

🐰 Meetings dance, roles unfurl,
Metrics tracked in digital swirl
Destroy method, now more wise
Preserving data before it dies
A rabbit's code, both smart and neat! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42bd008 and a034daa.

📒 Files selected for processing (2)
  • packages/@webex/plugin-meetings/src/meetings/index.ts (2 hunks)
  • packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (5 hunks)
🔇 Additional comments (4)
packages/@webex/plugin-meetings/src/meetings/index.ts (2)

158-160: LGTM! Enhanced meeting state management

The additions to BasicMeetingInformation type properly preserve role and user type information, which is essential for maintaining meeting state even after deletion.


1149-1151: LGTM! Proper state preservation in destroy method

The implementation correctly stores the additional meeting properties (roles, callStateForMetrics, and getCurUserType) when destroying meetings, ensuring important state information is preserved.

packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (2)

1988-1989: LGTM! Good test coverage for new properties

The test assertions properly verify that roles and callStateForMetrics are preserved in deletedMeetings after meeting destruction.


Line range hint 2099-2122: LGTM! Comprehensive test setup for user scenarios

The setup function changes properly handle different user types and scenarios, ensuring robust testing of the new functionality.


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.

@rsarika rsarika added the validated If the pull request is validated for automation. label Dec 20, 2024
@rsarika rsarika requested a review from sreenara December 20, 2024 10:07
Copy link

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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (1)

2099-2099: Consistent spacing in setup function parameters.

Minor formatting improvement for better code consistency.

Also applies to: 2120-2120, 2122-2122

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42bd008 and a034daa.

📒 Files selected for processing (2)
  • packages/@webex/plugin-meetings/src/meetings/index.ts (2 hunks)
  • packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (5 hunks)
🔇 Additional comments (3)
packages/@webex/plugin-meetings/src/meetings/index.ts (2)

158-160: LGTM! Type definition enhancement.

The new properties added to BasicMeetingInformation type appropriately capture additional meeting state information that needs to be preserved.


1149-1151: LGTM! Preserving additional meeting state.

The destroy method now correctly preserves roles, call state metrics, and user type information in the deletedMeetings map, allowing this data to be accessed even after meeting destruction.

packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (1)

1988-1989: LGTM! Comprehensive test coverage for new properties.

The test has been properly updated to verify that roles and callStateForMetrics are correctly preserved in deletedMeetings and can be retrieved via getBasicMeetingInformation.

Also applies to: 2026-2027

@@ -1143,6 +1146,9 @@ export default class Meetings extends WebexPlugin {
sessionId: meeting.locusInfo?.fullState?.sessionId,
},
},
roles: meeting.roles,
callStateForMetrics: meeting.callStateForMetrics,
getCurUserType: meeting.getCurUserType,
Copy link
Collaborator

Choose a reason for hiding this comment

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

initially I didn't like this approach, because I thought that having a reference to the method of a meeting will prevent that meeting object from being garbage collected, but I think it's OK, you can have references to methods of an object and these methods on their own don't have a reference to the object itself (as long as they don't use any closures), so it should be fine.

Copy link
Contributor

@sreenara sreenara left a comment

Choose a reason for hiding this comment

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

Just one question.

@@ -155,6 +155,9 @@ export type BasicMeetingInformation = {
};
meetingInfo: any;
sessionCorrelationId: string;
roles: string[];
Copy link
Contributor

Choose a reason for hiding this comment

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

question. Why have we also added roles and callStateForMetrics?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

roles being read in getCurUserType utility function and callStateForMetrics is being read in next line where previous error occured.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validated If the pull request is validated for automation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants