feat(client-sqs): handle md5=false in sqs middleware

aws · Apr 2, 2024 · d382a08 · d382a08
1 parent d6bda9d
commit d382a08
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 6 deletions.
diff --git a/clients/client-sqs/src/SQSClient.ts b/clients/client-sqs/src/SQSClient.ts
@@ -257,10 +257,9 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
 
   /**
    * A constructor for a class implementing the {@link __Checksum} interface
-   * that computes MD5 hashes.
-   * @internal
+   * that computes MD5 hashes, or false to prevent MD5 computation.
    */
-  md5?: __ChecksumConstructor | __HashConstructor;
+  md5?: __ChecksumConstructor | __HashConstructor | false;
 
   /**
    * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header

diff --git a/packages/middleware-sdk-sqs/src/configurations.ts b/packages/middleware-sdk-sqs/src/configurations.ts
@@ -1,5 +1,5 @@
 import { ChecksumConstructor, HashConstructor } from "@smithy/types";
 
 export interface PreviouslyResolved {
-  md5: ChecksumConstructor | HashConstructor;
+  md5: ChecksumConstructor | HashConstructor | false;
 }
diff --git a/packages/middleware-sdk-sqs/src/middleware-sdk-sqs.integ.spec.ts b/packages/middleware-sdk-sqs/src/middleware-sdk-sqs.integ.spec.ts
@@ -103,8 +103,7 @@ const handlerResponse = (body: string) => {
 };
 
 describe("middleware-sdk-sqs", () => {
-  // TODO: check in CI
-  xdescribe(SQS.name + ` w/ useAwsQuery: ${useAwsQuery}`, () => {
+  describe(SQS.name + ` w/ useAwsQuery: ${useAwsQuery}`, () => {
     describe("correct md5 hashes", () => {
       beforeEach(() => {
         hashError = "";

diff --git a/packages/middleware-sdk-sqs/src/receive-message.ts b/packages/middleware-sdk-sqs/src/receive-message.ts
@@ -26,6 +26,9 @@ export function receiveMessageMiddleware(options: PreviouslyResolved): Initializ
   return <Output extends MetadataBearer>(next: InitializeHandler<any, Output>): InitializeHandler<any, Output> =>
     async (args: InitializeHandlerArguments<any>): Promise<InitializeHandlerOutput<Output>> => {
       const resp = await next({ ...args });
+      if (options.md5 === false) {
+        return resp;
+      }
       const output = resp.output as unknown as ReceiveMessageResult;
       const messageIds = [];
       if (output.Messages !== undefined) {

diff --git a/packages/middleware-sdk-sqs/src/receive-messages.spec.ts b/packages/middleware-sdk-sqs/src/receive-messages.spec.ts
@@ -69,4 +69,23 @@ describe("receiveMessageMiddleware", () => {
     expect(mockHashUpdate.mock.calls.length).toBe(2);
     expect(mockHashDigest.mock.calls.length).toBe(2);
   });
+
+  it("ignores checksum if md5=false in config", async () => {
+    const next = jest.fn().mockReturnValue({
+      output: {
+        Messages: [
+          { Body: "foo", MD5OfBody: "XXYYZZ", MessageId: "fooMessage" },
+          { Body: "bar", MD5OfBody: "XXYYZZ", MessageId: "barMessage" },
+        ],
+      },
+    });
+    const handler = receiveMessageMiddleware({
+      md5: false,
+    })(next, {} as any);
+
+    await handler({ input: {} });
+
+    expect(mockHashUpdate.mock.calls.length).toBe(0);
+    expect(mockHashDigest.mock.calls.length).toBe(0);
+  });
 });
diff --git a/packages/middleware-sdk-sqs/src/send-message-batch.ts b/packages/middleware-sdk-sqs/src/send-message-batch.ts
@@ -27,6 +27,9 @@ export const sendMessageBatchMiddleware =
   <Output extends MetadataBearer>(next: InitializeHandler<any, Output>): InitializeHandler<any, Output> =>
   async (args: InitializeHandlerArguments<any>): Promise<InitializeHandlerOutput<Output>> => {
     const resp = await next({ ...args });
+    if (options.md5 === false) {
+      return resp;
+    }
     const output = resp.output as unknown as SendMessageBatchResult;
     const messageIds = [];
     const entries: Record<string, SendMessageBatchResultEntry> = {};

diff --git a/packages/middleware-sdk-sqs/src/send-message.ts b/packages/middleware-sdk-sqs/src/send-message.ts
@@ -21,6 +21,9 @@ export const sendMessageMiddleware =
   <Output extends MetadataBearer>(next: InitializeHandler<any, Output>): InitializeHandler<any, Output> =>
   async (args: InitializeHandlerArguments<any>): Promise<InitializeHandlerOutput<Output>> => {
     const resp = await next({ ...args });
+    if (options.md5 === false) {
+      return resp;
+    }
     const output = resp.output as SendMessageResult;
     const hash = new options.md5();
     hash.update(toUint8Array(args.input.MessageBody || ""));