Support generating non-AWS client #1

gosar · 2021-03-23T06:47:28Z

Description

These changes are to support generating a non-AWS typescript client. There are changes in the code generation logic to skip pieces that apply only to AWS services. Some typescript dependencies also needed updates.

This is initial prototype work for smithy-typescript-ssdk-demo.

Testing

Using these changes I successfully generated a working non-AWS typescript client for the bootleg-service in smithy-typescript-ssdk-demo.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

gosar · 2021-03-23T06:54:49Z

One thing I wanted to improve - EndpointsInputConfig.endpoint is optional. So when a customer of the BootlegClient in instantiating an instance of the client and doesn't provide an endpoint in the constructor, it is not a compile error. Since it is marked optional in Endpoints.ts and that's used for AWS service clients where it should be optional, I couldn't change this easily. I'd like to discuss ideas on how to do this.

JordonPhillips

Generally it would be nice to have a comment explaining why a thing was disabled for non-aws services. And feel free to throw exceptions for bad trait configurations

...pt-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPlugin.java

JordonPhillips · 2021-03-23T14:30:15Z

...pt-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPlugin.java

+    private static boolean isAwsService(Shape serviceShape) {
+        return serviceShape.getTrait(ServiceTrait.class).isPresent();
+    }


Can't you just check for sigv4 instead? The ServiceIndex had a getAuthSchemes operation you can use to generically check for auth. If the problem ist aht you need the aws service trait to make these components work, then you should throw a codegen exception if the sigv4 trait is present but the aws service trait is not.

I agree, I think a sigv4 check is more useful here.

See the latest diffs. I think the serviceShape.hasTrait(SigV4.class) check is sufficient, so I didn't use ServiceIndex. LMK if you think it is needed.

...main/java/software/amazon/smithy/aws/typescript/codegen/AwsEndpointGeneratorIntegration.java

adamthom-amzn · 2021-03-23T16:28:57Z

...pt-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPlugin.java

+    private static boolean isAwsService(Shape serviceShape) {
+        return serviceShape.getTrait(ServiceTrait.class).isPresent();
+    }


I agree, I think a sigv4 check is more useful here.

...codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsRuntimeConfig.java

...egen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddUserAgentDependency.java

adamthom-amzn · 2021-04-02T16:51:20Z

One thing I wanted to improve - EndpointsInputConfig.endpoint is optional. So when a customer of the BootlegClient in instantiating an instance of the client and doesn't provide an endpoint in the constructor, it is not a compile error. Since it is marked optional in Endpoints.ts and that's used for AWS service clients where it should be optional, I couldn't change this easily. I'd like to discuss ideas on how to do this.

You can do something like this:

constructor(c: EndpointsInputConfig & { endpoint : string }) {
 ...
}

This will make endpoint required for your constructor, even though it's optional in EndpointsInputConfig.

This is an initial version to get a working version of generated code that compiles without manual edits in smithy-typescript-ssdk-demo. I expect to make updates to this logic.

The minor ones from #1

AddAwsRuntimeConfigTest is checking for some behaviors from AddAwsAuthPlugin too, which was failing with missing aws.auth#sigv4 trait after my change. Added the trait for now to the test, but unit tests will need to be added/refactored for all these changes.

The minor ones from adamthom-amzn#1

* feat(config-resolver): make region optional for non-AWS client * feat(codegen): skip integrations that are not relevant for non-AWS services This is an initial version to get a working version of generated code that compiles without manual edits in smithy-typescript-ssdk-demo. I expect to make updates to this logic. * chore(codegen): address code comments The minor ones from adamthom-amzn#1 * fix(codegen): use SigV4Trait check instead of ServiceTrait AddAwsRuntimeConfigTest is checking for some behaviors from AddAwsAuthPlugin too, which was failing with missing aws.auth#sigv4 trait after my change. Added the trait for now to the test, but unit tests will need to be added/refactored for all these changes. * chore(codegen): move isAwsService check to utils class * chore(codegen): code style formatting * chore(codegen): check SigV4 trait for including region

