diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddBuiltinPlugins.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddBuiltinPlugins.java index 9e7cb91db642..c32a4d9234c8 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddBuiltinPlugins.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddBuiltinPlugins.java @@ -169,6 +169,24 @@ && testServiceId(s, "Route 53")) HAS_MIDDLEWARE) .servicePredicate((m, s) -> testServiceId(s, "S3 Control")) .build(), + RuntimeClientPlugin.builder() + .withConventions(AwsDependency.SQS_MIDDLEWARE.dependency, "SendMessage", + HAS_MIDDLEWARE) + .operationPredicate((m, s, o) -> o.getId().getName().equals("SendMessage") + && testServiceId(s, "SQS")) + .build(), + RuntimeClientPlugin.builder() + .withConventions(AwsDependency.SQS_MIDDLEWARE.dependency, "SendMessageBatch", + HAS_MIDDLEWARE) + .operationPredicate((m, s, o) -> o.getId().getName().equals("SendMessageBatch") + && testServiceId(s, "SQS")) + .build(), + RuntimeClientPlugin.builder() + .withConventions(AwsDependency.SQS_MIDDLEWARE.dependency, "ReceiveMessage", + HAS_MIDDLEWARE) + .operationPredicate((m, s, o) -> o.getId().getName().equals("ReceiveMessage") + && testServiceId(s, "SQS")) + .build(), RuntimeClientPlugin.builder() .withConventions(AwsDependency.MIDDLEWARE_HOST_HEADER.dependency, "HostHeader") .build() diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java index 98acc52bb549..fbbbdfb84ae0 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java @@ -48,6 +48,7 @@ public enum AwsDependency implements SymbolDependencyContainer { BUCKET_ENDPOINT_MIDDLEWARE(NORMAL_DEPENDENCY, "@aws-sdk/middleware-bucket-endpoint", "^1.0.0-alpha.1"), BODY_CHECKSUM(NORMAL_DEPENDENCY, "@aws-sdk/middleware-apply-body-checksum", "^1.0.0-alpha.1"), MIDDLEWARE_HOST_HEADER(NORMAL_DEPENDENCY, "@aws-sdk/middleware-host-header", "^1.0.0-alpha.1"), + SQS_MIDDLEWARE(NORMAL_DEPENDENCY, "@aws-sdk/middleware-sdk-sqs", "^1.0.0-alpha.0"), XML_BUILDER(NORMAL_DEPENDENCY, "@aws-sdk/xml-builder", "^1.0.0-alpha.1"), XML_PARSER(NORMAL_DEPENDENCY, "pixl-xml", "^1.0.13"), XML_PARSER_TYPES(DEV_DEPENDENCY, "@types/pixl-xml", "^1.0.1"); diff --git a/packages/middleware-sdk-sqs/.gitignore b/packages/middleware-sdk-sqs/.gitignore new file mode 100644 index 000000000000..3d1714c9806e --- /dev/null +++ b/packages/middleware-sdk-sqs/.gitignore @@ -0,0 +1,8 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/packages/middleware-sdk-sqs/.npmignore b/packages/middleware-sdk-sqs/.npmignore new file mode 100644 index 000000000000..4b9fe3abf33a --- /dev/null +++ b/packages/middleware-sdk-sqs/.npmignore @@ -0,0 +1,13 @@ +/src/ +/coverage/ +/docs/ +tsconfig.test.json +*.tsbuildinfo + +*.spec.js +*.spec.d.ts +*.spec.js.map + +*.fixture.js +*.fixture.d.ts +*.fixture.js.map diff --git a/packages/middleware-sdk-sqs/CHANGELOG.md b/packages/middleware-sdk-sqs/CHANGELOG.md new file mode 100644 index 000000000000..e9fb6ecf5930 --- /dev/null +++ b/packages/middleware-sdk-sqs/CHANGELOG.md @@ -0,0 +1,4 @@ +# Change Log + +All notable changes to this project will be documented in this file. +See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. \ No newline at end of file diff --git a/packages/middleware-sdk-sqs/LICENSE b/packages/middleware-sdk-sqs/LICENSE new file mode 100644 index 000000000000..e907b58668da --- /dev/null +++ b/packages/middleware-sdk-sqs/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/middleware-sdk-sqs/README.md b/packages/middleware-sdk-sqs/README.md new file mode 100644 index 000000000000..ee79645e89d5 --- /dev/null +++ b/packages/middleware-sdk-sqs/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/@aws-sdk/middleware-sdk-sqs + +[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/middleware-sdk-sqs/preview.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/middleware-sdk-sqs) +[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/middleware-sdk-sqs.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/middleware-sdk-sqs) diff --git a/packages/middleware-sdk-sqs/jest.config.js b/packages/middleware-sdk-sqs/jest.config.js new file mode 100644 index 000000000000..498ea8304467 --- /dev/null +++ b/packages/middleware-sdk-sqs/jest.config.js @@ -0,0 +1,5 @@ +const base = require("../../jest.config.base.js"); + +module.exports = { + ...base +}; diff --git a/packages/middleware-sdk-sqs/package.json b/packages/middleware-sdk-sqs/package.json new file mode 100644 index 000000000000..3a41aa4438a6 --- /dev/null +++ b/packages/middleware-sdk-sqs/package.json @@ -0,0 +1,26 @@ +{ + "name": "@aws-sdk/middleware-sdk-sqs", + "version": "1.0.0-alpha.0", + "scripts": { + "prepublishOnly": "tsc", + "pretest": "tsc -p tsconfig.test.json", + "test": "jest" + }, + "main": "./build/index.js", + "types": "./build/index.d.ts", + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/types": "^1.0.0-alpha.2", + "tslib": "^1.8.0", + "@aws-sdk/util-hex-encoding": "^1.0.0-alpha.2" + }, + "devDependencies": { + "@types/jest": "^24.0.12", + "jest": "^24.7.1", + "typescript": "~3.4.0" + } +} diff --git a/packages/middleware-sdk-sqs/src/configurations.ts b/packages/middleware-sdk-sqs/src/configurations.ts new file mode 100644 index 000000000000..d063cdea4fd4 --- /dev/null +++ b/packages/middleware-sdk-sqs/src/configurations.ts @@ -0,0 +1,5 @@ +import { Hash } from "@aws-sdk/types"; + +export interface PreviouslyResolved { + md5: { new (): Hash }; +} diff --git a/packages/middleware-sdk-sqs/src/index.ts b/packages/middleware-sdk-sqs/src/index.ts new file mode 100644 index 000000000000..9eff99dcf3bf --- /dev/null +++ b/packages/middleware-sdk-sqs/src/index.ts @@ -0,0 +1,3 @@ +export * from "./receive-message"; +export * from "./send-message"; +export * from "./send-message-batch"; diff --git a/packages/middleware-sdk-sqs/src/receive-message.ts b/packages/middleware-sdk-sqs/src/receive-message.ts new file mode 100644 index 000000000000..16a0068b26b8 --- /dev/null +++ b/packages/middleware-sdk-sqs/src/receive-message.ts @@ -0,0 +1,71 @@ +import { PreviouslyResolved } from "./configurations"; +import { + InitializeHandler, + InitializeMiddleware, + InitializeHandlerArguments, + InitializeHandlerOptions, + InitializeHandlerOutput, + MetadataBearer, + Pluggable +} from "@aws-sdk/types"; +import { toHex } from "@aws-sdk/util-hex-encoding"; + +interface ReceiveMessageResult { + Messages: Array; +} + +interface Message { + Body: string | undefined; + MD5OfBody: string | undefined; + MessageId: string | undefined; +} + +export function receiveMessageMiddleware( + options: PreviouslyResolved +): InitializeMiddleware { + return ( + next: InitializeHandler + ): InitializeHandler => async ( + args: InitializeHandlerArguments + ): Promise> => { + const resp = await next({ ...args }); + const output = (resp.output as unknown) as ReceiveMessageResult; + let messageIds = []; + if (output.Messages !== undefined) { + for (const message of output.Messages) { + const md5 = message.MD5OfBody; + const hash = new options.md5(); + hash.update(message.Body || ""); + if (md5 !== toHex(await hash.digest())) { + messageIds.push(message.MessageId); + } + } + } + if (messageIds.length > 0) { + throw new Error( + "Invalid MD5 checksum on messages: " + messageIds.join(", ") + ); + } + + return next({ + ...args + }); + }; +} + +export const receiveMessageMiddlewareOptions: InitializeHandlerOptions = { + step: "initialize", + tags: ["VALIDATE_BODY_MD5"], + name: "receiveMessageMiddleware" +}; + +export const getReceiveMessagePlugin = ( + config: PreviouslyResolved +): Pluggable => ({ + applyToStack: clientStack => { + clientStack.add( + receiveMessageMiddleware(config), + receiveMessageMiddlewareOptions + ); + } +}); diff --git a/packages/middleware-sdk-sqs/src/receive-messages.spec.ts b/packages/middleware-sdk-sqs/src/receive-messages.spec.ts new file mode 100644 index 000000000000..5fe2e668001c --- /dev/null +++ b/packages/middleware-sdk-sqs/src/receive-messages.spec.ts @@ -0,0 +1,54 @@ +import { receiveMessageMiddleware } from "./receive-message"; +import { HashConstructor } from "@aws-sdk/types"; + +describe("receiveMessageMiddleware", () => { + const mockHashUpdate = jest.fn(); + const mockHashDigest = jest.fn().mockReturnValue(new Uint8Array(1)); + const MockHash: HashConstructor = class {} as any; + MockHash.prototype.update = mockHashUpdate; + MockHash.prototype.digest = mockHashDigest; + + beforeEach(() => { + mockHashUpdate.mockClear(); + mockHashDigest.mockClear(); + }); + + it("should do nothing if the checksums match", async () => { + const next = jest.fn().mockReturnValue({ + output: { + Messages: [ + { Body: "foo", MD5OfBody: "00", MessageId: "fooMessage" }, + { Body: "bar", MD5OfBody: "00", MessageId: "barMessage" } + ] + } + }); + const handler = receiveMessageMiddleware({ + md5: MockHash + })(next, {} as any); + + await handler({ input: {} }); + + expect(mockHashUpdate.mock.calls.length).toBe(2); + expect(mockHashDigest.mock.calls.length).toBe(2); + }); + + it("should throw if the checksum does not match", async () => { + const next = jest.fn().mockReturnValue({ + output: { + Messages: [ + { Body: "foo", MD5OfBody: "00", MessageId: "fooMessage" }, + { Body: "bar", MD5OfBody: "1", MessageId: "barMessage" } + ] + } + }); + const handler = receiveMessageMiddleware({ + md5: MockHash + })(next, {} as any); + + await expect(handler({ input: {} })).rejects.toThrow( + new Error("Invalid MD5 checksum on messages: barMessage") + ); + expect(mockHashUpdate.mock.calls.length).toBe(2); + expect(mockHashDigest.mock.calls.length).toBe(2); + }); +}); diff --git a/packages/middleware-sdk-sqs/src/send-message-batch.spec.ts b/packages/middleware-sdk-sqs/src/send-message-batch.spec.ts new file mode 100644 index 000000000000..0c04221af66a --- /dev/null +++ b/packages/middleware-sdk-sqs/src/send-message-batch.spec.ts @@ -0,0 +1,70 @@ +import { sendMessageBatchMiddleware } from "./send-message-batch"; +import { HashConstructor } from "@aws-sdk/types"; + +describe("sendMessageBatchMiddleware", () => { + const mockHashUpdate = jest.fn(); + const mockHashDigest = jest.fn().mockReturnValue(new Uint8Array(1)); + const MockHash: HashConstructor = class {} as any; + MockHash.prototype.update = mockHashUpdate; + MockHash.prototype.digest = mockHashDigest; + + beforeEach(() => { + mockHashUpdate.mockClear(); + mockHashDigest.mockClear(); + }); + + it("should do nothing if the checksums match", async () => { + const next = jest.fn().mockReturnValue({ + output: { + Successful: [ + { Id: "foo", MD5OfMessageBody: "00" }, + { Id: "bar", MD5OfMessageBody: "00" } + ] + } + }); + const handler = sendMessageBatchMiddleware({ + md5: MockHash + })(next, {} as any); + + await handler({ + input: { + Entries: [ + { Id: "foo", MessageBody: "0" }, + { Id: "bar", MessageBody: "0" } + ] + } + }); + + expect(mockHashUpdate.mock.calls.length).toBe(2); + expect(mockHashDigest.mock.calls.length).toBe(2); + }); + + it("should throw if the checksum does not match", async () => { + const next = jest.fn().mockReturnValue({ + output: { + Successful: [ + { Id: "foo", MD5OfMessageBody: "00", MessageId: "fooMessage" }, + { Id: "bar", MD5OfMessageBody: "1", MessageId: "barMessage" } + ] + } + }); + const handler = sendMessageBatchMiddleware({ + md5: MockHash + })(next, {} as any); + + await expect( + handler({ + input: { + Entries: [ + { Id: "foo", MessageBody: "0" }, + { Id: "bar", MessageBody: "0" } + ] + } + }) + ).rejects.toThrow( + new Error("Invalid MD5 checksum on messages: barMessage") + ); + expect(mockHashUpdate.mock.calls.length).toBe(2); + expect(mockHashDigest.mock.calls.length).toBe(2); + }); +}); diff --git a/packages/middleware-sdk-sqs/src/send-message-batch.ts b/packages/middleware-sdk-sqs/src/send-message-batch.ts new file mode 100644 index 000000000000..4257180b433a --- /dev/null +++ b/packages/middleware-sdk-sqs/src/send-message-batch.ts @@ -0,0 +1,79 @@ +import { PreviouslyResolved } from "./configurations"; +import { + InitializeHandler, + InitializeMiddleware, + InitializeHandlerArguments, + InitializeHandlerOptions, + InitializeHandlerOutput, + MetadataBearer, + Pluggable +} from "@aws-sdk/types"; +import { toHex } from "@aws-sdk/util-hex-encoding"; + +interface SendMessageBatchResult { + Successful: Array | undefined; +} + +interface SendMessageBatchResultEntry { + Id: string | undefined; + MD5OfMessageBody: string | undefined; + MessageId: string | undefined; +} + +export function sendMessageBatchMiddleware( + options: PreviouslyResolved +): InitializeMiddleware { + return ( + next: InitializeHandler + ): InitializeHandler => async ( + args: InitializeHandlerArguments + ): Promise> => { + const resp = await next({ ...args }); + const output = (resp.output as unknown) as SendMessageBatchResult; + let messageIds = []; + let entries: { [index: string]: SendMessageBatchResultEntry } = {}; + if (output.Successful !== undefined) { + for (const entry of output.Successful) { + if (entry.Id !== undefined) { + entries[entry.Id] = entry; + } + } + } + for (const entry of args.input.Entries) { + if (entries[entry.Id]) { + const md5 = entries[entry.Id].MD5OfMessageBody; + const hash = new options.md5(); + hash.update(entry.MD5OfMessageBody || ""); + if (md5 !== toHex(await hash.digest())) { + messageIds.push(entries[entry.Id].MessageId); + } + } + } + if (messageIds.length > 0) { + throw new Error( + "Invalid MD5 checksum on messages: " + messageIds.join(", ") + ); + } + + return next({ + ...args + }); + }; +} + +export const sendMessageBatchMiddlewareOptions: InitializeHandlerOptions = { + step: "initialize", + tags: ["VALIDATE_BODY_MD5"], + name: "sendMessageBatchMiddleware" +}; + +export const getSendMessageBatchPlugin = ( + config: PreviouslyResolved +): Pluggable => ({ + applyToStack: clientStack => { + clientStack.add( + sendMessageBatchMiddleware(config), + sendMessageBatchMiddlewareOptions + ); + } +}); diff --git a/packages/middleware-sdk-sqs/src/send-message.spec.ts b/packages/middleware-sdk-sqs/src/send-message.spec.ts new file mode 100644 index 000000000000..9c07e893e6fa --- /dev/null +++ b/packages/middleware-sdk-sqs/src/send-message.spec.ts @@ -0,0 +1,50 @@ +import { sendMessageMiddleware } from "./send-message"; +import { HashConstructor } from "@aws-sdk/types"; + +describe("sendMessageMiddleware", () => { + const mockHashUpdate = jest.fn(); + const mockHashDigest = jest.fn().mockReturnValue(new Uint8Array(1)); + const MockHash: HashConstructor = class {} as any; + MockHash.prototype.update = mockHashUpdate; + MockHash.prototype.digest = mockHashDigest; + + beforeEach(() => { + mockHashUpdate.mockClear(); + mockHashDigest.mockClear(); + }); + + it("should do nothing if the checksum matches", async () => { + const next = jest.fn().mockReturnValue({ + output: { + MD5OfMessageBody: "00" + } + }); + const handler = sendMessageMiddleware({ + md5: MockHash + })(next, {} as any); + + await handler({ + input: {} + }); + + expect(mockHashUpdate.mock.calls.length).toBe(1); + expect(mockHashDigest.mock.calls.length).toBe(1); + }); + + it("should throw if the checksum does not match", async () => { + const next = jest.fn().mockReturnValue({ + output: { + MD5OfMessageBody: "1" + } + }); + const handler = sendMessageMiddleware({ + md5: MockHash + })(next, {} as any); + + await expect(handler({ input: {} })).rejects.toThrow( + new Error("InvalidChecksumError") + ); + expect(mockHashUpdate.mock.calls.length).toBe(1); + expect(mockHashDigest.mock.calls.length).toBe(1); + }); +}); diff --git a/packages/middleware-sdk-sqs/src/send-message.ts b/packages/middleware-sdk-sqs/src/send-message.ts new file mode 100644 index 000000000000..e252b9de2584 --- /dev/null +++ b/packages/middleware-sdk-sqs/src/send-message.ts @@ -0,0 +1,53 @@ +import { PreviouslyResolved } from "./configurations"; +import { + InitializeHandler, + InitializeMiddleware, + InitializeHandlerArguments, + InitializeHandlerOptions, + InitializeHandlerOutput, + MetadataBearer, + Pluggable +} from "@aws-sdk/types"; +import { toHex } from "@aws-sdk/util-hex-encoding"; + +interface SendMessageResult { + MD5OfMessageBody?: string; +} + +export function sendMessageMiddleware( + options: PreviouslyResolved +): InitializeMiddleware { + return ( + next: InitializeHandler + ): InitializeHandler => async ( + args: InitializeHandlerArguments + ): Promise> => { + const resp = await next({ ...args }); + const output = resp.output as SendMessageResult; + const hash = new options.md5(); + hash.update(args.input.MessageBody || ""); + if (output.MD5OfMessageBody !== toHex(await hash.digest())) { + throw new Error("InvalidChecksumError"); + } + return next({ + ...args + }); + }; +} + +export const sendMessageMiddlewareOptions: InitializeHandlerOptions = { + step: "initialize", + tags: ["VALIDATE_BODY_MD5"], + name: "sendMessageMiddleware" +}; + +export const getSendMessagePlugin = ( + config: PreviouslyResolved +): Pluggable => ({ + applyToStack: clientStack => { + clientStack.add( + sendMessageMiddleware(config), + sendMessageMiddlewareOptions + ); + } +}); diff --git a/packages/middleware-sdk-sqs/tsconfig.json b/packages/middleware-sdk-sqs/tsconfig.json new file mode 100644 index 000000000000..38b94cda274e --- /dev/null +++ b/packages/middleware-sdk-sqs/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "target": "es5", + "module": "commonjs", + "declaration": true, + "strict": true, + "sourceMap": true, + "downlevelIteration": true, + "importHelpers": true, + "noEmitHelpers": true, + "lib": [ + "es5", + "es2015.promise", + "es2015.collection", + "es2015.iterable", + "es2015.symbol.wellknown" + ], + "rootDir": "./src", + "outDir": "./build", + "incremental": true + } +} diff --git a/packages/middleware-sdk-sqs/tsconfig.test.json b/packages/middleware-sdk-sqs/tsconfig.test.json new file mode 100644 index 000000000000..17d0f1b7321f --- /dev/null +++ b/packages/middleware-sdk-sqs/tsconfig.test.json @@ -0,0 +1,11 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "sourceMap": false, + "inlineSourceMap": true, + "inlineSources": true, + "rootDir": "./src", + "outDir": "./build", + "incremental": true + } +}