Skip to content

Fix http error registration #118

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 7 commits into from
May 3, 2021
Merged

Fix http error registration #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
91478be
fix error registration codegen to generate without presense of HttpEr…
kggilmer Apr 29, 2021
cce9462
linter
kggilmer Apr 29, 2021
fb7c45f
Merge branch 'main' into fix-http-error-registration
kggilmer Apr 29, 2021
a596af3
Fix server error handling of error registration from PR feedback
kggilmer Apr 29, 2021
80c4323
Merge branch 'fix-http-error-registration' of github.com:awslabs/aws-…
kggilmer Apr 29, 2021
1e8ed70
Updates from PR feedback
kggilmer May 3, 2021
5382c98
Merge branch 'main' into fix-http-error-registration
kggilmer May 3, 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
12 changes: 8 additions & 4 deletions ...-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/protocols/json/RestJsonErrorMiddleware.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ import aws.sdk.kotlin.codegen.AwsKotlinDependency
import aws.sdk.kotlin.codegen.protocols.middleware.ModeledExceptionsMiddleware
import software.amazon.smithy.kotlin.codegen.core.KotlinWriter
import software.amazon.smithy.kotlin.codegen.core.addImport
import software.amazon.smithy.kotlin.codegen.model.expectTrait
import software.amazon.smithy.kotlin.codegen.model.getTrait
import software.amazon.smithy.kotlin.codegen.rendering.protocol.HttpBindingResolver
import software.amazon.smithy.kotlin.codegen.rendering.protocol.ProtocolGenerator
import software.amazon.smithy.model.traits.ErrorTrait
import software.amazon.smithy.model.traits.HttpErrorTrait

class RestJsonErrorMiddleware(
Expand All @@ -31,10 +34,11 @@ class RestJsonErrorMiddleware(
val code = errShape.id.name
val symbol = ctx.symbolProvider.toSymbol(errShape)
val deserializerName = "${symbol.name}Deserializer"
val httpStatusCode: Int? = errShape.getTrait(HttpErrorTrait::class.java).map { it.code }.orElse(null)
if (httpStatusCode != null) {
writer.write("register(code = #S, deserializer = $deserializerName(), httpStatusCode = $httpStatusCode)", code)
}
// If model specifies error code use it otherwise default to 400 (client) or 500 (server)
// See https://awslabs.github.io/smithy/1.0/spec/core/http-traits.html#httperror-trait
val defaultCode = if (errShape.expectTrait<ErrorTrait>().isClientError) 400 else 500
val httpStatusCode = errShape.getTrait<HttpErrorTrait>()?.code ?: defaultCode
writer.write("register(code = #S, deserializer = $deserializerName(), httpStatusCode = $httpStatusCode)", code)
}
}
}
10 changes: 7 additions & 3 deletions ...in-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/protocols/xml/RestXmlErrorMiddleware.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ import aws.sdk.kotlin.codegen.AwsKotlinDependency
import aws.sdk.kotlin.codegen.protocols.middleware.ModeledExceptionsMiddleware
import software.amazon.smithy.kotlin.codegen.core.KotlinWriter
import software.amazon.smithy.kotlin.codegen.core.addImport
import software.amazon.smithy.kotlin.codegen.model.expectTrait
import software.amazon.smithy.kotlin.codegen.model.getTrait
import software.amazon.smithy.kotlin.codegen.rendering.protocol.HttpBindingResolver
import software.amazon.smithy.kotlin.codegen.rendering.protocol.ProtocolGenerator
import software.amazon.smithy.model.traits.ErrorTrait
import software.amazon.smithy.model.traits.HttpErrorTrait

class RestXmlErrorMiddleware(
Expand All @@ -32,9 +34,11 @@ class RestXmlErrorMiddleware(
val code = errShape.id.name
val symbol = ctx.symbolProvider.toSymbol(errShape)
val deserializerName = "${symbol.name}Deserializer"
errShape.getTrait<HttpErrorTrait>()?.code?.let { httpStatusCode ->
writer.write("register(code = #S, deserializer = $deserializerName(), httpStatusCode = $httpStatusCode)", code)
}
// If model specifies error code use it otherwise default to 400 (client) or 500 (server)
// See https://awslabs.github.io/smithy/1.0/spec/core/http-traits.html#httperror-trait
val defaultCode = if (errShape.expectTrait<ErrorTrait>().isClientError) 400 else 500
val httpStatusCode = errShape.getTrait<HttpErrorTrait>()?.code ?: defaultCode
writer.write("register(code = #S, deserializer = $deserializerName(), httpStatusCode = $httpStatusCode)", code)
}
}
}
105 changes: 105 additions & 0 deletions ...degen/src/test/kotlin/aws/sdk/kotlin/codegen/protocols/json/AwsJsonErrorMiddlewareTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
package aws.sdk.kotlin.codegen.protocols.json

import org.junit.jupiter.api.Test
import software.amazon.smithy.kotlin.codegen.rendering.protocol.HttpTraitResolver
import software.amazon.smithy.kotlin.codegen.test.*

