[Feature breanch] Lex chatbot integration

.github/actions/main-action/action.yml

@@ -67,8 +67,14 @@ inputs:
   s3-bucket:
     description: 'S3 bucket name where Aselo documents are stored'
     required: true
-  helpline-name:
-    description: 'The identifier in the format "<short helpline>-<short env>" used for this helpline'
+  helpline-code:
+    description: 'The short (usually 2 character) upper case code used to identify the helpline internally, e.g. ZA, IN, BR.'
+    required: true
+  environment-code:
+    description: 'The short upper case code used to identify the environment internally, e.g. STG, PROD, DEV'
+    required: true
+  environment:
+    description: The environment to deploy to, e.g. staging, production, development (Yes, this is a duplicate of the above, but it's needed for the workflow to run... for now)
     required: true
   send-slack-message:
     description: 'Specifies if should send a Slack message at the end of successful run. Defaults to true'
@@ -81,6 +87,9 @@ inputs:
 runs:
   using: 'composite'
   steps:
+    - name: Set helpline-name
+      run: echo "helpline-name=${{ inputs.helpline-code }}_${{ inputs.environment-code }}" >> $GITHUB_ENV
+      shell: bash
     # Set any env vars needed from Parameter Store here
     # Slack env
     - name: Set GITHUB_ACTIONS_SLACK_BOT_TOKEN
@@ -100,6 +109,8 @@ runs:
     - name: Fill .env
       run: |
         cat <<EOT >> .env
+        HELPLINE_CODE=${{ inputs.helpline-code }}
+        ENVIRONMENT=${{ inputs.environment }}
         TWILIO_WORKSPACE_SID=${{ inputs.workspace-sid }}
         TWILIO_CHAT_TRANSFER_WORKFLOW_SID=${{ inputs.transfer-workflow-sid }}
         SYNC_SERVICE_API_KEY=${{ inputs.sync-service-api-key }}
@@ -131,7 +142,7 @@ runs:
     - name: Execute custom action (if any)
       uses: ./.github/actions/custom-actions
       with:
-        helpline-name: ${{ inputs.helpline-name }}
+        helpline-name: ${{ env.helpline-name }}
         account-sid: ${{ inputs.account-sid }}
     # Install dependencies for the twilio functions
     - name: Install dependencies for the twilio functions
@@ -170,6 +181,6 @@ runs:
       if: ${{ inputs.send-slack-message != 'false' }}
       with:
         channel-id: ${{ env.ASELO_DEPLOYS_CHANNEL_ID }}
-        slack-message: "`[Serverless]` Deployment to `${{ inputs.helpline-name }}` from ${{ github.ref_type }} `${{ github.ref_name }}` requested by `${{ github.triggering_actor }}` completed using workflow '${{ github.workflow }}' with SHA ${{ github.sha }} :rocket:."
+        slack-message: "`[Serverless]` Deployment to `${{ env.helpline-name }}` from ${{ github.ref_type }} `${{ github.ref_name }}` requested by `${{ github.triggering_actor }}` completed using workflow '${{ github.workflow }}' with SHA ${{ github.sha }} :rocket:."
       env:
         SLACK_BOT_TOKEN: ${{ env.GITHUB_ACTIONS_SLACK_BOT_TOKEN }}

.github/workflows/custom_helpline.yml

@@ -191,7 +191,9 @@ jobs:
           aselo-app-secret-key: $ASELO_APP_SECRET_KEY
           aws-region: $HELPLINE_AWS_REGION
           s3-bucket: $S3_BUCKET
-          helpline-name: ${{inputs.helpline_code}}_${{inputs.environment_code}}
+          helpline-code: ${{inputs.helpline_code}}
+          environment-code: ${{inputs.environment_code}}
+          environment: ${{inputs.environment}}
           # Set 'false' if the target environment is production OR the force_enable_operating_hours override option is checked - otherwise 'true'
           disable-operating-hours: ${{ (inputs.force_enable_operating_hours || inputs.environment_code == 'PROD') && 'false' || 'true' }}
           send-slack-message: ${{ inputs.send-slack-message }}

README.md

@@ -42,6 +42,8 @@ For help on twilio-run commands run:
 | `S3_ENDPOINT`                       | _local transcripts only_ http://localhost:4566                                                                 |
 | `ASELO_APP_ACCESS_KEY`              | AWS_ACCESS_KEY_ID with access to s3 bucket (can be any string for localstack)                                  |
 | `ASELO_APP_SECRET_KEY`              | AWS_SECRET_ACCESS_KEY for ASELO_APP_ACCESS_KEY (can be any string for localstack                               |
+| `HELPLINE_CODE`                     | The short (usually 2 character) upper case code used to identify the helpline internally, e.g. ZA, IN, BR.     |
+| `ENVIRONMENT_CODE`                  | The short upper case code used to identify the environment internally, e.g. STG, PROD, DEV                     |
 
 ## Deployment
 

functions/channelCapture/captureChannelWithBot.protected.ts

@@ -0,0 +1,99 @@
+/* eslint-disable import/no-dynamic-require */
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+/* eslint-disable global-require */
+/* eslint-disable import/no-dynamic-require */
+import '@twilio-labs/serverless-runtime-types';
+import {
+  responseWithCors,
+  bindResolve,
+  error400,
+  error500,
+  success,
+} from '@tech-matters/serverless-helpers';
+import type { Context, ServerlessCallback } from '@twilio-labs/serverless-runtime-types/types';
+import type {
+  ChannelCaptureHandlers,
+  HandleChannelCaptureParams,
+} from './channelCaptureHandlers.private';
+import type { AWSCredentials } from './lexClient.private';
+
+type EnvVars = {
+  HELPLINE_CODE: string;
+  ENVIRONMENT: string;
+  CHAT_SERVICE_SID: string;
+  TWILIO_WORKSPACE_SID: string;
+  SURVEY_WORKFLOW_SID: string;
+  HRM_STATIC_KEY: string;
+} & AWSCredentials;
+
+export type Body = Partial<HandleChannelCaptureParams>;
+
+export const handler = async (
+  context: Context<EnvVars>,
+  event: Body,
+  callback: ServerlessCallback,
+) => {
+  console.log('===== captureChannelWithBot handler =====');
+  const response = responseWithCors();
+  const resolve = bindResolve(callback)(response);
+
+  try {
+    const {
+      channelSid,
+      message,
+      triggerType,
+      releaseType,
+      studioFlowSid,
+      language,
+      botSuffix,
+      additionControlTaskAttributes,
+      controlTaskTTL,
+      memoryAttribute,
+      releaseFlag,
+    } = event;
+
+    const handlerPath = Runtime.getFunctions()['channelCapture/channelCaptureHandlers'].path;
+    const channelCaptureHandlers = require(handlerPath) as ChannelCaptureHandlers;
+
+    const result = await channelCaptureHandlers.handleChannelCapture(context, {
+      channelSid,
+      message,
+      language,
+      botSuffix,
+      triggerType,
+      releaseType,
+      studioFlowSid,
+      memoryAttribute,
+      releaseFlag,
+      additionControlTaskAttributes,
+      controlTaskTTL,
+    });
+
+    if (result.status === 'failure' && result.validationResult.status === 'invalid') {
+      resolve(error400(result.validationResult.error));
+      return;
+    }
+
+    resolve(success('Channel captured by bot =)'));
+  } catch (err) {
+    if (err instanceof Error) resolve(error500(err));
+    else resolve(error500(new Error(String(err))));
+  }
+};
+
+export type CaptureChannelWithBot = { handler: typeof handler };