Accept Provider in CompressionInputConfig (#1132)

Author: trivikr

.changeset/bright-elephants-walk.md

@@ -0,0 +1,5 @@
+---
+"@smithy/middleware-compression": patch
+---
+
+Accept Provider in CompressionInputConfig

packages/middleware-compression/package.json

@@ -18,6 +18,7 @@
     "@smithy/node-config-provider": "workspace:^",
     "@smithy/types": "workspace:^",
     "@smithy/util-config-provider": "workspace:^",
+    "@smithy/util-middleware": "workspace:^",
     "fflate": "0.8.1",
     "tslib": "^2.5.0"
   },

packages/middleware-compression/src/compressionMiddleware.spec.ts

@@ -15,8 +15,8 @@ describe(compressionMiddleware.name, () => {
   const mockBody = "body";
   const mockConfig = {
     bodyLengthChecker: jest.fn().mockReturnValue(mockBody.length),
-    disableRequestCompression: false,
-    requestMinCompressionSizeBytes: 0,
+    disableRequestCompression: async () => false,
+    requestMinCompressionSizeBytes: async () => 0,
   };
   const mockMiddlewareConfig = {
     encodings: [CompressionAlgorithm.GZIP],
@@ -32,20 +32,20 @@ describe(compressionMiddleware.name, () => {
 
   it("skips compression if it's not an HttpRequest", async () => {
     const { isInstance } = HttpRequest;
-    (isInstance as unknown as jest.Mock).mockReturnValue(false);
+    ((isInstance as unknown) as jest.Mock).mockReturnValue(false);
     await compressionMiddleware(mockConfig, mockMiddlewareConfig)(mockNext, mockContext)({ ...mockArgs } as any);
     expect(mockNext).toHaveBeenCalledWith(mockArgs);
   });
 
   describe("HttpRequest", () => {
     beforeEach(() => {
       const { isInstance } = HttpRequest;
-      (isInstance as unknown as jest.Mock).mockReturnValue(true);
+      ((isInstance as unknown) as jest.Mock).mockReturnValue(true);
       (isStreaming as jest.Mock).mockReturnValue(false);
     });
 
     it("skips compression if disabled", async () => {
-      await compressionMiddleware({ ...mockConfig, disableRequestCompression: true }, mockMiddlewareConfig)(
+      await compressionMiddleware({ ...mockConfig, disableRequestCompression: async () => true }, mockMiddlewareConfig)(
         mockNext,
         mockContext
       )({ ...mockArgs } as any);
@@ -107,7 +107,7 @@ describe(compressionMiddleware.name, () => {
     describe("not streaming", () => {
       it("skips compression if body is smaller than min size", async () => {
         await compressionMiddleware(
-          { ...mockConfig, requestMinCompressionSizeBytes: mockBody.length + 1 },
+          { ...mockConfig, requestMinCompressionSizeBytes: async () => mockBody.length + 1 },
           mockMiddlewareConfig
         )(
           mockNext,

packages/middleware-compression/src/compressionMiddleware.ts

@@ -11,7 +11,7 @@ import {
 
 import { compressStream } from "./compressStream";
 import { compressString } from "./compressString";
-import { CompressionResolvedConfig } from "./configurations";
+import { CompressionPreviouslyResolved, CompressionResolvedConfig } from "./configurations";
 import { CLIENT_SUPPORTED_ALGORITHMS, CompressionAlgorithm } from "./constants";
 import { isStreaming } from "./isStreaming";
 
@@ -34,67 +34,75 @@ export interface CompressionMiddlewareConfig {
 /**
  * @internal
  */
-export const compressionMiddleware =
-  (config: CompressionResolvedConfig, middlewareConfig: CompressionMiddlewareConfig): BuildMiddleware<any, any> =>
-  <Output extends MetadataBearer>(next: BuildHandler<any, Output>): BuildHandler<any, Output> =>
-  async (args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<Output>> => {
-    if (!HttpRequest.isInstance(args.request) || config.disableRequestCompression) {
-      return next(args);
-    }
+export const compressionMiddleware = (
+  config: CompressionResolvedConfig & CompressionPreviouslyResolved,
+  middlewareConfig: CompressionMiddlewareConfig
+): BuildMiddleware<any, any> => <Output extends MetadataBearer>(
+  next: BuildHandler<any, Output>
+): BuildHandler<any, Output> => async (args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<Output>> => {
+  if (!HttpRequest.isInstance(args.request)) {
+    return next(args);
+  }
+
+  const disableRequestCompression = await config.disableRequestCompression();
+  if (disableRequestCompression) {
+    return next(args);
+  }
 
-    const { request } = args;
-    const { body, headers } = request;
-    const { encodings, streamRequiresLength } = middlewareConfig;
+  const { request } = args;
+  const { body, headers } = request;
+  const { encodings, streamRequiresLength } = middlewareConfig;
 
-    let updatedBody = body;
-    let updatedHeaders = headers;
+  let updatedBody = body;
+  let updatedHeaders = headers;
 
-    for (const algorithm of encodings) {
-      if (CLIENT_SUPPORTED_ALGORITHMS.includes(algorithm as CompressionAlgorithm)) {
-        let isRequestCompressed = false;
-        if (isStreaming(body)) {
-          if (!streamRequiresLength) {
-            updatedBody = await compressStream(body);
-            isRequestCompressed = true;
-          } else {
-            // Invalid case. We should never get here.
-            throw new Error("Compression is not supported for streaming blobs that require a length.");
-          }
+  for (const algorithm of encodings) {
+    if (CLIENT_SUPPORTED_ALGORITHMS.includes(algorithm as CompressionAlgorithm)) {
+      let isRequestCompressed = false;
+      if (isStreaming(body)) {
+        if (!streamRequiresLength) {
+          updatedBody = await compressStream(body);
+          isRequestCompressed = true;
         } else {
-          const bodyLength = config.bodyLengthChecker(body);
-          if (bodyLength && bodyLength >= config.requestMinCompressionSizeBytes) {
-            updatedBody = await compressString(body);
-            isRequestCompressed = true;
-          }
+          // Invalid case. We should never get here.
+          throw new Error("Compression is not supported for streaming blobs that require a length.");
         }
+      } else {
+        const bodyLength = config.bodyLengthChecker(body);
+        const requestMinCompressionSizeBytes = await config.requestMinCompressionSizeBytes();
+        if (bodyLength && bodyLength >= requestMinCompressionSizeBytes) {
+          updatedBody = await compressString(body);
+          isRequestCompressed = true;
+        }
+      }
 
-        if (isRequestCompressed) {
-          // Either append to the header if it already exists, else set it
-          if (headers["Content-Encoding"]) {
-            updatedHeaders = {
-              ...headers,
-              "Content-Encoding": `${headers["Content-Encoding"]},${algorithm}`,
-            };
-          } else {
-            updatedHeaders = { ...headers, "Content-Encoding": algorithm };
-          }
-
-          // We've matched on one supported algorithm in the
-          // priority-ordered list, so we're finished.
-          break;
+      if (isRequestCompressed) {
+        // Either append to the header if it already exists, else set it
+        if (headers["Content-Encoding"]) {
+          updatedHeaders = {
+            ...headers,
+            "Content-Encoding": `${headers["Content-Encoding"]},${algorithm}`,
+          };
+        } else {
+          updatedHeaders = { ...headers, "Content-Encoding": algorithm };
         }
+
+        // We've matched on one supported algorithm in the
+        // priority-ordered list, so we're finished.
+        break;
       }
     }
+  }
 
-    return next({
-      ...args,
-      request: {
-        ...request,
-        body: updatedBody,
-        headers: updatedHeaders,
-      },
-    });
-  };
+  return next({
+    ...args,
+    request: {
+      ...request,
+      body: updatedBody,
+      headers: updatedHeaders,
+    },
+  });
+};
 
 export const compressionMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation = {
   name: "compressionMiddleware",

packages/middleware-compression/src/configurations.ts

@@ -1,27 +1,42 @@
-import { BodyLengthCalculator } from "@smithy/types";
+import { BodyLengthCalculator, Provider } from "@smithy/types";
 
 /**
  * @public
  */
 export interface CompressionInputConfig {
-  /**
-   * A function that can calculate the length of a body.
-   */
-  bodyLengthChecker: BodyLengthCalculator;
-
   /**
    * Whether to disable request compression.
    */
-  disableRequestCompression: boolean;
+  disableRequestCompression: boolean | Provider<boolean>;
 
   /**
    * The minimum size in bytes that a request body should be to trigger compression.
    * The value must be a non-negative integer value between 0 and 10485760 bytes inclusive.
    */
-  requestMinCompressionSizeBytes: number;
+  requestMinCompressionSizeBytes: number | Provider<number>;
+}
+
+/**
+ * @internal
+ */
+export interface CompressionPreviouslyResolved {
+  /**
+   * A function that can calculate the length of a body.
+   */
+  bodyLengthChecker: BodyLengthCalculator;
 }
 
 /**
  * @internal
  */
-export interface CompressionResolvedConfig extends CompressionInputConfig {}
+export interface CompressionResolvedConfig {
+  /**
+   * Resolved value for input config {@link CompressionInputConfig.disableRequestCompression}
+   */
+  disableRequestCompression: Provider<boolean>;
+
+  /**
+   * Resolved value for input config {@link CompressionInputConfig.requestMinCompressionSizeBytes}
+   */
+  requestMinCompressionSizeBytes: Provider<number>;
+}

packages/middleware-compression/src/getCompressionPlugin.spec.ts

@@ -6,8 +6,8 @@ jest.mock("./compressionMiddleware");
 describe(getCompressionPlugin.name, () => {
   const config = {
     bodyLengthChecker: jest.fn(),
-    disableRequestCompression: false,
-    requestMinCompressionSizeBytes: 0,
+    disableRequestCompression: async () => false,
+    requestMinCompressionSizeBytes: async () => 0,
   };
   const middlewareConfig = { encodings: [] };
 

packages/middleware-compression/src/getCompressionPlugin.ts

@@ -5,13 +5,13 @@ import {
   CompressionMiddlewareConfig,
   compressionMiddlewareOptions,
 } from "./compressionMiddleware";
-import { CompressionResolvedConfig } from "./configurations";
+import { CompressionPreviouslyResolved, CompressionResolvedConfig } from "./configurations";
 
 /**
  * @internal
  */
 export const getCompressionPlugin = (
-  config: CompressionResolvedConfig,
+  config: CompressionResolvedConfig & CompressionPreviouslyResolved,
   middlewareConfig: CompressionMiddlewareConfig
 ): Pluggable<any, any> => ({
   applyToStack: (clientStack) => {

packages/middleware-compression/src/resolveCompressionConfig.spec.ts

@@ -6,39 +6,41 @@ describe(resolveCompressionConfig.name, () => {
     disableRequestCompression: false,
     requestMinCompressionSizeBytes: 0,
   };
-  it("should throw an error if requestMinCompressionSizeBytes is less than 0", () => {
+
+  it("should throw an error if requestMinCompressionSizeBytes is less than 0", async () => {
     const requestMinCompressionSizeBytes = -1;
-    expect(() => {
-      resolveCompressionConfig({ ...mockConfig, requestMinCompressionSizeBytes });
-    }).toThrow(
+    const resolvedConfig = resolveCompressionConfig({ ...mockConfig, requestMinCompressionSizeBytes });
+    await expect(resolvedConfig.requestMinCompressionSizeBytes()).rejects.toThrow(
       new RangeError(
         "The value for requestMinCompressionSizeBytes must be between 0 and 10485760 inclusive. " +
           `The provided value ${requestMinCompressionSizeBytes} is outside this range."`
       )
     );
   });
 
-  it("should throw an error if requestMinCompressionSizeBytes is greater than 10485760", () => {
+  it("should throw an error if requestMinCompressionSizeBytes is greater than 10485760", async () => {
     const requestMinCompressionSizeBytes = 10485761;
-    expect(() => {
-      resolveCompressionConfig({ ...mockConfig, requestMinCompressionSizeBytes });
-    }).toThrow(
+    const resolvedConfig = resolveCompressionConfig({ ...mockConfig, requestMinCompressionSizeBytes });
+    await expect(resolvedConfig.requestMinCompressionSizeBytes()).rejects.toThrow(
       new RangeError(
         "The value for requestMinCompressionSizeBytes must be between 0 and 10485760 inclusive. " +
           `The provided value ${requestMinCompressionSizeBytes} is outside this range."`
       )
     );
   });
 
-  it.each([0, 10240, 10485760])("returns requestMinCompressionSizeBytes value %s", (requestMinCompressionSizeBytes) => {
-    const inputConfig = { ...mockConfig, requestMinCompressionSizeBytes };
-    const resolvedConfig = resolveCompressionConfig(inputConfig);
-    expect(inputConfig).toEqual(resolvedConfig);
-  });
+  it.each([0, 10240, 10485760])(
+    "returns requestMinCompressionSizeBytes value %s",
+    async (requestMinCompressionSizeBytes) => {
+      const inputConfig = { ...mockConfig, requestMinCompressionSizeBytes };
+      const resolvedConfig = resolveCompressionConfig(inputConfig);
+      await expect(resolvedConfig.requestMinCompressionSizeBytes()).resolves.toEqual(requestMinCompressionSizeBytes);
+    }
+  );
 
-  it.each([false, true])("returns disableRequestCompression value %s", (disableRequestCompression) => {
+  it.each([false, true])("returns disableRequestCompression value %s", async (disableRequestCompression) => {
     const inputConfig = { ...mockConfig, disableRequestCompression };
     const resolvedConfig = resolveCompressionConfig(inputConfig);
-    expect(inputConfig).toEqual(resolvedConfig);
+    await expect(resolvedConfig.disableRequestCompression()).resolves.toEqual(disableRequestCompression);
   });
 });

packages/middleware-compression/src/resolveCompressionConfig.ts

@@ -1,19 +1,25 @@
+import { normalizeProvider } from "@smithy/util-middleware";
+
 import { CompressionInputConfig, CompressionResolvedConfig } from "./configurations";
 
 /**
  * @internal
  */
-export const resolveCompressionConfig = <T>(input: T & CompressionInputConfig): T & CompressionResolvedConfig => {
-  const { requestMinCompressionSizeBytes } = input;
+export const resolveCompressionConfig = <T>(input: T & CompressionInputConfig): T & CompressionResolvedConfig => ({
+  ...input,
+  disableRequestCompression: normalizeProvider(input.disableRequestCompression),
+  requestMinCompressionSizeBytes: async () => {
+    const requestMinCompressionSizeBytes = await normalizeProvider(input.requestMinCompressionSizeBytes)();
 
-  // The requestMinCompressionSizeBytes should be less than the upper limit for API Gateway
-  // https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html
-  if (requestMinCompressionSizeBytes < 0 || requestMinCompressionSizeBytes > 10485760) {
-    throw new RangeError(
-      "The value for requestMinCompressionSizeBytes must be between 0 and 10485760 inclusive. " +
-        `The provided value ${requestMinCompressionSizeBytes} is outside this range."`
-    );
-  }
+    // The requestMinCompressionSizeBytes should be less than the upper limit for API Gateway
+    // https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html
+    if (requestMinCompressionSizeBytes < 0 || requestMinCompressionSizeBytes > 10485760) {
+      throw new RangeError(
+        "The value for requestMinCompressionSizeBytes must be between 0 and 10485760 inclusive. " +
+          `The provided value ${requestMinCompressionSizeBytes} is outside this range."`
+      );
+    }
 
-  return input;
-};
+    return requestMinCompressionSizeBytes;
+  },
+});

yarn.lock

@@ -2085,6 +2085,7 @@ __metadata:
     "@smithy/node-config-provider": "workspace:^"
     "@smithy/types": "workspace:^"
     "@smithy/util-config-provider": "workspace:^"
+    "@smithy/util-middleware": "workspace:^"
     "@tsconfig/recommended": 1.0.1
     concurrently: 7.0.0
     downlevel-dts: 0.10.1