Skip to content

Commit 0e18b0a

Browse files
committed
test: update loggerMiddleware tests
1 parent 99f85a2 commit 0e18b0a

File tree

2 files changed

+6
-41
lines changed

2 files changed

+6
-41
lines changed

packages/middleware-logger/src/loggerMiddleware.spec.ts

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,8 @@ describe("getLoggerPlugin", () => {
2121
describe("loggerMiddleware", () => {
2222
const next = jest.fn();
2323

24-
const args = {
25-
input: {
26-
inputKey: "inputValue",
27-
},
28-
request: {
29-
method: "GET",
30-
headers: {},
31-
},
32-
};
33-
24+
const args = {};
3425
const mockResponse = {
35-
response: {
36-
statusCode: 200,
37-
headers: {},
38-
},
3926
output: {
4027
$metadata: {
4128
statusCode: 200,
@@ -59,54 +46,31 @@ describe("loggerMiddleware", () => {
5946
expect(response).toStrictEqual(mockResponse);
6047
});
6148

62-
it("returns without logging if context.logger doesn't have debug/info functions", async () => {
49+
it("returns without logging if context.logger doesn't have info function", async () => {
6350
const logger = {} as Logger;
6451
const response = await loggerMiddleware()(next, { logger })(args as BuildHandlerArguments<any>);
6552
expect(next).toHaveBeenCalledTimes(1);
6653
expect(response).toStrictEqual(mockResponse);
6754
});
6855

69-
it("logs $metadata, input, output if context.logger has info function", async () => {
56+
it("logs $metadata if context.logger has info function", async () => {
7057
const logger = ({ info: jest.fn() } as unknown) as Logger;
7158

72-
const inputFilterSensitiveLog = jest.fn().mockImplementationOnce((input) => input);
73-
const outputFilterSensitiveLog = jest.fn().mockImplementationOnce((output) => output);
7459
const context = {
7560
logger,
76-
inputFilterSensitiveLog,
77-
outputFilterSensitiveLog,
7861
};
7962

8063
const response = await loggerMiddleware()(next, context)(args as BuildHandlerArguments<any>);
8164
expect(next).toHaveBeenCalledTimes(1);
8265
expect(response).toStrictEqual(mockResponse);
8366

84-
expect(inputFilterSensitiveLog).toHaveBeenCalledTimes(1);
85-
expect(outputFilterSensitiveLog).toHaveBeenCalledTimes(1);
8667
expect(logger.info).toHaveBeenCalledTimes(1);
8768

8869
const {
89-
output: { $metadata, ...outputWithoutMetadata },
70+
output: { $metadata },
9071
} = mockResponse;
9172
expect(logger.info).toHaveBeenCalledWith({
9273
$metadata,
93-
input: args.input,
94-
output: outputWithoutMetadata,
95-
});
96-
});
97-
98-
it("logs httpRequest, httpResponse if context.logger has debug function", async () => {
99-
const logger = ({ debug: jest.fn() } as unknown) as Logger;
100-
const response = await loggerMiddleware()(next, { logger })(args as BuildHandlerArguments<any>);
101-
expect(next).toHaveBeenCalledTimes(1);
102-
expect(response).toStrictEqual(mockResponse);
103-
104-
expect(logger.debug).toHaveBeenCalledTimes(2);
105-
expect(logger.debug).toHaveBeenNthCalledWith(1, {
106-
httpRequest: args.request,
107-
});
108-
expect(logger.debug).toHaveBeenNthCalledWith(2, {
109-
httpResponse: mockResponse.response,
11074
});
11175
});
11276
});

packages/middleware-logger/src/loggerMiddleware.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ export const loggerMiddleware = () => <Output extends MetadataBearer = MetadataB
2525
output: { $metadata },
2626
} = response;
2727

28-
// Suggested custom metadata in https://github.com/aws/aws-sdk-js-v3/issues/1491#issuecomment-692174256
28+
// TODO: Populate custom metadata in https://github.com/aws/aws-sdk-js-v3/issues/1491#issuecomment-692174256
29+
// $metadata will be removed in https://github.com/aws/aws-sdk-js-v3/issues/1490
2930
if (typeof logger.info === "function") {
3031
logger.info({
3132
$metadata,

0 commit comments

Comments
 (0)