FPAD-7877: Refactor send-sqs-message

Option to pass in an SqsClient to avoid creating it multiple times

Author: edlouth

src/commons/get-env-or-throw.ts

@@ -1,7 +1,12 @@
+import logger from './logger';
+
 const getEnvOrThrow = (name: string) => {
   const value = process.env[name];
 
-  if (!value) throw new Error(`Environment variable ${name} not found`);
+  if (!value) {
+    logger.error(`Environment variable ${name} not found`);
+    throw new Error(`Environment variable ${name} not found`);
+  }
 
   return value;
 };

src/handlers/tests/txma-handler.test.ts

@@ -94,6 +94,7 @@ describe('TxMA Handler', () => {
         },
       ],
       'delete_queue',
+      undefined,
     );
   });
 
@@ -115,6 +116,7 @@ describe('TxMA Handler', () => {
         },
       ],
       'intervention_queue',
+      undefined,
     );
   });
 

src/handlers/txma-handler.ts

@@ -1,7 +1,7 @@
 import { SQSEvent, Context } from 'aws-lambda';
 import logger from '../commons/logger';
 import { TxMAEgressEvent } from '../data-types/interfaces';
-import { sendBatchSqsMessage } from '../services/send-sqs-message';
+import { createSqsClient, sendBatchSqsMessage } from '../services/send-sqs-message';
 import { addMetric, metric } from '../commons/metrics';
 import { MetricNames } from '../data-types/constants';
 import { AccountDeleteMessage } from '../contracts/account-delete-message';
@@ -52,11 +52,14 @@ export async function handler(event: SQSEvent, context: Context): Promise<void>
     }
   }
 
+  const sqsClient = createSqsClient();
+
   const promiseList = [];
 
-  if (deletionMessages.length > 0) promiseList.push(sendBatchSqsMessage(deletionMessages, accountDeletionSqsQueue));
+  if (deletionMessages.length > 0)
+    promiseList.push(sendBatchSqsMessage(deletionMessages, accountDeletionSqsQueue, sqsClient));
   if (interventionMessages.length > 0)
-    promiseList.push(sendBatchSqsMessage(interventionMessages, accountInterventionEventsQueue));
+    promiseList.push(sendBatchSqsMessage(interventionMessages, accountInterventionEventsQueue, sqsClient));
 
   await Promise.all(promiseList);
 

src/services/send-sqs-message.ts

@@ -7,18 +7,19 @@ import {
   SendMessageBatchCommandOutput,
   SendMessageBatchRequestEntry,
 } from '@aws-sdk/client-sqs';
-import logger from '../commons/logger';
+import getEnvOrThrow from '../commons/get-env-or-throw';
+
+export function createSqsClient() {
+  const region = getEnvOrThrow('AWS_REGION');
+
+  return new SQSClient({ region });
+}
 
 export async function sendSqsMessage(
   messageBody: string,
   queueUrl: string | undefined,
+  client: SQSClient = createSqsClient(),
 ): Promise<SendMessageCommandOutput> {
-  if (!process.env['AWS_REGION']) {
-    logger.error('AWS_REGION environment variable is not set');
-    throw new Error('AWS_REGION environment variable not set');
-  }
-  const region = process.env['AWS_REGION'];
-  const client = new SQSClient({ region });
   const message: SendMessageRequest = {
     QueueUrl: queueUrl,
     MessageBody: messageBody,
@@ -29,13 +30,8 @@ export async function sendSqsMessage(
 export async function sendBatchSqsMessage(
   messages: SendMessageBatchRequestEntry[],
   queueUrl: string | undefined,
+  client: SQSClient = createSqsClient(),
 ): Promise<SendMessageBatchCommandOutput> {
-  if (!process.env['AWS_REGION']) {
-    logger.error('AWS_REGION environment variable is not set');
-    throw new Error('AWS_REGION environment variable not set');
-  }
-  const region = process.env['AWS_REGION'];
-  const client = new SQSClient({ region });
   const parameters = {
     QueueUrl: queueUrl,
     Entries: messages,

src/services/test/send-sqs-message.test.ts

@@ -30,9 +30,9 @@ describe('sendSqsMessage', () => {
 
   it('throws an error if AWS_REGION environment variable is not set', async () => {
     vi.stubEnv('AWS_REGION', '');
-    await expect(sendSqsMessage(messageBody, queueUrl)).rejects.toThrow('AWS_REGION environment variable not set');
+    await expect(sendSqsMessage(messageBody, queueUrl)).rejects.toThrow('Environment variable AWS_REGION not found');
     // eslint-disable-next-line @typescript-eslint/unbound-method
-    expect(vi.mocked(logger.error)).toHaveBeenCalledWith('AWS_REGION environment variable is not set');
+    expect(vi.mocked(logger.error)).toHaveBeenCalledWith('Environment variable AWS_REGION not found');
   });
 
   it('sends a message successfully when AWS_REGION and parameters are set', async () => {
@@ -73,9 +73,9 @@ describe('sendBatchSqsMessage', () => {
 
   it('throws an error if AWS_REGION environment variable is not set', async () => {
     vi.stubEnv('AWS_REGION', '');
-    await expect(sendBatchSqsMessage(entries, queueUrl)).rejects.toThrow('AWS_REGION environment variable not set');
+    await expect(sendBatchSqsMessage(entries, queueUrl)).rejects.toThrow('Environment variable AWS_REGION not found');
     // eslint-disable-next-line @typescript-eslint/unbound-method
-    expect(vi.mocked(logger.error)).toHaveBeenCalledWith('AWS_REGION environment variable is not set');
+    expect(vi.mocked(logger.error)).toHaveBeenCalledWith('Environment variable AWS_REGION not found');
   });
 
   it('sends a message successfully when AWS_REGION and parameters are set', async () => {