fix(csharp-codegen): escape C# reserved keywords in generated identifiers#4535
Open
stablegenius49 wants to merge 2 commits intoclockworklabs:masterfrom
Open
fix(csharp-codegen): escape C# reserved keywords in generated identifiers#4535stablegenius49 wants to merge 2 commits intoclockworklabs:masterfrom
stablegenius49 wants to merge 2 commits intoclockworklabs:masterfrom
Conversation
…iers - Add Identifier property to MemberDeclaration that prefixes C# keywords with @ - Use SyntaxFacts.GetKeywordKind to detect reserved keywords - Update all code generation sites to use Identifier instead of Name - Add test for keyword field names (class, params) in tables/reducers/procedures Fixes clockworklabs#4529
|
|
Collaborator
|
Thank you for opening a PR for this! We'll work on getting it reviewed. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR fixes an issue where C# reserved keywords (like
params,class,event, etc.) used as field or parameter names in SpacetimeDB types would cause compilation errors in the generated code.Problem
When a user defines a table or reducer with a field named using a C# reserved keyword:
The codegen would generate invalid C# like:
Solution
Added an
Identifierproperty toMemberDeclarationin the codegen that automatically detects C# reserved keywords usingSyntaxFacts.GetKeywordKind()and prefixes them with@when needed.Updated all code generation sites to use
Identifierinstead ofNamewhen generating:Added a regression test that verifies tables, reducers, and procedures with keyword field names compile successfully.
Test Plan
CSharpKeywordIdentifiersAreEscapedInGeneratedCodetest that creates a table with@classand@paramsfields, plus a reducer and procedure with keyword parametersFormerlyForbiddenFieldNamesfixture which already tests edge cases likeRead,Write,GetAlgebraicType)Fixes #4529