fix: resolve endpoint in command serializer #162
Merged
Conversation
This file contains hidden or 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
AllanZhengYP
force-pushed
the
fix-context-endpoint
branch
2 times, most recently
from
ab24cb0 to
02f9506
Compare
The endpoint used to be a function returning a promise of Endpoint, and it is resolved in serializer parameter. It introduces mismatch between SerDeContext type and the value, where the value contains resolved endpoint but the type is a provider function returning Endpoint promise. This change assumes the SerDeContext.endpoint is actually a provider function and only resolve the promise when constructing a request. This change also fix the issue that the request resolved path got overwritten by '/'. Now only the hostname, port and scheme from client endpoint config is persisted when creating a request.
AllanZhengYP
force-pushed
the
fix-context-endpoint
branch
from
02f9506 to
fb5e27e
Compare
kstich
requested changes
Apr 24, 2020
| HttpProtocolGeneratorUtils.writeHostPrefix(context, operation); | ||
| } | ||
|
|
||
| writer.write("const {hostname, protocol = \"https\", port} = await context.endpoint();"); |
Contributor
There was a problem hiding this comment.
Can you add comments describing what this setup is doing and why it's necessary, in each of the files?
kstich
approved these changes
Apr 24, 2020
srchase
pushed a commit
to srchase/smithy-typescript
that referenced
this pull request
Mar 17, 2023
* fix: resolve endpoint in command serializer The endpoint used to be a function returning a promise of Endpoint, and it is resolved in serializer parameter. It introduces mismatch between SerDeContext type and the value, where the value contains resolved endpoint but the type is a provider function returning Endpoint promise. This change assumes the SerDeContext.endpoint is actually a provider function and only resolve the promise when constructing a request. This change also fix the issue that the request resolved path got overwritten by '/'. Now only the hostname, port and scheme from client endpoint config is persisted when creating a request. * add inline documents
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Replaces: #161
Fixes: #158
CodeGen: aws/aws-sdk-js-v3#1106
The SerDeContext contains endpoint config that used to be a provider
function returning a promise of Endpoint,
and it is resolved in serializer middleware. It introduces mismatch
between SerDeContext type and the value, where the value contains
resolved endpoint but the type is a provider function returning Endpoint
promise. This change assumes the SerDeContext.endpoint is actually
a provider function and only resolve the promise when constructing
a request.
This change also fixes a bug introduced in #160. By default the parsed
endpoint will have a default
path:/, which will then incorrectlyoverride the path from operation model. By this change, the default
endpoint or endpoint supplied from client constructor can only override
the
hostname,protocol, andportpart of the request.Whereas
pathandquerywill always be generated from the model.This behavior will also be align with V2 SDK
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.