chore: add pkg api shape validation

Author: kuhe

clients/client-scheduler/package.json

@@ -11,7 +11,9 @@
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "extract:docs": "api-extractor run --local",
-    "generate:client": "node ../../scripts/generate-clients/single-service --solo scheduler"
+    "generate:client": "node ../../scripts/generate-clients/single-service --solo scheduler",
+    "test:e2e": "yarn g:vitest run -c vitest.config.e2e.mts",
+    "test:e2e:watch": "yarn g:vitest watch -c vitest.config.e2e.mts"
   },
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",

clients/client-scheduler/test/Scheduler.e2e.spec.ts

@@ -0,0 +1,49 @@
+import { DeleteScheduleInput } from "@aws-sdk/client-scheduler/src/schemas/schemas_0";
+import { AwsRestJsonProtocol } from "@aws-sdk/core";
+import { ToStringShapeSerializer } from "@smithy/core/protocols";
+import { TimestampEpochSecondsSchema } from "@smithy/types";
+import { describe, expect, test as it } from "vitest";
+
+describe(
+  "Scheduler",
+  {
+    timeout: 120_000,
+    retry: 4,
+  },
+  () => {
+    it("should serialize default idempotency token (shape serializer)", async () => {
+      const restJson = new AwsRestJsonProtocol({ defaultNamespace: "com.amazonaws.scheduler" });
+      const codec = restJson.getPayloadCodec();
+
+      const serializer = codec.createSerializer();
+
+      const input = {
+        Name: "MyScheduleName",
+      };
+
+      serializer.write(DeleteScheduleInput, input);
+      const serialization = serializer.flush();
+
+      expect(serialization).toContain("ClientToken");
+    });
+
+    it("should serializer default idempotency token (query serialization)", async () => {
+      const serializer = new ToStringShapeSerializer({
+        httpBindings: true,
+        timestampFormat: {
+          default: 7 as const satisfies TimestampEpochSecondsSchema,
+          useTrait: true,
+        },
+      });
+
+      const input = {
+        Name: "MyScheduleName",
+      };
+
+      serializer.write(DeleteScheduleInput, input);
+      const serialization = serializer.flush();
+
+      expect(serialization).toContain("ClientToken");
+    });
+  }
+);

clients/client-scheduler/vitest.config.e2e.mts

@@ -0,0 +1,10 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    exclude: ["**/*.browser.e2e.spec.ts"],
+    include: ["**/*.e2e.spec.ts"],
+    environment: "node",
+  },
+  mode: "development",
+});

scripts/validation/api-snapshot-validation.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+/**
+This script uses the JSON file api-snapshot/api.json to validate that previously present symbols
+are still exported by the packages within the assessed group.
+
+Data may only be deleted from api.json in an intentional backwards-incompatible change.
+ */
+
+const fs = require("node:fs");
+const path = require("node:path");
+
+const root = path.join(__dirname, "..", "..");
+const dataPath = path.join(root, "scripts", "validation", "api.json");
+const api = require(dataPath);
+
+api.$schema = "https://json-schema.org/draft/2020-12/schema";
+
+const packageDirs = [
+  ...fs.readdirSync(path.join(root, "packages")).map((f) => path.join(root, "packages", f)),
+  ...fs.readdirSync(path.join(root, "lib")).map((f) => path.join(root, "lib", f)),
+  path.join(root, "clients", "client-s3"), // rest xml
+  path.join(root, "clients", "client-s3-control"), // rest xml
+  path.join(root, "clients", "client-dynamodb"), // json rpc
+  path.join(root, "clients", "client-cloudwatch"), // query
+  path.join(root, "clients", "client-sts"), // query
+  path.join(root, "clients", "client-sagemaker"), // json rpc
+  path.join(root, "clients", "client-bedrock"), // rest json
+];
+const errors = [];
+
+for (const packageRoot of packageDirs) {
+  const pkgJsonPath = path.join(packageRoot, "package.json");
+  const cjsPath = path.join(packageRoot, "dist-cjs", "index.js");
+
+  if (fs.existsSync(pkgJsonPath) && fs.existsSync(cjsPath)) {
+    const packageJson = require(pkgJsonPath);
+    const { name, version } = packageJson;
+    const module = require(cjsPath);
+
+    for (const key of Object.keys(module)) {
+      if (module[key] === undefined) {
+        console.warn(`symbol ${key} in ${name}@${version} has a value of undefined.`);
+      }
+    }
+
+    if (!api[name]) {
+      api[name] = {};
+      for (const key of Object.keys(module)) {
+        api[name][key] = [typeof module[key], `<=${version}`].join(", since ");
+      }
+    } else {
+      for (const symbol of [...new Set([...Object.keys(api[name]), ...Object.keys(module)])]) {
+        if (symbol in module && !(symbol in api[name])) {
+          errors.push(`You must commit changes in api.json.`);
+          api[name][symbol] = [typeof module[symbol], version].join(", since ");
+        }
+        if (!(symbol in module) && symbol in api[name]) {
+          errors.push(`Symbol [${symbol}] is missing from ${name}, (${api[name][symbol]}).`);
+        }
+        if (symbol in module && symbol in api[name]) {
+          if (api[name][symbol].split(", ")[0] !== typeof module[symbol]) {
+            errors.push(
+              `Symbol [${symbol}] has a different type than expected in ${name}, actual=${typeof module[
+                symbol
+              ]} expected=${api[name][symbol]}.`
+            );
+          }
+        }
+      }
+    }
+  }
+}
+
+fs.writeFileSync(dataPath, JSON.stringify(api, null, 2));
+
+if (errors.length) {
+  throw new Error(errors.join("\n"));
+} else {
+  console.log(`✅ API snapshot test passed.`);
+}