Merge pull request #649 from techmatters/CHI-2790-native_channel_aler…

…t_service_user_unsupported_media

CHI-2790: Alert service user for unsupported media

functions/helpers/sendErrorMessageForUnsupportedMedia.private.ts

@@ -0,0 +1,94 @@
+/**
+ * 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/.
+ */
+
+import { Context } from '@twilio-labs/serverless-runtime-types/types';
+
+export type ConversationSid = `CH${string}`;
+
+type SendErrorMessageForUnsupportedMediaEvent = {
+  Body?: string;
+  ConversationSid: ConversationSid;
+  EventType?: string;
+  Media?: Record<string, any>;
+  DateCreated: Date;
+};
+
+export type Event = SendErrorMessageForUnsupportedMediaEvent;
+
+export const sendConversationMessage = async (
+  context: Context,
+  {
+    conversationSid,
+    author,
+    messageText,
+    messageAttributes,
+  }: {
+    conversationSid: ConversationSid;
+    author: string;
+    messageText: string;
+    messageAttributes?: string;
+  },
+) =>
+  context
+    .getTwilioClient()
+    .conversations.conversations.get(conversationSid)
+    .messages.create({
+      body: messageText,
+      author,
+      xTwilioWebhookEnabled: 'true',
+      ...(messageAttributes && { attributes: messageAttributes }),
+    });
+
+const getTimeDifference = async (isoString: Date): Promise<string> => {
+  const unitCheck = (count: number, unit: string) => (count > 1 ? `${unit}s` : unit);
+  // Create a new Date object from the ISO string
+  const givenDate = new Date(isoString);
+
+  // Get the current date and time
+  const currentDate = new Date();
+
+  // Calculate the difference in milliseconds
+  const differenceInMillis = currentDate.getTime() - givenDate.getTime();
+
+  // Convert the difference to seconds
+  const differenceInSeconds = Math.floor(differenceInMillis / 1000);
+  const differenceInMinutes = Math.floor(differenceInSeconds / 60);
+
+  // Determine whether to return the difference in seconds or minutes
+  return differenceInSeconds < 60
+    ? `${differenceInSeconds} ${unitCheck(differenceInSeconds, 'second')}`
+    : `${differenceInMinutes} ${unitCheck(differenceInMinutes, 'minute')}`;
+};
+
+export const sendErrorMessageForUnsupportedMedia = async (context: Context, event: Event) => {
+  const { EventType, Body, Media, ConversationSid, DateCreated } = event;
+
+  /* Valid message will have either a body/media. A message with no
+     body or media implies that there was an error sending such message
+  */
+  if (EventType === 'onMessageAdded' && !Body && !Media) {
+    const messageTime = await getTimeDifference(DateCreated);
+    const messageText = `Sorry, the message sent ${messageTime} ago is unsupported and could not be delivered.`;
+
+    await sendConversationMessage(context, {
+      conversationSid: ConversationSid,
+      author: 'Bot',
+      messageText,
+    });
+  }
+};
+
+export type SendErrorMessageForUnsupportedMedia = typeof sendErrorMessageForUnsupportedMedia;

functions/webhooks/serviceConversationListener.protected.ts

@@ -0,0 +1,38 @@
+/**
+ * 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/.
+ */
+
+import { Context, ServerlessCallback } from '@twilio-labs/serverless-runtime-types/types';
+import { responseWithCors, bindResolve, error500 } from '@tech-matters/serverless-helpers';
+import {
+  Event,
+  SendErrorMessageForUnsupportedMedia,
+} from '../helpers/sendErrorMessageForUnsupportedMedia.private';
+
+export const handler = async (context: Context, event: Event, callback: ServerlessCallback) => {
+  const response = responseWithCors();
+  const resolve = bindResolve(callback)(response);
+  // eslint-disable-next-line global-require,import/no-dynamic-require
+  const sendErrorMessageForUnsupportedMedia = require(Runtime.getFunctions()[
+    'helpers/sendErrorMessageForUnsupportedMedia'
+  ].path).sendErrorMessageForUnsupportedMedia as SendErrorMessageForUnsupportedMedia;
+
+  try {
+    await sendErrorMessageForUnsupportedMedia(context, event);
+  } catch (err) {
+    if (err instanceof Error) resolve(error500(err));
+    else resolve(error500(new Error(String(err))));
+  }
+};