[haskell-servant][haskell-yesod] Fix specialCharReplacements#16289
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Aug 10, 2023
Merged
Conversation
HaskellServantCodegen and HaskellYesodServerCodegen modify
specialCharReplacements by replacing its keys: backslash ("\\") with
"\\\\" and "\"" with "\\\"".
It seems that those replacements were for using the keys in string
literals in the specialChars table in the generated code. However,
modifying the keys causes the substitution of those characters in
field names not to work, making generated code syntactically invalid.
Since the specialChars table has already been removed, we can safely
stop modifying the specialCharReplacements.
Member
|
Tested locally to confirm both the issue and the fix. Thanks for the PR. I'll file a separate PR to add some tests. |
6 tasks
Member
|
Merged #16290 to add some tests and github workflow. |
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.
HaskellServantCodegenandHaskellYesodServerCodegenmodifyspecialCharReplacementsby replacing its keys: backslash (\) with\\and"with\".It seems that those replacements were for using the keys in string literals in the
specialCharstable in the generated code.I.e. we want to have
("\\", "Back_Slash")instead of("\", "Back_Slash")and("\"", "Double_Quote")instead of(""", "Double_Quote")in the table below.openapi-generator/samples/server/petstore/haskell-servant/lib/OpenAPIPetstore/Types.hs
Lines 158 to 196 in 81c398e
However, modifying the keys causes the substitution of those characters in field names not to work, making generated code syntactically invalid. Suppose we have the following spec:
Those generators generate the following data type definition, but
helloResponse"andhelloResponse\are invalid identifiers in Haskell.Since the
specialCharstable has already been removed in #16232, we can safely stop modifying thespecialCharReplacements, thereby generated code for the above example become the following syntactically correct code.I believe that this change maintains backward compatibility, as it only fixes cases where it has not been working (when field names contain backslashes or double quotes).
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master(6.3.0) (minor release - breaking changes with fallbacks),7.0.x(breaking changes without fallbacks)