DeserializationException on DDB ResourceInUse

[cprice404]

Describe the bug

In the DynamoDB SDK: making a createTable request for a table that already exists results in:

aws.smithy.kotlin.runtime.serde.DeserializationException: Unexpected token type EndDocument

Expected Behavior

Should throw a ResourceInUse exception or similar

Current Behavior

Unexpected token type EndDocument
aws.smithy.kotlin.runtime.serde.DeserializationException: Unexpected token type EndDocument
	at app//aws.smithy.kotlin.runtime.serde.json.JsonDeserializer.deserializeStruct(JsonDeserializer.kt:73)
	at app//aws.smithy.kotlin.runtime.serde.DeserializerKt.deserializeStruct(Deserializer.kt:200)
	at app//aws.sdk.kotlin.services.dynamodb.transform.ResourceInUseExceptionDeserializerKt.deserializeResourceInUseExceptionError(ResourceInUseExceptionDeserializer.kt:45)
	at app//aws.sdk.kotlin.services.dynamodb.transform.ResourceInUseExceptionDeserializerKt.access$deserializeResourceInUseExceptionError(ResourceInUseExceptionDeserializer.kt:1)
	at app//aws.sdk.kotlin.services.dynamodb.transform.ResourceInUseExceptionDeserializer.deserialize(ResourceInUseExceptionDeserializer.kt:32)
	at app//aws.sdk.kotlin.services.dynamodb.transform.CreateTableOperationDeserializerKt.throwCreateTableError(CreateTableOperationDeserializer.kt:85)
	at app//aws.sdk.kotlin.services.dynamodb.transform.CreateTableOperationDeserializerKt.access$throwCreateTableError(CreateTableOperationDeserializer.kt:1)
	at app//aws.sdk.kotlin.services.dynamodb.transform.CreateTableOperationDeserializer.deserialize(CreateTableOperationDeserializer.kt:35)
	at app//aws.smithy.kotlin.runtime.http.operation.SdkOperationExecutionKt$decorate$3.invoke(SdkOperationExecution.kt:97)
	at app//aws.smithy.kotlin.runtime.http.operation.SdkOperationExecutionKt$decorate$3.invoke(SdkOperationExecution.kt:97)
	at app//aws.smithy.kotlin.runtime.http.operation.DeserializeHandler.call(SdkOperationExecution.kt:153)
	at app//aws.smithy.kotlin.runtime.http.operation.DeserializeHandler$call$1.invokeSuspend(SdkOperationExecution.kt)

Steps to Reproduce

Run this twice:

   val request = CreateTableRequest {
            this.tableName = "foo"
            attributeDefinitions = listOf(
                AttributeDefinition {
                    attributeName = "myKey"
                    attributeType = ScalarAttributeType.S
                }
            )
            keySchema = listOf(
                KeySchemaElement {
                    attributeName = "myKey"
                    keyType = KeyType.Hash
                }
            )
            provisionedThroughput = ProvisionedThroughput {
                readCapacityUnits = 10
                writeCapacityUnits = 10
            }
        }

Possible Solution

Seems like just a basic deserialization bug

Context

Writing code that should catch the ResourceInUse exception and handle it; will probably be
forced to temporarliy catch this DeserializationException instead.

Your Environment

• AWS Kotlin SDK version used: 0.7.0-alpha
• Platform (JVM/JS/Native): JVM
• Operating System and version: Mac OSX Big Sur

[aajtodd]

Thanks for the bug report!

It looks like this is an error in code generation actually. The response payload is consumed and can only be read once (for streaming payloads, of which all responses are considered streaming).

private suspend fun throwCreateTableError(context: ExecutionContext, response: HttpResponse): kotlin.Nothing {
    val payload = response.body.readAll()
    val wrappedResponse = response.withPayload(payload)

    println(payload)
    val errorDetails = try {
        RestJsonErrorDeserializer.deserialize(response.headers, payload)
    } catch (ex: Exception) {
        throw UnknownServiceErrorException("failed to parse response as awsJson1_0 error", ex).also {
            setAseErrorMetadata(it, wrappedResponse, null)
        }
    }

    val modeledExceptionDeserializer = when(errorDetails.code) {
        "InternalServerError" -> InternalServerErrorDeserializer()
        "InvalidEndpointException" -> InvalidEndpointExceptionDeserializer()
        "LimitExceededException" -> LimitExceededExceptionDeserializer()
        "ResourceInUseException" -> ResourceInUseExceptionDeserializer()
        else -> throw DynamoDbException(errorDetails.message)
    }
-    val modeledException = modeledExceptionDeserializer.deserialize(context, response)
+    val modeledException = modeledExceptionDeserializer.deserialize(context, wrappedResponse)
    setAseErrorMetadata(modeledException, wrappedResponse, errorDetails)
    throw modeledException
}

This wasn't caught by the protocol tests because we just so happen to use HttpBody.Bytes for the test response body.

We'll get a fix out for this in the next release.

[cprice404]

Thanks! FYI it appears to happen if you try to delete a non-existent table too, for the ResourceNotFound exception.

[aajtodd]

Thanks! FYI it appears to happen if you try to delete a non-existent table too, for the ResourceNotFound exception.

Ya it will actually happen for any exception at the moment that has a non-empty response body. Fix should land in next release which will hopefully be today.

Thanks again for the report and please feel free to share any other feedback about using the SDK!

[cprice404]

Thanks for the quick fix! I do actually have a couple of other minor thoughts on the SDK, what's the best way to submit them? Just open new github issues?

[aajtodd]

@cprice404

For bugs or feature requests you can open an issue. For Q&A, general feedback, or ideas feel free to start a discussion.

Looking forward to hearing your thoughts.