chore: feature detection for gzip and endpoint override

.changeset/silent-rockets-turn.md

@@ -0,0 +1,7 @@
+---
+"@smithy/middleware-compression": minor
+"@smithy/middleware-endpoint": minor
+"@smithy/core": minor
+---
+
+feature detection for custom endpoint and gzip

.changeset/unlucky-books-think.md

@@ -0,0 +1,8 @@
+---
+"@smithy/middleware-compression": patch
+"@smithy/middleware-endpoint": patch
+"@smithy/smithy-client": patch
+"@smithy/core": patch
+---
+
+reorganize smithy/core to be upstream of smithy/smithy-client

packages/core/package.json

@@ -46,14 +46,12 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@smithy/middleware-endpoint": "workspace:^",
-    "@smithy/middleware-retry": "workspace:^",
     "@smithy/middleware-serde": "workspace:^",
     "@smithy/protocol-http": "workspace:^",
-    "@smithy/smithy-client": "workspace:^",
     "@smithy/types": "workspace:^",
     "@smithy/util-body-length-browser": "workspace:^",
     "@smithy/util-middleware": "workspace:^",
+    "@smithy/util-stream": "workspace:^",
     "@smithy/util-utf8": "workspace:^",
     "tslib": "^2.6.2"
   },

packages/core/src/index.ts

@@ -1,7 +1,11 @@
+export * from "./getSmithyContext";
 export * from "./middleware-http-auth-scheme";
 export * from "./middleware-http-signing";
-export * from "./util-identity-and-auth";
-export * from "./getSmithyContext";
 export * from "./normalizeProvider";
-export * from "./protocols/requestBuilder";
 export { createPaginator } from "./pagination/createPaginator";
+export * from "./protocols/collect-stream-body";
+export * from "./protocols/requestBuilder";
+export * from "./protocols/resolve-path";
+export * from "./protocols/extended-encode-uri-component";
+export * from "./setFeature";
+export * from "./util-identity-and-auth";

packages/core/src/middleware-http-auth-scheme/getHttpAuthSchemeEndpointRuleSetPlugin.ts

@@ -1,4 +1,3 @@
-import { endpointMiddlewareOptions } from "@smithy/middleware-endpoint";
 import {
   HandlerExecutionContext,
   HttpAuthSchemeParameters,
@@ -20,7 +19,7 @@ export const httpAuthSchemeEndpointRuleSetMiddlewareOptions: SerializeHandlerOpt
   name: "httpAuthSchemeMiddleware",
   override: true,
   relation: "before",
-  toMiddleware: endpointMiddlewareOptions.name!,
+  toMiddleware: "endpointV2Middleware",
 };
 
 /**

packages/core/src/middleware-http-signing/getHttpSigningMiddleware.ts

@@ -1,4 +1,3 @@
-import { retryMiddlewareOptions } from "@smithy/middleware-retry";
 import { FinalizeRequestHandlerOptions, Pluggable, RelativeMiddlewareOptions } from "@smithy/types";
 
 import { httpSigningMiddleware } from "./httpSigningMiddleware";
@@ -13,7 +12,7 @@ export const httpSigningMiddlewareOptions: FinalizeRequestHandlerOptions & Relat
   aliases: ["apiKeyMiddleware", "tokenMiddleware", "awsAuthMiddleware"],
   override: true,
   relation: "after",
-  toMiddleware: retryMiddlewareOptions.name!,
+  toMiddleware: "retryMiddleware",
 };
 
 /**

packages/core/src/protocols/collect-stream-body.ts

@@ -0,0 +1,26 @@
+import { SerdeContext } from "@smithy/types";
+import { Uint8ArrayBlobAdapter } from "@smithy/util-stream";
+
+/**
+ * @internal
+ *
+ * Collect low-level response body stream to Uint8Array.
+ */
+export const collectBody = async (
+  streamBody: any = new Uint8Array(),
+  context: {
+    streamCollector: SerdeContext["streamCollector"];
+  }
+): Promise<Uint8ArrayBlobAdapter> => {
+  if (streamBody instanceof Uint8Array) {
+    return Uint8ArrayBlobAdapter.mutate(streamBody);
+  }
+
+  if (!streamBody) {
+    return Uint8ArrayBlobAdapter.mutate(new Uint8Array());
+  }
+
+  const fromContext = context.streamCollector(streamBody);
+
+  return Uint8ArrayBlobAdapter.mutate(await fromContext);
+};

