fix(cc-ui-logging): @webex/ui-logging package by Shreyas281299 · Pull Request #491 · webex/widgets

Shreyas281299 · 2025-07-07T06:19:26Z

COMPLETES # https://jira-eng-sjc12.cisco.com/jira/browse/CAI-6285

This pull request addresses

Adds a new package in contact-center widgets that is used to log the usage of widgets.

by making the following changes

Now there is a HOC present that can be wrapped around any widget and that provides us with basic logging for a widget. Like when a widget was mounted and unmounted. We also have access to props in the HOC.

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

The testing is done with the amplify link
Released an alpha version and had epic tested the logging
Testing this in windows and in mac for our sample page

The GAI Coding Policy And Copyright Annotation Best Practices

Checklist before merging

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

coderabbitai · 2025-07-07T06:19:32Z

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.

aws-amplify-us-east-2 · 2025-07-07T06:24:28Z

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

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

Shreyas281299 · 2025-07-29T08:35:51Z

Update the package to @webex/ui-logging

Shreyas281299 · 2025-07-29T08:40:28Z

Shreyas281299 · 2025-07-29T08:40:30Z

Shreyas281299 · 2025-07-29T08:40:34Z

Shreyas281299 · 2025-07-29T08:42:08Z

Shreyas281299 · 2025-07-29T08:42:12Z

Shreyas281299 · 2025-07-29T08:53:25Z

+          });
+        };
+      }, []);
+


Add the ticket for propUpdate log

Shreyas281299 · 2025-07-29T08:57:48Z

 };

-export default CallControlCADComponent;
+const CallControlCADComponentWithMetrics = withMetrics(CallControlCADComponent, 'CallControlCAD');


CallControlComponent is already wrapper in withMetrics, and we are again wrapping the component here with withMetrics. See if the logging is happening twice? If it is then it is wrong. we only need it once

Shreyas281299 · 2025-07-29T08:58:58Z

+    expect(renderSpy).toHaveBeenCalledTimes(2);
+  });
+
+  it('should handle complex prop changes', () => {


This is not required, as we are only doing shallow comparision

Shreyas281299 · 2025-07-29T08:59:28Z

Shreyas281299 · 2025-07-29T09:00:10Z

+  stats: {
+    warningsFilter: [/sass-loader/],
+  },


Add a comment about this suppression

Kesari3008

Approving with few minor comments

Kesari3008 · 2025-08-12T15:39:00Z

    "@momentum-ui/illustrations": "^1.24.0",
    "@r2wc/react-to-web-component": "2.0.3",
-    "@webex/cc-store": "workspace:*"
+    "@webex/cc-store": "workspace:*",


Why are we removing this ?

Its not removed, just added another dependency and this line it added a comma that why it is showing like this

Kesari3008 · 2025-08-12T15:54:04Z

    "react-dom": ">=18.3.1"
  }
-}
+}


Why were these changes introduced? Can we revert them ?

These are linting changes, this needs to be fixed in the tooling. We already have a task for this

Kesari3008 · 2025-08-12T15:59:50Z

    const taskListPresentational = screen.getByTestId('task-list');
    expect(taskListPresentational).toBeInTheDocument();

-    // Verify that `TaskListPresentational` is called with the correct props.


Why is this removed ?

Kesari3008 · 2025-08-12T16:16:55Z

