-
Notifications
You must be signed in to change notification settings - Fork 65
docs(ai-docs): task refactor migration overview (PR 1/4) #644
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
akulakum
wants to merge
18
commits into
webex:next
Choose a base branch
from
akulakum:TASK_REFACTOR_MIGRATION_OLD_VS_NEW
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
439effd
docs(ai-docs): add task refactor migration documentation (old vs new)
akulakum 4a534db
Merge branch 'next' into TASK_REFACTOR_MIGRATION_OLD_VS_NEW
akulakum 45a1bd6
docs(ai-docs): address codex review comments
akulakum 28397c2
docs(ai-docs): address codex second review comments
akulakum 3bd613f
docs(ai-docs): address codex third review comments
akulakum 606dcbf
docs(ai-docs): address codex fourth review comments
akulakum 23c1fab
docs(ai-docs): address codex fifth review comments
akulakum e4ea922
docs(ai-docs): address codex sixth review comments
akulakum b35a8c3
Merge branch 'next' into TASK_REFACTOR_MIGRATION_OLD_VS_NEW
akulakum 2313f1a
docs(ai-docs): address codex seventh review comments
akulakum 0024a37
docs(ai-docs): split PR — retain only foundation docs (PR 1/4)
akulakum abbbaf3
docs(ai-docs): address codex eighth review — fix conference state der…
akulakum eabc80d
docs(ai-docs): add CC SDK task-refactor branch reference to 001-migra…
akulakum 6e50dc5
docs(ai-docs): address codex ninth review — fix consult mapping, reco…
akulakum 0d08a09
docs(ai-docs): address codex tenth review — add TaskState export, fix…
akulakum d576676
docs(ai-docs): address codex eleventh review — keep findHoldStatus in…
akulakum 4a28a43
docs(ai-docs): address reviewer feedback — restructure 001 overview, …
akulakum 91dd405
docs(ai-docs): consolidate PR 1 migration docs into single overview
akulakum File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
packages/contact-center/ai-docs/migration/migration-overview.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| # Task Refactor Migration Overview | ||
|
|
||
| ## Purpose | ||
|
|
||
| Guide for migrating CC Widgets from ad-hoc task state management to the new SDK state-machine-driven architecture (`task-refactor` branch). This is the single entry point — it tells you what changed, which docs to follow in what order, and what to watch out for. | ||
|
|
||
| --- | ||
|
|
||
| ## Architectural Change: Old vs New | ||
|
|
||
| ``` | ||
| ┌─────────────────────────────────────────────────────────────────────────────────┐ | ||
| │ OLD (Current Widgets) │ NEW (After Migration) │ | ||
| │ │ │ | ||
| │ SDK emits 30+ task events │ SDK state machine transitions │ | ||
| │ │ │ │ │ | ||
| │ ▼ │ ▼ │ | ||
| │ Store: refreshTaskList() │ SDK: computes TaskUIControls │ | ||
| │ + update observables manually │ from (TaskState + TaskContext) │ | ||
| │ │ │ │ │ | ||
| │ ▼ │ ▼ │ | ||
| │ Hooks: getControlsVisibility( │ SDK emits │ | ||
| │ deviceType, featureFlags, │ 'task:ui-controls-updated' │ | ||
| │ task, agentId, conferenceEnabled) │ │ │ | ||
| │ │ │ ▼ │ | ||
| │ ▼ │ Widgets read task.uiControls │ | ||
| │ Components: flat ControlVisibility │ │ │ | ||
| │ (22 controls + 7 state flags) │ ▼ │ | ||
| │ │ Components: TaskUIControls │ | ||
| │ Logic spread across: │ (17 controls, each │ | ||
| │ task-util.ts, task-utils.ts, │ { isVisible, isEnabled }) │ | ||
| │ timer-utils.ts, component utils │ │ | ||
| │ │ Single source of truth: │ | ||
| │ │ task.uiControls │ | ||
| └─────────────────────────────────────────────────────────────────────────────────┘ | ||
| ``` | ||
|
|
||
| ### `TaskUIControls` Structure | ||
|
|
||
| ```typescript | ||
| type TaskUIControlState = { isVisible: boolean; isEnabled: boolean }; | ||
|
|
||
| type TaskUIControls = { | ||
| accept, decline, hold, transfer, consult, end, recording, mute, | ||
| consultTransfer, endConsult, conference, exitConference, | ||
| transferConference, mergeToConference, wrapup, | ||
| switchToMainCall, switchToConsult | ||
| // each: TaskUIControlState | ||
| }; | ||
| ``` | ||
|
|
||
| Widgets no longer compute control visibility — `task.uiControls` is the single source of truth. | ||
|
|
||
| --- | ||
|
|
||
| ## Execution Order | ||
|
|
||
| Follow these docs in order. Each doc has old vs new code, before/after examples, and files to modify. | ||
|
|
||
| | Order | Document | What to Do | | ||
| |-------|----------|------------| | ||
| | 1 | [store-event-wiring-migration.md](./store-event-wiring-migration.md) | Simplify 30+ event handlers — remove `refreshTaskList()`, add `TASK_UI_CONTROLS_UPDATED` subscription | | ||
| | 2 | [store-task-utils-migration.md](./store-task-utils-migration.md) | Remove redundant utils (SDK handles), keep display/timer utils | | ||
| | 3 | [call-control-hook-migration.md](./call-control-hook-migration.md) | Replace `getControlsVisibility()` with `task.uiControls` in `useCallControl` + update timer utils | | ||
| | 4 | [incoming-task-migration.md](./incoming-task-migration.md) | Use `task.uiControls.accept/decline` instead of visibility functions | | ||
| | 5 | [task-list-migration.md](./task-list-migration.md) | Per-task `uiControls` for accept/decline | | ||
| | 6 | [component-layer-migration.md](./component-layer-migration.md) | Update `cc-components` props — `ControlVisibility` → `TaskUIControls`, rename control props | | ||
|
|
||
| --- | ||
|
|
||
| ## SDK Pending Exports (Prerequisites) | ||
|
|
||
| > **Status:** This section will be updated once the SDK team adds these exports. Migration can begin on items that don't depend on these, but full completion requires them. | ||
|
|
||
| These items are exported from SDK source files but not yet from the package entry point (`src/index.ts`): | ||
|
|
||
| | Item | SDK Change Needed | | ||
| |------|---| | ||
| | `TaskUIControls` type | Add to `src/index.ts` | | ||
| | `getDefaultUIControls()` | Add to `src/index.ts` | | ||
| | `TaskState` enum | Add to `src/index.ts` (needed for consult timer labeling) | | ||
| | `uiControls` on `ITask` | Add getter to `ITask` interface (currently only on concrete `Task` class) | | ||
| | `IVoice`, `IDigital`, `IWebRTC` | Add to `src/index.ts` (optional — for type narrowing) | | ||
|
|
||
| --- | ||
|
|
||
| ## Key Types from SDK | ||
|
|
||
| | Type | Purpose | | ||
| |------|---------| | ||
| | `TaskUIControls` | Pre-computed control states (17 controls) | | ||
| | `getDefaultUIControls()` | Fallback when no task: `task?.uiControls ?? getDefaultUIControls()` | | ||
| | `TASK_EVENTS` | Import from SDK — delete local enum in `store.types.ts` | | ||
|
|
||
| > Constants to delete/keep, event name mappings, and migration gotchas are documented in each migration doc above (PRs 2 and 3). | ||
|
|
||
| --- | ||
|
|
||
| ## CC Widgets Files Affected | ||
|
|
||
| | Area | Path | | ||
| |------|------| | ||
| | Task hooks | `packages/contact-center/task/src/helper.ts` | | ||
| | Task UI utils (OLD — to be removed) | `packages/contact-center/task/src/Utils/task-util.ts` | | ||
| | Task timer utils | `packages/contact-center/task/src/Utils/timer-utils.ts` | | ||
| | Hold timer hook | `packages/contact-center/task/src/Utils/useHoldTimer.ts` | | ||
| | Task types | `packages/contact-center/task/src/task.types.ts` | | ||
| | Store event wrapper | `packages/contact-center/store/src/storeEventsWrapper.ts` | | ||
| | Store task utils | `packages/contact-center/store/src/task-utils.ts` | | ||
| | Store constants | `packages/contact-center/store/src/constants.ts` | | ||
| | CC Components — CallControl | `packages/contact-center/cc-components/src/components/task/CallControl/` | | ||
| | CC Components — CallControlCAD | `packages/contact-center/cc-components/src/components/task/CallControlCAD/` | | ||
| | CC Components types | `packages/contact-center/cc-components/src/components/task/task.types.ts` | | ||
|
|
||
| --- | ||
|
|
||
| ## CC SDK Reference | ||
|
|
||
| > **Repo:** [webex/webex-js-sdk (task-refactor)](https://github.com/webex/webex-js-sdk/tree/task-refactor) | ||
| > **Local path:** `/Users/akulakum/Documents/CC_SDK/webex-js-sdk` (branch: `task-refactor`) | ||
|
|
||
| | File | Purpose | | ||
| |------|---------| | ||
| | `uiControlsComputer.ts` | Computes `TaskUIControls` from `TaskState` + `TaskContext` — the single source of truth | | ||
| | `Task.ts` | Task service exposing `task.uiControls` getter and `task:ui-controls-updated` event | | ||
| | `constants.ts` | `TaskState` and `TaskEvent` enums | | ||
|
|
||
| --- | ||
|
|
||
| _Created: 2026-03-09_ | ||
| _Updated: 2026-03-12 (consolidated and reordered per reviewer feedback)_ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The execution-order table links to
./store-event-wiring-migration.mdand five similar files that are not present in this commit, so readers following the "single entry point" guidance hit dead links immediately and cannot continue the migration workflow. I verified the scope underpackages/contact-center/ai-docs/migrationin this tree and onlymigration-overview.mdexists, so these references need to be updated (or clearly marked as pending) to avoid blocking migration work.Useful? React with 👍 / 👎.