packages/core/src/protocols/extended-encode-uri-component.ts

@@ -0,0 +1,11 @@
+/**
+ * @internal
+ *
+ * Function that wraps encodeURIComponent to encode additional characters
+ * to fully adhere to RFC 3986.
+ */
+export function extendedEncodeURIComponent(str: string): string {
+  return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
+    return "%" + c.charCodeAt(0).toString(16).toUpperCase();
+  });
+}

packages/core/src/protocols/requestBuilder.ts

@@ -1,7 +1,8 @@
 import { HttpRequest } from "@smithy/protocol-http";
-import { resolvedPath } from "@smithy/smithy-client";
 import type { SerdeContext } from "@smithy/types";
 
+import { resolvedPath } from "./resolve-path";
+
 /**
  * @internal
  * used in code-generated serde.

packages/core/src/protocols/resolve-path.ts

@@ -0,0 +1,32 @@
+import { extendedEncodeURIComponent } from "./extended-encode-uri-component";
+
+/**
+ * @internal
+ */
+export const resolvedPath = (
+  resolvedPath: string,
+  input: unknown,
+  memberName: string,
+  labelValueProvider: () => string | undefined,
+  uriLabel: string,
+  isGreedyLabel: boolean
+): string => {
+  if (input != null && (input as Record<string, unknown>)[memberName] !== undefined) {
+    const labelValue = labelValueProvider() as string;
+    if (labelValue.length <= 0) {
+      throw new Error("Empty value provided for input HTTP label: " + memberName + ".");
+    }
+    resolvedPath = resolvedPath.replace(
+      uriLabel,
+      isGreedyLabel
+        ? labelValue
+            .split("/")
+            .map((segment) => extendedEncodeURIComponent(segment))
+            .join("/")
+        : extendedEncodeURIComponent(labelValue)
+    );
+  } else {
+    throw new Error("No value provided for input HTTP label: " + memberName + ".");
+  }
+  return resolvedPath;
+};

packages/core/src/submodules/cbor/parseCborBody.ts

@@ -1,5 +1,5 @@
+import { collectBody } from "@smithy/core";
 import { HttpRequest as __HttpRequest } from "@smithy/protocol-http";
-import { collectBody } from "@smithy/smithy-client";
 import { HeaderBag as __HeaderBag, HttpResponse, SerdeContext as __SerdeContext, SerdeContext } from "@smithy/types";
 import { calculateBodyLength } from "@smithy/util-body-length-browser";
 

packages/middleware-compression/package.json

@@ -15,6 +15,7 @@
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "dependencies": {
+    "@smithy/core": "workspace:^",
     "@smithy/is-array-buffer": "workspace:^",
     "@smithy/node-config-provider": "workspace:^",
     "@smithy/protocol-http": "workspace:^",

packages/middleware-compression/src/compressionMiddleware.ts

@@ -1,3 +1,4 @@
+import { setFeature } from "@smithy/core";
 import { HttpRequest } from "@smithy/protocol-http";
 import {
   AbsoluteLocation,
@@ -6,6 +7,7 @@ import {
   BuildHandlerOptions,
   BuildHandlerOutput,
   BuildMiddleware,
+  HandlerExecutionContext,
   MetadataBearer,
 } from "@smithy/types";
 
@@ -39,7 +41,10 @@ export const compressionMiddleware =
     config: CompressionResolvedConfig & CompressionPreviouslyResolved,
     middlewareConfig: CompressionMiddlewareConfig
   ): BuildMiddleware<any, any> =>
-  <Output extends MetadataBearer>(next: BuildHandler<any, Output>): BuildHandler<any, Output> =>
+  <Output extends MetadataBearer>(
+    next: BuildHandler<any, Output>,
+    context: HandlerExecutionContext
+  ): BuildHandler<any, Output> =>
   async (args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<Output>> => {
     if (!HttpRequest.isInstance(args.request)) {
       return next(args);
@@ -88,6 +93,10 @@ export const compressionMiddleware =
             updatedHeaders = { ...headers, "content-encoding": algorithm };
           }
 
+          if (headers["content-encoding"].includes("gzip")) {
+            setFeature(context, "GZIP_REQUEST_COMPRESSION", "L");
+          }
+
           // We've matched on one supported algorithm in the
           // priority-ordered list, so we're finished.
           break;

packages/middleware-endpoint/package.json

@@ -23,6 +23,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "@smithy/core": "workspace:^",
     "@smithy/middleware-serde": "workspace:^",
     "@smithy/node-config-provider": "workspace:^",
     "@smithy/shared-ini-file-loader": "workspace:^",

packages/middleware-endpoint/src/endpointMiddleware.ts

@@ -1,3 +1,4 @@
+import { setFeature } from "@smithy/core";
 import {
   AuthScheme,
   EndpointParameters,
@@ -38,6 +39,10 @@ export const endpointMiddleware = <T extends EndpointParameters>({
       context: HandlerExecutionContext
     ): SerializeHandler<any, Output> =>
     async (args: SerializeHandlerArguments<any>): Promise<SerializeHandlerOutput<Output>> => {
+      if (config.endpoint) {
+        setFeature(context, "ENDPOINT_OVERRIDE", "N");
+      }
+
       const endpoint: EndpointV2 = await getEndpointFromInstructions(
         args.input,
         {

packages/smithy-client/package.json

@@ -23,6 +23,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "@smithy/core": "workspace:^",
     "@smithy/middleware-endpoint": "workspace:^",
     "@smithy/middleware-stack": "workspace:^",
     "@smithy/protocol-http": "workspace:^",

packages/smithy-client/src/collect-stream-body.ts

@@ -1,26 +1,5 @@
-import { SerdeContext } from "@smithy/types";
-import { Uint8ArrayBlobAdapter } from "@smithy/util-stream";
-
 /**
  * @internal
- *
- * Collect low-level response body stream to Uint8Array.
+ * Backwards compatibility re-export.
  */
-export const collectBody = async (
-  streamBody: any = new Uint8Array(),
-  context: {
-    streamCollector: SerdeContext["streamCollector"];
-  }
-): Promise<Uint8ArrayBlobAdapter> => {
-  if (streamBody instanceof Uint8Array) {
-    return Uint8ArrayBlobAdapter.mutate(streamBody);
-  }
-
-  if (!streamBody) {
-    return Uint8ArrayBlobAdapter.mutate(new Uint8Array());
-  }
-
-  const fromContext = context.streamCollector(streamBody);
-
-  return Uint8ArrayBlobAdapter.mutate(await fromContext);
-};
+export { collectBody } from "@smithy/core";

packages/smithy-client/src/extended-encode-uri-component.ts

@@ -1,11 +1,5 @@
 /**
  * @internal
- *
- * Function that wraps encodeURIComponent to encode additional characters
- * to fully adhere to RFC 3986.
+ * Backwards compatibility re-export.
  */
-export function extendedEncodeURIComponent(str: string): string {
-  return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
-    return "%" + c.charCodeAt(0).toString(16).toUpperCase();
-  });
-}
+export { extendedEncodeURIComponent } from "@smithy/core";

packages/smithy-client/src/resolve-path.ts

@@ -1,32 +1,5 @@
-import { extendedEncodeURIComponent } from "./extended-encode-uri-component";
-
 /**
  * @internal
+ * Backwards compatibility re-export.
  */
-export const resolvedPath = (
-  resolvedPath: string,
-  input: unknown,
-  memberName: string,
-  labelValueProvider: () => string | undefined,
-  uriLabel: string,
-  isGreedyLabel: boolean
-): string => {
-  if (input != null && (input as Record<string, unknown>)[memberName] !== undefined) {
-    const labelValue = labelValueProvider() as string;
-    if (labelValue.length <= 0) {
-      throw new Error("Empty value provided for input HTTP label: " + memberName + ".");
-    }
-    resolvedPath = resolvedPath.replace(
-      uriLabel,
-      isGreedyLabel
-        ? labelValue
-            .split("/")
-            .map((segment) => extendedEncodeURIComponent(segment))
-            .join("/")
-        : extendedEncodeURIComponent(labelValue)
-    );
-  } else {
-    throw new Error("No value provided for input HTTP label: " + memberName + ".");
-  }
-  return resolvedPath;
-};
+export { resolvedPath } from "@smithy/core";