+export type WidgetMetrics = {
+  widgetName: string;
+  event: 'WIDGET_MOUNTED' | 'ERROR' | 'WIDGET_UNMOUNTED' | 'PROPS_UPDATED';
+  props?: Record<string, any>;


Is there no way to avoid using any for props and additionalContext ?

No, we dont for now. props can be from any widget. If I use the actual types from the widgets it would end up creating a circular dependency. 1 thing we can do is move all the types to store but that would go against out design

Kesari3008 · 2025-08-12T16:20:17Z

+ */
+export const logMetrics = (metric: WidgetMetrics) => {
+  if (!store.logger) {
+    console.warn('CC-Widgets: UI Metrics: No logger found');


Can we avoid console.warn ? We can use logger.warn

this scenario is for when logger is not present. so we are just logging a warning

Kesari3008 · 2025-08-12T16:22:07Z

+ * Once we start sanitizing we can do a deep comparison. This is used to only re-render
+ * the HOC if the props have changed.
+ */
+export function havePropsChanged(prev: any, next: any): boolean {


Same comment here about any

Same as above

Kesari3008 · 2025-08-12T16:27:04Z

+  }
+
+  // All shallow comparisons passed, consider props unchanged
+  return false;


Where do we log metrics for prop updated case or is that what that JIra is added in comment ?

The JIRA has been added @ packages/contact-center/ui-logging/src/withMetrics.tsx

# [1.28.0-ccwidgets.107](v1.28.0-ccwidgets.106...v1.28.0-ccwidgets.107) (2025-08-22) ### Bug Fixes * **cc-ui-logging:** @webex/ui-logging package ([#491](#491)) ([b647448](b647448)) * **cc-widgets:** added new chat client for cc widgets e2e testing ([#516](#516)) ([1b34046](1b34046)) * **cc-widgets:** Updated chat client with new asset ([#515](#515)) ([ea99d28](ea99d28)) * **publish:** force-publish-version-108 ([#522](#522)) ([125fd27](125fd27)) * **tooling:** force publish version 108 - 2 ([#523](#523)) ([ae9b70e](ae9b70e)) * **tooling:** force publish version 108 - 4 ([#525](#525)) ([010e10e](010e10e)) * **ui-logging:** add public access config in cc-ui-logging ([#521](#521)) ([3ab033b](3ab033b)) ### Features * **widgets:** addd e2e tests for task list ([#508](#508)) ([549dafd](549dafd))

sreenara · 2025-08-22T06:42:41Z

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

The release is available on GitHub release

Your semantic-release bot 📦🚀

fix(ui-metrics): @webex/ui-metrics package

136e550

Shreyas281299 added 6 commits July 15, 2025 11:02

Merge remote-tracking branch 'upstream/ccwidgets' into metrics

92d37d1

fix(ui-metrics): metrics rerendering issue

032fd09

feat(cc-ui-metrics): change name to cc-ui-metrics

e800f38

fix(ui-metrics): add uts

c4982b2

Merge remote-tracking branch 'upstream/ccwidgets' into metrics

594e859

fix(ui-metrics): merged latest and typed properly

a5bfab9

Shreyas281299 added validated Indicates that the PR is ready for actions run_e2e Add this label to run E2E test for meeting and CC widgets labels Jul 22, 2025

Shreyas281299 marked this pull request as ready for review July 25, 2025 10:21

Shreyas281299 changed the title ~~fix(ui-metrics): @webex/ui-metrics package~~ fix(ui-metrics): @webex/ui-logging package Jul 29, 2025

Shreyas281299 commented Jul 29, 2025

View reviewed changes

fix(cc-loggin): review-comments

979f3d0

rarajes2 approved these changes Aug 7, 2025

View reviewed changes

Shreyas281299 and others added 5 commits August 8, 2025 10:33

fix(ui-loggin): change folder name to logging

cab57af

fix(ui-logging): build issue

3c85248

Merge remote-tracking branch 'upstream/ccwidgets' into metrics

79c6fe3

fix(samples): fix samples building issues

40ded98

Merge branch 'ccwidgets' into metrics

b73d233

Kesari3008 approved these changes Aug 12, 2025

View reviewed changes

Merge branch 'ccwidgets' into metrics

ebdbca5

Shreyas281299 changed the title ~~fix(ui-metrics): @webex/ui-logging package~~ fix(cc-ui-logging): @webex/ui-logging package Aug 14, 2025

Shreyas281299 merged commit b647448 into webex:ccwidgets Aug 14, 2025
7 of 9 checks passed

sreenara added the released on @ccwidgets label Aug 22, 2025

Shreyas281299 deleted the metrics branch September 16, 2025 04:53

Uh oh!

Conversation

Shreyas281299 commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

COMPLETES # https://jira-eng-sjc12.cisco.com/jira/browse/CAI-6285

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

The GAI Coding Policy And Copyright Annotation Best Practices

Checklist before merging

Uh oh!

coderabbitai Bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

Status, Documentation and Community

Uh oh!

aws-amplify-us-east-2 Bot commented Jul 7, 2025

Uh oh!

Shreyas281299 commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kesari3008 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Shreyas281299 commented Jul 7, 2025 •

edited

Loading

coderabbitai Bot commented Jul 7, 2025 •

edited

Loading

Shreyas281299 commented Jul 29, 2025 •

edited

Loading