-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #730 from techmatters/CHI-3069-backend_contact_create
CHI-3069: Backend contact create
- Loading branch information
Showing
8 changed files
with
835 additions
and
113 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
This file contains 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
191 changes: 191 additions & 0 deletions
191
functions/taskrouterListeners/createHrmContactListener.private.ts
This file contains 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,191 @@ | ||
| /** | ||
| * 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 { Context } from '@twilio-labs/serverless-runtime-types/types'; | ||
|
|
||
| import { | ||
| EventFields, | ||
| EventType, | ||
| RESERVATION_ACCEPTED, | ||
| TaskrouterListener, | ||
| } from '@tech-matters/serverless-helpers/taskrouter'; | ||
| import { HrmContact, PrepopulateForm } from '../hrm/populateHrmContactFormFromTask'; | ||
|
|
||
| export const eventTypes: EventType[] = [RESERVATION_ACCEPTED]; | ||
|
|
||
| type EnvVars = { | ||
| TWILIO_WORKSPACE_SID: string; | ||
| CHAT_SERVICE_SID: string; | ||
| HRM_STATIC_KEY: string; | ||
| }; | ||
|
|
||
| // Temporarily copied to this repo, will share the flex types when we move them into the same repo | ||
|
|
||
| const BLANK_CONTACT: HrmContact = { | ||
| id: '', | ||
| timeOfContact: new Date().toISOString(), | ||
| taskId: null, | ||
| helpline: '', | ||
| rawJson: { | ||
| childInformation: {}, | ||
| callerInformation: {}, | ||
| caseInformation: {}, | ||
| callType: '', | ||
| contactlessTask: { | ||
| channel: 'web', | ||
| date: '', | ||
| time: '', | ||
| createdOnBehalfOf: '', | ||
| helpline: '', | ||
| }, | ||
| categories: {}, | ||
| }, | ||
| channelSid: '', | ||
| serviceSid: '', | ||
| channel: 'default', | ||
| createdBy: '', | ||
| createdAt: '', | ||
| updatedBy: '', | ||
| updatedAt: '', | ||
| queueName: '', | ||
| number: '', | ||
| conversationDuration: 0, | ||
| csamReports: [], | ||
| conversationMedia: [], | ||
| }; | ||
|
|
||
| /** | ||
| * Checks the event type to determine if the listener should handle the event or not. | ||
| * If it returns true, the taskrouter will invoke this listener. | ||
| */ | ||
| export const shouldHandle = ({ | ||
| TaskAttributes: taskAttributesString, | ||
| TaskSid: taskSid, | ||
| EventType: eventType, | ||
| }: EventFields) => { | ||
| if (!eventTypes.includes(eventType)) return false; | ||
|
|
||
| const { isContactlessTask, transferTargetType } = JSON.parse(taskAttributesString ?? '{}'); | ||
|
|
||
| if (isContactlessTask) { | ||
| console.debug(`Task ${taskSid} is a contactless task, contact was already created in Flex.`); | ||
| return false; | ||
| } | ||
|
|
||
| if (transferTargetType) { | ||
| console.debug( | ||
| `Task ${taskSid} was created to receive a ${transferTargetType} transfer. The original contact will be used so a new one will not be created.`, | ||
| ); | ||
| return false; | ||
| } | ||
| return true; | ||
| }; | ||
|
|
||
| export const handleEvent = async ( | ||
| { getTwilioClient, HRM_STATIC_KEY, TWILIO_WORKSPACE_SID }: Context<EnvVars>, | ||
| { TaskAttributes: taskAttributesString, TaskSid: taskSid, WorkerSid: workerSid }: EventFields, | ||
| ) => { | ||
| const taskAttributes = taskAttributesString ? JSON.parse(taskAttributesString) : {}; | ||
| const { channelSid } = taskAttributes; | ||
|
|
||
| const client = getTwilioClient(); | ||
| const serviceConfig = await client.flexApi.configuration.get().fetch(); | ||
|
|
||
| const { | ||
| definitionVersion, | ||
| hrm_base_url: hrmBaseUrl, | ||
| hrm_api_version: hrmApiVersion, | ||
| form_definitions_version_url: configFormDefinitionsVersionUrl, | ||
| assets_bucket_url: assetsBucketUrl, | ||
| helpline_code: helplineCode, | ||
| channelType, | ||
| customChannelType, | ||
| feature_flags: { enable_backend_hrm_contact_creation: enableBackendHrmContactCreation }, | ||
| } = serviceConfig.attributes; | ||
| const formDefinitionsVersionUrl = | ||
| configFormDefinitionsVersionUrl || `${assetsBucketUrl}/form-definitions/${helplineCode}/v1`; | ||
| if (!enableBackendHrmContactCreation) { | ||
| console.debug( | ||
| `enable_backend_hrm_contact_creation is not set, the contact associated with task ${taskSid} will be created from Flex.`, | ||
| ); | ||
| return; | ||
| } | ||
| console.debug('Creating HRM contact for task', taskSid); | ||
| const hrmBaseAccountUrl = `${hrmBaseUrl}/${hrmApiVersion}/accounts/${serviceConfig.accountSid}`; | ||
|
|
||
| const newContact: HrmContact = { | ||
| ...BLANK_CONTACT, | ||
| channel: (customChannelType || channelType) as HrmContact['channel'], | ||
| rawJson: { | ||
| definitionVersion, | ||
| ...BLANK_CONTACT.rawJson, | ||
| }, | ||
| twilioWorkerId: workerSid as HrmContact['twilioWorkerId'], | ||
| taskId: taskSid as HrmContact['taskId'], | ||
| channelSid: channelSid ?? '', | ||
| serviceSid: (channelSid && serviceConfig.chatServiceInstanceSid) ?? '', | ||
| // We set createdBy to the workerSid because the contact is 'created' by the worker who accepts the task | ||
| createdBy: workerSid as HrmContact['createdBy'], | ||
| }; | ||
|
|
||
| const prepopulatePath = Runtime.getFunctions()['hrm/populateHrmContactFormFromTask'].path; | ||
| const { populateHrmContactFormFromTask } = require(prepopulatePath) as PrepopulateForm; | ||
| const populatedContact = await populateHrmContactFormFromTask( | ||
| taskAttributes, | ||
| newContact, | ||
| formDefinitionsVersionUrl, | ||
| ); | ||
| const options: RequestInit = { | ||
| method: 'POST', | ||
| body: JSON.stringify(populatedContact), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| Authorization: `Basic ${HRM_STATIC_KEY}`, | ||
| }, | ||
| }; | ||
| const response = await fetch(`${hrmBaseAccountUrl}/contacts`, options); | ||
| if (!response.ok) { | ||
| console.error( | ||
| `Failed to create HRM contact for task ${taskSid} - status: ${response.status} - ${response.statusText}`, | ||
| await response.text(), | ||
| ); | ||
| return; | ||
| } | ||
| const { id }: HrmContact = await response.json(); | ||
| console.info(`Created HRM contact with id ${id} for task ${taskSid}`); | ||
|
|
||
| const taskContext = client.taskrouter.v1.workspaces.get(TWILIO_WORKSPACE_SID).tasks.get(taskSid); | ||
| const currentTaskAttributes = (await taskContext.fetch()).attributes; // Less chance of race conditions if we fetch the task attributes again, still not the best... | ||
| const updatedAttributes = { | ||
| ...JSON.parse(currentTaskAttributes), | ||
| contactId: id.toString(), | ||
| }; | ||
| await taskContext.update({ attributes: JSON.stringify(updatedAttributes) }); | ||
| }; | ||
|
|
||
| /** | ||
| * The taskrouter callback expects that all taskrouter listeners return | ||
| * a default object of type TaskrouterListener. | ||
| */ | ||
| const createHrmContactListener: TaskrouterListener = { | ||
| shouldHandle, | ||
| handleEvent, | ||
| }; | ||
|
|
||
| export default createHrmContactListener; |
Oops, something went wrong.