Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[PHP/Dart/Python] Correctly escape strings in single quotes (Fixes #17582) #19529

Conversation

JulianVennen
Copy link
Contributor

This PR fixes #17582 by correctly escaping strings inside the single quotes for the PHP, Dart and Python generators.
For the PHP generator, double quotes escaped by the default generator are unescaped because PHP treats '\"' as a string containing a backslash and a double quote.
I have verified that python and dart treat '\"' as a string containing just a double quote character.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Dart: @jaumard @josh-burton @amondnet @sbu-WBT @kuhnroyal @agilob @ahmednfwela
PHP: @jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon
Python: @cbornet @tomplus @krjakbrjak @fa0311 @multani

return escapeText(input).replace("'", "\\'");
}


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in abstract typescript codegen, it overrides escapeText to replace ' with \\'

what about follow the same without introducing escapeTextInSingleQuotes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are several issues with escaping single quotes by default that would also affect other generators:

  • Some languages (e.g., PHP) treat '\"' as a string containing a backslash and a double quote
  • ' is often used in text like parameter descriptions and would be escaped in comments, which leads to doc blocks like this:
    image
  • Escaping a single quote is illegal in some formats (e.g., JSON)

Ideally, the context a text is used in (e.g., JSON, single-quoted string, double-quoted string or comment) could be taken into account when a string is escaped, either by making them individual methods or by adding a parameter for that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the explanation. let me think about it and review accordingly

@JulianVennen JulianVennen requested a review from wing328 November 6, 2024 13:55
@wing328
Copy link
Member

wing328 commented Nov 9, 2024

thanks again for the PR

let's give it a try

@wing328 wing328 merged commit 6bd3d53 into OpenAPITools:master Nov 9, 2024
17 checks passed
@wing328 wing328 added this to the 7.10.0 milestone Nov 9, 2024
@JulianVennen JulianVennen deleted the enum-value-fix-escaping-single-quotes branch December 11, 2024 13:14
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] PHP/Dart/Python Generator does not escape single quotes in enum values
2 participants