feat(credential-providers): deferred loading for credential providers aggregation package (#8129)

Author: kuhe

packages-internal/credential-provider-ini/src/resolveLoginCredentials.ts

@@ -1,5 +1,4 @@
 import { setCredentialFeature } from "@aws-sdk/core/client";
-import { fromLoginCredentials } from "@aws-sdk/credential-provider-login";
 import type { AwsIdentityProperties } from "@aws-sdk/types";
 import type { AwsCredentialIdentity, ParsedIniData } from "@smithy/types";
 
@@ -20,6 +19,7 @@ export const resolveLoginCredentials = async (
   options: FromIniInit,
   callerClientConfig?: AwsIdentityProperties["callerClientConfig"]
 ): Promise<AwsCredentialIdentity> => {
+  const { fromLoginCredentials } = await import("@aws-sdk/credential-provider-login");
   const credentials = await fromLoginCredentials({
     ...options,
     profile: profileName,

packages-internal/credential-provider-sso/src/fromSSO.ts

@@ -12,7 +12,7 @@ import { resolveSSOCredentials } from "./resolveSSOCredentials";
 import { validateSsoProfile } from "./validateSsoProfile";
 
 /**
- * @internal
+ * @public
  */
 export interface SsoCredentialsParameters {
   /**
@@ -43,7 +43,7 @@ export interface SsoCredentialsParameters {
 }
 
 /**
- * @internal
+ * @public
  */
 export interface FromSSOInit extends SourceProfileInit, CredentialProviderOptions {
   ssoClient?: SSOClient;
@@ -52,8 +52,6 @@ export interface FromSSOInit extends SourceProfileInit, CredentialProviderOption
 }
 
 /**
- * @internal
- *
  * Creates a credential provider that will read from a credential_process specified
  * in ini files.
  *
@@ -81,6 +79,8 @@ export interface FromSSOInit extends SourceProfileInit, CredentialProviderOption
  * sso_region = us-east-1
  * sso_start_url = https://www.....com/start
  * ```
+ *
+ * @internal
  */
 export const fromSSO =
   (init: FromSSOInit & Partial<SsoCredentialsParameters> = {}): RuntimeConfigAwsCredentialIdentityProvider =>

packages-internal/types/src/identity/AwsCredentialIdentity.ts

@@ -33,33 +33,32 @@ export interface AwsIdentityProperties {
 }
 
 /**
- * @public
- *
  * Variation of {@link IdentityProvider} which accepts a contextual
  * client configuration that includes an AWS region and potentially other
  * configurable fields.
  *
  * Used to link a credential provider to a client if it is being called
  * in the context of a client.
+ *
+ * @public
  */
 export type RuntimeConfigIdentityProvider<T> = (awsIdentityProperties?: AwsIdentityProperties) => Promise<T>;
 
 /**
- * @public
- *
  * Variation of {@link AwsCredentialIdentityProvider} which accepts a contextual
  * client configuration that includes an AWS region and potentially other
  * configurable fields.
  *
  * Used to link a credential provider to a client if it is being called
  * in the context of a client.
+ *
+ * @public
  */
 export type RuntimeConfigAwsCredentialIdentityProvider = RuntimeConfigIdentityProvider<AwsCredentialIdentity>;
 
 /**
- * @public
- *
  * AwsCredentialIdentity with source attribution metadata.
+ * @public
  */
 export type AttributedAwsCredentialIdentity = AwsCredentialIdentity & {
   $source?: AwsSdkCredentialsFeatures;

packages/credential-providers/package.json

@@ -37,7 +37,6 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/client-cognito-identity": "workspace:3.1081.0",
     "@aws-sdk/core": "workspace:^3.974.29",
     "@aws-sdk/credential-provider-cognito-identity": "workspace:^3.972.54",
     "@aws-sdk/credential-provider-env": "workspace:^3.972.55",

packages/credential-providers/src/fromCognitoIdentity.spec.ts

@@ -10,7 +10,7 @@ vi.mock("@aws-sdk/client-cognito-identity", () => ({
 }));
 
 vi.mock("@aws-sdk/credential-provider-cognito-identity", () => ({
-  fromCognitoIdentity: vi.fn(),
+  fromCognitoIdentity: vi.fn().mockReturnValue(vi.fn()),
 }));
 
 describe("fromCognitoIdentity", () => {
@@ -20,10 +20,11 @@ describe("fromCognitoIdentity", () => {
     vi.clearAllMocks();
   });
 
-  it("defers to @aws-sdk/credential-provider-cognito-identity", () => {
-    fromCognitoIdentity({
+  it("defers to @aws-sdk/credential-provider-cognito-identity", async () => {
+    const provider = fromCognitoIdentity({
       identityId,
     });
+    await provider({});
     expect(coreProvider).toHaveBeenCalledWith({
       identityId,
     });

packages/credential-providers/src/fromCognitoIdentity.ts

@@ -1,19 +1,13 @@
-import type { CognitoIdentityClientConfig } from "@aws-sdk/client-cognito-identity";
 import type {
   CognitoIdentityCredentialProvider as _CognitoIdentityCredentialProvider,
   FromCognitoIdentityParameters as _FromCognitoIdentityParameters,
 } from "@aws-sdk/credential-provider-cognito-identity";
-import { fromCognitoIdentity as _fromCognitoIdentity } from "@aws-sdk/credential-provider-cognito-identity";
+import type { AwsIdentityProperties } from "@aws-sdk/types";
 
 /**
  * @public
  */
-export interface FromCognitoIdentityParameters extends Omit<_FromCognitoIdentityParameters, "client"> {
-  /**
-   * Custom client configuration if you need overwrite default Cognito Identity client configuration.
-   */
-  clientConfig?: CognitoIdentityClientConfig;
-}
+export interface FromCognitoIdentityParameters extends Omit<_FromCognitoIdentityParameters, "client"> {}
 
 export type CognitoIdentityCredentialProvider = _CognitoIdentityCredentialProvider;
 
@@ -54,7 +48,9 @@ export type CognitoIdentityCredentialProvider = _CognitoIdentityCredentialProvid
  *
  * @public
  */
-export const fromCognitoIdentity = (options: FromCognitoIdentityParameters): CognitoIdentityCredentialProvider =>
-  _fromCognitoIdentity({
-    ...options,
-  });
+export const fromCognitoIdentity = (options: FromCognitoIdentityParameters): CognitoIdentityCredentialProvider => {
+  return async (args?: AwsIdentityProperties) => {
+    const { fromCognitoIdentity: _fromCognitoIdentity } = await import("@aws-sdk/credential-provider-cognito-identity");
+    return _fromCognitoIdentity(options)(args);
+  };
+};

packages/credential-providers/src/fromCognitoIdentityPool.spec.ts

@@ -10,7 +10,7 @@ vi.mock("@aws-sdk/client-cognito-identity", () => ({
 }));
 
 vi.mock("@aws-sdk/credential-provider-cognito-identity", () => ({
-  fromCognitoIdentityPool: vi.fn(),
+  fromCognitoIdentityPool: vi.fn().mockReturnValue(vi.fn()),
 }));
 
 describe("fromCognitoIdentityPool", () => {
@@ -20,10 +20,11 @@ describe("fromCognitoIdentityPool", () => {
     vi.clearAllMocks();
   });
 
-  it("defers to @aws-sdk/credential-provider-cognito-identity", () => {
-    fromCognitoIdentityPool({
+  it("defers to @aws-sdk/credential-provider-cognito-identity", async () => {
+    const provider = fromCognitoIdentityPool({
       identityPoolId,
     });
+    await provider({});
     expect(coreProvider).toHaveBeenCalledWith({
       identityPoolId,
     });

packages/credential-providers/src/fromCognitoIdentityPool.ts

@@ -1,13 +1,13 @@
-import type { CognitoIdentityClientConfig } from "@aws-sdk/client-cognito-identity";
 import type {
   CognitoIdentityCredentialProvider,
   FromCognitoIdentityPoolParameters as _FromCognitoIdentityPoolParameters,
 } from "@aws-sdk/credential-provider-cognito-identity";
-import { fromCognitoIdentityPool as _fromCognitoIdentityPool } from "@aws-sdk/credential-provider-cognito-identity";
+import type { AwsIdentityProperties } from "@aws-sdk/types";
 
-export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIdentityPoolParameters, "client"> {
-  clientConfig?: CognitoIdentityClientConfig;
-}
+/**
+ * @public
+ */
+export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIdentityPoolParameters, "client"> {}
 
 /**
  * Creates a credential provider function that retrieves or generates a unique identifier using Amazon Cognito's `GetId`
@@ -53,7 +53,11 @@ export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIden
  */
 export const fromCognitoIdentityPool = (
   options: FromCognitoIdentityPoolParameters
-): CognitoIdentityCredentialProvider =>
-  _fromCognitoIdentityPool({
-    ...options,
-  });
+): CognitoIdentityCredentialProvider => {
+  return async (args?: AwsIdentityProperties) => {
+    const { fromCognitoIdentityPool: _fromCognitoIdentityPool } = await import(
+      "@aws-sdk/credential-provider-cognito-identity"
+    );
+    return _fromCognitoIdentityPool(options)(args);
+  };
+};

packages/credential-providers/src/fromContainerMetadata.ts

@@ -1,6 +1,5 @@
-import type { CredentialProviderOptions } from "@aws-sdk/types";
+import type { AwsIdentityProperties, CredentialProviderOptions } from "@aws-sdk/types";
 import type { RemoteProviderInit as _RemoteProviderInit } from "@smithy/credential-provider-imds";
-import { fromContainerMetadata as _fromContainerMetadata } from "@smithy/credential-provider-imds";
 import type { AwsCredentialIdentityProvider } from "@smithy/types";
 
 export interface RemoteProviderInit extends _RemoteProviderInit, CredentialProviderOptions {}
@@ -27,6 +26,9 @@ export interface RemoteProviderInit extends _RemoteProviderInit, CredentialProvi
  * @public
  */
 export const fromContainerMetadata = (init?: RemoteProviderInit): AwsCredentialIdentityProvider => {
-  init?.logger?.debug("@smithy/credential-provider-imds", "fromContainerMetadata");
-  return _fromContainerMetadata(init);
+  return async (props?: AwsIdentityProperties) => {
+    init?.logger?.debug("@smithy/credential-provider-imds", "fromContainerMetadata");
+    const { fromContainerMetadata: _fromContainerMetadata } = await import("@smithy/credential-provider-imds");
+    return _fromContainerMetadata(init)();
+  };
 };

packages/credential-providers/src/fromEnv.ts

@@ -1,5 +1,5 @@
 import type { FromEnvInit } from "@aws-sdk/credential-provider-env";
-import { fromEnv as _fromEnv } from "@aws-sdk/credential-provider-env";
+import type { AwsIdentityProperties } from "@aws-sdk/types";
 import type { AwsCredentialIdentityProvider } from "@smithy/types";
 
 /**
@@ -28,4 +28,9 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
  *
  * @public
  */
-export const fromEnv = (init?: FromEnvInit): AwsCredentialIdentityProvider => _fromEnv(init);
+export const fromEnv = (init?: FromEnvInit): AwsCredentialIdentityProvider => {
+  return async (args?: AwsIdentityProperties) => {
+    const { fromEnv: _fromEnv } = await import("@aws-sdk/credential-provider-env");
+    return _fromEnv(init)(args);
+  };
+};