Skip to content
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.

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

feat(codegen): send x-amzn-query-mode header #6651

Merged
merged 1 commit into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions clients/client-sqs/src/protocols/Aws_json1_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2087,6 +2087,7 @@ function sharedHeaders(operation: string): __HeaderBag {
return {
"content-type": "application/x-amz-json-1.0",
"x-amz-target": `AmazonSQS.${operation}`,
"x-amzn-query-mode": "true",
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
package software.amazon.smithy.aws.typescript.codegen;

import software.amazon.smithy.aws.traits.protocols.AwsJson1_1Trait;
import software.amazon.smithy.model.shapes.ServiceShape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
import software.amazon.smithy.utils.SmithyInternalApi;

/**
Expand All @@ -43,4 +46,22 @@ public ShapeId getProtocol() {
public String getName() {
return "aws.json-1.1";
}

/**
* This override exists because the "x-amzn-query-error" header is only
* sent in AwsJsonRpc1_0.
*/
@Override
protected void writeSharedRequestHeaders(GenerationContext context) {
ServiceShape serviceShape = context.getService();
TypeScriptWriter writer = context.getWriter();
writer.addImport("HeaderBag", "__HeaderBag", TypeScriptDependency.SMITHY_TYPES);
String targetHeader = serviceShape.getId().getName(serviceShape) + ".${operation}";
writer.openBlock("function sharedHeaders(operation: string): __HeaderBag { return {", "}};",
() -> {
writer.write("'content-type': $S,", getDocumentContentType());
writer.write("'x-amz-target': `$L`,", targetHeader);
}
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import software.amazon.smithy.aws.traits.protocols.AwsQueryCompatibleTrait;
import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator;
import software.amazon.smithy.typescript.codegen.protocols.cbor.SmithyRpcV2Cbor;

/**
Expand All @@ -34,6 +35,24 @@ public void generateSharedComponents(GenerationContext context) {
}
}

@Override
protected void writeSharedRequestHeaders(ProtocolGenerator.GenerationContext context) {
TypeScriptWriter writer = context.getWriter();
writer.addImport("HeaderBag", "__HeaderBag", TypeScriptDependency.SMITHY_TYPES);
writer.openBlock("const SHARED_HEADERS: __HeaderBag = {", "};", () -> {
writer.write("'content-type': $S,", getDocumentContentType());
writer.write("""
"smithy-protocol": "rpc-v2-cbor",
"accept": "application/cbor",
""");
if (context.getService().hasTrait(AwsQueryCompatibleTrait.class)) {
writer.write("""
"x-amzn-query-mode": "true",
""");
}
});
}

@Override
protected void writeErrorCodeParser(GenerationContext generationContext) {
super.writeErrorCodeParser(generationContext);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,11 @@ protected void writeSharedRequestHeaders(GenerationContext context) {
// AWS JSON RPC protocols use a combination of the service and operation shape names,
// separated by a '.' character, for the target header.
writer.write("'x-amz-target': `$L`,", targetHeader);
if (serviceShape.hasTrait(AwsQueryCompatibleTrait.class)) {
writer.write("""
"x-amzn-query-mode": "true",
""");
}
}
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import { requireRequestsFrom } from "../../../private/aws-util-test/src";

const sqsModel: any = require("../../../codegen/sdk-codegen/aws-models/sqs.json");
const useAwsQuery = !!sqsModel.shapes["com.amazonaws.sqs#AmazonSQS"].traits["aws.protocols#awsQuery"];
const isAwsQueryCompatible =
!!sqsModel.shapes["com.amazonaws.sqs#AmazonSQS"].traits["aws.protocols#awsQueryCompatible"];

let hashError = "";
const md5 = (str: string) =>
Expand Down Expand Up @@ -319,6 +321,28 @@ describe("middleware-sdk-sqs", () => {
});
});

it("should send the x-amzn-query-mode header when in awsQueryCompatible mode", async () => {
const client = new SQS({
region: "us-west-2",
credentials: mockCredentials,
logger,
});

requireRequestsFrom(client).toMatch({
hostname: "abc.com",
protocol: "https:",
path: "/",
headers: {
"x-amzn-query-mode": "true",
},
});

await client.sendMessage({
QueueUrl: "https://abc.com/123/MyQueue",
MessageBody: "hello",
});
});

describe("queue-url", () => {
it("should override resolved endpoint by default", async () => {
const client = new SQS({
Expand Down
Loading