feat(cc-widgets): UI Automation for State Change by PrayagGP · Pull Request #476 · webex/widgets

PrayagGP · 2025-06-19T10:15:25Z

COMPLETES #< https://jira-eng-sjc12.cisco.com/jira/browse/CAI-6521 >

This pull request addresses

UI automation for testing the user state

by making the following changes

    1. Created utility functions for tests
    2. Wrote tests for user state using the newly created utilities.

Vidcast: https://app.vidcast.io/share/1af66521-e31c-401f-9cf4-ad53e8adca43

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
< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >

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

- Comprehensive test for user state widget functionality - Includes authentication, state changes, theme validation - Tests page refresh persistence and multi-session sync - Validates callback sequences and idle state transitions

…ls with them

… updated constants.ts file

coderabbitai · 2025-06-19T10:15:30Z

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.

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

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

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

aws-amplify-us-east-2 · 2025-06-19T10:20:41Z

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

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

rsarika · 2025-06-20T09:28:29Z

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


try to remove and avoid these changes

rsarika · 2025-06-20T09:29:06Z

    baseURL: 'http://localhost:3000',

    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-    trace: 'retain-on-failure',


why did we change this? we only want to check if itas a failure

Yeah I'll revert the change. I had changed it to obtain the trace even for test success for debugging purposes just to see if things are actually happening the way I wanted them to.

rsarika · 2025-06-20T09:30:36Z

+        await page.locator('#select-base-triggerid').getByText('Access Token').click();
+        await page.getByTestId('samples:login_option_oauth').getByText('Login with Webex').click();
+        await page.getByTestId('login with webex button').click();
+        await page.getByRole('textbox', { name: 'name@example.com' }).fill(process.env.PLAYWRIGHT_USERNAME);


Is it not possible to get this also by testId?

I agree using testid will make things easier and more consistent

These are buttons and textboxes for Oauth login. I don't think I can add data-testids for these as I probably won't have access to its source code.

rsarika · 2025-06-20T09:30:53Z

+        await page.getByTestId('samples:login_option_oauth').getByText('Login with Webex').click();
+        await page.getByTestId('login with webex button').click();
+        await page.getByRole('textbox', { name: 'name@example.com' }).fill(process.env.PLAYWRIGHT_USERNAME);
+        await page.getByRole('link', { name: 'Sign in' }).click();


same here, can we make everything by testId?

rsarika · 2025-06-20T09:32:02Z

