Skip to content

Enforce string key type in maps #36

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 2 commits into from
Jun 1, 2023
Merged

Enforce string key type in maps #36

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
be7f745
feat(semantic): Enforce string key type in maps
KCreate May 30, 2023
339878c
refactor(semantic): Implemented PR feedback
KCreate May 31, 2023
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
63 changes: 49 additions & 14 deletions semantic/src/main/kotlin/tools/samt/semantic/SemanticModelReferenceResolver.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,27 +111,62 @@ internal class SemanticModelReferenceResolver(
typeNode = expression.base,
fullNode = expression,
)
} else {
expression.reportError(controller) {
message("List must have exactly one type argument")
highlight("expected one type argument", expression.location)

if (expression.arguments.size == 2) {
help("Did you mean to use Map<Key, Value> instead?")
}
}
}
}

"Map" -> {
if (expression.arguments.size == 2) {
return ResolvedTypeReference(
type = MapType(
keyType = resolveAndLinkExpression(scope, expression.arguments[0]),
valueType = resolveAndLinkExpression(scope, expression.arguments[1]),
node = expression,
),
typeNode = expression.base,
fullNode = expression,
)
val (keyTypeNode, valueTypeNode) = expression.arguments
val keyType = resolveAndLinkExpression(scope, keyTypeNode)
val valueType = resolveAndLinkExpression(scope, valueTypeNode)

// error if keyType does not refer to string type
// serializing non-string types as keys is currently not supported,
// but types like integers or enums might be supported in the future
if (keyType.type != StringType) {
keyTypeNode.reportError(controller) {
message("Map key type must be String")
highlight("expected String", keyTypeNode.location)
}
} else {
return ResolvedTypeReference(
type = MapType(
keyType = keyType,
valueType = valueType,
node = expression,
),
typeNode = expression.base,
fullNode = expression,
)
}
} else {
expression.reportError(controller) {
message("Map must have exactly two type arguments")
highlight("expected two type arguments", expression.location)

if (expression.arguments.size == 1) {
help("Did you mean to use List<Value> instead?")
}
}
}
}

else -> {
expression.reportError(controller) {
message("Unsupported generic type")
highlight(expression.location)
help("Valid generic types are List<Value> and Map<Key, Value>")
}
}
}
expression.reportError(controller) {
message("Unsupported generic type")
highlight(expression.location)
help("Valid generic types are List<Value> and Map<Key, Value>")
}
}

Expand Down
22 changes: 19 additions & 3 deletions semantic/src/test/kotlin/tools/samt/semantic/SemanticModelTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,9 +453,25 @@ class SemanticModelTest {
""".trimIndent()
parseAndCheck(
source to listOf(
"Error: Unsupported generic type",
"Error: Unsupported generic type",
"Error: Unsupported generic type",
"Error: List must have exactly one type argument",
"Error: Map must have exactly two type arguments",
"Error: Map must have exactly two type arguments",
)
)
}

@Test
fun `cannot use non-string types as keys in maps`() {
val source = """
package foo

record Foo {
arg: Map<Int, String>
}
""".trimIndent()
parseAndCheck(
source to listOf(
"Error: Map key type must be String",
)
)
}
Expand Down