diff --git a/packages/middleware-http-debug-log/CHANGELOG.md b/packages/middleware-http-debug-log/CHANGELOG.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/middleware-http-debug-log/LICENSE b/packages/middleware-http-debug-log/LICENSE new file mode 100644 index 000000000000..dd65ae06be7a --- /dev/null +++ b/packages/middleware-http-debug-log/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 2018-2020 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-http-debug-log/README.md b/packages/middleware-http-debug-log/README.md new file mode 100644 index 000000000000..91e2d09c9c1c --- /dev/null +++ b/packages/middleware-http-debug-log/README.md @@ -0,0 +1,96 @@ +# @aws-sdk/middleware-http-debug-log + +An internal package for HTTP message logging. + +This package is not available on NPM. + +## Usage + +```ts +import { type HttpDebugLoggingOptions, getHttpDebugLogPlugin } from "@aws-sdk/middleware-http-debug-log"; +import { S3 } from "@aws-sdk/client-s3"; + +const client = new S3({}); + +// See type {HttpDebugLoggingOptions} for detailed logging options. +// It can be a string, shown here, or object. +const options: HttpDebugLoggingOptions = "header body formatted"; +client.middlewareStack.use(getHttpDebugLogPlugin(options)); + +await client.listBuckets({ + MaxBuckets: 2, +}); +``` + +Output (data redacted): + +```txt +200 GET S3Client ListBucketsCommand + https://s3.**-****-*.amazonaws.com/ + >> Request URL queryParams: { + "x-id": "ListBuckets", + "max-buckets": "2" + } + >>== Request Headers: { + "x-amz-user-agent": "aws-sdk-js/3.***.0", + "user-agent": "aws-sdk-js/3.***.0 ua/2.1 os/*** lang/js md/nodejs#*** api/s3#3.***.0 m/E,n", + "host": "s3.**-****-*.amazonaws.com", + "amz-sdk-invocation-id": "***-***-***-***-***", + "amz-sdk-request": "attempt=1; max=3", + "x-amz-date": "***", + "x-amz-security-token": "***", + "x-amz-content-sha256": "***", + "authorization": "AWS4-HMAC-SHA256 Credential=***/***/**-****-*/s3/aws4_request, SignedHeaders=amz-sdk-invocation-id;amz-sdk-request;host;x-amz-content-sha256;x-amz-date;x-amz-security-token;x-amz-user-agent, Signature=***" + } + >>>=== Request Body Start ====== + + >>>=== Request Body End ====== + <<== Response Headers: { + "x-amz-id-2": "***", + "x-amz-request-id": "***", + "date": "*** GMT", + "content-type": "application/xml", + "transfer-encoding": "chunked", + "server": "AmazonS3" + } + <<<=== Response Body Start ====== + + + + + *** + + + *** + + + + + + *** + + + *** + + + *** + + + + + *** + + + *** + + + *** + + + + + *** + + + <<<=== Response Body End ====== +``` diff --git a/packages/middleware-http-debug-log/package.json b/packages/middleware-http-debug-log/package.json new file mode 100644 index 000000000000..7eeb49261157 --- /dev/null +++ b/packages/middleware-http-debug-log/package.json @@ -0,0 +1,58 @@ +{ + "name": "@aws-sdk/middleware-http-debug-log", + "version": "3.0.0", + "private": true, + "scripts": { + "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", + "build:cjs": "node ../../scripts/compilation/inline middleware-http-debug-log", + "build:es": "tsc -p tsconfig.es.json", + "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build", + "build:types": "tsc -p tsconfig.types.json", + "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", + "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "test": "yarn g:vitest run", + "test:watch": "yarn g:vitest watch" + }, + "main": "./dist-cjs/index.js", + "module": "./dist-es/index.js", + "types": "./dist-types/index.d.ts", + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "dependencies": { + "@smithy/protocol-http": "^5.0.1", + "@smithy/types": "^4.1.0", + "@smithy/util-stream": "^4.1.2", + "@smithy/util-utf8": "^4.0.0", + "tslib": "^2.6.2" + }, + "devDependencies": { + "@tsconfig/recommended": "1.0.1", + "@types/node": "^18.19.69", + "concurrently": "7.0.0", + "downlevel-dts": "0.10.1", + "rimraf": "3.0.2", + "typescript": "~5.2.2" + }, + "engines": { + "node": ">=18.0.0" + }, + "typesVersions": { + "<4.0": { + "dist-types/*": [ + "dist-types/ts3.4/*" + ] + } + }, + "files": [ + "dist-*/**" + ], + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/middleware-http-debug-log", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "packages/middleware-http-debug-log" + } +} diff --git a/packages/middleware-http-debug-log/src/getHttpDebugLogPlugin.spec.ts b/packages/middleware-http-debug-log/src/getHttpDebugLogPlugin.spec.ts new file mode 100644 index 000000000000..3303122f218d --- /dev/null +++ b/packages/middleware-http-debug-log/src/getHttpDebugLogPlugin.spec.ts @@ -0,0 +1,261 @@ +import { HttpRequest, HttpResponse } from "@smithy/protocol-http"; +import { Readable } from "node:stream"; +import { describe, expect, test as it, vi } from "vitest"; + +import { getHttpDebugLogPlugin } from "./getHttpDebugLogPlugin"; + +describe(getHttpDebugLogPlugin.name, () => { + describe("JSON", () => { + const httpRequest = new HttpRequest({ + headers: { + header1: "headerValue1", + }, + query: { + query1: "queryValue1", + }, + protocol: "https:", + hostname: "localhost", + path: "/path", + body: JSON.stringify({ requestBody: "OK" }), + }); + + const httpResponse = new HttpResponse({ + headers: { + responseHeader1: "responseHeaderValue1", + }, + statusCode: 200, + body: Readable.from('{ "responseBody": "OK" }'), + }); + + it("should pass http request and response data through a logger", async () => { + const next = () => ({ + response: httpResponse, + }); + const args = { + request: httpRequest, + }; + + const mwStack = { + addRelativeTo(middleware: (next: Function, context: any) => (args: any) => Promise): void { + middleware(next, {})(args); + }, + } as any; + + const logger = { + error: vi.fn(), + warn: vi.fn(), + info: vi.fn(), + debug: vi.fn(), + }; + + const plugin = getHttpDebugLogPlugin({ + request: { + client: true, + command: true, + method: true, + url: true, + headers: true, + formatBody: true, + body: true, + }, + response: { + statusCode: true, + headers: true, + body: true, + formatBody: true, + }, + logger: logger, + }); + + plugin.applyToStack(mwStack); + + // inner tested fn is un-awaitable. + await new Promise((r) => setTimeout(r, 100)); + + expect(vi.mocked(logger.debug).mock.calls.flat()).toEqual([ + "200 GET UnknownClient UnknownCommand", + " https://localhost/path", + ` >> Request URL queryParams: { + "query1": "queryValue1" + }`, + ` >>== Request Headers: { + "header1": "headerValue1" + }`, + " >>>=== Request Body Start ======", + ` { + "requestBody": "OK" + }`, + " >>>=== Request Body End ======", + ` <<== Response Headers: { + "responseHeader1": "responseHeaderValue1" + }`, + " <<<=== Response Body Start ======", + ` { + "responseBody": "OK" + }`, + " <<<=== Response Body End ======", + ]); + }); + }); + + describe("XML", () => { + const httpRequest = new HttpRequest({ + headers: { + header1: "headerValue1", + }, + query: { + query1: "queryValue1", + }, + protocol: "https:", + hostname: "localhost", + path: "/path", + body: `stringstringstringstringstringstringstringstringstringstringstring`, + }); + + const httpResponse = new HttpResponse({ + headers: { + responseHeader1: "responseHeaderValue1", + }, + statusCode: 200, + body: Readable.from( + `stringstringstringstringstringstringstringstringstring` + ), + }); + + it("should pass http request and response data through a logger", async () => { + const next = () => ({ + response: httpResponse, + }); + const args = { + request: httpRequest, + }; + + const mwStack = { + addRelativeTo(middleware: (next: Function, context: any) => (args: any) => Promise): void { + middleware(next, {})(args); + }, + } as any; + + const plugin = getHttpDebugLogPlugin("lines headers formatted"); + + plugin.applyToStack(mwStack); + + const spy = vi.spyOn(console, "debug").mockImplementation(() => {}); + + // inner tested fn is un-awaitable. + await new Promise((r) => setTimeout(r, 100)); + + expect(vi.mocked(spy).mock.calls.flat()).toEqual([ + "200 GET UnknownClient UnknownCommand", + " https://localhost/path", + ` >> Request URL queryParams: { + "query1": "queryValue1" + }`, + ` >>== Request Headers: { + "header1": "headerValue1" + }`, + " >>>=== Request Body Start ======", + ` + + + + string + + + + + string + + + + + string + + + string + + + + + + + string + + + string + + + + + string + + + string + + + string + + + string + + + string + + + + + `, + " >>>=== Request Body End ======", + ` <<== Response Headers: { + "responseHeader1": "responseHeaderValue1" + }`, + " <<<=== Response Body Start ======", + ` + + + + string + + + + + + string + + + string + + + string + + + string + + + string + + + + string + + + + + + + string + + + + + + + string + + + `, + " <<<=== Response Body End ======", + ]); + }); + }); +}); diff --git a/packages/middleware-http-debug-log/src/getHttpDebugLogPlugin.ts b/packages/middleware-http-debug-log/src/getHttpDebugLogPlugin.ts new file mode 100644 index 000000000000..b54d5a4dc9ba --- /dev/null +++ b/packages/middleware-http-debug-log/src/getHttpDebugLogPlugin.ts @@ -0,0 +1,322 @@ +import { HttpRequest, HttpResponse } from "@smithy/protocol-http"; +import type { + DeserializeHandler, + DeserializeHandlerArguments, + HandlerExecutionContext, + Logger, + MiddlewareStack, +} from "@smithy/types"; +import { headStream } from "@smithy/util-stream"; +import { fromUtf8, toUtf8 } from "@smithy/util-utf8"; + +/** + * FOR DEBUG USE ONLY. + * Attaching these debug loggers will degrade performance since body streams may need to be read twice. + * + * When given as a string, + * Including "line" will turn on method, statusCode, client, command, URL logging. + * Including "header" will turn on request and response header logging. + * Including "body" will turn on response body logging. + * Including "formatted" will turn on response body logging with formatting. + * + * @public + */ +export type HttpDebugLoggingOptions = + | string + | { + request?: { + /** + * The client name. + */ + client?: boolean; + /** + * The command name. + */ + command?: boolean; + /** + * HTTP request method. + */ + method?: boolean; + /** + * HTTP request URL. + */ + url?: boolean; + /** + * HTTP request headers. + */ + headers?: boolean; + /** + * HTTP request payload/body. + */ + body?: boolean; + /** + * Attempt to format body (JSON, XML supported). + */ + formatBody?: boolean | "json" | "xml"; + }; + response?: { + /** + * HTTP response status code. + */ + statusCode?: boolean; + /** + * HTTP response headers. + */ + headers?: boolean; + /** + * HTTP body in utf-8. + * Does not work for HTTP2 and will be unreadable for BLOB payloads. + */ + body?: boolean; + /** + * Attempt to format body (JSON, XML supported). + */ + formatBody?: boolean | "json" | "xml"; + }; + logger?: Logger; + }; + +/** + * FOR DEBUG USE ONLY. + * Attaching these debug loggers will degrade performance since body streams may need to be read twice. + * + * @public + * + * @param options - what to log. + */ +export function getHttpDebugLogPlugin(options: HttpDebugLoggingOptions = {}) { + const optionsObject: Required> = { + request: {}, + response: {}, + logger: console, + }; + if (typeof options === "string") { + const [line, header, body, formatted] = [ + options.includes("line"), + options.includes("header"), + options.includes("body"), + options.includes("formatted"), + ]; + if (line || header || body || formatted) { + optionsObject.request.command = true; + optionsObject.request.client = true; + optionsObject.request.url = true; + optionsObject.request.method = true; + optionsObject.response.statusCode = true; + } + if (header) { + optionsObject.request.headers = true; + optionsObject.response.headers = true; + } + if (body || formatted) { + optionsObject.request.body = true; + optionsObject.response.body = true; + } + if (formatted) { + optionsObject.request.formatBody = true; + optionsObject.response.formatBody = true; + } + } else { + Object.assign(optionsObject, options); + } + + return { + applyToStack: (middlewareStack: MiddlewareStack) => { + middlewareStack.addRelativeTo( + (next: DeserializeHandler, context: HandlerExecutionContext) => + async (args: DeserializeHandlerArguments) => { + let result: any = undefined; + let error: unknown = undefined; + let request: HttpRequest | unknown = undefined; + let response: HttpResponse | unknown; + + try { + result = await next(args); + request = args.request; + response = result.response; + } catch (e) { + error = e; + response = e.$response; + if (response && e.$responseBodyText) { + (response as HttpResponse).body = fromUtf8(e.$responseBodyText); + } + } + + if (HttpRequest.isInstance(request) && HttpResponse.isInstance(response)) { + const logger = optionsObject.logger; + const line: string[] = []; + if (optionsObject.response.statusCode) { + line.push(String(response.statusCode)); + } + if (optionsObject.request.method) { + line.push(request.method); + } + const { clientName = "UnknownClient", commandName = "UnknownCommand" } = context; + if (optionsObject.request.client) { + line.push(clientName); + } + if (optionsObject.request.command) { + line.push(commandName); + } + logger.debug(line.join(" ")); + const indentation = line.length ? 4 : 0; + + if (optionsObject.request.url) { + let auth = ""; + if (request.username != null || request.password != null) { + const username = request.username ?? ""; + const password = "***"; + auth = `${username}:${password}@`; + } + + const { port, path } = request; + const url = `${request.protocol}//${auth}${request.hostname}${port ? `:${port}` : ""}${path}`; + logger.debug(indent(indentation, url)); + if (Object.keys(request.query).length) { + logger.debug(indent(4, ">> Request URL queryParams: " + JSON.stringify(request.query, null, 2))); + } + } + if (optionsObject.request.headers) { + const headers = { + ...request.headers, + }; + for (const key in headers) { + if (key.toLowerCase().match(/security|-token/)) { + headers[key] = "***"; + } + if (key.toLowerCase() === "authorization") { + let value = "***"; + if (headers[key].match(/Credential=[A-Z0-9]+/)) { + value = headers[key] + .replace(/Credential=[A-Z0-9\w]+/, "Credential=***") + .replace(/Signature=\w+/, "Signature=***"); + } + headers[key] = value; + } + } + logger.debug(indent(indentation, ">>== Request Headers: " + JSON.stringify(headers, null, 2))); + } + if (optionsObject.request.body) { + const body = await (async () => { + if (typeof request.body === "string") { + return fromUtf8(request.body); + } + try { + return await headStream(request.body, Infinity); + } catch (e) { + return fromUtf8(request.body ? String(request.body) : ""); + } + })(); + const text = format(body, optionsObject.request.formatBody); + logger.debug(indent(indentation, `>>>=== Request Body Start ======`)); + logger.debug(indent(indentation, text)); + logger.debug(indent(indentation, `>>>=== Request Body End ======`)); + request.body = body; + } + + if (optionsObject.response.headers) { + logger.debug( + indent(indentation, "<<== Response Headers: " + JSON.stringify(response.headers, null, 2)) + ); + } + if (optionsObject.response.body) { + const bodyBytes = await headStream(response.body, Infinity); + const text = format(bodyBytes, optionsObject.response.formatBody); + logger.debug(indent(indentation, `<<<=== Response Body Start ======`)); + logger.debug(indent(indentation, text)); + logger.debug(indent(indentation, `<<<=== Response Body End ======`)); + response.body = bodyBytes; + } + } + + if (error) { + throw error; + } + return result; + }, + { + toMiddleware: "deserializerMiddleware", + relation: "after", + name: "httpDebugLogMiddleware", + override: true, + } + ); + }, + }; +} + +/** + * @internal + */ +function format(str: string | Uint8Array, format: boolean | "json" | "xml" = false): string { + if (!str) { + return ""; + } + let text = ""; + try { + text = toUtf8(str); + if (format === true || format === "json") { + try { + text = JSON.stringify(JSON.parse(text), null, 2); + } catch (e) { + // ignore error, text is not JSON. + } + } + if (format === true || format === "xml") { + try { + if (text.startsWith("") { + indentation += 2; + b += c + "\n" + " ".repeat(indentation); + } else { + b += c; + } + } + return b + .split("\n") + .filter((s) => !!s.trim()) + .join("\n"); +} diff --git a/packages/middleware-http-debug-log/src/index.ts b/packages/middleware-http-debug-log/src/index.ts new file mode 100644 index 000000000000..b7940710f34c --- /dev/null +++ b/packages/middleware-http-debug-log/src/index.ts @@ -0,0 +1 @@ +export { getHttpDebugLogPlugin, type HttpDebugLoggingOptions } from "./getHttpDebugLogPlugin"; diff --git a/packages/middleware-http-debug-log/tsconfig.cjs.json b/packages/middleware-http-debug-log/tsconfig.cjs.json new file mode 100644 index 000000000000..ef6dff226650 --- /dev/null +++ b/packages/middleware-http-debug-log/tsconfig.cjs.json @@ -0,0 +1,10 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "outDir": "dist-cjs", + "rootDir": "src", + "strict": false + }, + "extends": "../../tsconfig.cjs.json", + "include": ["src/"] +} diff --git a/packages/middleware-http-debug-log/tsconfig.es.json b/packages/middleware-http-debug-log/tsconfig.es.json new file mode 100644 index 000000000000..a19fc8aee5b3 --- /dev/null +++ b/packages/middleware-http-debug-log/tsconfig.es.json @@ -0,0 +1,11 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "lib": [], + "outDir": "dist-es", + "rootDir": "src", + "strict": false + }, + "extends": "../../tsconfig.es.json", + "include": ["src/"] +} diff --git a/packages/middleware-http-debug-log/tsconfig.types.json b/packages/middleware-http-debug-log/tsconfig.types.json new file mode 100644 index 000000000000..6cdf9f52ea06 --- /dev/null +++ b/packages/middleware-http-debug-log/tsconfig.types.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "declarationDir": "dist-types", + "rootDir": "src" + }, + "extends": "../../tsconfig.types.json", + "include": ["src/"] +} diff --git a/packages/middleware-http-debug-log/vitest.config.ts b/packages/middleware-http-debug-log/vitest.config.ts new file mode 100644 index 000000000000..4e46707824a5 --- /dev/null +++ b/packages/middleware-http-debug-log/vitest.config.ts @@ -0,0 +1,9 @@ +import { defineConfig } from "vitest/config"; + +export default defineConfig({ + test: { + exclude: ["**/*.{integ,e2e,browser}.spec.ts"], + include: ["**/*.spec.ts"], + environment: "node", + }, +}); diff --git a/yarn.lock b/yarn.lock index 2d62d1fc8a5c..8743290a34ac 100644 --- a/yarn.lock +++ b/yarn.lock @@ -22933,6 +22933,24 @@ __metadata: languageName: unknown linkType: soft +"@aws-sdk/middleware-http-debug-log@workspace:packages/middleware-http-debug-log": + version: 0.0.0-use.local + resolution: "@aws-sdk/middleware-http-debug-log@workspace:packages/middleware-http-debug-log" + dependencies: + "@smithy/protocol-http": "npm:^5.0.1" + "@smithy/types": "npm:^4.1.0" + "@smithy/util-stream": "npm:^4.1.2" + "@smithy/util-utf8": "npm:^4.0.0" + "@tsconfig/recommended": "npm:1.0.1" + "@types/node": "npm:^18.19.69" + concurrently: "npm:7.0.0" + downlevel-dts: "npm:0.10.1" + rimraf: "npm:3.0.2" + tslib: "npm:^2.6.2" + typescript: "npm:~5.2.2" + languageName: unknown + linkType: soft + "@aws-sdk/middleware-location-constraint@npm:*, @aws-sdk/middleware-location-constraint@workspace:packages/middleware-location-constraint": version: 0.0.0-use.local resolution: "@aws-sdk/middleware-location-constraint@workspace:packages/middleware-location-constraint"