Skip to content

Commit

Permalink
extract getEvent function
Browse files Browse the repository at this point in the history
  • Loading branch information
@jhumbert-dd
jhumbert-dd committed Jan 13, 2025
1 parent a2a00af commit 67d625b
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 373 deletions.
7 changes: 6 additions & 1 deletion test-resources/src/dequeue/dequeueHandler.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ import {
SQSBatchItemFailure,
SQSBatchResponse,
SQSEvent,
SQSRecord,
} from "aws-lambda";
import { Logger } from "../services/logging/logger";
import { getConfig } from "./getConfig";
import { allowedTxmaEventNames, getEvent } from "./getEvent";
import { allowedTxmaEventNames, getEvent, TxmaEvent } from "./getEvent";
import { MessageName, registeredLogs } from "./registeredLogs";
import { Result } from "../utils/result";

export const lambdaHandlerConstructor = async (
dependencies: IDequeueDependencies,
Expand All @@ -25,6 +27,7 @@ export const lambdaHandlerConstructor = async (
const logger = dependencies.logger();
logger.addContext(context);
logger.log("STARTED");
const { getEvent } = dependencies;

const records = event.Records;
const batchItemFailures: SQSBatchItemFailure[] = [];
Expand Down Expand Up @@ -114,6 +117,7 @@ interface IProcessedMessage {
export interface IDequeueDependencies {
env: NodeJS.ProcessEnv;
logger: () => Logger<MessageName>;
getEvent: (record: SQSRecord) => Result<TxmaEvent>;
}

const dependencies: IDequeueDependencies = {
Expand All @@ -123,6 +127,7 @@ const dependencies: IDequeueDependencies = {
new PowertoolsLogger({ serviceName: "Dequeue Function" }),
registeredLogs,
),
getEvent,
};

export const lambdaHandler = lambdaHandlerConstructor.bind(null, dependencies);
4 changes: 2 additions & 2 deletions test-resources/src/dequeue/getEvent.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ export function getEvent(record: SQSRecord): Result<TxmaEvent> {
return successResult(txmaEvent);
}

interface TxmaEvent {
export interface TxmaEvent {
event_name: string;
user: {
session_id: string;
};
timestamp: number;
timestamp: string;
}

export const allowedTxmaEventNames = [
Expand Down
224 changes: 46 additions & 178 deletions test-resources/src/dequeue/tests/dequeueHandler.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
import { DynamoDBClient, PutItemCommand } from "@aws-sdk/client-dynamodb";
import { SQSBatchResponse, SQSEvent } from "aws-lambda";
import { SQSBatchResponse, SQSEvent, SQSRecord } from "aws-lambda";
import { mockClient } from "aws-sdk-client-mock";
import "aws-sdk-client-mock-jest";
import { Logger } from "../../services/logging/logger";
import { buildLambdaContext } from "../../services/logging/tests/mockContext";
import { MockLoggingAdapter } from "../../services/logging/tests/mockLogger";
import { errorResult, Result, successResult } from "../../utils/result";
import {
IDequeueDependencies,
lambdaHandlerConstructor,
} from "../dequeueHandler";
import { TxmaEvent } from "../getEvent";
import { MessageName, registeredLogs } from "../registeredLogs";
import {
eventNameMissingSQSRecord,
eventNameNotAllowedSQSRecord,
invalidBodySQSRecord,
missingSessionIdInvalidSQSRecord,
missingSessionIdValidSQSRecord,
missingTimestampSQSRecord,
passingSQSRecord,
putItemInputForPassingSQSRecord,
putItemInputForPassingSQSRecordWithoutSessionId,
} from "./testData";

const env = {
Expand All @@ -39,6 +36,7 @@ describe("Dequeue TxMA events", () => {
dependencies = {
env,
logger: () => new Logger(mockLogger, registeredLogs),
getEvent: mockGetEvent,
};
});

Expand Down Expand Up @@ -102,183 +100,36 @@ describe("Dequeue TxMA events", () => {
});
});

describe("Message validation", () => {
describe("Given there is an error parsing the record body", () => {
it("Logs an error message", async () => {
const event: SQSEvent = {
Records: [invalidBodySQSRecord],
};

await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);

expect(mockLogger.getLogMessages().length).toEqual(4);
expect(mockLogger.getLogMessages()[1].logMessage.messageCode).toEqual(
"DEQUEUE_FAILED_TO_PROCESS_MESSAGES",
);
expect(mockLogger.getLogMessages()[1].data.errorMessage).toEqual(
`Failed to process message - messageId: ${invalidBodySQSRecord.messageId}`,
);
expect(mockLogger.getLogMessages()[1].data.body).toEqual("{");
expect(mockLogger.getLogMessages()[2].data.processedMessages).toEqual(
[],
);
});
});

describe("Given event_name is missing", () => {
it("Logs an error message", async () => {
const event: SQSEvent = {
Records: [eventNameMissingSQSRecord],
};

await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);

expect(mockLogger.getLogMessages().length).toEqual(4);
expect(mockLogger.getLogMessages()[1].logMessage.messageCode).toEqual(
"DEQUEUE_FAILED_TO_PROCESS_MESSAGES",
);
expect(mockLogger.getLogMessages()[1].data.errorMessage).toEqual(
"Missing event_name",
);
expect(mockLogger.getLogMessages()[2].logMessage.message).toStrictEqual(
"PROCESSED_MESSAGES",
);
expect(mockLogger.getLogMessages()[2].data).toStrictEqual({
processedMessages: [],
});
});
});

describe("Given the event_name is not allowed", () => {
it("Logs an error message", async () => {
const event: SQSEvent = {
Records: [eventNameNotAllowedSQSRecord],
};

await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);
describe("Given validation fails when retrieving an event", () => {
let event: SQSEvent;
let result: SQSBatchResponse;

expect(mockLogger.getLogMessages().length).toEqual(4);
expect(mockLogger.getLogMessages()[1].data).toStrictEqual({
errorMessage: "event_name not allowed",
eventName: JSON.parse(eventNameNotAllowedSQSRecord.body).event_name,
});
expect(mockLogger.getLogMessages()[2].logMessage.message).toStrictEqual(
"PROCESSED_MESSAGES",
);
expect(mockLogger.getLogMessages()[2].data).toStrictEqual({
processedMessages: [],
});
});
beforeEach(async () => {
event = {
Records: [eventNameMissingSQSRecord],
};
result = await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);
});

describe("Given session_id is missing", () => {
describe("Given the registered event schema does not include a session_id", () => {
it("Writes to Dynamo using UNKNOWN as the sessionId", async () => {
mockDbClient.on(PutItemCommand).resolves({});
const event: SQSEvent = {
Records: [missingSessionIdValidSQSRecord],
};

const result = await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);

expect(mockLogger.getLogMessages().length).toEqual(3);
expect(
mockLogger.getLogMessages()[1].logMessage.message,
).toStrictEqual("PROCESSED_MESSAGES");
expect(mockLogger.getLogMessages()[1].data.processedMessages).toEqual(
[
{
eventName: JSON.parse(missingSessionIdValidSQSRecord.body)
.event_name,
sessionId: "UNKNOWN",
},
],
);

expect(mockDbClient).toHaveReceivedCommandWith(
PutItemCommand,
putItemInputForPassingSQSRecordWithoutSessionId,
);
expect(result).toStrictEqual({
batchItemFailures: [],
});
});
});

describe("Given the registered event schema includes a session_id", () => {
it("Logs an error message", async () => {
const event: SQSEvent = {
Records: [missingSessionIdInvalidSQSRecord],
};

await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);

expect(mockLogger.getLogMessages().length).toEqual(4);
expect(
mockLogger.getLogMessages()[1].logMessage.message,
).toStrictEqual("FAILED_TO_PROCESS_MESSAGES");
expect(mockLogger.getLogMessages()[1].data).toStrictEqual({
errorMessage: "Missing session_id",
eventName: JSON.parse(missingSessionIdInvalidSQSRecord.body)
.event_name,
});
expect(
mockLogger.getLogMessages()[2].logMessage.message,
).toStrictEqual("PROCESSED_MESSAGES");
expect(mockLogger.getLogMessages()[2].data).toStrictEqual({
processedMessages: [],
});
});
it("Returns an error message", () => {
expect(mockLogger.getLogMessages()[1]).toEqual({
logMessage: expect.objectContaining({
messageCode: "DEQUEUE_FAILED_TO_PROCESS_MESSAGES",
message: "FAILED_TO_PROCESS_MESSAGES",
}),
data: {
errorMessage: "Mock validation error",
body: "Invalid body",
},
});
});

describe("Given timestamp is missing", () => {
it("Logs an error message", async () => {
const event: SQSEvent = {
Records: [missingTimestampSQSRecord],
};

await lambdaHandlerConstructor(
dependencies,
event,
buildLambdaContext(),
);

expect(mockLogger.getLogMessages().length).toEqual(4);
expect(mockLogger.getLogMessages()[1].logMessage.message).toStrictEqual(
"FAILED_TO_PROCESS_MESSAGES",
);
expect(mockLogger.getLogMessages()[1].data).toStrictEqual({
errorMessage: "Missing timestamp",
eventName: JSON.parse(missingTimestampSQSRecord.body).event_name,
});
expect(mockLogger.getLogMessages()[2].logMessage.message).toStrictEqual(
"PROCESSED_MESSAGES",
);
expect(mockLogger.getLogMessages()[2].data).toStrictEqual({
processedMessages: [],
});
});
it("Returns no no batchItemFailures to be reprocessed", () => {
expect(result).toStrictEqual({ batchItemFailures: [] });
});
});

Expand Down Expand Up @@ -339,7 +190,7 @@ describe("Dequeue TxMA events", () => {
"FAILED_TO_PROCESS_MESSAGES",
);
expect(mockLogger.getLogMessages()[1].data.errorMessage).toEqual(
`Failed to process message - messageId: ${invalidBodySQSRecord.messageId}`,
`Mock validation error`,
);
});

Expand Down Expand Up @@ -421,3 +272,20 @@ describe("Dequeue TxMA events", () => {
});
});
});

function mockGetEvent(record: SQSRecord): Result<TxmaEvent> {
if (record.messageId === passingSQSRecord.messageId) {
return successResult({
event_name: "DCMAW_ASYNC_CRI_START",
user: {
session_id: "49E7D76E-D5FE-4355-B8B4-E90ACA0887C2",
},
timestamp: "mockTimestamp",
});
}

return errorResult({
errorMessage: "Mock validation error",
body: "Invalid body",
});
}
Loading

0 comments on commit 67d625b

Please sign in to comment.