fix(token-providers): use static version of bundled sso oidc client (#5067)

Author: kuhe

packages/token-providers/README.md

@@ -10,7 +10,7 @@ type is going to be token based. For example, the `bearer` authorization type se
 ## Static Token Provider
 
 ```ts
-import { fromStatic } from "@aws-sdk/token-providers"
+import { fromStatic } from "@aws-sdk/token-providers";
 
 const token = { token: "TOKEN" };
 const staticTokenProvider = fromStatic(token);
@@ -21,7 +21,7 @@ const staticToken = await staticTokenProvider(); // returns { token: "TOKEN" }
 ## SSO Token Provider
 
 ```ts
-import { fromSso } from "@aws-sdk/token-providers"
+import { fromSso } from "@aws-sdk/token-providers";
 
 // returns token from SSO token cache or ssoOidc.createToken() call.
 const ssoToken = await fromSso();
@@ -30,10 +30,24 @@ const ssoToken = await fromSso();
 ## Token Provider Chain
 
 ```ts
-import { nodeProvider } from "@aws-sdk/token-providers"
+import { nodeProvider } from "@aws-sdk/token-providers";
 
 // returns token from default providers.
 const token = await nodeProvider();
 ```
 
 [http-bearer-auth-trait]: https://smithy.io/2.0/spec/authentication-traits.html#smithy-api-httpbearerauth-trait
+
+---
+
+### Development
+
+This package contains a minimal copy of the SSO OIDC client, instead of relying on the full client, which
+would cause a circular dependency.
+
+When regenerating the bundled version of the SSO OIDC client, run the esbuild.js script and then make the following changes:
+
+- Remove any dependency of the generated client on the credential chain such that it would create
+  a circular dependency back to this package. Because we only need the `CreateTokenCommand`, the client, and this command's
+  associated `Exception`s, it is possible to remove auth dependencies.
+- Ensure all required packages are declared in the `package.json` of token-providers.

packages/token-providers/package.json

@@ -6,8 +6,8 @@
   "module": "./dist-es/index.js",
   "sideEffects": false,
   "scripts": {
-    "build:client-dist": "node ./scripts/esbuild",
-    "build": "yarn build:client-dist && concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build:client-bundle": "node ./scripts/esbuild",
+    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
@@ -27,11 +27,41 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "@aws-crypto/sha256-browser": "3.0.0",
+    "@aws-crypto/sha256-js": "3.0.0",
+    "@aws-sdk/middleware-host-header": "*",
+    "@aws-sdk/middleware-logger": "*",
+    "@aws-sdk/middleware-recursion-detection": "*",
+    "@aws-sdk/middleware-user-agent": "*",
     "@aws-sdk/types": "*",
-    "@smithy/property-provider": "^2.0.0",
-    "@smithy/shared-ini-file-loader": "^2.0.0",
+    "@aws-sdk/util-endpoints": "*",
+    "@aws-sdk/util-user-agent-browser": "*",
+    "@aws-sdk/util-user-agent-node": "*",
+    "@smithy/config-resolver": "^2.0.2",
+    "@smithy/fetch-http-handler": "^2.0.2",
+    "@smithy/hash-node": "^2.0.2",
+    "@smithy/invalid-dependency": "^2.0.2",
+    "@smithy/middleware-content-length": "^2.0.2",
+    "@smithy/middleware-endpoint": "^2.0.2",
+    "@smithy/middleware-retry": "^2.0.2",
+    "@smithy/middleware-serde": "^2.0.2",
+    "@smithy/middleware-stack": "^2.0.0",
+    "@smithy/node-config-provider": "^2.0.2",
+    "@smithy/node-http-handler": "^2.0.2",
+    "@smithy/protocol-http": "^2.0.2",
+    "@smithy/smithy-client": "^2.0.2",
     "@smithy/types": "^2.1.0",
-    "tslib": "^2.5.0"
+    "@smithy/url-parser": "^2.0.2",
+    "@smithy/util-base64": "^2.0.0",
+    "@smithy/util-body-length-browser": "^2.0.0",
+    "@smithy/util-body-length-node": "^2.0.0",
+    "@smithy/util-defaults-mode-browser": "^2.0.2",
+    "@smithy/util-defaults-mode-node": "^2.0.2",
+    "@smithy/util-retry": "^2.0.0",
+    "@smithy/util-utf8": "^2.0.0",
+    "tslib": "^2.5.0",
+    "@smithy/property-provider": "^2.0.0",
+    "@smithy/shared-ini-file-loader": "^2.0.0"
   },
   "devDependencies": {
     "@tsconfig/recommended": "1.0.1",
@@ -57,10 +87,10 @@
     "dist-*/**"
   ],
   "browser": {
-    "./dist-es/client-sso-oidc-bundle/dist-node": "./dist-es/client-sso-oidc-bundle/dist-browser"
+    "./dist-es/bundle/client-sso-oidc-node": "./dist-es/bundle/client-sso-oidc-browser"
   },
   "react-native": {
-    "./dist-es/client-sso-oidc-bundle/dist-node": "./dist-es/client-sso-oidc-bundle/dist-browser"
+    "./dist-es/bundle/client-sso-oidc-node": "./dist-es/bundle/client-sso-oidc-browser"
   },
   "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/token-providers",
   "repository": {

packages/token-providers/scripts/esbuild.js

@@ -21,6 +21,14 @@ const root = path.join(__dirname, "..", "..", "..");
   const browserRuntimeConfig = fs.readFileSync(
     path.join(path.dirname(defaultRuntimeConfigFile), "runtimeConfig.browser.ts")
   );
+  const clientPkgJsonPath = path.join(root, "clients", "client-sso-oidc", "package.json");
+  const clientPkgJson = require(clientPkgJsonPath);
+  fs.writeFileSync(
+    clientPkgJsonPath,
+    JSON.stringify({
+      version: clientPkgJson.version,
+    })
+  );
 
   for (const platform of ["browser", "node"]) {
     if (platform === "browser") {
@@ -29,14 +37,7 @@ const root = path.join(__dirname, "..", "..", "..");
       fs.writeFileSync(defaultRuntimeConfigFile, nodeRuntimeConfig);
     }
 
-    const outfile = path.join(
-      root,
-      "packages",
-      "token-providers",
-      "src",
-      "client-sso-oidc-bundle",
-      `dist-${platform}.ts`
-    );
+    const outfile = path.join(root, "packages", "token-providers", "src", "bundle", `client-sso-oidc-${platform}.ts`);
 
     await esbuild.build({
       platform,
@@ -54,4 +55,5 @@ const root = path.join(__dirname, "..", "..", "..");
   }
 
   fs.writeFileSync(defaultRuntimeConfigFile, nodeRuntimeConfig);
+  fs.writeFileSync(clientPkgJsonPath, JSON.stringify(clientPkgJson, null, 2) + "\n");
 })();