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(plugin-meetings): improve error handling for stream state ended #3975

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

rarajes2
Copy link
Contributor

@rarajes2 rarajes2 commented Nov 14, 2024

COMPLETES #< SPARK-579391 >

This pull request addresses

While debugging the Instant connect issue, we found that throwing a generic error for all types of streams was not helpful during investigation. This PR handles all the streams individually keeping the old logic aligned and throws the error with specific detail about the stream.

by making the following changes

The error thrown will contain the info about which stream caused it to throw the error, providing better logs to debug.

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 the logic in isolation. Error message is being thrown as expected.

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 handling of local media streams for improved reliability during meetings.
    • Streamlined publishing process for local streams, ensuring only valid streams are processed.
  • Bug Fixes

    • Improved error handling for publishing local streams, providing clearer messages for failures.

@rarajes2 rarajes2 requested review from a team as code owners November 14, 2024 09:48
@rarajes2 rarajes2 added the validated If the pull request is validated for automation. label Nov 14, 2024
Copy link

coderabbitai bot commented Nov 14, 2024

Walkthrough

The changes in this pull request focus on enhancements to the Meeting class within the index.ts file. Key modifications include improved handling of local media streams, with a structured approach to verify their readiness before publishing. A new array, streamChecks, is introduced to check the readyState of local streams. The publishStreams and unpublishStreams methods have updated signatures and logic to ensure only valid streams are processed, with enhanced error handling for better clarity and maintainability.

Changes

File Path Change Summary
packages/@webex/plugin-meetings/src/meeting/index.ts - Updated method signatures for publishStreams and unpublishStreams in the Meeting class.
- Introduced streamChecks array for validating local streams' readyState.
- Streamlined logic for publishing local streams and improved error handling.

Possibly related PRs

Suggested reviewers

  • marcin-bazyl
  • antsukanova
  • szotrabh
  • edvujic

🐰 In the meadow, streams do flow,
With checks in place, we’re set to go!
Publish with care, let errors be few,
A hop and a skip, all systems anew!
Let’s gather the streams, both near and far,
Together we shine, like a bright little star! 🌟


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.

Copy link

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

Access this pull request here: https://pr-3975.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

🧹 Outside diff range and nitpick comments (2)
packages/@webex/plugin-meetings/src/meeting/index.ts (2)

Line range hint 4-4: Reminder: Address the TODO comment.

The TODO comment indicates that tests are missing for this function. Please ensure that the additional parameter change is thoroughly tested to confirm that it behaves as expected.

Do you want me to generate the unit testing code or open a GitHub issue to track this task?


Line range hint 12-24: Consider adjusting the fee structure or discount policy.

The implementation of a flat $20 fee on discounted bills could negate the benefit of the discount, especially for smaller purchases or marginal loyalty tiers. This might lead to customer dissatisfaction, as the intent to reward loyalty paradoxically increases the bill.

Consider revising either the discount percentages or the flat fee application to better align with customer incentives.

Would you like assistance in generating a revised implementation?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 397373d and c5dbd9e.

📒 Files selected for processing (1)
  • packages/@webex/plugin-meetings/src/meeting/index.ts (1 hunks)
🔇 Additional comments (2)
packages/@webex/plugin-meetings/src/meeting/index.ts (2)

Line range hint 1-2: LGTM!

The function logic is correct and implementation is accurate.


Line range hint 6-6: Verify the latest stable versions and any security advisories

Ensure that the fixed version of the requests library is secure and free from vulnerabilities.

Run the following script to verify the fixed version of the requests library:

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

🧹 Outside diff range and nitpick comments (1)
packages/@webex/plugin-meetings/src/meeting/index.ts (1)

8733-8738: Consider optimizing the stream validation loop.

While the current implementation works correctly, it could be improved for better performance and readability:

  1. Add early returns for empty/undefined streams
  2. Use Array.prototype.find() to detect first invalid stream

Here's a suggested optimization:

-    for (const {stream, name} of streamChecks) {
-      if (stream?.readyState === 'ended') {
-        throw new Error(
-          `Attempted to publish ${name} stream with ended readyState, correlationId=${this.correlationId}`
-        );
-      }
-    }
+    const invalidStream = streamChecks.find(({stream}) => stream?.readyState === 'ended');
+    if (invalidStream) {
+      throw new Error(
+        `Attempted to publish ${invalidStream.name} stream with ended readyState, correlationId=${this.correlationId}`
+      );
+    }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 397373d and c5dbd9e.

📒 Files selected for processing (1)
  • packages/@webex/plugin-meetings/src/meeting/index.ts (1 hunks)
🔇 Additional comments (1)
packages/@webex/plugin-meetings/src/meeting/index.ts (1)

8726-8731: LGTM! Well-structured stream validation setup.

The streamChecks array is well organized and provides a clean way to validate multiple stream types. The code is readable and maintainable.

Copy link
Contributor

@mkesavan13 mkesavan13 left a comment

Choose a reason for hiding this comment

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

That's a nice and needed improvement. Thanks for raising this PR, @rarajes2. Good one 💪🏻

Copy link
Contributor

@chburket chburket left a comment

Choose a reason for hiding this comment

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

Approved, but I would suggest the unit test(s) be updated.

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.

5 participants