feat!: add interceptor client config #704
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
milesziemer
force-pushed
the
interceptors-config
branch
from
f269732
to
0bbf847
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
May 9, 2024
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
May 9, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case.
milesziemer
force-pushed
the
interceptors-config
branch
2 times, most recently
from
fbcac8e
to
8e4ec7c
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
May 13, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case.
milesziemer
force-pushed
the
interceptors-config
branch
from
8e4ec7c
to
3448636
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
May 14, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case.
| @@ -13,6 +13,10 @@ public protocol RequestMessageBuilder<RequestType>: AnyObject { | |||
|
|
|||
| init() | |||
|
|
|||
| func withHost(_ host: String) -> Self | |||
There was a problem hiding this comment.
Host should be provided from URI?
There was a problem hiding this comment.
Oh yea, this is just here so I could use it in a test. I think this can changed to something like withURI
milesziemer
requested review from
dayaffe and
aws-dash
and removed request for
aws-dash
dayaffe
approved these changes
May 22, 2024
| writer.write("let builder = OrchestratorBuilder<$inputSymbol, $outputSymbol, SdkHttpRequest, HttpResponse, HttpContext>()") | ||
| writer.write("config.interceptorProviders.forEach { builder.interceptors.add($$0.create()) }") |
There was a problem hiding this comment.
nit: more readable if you did
config.interceptorProviders.forEach { provider in
builder.interceptors.add(provider.create())
}
dayaffe
reviewed
May 22, 2024
Comment on lines
68
to
78
| config.httpInterceptorProviders.forEach { | ||
| let i: any HttpInterceptor<${'$'}N, ${'$'}N> = $$0.create() | ||
| builder.interceptors.add(i) | ||
| } |
There was a problem hiding this comment.
same nit here might be better to use a name instead of $0.create for readability
milesziemer
force-pushed
the
interceptors-config
branch
from
3448636
to
0831020
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 11, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case, and updates the types of some interceptor implementations to remove AttributesType.
milesziemer
force-pushed
the
interceptors-config
branch
from
0831020
to
1db4723
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 11, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case, and updates the types of some interceptor implementations to remove AttributesType.
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 12, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case, and updates the types of some interceptor implementations to remove AttributesType.
milesziemer
force-pushed
the
interceptors-config
branch
3 times, most recently
from
350997f
to
bdbfa0b
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 12, 2024
Codegen for smithy-lang/smithy-swift#704. Also fixes a codegen test case, and updates the types of some interceptor implementations to remove AttributesType.
milesziemer
force-pushed
the
interceptors-config
branch
from
bdbfa0b
to
263ef6e
Compare
milesziemer
force-pushed
the
interceptors-config
branch
from
263ef6e
to
a0d018f
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 20, 2024
Codegen for smithy-lang/smithy-swift#704. Also updates the types of some interceptor implementations to remove AttributesType.
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 20, 2024
Codegen for smithy-lang/smithy-swift#704. Also updates the types of some interceptor implementations to remove AttributesType.
Allows configuration of interceptors on a client level by adding interceptor providers to client config, allowing Plugins to add interceptors. The primary addition is `InterceptorProvider`, an interface that creates generic interceptors which can operate on any transport - http or otherwise. When an operation is executed, interceptor providers are called to create new instances of service-level interceptors. Creating new instances also means we don't need to synchronize on the shared interceptors. Transport specific config, have their own methods for adding interceptor providers, so you can add `HttpInterceptorProvider`s to http config. Operations know which transport they operate on, and can choose which transport-specific interceptor providers to use. If/when we have operation-level configuration, it might make more sense to allow plugins to configure more generic 'operation customizations' or something, rather than just the interceptors. Operations would then call the customizations before executing. A few other minor changes were made to the client libraries: - Removed HasAttributes protocol and corresponding AttributesType from interceptor interfaces, as we now just use `Context`. - Changed InterceptorContext `getResult` to `getOutput`. We still store a `Result<OutputType, Error>` in DefaultInterceptorContext, but `getOutput` now throws that error if it is present, otherwise just returns `OutputType` - Added actual builder methods to RequestMessageBuilder, which we would need eventually, so I could use them in testing - Made SdkHttpRequestBuilder final Codegen was also updated to generate the new config methods, and to call interceptor providers in operations to add configured interceptors.
milesziemer
force-pushed
the
interceptors-config
branch
from
a0d018f
to
1c9d7ba
Compare
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 21, 2024
Codegen for smithy-lang/smithy-swift#704. Also updates the types of some interceptor implementations to remove AttributesType, and fixes a test case.
milesziemer
added a commit
to awslabs/aws-sdk-swift
that referenced
this pull request
Jun 21, 2024
Codegen for smithy-lang/smithy-swift#704. Also updates the types of some interceptor implementations to remove AttributesType, and fixes a test case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #
Description of changes
Allows configuration of interceptors on a client level by adding interceptor
providers to client config, allowing Plugins to add interceptors.
The primary addition is
InterceptorProvider, an interface that createsgeneric interceptors which can operate on any transport - http or otherwise.
When an operation is executed, interceptor providers are called to create
new instances of service-level interceptors. Creating new instances also
means we don't need to synchronize on the shared interceptors. Transport
specific config, have their own methods for adding interceptor providers, so
you can add
HttpInterceptorProviders to http config. Operations know whichtransport they operate on, and can choose which transport-specific interceptor
providers to use.
If/when we have operation-level configuration, it might make more sense to
allow plugins to configure more generic 'operation customizations' or
something, rather than just the interceptors. Operations would then call
the customizations before executing.
A few other minor changes were made to the client libraries:
eventually, so I could use them in testing
Codegen was also updated to generate the new config methods, and to call
interceptor providers in operations to add configured interceptors.
Scope
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.