chore: update configurations

Author: trivikr

packages/middleware-compression/jest.config.js

@@ -0,0 +1,6 @@
+const base = require("../../jest.config.base.js");
+
+module.exports = {
+  ...base,
+  testMatch: ["**/*.spec.ts"],
+};

packages/middleware-compression/src/compressionMiddleware.ts

@@ -10,7 +10,7 @@ import {
 } from "@smithy/types";
 
 import { compress, compressStream } from "./compress";
-import { CompressionResolvedConfig } from "./configuration";
+import { CompressionResolvedConfig } from "./configurations";
 import { CLIENT_SUPPORTED_ALGORITHMS as supportedAlgorithms } from "./types";
 import { isStreaming } from "./utils";
 

packages/middleware-compression/src/configuration.ts

@@ -0,0 +1,20 @@
+/**
+ * @public
+ */
+export interface CompressionInputConfig {
+  /**
+   * Whether to disable request compression.
+   */
+  disableRequestCompression: 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;
+}
+
+/**
+ * @internal
+ */
+export interface CompressionResolvedConfig extends CompressionInputConfig {}

packages/middleware-compression/src/configurations.ts

@@ -1 +1,3 @@
 export * from "./compressionMiddleware";
+export * from "./configurations";
+export * from "./resolveCompressionConfig";

packages/middleware-compression/src/index.ts

@@ -0,0 +1,39 @@
+import { resolveCompressionConfig } from "./resolveCompressionConfig";
+
+describe(resolveCompressionConfig.name, () => {
+  it("should throw an error if requestMinCompressionSizeBytes is less than 0", () => {
+    const requestMinCompressionSizeBytes = -1;
+    expect(() => {
+      resolveCompressionConfig({ disableRequestCompression: false, requestMinCompressionSizeBytes });
+    }).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", () => {
+    const requestMinCompressionSizeBytes = 10485761;
+    expect(() => {
+      resolveCompressionConfig({ disableRequestCompression: false, requestMinCompressionSizeBytes });
+    }).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 = { disableRequestCompression: false, requestMinCompressionSizeBytes };
+    const resolvedConfig = resolveCompressionConfig(inputConfig);
+    expect(inputConfig).toEqual(resolvedConfig);
+  });
+
+  it.each([false, true])("returns disableRequestCompression value %s", (disableRequestCompression) => {
+    const inputConfig = { disableRequestCompression, requestMinCompressionSizeBytes: 0 };
+    const resolvedConfig = resolveCompressionConfig(inputConfig);
+    expect(inputConfig).toEqual(resolvedConfig);
+  });
+});

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

@@ -0,0 +1,16 @@
+import { CompressionInputConfig, CompressionResolvedConfig } from "./configurations";
+
+export const resolveCompressionConfig = <T>(input: T & CompressionInputConfig): T & CompressionResolvedConfig => {
+  const { requestMinCompressionSizeBytes } = input;
+
+  // 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;
+};