Bugfix-2071: Fixed bug where a double quote in the Formal Name would cause invalid strings.#2298
Open
dev-adas wants to merge 2 commits intobeeware:mainfrom
Open
Bugfix-2071: Fixed bug where a double quote in the Formal Name would cause invalid strings.#2298dev-adas wants to merge 2 commits intobeeware:mainfrom
dev-adas wants to merge 2 commits intobeeware:mainfrom
Conversation
freakboy3742
requested changes
May 19, 2025
Member
freakboy3742
left a comment
There was a problem hiding this comment.
As noted in person - we can't eliminate this at the level of the new wizard - in part because the new wizard is only one place for a formal name to be specified, but also because a quote is a valid formal name.
What we need here is more complete escaping across the board; but we can't do that on the Briefcase side, because the escaping used depends on the context in which the values is used.
freakboy3742
requested changes
May 20, 2025
Member
freakboy3742
left a comment
There was a problem hiding this comment.
This looks good - but it requires a test case to verify against future regressions.
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
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.
This addresses #2071 (details were also left on this comment #2071 (comment))
Formal Names with a double quote was causing invalid strings, this was causing the
post_gen_projecthook for MacOS to fail.Log error:
One proposed solution was to make the "fix" with
{{ cookiecutter.formal_name|replace('"', '\\"') }}on line 12 of the macOS post gen template scriptHowever, fixing this caused cascading issues (invalid strings) with the generation of the
briefcase.tomlcorresponding to the user's application build.See example for formal_name as
badFormalName"Solution:
Do not allow users to create an application with a formal name containing a double quote(s).
PR Checklist: