fix(types): code reorganization in client-api-test

Author: kuhe

private/client-api-test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/client-api-test",
-  "description": "",
+  "description": "Test suite for client interface stability",
   "version": "3.0.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",

private/client-api-test/src/client-interface-tests/ClientInterfaceTest.ts

@@ -0,0 +1,24 @@
+/**
+ * Pattern for testing the stability of a Client interface.
+ */
+export interface ClientInterfaceTest<Client> {
+  /**
+   * Assert that some resolved config fields can be set to undefined.
+   */
+  optionalConfigFieldsCanBeVoided(): void;
+  /**
+   * Create a test that initializes a client
+   * with the minimal number of user-supplied values. This is
+   * usually 0.
+   *
+   * This method is also a compilation test.
+   */
+  initializeWithMinimalConfiguration(): Client;
+  /**
+   * Create a test that initializes a client with all config fields supplied
+   * by the user.
+   *
+   * This method is also a compilation test.
+   */
+  initializeWithMaximalConfiguration(): Client;
+}

private/client-api-test/src/client-interface-tests/FIELD_INIT_TYPE.ts

@@ -0,0 +1,5 @@
+/**
+ * The status of a config field after passing through constructor
+ * resolvers.
+ */
+export type FIELD_INIT_TYPE = "resolvedByConfigResolver" | "resolvedOnlyIfProvided" | "neverResolved";

private/client-api-test/src/client-interface-tests/client-s3/ClientS3InterfaceTest.spec.ts

@@ -0,0 +1,41 @@
+import { ClientS3InterfaceTest } from "./ClientS3InterfaceTest";
+import { RESOLVED_FIELDS } from "./RESOLVED_FIELDS";
+
+const Subject = ClientS3InterfaceTest;
+
+describe("Client config interface should be stable", () => {
+  describe(ClientS3InterfaceTest.name, () => {
+    describe("initialization with minimal configuration", () => {
+      const client = new Subject().initializeWithMinimalConfiguration();
+      for (const [configType, fields] of Object.entries(RESOLVED_FIELDS)) {
+        for (const field of fields) {
+          if (configType === "resolvedByConfigResolver") {
+            it(`should resolve the field [${field}] after minimal client init`, () => {
+              expect(client.config[field as keyof typeof client.config]).toBeDefined();
+            });
+          } else {
+            it(`should not resolve the field [${field}] after minimal client init`, () => {
+              expect(client.config[field as keyof typeof client.config]).not.toBeDefined();
+            });
+          }
+        }
+      }
+    });
+    describe("initialization with maximal configuration", () => {
+      const client = new Subject().initializeWithMaximalConfiguration();
+      for (const [configType, fields] of Object.entries(RESOLVED_FIELDS)) {
+        for (const field of fields) {
+          if (configType === "resolvedByConfigResolver" || configType === "resolvedOnlyIfProvided") {
+            it(`should resolve the field [${field}] after maximally configured client init`, () => {
+              expect(client.config[field as keyof typeof client.config]).toBeDefined();
+            });
+          } else {
+            it(`should not resolve the field [${field}] after maximally configured client init`, () => {
+              expect(client.config[field as keyof typeof client.config]).not.toBeDefined();
+            });
+          }
+        }
+      }
+    });
+  });
+});

private/client-api-test/src/client-interface-tests/client-s3/ClientS3InterfaceTest.ts

@@ -0,0 +1,25 @@
+import { S3Client, S3ClientResolvedConfig } from "@aws-sdk/client-s3";
+
+import { ClientInterfaceTest } from "../ClientInterfaceTest";
+import { initializeWithMaximalConfiguration } from "./impl/initializeWithMaximalConfiguration";
+import { initializeWithMinimalConfiguration } from "./impl/initializeWithMinimalConfiguration";
+
+export class ClientS3InterfaceTest implements ClientInterfaceTest<S3Client> {
+  optionalConfigFieldsCanBeVoided(): void {
+    const s3 = new S3Client({});
+    const resolvedConfig: S3ClientResolvedConfig = s3.config;
+    /**
+     * Endpoint is no longer guaranteed as of endpoints 2.0 (rulesets).
+     * @see https://github.com/aws/aws-sdk-js-v3/issues/4122
+     */
+    resolvedConfig.endpoint = void 0;
+    resolvedConfig.isCustomEndpoint = void 0;
+    resolvedConfig.customUserAgent = void 0;
+  }
+  initializeWithMinimalConfiguration(): S3Client {
+    return initializeWithMinimalConfiguration();
+  }
+  initializeWithMaximalConfiguration(): S3Client {
+    return initializeWithMaximalConfiguration();
+  }
+}

private/client-api-test/src/client-interface-tests/client-s3/RESOLVED_FIELDS.ts

@@ -0,0 +1,53 @@
+import { S3ClientResolvedConfig } from "@aws-sdk/client-s3";
+
+import { FIELD_INIT_TYPE } from "../FIELD_INIT_TYPE";
+
+export const RESOLVED_FIELDS: Record<FIELD_INIT_TYPE, (keyof S3ClientResolvedConfig)[]> = {
+  resolvedByConfigResolver: [
+    "requestHandler",
+    "apiVersion",
+    "sha256",
+    "urlParser",
+    "bodyLengthChecker",
+    "streamCollector",
+    "base64Decoder",
+    "base64Encoder",
+    "utf8Decoder",
+    "utf8Encoder",
+    "runtime",
+    "disableHostPrefix",
+    "maxAttempts",
+    "retryMode",
+    "logger",
+    "useDualstackEndpoint",
+    "useFipsEndpoint",
+    "serviceId",
+    "region",
+    "credentialDefaultProvider",
+    "signingEscapePath",
+    "useArnRegion",
+    "defaultUserAgentProvider",
+    "streamHasher",
+    "md5",
+    "sha1",
+    "getAwsChunkedEncodingStream",
+    "eventStreamSerdeProvider",
+    "defaultsMode",
+    "sdkStreamMixin",
+    "endpointProvider",
+    "tls",
+    "isCustomEndpoint",
+    "retryStrategy",
+    "credentials",
+    "signer",
+    "systemClockOffset",
+    "forcePathStyle",
+    "useAccelerateEndpoint",
+    "disableMultiregionAccessPoints",
+    "eventStreamMarshaller",
+    "defaultSigningName",
+    "useGlobalEndpoint",
+  ],
+  resolvedOnlyIfProvided: ["customUserAgent", "endpoint"],
+  neverResolved: [],
+};

private/client-api-test/src/client-s3-interface.ts renamed to private/client-api-test/src/client-interface-tests/client-s3/impl/initializeWithMaximalConfiguration.ts

@@ -1,4 +1,4 @@
-import { S3Client, S3ClientResolvedConfig } from "@aws-sdk/client-s3";
+import { S3Client } from "@aws-sdk/client-s3";
 import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
 import {
   NODE_REGION_CONFIG_FILE_OPTIONS,
@@ -29,30 +29,6 @@ import { getAwsChunkedEncodingStream, sdkStreamMixin } from "@aws-sdk/util-strea
 import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
 import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
 
-/**
- * This function compiling indicates the expected
- * optional fields can be reassigned to void.
- */
-export const optionalConfigFieldsCanBeVoided = () => {
-  const s3 = new S3Client({});
-  const resolvedConfig: S3ClientResolvedConfig = s3.config;
-  /**
-   * Endpoint is no longer guaranteed as of endpoints 2.0 (rulesets).
-   * @see https://github.com/aws/aws-sdk-js-v3/issues/4122
-   */
-  resolvedConfig.endpoint = void 0;
-  resolvedConfig.isCustomEndpoint = void 0;
-  resolvedConfig.customUserAgent = void 0;
-};
-
-/**
- * Successful compilation indicates the client can be initialized
- * with minimal configuration.
- */
-export const initializeWithMinimalConfiguration = () => {
-  return new S3Client({});
-};
-
 /**
  * Successful compilation indicates the client can be initialized
  * with maximal configuration.

private/client-api-test/src/client-interface-tests/client-s3/impl/initializeWithMinimalConfiguration.ts

@@ -0,0 +1,9 @@
+import { S3Client } from "@aws-sdk/client-s3";
+
+/**
+ * Successful compilation indicates the client can be initialized
+ * with minimal configuration.
+ */
+export const initializeWithMinimalConfiguration = () => {
+  return new S3Client({});
+};