ATO-814: Added error handling to cognito sms lambda.

backend/cognito/package.json

@@ -10,6 +10,7 @@
   },
   "dependencies": {
     "@aws-sdk/client-ses": "^3.609.0",
+    "@aws-lambda-powertools/logger": "2.6.0",
     "notifications-node-client": "^7.0.0",
     "esbuild": "^0.23.0",
     "@aws-crypto/client-node": "^3.2.0"

backend/cognito/src/handlers/send-security-code-text-message.ts

@@ -1,7 +1,8 @@
-import {CustomSMSSenderTriggerEvent} from "aws-lambda";
+import {Context, CustomSMSSenderTriggerEvent, APIGatewayProxyResult} from "aws-lambda";
 import {NotifyClient} from "notifications-node-client";
 import {toByteArray} from "base64-js";
 import {buildClient, CommitmentPolicy, KmsKeyringNode} from "@aws-crypto/client-node";
+import {Logger} from "@aws-lambda-powertools/logger";
 
 const {decrypt} = buildClient(CommitmentPolicy.REQUIRE_ENCRYPT_ALLOW_DECRYPT);
 const generatorKeyId = process.env.DECRYPTION_KEY_ARN;
@@ -10,19 +11,30 @@ const keyring = new KmsKeyringNode({generatorKeyId});
 const apiKey = process.env.NOTIFY_API_KEY;
 const templateId = process.env.SECURITY_CODE_TEXT_MESSAGE_TEMPLATE;
 const notifyClient = new NotifyClient(apiKey);
+const logger = new Logger({
+    serviceName: "self-service-experience"
+});
+
+export const lambdaHandler = async (event: CustomSMSSenderTriggerEvent, context: Context): Promise<void> => {
+    logger.addContext(context);
 
-export const lambdaHandler = async (event: CustomSMSSenderTriggerEvent): Promise<void> => {
     if (!event.request.code) {
+        logger.error("No request code provided, failed to send sms.");
         throw new Error("Missing code parameter");
     }
 
-    const plainTextCode = await decryptText(event.request.code);
-    const phoneNumber = event.request.userAttributes.phone_number;
+    try {
+        const plainTextCode = await decryptText(event.request.code);
+        const phoneNumber = event.request.userAttributes.phone_number;
 
-    await notifyClient.sendSms(templateId, phoneNumber, {
-        personalisation: {code: plainTextCode},
-        reference: null
-    });
+        await notifyClient.sendSms(templateId, phoneNumber, {
+            personalisation: {code: plainTextCode},
+            reference: null
+        });
+    } catch (e) {
+        logger.error("Failed to send security code sms", e);
+        throw e;
+    }
 };
 
 async function decryptText(encryptedText: string): Promise<string> {

backend/cognito/tests/handlers/security-code-text-message-sender.test.ts

@@ -33,11 +33,11 @@ process.env.SECURITY_CODE_TEXT_MESSAGE_TEMPLATE = templateId;
 
 import {toByteArray} from "base64-js";
 import {lambdaHandler} from "../../src/handlers/send-security-code-text-message";
-import {smsSenderTrigger} from "../mocks";
+import {lambdaContext, smsSenderTrigger} from "../mocks";
 
 describe("Custom SMS sender", () => {
     it("Send SMS with a security code", async () => {
-        await lambdaHandler(smsSenderTrigger(phoneNumber, encryptedCode));
+        await lambdaHandler(smsSenderTrigger(phoneNumber, encryptedCode), lambdaContext);
 
         expect(sendSms).toBeCalledTimes(1);
         expect(sendSms.mock.calls[0][0]).toBe(templateId);
@@ -52,6 +52,6 @@ describe("Custom SMS sender", () => {
     });
 
     it("Throw an error for missing code", async () => {
-        await expect(lambdaHandler(smsSenderTrigger(phoneNumber))).rejects.toThrow(/missing.*code/i);
+        await expect(lambdaHandler(smsSenderTrigger(phoneNumber), lambdaContext)).rejects.toThrow(/missing.*code/i);
     });
 });

backend/cognito/tests/mocks.ts

@@ -1,8 +1,31 @@
-import {CustomMessageForgotPasswordTriggerEvent, CustomSMSSenderTriggerEvent} from "aws-lambda";
+import {Context, CustomMessageForgotPasswordTriggerEvent, CustomSMSSenderTriggerEvent} from "aws-lambda";
 
 export const smsSenderTrigger = (number: string, code?: string) =>
     ({request: {code: code, userAttributes: {phone_number: number}}} as unknown as CustomSMSSenderTriggerEvent);
 
+export const lambdaContext: Context = {
+    callbackWaitsForEmptyEventLoop: false,
+    functionName: "mocked",
+    functionVersion: "mocked",
+    invokedFunctionArn: "mocked",
+    memoryLimitInMB: "mocked",
+    awsRequestId: "mocked",
+    logGroupName: "mocked",
+    logStreamName: "mocked",
+    getRemainingTimeInMillis(): number {
+        return 999;
+    },
+    done(): void {
+        return;
+    },
+    fail(): void {
+        return;
+    },
+    succeed(): void {
+        return;
+    }
+};
+
 export const TEST_PROTOCOL = "https";
 export const TEST_HOST = "some.service.gov.uk";
 export const TEST_CODE_PARAM = "12345";