feat(cc-widgets): UI Automation for Basic Task Controls by PrayagGP · Pull Request #497 · webex/widgets

PrayagGP · 2025-07-14T13:31:04Z

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

This pull request addresses

UI automation for testing the basic task controls

by making the following changes

    1. Created util methods and tests for basic task controls.

https://app.vidcast.io/share/4ccc2926-2988-4150-b661-e651c529cc73

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

…helperUtils and fix initUtils formatting

coderabbitai · 2025-07-14T13:31:09Z

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.
- 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 generate unit tests to generate unit tests for 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-07-14T13:36:23Z

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

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

mkesavan13 · 2025-07-15T04:45:49Z

+        if (!extensionPage) {
+          throw new Error('Extension page is not available for handling extension call');
+        }


Should we rather check if the UI goes rightly to RONA if the extension page is not open?

Should this be done as a separate test? If so, I think it would be more suitable to add it to incomingTask tests.

@rsarika - Here' we are failing the test. However, shouldn't it be a test that simply ensures it goes to RONA if the extension isn't open?

yes. we should do this

mkesavan13 · 2025-07-15T04:56:15Z

+ */
+export async function callTaskControlCheck(page: Page): Promise<void> {
+  // Verify call control container is visible
+  await expect(page.getByTestId('call-control-container').nth(0)).toBeVisible({ timeout: 30000 });


If Akula's PR goes in before this, let us ensure to include the mute button as well

mkesavan13 · 2025-07-15T05:00:48Z

+ * @param expectedIsHeld - Expected hold state (true for hold, false for resume)
+ * @throws Error if verification fails with detailed error message
+ */
+export function verifyHoldLogs(expectedIsHeld: boolean): void {


Do we not verify anywhere if the icons were changing based on the state?

Added utils and checks for the same

mkesavan13 · 2025-07-15T05:10:56Z

+    // Verify audio element properties using JavaScript evaluation
+    // Handle multiple audio elements with same ID by checking all of them
+    const audioProperties = await page.evaluate(() => {
+      const audioElements = document.querySelectorAll('#remote-audio') as NodeListOf<HTMLAudioElement>;


We add IDs(#remote-audio) as unique elements. Why do we need to do querySelectorAll? We could do querySelector instead that will result in not having a forEach in line#270

Sure. Will look into it

mkesavan13 · 2025-07-15T05:11:39Z

+          tracksCount = mediaStream.getTracks().length;
+          audioTracksCount = mediaStream.getAudioTracks().length;


Isn't the audioTracksCount enough here?

Re-checking the way I am verifying audio stream

mkesavan13 · 2025-07-15T05:40:57Z

+ * @returns Promise<void>
+ * @throws Error if remote audio element is not found
+ */
+export async function executeRemoteAudioQuery(page: Page): Promise<void> {


Why do we need this?

mkesavan13 · 2025-07-15T05:42:18Z

+let context2: BrowserContext;
+const maxRetries = 3;
+
+test.describe('Basic Task Controls Tests', () => {


Why do we need this test. prefix everywhere?

Can't we simply do describe, beforeEach, beforeAll etc.,?

mkesavan13 · 2025-07-15T05:50:53Z

+
+    try {
+      // Clear logs first to ensure clean state
+      clearCapturedLogs();


Doesn't this happen before each test anyway?

Yeah removed the unnecessary calls of that function. But in some cases it is needed because I wanted to clear the logs related to pause recording before looking at logs for resume recording within the same test

Yes. Those clear log calls are alright. That is why I hadn't commented there.

mkesavan13 · 2025-07-15T05:52:11Z

+      await page.waitForTimeout(2000);
+
+      // Verify resume callback logs
+      verifyHoldLogs(false);


It would have been better if we had the parameter as JSON. Gives more readability.

Suggested change

verifyHoldLogs(false);

verifyHoldLogs({expectedIsHeld: false});

Should be similar everywhere we have parameters

Yeah, this looks better. Will update the concerned functions with such parameters

mkesavan13 · 2025-07-15T05:53:09Z

+
+      // Verify resume recording callback logs
+      verifyRecordingLogs(true);
+      clearCapturedLogs(); // Clear logs for next verification


Again, wouldn't this happen as part of beforeEach?

rsarika · 2025-07-16T13:20:39Z

@coderabbitai review

coderabbitai · 2025-07-16T13:20:45Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

…lows

rsarika · 2025-07-22T05:36:02Z

    {
      name: 'Test: Chrome',
+      // Run all tests except advanced tests and transfer/consult tests on Chrome
+      testIgnore: [/advanced-task-controls-test\.spec\.ts/],


why we are not running this in chromium?

rsarika · 2025-07-22T05:40:55Z

+ * Utility function to get all captured logs for debugging purposes.
+ * @returns Array of all captured log messages
+ */
+export function getAllCapturedLogs(): string[] {


we should remove this if not used

rsarika · 2025-07-22T05:45:56Z

+ * @param agentName - Name of the agent to consult with (e.g., 'User2 Agent2')
+ * @returns Promise<void>
+ */
+export async function consultViaAgent(page: Page, agentName: string = 'User2 Agent2'): Promise<void> {


combine 4 methods as one and differentiate using param, param should be a json

rsarika · 2025-07-22T05:48:14Z

+        if (!extensionPage) {
+          throw new Error('Extension page is not available for handling extension call');
+        }


yes. we should do this

rsarika · 2025-07-22T05:52:36Z

+    clearAdvancedCapturedLogs();
+  });
+
+  test('Normal Call Blind Transferred by Agent to Another Agent', async () => {


Suggested change

test('Normal Call Blind Transferred by Agent to Another Agent', async () => {

test('Desktop Call Blind Transferred by Agent to Another Agent', async () => {

rsarika · 2025-07-22T05:56:25Z

+    await verifyCurrentState(agent1Page, USER_STATES.AVAILABLE);
+  });
+
+  test('Normal Call Consulted via Agent and Declined (A1 → A2)', async () => {


Suggested change

test('Normal Call Consulted via Agent and Declined (A1 → A2)', async () => {

test('Desktop Call Consulted via Agent and Declined (A1 → A2)', async () => {

rsarika · 2025-07-22T05:56:57Z

+    await agent1Page.waitForTimeout(2000);
+  });
+
+  test('Normal Call Consulted via Agent and Not Picked Up by Agent 2', async () => {


Suggested change

test('Normal Call Consulted via Agent and Not Picked Up by Agent 2', async () => {

test('Desktop Call Consulted via Agent and Not Picked Up by Agent 2', async () => {

rsarika · 2025-07-22T06:01:16Z

+    await agent1Page.waitForTimeout(2000);
+  });
+
+  test('Consult Transfer - Normal Call to Agent 2', async () => {


Suggested change

test('Consult Transfer - Normal Call to Agent 2', async () => {

test('Consult Transfer - Desktop Call to Agent 2', async () => {

rsarika · 2025-07-22T06:02:14Z

+    await endTask(agent1Page);
+    await agent1Page.waitForTimeout(3000);
+    await submitWrapup(agent1Page, WRAPUP_REASONS.RESOLVED);
+    await agent1Page.waitForTimeout(2000);


we should test two way audio for desktop calls, in all the consult and transfer flows

rsarika · 2025-07-22T06:04:46Z

+        }
+      })(),
+      (async () => {
+        await pageSetup(agent1Page, LOGIN_MODE.DESKTOP, 'AGENT1');


lets make it Extension mode so that we can test two mode at one shot
update the tests accordingly

rsarika · 2025-07-22T06:16:47Z

+
+  // Verify the correct icon based on recording state
+  const expectedIcon = expectedIsRecording ? 'record-paused-bold' : 'record-bold';
+  const actualIcon = await iconElement.getAttribute('name');


We should also verify if the button in the top right (the recording indicator) is changing

mkesavan13 · 2025-07-22T06:19:37Z

Let the E2E tests pass and we shall merge. The reviews posted by Ravi & Me (In Ravi's review itself) should be addressed as a separate PR & ticket.

# [1.28.0-ccwidgets.96](v1.28.0-ccwidgets.95...v1.28.0-ccwidgets.96) (2025-07-24) ### Features * **cc-widgets:** UI Automation for Basic Task Controls ([#497](#497)) ([6aa1c90](6aa1c90))

sreenara · 2025-07-24T06:32:21Z

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

The release is available on GitHub release

Your semantic-release bot 📦🚀

PrayagGP added 11 commits July 14, 2025 14:40

fix(cc-widgets): add station-login tests

1202ad8

fix(cc-widgets): rename multi-session to mulit-login

0d043fb

fix(cc-widgets): add delays while handling socket reconnection

1165d03

fix(cc-widgets): add timeouts for various expect statements

6c2f811

fix(cc-widgets): add a second attempt of intialising widgets

e62cf04

fix(cc-widgets): add descriptions for helper functions

2783685

fix(cc-widgets): update test.afterAll for Desktop mode

0f92557

fix(cc-widgets): remove unnecessary code

fc40e67

fix(cc-widgets): shift functions from test file to util file

77ce464

fix(cc-widgets): sync utility files with upstream - restore complete …

fe92788

…helperUtils and fix initUtils formatting

fix(cc-widgets): add tests and utils for basic task controls

4baacb6

mkesavan13 requested changes Jul 15, 2025

View reviewed changes

riteshfyi mentioned this pull request Jul 15, 2025

feat(cc-widgets): UI Automation for Task List #500

Closed

22 tasks

fix(cc-widgets): add utils and tests to verify hold and recording icons

ff53ab0

Shreyas281299 added the validated Indicates that the PR is ready for actions label Jul 16, 2025

rsarika approved these changes Jul 16, 2025

View reviewed changes

rsarika added the run_e2e Add this label to run E2E test for meeting and CC widgets label Jul 16, 2025

rsarika added 2 commits July 16, 2025 18:50

Merge branch 'ccwidgets' into ccwidgets

c2f2e6d

Merge branch 'ccwidgets' into ccwidgets

54d363f

rsarika requested a review from mkesavan13 July 16, 2025 14:24

fix(cc-widgets): add utils and tests to verify consult and transfer f…

1f1b982

…lows

rsarika approved these changes Jul 22, 2025

View reviewed changes

mkesavan13 approved these changes Jul 22, 2025

View reviewed changes

Merge branch 'ccwidgets' into ccwidgets

9b1e7a2

Merge branch 'ccwidgets' into ccwidgets

a41873b

Shreyas281299 merged commit 6aa1c90 into webex:ccwidgets Jul 24, 2025
12 of 16 checks passed

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

		tracksCount = mediaStream.getTracks().length;
		audioTracksCount = mediaStream.getAudioTracks().length;

	verifyHoldLogs(false);
	verifyHoldLogs({expectedIsHeld: false});

	test('Normal Call Blind Transferred by Agent to Another Agent', async () => {
	test('Desktop Call Blind Transferred by Agent to Another Agent', async () => {

	test('Normal Call Consulted via Agent and Declined (A1 → A2)', async () => {
	test('Desktop Call Consulted via Agent and Declined (A1 → A2)', async () => {

	test('Consult Transfer - Normal Call to Agent 2', async () => {
	test('Consult Transfer - Desktop Call to Agent 2', async () => {

Uh oh!

Conversation

PrayagGP commented Jul 14, 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-6523

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 14, 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 comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

aws-amplify-us-east-2 Bot commented Jul 14, 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!

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!

rsarika commented Jul 16, 2025

Uh oh!

coderabbitai Bot commented Jul 16, 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

PrayagGP commented Jul 14, 2025 •

edited

Loading

coderabbitai Bot commented Jul 14, 2025 •

edited

Loading