class AwsJsonErrorMiddlewareTest {

@Test
fun `it registers error deserializers for client error shapes`() {
val model = """
@http(method: "PUT", uri: "/test", code: 200)
operation TestOperation {
output: TestResponse,
errors: [TestError]
}

structure TestResponse {
someVal: Integer
}

@error("client")
structure TestError {
someCode: Integer,
someMessage: String
}
""".prependNamespaceAndService(operations = listOf("TestOperation"))
.toSmithyModel()

val (ctx, _, _) = model.newTestContext()

val unit = RestJsonErrorMiddleware(ctx, AwsJsonHttpBindingResolver(ctx, "application/x-amz-json-1.0"))

val actual = generateCode { writer ->
unit.renderRegisterErrors(writer)
}

actual.shouldContainOnlyOnceWithDiff("register(code = \"TestError\", deserializer = TestErrorDeserializer(), httpStatusCode = 400)")
}

@Test
fun `it registers error deserializers for server error shapes`() {
val model = """
@http(method: "PUT", uri: "/test", code: 200)
operation TestOperation {
output: TestResponse,
errors: [TestError]
}

structure TestResponse {
someVal: Integer
}

@error("server")
structure TestError {
someCode: Integer,
someMessage: String
}
""".prependNamespaceAndService(operations = listOf("TestOperation"))
.toSmithyModel()

val (ctx, _, _) = model.newTestContext()

val unit = RestJsonErrorMiddleware(ctx, AwsJsonHttpBindingResolver(ctx, "application/x-amz-json-1.0"))

val actual = generateCode { writer ->
unit.renderRegisterErrors(writer)
}

actual.shouldContainOnlyOnceWithDiff("register(code = \"TestError\", deserializer = TestErrorDeserializer(), httpStatusCode = 500)")
}

@Test
fun `it registers error deserializer with custom code for error shapes`() {
val model = """
@http(method: "PUT", uri: "/test", code: 200)
operation TestOperation {
output: TestResponse,
errors: [TestError]
}

structure TestResponse {
someVal: Integer
}

@error("client")
@httpError(404)
structure TestError {
someCode: Integer,
someMessage: String
}
""".prependNamespaceAndService(operations = listOf("TestOperation"))
.toSmithyModel()

val (ctx, _, _) = model.newTestContext()

val unit = RestJsonErrorMiddleware(ctx, HttpTraitResolver(ctx, "application/xml"))

val actual = generateCode { writer ->
unit.renderRegisterErrors(writer)
}

actual.shouldContainOnlyOnceWithDiff("register(code = \"TestError\", deserializer = TestErrorDeserializer(), httpStatusCode = 404)")
}
}
105 changes: 105 additions & 0 deletions ...odegen/src/test/kotlin/aws/sdk/kotlin/codegen/protocols/xml/RestXmlErrorMiddlewareTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
package aws.sdk.kotlin.codegen.protocols.xml

import org.junit.jupiter.api.Test
import software.amazon.smithy.kotlin.codegen.rendering.protocol.HttpTraitResolver
import software.amazon.smithy.kotlin.codegen.test.*

class RestXmlErrorMiddlewareTest {

@Test
fun `it registers error deserializers for client error shapes`() {
val model = """
@http(method: "PUT", uri: "/test", code: 200)
operation TestOperation {
output: TestResponse,
errors: [TestError]
}

structure TestResponse {
someVal: Integer
}

@error("client")
structure TestError {
someCode: Integer,
someMessage: String
}
""".prependNamespaceAndService(operations = listOf("TestOperation"))
.toSmithyModel()

val (ctx, _, _) = model.newTestContext()

val unit = RestXmlErrorMiddleware(ctx, HttpTraitResolver(ctx, "application/xml"))

val actual = generateCode { writer ->
unit.renderRegisterErrors(writer)
}

actual.shouldContainOnlyOnceWithDiff("register(code = \"TestError\", deserializer = TestErrorDeserializer(), httpStatusCode = 400)")
}

@Test
fun `it registers error deserializers for server error shapes`() {
val model = """
@http(method: "PUT", uri: "/test", code: 200)
operation TestOperation {
output: TestResponse,
errors: [TestError]
}

structure TestResponse {
someVal: Integer
}

@error("server")
structure TestError {
someCode: Integer,
someMessage: String
}
""".prependNamespaceAndService(operations = listOf("TestOperation"))
.toSmithyModel()

val (ctx, _, _) = model.newTestContext()

val unit = RestXmlErrorMiddleware(ctx, HttpTraitResolver(ctx, "application/xml"))

val actual = generateCode { writer ->
unit.renderRegisterErrors(writer)
}

actual.shouldContainOnlyOnceWithDiff("register(code = \"TestError\", deserializer = TestErrorDeserializer(), httpStatusCode = 500)")
}

@Test
fun `it registers error deserializer with custom code for error shapes`() {
val model = """
@http(method: "PUT", uri: "/test", code: 200)
operation TestOperation {
output: TestResponse,
errors: [TestError]
}

structure TestResponse {
someVal: Integer
}

@error("client")
@httpError(404)
structure TestError {
someCode: Integer,
someMessage: String
}
""".prependNamespaceAndService(operations = listOf("TestOperation"))
.toSmithyModel()

val (ctx, _, _) = model.newTestContext()

val unit = RestXmlErrorMiddleware(ctx, HttpTraitResolver(ctx, "application/xml"))

val actual = generateCode { writer ->
unit.renderRegisterErrors(writer)
}

actual.shouldContainOnlyOnceWithDiff("register(code = \"TestError\", deserializer = TestErrorDeserializer(), httpStatusCode = 404)")
}
}