Skip to content

Commit a40e1e9

Browse files
kuheSteven Yuan
kuhe
and
Steven Yuan
authored
feat(experimentalIdentityAndAuth): enable identity and auth by default (#1352)
* feat(codegen): add `mutateClientPlugins()` integration hook * feat(experimentalIdentityAndAuth): enable identity and auth by default `experimentalIdentityAndAuth` behavior is now the default auth behavior. The `experimentalIdentityAndAuth` flag is now oppositely replaced with `useLegacyAuth`, which enables legacy auth behavior for backward compatibility concerns. * additional cleanup * disable released version test * feat(codegen): add PreCommandClassCodeSection * wip: writerConsumers for plugins * feat: enable writers for plugin parameters * code style * use templating, use instance name for plugin --------- Co-authored-by: Steven Yuan <yuasteve@amazon.com>
1 parent c86fa19 commit a40e1e9

37 files changed

+664
-243
lines changed

‎.changeset/large-trainers-cross.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@smithy/experimental-identity-and-auth": patch
3+
---
4+
5+
set identity&auth SRA active by default

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ under development:
3030

3131
Experimental Feature | Flag | Description
3232
---------------------|-------------------------------|------------
33-
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.
33+
N/A | N/A | N/A
3434

3535
## Reporting Bugs/Feature Requests
3636

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ By default, the Smithy TypeScript code generators provide the code generation fr
197197
|`private`|No|Whether the package is `private` in `package.json`. The default value is `false`.|
198198
|`requiredMemberMode`|No|**NOT RECOMMENDED DUE TO BACKWARD COMPATIBILITY CONCERNS.** Sets whether members marked with the `@required` trait are allowed to be `undefined`. See more details on the risks in `TypeScriptSettings.RequiredMemberMode`. The default value is `nullable`.|
199199
|`createDefaultReadme`|No|Whether to generate a default `README.md` for the package. The default value is `false`.|
200-
|`experimentalIdentityAndAuth`|No|Experimental feature that standardizes identity and auth integrations to match the Smithy specification (see [Authentication Traits](https://smithy.io/2.0/spec/authentication-traits.html)). See [the experimental features section for more details](CONTRIBUTING.md#experimental-features).|
200+
|`useLegacyAuth`|No|**NOT RECOMMENDED, AVAILABLE ONLY FOR BACKWARD COMPATIBILITY CONCERNS.** Flag that enables using legacy auth. When in doubt, use the default identity and auth behavior (not configuring `useLegacyAuth`) as the golden path.|
201201

202202
#### `typescript-client-codegen` plugin artifacts
203203

‎packages/experimental-identity-and-auth/src/integration/httpApiKeyAuth.integ.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
import { requireRequestsFrom } from "@smithy/util-test";
88

99
describe("@httpApiKeyAuth integration tests", () => {
10-
// TODO(experimentalIdentityAndAuth): should match `HttpApiKeyAuthService` `@httpApiKeyAuth` trait
10+
// Match `HttpApiKeyAuthService` `@httpApiKeyAuth` trait
1111
const MOCK_API_KEY_NAME = "Authorization";
1212
const MOCK_API_KEY_SCHEME = "ApiKey";
1313
const MOCK_API_KEY = "APIKEY_123";

‎scripts/build-generated-test-packages.js

+40-51
Original file line numberDiff line numberDiff line change
@@ -9,59 +9,39 @@ const { spawnProcess } = require("./utils/spawn-process");
99

1010
const root = path.join(__dirname, "..");
1111

12-
const testProjectDir = path.join(
13-
root,
14-
"smithy-typescript-codegen-test",
15-
);
12+
const testProjectDir = path.join(root, "smithy-typescript-codegen-test");
1613

17-
const codegenTestDir = path.join(
18-
testProjectDir,
19-
"build",
20-
"smithyprojections",
21-
"smithy-typescript-codegen-test",
22-
);
14+
const codegenTestDir = path.join(testProjectDir, "build", "smithyprojections", "smithy-typescript-codegen-test");
2315

24-
const weatherClientDir = path.join(
25-
codegenTestDir,
26-
"source",
27-
"typescript-client-codegen"
28-
);
16+
const weatherClientDir = path.join(codegenTestDir, "source", "typescript-client-codegen");
2917

3018
const releasedClientDir = path.join(
31-
testProjectDir,
32-
"released-version-test",
33-
"build",
34-
"smithyprojections",
35-
"released-version-test",
36-
"source",
37-
"typescript-codegen"
19+
testProjectDir,
20+
"released-version-test",
21+
"build",
22+
"smithyprojections",
23+
"released-version-test",
24+
"source",
25+
"typescript-codegen"
3826
);
3927

40-
// TODO(experimentalIdentityAndAuth): build generic client for integration tests
41-
const weatherExperimentalIdentityAndAuthClientDir = path.join(
42-
codegenTestDir,
43-
"client-experimental-identity-and-auth",
44-
"typescript-client-codegen"
45-
);
28+
// Build generic legacy auth client for integration tests
29+
const weatherLegacyAuthClientDir = path.join(codegenTestDir, "client-legacy-auth", "typescript-client-codegen");
4630

47-
const weatherSsdkDir = path.join(
48-
codegenTestDir,
49-
"ssdk-test",
50-
"typescript-server-codegen"
51-
)
31+
const weatherSsdkDir = path.join(codegenTestDir, "ssdk-test", "typescript-server-codegen");
5232

53-
// TODO(experimentalIdentityAndAuth): add `@httpApiKeyAuth` client for integration tests
33+
// Build `@httpApiKeyAuth` client for integration tests
5434
const httpApiKeyAuthClientDir = path.join(
55-
codegenTestDir,
56-
"identity-and-auth-http-api-key-auth",
57-
"typescript-client-codegen"
35+
codegenTestDir,
36+
"identity-and-auth-http-api-key-auth",
37+
"typescript-client-codegen"
5838
);
5939

60-
// TODO(experimentalIdentityAndAuth): add `@httpBearerAuth` client for integration tests
40+
// Build `@httpBearerAuth` client for integration tests
6141
const httpBearerAuthClientDir = path.join(
62-
codegenTestDir,
63-
"identity-and-auth-http-bearer-auth",
64-
"typescript-client-codegen"
42+
codegenTestDir,
43+
"identity-and-auth-http-bearer-auth",
44+
"typescript-client-codegen"
6545
);
6646

6747
const nodeModulesDir = path.join(root, "node_modules");
@@ -82,10 +62,14 @@ const buildAndCopyToNodeModules = async (packageName, codegenDir, nodeModulesDir
8262
await spawnProcess("rm", ["-rf", packageName], { cwd: nodeModulesDir });
8363
await spawnProcess("mkdir", ["-p", packageName], { cwd: nodeModulesDir });
8464
const targetPackageDir = path.join(nodeModulesDir, packageName);
85-
await spawnProcess("tar", ["-xf", "package.tgz", "-C", targetPackageDir, "--strip-components", "1"], { cwd: codegenDir });
65+
await spawnProcess("tar", ["-xf", "package.tgz", "-C", targetPackageDir, "--strip-components", "1"], {
66+
cwd: codegenDir,
67+
});
8668
}
8769
} catch (e) {
88-
console.log(`Building and copying package \`${packageName}\` in \`${codegenDir}\` to \`${nodeModulesDir}\` failed:`)
70+
console.log(
71+
`Building and copying package \`${packageName}\` in \`${codegenDir}\` to \`${nodeModulesDir}\` failed:`
72+
);
8973
console.log(e);
9074
process.exit(1);
9175
}
@@ -94,12 +78,17 @@ const buildAndCopyToNodeModules = async (packageName, codegenDir, nodeModulesDir
9478
(async () => {
9579
await buildAndCopyToNodeModules("weather", weatherClientDir, nodeModulesDir);
9680
await buildAndCopyToNodeModules("weather-ssdk", weatherSsdkDir, nodeModulesDir);
97-
// TODO(experimentalIdentityAndAuth): build generic client for integration tests
98-
await buildAndCopyToNodeModules("@smithy/weather-experimental-identity-and-auth", weatherExperimentalIdentityAndAuthClientDir, nodeModulesDir);
99-
// TODO(experimentalIdentityAndAuth): add `@httpApiKeyAuth` client for integration tests
100-
await buildAndCopyToNodeModules("@smithy/identity-and-auth-http-api-key-auth-service", httpApiKeyAuthClientDir, nodeModulesDir);
101-
// TODO(experimentalIdentityAndAuth): add `@httpBearerAuth` client for integration tests
102-
await buildAndCopyToNodeModules("@smithy/identity-and-auth-http-bearer-auth-service", httpBearerAuthClientDir, nodeModulesDir);
103-
// Test released version of smithy-typescript codegenerators, but
104-
await buildAndCopyToNodeModules("released", releasedClientDir, undefined);
81+
await buildAndCopyToNodeModules("@smithy/weather-legacy-auth", weatherLegacyAuthClientDir, nodeModulesDir);
82+
await buildAndCopyToNodeModules(
83+
"@smithy/identity-and-auth-http-api-key-auth-service",
84+
httpApiKeyAuthClientDir,
85+
nodeModulesDir
86+
);
87+
await buildAndCopyToNodeModules(
88+
"@smithy/identity-and-auth-http-bearer-auth-service",
89+
httpBearerAuthClientDir,
90+
nodeModulesDir
91+
);
92+
// TODO(released-version-test): Test released version of smithy-typescript codegenerators, but currently is not working
93+
// await buildAndCopyToNodeModules("released", releasedClientDir, undefined);
10594
})();

‎smithy-typescript-codegen-test/example-weather-customizations/src/main/java/example/weather/SupportWeatherSigV4Auth.java

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package example.weather;
7+
8+
import java.util.Optional;
9+
import java.util.function.Consumer;
10+
import software.amazon.smithy.codegen.core.Symbol;
11+
import software.amazon.smithy.codegen.core.SymbolReference;
12+
import software.amazon.smithy.model.shapes.ShapeId;
13+
import software.amazon.smithy.typescript.codegen.ApplicationProtocol;
14+
import software.amazon.smithy.typescript.codegen.LanguageTarget;
15+
import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
16+
import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
17+
import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
18+
import software.amazon.smithy.typescript.codegen.auth.http.ConfigField;
19+
import software.amazon.smithy.typescript.codegen.auth.http.HttpAuthOptionProperty;
20+
import software.amazon.smithy.typescript.codegen.auth.http.HttpAuthScheme;
21+
import software.amazon.smithy.typescript.codegen.auth.http.HttpAuthSchemeParameter;
22+
import software.amazon.smithy.typescript.codegen.auth.http.integration.HttpAuthTypeScriptIntegration;
23+
import software.amazon.smithy.utils.SmithyInternalApi;
24+
25+
@SmithyInternalApi
26+
public final class SupportWeatherSigV4Auth implements HttpAuthTypeScriptIntegration {
27+
static final Symbol AWS_CREDENTIAL_IDENTITY = Symbol.builder()
28+
.name("AwsCredentialIdentity")
29+
.namespace(TypeScriptDependency.SMITHY_TYPES.getPackageName(), "/")
30+
.addDependency(TypeScriptDependency.SMITHY_TYPES)
31+
.build();
32+
static final Symbol AWS_CREDENTIAL_IDENTITY_PROVIDER = Symbol.builder()
33+
.name("AwsCredentialIdentityProvider")
34+
.namespace(TypeScriptDependency.SMITHY_TYPES.getPackageName(), "/")
35+
.addDependency(TypeScriptDependency.SMITHY_TYPES)
36+
.build();
37+
static final ConfigField CREDENTIALS_CONFIG_FIELD = ConfigField.builder()
38+
.name("credentials")
39+
.type(ConfigField.Type.MAIN)
40+
.docs(w -> w.write("The credentials used to sign requests."))
41+
.inputType(Symbol.builder()
42+
.name("AwsCredentialIdentity | AwsCredentialIdentityProvider")
43+
.addReference(AWS_CREDENTIAL_IDENTITY)
44+
.addReference(AWS_CREDENTIAL_IDENTITY_PROVIDER)
45+
.build())
46+
.resolvedType(Symbol.builder()
47+
.name("AwsCredentialIdentityProvider")
48+
.addReference(AWS_CREDENTIAL_IDENTITY)
49+
.addReference(AWS_CREDENTIAL_IDENTITY_PROVIDER)
50+
.build())
51+
.configFieldWriter(ConfigField::defaultMainConfigFieldWriter)
52+
.build();
53+
private static final Consumer<TypeScriptWriter> AWS_SIGV4_AUTH_SIGNER = w -> {
54+
w.addDependency(TypeScriptDependency.EXPERIMENTAL_IDENTITY_AND_AUTH);
55+
w.addImport("SigV4Signer", null, TypeScriptDependency.EXPERIMENTAL_IDENTITY_AND_AUTH);
56+
w.write("new SigV4Signer()");
57+
};
58+
private static final SymbolReference PROVIDER = SymbolReference.builder()
59+
.symbol(Symbol.builder()
60+
.name("Provider")
61+
.namespace(TypeScriptDependency.SMITHY_TYPES.getPackageName(), "/")
62+
.addDependency(TypeScriptDependency.SMITHY_TYPES)
63+
.build())
64+
.alias("__Provider")
65+
.build();
66+
67+
@Override
68+
public boolean matchesSettings(TypeScriptSettings settings) {
69+
return !settings.useLegacyAuth();
70+
}
71+
72+
@Override
73+
public Optional<HttpAuthScheme> getHttpAuthScheme() {
74+
return Optional.of(HttpAuthScheme.builder()
75+
.schemeId(ShapeId.from("aws.auth#sigv4"))
76+
.applicationProtocol(ApplicationProtocol.createDefaultHttpApplicationProtocol())
77+
.putDefaultSigner(LanguageTarget.SHARED, AWS_SIGV4_AUTH_SIGNER)
78+
.addConfigField(CREDENTIALS_CONFIG_FIELD)
79+
.addConfigField(ConfigField.builder()
80+
.name("region")
81+
.type(ConfigField.Type.AUXILIARY)
82+
.docs(w -> w.write("The AWS region to which this client will send requests."))
83+
.inputType(Symbol.builder()
84+
.name("string | __Provider<string>")
85+
.addReference(PROVIDER)
86+
.build())
87+
.resolvedType(Symbol.builder()
88+
.name("__Provider<string>")
89+
.addReference(PROVIDER)
90+
.build())
91+
.configFieldWriter(ConfigField::defaultAuxiliaryConfigFieldWriter)
92+
.build())
93+
.addHttpAuthSchemeParameter(HttpAuthSchemeParameter.builder()
94+
.name("region")
95+
.type(w -> w.write("string"))
96+
.source(w -> {
97+
w.addDependency(TypeScriptDependency.UTIL_MIDDLEWARE);
98+
w.addImport("normalizeProvider", null, TypeScriptDependency.UTIL_MIDDLEWARE);
99+
w.openBlock("await normalizeProvider(config.region)() || (() => {", "})()", () -> {
100+
w.write("throw new Error(\"expected `region` to be configured for `aws.auth#sigv4`\");");
101+
});
102+
})
103+
.build())
104+
.addHttpAuthOptionProperty(HttpAuthOptionProperty.builder()
105+
.name("name")
106+
.type(HttpAuthOptionProperty.Type.SIGNING)
107+
.source(s -> w -> {
108+
w.write("$S", s.trait().toNode().expectObjectNode().getMember("name"));
109+
})
110+
.build())
111+
.addHttpAuthOptionProperty(HttpAuthOptionProperty.builder()
112+
.name("region")
113+
.type(HttpAuthOptionProperty.Type.SIGNING)
114+
.source(t -> w -> {
115+
w.write("authParameters.region");
116+
})
117+
.build())
118+
.propertiesExtractor(s -> w -> w
119+
.write("""
120+
(config, context) => {
121+
return {
122+
/**
123+
* @internal
124+
*/
125+
signingProperties: {
126+
...config,
127+
...context,
128+
},
129+
};
130+
},"""))
131+
.build());
132+
}
133+
}

‎smithy-typescript-codegen-test/example-weather-customizations/src/main/resources/META-INF/services/software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
example.weather.ExampleWeatherCustomEndpointsRuntimeConfig
2+
example.weather.SupportWeatherSigV4Auth

‎smithy-typescript-codegen-test/model/weather/main.smithy

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ service Weather {
3434
GetCurrentTime
3535
// util-stream.integ.spec.ts
3636
Invoke
37-
// experimentalIdentityAndAuth
37+
// Identity and Auth
3838
OnlyHttpApiKeyAuth
3939
OnlyHttpApiKeyAuthOptional
4040
OnlyHttpBearerAuth

‎smithy-typescript-codegen-test/released-version-test/build.gradle.kts

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6+
// TODO(released-version-test): Test released version of smithy-typescript codegenerators, but currently is extremely flaky
7+
/*
68
plugins {
79
java
810
id("software.amazon.smithy.gradle.smithy-base")
@@ -27,3 +29,4 @@ dependencies {
2729
}
2830
2931
tasks["jar"].enabled = false
32+
*/

‎smithy-typescript-codegen-test/smithy-build.json

+9-11
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
}
3030
}
3131
},
32-
"client-experimental-identity-and-auth": {
32+
"client-identity-and-auth": {
3333
"transforms": [
3434
{
3535
"name": "includeServices",
@@ -41,17 +41,16 @@
4141
"plugins": {
4242
"typescript-client-codegen": {
4343
"service": "example.weather#Weather",
44-
"package": "@smithy/weather-experimental-identity-and-auth",
44+
"package": "weather",
4545
"packageVersion": "0.0.1",
4646
"packageJson": {
4747
"license": "Apache-2.0",
4848
"private": true
49-
},
50-
"experimentalIdentityAndAuth": true
49+
}
5150
}
5251
}
5352
},
54-
"control-experimental-identity-and-auth": {
53+
"client-legacy-auth": {
5554
"transforms": [
5655
{
5756
"name": "includeServices",
@@ -63,12 +62,13 @@
6362
"plugins": {
6463
"typescript-client-codegen": {
6564
"service": "example.weather#Weather",
66-
"package": "weather",
65+
"package": "@smithy/weather-legacy-auth",
6766
"packageVersion": "0.0.1",
6867
"packageJson": {
6968
"license": "Apache-2.0",
7069
"private": true
71-
}
70+
},
71+
"useLegacyAuth": true
7272
}
7373
}
7474
},
@@ -89,8 +89,7 @@
8989
"packageJson": {
9090
"license": "Apache-2.0",
9191
"private": true
92-
},
93-
"experimentalIdentityAndAuth": true
92+
}
9493
}
9594
}
9695
},
@@ -111,8 +110,7 @@
111110
"packageJson": {
112111
"license": "Apache-2.0",
113112
"private": true
114-
},
115-
"experimentalIdentityAndAuth": true
113+
}
116114
}
117115
}
118116
}

0 commit comments

Comments
 (0)