Skip to content
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.

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

Change BrotliCompress response files to quote file paths #26077

Conversation

baronfel
Copy link
Member

@baronfel baronfel commented Jun 17, 2022

Description

Fixes a regression in the parsing/handling of response files (raised in #26061) by ensuring that file paths are quoted in response files generated by the brotli compression tool task. This ensures that the response files can be read by System.CommandLine, which updated and brought along this change in handling.

Given that this utility is the only report of this problem, we decided this was an acceptable fix for the issue. If it proves to be more widespread we can reimplement the old tokenization inside of Parser.cs.

If/when the other razor CLI tools migrate to System.CommandLine we'll need to do the same quoting of file paths.

Customer Impact

Users using the brotli compression feature cannot compile their applications if the application is in a path containing spaces. The user must rename containing folders to work around this at the moment.

Regression

Yes. Introduced in 6.0.302.

Testing

New tests verifying the contents of the generated response files were added for the Brotli Compression task.

Risk

The risk of taking this is low - it only impacts response file generation for the Brotli compression command, which is also authored in the SDK and not distributed anywhere else.

@baronfel baronfel changed the title quote anything that's a file path in our tooltasks Change BrotliCompress response files to quote file paths Jun 17, 2022
@baronfel baronfel marked this pull request as ready for review June 20, 2022 21:15
@baronfel baronfel force-pushed the fix-file-paths-in-response-files branch 3 times, most recently from 76b2ee2 to 77fafd2 Compare June 22, 2022 03:46
@baronfel baronfel requested review from captainsafia and a team June 22, 2022 13:00
@baronfel
Copy link
Member Author

This is targeted for the next 6.0.3xx servicing release to fix a regression, so it will need servicing consideration, but I still need review from code owners.

@baronfel baronfel added this to the 6.0.3xx milestone Jun 22, 2022
@captainsafia captainsafia requested review from a team and javiercn June 22, 2022 17:36
Copy link
Member

@javiercn javiercn left a comment

Choose a reason for hiding this comment

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

Brotli changes look good.

I can't speak about the NU1505 changes.

@baronfel
Copy link
Member Author

The NU1505 changes have also been validated by @wtgodbe (we think the build environment for full framework got ahead of us). We won't take those changes in 6.0.4xx and 7.0.1xx, since the core SDK problem has been fixed in those branches.

@wtgodbe
Copy link
Member

wtgodbe commented Jun 22, 2022

#26133 covered many of the NU1505 changes, may be worth rebasing

@baronfel
Copy link
Member Author

Solid point, I'll do that now.

@baronfel baronfel force-pushed the fix-file-paths-in-response-files branch from 77fafd2 to 908a64f Compare June 22, 2022 19:04
@baronfel
Copy link
Member Author

Closing this as we are going to revert the S.CL update now. Additional reports of the regression in 6.0.3xx have triggered this.

@baronfel baronfel closed this Jun 23, 2022
@baronfel baronfel removed this from the 6.0.3xx milestone Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants