CHI-3711: POC for voice and sms E2E tests - CI only

e2e-tests/chatScripts.ts

@@ -80,3 +80,65 @@ export const getWebchatScript = (): ChatStatement[] => {
 
   return defaultScript;
 };
+
+/**
+ * SMS scripts are structurally the same as webchat scripts (using the same ChatStatement format),
+ * but must start with a CALLER statement since the client must initiate an SMS conversation.
+ * BOT messages are expected to arrive after the client sends its first message.
+ */
+export const defaultSmsScript: ChatStatement[] = [
+  callerStatement('hi'),
+  botStatement('Welcome to the helpline. Please answer the following questions.'),
+  callerStatement('yes'),
+  botStatement('How old are you?'),
+  callerStatement('10'),
+  botStatement('What is your gender?'),
+  callerStatement('girl'),
+  botStatement('We will transfer you now. Please hold for a counsellor.'),
+  counselorAutoStatement('Hi, this is the counsellor. How can I help you?'),
+  callerStatement('CALLER TEST SMS MESSAGE'),
+  counselorStatement('COUNSELLOR TEST SMS MESSAGE'),
+];
+
+export const smsCommonScripts: Record<string, ChatStatement[]> = {
+  ca: [
+    callerStatement('CALLER TEST SMS MESSAGE'),
+    counselorAutoStatement("Hi, you've reached a counsellor. What would you like to talk about?"),
+    counselorStatement('COUNSELLOR TEST SMS MESSAGE'),
+  ],
+};
+
+export const smsEnvScripts: Record<string, Record<string, ChatStatement[]>> = {
+  development: {
+    as: [
+      callerStatement('hi'),
+      botStatement("Sorry, I didn't understand that. Please try again."),
+      callerStatement('hi'),
+      botStatement('Are you calling about yourself? Please answer Yes or No.'),
+      callerStatement('yes'),
+      botStatement('How old are you?'),
+      callerStatement('10'),
+      botStatement('What is your gender?'),
+      callerStatement('girl'),
+      botStatement("We'll transfer you now. Please hold for a counsellor."),
+      counselorAutoStatement('Hi, this is the counsellor. How can I help you?'),
+      callerStatement('CALLER TEST SMS MESSAGE'),
+      counselorStatement('COUNSELLOR TEST SMS MESSAGE'),
+    ],
+  },
+};
+
+export const getSmsScript = (): ChatStatement[] => {
+  const helplineShortCode = getConfigValue('helplineShortCode') as string;
+  const helplineEnv = getConfigValue('helplineEnv') as string;
+
+  if (smsEnvScripts[helplineEnv]?.[helplineShortCode]) {
+    return smsEnvScripts[helplineEnv][helplineShortCode];
+  }
+
+  if (smsCommonScripts[helplineShortCode]) {
+    return smsCommonScripts[helplineShortCode];
+  }
+
+  return defaultSmsScript;
+};

e2e-tests/config.ts

@@ -41,7 +41,10 @@ export type Config = {
 };
 
 const helplineShortCode = process.env.HL?.toLocaleLowerCase() || 'e2e';
+// Account to initiate calls into the helpline under test from, for testing voice & SMS
 const helplineEnv = process.env.HL_ENV?.toLocaleLowerCase() || 'local';
+const clientHelplineShortCode = process.env.CLIENT_HL?.toLocaleLowerCase() || 'as';
+const clientHelplineEnv = process.env.CLIENT_HL_ENV?.toLocaleLowerCase() || 'development';
 const shouldLoadFromSsm = process.env.LOAD_SSM_CONFIG && process.env.LOAD_SSM_CONFIG !== 'false';
 
 // These are environments where we want to avoid tests or steps that update HRM data
@@ -135,6 +138,18 @@ const configOptions: ConfigOptions = {
     ssmPath: () => `/${localOverrideEnv}/twilio/${getConfigValue('twilioAccountSid')}/auth_token`,
   },
 
+  // The twilio account sid and auth token are used to target a flex account
+  clientTwilioAccountSid: {
+    envKey: 'CLIENT_TWILIO_ACCOUNT_SID',
+    ssmPath: `/${clientHelplineEnv}/twilio/${clientHelplineShortCode.toUpperCase()}/account_sid`,
+  },
+  clientTwilioAuthToken: {
+    envKey: 'CLIENT_TWILIO_AUTH_TOKEN',
+    // Order is important here. We use a function so that we can reference the clientTwilioAccountSid config value above.
+    ssmPath: () =>
+      `/${clientHelplineEnv}/twilio/${getConfigValue('clientTwilioAccountSid')}/auth_token`,
+  },
+
   // Turn on debug mode. Possibly unused.
   debug: {
     envKey: 'DEBUG',
@@ -180,6 +195,30 @@ const configOptions: ConfigOptions = {
     default: `https://assets-${localOverrideEnv}.tl.techmatters.org/aselo-webchat-react-app/${helplineShortCode}/?e2eTestMode=true`,
   },
 
+  // This should match the number set up for the Voice studio flow on the helpline under test
+  voicePhoneNumber: {
+    envKey: 'VOICE_PHONE_NUMBER',
+    default: '+12607821891',
+  },
+
+  // This should match the number set up on the clientTwilioAccountSid that can make outgoing calls
+  clientVoicePhoneNumber: {
+    envKey: 'CLIENT_VOICE_PHONE_NUMBER',
+    default: '+12064083885',
+  },
+
+  // This should match the number set up for the SMS studio flow on the helpline under test
+  smsPhoneNumber: {
+    envKey: 'SMS_PHONE_NUMBER',
+    default: () => getConfigValue('voicePhoneNumber'),
+  },
+
+  // This should match the number set up on the clientTwilioAccountSid that can send outgoing SMS messages
+  clientSmsPhoneNumber: {
+    envKey: 'CLIENT_SMS_PHONE_NUMBER',
+    default: () => getConfigValue('clientVoicePhoneNumber'),
+  },
+
   // inLambda is used to determine if we are running in a lambda or not and set other config values accordingly
   inLambda: {
     envKey: 'TEST_IN_LAMBDA',
@@ -256,7 +295,7 @@ const setConfigValueFromSsm = async (key: string) => {
       throw err;
     }
 
-    console.log(`Failed to load config value from SSM at ${option.ssmPath}. Using default value`);
+    console.warn(`Failed to load config value from SSM at ${option.ssmPath}. Using default value`);
 
     setConfigValue(key, typeof option.default === 'function' ? option.default() : option.default);
   }

e2e-tests/contactForm.ts

@@ -85,7 +85,7 @@ export function contactForm(page: Page) {
     }
   }
 
-  return {
+  const formApi = {
     selectChildCallType: async () => {
       const childCallTypeButton = selectors.childCallTypeButton();
       const responsePromise = page.waitForResponse('**/contacts/**');
@@ -100,6 +100,28 @@ export function contactForm(page: Page) {
         await tab.fill(tab);
       }
     },
+    fillWithContent: async (formContent: any) => {
+      await formApi.fill([
+        <ContactFormTab>{
+          id: 'childInformation',
+          label: 'TabbedForms-AddChildInfoTab',
+          fill: formApi.fillStandardTab,
+          items: formContent.childInformation,
+        },
+        <ContactFormTab<Categories>>{
+          id: 'categories',
+          label: 'TabbedForms-CategoriesTab',
+          fill: formApi.fillCategoriesTab,
+          items: formContent.categories,
+        },
+        <ContactFormTab>{
+          id: 'caseInformation',
+          label: 'TabbedForms-AddCaseInfoTab',
+          fill: formApi.fillStandardTab,
+          items: formContent.caseInformation,
+        },
+      ]);
+    },
     save: async ({ saveAndAddToCase }: { saveAndAddToCase?: boolean } = {}) => {
       const tab = {
         id: 'caseInformation',
@@ -124,5 +146,6 @@ export function contactForm(page: Page) {
     },
     fillCategoriesTab,
     fillStandardTab,
-  };
+  } as const;
+  return formApi;
 }

e2e-tests/deleteChatChannels.ts → e2e-tests/deleteConversations.ts

@@ -23,12 +23,13 @@
  * send new messages from the e2e test user.
  */
 
-import { deleteChatChannels } from './twilio/channels';
+import { deleteChatConversations, deleteSmsConversations } from './twilio/channels';
 import { initConfig } from './config';
 
 const main = async () => {
   await initConfig();
-  await deleteChatChannels();
+  await deleteChatConversations();
+  await deleteSmsConversations();
 };
 
 main();

e2e-tests/formContentsByHelpline.ts

@@ -27,7 +27,7 @@ export const formContentsByHelpline = {
       Accessibility: ['Education'],
     },
     caseInformation: {
-      callSummary: 'E2E TEST CALL',
+      callSummary: 'E2E TEST PREPOPULATED FORM',
     },
   },
   ca: {
@@ -54,3 +54,19 @@ export const formContentsByHelpline = {
     },
   },
 };
