CHI-3641: Add channel_type attribute to new aselo webchat conversations. by stephenhand · Pull Request #4087 · techmatters/flex-plugins

stephenhand · 2026-03-23T10:57:45Z

Description

Replace call to deprecated API with reusing the conversation creation logic we use for custom channels (createConversation). Adds channel_type: 'web' to conversation attributes by passing channelType: 'web' through the shared createConversation flow, and uses getChannelStudioFlowSid to retrieve the studio flow SID from SSM.

Unit tests for initWebchat.ts have been rewritten to align with the updated flow: mocks for the deprecated webChannels.create and patchConversationAttributes have been replaced with mocks for createConversation and getChannelStudioFlowSid, with coverage for correct parameter passing, friendly name fallbacks, pre-engagement data attributes, error handling, and token generation.

Checklist

Corresponding issue has been opened
New tests added
[n/a] Feature flags added
[n/a] Strings are localized
Tested for chat contacts
[n/a] Tested for call contacts

Other Related Issues

None

Verification steps

Create a new webchat conversation and confirm the conversation attributes include channel_type: 'web'. Verify studio flows that branch on channel_type route correctly for webchat contacts.

AFTER YOU MERGE

Cut a release tag using the Github workflow. Wait for it to complete and notify in the #aselo-deploys Slack channel.
Comment on the ticket with the release tag version AND any additional instructions required to configure an environment to test the changes.
Only then move the ticket into the QA column in JIRA

You are responsible for ensuring the above steps are completed. If you move a ticket into QA without advising what version to test, the QA team will assume the latest tag has the changes. If it does not, the following confusion is on you! :-P

⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

… redundant proxy session check from conversations path of the channel janitor

stephenhand · 2026-03-23T11:50:22Z

@copilot - add unit test coverage for the updated initWebchat.ts

client.flexApi.v2.webChannels.create and patchConversationAttributes are calls with side effects, explicitly check they are invoked

Copilot · 2026-03-23T11:50:28Z

@stephenhand I've opened a new pull request, #4088, to work on those changes. Once the pull request is ready, I'll request review from you.

…chConversationAttributes invocations Co-authored-by: stephenhand <1694716+stephenhand@users.noreply.github.com> Agent-Logs-Url: https://github.com/techmatters/flex-plugins/sessions/0c6cb863-13ab-44ab-91d9-a12ec2bf6070

… channel type

Agent-Logs-Url: https://github.com/techmatters/flex-plugins/sessions/fbbe4f24-9cb2-48aa-9a23-babf6b3bd84e Co-authored-by: stephenhand <1694716+stephenhand@users.noreply.github.com>

CHI-3641: Add channel_type attribute to new aselo webchat conversations.

stephenhand · 2026-03-27T17:08:30Z

@copilot fix the failing unit tests to align with the updated conversation creation process, remove any redundant ones and add new ones to address gaps in coverage of the new workflow

…flow Agent-Logs-Url: https://github.com/techmatters/flex-plugins/sessions/be435f5c-b653-4f28-a304-9149792dac99 Co-authored-by: stephenhand <1694716+stephenhand@users.noreply.github.com>

Copilot · 2026-03-27T17:19:41Z

@copilot fix the failing unit tests to align with the updated conversation creation process, remove any redundant ones and add new ones to address gaps in coverage of the new workflow

Done in 25bfa84. The test file has been fully rewritten to align with the new flow:

Removed (no longer relevant):

Mocks for webChannels.create and patchConversationAttributes
Tests asserting the old webChannels.create arguments, patchConversationAttributes invocation, and the old "Customer" fallback name

Updated/added (covering the new workflow):

Mocks for createConversation and getChannelStudioFlowSid
getChannelStudioFlowSid called with accountSid and 'web'
createConversation called with all expected params (channelType: 'web', studioFlowSid, conversationFriendlyName, senderScreenName, twilioNumber: web:<accountSid>, uniqueUserName matching /^web:/, additionalConversationAttributes with pre_engagement_data and from)
createToken called with the identity passed as uniqueUserName to createConversation
Success result shape (token, conversationSid, expiration)
Error when createConversation throws (verifies createToken is not called)
Friendly name from CustomerFriendlyName body field when absent in form data
Fallback to 'Anonymous' (including from field in attributes)
Pre-engagement form data correctly set as additionalConversationAttributes.pre_engagement_data

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

