feat: support Smithy default trait
#857
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "id": "d3ec877c-68c6-4c21-881f-8767d1f87e1c", | ||
| "type": "feature", | ||
| "description": "Support Smithy default trait", | ||
| "issues": [ | ||
| "https://github.com/awslabs/smithy-kotlin/issues/718" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,8 +18,11 @@ object SymbolProperty { | |
| // The key that holds the default value for a type (symbol) as a string | ||
| const val DEFAULT_VALUE_KEY: String = "defaultValue" | ||
|
|
||
| // The key that holds the type of default value | ||
| const val DEFAULT_VALUE_TYPE_KEY: String = "defaultValueType" | ||
|
|
||
| // Boolean property indicating this symbol is nullable | ||
| const val NULLABLE_KEY: String = "nullable" | ||
|
|
||
| // the original shape the symbol was created from | ||
| const val SHAPE_KEY: String = "shape" | ||
|
|
@@ -47,21 +50,21 @@ object SymbolProperty { | |
| } | ||
|
|
||
| /** | ||
| * Test if a symbol is nullable | ||
| */ | ||
| val Symbol.isNullable: Boolean | ||
| get() = getProperty(SymbolProperty.NULLABLE_KEY).map { | ||
| when (it) { | ||
| is Boolean -> it | ||
| else -> false | ||
| } | ||
| }.orElse(false) | ||
|
|
||
| /** | ||
| * Test if a symbol is not nullable | ||
| */ | ||
| val Symbol.isNotNullable: Boolean | ||
| get() = !isNullable | ||
|
|
||
| enum class PropertyTypeMutability { | ||
| /** | ||
|
|
@@ -82,6 +85,21 @@ enum class PropertyTypeMutability { | |
| } | ||
| } | ||
|
|
||
| enum class DefaultValueType { | ||
| /** | ||
| * A default value which has been inferred, such as 0f for floats and false for booleans | ||
| */ | ||
| INFERRED, | ||
|
|
||
| /** | ||
| * A default value which has been modeled using Smithy's default trait. | ||
| */ | ||
| MODELED, | ||
| } | ||
|
|
||
| val Symbol.defaultValueType: DefaultValueType? | ||
| get() = getProperty(SymbolProperty.DEFAULT_VALUE_TYPE_KEY, DefaultValueType::class.java).getOrNull() | ||
|
|
||
| /** | ||
| * Get the property type mutability of this symbol if set. | ||
| */ | ||
|
|
@@ -92,27 +110,30 @@ val Symbol.propertyTypeMutability: PropertyTypeMutability? | |
|
|
||
| /** | ||
| * Gets the default value for the symbol if present, else null | ||
| * @param defaultNullable the string to pass back for nullable values | ||
| */ | ||
| fun Symbol.defaultValue(defaultNullable: String? = "null"): String? { | ||
| val default = getProperty(SymbolProperty.DEFAULT_VALUE_KEY, String::class.java) | ||
|
|
||
| // nullable types should default to null if there is no modeled default | ||
|
There was a problem hiding this comment. I probably don't understand how this all fits, but why is isNullable not sufficient? Seems simpler if it ended up like that. What test case would break without the There was a problem hiding this comment. The reason for the With public val foo: String? = "my modeled default value"Without public val foo: String? = null // (discards the modeled default value)There was a problem hiding this comment. I thought if something has a non-null default value, it won't be nullable. Atleast when it uses There was a problem hiding this comment. oh, but they can be nullable because of |
||
| if (isNullable && (!default.isPresent || defaultValueType == DefaultValueType.INFERRED)) { | ||
| return defaultNullable | ||
| } | ||
| return default.getOrNull() | ||
| } | ||
|
|
||
| /** | ||
| * Mark a symbol as being nullable (i.e. `T?`) | ||
| */ | ||
| fun Symbol.Builder.nullable(): Symbol.Builder = apply { putProperty(SymbolProperty.NULLABLE_KEY, true) } | ||
|
|
||
| /** | ||
| * Set the default value used when formatting the symbol | ||
| */ | ||
| fun Symbol.Builder.defaultValue(value: String?, type: DefaultValueType = DefaultValueType.INFERRED): Symbol.Builder = apply { | ||
| putProperty(SymbolProperty.DEFAULT_VALUE_KEY, value) | ||
| putProperty(SymbolProperty.DEFAULT_VALUE_TYPE_KEY, type) | ||
| } | ||
|
|
||
| /** | ||
| * Convenience function for specifying kotlin namespace | ||
|
|
@@ -177,7 +198,7 @@ val Symbol.shape: Shape? | |
| /** | ||
| * Get the nullable version of a symbol | ||
| */ | ||
| fun Symbol.asNullable(): Symbol = toBuilder().nullable().build() | ||
|
|
||
| /** | ||
| * Check whether a symbol represents an extension | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: so all number shapes having a INFERRED default value means the shape knows what the value would be, but the shape can be
nullabletoo, and it's thenullablecheck that'll decide how the code is generated, and if it is not nullable, only then that defaultValue is relevant? Trying to understand the motivation for maintaining INFERRED v/s MODELED.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The motivation behind
INFERRED/MODELEDis because we're using.defaultValue()in two ways now. The previous way is inferring that numbers and booleans have a default value (0, 0f, 0.0, false). The new way we use.defaultValue()is when it's modeled on a shape.If a shape has an
INFERREDdefault value but it's nullable, we set it to null. If a shape has aMODELEDdefault value but it's nullable, we will use the default value.