Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

fix(kinesis): accept AWS SDK v2 CBOR content type (#457)

TiMc2653db2e704
diff --git a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/KinesisTest.java b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/KinesisTest.java
new file mode 100644
index 0000000000..6c3b82eee1
--- /dev/null
+++ b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/KinesisTest.java
@@ -0,0 +1,86 @@
+package com.floci.test;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
+import software.amazon.awssdk.core.interceptor.Context;
+import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
+import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
+import software.amazon.awssdk.http.SdkHttpRequest;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.kinesis.KinesisClient;
+import software.amazon.awssdk.services.kinesis.model.CreateStreamRequest;
+import software.amazon.awssdk.services.kinesis.model.DeleteStreamRequest;
+import software.amazon.awssdk.services.kinesis.model.DescribeStreamSummaryRequest;
+
+import java.util.concurrent.atomic.AtomicReference;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+
+@DisplayName("Kinesis")
+class KinesisTest {
+
+ private static final StaticCredentialsProvider CREDENTIALS =
+ StaticCredentialsProvider.create(AwsBasicCredentials.create("test", "test"));
+
+ private static KinesisClient kinesis;
+
+ @AfterAll
+ static void cleanup() {
+ if (kinesis != null) {
+ kinesis.close();
+ }
+ }
+
+ @Test
+ void awsSdkV2UsesRootCborRoute() {
+ AtomicReference<SdkHttpRequest> requestRef = new AtomicReference<>();
+
+ kinesis = KinesisClient.builder()
+ .endpointOverride(TestFixtures.endpoint())
+ .region(Region.US_EAST_1)
+ .credentialsProvider(CREDENTIALS)
+ .overrideConfiguration(ClientOverrideConfiguration.builder()
+ .addExecutionInterceptor(new ExecutionInterceptor() {
+ @Override
+ public SdkHttpRequest modifyHttpRequest(Context.ModifyHttpRequest context,
+ ExecutionAttributes executionAttributes) {
+ requestRef.set(context.httpRequest());
+ return context.httpRequest();
+ }
+ })
+ .build())
+ .build();
+
+ String streamName = TestFixtures.uniqueName("sdk-v2-kinesis-stream");
+
+ try {
+ assertDoesNotThrow(() -> kinesis.createStream(CreateStreamRequest.builder()
+ .streamName(streamName)
+ .shardCount(1)
+ .build()));
+
+ var response = assertDoesNotThrow(() -> kinesis.describeStreamSummary(
+ DescribeStreamSummaryRequest.builder()
+ .streamName(streamName)
+ .build()));
+
+ SdkHttpRequest request = requestRef.get();
+ assertThat(request).isNotNull();
+ assertThat(request.encodedPath()).isEqualTo("/");
+ assertThat(request.firstMatchingHeader("Content-Type").orElse(null))
+ .isEqualTo("application/x-amz-cbor-1.1");
+ assertThat(request.firstMatchingHeader("X-Amz-Target").orElse(null))
+ .isEqualTo("Kinesis_20131202.DescribeStreamSummary");
+ assertThat(response.streamDescriptionSummary().streamName()).isEqualTo(streamName);
+ } finally {
+ assertDoesNotThrow(() -> kinesis.deleteStream(DeleteStreamRequest.builder()
+ .streamName(streamName)
+ .build()));
+ }
+ }
+}
diff --git a/src/main/java/io/github/hectorvent/floci/core/common/AwsCborContentTypeFilter.java b/src/main/java/io/github/hectorvent/floci/core/common/AwsCborContentTypeFilter.java
new file mode 100644
index 0000000000..d3714bf344
--- /dev/null
+++ b/src/main/java/io/github/hectorvent/floci/core/common/AwsCborContentTypeFilter.java
@@ -0,0 +1,29 @@
+package io.github.hectorvent.floci.core.common;
+
+import jakarta.annotation.Priority;
+import jakarta.ws.rs.Priorities;
+import jakarta.ws.rs.container.ContainerRequestContext;
+import jakarta.ws.rs.container.ContainerRequestFilter;
+import jakarta.ws.rs.container.PreMatching;
+import jakarta.ws.rs.ext.Provider;
+
+@Provider
+@PreMatching
+@Priority(Priorities.HEADER_DECORATOR)
+public class AwsCborContentTypeFilter implements ContainerRequestFilter {
+
+ static final String ORIGINAL_CONTENT_TYPE_HEADER = "X-Floci-Original-Content-Type";
+ private static final String AWS_CBOR_1_1_MEDIA_TYPE = "application/x-amz-cbor-1.1";
+ private static final String GENERIC_CBOR_MEDIA_TYPE = "application/cbor";
+
+ @Override
+ public void filter(ContainerRequestContext ctx) {
+ String contentType = ctx.getHeaderString("Content-Type");
+ if (contentType == null || !contentType.startsWith(AWS_CBOR_1_1_MEDIA_TYPE)) {
+ return;
+ }
+
+ ctx.getHeaders().putSingle(ORIGINAL_CONTENT_TYPE_HEADER, contentType);
+ ctx.getHeaders().putSingle("Content-Type", GENERIC_CBOR_MEDIA_TYPE);
+ }
+}
diff --git a/src/main/java/io/github/hectorvent/floci/core/common/AwsJsonCborController.java b/src/main/java/io/github/hectorvent/floci/core/common/AwsJsonCborController.java
index 8e099b9b81..b1b16a0f5a 100644
--- a/src/main/java/io/github/hectorvent/floci/core/common/AwsJsonCborController.java
+++ b/src/main/java/io/github/hectorvent/floci/core/common/AwsJsonCborController.java
@@ -7,6 +7,7 @@ import com.fasterxml.jackson.dataformat.cbor.CBORGenerator;
import io.github.hectorvent.floci.services.cloudwatch.metrics.CloudWatchMetricsJsonHandler;
import io.github.hectorvent.floci.services.dynamodb.DynamoDbJsonHandler;
import io.github.hectorvent.floci.services.dynamodb.DynamoDbStreamsJsonHandler;
+import io.github.hectorvent.floci.services.kinesis.KinesisJsonHandler;
import io.github.hectorvent.floci.services.sns.SnsJsonHandler;
import io.github.hectorvent.floci.services.sqs.SqsJsonHandler;
import io.github.hectorvent.floci.services.stepfunctions.StepFunctionsJsonHandler;
@@ -34,6 +35,8 @@ public class AwsJsonCborController {
private static final Logger LOG = Logger.getLogger(AwsJsonCborController.class);
private static final ObjectMapper CBOR_MAPPER = new ObjectMapper(new CBORFactory());
+ private static final String GENERIC_CBOR_MEDIA_TYPE = "application/cbor";
+ private static final String AWS_CBOR_1_1_MEDIA_TYPE = "application/x-amz-cbor-1.1";
private final ObjectMapper objectMapper;
private final ResolvedServiceCatalog catalog;
@@ -42,6 +45,7 @@ public class AwsJsonCborController {
private final DynamoDbStreamsJsonHandler dynamoDbStreamsJsonHandler;
private final SqsJsonHandler sqsJsonHandler;
private final SnsJsonHandler snsJsonHandler;
+ private final KinesisJsonHandler kinesisJsonHandler;
private final StepFunctionsJsonHandler sfnJsonHandler;
private final CloudWatchMetricsJsonHandler cloudWatchMetricsJsonHandler;
@@ -51,6 +55,7 @@ public class AwsJsonCborController {
DynamoDbJsonHandler dynamoDbJsonHandler,
DynamoDbStreamsJsonHandler dynamoDbStreamsJsonHandler,
SqsJsonHandler sqsJsonHandler, SnsJsonHandler snsJsonHandler,
+ KinesisJsonHandler kinesisJsonHandler,
StepFunctionsJsonHandler sfnJsonHandler,
CloudWatchMetricsJsonHandler cloudWatchMetricsJsonHandler) {
this.objectMapper = objectMapper;
@@ -60,6 +65,7 @@ public class AwsJsonCborController {
this.dynamoDbStreamsJsonHandler = dynamoDbStreamsJsonHandler;
this.sqsJsonHandler = sqsJsonHandler;
this.snsJsonHandler = snsJsonHandler;
+ this.kinesisJsonHandler = kinesisJsonHandler;
this.sfnJsonHandler = sfnJsonHandler;
this.cloudWatchMetricsJsonHandler = cloudWatchMetricsJsonHandler;
}
@@ -116,13 +122,13 @@ public class AwsJsonCborController {
/**
* Handles AWS smithy-rpc-v2-cbor protocol requests.
* AWS SDK v2 sends to POST /service/{sdkId}/operation/{op}
- * with Content-Type: application/cbor and no X-Amz-Target header.
+ * with a CBOR content type and no X-Amz-Target header.
* Supported services: DynamoDB, SQS, SNS, StepFunctions, CloudWatch.
*/
@POST
@Path("service/{serviceId}/operation/{operation}")
- @Consumes("application/cbor")
- @Produces("application/cbor")
+ @Consumes({GENERIC_CBOR_MEDIA_TYPE, AWS_CBOR_1_1_MEDIA_TYPE})
+ @Produces({GENERIC_CBOR_MEDIA_TYPE, AWS_CBOR_1_1_MEDIA_TYPE})
public Response handleSmithyRpcV2Cbor(
@PathParam("serviceId") String serviceId,
@PathParam("operation") String operation,
@@ -146,13 +152,14 @@ public class AwsJsonCborController {
? (JsonNode) delegated.getEntity()
: objectMapper.valueToTree(delegated.getEntity());
byte[] cborBytes = nodeToSmithyCbor(responseNode);
+ String responseContentType = responseContentType(httpHeaders);
return Response.status(delegated.getStatus())
.header("Smithy-Protocol", "rpc-v2-cbor")
- .type("application/cbor")
+ .type(responseContentType)
.entity(cborBytes)
.build();
} catch (AwsException e) {
- return cborErrorResponse(e, "Smithy-Protocol");
+ return cborErrorResponse(e, "Smithy-Protocol", responseContentType(httpHeaders));
} catch (Exception e) {
LOG.error("Error processing Smithy CBOR request: " + serviceId + "." + operation, e);
return Response.status(500).build();
@@ -164,8 +171,8 @@ public class AwsJsonCborController {
* Fallback handler for X-Amz-Target based routing with CBOR body.
*/
@POST
- @Consumes("application/cbor")
- @Produces("application/cbor")
+ @Consumes({GENERIC_CBOR_MEDIA_TYPE, AWS_CBOR_1_1_MEDIA_TYPE})
+ @Produces({GENERIC_CBOR_MEDIA_TYPE, AWS_CBOR_1_1_MEDIA_TYPE})
public Response handleCborRequest(
@HeaderParam("X-Amz-Target") String target,
@Context HttpHeaders httpHeaders,
@@ -203,6 +210,7 @@ public class AwsJsonCborController {
}
case "sqs" -> sqsJsonHandler.handle(action, request, region);
case "sns" -> snsJsonHandler.handle(action, request, region);
+ case "kinesis" -> kinesisJsonHandler.handle(action, request, region);
case "states" -> sfnJsonHandler.handle(action, request, region);
case "monitoring" -> cloudWatchMetricsJsonHandler.handle(action, request, region);
default -> null;
@@ -215,13 +223,14 @@ public class AwsJsonCborController {
? (JsonNode) delegated.getEntity()
: objectMapper.valueToTree(delegated.getEntity());
byte[] cborBytes = nodeToSmithyCbor(responseNode);
+ String responseContentType = responseContentType(httpHeaders);
return Response.status(delegated.getStatus())
.header("smithy-protocol", "rpc-v2-cbor")
- .type("application/cbor")
+ .type(responseContentType)
.entity(cborBytes)
.build();
} catch (AwsException e) {
- return cborErrorResponse(e, "smithy-protocol");
+ return cborErrorResponse(e, "smithy-protocol", responseContentType(httpHeaders));
} catch (Exception e) {
LOG.error("Error processing CBOR request: " + serviceKey + "." + action, e);
return Response.status(500).build();
@@ -251,7 +260,7 @@ public class AwsJsonCborController {
};
}
- private Response cborErrorResponse(AwsException e, String protocolHeader) {
+ private Response cborErrorResponse(AwsException e, String protocolHeader, String mediaType) {
try {
byte[] errBytes = CBOR_MAPPER.writeValueAsBytes(
new AwsErrorResponse(e.jsonType(), e.getMessage()));
@@ -259,11 +268,22 @@ public class AwsJsonCborController {
return Response.status(e.getHttpStatus())
.header(protocolHeader, "rpc-v2-cbor")
.header("x-amzn-query-error", e.getErrorCode() + ";" + queryErrorFault)
- .type("application/cbor")
+ .type(mediaType)
.entity(errBytes)
.build();
} catch (Exception ex) {
return Response.status(e.getHttpStatus()).build();
}
}
+
+ private String responseContentType(HttpHeaders httpHeaders) {
+ String requestContentType = httpHeaders.getHeaderString(AwsCborContentTypeFilter.ORIGINAL_CONTENT_TYPE_HEADER);
+ if (requestContentType == null) {
+ requestContentType = httpHeaders.getHeaderString("Content-Type");
+ }
+ if (requestContentType != null && requestContentType.contains("x-amz-cbor")) {
+ return AWS_CBOR_1_1_MEDIA_TYPE;
+ }
+ return GENERIC_CBOR_MEDIA_TYPE;
+ }
}
diff --git a/src/main/java/io/github/hectorvent/floci/core/common/ResolvedServiceCatalog.java b/src/main/java/io/github/hectorvent/floci/core/common/ResolvedServiceCatalog.java
index 3895b4542e..b340c6e6f8 100644
--- a/src/main/java/io/github/hectorvent/floci/core/common/ResolvedServiceCatalog.java
+++ b/src/main/java/io/github/hectorvent/floci/core/common/ResolvedServiceCatalog.java
@@ -111,7 +111,7 @@ public class ResolvedServiceCatalog {
Set.of("AmazonApiGatewayV2."), Set.of("apigatewayv2"), Set.of(), Set.of()),
descriptor("kinesis", "kinesis", config.services().kinesis().enabled(), true,
"kinesis", config.storage().mode(), 5000L, null, ServiceProtocol.JSON,
- protocols(ServiceProtocol.JSON),
+ protocols(ServiceProtocol.JSON, ServiceProtocol.CBOR),
Set.of("Kinesis_20131202."), Set.of("kinesis"), Set.of(), Set.of()),
descriptor("kms", "kms", config.services().kms().enabled(), true,
"kms", config.storage().mode(), 5000L, null, ServiceProtocol.JSON,