fix: add some sqs request model fixes

Author: rebecamendez

package.json

@@ -13,6 +13,7 @@
     "test": "jest --silent --logHeapUsage --coverage",
     "dev": "node --env-file=.env -r esbuild-register ./src/launch.ts -e .ts",
     "dev:secrets": "doppler setup --no-interactive && doppler secrets download --no-file --format env > .env && touch .env.overrides && cat .env.overrides >> .env",
+    "dev:consumer": "node --env-file=.env -r esbuild-register ./src/launch-sqs-consumer.ts",
     "audit:critical": "npm audit --audit-level=critical",
     "clean": "rm -rf dist node_modules"
   },
@@ -42,6 +43,7 @@
     "jest-mock-extended": "4.0.0-beta1",
     "prettier": "3.3.3",
     "prettier-plugin-sort-imports": "1.8.6",
+    "sqs-consumer": "11.2.0",
     "typescript": "5.6.3"
   },
   "engines": {

src/contracts/linkedin-profile.request.ts

@@ -1,9 +1,12 @@
-import { IsIn, IsInt, IsNumber, IsString, IsUrl, Min } from 'class-validator';
+import { IsIn, IsInt, IsNumber, IsString, IsUrl } from 'class-validator';
 
 export class LinkedinProfileRequest {
   @IsString()
   public messageId!: string;
 
+  @IsString()
+  public importId!: string;
+
   @IsString()
   public contextId!: string;
 
@@ -14,13 +17,10 @@ export class LinkedinProfileRequest {
   @IsInt()
   public profileId!: number;
 
+  // Profile parameters
   @IsString()
-  public profileApiToken!: string;
+  public linkedinApiToken!: string;
 
   @IsUrl()
-  public linkedinUrl!: string;
-
-  @IsInt()
-  @Min(1)
-  public attempt!: number;
+  public linkedinProfileUrl!: string;
 }

src/index.spec.ts

@@ -46,10 +46,10 @@ describe('Linkedin lambda handler', () => {
 
   it('should throw an error if message is not a valid LinkedinProfileRequest', async () => {
     const request = createMockedLinkedinProfileRequest();
-    request.profileApiToken = undefined as unknown as string; // missing required field
+    request.linkedinApiToken = undefined as unknown as string; // missing required field
     const event = createMockedSqsSEvent(request);
     const expectedErrorString =
-      '[LinkedinProfileRequestMapper] Validation failed: ["property: profileApiToken errors: profileApiToken must be a string"]';
+      '[LinkedinProfileRequestMapper] Validation failed: ["property: linkedinApiToken errors: linkedinApiToken must be a string"]';
 
     await expect(handler(event, {} as Context, () => {})).rejects.toThrow(new Error(expectedErrorString));
   });

src/index.ts

@@ -11,12 +11,18 @@ export const handler: Handler = async (event: SQSEvent): Promise<LinkedinProfile
   try {
     const linkedinProfileRequest = LinkedinProfileRequestMapper.toDomain(event);
     Environment.setupEnvironment(linkedinProfileRequest);
-    logger.info(`⌛️ [handler] Starting Linkedin profile request for linkedinUrl: ${linkedinProfileRequest.linkedinUrl}`, linkedinProfileRequest);
+    logger.info(
+      `⌛️ [handler] Starting Linkedin profile request for linkedinProfileUrl: ${linkedinProfileRequest.linkedinProfileUrl}`,
+      linkedinProfileRequest
+    );
 
-    const { linkedinProfile, isEmptyProfile } = await new LinkedinProfileService().getLinkedinProfile(linkedinProfileRequest.profileApiToken);
+    const { linkedinProfile, isEmptyProfile } = await new LinkedinProfileService().getLinkedinProfile(linkedinProfileRequest.linkedinApiToken);
 
     if (isEmptyProfile) {
-      logger.warn(`👻 [handler] Linkedin profile is not synced for linkedinUrl: ${linkedinProfileRequest.linkedinUrl}`, linkedinProfileRequest);
+      logger.warn(
+        `👻 [handler] Linkedin profile is not synced for linkedinProfileUrl: ${linkedinProfileRequest.linkedinProfileUrl}`,
+        linkedinProfileRequest
+      );
       // TODO: send response to SQS queue again if no max retries
       return undefined;
     }
@@ -27,7 +33,7 @@ export const handler: Handler = async (event: SQSEvent): Promise<LinkedinProfile
 
     return linkedinProfileResponse;
   } catch (error) {
-    logger.error(`❌ [handler] Error processing Linkedin profile request: ${error}`, error);
+    logger.error(`❌ [handler] Error processing Linkedin profile request`, { error, event });
     throw error;
   }
 };

src/launch-sqs-consumer.ts

@@ -0,0 +1,60 @@
+import { Message, SQSClient } from '@aws-sdk/client-sqs';
+import { Context, SQSEvent, SQSRecord } from 'aws-lambda';
+import { Consumer } from 'sqs-consumer';
+
+import { handler } from './index';
+import { logger } from './util/logger';
+
+/**
+ * Test the SQS consumer locally using LocalStack queues
+ */
+const sqsClient = new SQSClient({ region: 'eu-west-1', endpoint: 'http://localhost:4566' });
+
+const queueUrl = 'http://localhost:4566/000000000000/linkedin-api-import-profile-local.fifo';
+
+const consumer = Consumer.create({
+  queueUrl,
+  handleMessage: async (message: Message) => {
+    logger.info('👉  Message received:', message);
+
+    try {
+      const sqsRecord = {
+        messageId: message.MessageId!,
+        receiptHandle: message.ReceiptHandle!,
+        body: message.Body!,
+        attributes: message.Attributes || {},
+        messageAttributes: message.MessageAttributes || {},
+        md5OfBody: message.MD5OfBody || '',
+        eventSource: 'aws:sqs',
+        eventSourceARN: `arn:aws:sqs:eu-west-1:000000000000:linkedin-api-import-profile-local.fifo`,
+        awsRegion: 'eu-west-1'
+      } as unknown as SQSRecord;
+
+      const event = { Records: [sqsRecord] } as SQSEvent;
+
+      const response = await handler(event, {} as Context, () => {
+        logger.info('✅  Executed handler');
+      });
+
+      return response;
+    } catch (error) {
+      logger.error('❌  Error handling message:', error);
+    }
+  },
+  sqs: sqsClient
+});
+
+consumer.on('error', (err: Error) => {
+  logger.error('❌  Consumer error:', err.message);
+});
+
+consumer.on('processing_error', (err: Error) => {
+  logger.error('❌  Processing error:', err.message);
+});
+
+consumer.on('empty', () => {
+  logger.info('🥱  Waiting for messages...');
+});
+
+logger.info(`🔄  Starting SQS consumer for ${queueUrl}...`);
+consumer.start();

src/launch.ts

@@ -7,8 +7,8 @@ import { logger } from './util/logger';
 
 // 👉 Fake manual execution without AWS: For local debug
 void (async (): Promise<void> => {
-  const profileApiToken = process.env['LOCAL_PROFILE_API_TOKEN'];
-  const request = createMockedLinkedinProfileRequest({ profileApiToken });
+  const linkedinApiToken = process.env['LOCAL_LINKEDIN_API_TOKEN'];
+  const request = createMockedLinkedinProfileRequest({ linkedinApiToken });
   const fakeEvent = createMockedSqsSEvent(request);
 
   logger.info('👉 [launch.ts] Debugging lambda handler  ...');

src/mappers/linkedin-profile.request.mapper.ts

@@ -10,12 +10,12 @@ export class LinkedinProfileRequestMapper {
 
     const request = new LinkedinProfileRequest();
     request.messageId = message.messageId;
+    request.importId = messageBody.importId;
     request.contextId = messageBody.contextId;
     request.env = messageBody.env;
-    request.profileId = messageBody.profileId;
-    request.profileApiToken = messageBody.profileApiToken;
-    request.linkedinUrl = messageBody.linkedinUrl;
-    request.attempt = messageBody.attempt;
+    request.profileId = +messageBody.profileId;
+    request.linkedinApiToken = messageBody.linkedinApiToken;
+    request.linkedinProfileUrl = messageBody.linkedinProfileUrl;
 
     this.validate(request);
 

src/test/mocks/linkedin-profile.mocks.ts

@@ -4,12 +4,12 @@ import { LinkedinProfile } from '../../domain/linkedin-profile';
 export const createMockedLinkedinProfileRequest = (customValues: Partial<LinkedinProfileRequest> = {}): LinkedinProfileRequest => {
   const request = new LinkedinProfileRequest();
   request.messageId = customValues.messageId ?? '059f36b4-87a3-44ab-83d2-661975830a7d';
+  request.importId = customValues.importId ?? '1';
   request.contextId = customValues.contextId ?? '1234';
   request.env = customValues.env ?? 'local';
   request.profileId = customValues.profileId ?? 123;
-  request.profileApiToken = customValues.profileApiToken ?? 'fake-token';
-  request.linkedinUrl = customValues.linkedinUrl ?? 'https://www.linkedin.com/in/username';
-  request.attempt = customValues.attempt ?? 1;
+  request.linkedinApiToken = customValues.linkedinApiToken ?? 'fake-token';
+  request.linkedinProfileUrl = customValues.linkedinProfileUrl ?? 'https://www.linkedin.com/in/username';
   return request;
 };
 

src/util/environment.ts

@@ -6,16 +6,16 @@ import { setContextLogger } from './logger';
 
 export class Environment {
   public readonly LOGGER_CONSOLE: boolean;
-  public readonly LOCAL_PROFILE_API_TOKEN?: string;
+  public readonly LOCAL_LINKEDIN_API_TOKEN?: string;
 
   private constructor(_envName: EnvironmentType) {
     const env = cleanEnv(process.env, {
       LOGGER_CONSOLE: bool({ default: false }),
-      LOCAL_PROFILE_API_TOKEN: str({ default: undefined })
+      LOCAL_LINKEDIN_API_TOKEN: str({ default: undefined })
     });
 
     this.LOGGER_CONSOLE = env.LOGGER_CONSOLE;
-    this.LOCAL_PROFILE_API_TOKEN = env.LOCAL_PROFILE_API_TOKEN ?? undefined;
+    this.LOCAL_LINKEDIN_API_TOKEN = env.LOCAL_LINKEDIN_API_TOKEN ?? undefined;
   }
 
   public static setupEnvironment(request: LinkedinProfileRequest): Environment {