mock-ssm
- Triggering command: /opt/hostedtoolcache/node/20.20.1/x64/bin/node node /home/REDACTED/work/flex-plugins/flex-plugins/lambdas/node_modules/.bin/jest tests/unit/webchatAuthentication/initWebchat.test.ts --no-coverage (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot

Pull request overview

This PR updates the webchat conversation initialization flow to use the shared Conversations creation helper (instead of the deprecated Flex WebChannels API), ensuring new webchat conversations include channel_type: 'web' in their attributes and use a Studio Flow SID retrieved from SSM. It also aligns several unit tests and custom-channel call sites with the updated conversation creation/webhook naming.

Changes:

Replace deprecated webchat conversation creation with shared createConversation(...), passing channelType: 'web' and retrieving the Studio Flow SID via getChannelStudioFlowSid(...).
Introduce shared conversation utilities (createConversation, patchConversationAttributes) and refactor custom channels to use onMessageAddedWebhookUrl naming.
Update/adjust unit tests to reflect new behavior (web conversations supported in HRM sanitization/profile-flag flows, janitor behavior changes, and rewritten webchat init tests).

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
lambdas/account-scoped/src/webchatAuthentication/initWebchat.ts	Webchat now creates conversations via shared helper and uses SSM Studio Flow SID.
lambdas/account-scoped/tests/unit/webchatAuthentication/initWebchat.test.ts	New unit tests for the updated init flow and parameter passing.
lambdas/account-scoped/src/conversation/createConversation.ts	New shared conversation creation helper that sets attributes and webhooks.
lambdas/account-scoped/src/conversation/patchConversationAttributes.ts	New helper to patch conversation attributes.
lambdas/account-scoped/src/customChannels/customChannelToFlex.ts	Refactor to import shared `createConversation` and rename webhook param.
lambdas/account-scoped/src/customChannels//ToFlex.ts	Update call sites to pass `onMessageAddedWebhookUrl` (renames/aliases).
lambdas/account-scoped/src/customChannels/configuration.ts	Allow `getChannelStudioFlowSid` to accept `'web'` as a channel name.
lambdas/account-scoped/src/hrm/sanitizeIdentifier.ts	Allow web conversation triggers to sanitize without error (behavior change).
lambdas/account-scoped/tests/unit/hrm/sanitizeIdentifier.test.ts	Update expectations for web conversation trigger behavior.
lambdas/account-scoped/tests/unit/hrm/getProfileFlagsForIdentifier.test.ts	Update expectations for web conversation channel behavior.
lambdas/account-scoped/src/conversation/chatChannelJanitor.ts	Stop deleting proxy sessions when deactivating conversations (behavior change).
lambdas/account-scoped/tests/unit/conversation/chatChannelJanitor.test.ts	Remove test coverage for proxy-session deletion on conversation deactivation.

Comments suppressed due to low confidence (1)

lambdas/account-scoped/src/conversation/chatChannelJanitor.ts:106

chatChannelJanitor's file header says it will delete the associated proxy session, but deactivateConversation no longer checks conversation attributes for proxySession or deletes it (only deactivateChannel does). Either update the documentation to reflect the new behavior or restore proxy-session cleanup for conversation-based flows if conversations can still have proxySession attributes.

const deactivateConversation = async (
  accountSid: AccountSID,
  conversationSid: ConversationSID,
) => {
  const client = await getTwilioClient(accountSid);
  const conversation = await client.conversations.v1.conversations
    .get(conversationSid)
    .fetch();

  if (conversation.state !== 'closed') {
    console.info('Attempting to deactivate active conversation', conversationSid);
    const updated = await conversation.update({
      state: 'closed',
      xTwilioWebhookEnabled: 'true',
    });

lambdas/account-scoped/src/conversation/patchConversationAttributes.ts

Copilot · 2026-03-30T12:49:09Z

lambdas/account-scoped/src/conversation/createConversation.ts

+  channelType: AseloCustomChannel | 'web'; // The chat channel being used
+  uniqueUserName: string; // Unique identifier for this user
+  senderScreenName: string; // Friendly info to show in the Flex UI (like Telegram handle)
+  onMessageAddedWebhookUrl?: string; // The url that must be used as the onMessageSent event webhook.


onMessageAddedWebhookUrl is documented as "onMessageSent" in the inline comment, which is misleading now that the webhook is subscribed to the onMessageAdded filter. Update the comment to match the actual behavior (and consider renaming any remaining references to onMessageSent if they exist).

Suggested change

onMessageAddedWebhookUrl?: string; // The url that must be used as the onMessageSent event webhook.

onMessageAddedWebhookUrl?: string; // The url that must be used as the onMessageAdded event webhook.

Copilot · 2026-03-30T12:49:10Z

lambdas/account-scoped/src/webchatAuthentication/initWebchat.ts

    const client = await getTwilioClient(accountSid);
-    const orchestratorResponse = await client.flexApi.v2.webChannels.create({
-      customerFriendlyName,
-      addressSid,
-      preEngagementData: JSON.stringify(formData),
-      uiVersion: process.env.WEBCHAT_VERSION || '1.0.0',
-      chatFriendlyName: 'Webchat widget',
+    const conversation = await createConversation(client, {
+      channelType: 'web',
+      conversationFriendlyName: customerFriendlyName,
+      senderScreenName: customerFriendlyName,
+      studioFlowSid,
+      testSessionId,
+      twilioNumber: `web:${accountSid}`,
+      uniqueUserName: senderId,
+      additionalConversationAttributes: {
+        pre_engagement_data: formData,
+        from: customerFriendlyName,
+      },
    });
-    console.info('Webchat Orchestrator successfully called', orchestratorResponse);

-    const { conversationSid, identity } = orchestratorResponse;
+    const { conversationSid } = conversation;
+    console.info(
+      `Created new conversation ${conversationSid} via the API with sender ID: ${senderId}`,
+    );

    return newOk({
      conversationSid: conversationSid as ConversationSID,
-      identity,
+      identity: senderId,
    });


createConversation returns { conversationSid, error? } rather than throwing on post-create failures (participants/attributes/webhooks). Here the error field is ignored, so contactWebchatOrchestrator can return Ok even when conversation setup failed, and token creation will proceed for a broken conversation. Handle the returned error (and consider removing the partially created conversation, similar to customChannelToFlex) or change createConversation to throw on failure.

Copilot · 2026-03-30T12:49:10Z

lambdas/account-scoped/src/webchatAuthentication/initWebchat.ts

+  const senderId = `web:${crypto.randomUUID()}`;
+  console.info(`Creating new conversation via the API with sender ID: ${senderId}`);


crypto.randomUUID() is used without importing crypto. In this codebase other usages import from crypto (e.g. import crypto from 'crypto'), and relying on a global may fail depending on TS libs/runtime. Import crypto explicitly (or use an existing UUID helper) to avoid build/runtime issues.

…butes.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ibute' into CHI-3641-channel_type_convo_attribute

stephenhand added 3 commits March 23, 2026 10:23

Add channel_type attribute to new aselo webchat conversations. Remove…

b7d8fe6

… redundant proxy session check from conversations path of the channel janitor

Fix reference

4cd237b

Remove conversations proxy session test

bf199ae

Initial plan

7175060

Copilot AI mentioned this pull request Mar 23, 2026

CHI-3641: Add channel_type attribute to new aselo webchat conversations. #4088

Merged

3 tasks

Copilot AI and others added 8 commits March 23, 2026 11:59

Rework to create conversations like custom channels

caba9e6

Licence header

59820c6

Fix webchat attributes

fae9c3e

Fix webchat attributes & getProfileIdentifier for conversations 'web'…

9f450ed

… channel type

Fix tests

ad2937c

Fix Prettier lint errors in initWebchat.test.ts

1296eb2

Agent-Logs-Url: https://github.com/techmatters/flex-plugins/sessions/fbbe4f24-9cb2-48aa-9a23-babf6b3bd84e Co-authored-by: stephenhand <1694716+stephenhand@users.noreply.github.com>

Merge pull request #4088 from techmatters/copilot/sub-pr-4087

60536ef

CHI-3641: Add channel_type attribute to new aselo webchat conversations.

Copilot started work on behalf of stephenhand March 27, 2026 17:10 View session

Rewrite initWebchat.test.ts to align with updated createConversation …

25bfa84

…flow Agent-Logs-Url: https://github.com/techmatters/flex-plugins/sessions/be435f5c-b653-4f28-a304-9149792dac99 Co-authored-by: stephenhand <1694716+stephenhand@users.noreply.github.com>

Copilot finished work on behalf of stephenhand March 27, 2026 17:22

stephenhand marked this pull request as ready for review March 27, 2026 17:40

stephenhand requested review from Copilot and gpaoloni March 30, 2026 12:44

Copilot started reviewing on behalf of stephenhand March 30, 2026 12:44 View session

Merge branch 'master' into CHI-3641-channel_type_convo_attribute

8380caf

Copilot AI reviewed Mar 30, 2026

View reviewed changes

stephenhand and others added 4 commits March 30, 2026 13:51

Update lambdas/account-scoped/src/conversation/patchConversationAttri…

3782d5b

…butes.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update lambdas/account-scoped/src/conversation/patchConversationAttri…

6be0704

…butes.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix contactWebchatOrchestrator error handling

3845943

Merge remote-tracking branch 'origin/CHI-3641-channel_type_convo_attr…

79b08ff

…ibute' into CHI-3641-channel_type_convo_attribute

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CHI-3641: Add channel_type attribute to new aselo webchat conversations.#4087

CHI-3641: Add channel_type attribute to new aselo webchat conversations.#4087
stephenhand wants to merge 18 commits intomasterfrom
CHI-3641-channel_type_convo_attribute

stephenhand commented Mar 23, 2026 •

edited by Copilot AI

Loading

Uh oh!

stephenhand commented Mar 23, 2026

Uh oh!

Copilot AI commented Mar 23, 2026

Uh oh!

stephenhand commented Mar 27, 2026

Uh oh!

Copilot AI commented Mar 27, 2026 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	onMessageAddedWebhookUrl?: string; // The url that must be used as the onMessageSent event webhook.
	onMessageAddedWebhookUrl?: string; // The url that must be used as the onMessageAdded event webhook.

		const senderId = `web:${crypto.randomUUID()}`;
		console.info(`Creating new conversation via the API with sender ID: ${senderId}`);

Conversation

stephenhand commented Mar 23, 2026 • edited by Copilot AI Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Other Related Issues

Verification steps

AFTER YOU MERGE

Uh oh!

stephenhand commented Mar 23, 2026

Uh oh!

Copilot AI commented Mar 23, 2026

Uh oh!

stephenhand commented Mar 27, 2026

Uh oh!

Copilot AI commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stephenhand commented Mar 23, 2026 •

edited by Copilot AI

Loading

Copilot AI commented Mar 27, 2026 •

edited

Loading