Skip to content

Only generate @error message getter when defined in the model #1441

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
david-perez merged 2 commits into from
Jun 8, 2022
Merged

Only generate @error message getter when defined in the model #1441

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
d565a05
Only generate `@error` `message` getter when defined in the model
david-perez Jun 3, 2022
a7f2aca
Merge branch 'main' into davidpz/only-generate-_@error_-_message_-get…
david-perez Jun 8, 2022
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
27 changes: 14 additions & 13 deletions ...main/kotlin/software/amazon/smithy/rust/codegen/smithy/generators/error/ErrorGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,6 @@ class ErrorGenerator(
val symbol = symbolProvider.toSymbol(shape)
val messageShape = shape.errorMessageMember()
val errorKindT = RuntimeType.errorKind(symbolProvider.config().runtimeConfig)
val (returnType, message) = messageShape?.let {
if (symbolProvider.toSymbol(messageShape).isOptional()) {
"Option<&str>" to "self.${symbolProvider.toMemberName(it)}.as_deref()"
} else {
"&str" to "self.${symbolProvider.toMemberName(it)}.as_ref()"
}
} ?: "Option<&str>" to "None"
writer.rustBlock("impl ${symbol.name}") {
val retryKindWriteable = shape.modeledRetryKind(error)?.writable(symbolProvider.config().runtimeConfig)
if (retryKindWriteable != null) {
Expand All @@ -84,12 +77,20 @@ class ErrorGenerator(
retryKindWriteable(this)
}
}
rust(
"""
/// Returns the error message.
pub fn message(&self) -> $returnType { $message }
"""
)
if (messageShape != null) {
val (returnType, message) = if (symbolProvider.toSymbol(messageShape).isOptional()) {
"Option<&str>" to "self.${symbolProvider.toMemberName(messageShape)}.as_deref()"
} else {
"&str" to "self.${symbolProvider.toMemberName(messageShape)}.as_ref()"
}

rust(
"""
/// Returns the error message.
pub fn message(&self) -> $returnType { $message }
"""
)
}

/*
* If we're generating for a server, the `name` method is added to enable
Expand Down
6 changes: 3 additions & 3 deletions ...rc/main/kotlin/software/amazon/smithy/rust/codegen/smithy/transformers/AddErrorMessage.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ import java.util.logging.Logger
fun StructureShape.errorMessageMember(): MemberShape? = this.getMember("message").or { this.getMember("Message") }.orNull()

/**
* Ensure that all errors have error messages
* Ensure that all errors have error messages.
*
* Not all errors are modeled with an error message field. However, in many cases, the server can still send an error.
* If an error, specifically, a structure shape with the error trait does not have a member `message` or `Message`,
* this transformer will add a `message` member targetting a string.
* this transformer will add a `message` member targeting a string.
*
* This ensures that we always generate a modeled error message field enabling end users to easily extract the error
* message when present.
Expand All @@ -33,7 +33,7 @@ object AddErrorMessage {
private val logger = Logger.getLogger("AddErrorMessage")

/**
* Ensure that all errors have error messages
* Ensure that all errors have error messages.
*/
fun transform(model: Model): Model {
return ModelTransformer.create().mapShapes(model) { shape ->
Expand Down