docs(test-fixtures): add AI documentation - AGENTS.md and ARCHITECTURE.md by Shreyas281299 · Pull Request #595 · webex/widgets

Shreyas281299 · 2026-01-14T08:08:14Z

COMPLETES N/A - Documentation Enhancement

This pull request addresses

Adding AI-optimized documentation for the test-fixtures package to help AI assistants understand the test mocks and utilities.

by making the following changes

Added packages/contact-center/test-fixtures/ai-docs/AGENTS.md - Usage documentation for test mocks
Added packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md - Technical implementation details

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

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
I have tested the functionality with amplify link

Make sure to have followed the contributing guidelines before submitting.

…E.md

aws-amplify-us-east-2 · 2026-01-14T08:13:48Z

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

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

Shreyas281299

PR Looks good.

akulakum · 2026-02-03T10:08:57Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+- **Ensures consistency** - Same mock data across all tests
+- **Supports customization** - Easy to extend or override fixtures
+
+### Key Capabilities


The current mockCC fixture does not include all SDK methods listed here (e.g., acceptTask, transferTask, outdial, etc.). Either expand mockCC or update this section to match the actual fixture surface.

akulakum · 2026-02-03T10:12:17Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+
+---
+
+### mockProfile (Profile)


In fixtures.ts, teams are {teamId, teamName}, and loginVoiceOptions is a string array. Update the example to match the real fixture shape.

akulakum · 2026-02-03T10:13:48Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+
+---
+
+### mockTask (ITask)


The actual mockTask data uses data.interaction fields, not origin/destination. Update the example to match the real TaskData shape in fixtures.ts.

akulakum · 2026-02-03T10:14:36Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+
+---
+
+## Available Fixtures


The package exports additional fixtures from incomingTaskFixtures, taskListFixtures, and outdialCallFixtures (e.g., mockIncomingTaskData, mockTaskData, mockOutdialCallProps, mockAniEntries, mockCCWithAni). Add them to this table.

akulakum · 2026-02-03T10:17:52Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+---
+
+## Dependencies
+


Fixtures import types from @webex/contact-center as well. Either list it as a dependency or update this section to clarify it’s a type-only import.

Let's ensure we are not creating a circular dependency here. NOT IN THE SCOPE OF THIS PR

akulakum · 2026-02-03T10:18:36Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+Test Fixtures is a testing utility package that provides realistic mock data for all contact center SDK types and widgets. It follows a fixture pattern where each fixture is a pre-configured, reusable mock object that matches the actual SDK types.
+
+### Fixture Table
+


The actual mockCC in fixtures.ts does not implement those methods. Update this table to reflect the real mockCC surface, or extend the mock to match the doc.

Its just taking about what are the available properties we dont say that we are implementing these methods

akulakum · 2026-02-03T10:19:14Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+| **makeMockAddressBook** | `Function` | `src/fixtures.ts` | Factory for custom address book | Via function parameter |
+
+### File Structure
+


Not all fixtures are in fixtures.ts. There are additional exports in incomingTaskFixtures, taskListFixtures, and components/task/outdialCallFixtures. Update file structure and/or add those files.

rarajes2 · 2026-02-06T03:29:12Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+
+### Key Capabilities
+
+- **Complete SDK Mock**: Mock `IContactCenter` with all methods


Let's ensure if we have all the methods in the fixture

We dont, so Ive reword this

rarajes2 · 2026-02-06T03:31:39Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+jest.mock('@webex/cc-store', () => ({
+  cc: mockCC,
+  teams: mockProfile.teams,
+  loginOptions: mockProfile.loginVoiceOptions,
+  logger: mockCC.LoggerProxy,
+  isAgentLoggedIn: false,
+}));


Let's check if we can provide this mock by default in the fixture itself. If required we should have some methods to override the mock or we can override manually like this

NOT IN THE SCOPE OF THIS PR

Yeah, I like this approach, Il explore this

