feat(experimentalIdentityAndAuth): make experimentalIdentityAndAuth…

… default TODO: - [ ] AddAwsRuntimeConfig - [ ] AddBuiltinPlugins - [ ] AddEventBridgePlugin - [ ] AddEventStreamHandlingDependency - [ ] AddS3Config - [ ] AddS3ControlDependency
aws · Oct 2, 2023 · a462fe5 · a462fe5
1 parent ba89e7e
commit a462fe5
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 79 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -149,9 +149,9 @@ experimental features that can affect `aws-sdk-js-v3`. These features are enable
 Note that any contributions related to these features MUST be reviewed carefully for opt-in behavior via feature flags
 as to not break any existing customers. Here are the experimental features that are currently under development:
 
-| Experimental Feature | Flag                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
-| -------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Identity & Auth      | `experimentalIdentityAndAuth` | Standardize identity and auth integrations to match the Smithy specification (see [Authentication Traits](https://smithy.io/2.0/spec/authentication-traits.html)). Newer capabilities include support for multiple auth schemes, `@optionalAuth`, and standardized identity interfaces for authentication schemes both in code generation and TypeScript packages. In `smithy-typescript`, `@httpApiKeyAuth` will be updated to use the new standardized interfaces. In `aws-sdk-js-v3` (`smithy-typescript`'s largest customer), this will affect `@aws.auth#sigv4` and `@httpBearerAuth` implementations, but is planned to be completely backwards-compatible. |
+| Experimental Feature | Flag | Description |
+| -------------------- | ---- | ----------- |
+| Currently None       | N/A  | N/A         |
 
 ## Build caching
 

diff --git a/codegen/generic-client-test-codegen/model/weather.smithy b/codegen/generic-client-test-codegen/model/weather.smithy
@@ -21,7 +21,7 @@ structure fakeProtocol {}
 service Weather {
     version: "2006-03-01"
     operations: [
-        // experimentalIdentityAndAuth
+        // Identity and Auth
         OnlyHttpApiKeyAuth
         OnlyHttpApiKeyAuthOptional
         OnlyHttpBearerAuth

diff --git a/codegen/generic-client-test-codegen/smithy-build.json b/codegen/generic-client-test-codegen/smithy-build.json
@@ -2,32 +2,7 @@
   "version": "1.0",
   "imports": ["model/echo.smithy"],
   "projections": {
-    "client-experimental-identity-and-auth": {
-      "transforms": [
-        {
-          "name": "includeServices",
-          "args": {
-            "services": ["example.weather#Weather"]
-          }
-        }
-      ],
-      "plugins": {
-        "typescript-codegen": {
-          "package": "@aws-sdk/weather",
-          "packageVersion": "0.0.1",
-          "packageJson": {
-            "author": {
-              "name": "AWS SDK for JavaScript Team",
-              "url": "https://aws.amazon.com/javascript/"
-            },
-            "license": "Apache-2.0"
-          },
-          "private": true,
-          "experimentalIdentityAndAuth": true
-        }
-      }
-    },
-    "control-experimental-identity-and-auth": {
+    "control-identity-and-auth": {
       "transforms": [
         {
           "name": "includeServices",

diff --git a/...codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPlugin.java b/...codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPlugin.java
@@ -55,9 +55,8 @@
 
 /**
  * Configure clients with AWS auth configurations and plugin.
- *
- * This is the existing control behavior for `experimentalIdentityAndAuth`.
  */
+@Deprecated
 @SmithyInternalApi
 public final class AddAwsAuthPlugin implements TypeScriptIntegration {
     static final String STS_CLIENT_PREFIX = "sts-client-";
@@ -67,14 +66,6 @@ public final class AddAwsAuthPlugin implements TypeScriptIntegration {
 
     private static final Logger LOGGER = Logger.getLogger(AddAwsAuthPlugin.class.getName());
 
-    /**
-     * Integration should only be used if `experimentalIdentityAndAuth` flag is false.
-     */
-    @Override
-    public boolean matchesSettings(TypeScriptSettings settings) {
-        return !settings.getExperimentalIdentityAndAuth();
-    }
-
     @Override
     public void addConfigInterfaceFields(
         TypeScriptSettings settings,

diff --git a/...degen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddTokenAuthPlugin.java b/...degen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddTokenAuthPlugin.java
@@ -20,28 +20,17 @@
 import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_MIDDLEWARE;
 
 import java.util.List;
-import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
 import software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin;
 import software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration;
 import software.amazon.smithy.utils.ListUtils;
 import software.amazon.smithy.utils.SmithyInternalApi;
 
 /**
  * Configure clients with Token auth configurations and plugin.
- *
- * This is the existing control behavior for `experimentalIdentityAndAuth`.
  */
+@Deprecated
 @SmithyInternalApi
 public final class AddTokenAuthPlugin implements TypeScriptIntegration {
-
-    /**
-     * Integration should only be used if `experimentalIdentityAndAuth` flag is false.
-     */
-    @Override
-    public boolean matchesSettings(TypeScriptSettings settings) {
-        return !settings.getExperimentalIdentityAndAuth();
-    }
-
     @Override
     public List<RuntimeClientPlugin> getClientPlugins() {
         return ListUtils.of(

diff --git a/...pt-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java b/...pt-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java
@@ -84,7 +84,7 @@ public enum AwsDependency implements Dependency {
     // Conditionally added when auth trait is present
     MIDDLEWARE_API_KEY(NORMAL_DEPENDENCY, "@aws-sdk/middleware-api-key"),
 
-    // feat(experimentalIdentityAndAuth): Conditionally added when @httpBearerAuth is used in an AWS service
+    // Conditionally added when @httpBearerAuth is used in an AWS service
     TOKEN_PROVIDERS(NORMAL_DEPENDENCY, "@aws-sdk/token-providers"),
     TYPES(NORMAL_DEPENDENCY, "@aws-sdk/types"),
     REGION_CONFIG_RESOLVER(NORMAL_DEPENDENCY, "@aws-sdk/region-config-resolver");

diff --git a/...y/aws/typescript/codegen/auth/http/integration/AwsCustomizeHttpBearerTokenAuthPlugin.java b/...y/aws/typescript/codegen/auth/http/integration/AwsCustomizeHttpBearerTokenAuthPlugin.java
@@ -9,7 +9,6 @@
 import software.amazon.smithy.aws.typescript.codegen.AwsDependency;
 import software.amazon.smithy.model.traits.HttpBearerAuthTrait;
 import software.amazon.smithy.typescript.codegen.LanguageTarget;
-import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
 import software.amazon.smithy.typescript.codegen.auth.http.HttpAuthScheme;
 import software.amazon.smithy.typescript.codegen.auth.http.SupportedHttpAuthSchemesIndex;
 import software.amazon.smithy.typescript.codegen.auth.http.integration.AddHttpBearerAuthPlugin;
@@ -18,20 +17,9 @@
 
 /**
  * Customize @httpBearerAuth for AWS SDKs.
- *
- * This is the experimental behavior for `experimentalIdentityAndAuth`.
  */
 @SmithyInternalApi
 public final class AwsCustomizeHttpBearerTokenAuthPlugin implements HttpAuthTypeScriptIntegration {
-
-    /**
-     * Integration should only be used if `experimentalIdentityAndAuth` flag is true.
-     */
-    @Override
-    public boolean matchesSettings(TypeScriptSettings settings) {
-        return settings.getExperimentalIdentityAndAuth();
-    }
-
     /**
      * Run after default AddHttpBearerAuthPlugin.
      */

diff --git a/...azon/smithy/aws/typescript/codegen/auth/http/integration/AwsCustomizeSigv4AuthPlugin.java b/...azon/smithy/aws/typescript/codegen/auth/http/integration/AwsCustomizeSigv4AuthPlugin.java
@@ -9,7 +9,6 @@
 import software.amazon.smithy.aws.traits.auth.SigV4Trait;
 import software.amazon.smithy.aws.typescript.codegen.AwsDependency;
 import software.amazon.smithy.typescript.codegen.LanguageTarget;
-import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
 import software.amazon.smithy.typescript.codegen.auth.http.HttpAuthScheme;
 import software.amazon.smithy.typescript.codegen.auth.http.SupportedHttpAuthSchemesIndex;
 import software.amazon.smithy.typescript.codegen.auth.http.integration.AddSigV4AuthPlugin;
@@ -18,20 +17,9 @@
 
 /**
  * Customize @aws.auth#sigv4 for AWS SDKs.
- *
- * This is the experimental behavior for `experimentalIdentityAndAuth`.
  */
 @SmithyInternalApi
 public class AwsCustomizeSigv4AuthPlugin implements HttpAuthTypeScriptIntegration {
-
-    /**
-     * Integration should only be used if `experimentalIdentityAndAuth` flag is true.
-     */
-    @Override
-    public boolean matchesSettings(TypeScriptSettings settings) {
-        return settings.getExperimentalIdentityAndAuth();
-    }
-
     /**
      * Run after default AddSigV4AuthPlugin.
      */

diff --git a/...-INF/services/software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration b/...-INF/services/software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration
@@ -1,8 +1,6 @@
 software.amazon.smithy.aws.typescript.codegen.AddEndpointsV2ParameterNameMap
 software.amazon.smithy.aws.typescript.codegen.AddAwsRuntimeConfig
 software.amazon.smithy.aws.typescript.codegen.AddBuiltinPlugins
-software.amazon.smithy.aws.typescript.codegen.AddAwsAuthPlugin
-software.amazon.smithy.aws.typescript.codegen.AddTokenAuthPlugin
 software.amazon.smithy.aws.typescript.codegen.AddProtocols
 software.amazon.smithy.aws.typescript.codegen.AwsEndpointGeneratorIntegration
 software.amazon.smithy.aws.typescript.codegen.AddNimbleCustomizations

diff --git a/...gen/src/test/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPluginTest.java b/...gen/src/test/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPluginTest.java
@@ -4,6 +4,7 @@
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.not;
 
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.build.MockManifest;
 import software.amazon.smithy.build.PluginContext;
@@ -12,7 +13,9 @@
 import software.amazon.smithy.typescript.codegen.CodegenUtils;
 import software.amazon.smithy.typescript.codegen.TypeScriptCodegenPlugin;
 
+@Deprecated
 public class AddAwsAuthPluginTest {
+    @Disabled("software.amazon.smithy.aws.typescript.codegen.AddAwsAuthPlugin is considered deprecated")
     @Test
     public void awsClient() {
         Model model = Model.assembler()
@@ -52,6 +55,7 @@ public void awsClient() {
         assertThat(manifest.getFileString(CodegenUtils.SOURCE_FOLDER + "/NotSameClient.ts").get(), containsString("getAwsAuthPlugin"));
     }
 
+    @Disabled("software.amazon.smithy.aws.typescript.codegen.AddAwsAuthPlugin is considered deprecated")
     @Test
     public void sigV4GenericClient() {
         Model model = Model.assembler()