+
+export const formContentsByHelplineForEmptyForm = {
+  ...formContentsByHelpline,
+  e2e: {
+    ...formContentsByHelpline.e2e,
+    childInformation: {
+      ...formContentsByHelpline.e2e.childInformation,
+
+      gender: 'Unknown',
+      age: 'Unknown',
+    },
+    caseInformation: {
+      callSummary: 'E2E TEST EMPTY FORM',
+    },
+  },
+};

e2e-tests/package.json

@@ -5,19 +5,19 @@
   "main": "index.js",
   "scripts": {
     "postinstall": "npx playwright install chromium",
-    "deleteChatChannels": "tsx deleteChatChannels.ts",
+    "deleteChatChannels": "tsx deleteConversations.ts",
     "test": "npx playwright test --workers 1 ",
     "test:ui": "npx playwright test --workers 1 --config ui-tests/playwright.ui-test.config.ts",
-    "test:local": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true npm run test",
+    "test:local": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true npm run test -- --retries 0",
     "test:local-aselo-webchat": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true ASELO_WEBCHAT_URL=http://localhost:3001 npm run test -- --headed --debug --retries 0 aseloWebchat",
-    "test:local:debug": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true npm run test -- --headed --debug --retries 0 offline",
+    "test:local:debug": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true npm run test -- --headed --debug --retries 0",
     "test:development:as": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=development HL=as SKIP_DATA_UPDATE=true npm run test",
     "test:development:as:debug": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=development HL=as SKIP_DATA_UPDATE=true npm run test -- --headed --retries 0",
     "test:development:e2e": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=development HL=e2e npm run test",
     "test:development:e2e:local": "cross-env LOAD_SSM_CONFIG=true HL_ENV=development HL=e2e npm run test -- --headed",
-    "test:development:e2e:debug": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=development HL=e2e npm run test -- --headed --debug --retries 0 login",
+    "test:development:e2e:debug": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=development HL=e2e npm run test -- --headed --debug --retries 0",
     "test:staging:ca": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=staging HL=ca npm run test",
-    "test:staging:ca:headed": "cross-env LOAD_SSM_CONFIG=true HL_ENV=staging HL=ca npm test -- --headed --debug --retries 0 aseloWebchat",
+    "test:staging:ca:headed": "cross-env LOAD_SSM_CONFIG=true HL_ENV=staging HL=ca npm test -- --headed --debug --retries 0",
     "test:production:ca": "cross-env DEBUG=pw:api LOAD_SSM_CONFIG=true HL_ENV=production HL=ca npm run test",
     "lint": "eslint --ext ts .",
     "lint:fix": "npm run lint -- --fix .",

e2e-tests/playwright.config.ts

@@ -21,6 +21,8 @@ import { getConfigValue } from './config';
 
 const inLambda = getConfigValue('inLambda') as boolean;
 
+const browserArgs = ['--use-fake-ui-for-media-stream', '--use-fake-device-for-media-stream'];
+
 const playwrightConfig: PlaywrightTestConfig = {
   globalSetup: require.resolve('./global-setup'),
   use: {
@@ -40,6 +42,7 @@ const playwrightConfig: PlaywrightTestConfig = {
              * of chromium/Playwright. We use the `TEST_NAME` environment variable to set
              * a unique target for each test that runs in lambdas to avoid this issue.
              */
+            ...browserArgs,
             '--single-process',
             '--autoplay-policy=user-gesture-required',
             '--disable-background-networking',
@@ -81,11 +84,11 @@ const playwrightConfig: PlaywrightTestConfig = {
             '--disable-gpu',
             '--use-gl=swiftshader',
             '--autoplay-policy=no-user-gesture-required',
-            '--use-fake-ui-for-media-stream',
-            '--use-fake-device-for-media-stream',
           ],
         }
-      : {},
+      : {
+          args: browserArgs,
+        },
   },
   testDir: './tests',
   retries: inLambda ? 0 : 1,

e2e-tests/tests/aseloWebchat.spec.ts

@@ -23,7 +23,7 @@ import { getWebchatScript } from '../chatScripts';
 import { flexChat } from '../flexChat';
 import { skipTestIfNotTargeted } from '../skipTest';
 import { tasks } from '../tasks';
-import { Categories, contactForm, ContactFormTab } from '../contactForm';
+import { contactForm } from '../contactForm';
 import { deleteAllTasksInQueue } from '../twilio/tasks';
 import { notificationBar } from '../notificationBar';
 import { clickThroughTwilioPasteModals } from '../agent-desktop';
@@ -102,26 +102,7 @@ test.describe.serial('Aselo web chat caller', () => {
       throw new Error(`No form contents configured for helplineShortCode="${String(helpline)}"`);
     }
     const form = contactForm(pluginPage);
-    await form.fill([
-      <ContactFormTab>{
-        id: 'childInformation',
-        label: 'TabbedForms-AddChildInfoTab',
-        fill: form.fillStandardTab,
-        items: formContent.childInformation,
-      },
-      <ContactFormTab<Categories>>{
-        id: 'categories',
-        label: 'TabbedForms-CategoriesTab',
-        fill: form.fillCategoriesTab,
-        items: formContent.categories,
-      },
-      <ContactFormTab>{
-        id: 'caseInformation',
-        label: 'TabbedForms-AddCaseInfoTab',
-        fill: form.fillStandardTab,
-        items: formContent.caseInformation,
-      },
-    ]);
+    await form.fillWithContent(formContent);
 
     console.info('Saving form');
     await form.save();

e2e-tests/tests/offlineContact.spec.ts

@@ -15,14 +15,19 @@
  */
 
 import { expect, Page, request, test } from '@playwright/test';
-import { Categories, contactForm, ContactFormTab } from '../contactForm';
+import { contactForm, ContactFormTab } from '../contactForm';
 import { caseHome } from '../case';
 import { agentDesktop, navigateToAgentDesktop } from '../agent-desktop';
 import { skipTestIfDataUpdateDisabled, skipTestIfNotTargeted } from '../skipTest';
 import { notificationBar } from '../notificationBar';
 import { closePage, setupContextAndPage } from '../browser';
 import { apiHrmRequest } from '../hrm/hrmRequest';
 import { clearOfflineTask } from '../hrm/clearOfflineTask';
+import { getConfigValue } from '../config';
+import {
+  formContentsByHelpline,
+  formContentsByHelplineForEmptyForm,
+} from '../formContentsByHelpline';
 
 test.describe.serial('Offline Contact (with Case)', () => {
   skipTestIfNotTargeted();
@@ -56,6 +61,8 @@ test.describe.serial('Offline Contact (with Case)', () => {
     await agentDesktopPage.addOfflineContact();
 
     console.log('Starting filling form');
+    const helpline = getConfigValue('helplineShortCode') as keyof typeof formContentsByHelpline;
+    const formContent = formContentsByHelplineForEmptyForm[helpline];
 
     const form = contactForm(pluginPage);
     await form.selectChildCallType();
@@ -70,38 +77,8 @@ test.describe.serial('Offline Contact (with Case)', () => {
           helpline: 'Childline',
         },
       },
-      <ContactFormTab>{
-        id: 'childInformation',
-        label: 'TabbedForms-AddChildInfoTab',
-        fill: form.fillStandardTab,
-        items: {
-          firstName: 'E2E',
-          lastName: 'OFFLINE CONTACT',
-          gender: 'Unknown',
-          age: 'Unknown',
-          phone1: '1234512345',
-          province: 'Northern',
-          district: 'District A',
-        },
-      },
-      <ContactFormTab<Categories>>{
-        id: 'categories',
-        label: 'TabbedForms-CategoriesTab',
-        fill: form.fillCategoriesTab,
-        items: {
-          Accessibility: ['Education'],
-        },
-      },
-      <ContactFormTab>{
-        id: 'caseInformation',
-        label: 'TabbedForms-AddCaseInfoTab',
-        fill: form.fillStandardTab,
-        items: {
-          callSummary: 'E2E OFFLINE CONTACT',
-        },
-      },
     ]);
-
+    await form.fillWithContent(formContent);
     const beforeDate = new Date(); // Capture date here since we'll create case inmediately after saving contact
 
     // if (getConfigValue('skipDataUpdate') as boolean) {