feat(cb2-10047): add service for aws SNS (#93)

Co-authored-by: owen <[email protected]>

.vscode/settings.json

@@ -14,7 +14,7 @@
   },
   "editor.formatOnSave": false,
   "editor.codeActionsOnSave": {
-    "source.fixAll": false,
-    "source.fixAll.eslint": true
+    "source.fixAll": "never",
+    "source.fixAll.eslint": "explicit"
   },
 }

package.json

@@ -38,6 +38,7 @@
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.341.0",
     "@aws-sdk/client-lambda": "^3.362.0",
+    "@aws-sdk/client-sns": "^3.485.0",
     "@aws-sdk/client-sqs": "^3.382.0",
     "@aws-sdk/lib-dynamodb": "^3.341.0",
     "@aws-sdk/util-dynamodb": "^3.362.0",

src/handler/updateVrm.ts

@@ -2,7 +2,7 @@ import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
 import 'dotenv/config';
 
 import { TechRecordType } from '@dvsa/cvs-type-definitions/types/v3/tech-record/tech-record-verb';
-import { UpdateVrmRequestBody } from '../models/updateVrm';
+import { SNSMessageBody, UpdateVrmRequestBody } from '../models/updateVrm';
 import { processCherishedTransfer } from '../processors/processCherishedTransfer';
 import { processCorrectVrm } from '../processors/processCorrectVrm';
 import {
@@ -16,6 +16,7 @@ import { addHttpHeaders } from '../util/httpHeaders';
 import logger from '../util/logger';
 import { validateUpdateVrmRequest, validateVrm, validateVrmExists } from '../validators/update';
 import { formatErrorMessage } from '../util/errorMessage';
+import { publish } from '../services/sns';
 
 export const handler = async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
   try {
@@ -67,6 +68,12 @@ export const handler = async (event: APIGatewayProxyEvent): Promise<APIGatewayPr
 
       await updateVehicle(recordsToArchive, recordsToUpdate);
 
+      const recordsToSend: SNSMessageBody[] = [];
+
+      recordsToUpdate.forEach((record) => recordsToSend.push({ ...record, userEmail: userDetails.email }));
+
+      await publish(JSON.stringify(recordsToSend), process.env.VRM_TRANSFERRED_ARN ?? '');
+
       return addHttpHeaders({
         statusCode: 200,
         body: JSON.stringify(recordsToUpdate[0]),

src/models/updateVrm.ts

@@ -1,5 +1,9 @@
+import { TechRecordType } from '@dvsa/cvs-type-definitions/types/v3/tech-record/tech-record-verb';
+
 export type UpdateVrmRequestBody = {
   newVrm: string
   isCherishedTransfer: boolean,
   thirdMark?: string
 };
+
+export type SNSMessageBody = TechRecordType<'get'> & { userEmail?: string };

src/services/sns.ts

@@ -0,0 +1,26 @@
+import { SNSClient, PublishCommand } from '@aws-sdk/client-sns';
+import logger from '../util/logger';
+
+const snsClient = new SNSClient({ region: process.env.DYNAMO_AWS_REGION });
+
+export const publish = async (message: string, topicArn: string) => {
+  logger.info('Sending SNS notification');
+
+  if (process.env.AWS_SAM_LOCAL) {
+    return '123';
+  }
+  const input = {
+    TopicArn: topicArn,
+    Message: message,
+  };
+
+  const command = new PublishCommand(input);
+  try {
+    const response = await snsClient.send(command);
+    logger.debug(response);
+    return undefined;
+  } catch (err: unknown) {
+    logger.error(err);
+    throw new Error(err as string);
+  }
+};

src/util/enum.ts

@@ -44,7 +44,7 @@ export enum ERRORS {
   FAILED_UPDATE_MESSAGE = 'Failed to update record',
 }
 export enum ReasonForCreation {
-  EU_VEHICLE_CATEGORY_UPDATE = 'EU Vehicle Catergory updated.',
+  EU_VEHICLE_CATEGORY_UPDATE = 'EU Vehicle Category updated.',
   RECORD_PROMOTED = 'Record promoted to current.',
 }
 

template.yml

@@ -153,18 +153,5 @@ Resources:
             Properties:
               Path: !GetAtt LocalQueue.Arn
               BatchSize: 10
-    UpdateTestVRMFunction:
-      Type: 'AWS::Serverless::Function'
-      Properties:
-        CodeUri: src/handler/
-        Handler: update-test-vrm.handler
-        Runtime: nodejs18.x
-        Timeout: 20
-        Events:
-          SQSEvent:
-            Type: SQS
-            Properties:
-              Path: !GetAtt LocalQueue.Arn
-              BatchSize: 10
     LocalQueue:
       Type: AWS::SQS::Queue

tests/unit/handler/updateVrm.unit.test.ts

@@ -7,6 +7,7 @@ const mockDonorVehicle = jest.fn();
 const mockValidateVrmExists = jest.fn();
 const mockValidateUpdateVrmRequest = jest.fn();
 const mockValidateVrm = jest.fn();
+const mockPublish = jest.fn();
 
 import { APIGatewayProxyEvent } from 'aws-lambda';
 import { handler } from '../../../src/handler/updateVrm';
@@ -28,6 +29,10 @@ jest.mock('../../../src/services/donorVehicle', () => ({
   donorVehicle: mockDonorVehicle,
 }));
 
+jest.mock('../../../src/services/sns', () => ({
+  publish: mockPublish,
+}));
+
 jest.mock('../../../src/validators/update', () => ({
   validateVrmExists: mockValidateVrmExists,
   validateUpdateVrmRequest: mockValidateUpdateVrmRequest,
@@ -73,9 +78,11 @@ describe('update vrm handler', () => {
       mockValidateVrmExists.mockReturnValueOnce(false);
       mockDonorVehicle.mockReturnValue([{ ...carData, primaryVrm: 'DONORVRM' }, undefined]);
       mockUpdateVehicle.mockResolvedValueOnce({});
+      mockPublish.mockResolvedValueOnce(undefined);
       const result = await handler(request);
 
       expect(mockGetBySystemNumberAndCreatedTimestamp).toHaveBeenCalledTimes(1);
+      expect(mockPublish).toHaveBeenCalledTimes(1);
       expect(result.statusCode).toBe(200);
       expect(result.body).not.toBeNull();
     });

tests/unit/processors/processSyncTestResultInfo.unit.test.ts

@@ -71,7 +71,7 @@ describe('syncTestResultInfo', () => {
       expect(mockGetBySystemNumberAndCreatedTimestamp).toHaveBeenCalledTimes(2);
       expect(mockUpdateVehicle).toHaveBeenCalledTimes(1);
     });
-    it('should not call update if record is current and EuVehicleCatergory is not updated', async () => {
+    it('should not call update if record is current and EuVehicleCategory is not updated', async () => {
       mockSearchByCriteria.mockResolvedValueOnce([{ techRecord_statusCode: 'current' }]);
       mockGetBySystemNumberAndCreatedTimestamp.mockResolvedValueOnce(hgvData[1]);
       await syncTestResultInfo('5000', 'submitted', 'pass', '47', '012345', 'Test User', undefined);

webpack/webpack.production.js

@@ -8,7 +8,7 @@ const AwsSamPlugin = require("aws-sam-webpack-plugin");
 
 
 const LAMBDA_NAMES = ['SearchLambdaFunction', 'GetLambdaFunction', 'PostLambdaFunction', 'PatchLambdaFunction',
- 'ArchiveLambdaFunction', 'UnarchiveLambdaFunction', 'PromoteLambdaFunction', 'UpdateVrmFunction', 'UpdateVinFunction', 'GeneratePlateFunction', 'GenerateLetterFunction', 'SyncTestResultInfoFunction', 'UpdateTestVRMFunction'];
+ 'ArchiveLambdaFunction', 'UnarchiveLambdaFunction', 'PromoteLambdaFunction', 'UpdateVrmFunction', 'UpdateVinFunction', 'GeneratePlateFunction', 'GenerateLetterFunction', 'SyncTestResultInfoFunction'];
 const OUTPUT_FOLDER = './'
 const REPO_NAME = 'cvs-svc-technical-records-v3';
 const BRANCH_NAME = branchName().replace(/\//g, "-");