+    await page.getByTestId('multi-login-enable-checkbox').click();
+}
+
+export const initialisePage = async (page: Page): Promise<void> => {


rename it to initiaseWidgets

initiateWidgets or initialiseWidgets?

initialiseWidgets, sounds good

rsarika · 2025-06-20T09:32:50Z

+dotenv.config();
+
+
+export const changeState = async (page: Page, userState: string): Promise<void> => {


changeUserState

rsarika · 2025-06-20T09:33:05Z

@@ -0,0 +1,136 @@
+import { Page,expect } from '@playwright/test';


rename file name to userStateUtils

rsarika · 2025-06-20T09:34:59Z

+  return timerText.trim();
+};
+
+export const checkConsole = async (page: Page, state: string, consoleMessages: string[]): Promise<boolean> => {


rename to more meaningful name

rsarika · 2025-06-20T09:35:42Z

@@ -0,0 +1,58 @@
+import { Page } from '@playwright/test';


rename file to stationLoginUtils.ts

rsarika · 2025-06-20T09:36:08Z

@@ -0,0 +1,23 @@
+export const BASE_URL = 'http://localhost:3000';
+
+export const STATES = {


USER_STATES

…nd files

… in the file

…ny valid number

…/widgets into ccwidgets_UserStateTest

…y the files accordingly

…logs

riteshfyi · 2025-06-29T16:43:48Z

Could you please update the pull-request.yml with the new variable names, such as PW_AGENT1_USERNAME, instead of PW_USERNAME, etc.

i have reviewed the comments and resolve them

…StateTest

…/widgets into ccwidgets_UserStateTest

…roach

…/widgets into ccwidgets_UserStateTest

# [1.28.0-ccwidgets.83](v1.28.0-ccwidgets.82...v1.28.0-ccwidgets.83) (2025-07-01) ### Features * **cc-widgets:** UI Automation for State Change ([#476](#476)) ([999cb53](999cb53))

sreenara · 2025-07-01T09:09:08Z

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

The release is available on GitHub release

Your semantic-release bot 📦🚀

prayprab_cisco and others added 18 commits June 16, 2025 18:42

Add User State Widget Functionality Test Suite

6b81885

- Comprehensive test for user state widget functionality - Includes authentication, state changes, theme validation - Tests page refresh persistence and multi-session sync - Validates callback sequences and idle state transitions

fix(cc-widgets): add timeout to config

e95adf7

fix(cc-widgets): change login method

a6494e2

fix(cc-widgets): fix element locators

7d675c9

fix(cc-widgets): added data-testid for some checkoxes and updated uti…

63c1ed7

…ls with them

fix(cc-widgets): removed console logs from utils

de99f62

add(cc-widgets): created a testfile that uses BeforeEach login

1c05232

add(cc-widgets): created a testfile that uses BeforeAll login

c37d18b

fix(cc-widgets): add a constants file

b8a5b64

fix(cc-widgets): updated the files based on constants.ts

d2be589

fix(cc-widgets): updated user-state-test.spec.ts

d7d31cc

fix(cc-widgets): updated the testfile by removing some redundant code

3d5b734

fix(cc-widgets): updated the files with constants with respect to the…

4d11615

… updated constants.ts file

fix(cc-widgets): renamed the utility file to stationUtils

807db7c

fix(cc-widgets): removed redundant tests

382b982

fix(cc-widgets): updated it with a constant for the url

b25beb9

fix(cc-widgets): updated the test file name

578f6a9

fix(cc-widgets): made the timeouts uniform

47f7af6

rsarika 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 Jun 19, 2025

fix(cc-widgets): updated the testfile for timer sync

8fb3aec

rsarika requested changes Jun 20, 2025

View reviewed changes

PrayagGP added 6 commits June 23, 2025 12:12

fix(cc-widgets): updated the files by changing the names of methods a…

7f7d497

…nd files

fix(cc-widgets): updated the files by changing the names of constants…

f205c98

… in the file

fix(cc-widgets): updated the workflow with new env variables

a277cb1

fix(cc-widgets): updated the data-testid for buttons

b9bfd84

fix(cc-widgets): updated the file to close the pages once the test ends

adfee7f

fix(cc-widgets): updated the file to close the pages once the test ends

7270aee

PrayagGP and others added 10 commits June 25, 2025 23:04

Merge branch 'ccwidgets' into ccwidgets_UserStateTest

95927fa

fix(cc-widgets): added a new method for login to any mode and using a…

d9e2959

…ny valid number

Merge branch 'ccwidgets_UserStateTest' of https://github.com/PrayagGP…

1dd64b3

…/widgets into ccwidgets_UserStateTest

fix(cc-widgets): add constants for login modes

ae90cac

fix(cc-widgets): add separate method for Access Token login and modif…

46dc2ef

…y the files accordingly

fix(cc-widgets): add typedoc and improve logic to search for console …

d6486de

…logs

fix(cc-widgets): format the code

e854c78

fix(cc-widgets): format the code

27eb062

fix(cc-widgets): format the code

10e419e

fix(cc-widgets): format the code

6686e8f

rsarika approved these changes Jun 27, 2025

View reviewed changes

PrayagGP and others added 3 commits June 29, 2025 22:42

fix(cc-widgets): update the names of env variables

68d1eda

fix(cc-widgets): add timeouts to waitFor visible state

14c47ce

Merge branch 'ccwidgets' into ccwidgets_UserStateTest

f70046e

PrayagGP and others added 10 commits June 30, 2025 17:11

fix(cc-widgets): update extension number

9262a5b

fix(cc-widgets): update the workflow

f300b69

Merge remote-tracking branch 'upstream/ccwidgets' into ccwidgets_User…

7331fa7

…StateTest

Merge branch 'ccwidgets_UserStateTest' of https://github.com/PrayagGP…

1e9be03

…/widgets into ccwidgets_UserStateTest

fix(cc-widgets): remove auxcodeID logic and use a more consistent app…

ac050e0

…roach

fix(cc-widgets): remove auxcodeID logic and use a more consistent app…

6b2e070

…roach

fix(cc-widgets): update files with modified env variables

db4a394

Merge branch 'ccwidgets' into ccwidgets_UserStateTest

8593ade

fix(cc-widgets): add more delays

9c5a359

Merge branch 'ccwidgets_UserStateTest' of https://github.com/PrayagGP…

01a19f3

…/widgets into ccwidgets_UserStateTest

rsarika merged commit 999cb53 into webex:ccwidgets Jul 1, 2025
7 of 8 checks passed

sreenara added the released on @ccwidgets label Jul 1, 2025

		dotenv.config();


		export const changeState = async (page: Page, userState: string): Promise<void> => {

		@@ -0,0 +1,136 @@
		import { Page,expect } from '@playwright/test';

		@@ -0,0 +1,23 @@
		export const BASE_URL = 'http://localhost:3000';

		export const STATES = {

Uh oh!

Conversation

PrayagGP commented Jun 19, 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-6521 >

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 Jun 19, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

aws-amplify-us-east-2 Bot commented Jun 19, 2025

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!

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!

riteshfyi commented Jun 29, 2025

Uh oh!

Uh oh!

sreenara commented Jul 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PrayagGP commented Jun 19, 2025 •

edited

Loading