Skip to content

Fix serialization of REST-JSON requests when the endpoint has a path #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 2, 2021
Merged

Fix serialization of REST-JSON requests when the endpoint has a path #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69ca9e7
Fix serialization of REST-JSON requests when the endpoint has a path
adamthom-amzn Jun 25, 2021
02dc06b
Add endpoint to protocol test client generation
adamthom-amzn Jun 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...en/src/main/java/software/amazon/smithy/typescript/codegen/HttpProtocolTestGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,9 @@ private void generateClientRequestTest(OperationShape operation, HttpRequestTest
// Create a client with a custom request handler that intercepts requests.
writer.openBlock("const client = new $T({", "});\n", serviceSymbol, () -> {
writer.write("...clientParams,");
testCase.getHost().ifPresent(host -> {
writer.write("endpoint: \"https://$L\",", host);
});
writer.write("requestHandler: new RequestSerializationTestHandler(),");
});

Expand Down
13 changes: 8 additions & 5 deletions ...a/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,11 @@ private void generateOperationRequestSerializer(
+ " input: $T,\n"
+ " context: $L\n"
+ "): Promise<$T> => {", "}", methodName, inputType, contextType, requestType, () -> {

// Get the hostname, path, port, and scheme from client's resolved endpoint. Then construct the request from
// them. The client's resolved endpoint can be default one or supplied by users.
writer.write("const {hostname, protocol = $S, port, path: basePath} = await context.endpoint();", "https");

writeRequestHeaders(context, operation, bindingIndex);
writeResolvedPath(context, operation, bindingIndex, trait);
boolean hasQueryComponents = writeRequestQueryString(context, operation, bindingIndex, trait);
Expand All @@ -616,10 +621,6 @@ private void generateOperationRequestSerializer(
if (hasHostPrefix) {
HttpProtocolGeneratorUtils.writeHostPrefix(context, operation);
}

// Get the hostname, port, and scheme from client's resolved endpoint. Then construct the request from
// them. The client's resolved endpoint can be default one or supplied by users.
writer.write("const {hostname, protocol = \"https\", port} = await context.endpoint();");
writer.openBlock("return new $T({", "});", requestType, () -> {
writer.write("protocol,");
if (hasHostPrefix) {
Expand Down Expand Up @@ -683,7 +684,9 @@ private void writeResolvedPath(
List<HttpBinding> labelBindings = bindingIndex.getRequestBindings(operation, Location.LABEL);

// Always write the bound path, but only the actual segments.
writer.write("let resolvedPath = $S;", "/" + trait.getUri().getSegments().stream()
writer.write("let resolvedPath = `$L` + $S;",
"${basePath?.endsWith('/') ? basePath.slice(0, -1) : (basePath || '')}",
Copy link
Contributor

@gosar gosar Jun 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a unit test to add tests for these cases?

Copy link
Contributor Author

@adamthom-amzn adamthom-amzn Jun 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not that I can see, no.

Copy link
Contributor Author

@adamthom-amzn adamthom-amzn Jun 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like protocol tests let you specify a custom endpoint, so it should be testable there.

Copy link
Contributor Author

@adamthom-amzn adamthom-amzn Jun 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

smithy-lang/smithy#845

"/" + trait.getUri().getSegments().stream()
.map(Segment::toString)
.collect(Collectors.joining("/")));

Expand Down