rarajes2 · 2026-02-06T03:33:45Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+
+// Use in tests
+test('calls SDK stationLogin method', async () => {
+  const loginSpy = jest.spyOn(mockCC, 'stationLogin')


Let's verify if this is correct. We should be spying on the actual object I think and a particular method would be mocked.

This is correct, we are spying on the method stationLogin which is present in the object mockCC. We can do a mockImplementation but its not required

rarajes2 · 2026-02-06T03:39:18Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+import { CallControl } from '@webex/cc-task';
+import { mockTask } from '@webex/test-fixtures';
+
+test('renders call control for active task', () => {


We are using it instead of test in our test files. Semantically we should be using test because we are not developing with TDD approach. Lets keep it for now

rarajes2 · 2026-02-06T03:40:50Z

packages/contact-center/test-fixtures/ai-docs/AGENTS.md

+  await mockTask.hold();
+  expect(mockTask.hold).toHaveBeenCalled();


This way it would be too obvious

Updated the example

rarajes2 · 2026-02-06T03:53:58Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+
+## Component Overview
+
+Test Fixtures is a testing utility package that provides realistic mock data for all contact center SDK types and widgets. It follows a fixture pattern where each fixture is a pre-configured, reusable mock object that matches the actual SDK types.


This seems repeated info from AGENTS.md

Its just an overview, I feel it can be a little repetetive. If we find this to be affecting the performance of the LLM in any way then we will remove this

rarajes2 · 2026-02-06T03:55:00Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+├── package.json
+├── tsconfig.json
+└── webpack.config.js


babel.config.js is missing

rarajes2 · 2026-02-06T03:55:54Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+  AgentProxy: { /* agent-related methods */ },
+  DiagnosticsProxy: { /* diagnostics methods */ },
+  LoggerProxy: { /* logger methods */ },
+  ScreenRecordingProxy: { /* screen recording */ },
+  TaskProxy: { /* task subscriptions */ },


What are these ? I think casing is wrong

Yeah, the names were incorrect for the methods

rarajes2 · 2026-02-06T03:58:10Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+graph TB
+    subgraph "Test Setup"
+        Fixtures[Import Fixtures]
+        Mock[Mock Store/SDK]
+    end
+
+    subgraph "Test Execution"
+        Render[Render Component]


Let's add screenshots of all these diagrams

rarajes2 · 2026-02-06T04:01:25Z

packages/contact-center/test-fixtures/ai-docs/ARCHITECTURE.md

+| SDK Feature | Mock Provided | Customizable |
+|-------------|---------------|--------------|
+| Station Login/Logout | ✅ `mockCC.stationLogin`, `mockCC.stationLogout` | ✅ Via jest mocking |
+| User State | ✅ `mockCC.setUserState` | ✅ Via jest mocking |
+| Task Accept/End | ✅ `mockCC.acceptTask`, `mockCC.endTask` | ✅ Via jest mocking |
+| Task Hold/Resume | ✅ `mockTask.hold`, `mockTask.resume` | ✅ Via jest mocking |
+| Transfer/Consult | ✅ `mockCC.transferTask`, `mockCC.consultTask` | ✅ Via jest mocking |
+| Recording | ✅ `mockCC.pauseRecording`, `mockCC.resumeRecording` | ✅ Via jest mocking |
+| Outdial | ✅ `mockCC.outdial`, `mockEntryPointsResponse` | ✅ Via jest mocking |
+| Address Book | ✅ `makeMockAddressBook` | ✅ Via factory parameter |
+| Agent Profile | ✅ `mockProfile` | ✅ Via object spread |
+| Queues | ✅ `mockQueueDetails` | ✅ Via array modification |
+| Agents | ✅ `mockAgents` | ✅ Via array modification |


Values for 3rd column ( Customizable ) - Isn't all mocked using jest mocking only then we pass the mock value in different shapes as required ? Correct me if I my understanding is wrong here

Wherever it says 'via jest mock' those are methods that are set to jest.fn() and where it says via object or array there we have set a custom object to map the correct type, for example AgentProfile

docs(test-fixtures): add AI documentation - AGENTS.md and ARCHITECTUR…

1d689ea

…E.md

Shreyas281299 mentioned this pull request Jan 14, 2026

docs(test-fixtures): add AI documentation - AGENTS.md and ARCHITECTURE.md #582

Closed

Shreyas281299 commented Feb 3, 2026

View reviewed changes

akulakum reviewed Feb 3, 2026

View reviewed changes

rarajes2 reviewed Feb 6, 2026

View reviewed changes

docs(fixtures): review

d870afd

akulakum approved these changes Feb 11, 2026

View reviewed changes

docs(fixtures): update from test to it in docs

bcfaa5e

rarajes2 approved these changes Feb 12, 2026

View reviewed changes

Shreyas281299 added the validated Indicates that the PR is ready for actions label Feb 12, 2026

Merge branch 'next' into ai-docs-fixtures

01653dc

Shreyas281299 merged commit 4149aed into webex:next Feb 12, 2026
1 of 2 checks passed

		Test Fixtures is a testing utility package that provides realistic mock data for all contact center SDK types and widgets. It follows a fixture pattern where each fixture is a pre-configured, reusable mock object that matches the actual SDK types.

		### Fixture Table

		\| makeMockAddressBook \| `Function` \| `src/fixtures.ts` \| Factory for custom address book \| Via function parameter \|

		### File Structure


		### Key Capabilities

		- Complete SDK Mock: Mock `IContactCenter` with all methods

		await mockTask.hold();
		expect(mockTask.hold).toHaveBeenCalled();


		## Component Overview

		Test Fixtures is a testing utility package that provides realistic mock data for all contact center SDK types and widgets. It follows a fixture pattern where each fixture is a pre-configured, reusable mock object that matches the actual SDK types.

		---

		## Dependencies

Conversation

Shreyas281299 commented Jan 14, 2026

COMPLETES N/A - Documentation Enhancement

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!

aws-amplify-us-east-2 bot commented Jan 14, 2026

Uh oh!

Shreyas281299 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

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!

Uh oh!