Skip to content

feat(ccwidgets): add error metrics and boundary for widgets#520

Merged
Shreyas281299 merged 17 commits into
webex:ccwidgetsfrom
Shreyas281299:error-boundary
Sep 15, 2025
Merged

feat(ccwidgets): add error metrics and boundary for widgets#520
Shreyas281299 merged 17 commits into
webex:ccwidgetsfrom
Shreyas281299:error-boundary

Conversation

@Shreyas281299

@Shreyas281299 Shreyas281299 commented Aug 20, 2025

Copy link
Copy Markdown
Contributor

COMPLETES # CAI-6395

This pull request addresses

  • Adds error boundary around each widget that catches any react uncaught errors
  • Adds error boundary around helper and util files across all widgets
  • Sends metrics for any UI error, this excludes the errros from helper and util files.

Amplitude link for error metrics - https://app.eu.amplitude.com/analytics/cisco-cross-project/chart/e-oe4in4od/edit/e-veibgczh?source=copy+url

by making the following changes

  • Any error in helper and utils is logged
  • Any error in react component is caught and a metrics is sent to Amplitude

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

  • Deliberately added errors and ensured the errors are caught and the app doesnt break, only the respective widget is hidden all other functionality still works properly.

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Cursor
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

Checklist before merging

  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the testing document

@coderabbitai

coderabbitai Bot commented Aug 20, 2025

Copy link
Copy Markdown

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.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@Shreyas281299 Shreyas281299 added the validated Indicates that the PR is ready for actions label Aug 20, 2025
@aws-amplify-us-east-2

Copy link
Copy Markdown

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

Access this pull request here: https://pr-520.d1b38q61t1z947.amplifyapp.com

@Shreyas281299 Shreyas281299 changed the title Error boundary feat(ccwidgets): add error metrics and boundary for widgets Aug 20, 2025
@Shreyas281299 Shreyas281299 added validated Indicates that the PR is ready for actions and removed validated Indicates that the PR is ready for actions labels Aug 20, 2025
@bhabalan

Copy link
Copy Markdown
Contributor

@coderabbitai review

secondsUntilAutoWrapup,
allowCancelAutoWrapup,
handleCancelWrapup,
logger,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

just a question, is there a way we can have it as singleton or at central place as we are passing this to each and every component?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

True, Il explore if this is possible, maybe we can pass this the same way we are passing the store

@Shreyas281299 Shreyas281299 added the run_e2e Add this label to run E2E test for meeting and CC widgets label Sep 10, 2025
@Shreyas281299
Shreyas281299 merged commit ab1b595 into webex:ccwidgets Sep 15, 2025
7 of 8 checks passed
github-actions Bot pushed a commit that referenced this pull request Sep 15, 2025
# [1.28.0-ccwidgets.113](v1.28.0-ccwidgets.112...v1.28.0-ccwidgets.113) (2025-09-15)

### Features

* **ccwidgets:** add error metrics and boundary for widgets ([#520](#520)) ([ab1b595](ab1b595))
@sreenara

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.28.0-ccwidgets.113 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Shreyas281299
Shreyas281299 deleted the error-boundary branch September 16, 2025 04:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released on @ccwidgets run_e2e Add this label to run E2E test for meeting and CC widgets validated Indicates that the PR is ready for actions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants