chore: move logging of output/response to serde

Author: trivikr

packages/middleware-logger/src/loggerMiddleware.ts

@@ -13,7 +13,7 @@ export const loggerMiddleware = () => <Output extends MetadataBearer = MetadataB
   next: BuildHandler<any, Output>,
   context: HandlerExecutionContext
 ): BuildHandler<any, Output> => async (args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<Output>> => {
-  const { logger, inputFilterSensitiveLog, outputFilterSensitiveLog } = context;
+  const { logger } = context;
 
   const response = await next(args);
 
@@ -22,19 +22,13 @@ export const loggerMiddleware = () => <Output extends MetadataBearer = MetadataB
   }
 
   const {
-    output: { $metadata, ...outputWithoutMetadata },
+    output: { $metadata },
   } = response;
 
-  if (typeof logger.debug === "function") {
-    logger.debug({
-      httpResponse: response.response,
-    });
-  }
-
+  // Suggested custom metadata in https://github.com/aws/aws-sdk-js-v3/issues/1491#issuecomment-692174256
   if (typeof logger.info === "function") {
     logger.info({
       $metadata,
-      output: outputFilterSensitiveLog(outputWithoutMetadata),
     });
   }
 

packages/middleware-serde/src/deserializerMiddleware.ts

@@ -3,21 +3,42 @@ import {
   DeserializeHandlerArguments,
   DeserializeHandlerOutput,
   DeserializeMiddleware,
+  HandlerExecutionContext,
   ResponseDeserializer,
 } from "@aws-sdk/types";
 
-export function deserializerMiddleware<Input extends object, Output extends object, RuntimeUtils = any>(
+export const deserializerMiddleware = <Input extends object, Output extends object, RuntimeUtils = any>(
   options: RuntimeUtils,
   deserializer: ResponseDeserializer<any, any, RuntimeUtils>
-): DeserializeMiddleware<Input, Output> {
-  return (next: DeserializeHandler<Input, Output>): DeserializeHandler<Input, Output> => async (
-    args: DeserializeHandlerArguments<Input>
-  ): Promise<DeserializeHandlerOutput<Output>> => {
-    const { response } = await next(args);
-    const parsed = await deserializer(response, options);
-    return {
-      response,
-      output: parsed as Output,
-    };
+): DeserializeMiddleware<Input, Output> => (
+  next: DeserializeHandler<Input, Output>,
+  context: HandlerExecutionContext
+): DeserializeHandler<Input, Output> => async (
+  args: DeserializeHandlerArguments<Input>
+): Promise<DeserializeHandlerOutput<Output>> => {
+  const { logger, outputFilterSensitiveLog } = context;
+
+  const { response } = await next(args);
+
+  if (typeof logger?.debug === "function") {
+    logger.debug({
+      httpResponse: response,
+    });
+  }
+
+  const parsed = await deserializer(response, options);
+
+  // Log parsed after $metadata is removed in https://github.com/aws/aws-sdk-js-v3/issues/1490
+  const { $metadata, ...outputWithoutMetadata } = parsed;
+
+  if (typeof logger?.info === "function") {
+    logger.info({
+      output: outputFilterSensitiveLog(outputWithoutMetadata),
+    });
+  }
+
+  return {
+    response,
+    output: parsed as Output,
   };
-}
+};