* chore: serialize rest json error code header (#2166) * chore: short-circuit ssdk-incompatible integrations (#2167) * chore: disable idempotency autofill import when not generating a client (#2181) * Support generating non-AWS client (#2222) * feat(config-resolver): make region optional for non-AWS client * feat(codegen): skip integrations that are not relevant for non-AWS services This is an initial version to get a working version of generated code that compiles without manual edits in smithy-typescript-ssdk-demo. I expect to make updates to this logic. * chore(codegen): address code comments The minor ones from adamthom-amzn#1 * fix(codegen): use SigV4Trait check instead of ServiceTrait AddAwsRuntimeConfigTest is checking for some behaviors from AddAwsAuthPlugin too, which was failing with missing aws.auth#sigv4 trait after my change. Added the trait for now to the test, but unit tests will need to be added/refactored for all these changes. * chore(codegen): move isAwsService check to utils class * chore(codegen): code style formatting * chore(codegen): check SigV4 trait for including region * chore(codegen,config-resolver): refactor how endpoint is resolved for non-AWS client (#2287) * chore(config-resolver): refactor EndpointsConfig for non AWS services This reverts an earlier change to EndpointsConfig.ts and instead provides the new functionality in separate CustomEndpointsConfig.ts. This will be used as a separate plugin for endpoint resolution in non AWS clients. * feat(codegen): Use separate CustomEndpointsConfig for non-AWS clients This depends on newly added CustomEndpointsConfig in @aws-sdk/config-resolver package. * test(config-resolver): add test for CustomEndpointsConfig (#2305) Co-authored-by: Adam Thomas <[email protected]> Co-authored-by: Jaykumar Gosar <[email protected]>

* chore: serialize rest json error code header (aws#2166) * chore: short-circuit ssdk-incompatible integrations (aws#2167) * chore: disable idempotency autofill import when not generating a client (aws#2181) * Support generating non-AWS client (aws#2222) * feat(config-resolver): make region optional for non-AWS client * feat(codegen): skip integrations that are not relevant for non-AWS services This is an initial version to get a working version of generated code that compiles without manual edits in smithy-typescript-ssdk-demo. I expect to make updates to this logic. * chore(codegen): address code comments The minor ones from adamthom-amzn#1 * fix(codegen): use SigV4Trait check instead of ServiceTrait AddAwsRuntimeConfigTest is checking for some behaviors from AddAwsAuthPlugin too, which was failing with missing aws.auth#sigv4 trait after my change. Added the trait for now to the test, but unit tests will need to be added/refactored for all these changes. * chore(codegen): move isAwsService check to utils class * chore(codegen): code style formatting * chore(codegen): check SigV4 trait for including region * chore(codegen,config-resolver): refactor how endpoint is resolved for non-AWS client (aws#2287) * chore(config-resolver): refactor EndpointsConfig for non AWS services This reverts an earlier change to EndpointsConfig.ts and instead provides the new functionality in separate CustomEndpointsConfig.ts. This will be used as a separate plugin for endpoint resolution in non AWS clients. * feat(codegen): Use separate CustomEndpointsConfig for non-AWS clients This depends on newly added CustomEndpointsConfig in @aws-sdk/config-resolver package. * test(config-resolver): add test for CustomEndpointsConfig (aws#2305) Co-authored-by: Adam Thomas <[email protected]> Co-authored-by: Jaykumar Gosar <[email protected]>

gosar · 2022-02-23T17:19:45Z

Moved to upstream repo - aws#2222

* chore: serialize rest json error code header (#2166) * chore: short-circuit ssdk-incompatible integrations (#2167) * chore: disable idempotency autofill import when not generating a client (#2181) * Support generating non-AWS client (#2222) * feat(config-resolver): make region optional for non-AWS client * feat(codegen): skip integrations that are not relevant for non-AWS services This is an initial version to get a working version of generated code that compiles without manual edits in smithy-typescript-ssdk-demo. I expect to make updates to this logic. * chore(codegen): address code comments The minor ones from adamthom-amzn/aws-sdk-js-v3#1 * fix(codegen): use SigV4Trait check instead of ServiceTrait AddAwsRuntimeConfigTest is checking for some behaviors from AddAwsAuthPlugin too, which was failing with missing aws.auth#sigv4 trait after my change. Added the trait for now to the test, but unit tests will need to be added/refactored for all these changes. * chore(codegen): move isAwsService check to utils class * chore(codegen): code style formatting * chore(codegen): check SigV4 trait for including region * chore(codegen,config-resolver): refactor how endpoint is resolved for non-AWS client (#2287) * chore(config-resolver): refactor EndpointsConfig for non AWS services This reverts an earlier change to EndpointsConfig.ts and instead provides the new functionality in separate CustomEndpointsConfig.ts. This will be used as a separate plugin for endpoint resolution in non AWS clients. * feat(codegen): Use separate CustomEndpointsConfig for non-AWS clients This depends on newly added CustomEndpointsConfig in @aws-sdk/config-resolver package. * test(config-resolver): add test for CustomEndpointsConfig (#2305) Co-authored-by: Adam Thomas <[email protected]> Co-authored-by: Jaykumar Gosar <[email protected]>

JordonPhillips suggested changes Mar 23, 2021

View reviewed changes

adamthom-amzn reviewed Mar 23, 2021

View reviewed changes

adamthom-amzn force-pushed the ssdk branch 6 times, most recently from aa35d8a to 093ce24 Compare March 25, 2021 19:24

gosar added 5 commits April 5, 2021 22:03

Making region optional for non-AWS client

48d59f1

Skip integrations that are not relevant for non-AWS services

d9c9a04

This is an initial version to get a working version of generated code that compiles without manual edits in smithy-typescript-ssdk-demo. I expect to make updates to this logic.

Address code comments

cc28181

The minor ones from #1

Move isAwsService check to utils class

7acdcb0

gosar requested a review from adamthom-amzn April 6, 2021 20:29

gosar added a commit to gosar/aws-sdk-js-v3 that referenced this pull request Apr 8, 2021

Address code comments

75cc635

The minor ones from adamthom-amzn#1

gosar added a commit to gosar/aws-sdk-js-v3 that referenced this pull request Apr 8, 2021

Address code comments

70f1fef

The minor ones from adamthom-amzn#1

gosar added a commit to gosar/aws-sdk-js-v3 that referenced this pull request Apr 8, 2021

chore(codegen): address code comments

a141f92

The minor ones from adamthom-amzn#1

adamthom-amzn force-pushed the ssdk branch from 762a554 to 092d239 Compare April 20, 2021 19:02

gosar mentioned this pull request Apr 21, 2021

chore(codegen,config-resolver): refactor how endpoint is resolved for non-AWS client aws/aws-sdk-js-v3#2287

Merged

gosar closed this Feb 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support generating non-AWS client #1

Support generating non-AWS client #1

gosar commented Mar 23, 2021

gosar commented Mar 23, 2021

JordonPhillips left a comment

JordonPhillips Mar 23, 2021

adamthom-amzn Mar 23, 2021

gosar Apr 6, 2021

adamthom-amzn Mar 23, 2021

adamthom-amzn commented Apr 2, 2021

gosar commented Feb 23, 2022

Support generating non-AWS client #1

Support generating non-AWS client #1

Conversation

gosar commented Mar 23, 2021

Description

Testing

gosar commented Mar 23, 2021

JordonPhillips left a comment

Choose a reason for hiding this comment

JordonPhillips Mar 23, 2021

Choose a reason for hiding this comment

adamthom-amzn Mar 23, 2021

Choose a reason for hiding this comment

gosar Apr 6, 2021

Choose a reason for hiding this comment

adamthom-amzn Mar 23, 2021

Choose a reason for hiding this comment

adamthom-amzn commented Apr 2, 2021

gosar commented Feb 23, 2022