Add FileNameStar to MultipartFileContent in WebCmdlets #19467

CarloToso · 2023-04-07T18:38:37Z

PR Summary

Add FileNameStar to MultipartFileContent

The parameters filename and filename* differ only in that filename* uses the encoding defined in RFC 5987. When both filename and filename* are present in a single header field value, filename* is preferred over filename when both are understood [from https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition]

Now .Net add quotes as needed so remove the code.

PR Context

Removed linked issue as this PR doesn't fix that issue

PR Checklist

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

daxian-dbw · 2023-04-11T00:10:48Z

@CarloToso Can you please update the PR description with more context information about why adding FileNameStar? Also, can you please confirm whether it fixes #19456?

CarloToso · 2023-04-11T07:54:02Z

@daxian-dbw Updated the PR description, I can't confirm it fixes the issue because it depends on the endpoint that recieves the Multipart/Form-Data

daxian-dbw · 2023-04-11T17:08:37Z

Thanks @CarloToso. Let's wait for the user to verify the fix.
#19456 (comment)

ghost · 2023-04-19T02:00:59Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

TravisEz13 · 2023-05-01T22:03:16Z

This did not fix the customer's issue. Do we still want to proceed with this fix?

CarloToso · 2023-05-02T21:58:53Z

@TravisEz13 I think we should merge this PR anyway

iSazonov · 2023-05-03T07:55:29Z

This add useful standard behavior.

TravisEz13 · 2023-05-08T18:29:45Z

I pinged WG-Cmdlets to triage.

SteveL-MSFT · 2023-05-08T19:31:52Z

Looking at the HTTP specs, it seems that this is useful even though it doesn't solve the original problem.

JamesWTruher · 2023-05-08T19:34:34Z

if we're adding new or altering current behavior, there should be some validation.

JamesWTruher

This really should have some validation of the behavior.

JamesWTruher · 2023-05-08T19:38:05Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

-            // .NET does not enclose field names in quotes, however, modern browsers and curl do.
-            result.Headers.ContentDisposition.FileName = "\"" + file.Name + "\"";
+            result.Headers.ContentDisposition.FileName = file.Name;
+            result.Headers.ContentDisposition.FileNameStar = file.Name;


I think we should have tests for this new behavior.

~~Done~~
~~I'll fix it tomorrow~~
Done

pull-request-quantifier-deprecated · 2023-05-08T23:00:37Z

This PR has 38 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Small
Size       : +35 -3
Percentile : 15.2%

Total files changed: 2

Change summary by file extension:
.cs : +4 -3
.ps1 : +31 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

ghost · 2023-05-16T14:00:58Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

SteveL-MSFT · 2023-06-07T16:42:27Z

@PowerShell/wg-powershell-cmdlets discussed this briefly and agree on supporting FileNameStar. The linked issue is not resolved by this PR, so we removed the link to the issue.

SteveL-MSFT

Tests look good to me

JamesWTruher

thanks for adding the validation!

ghost · 2023-06-29T22:06:22Z

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

marekvinkler · 2024-02-02T08:02:28Z

It is possible this change is breaking Invoke-RestMethod calls with multipart/form-data, i.e.

$form = @{
  "file"      = Get-Item -Path $File
}
Invoke-RestMethod -Uri $Url -Method POST -Headers $headers -Form $form

results in an malformed request.

rkeithhill-keysight · 2024-06-27T23:52:12Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

-
-            // .NET does not enclose field names in quotes, however, modern browsers and curl do.
-            contentDisposition.Name = "\"" + LanguagePrimitives.ConvertTo<string>(fieldName) + "\"";
+            contentDisposition.Name = LanguagePrimitives.ConvertTo<string>(fieldName);


This broke IWR for us when we upgraded to 7.4. We use IWR in a publish script to upload a zip to an internal PERL / CGI-based website. AFAICT the PERL CGI module requires field name values to be quoted. See #23843

add FileNameStar to MultipartFileContent

f50bc9b

CarloToso requested a review from PaulHigin as a code owner April 7, 2023 18:38

ghost assigned TravisEz13 Apr 7, 2023

iSazonov reviewed Apr 8, 2023

View reviewed changes

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated Show resolved Hide resolved

remove "\""

008e384

iSazonov approved these changes Apr 8, 2023

View reviewed changes

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Apr 8, 2023

iSazonov changed the title ~~WebCmdlets add FileNameStar to MultipartFileContent~~ Add FileNameStar to MultipartFileContent in WebCmdlets Apr 8, 2023

daxian-dbw mentioned this pull request Apr 11, 2023

Invoke-RestMethod Multipart/Form-Data Filename encoding with non-ascii chars #19456

Closed

5 tasks

ghost added the Review - Needed The PR is being reviewed label Apr 19, 2023

daxian-dbw added WG-Cmdlets general cmdlet issues Needs-Triage The issue is new and needs to be triaged by a work group. labels May 1, 2023

ghost removed the Review - Needed The PR is being reviewed label May 1, 2023

TravisEz13 added Needs-Triage The issue is new and needs to be triaged by a work group. Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels May 1, 2023

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 2, 2023

SteveL-MSFT approved these changes May 8, 2023

View reviewed changes

JamesWTruher suggested changes May 8, 2023

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 8, 2023

add test

bcb932e

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 8, 2023

pull-request-quantifier-deprecated bot added the Extra Small label May 8, 2023

CarloToso added 3 commits May 9, 2023 00:39

add tests

54a1447

forgot -Be

60fba13

fix tests

50c3f74

CarloToso requested a review from JamesWTruher May 9, 2023 10:24

ghost added the Review - Needed The PR is being reviewed label May 16, 2023

StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jun 5, 2023

ghost removed the Review - Needed The PR is being reviewed label Jun 7, 2023

SteveL-MSFT removed the Needs-Triage The issue is new and needs to be triaged by a work group. label Jun 7, 2023

SteveL-MSFT approved these changes Jun 12, 2023

View reviewed changes

JamesWTruher approved these changes Jun 12, 2023

View reviewed changes

daxian-dbw merged commit 1822ad7 into PowerShell:master Jun 12, 2023

daxian-dbw removed the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jun 12, 2023

iSazonov mentioned this pull request May 28, 2024

Using Invoke-WebRequest POST to upload a file is broken #23843

Open

5 tasks

rkeithhill-keysight reviewed Jun 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add FileNameStar to MultipartFileContent in WebCmdlets #19467

Add FileNameStar to MultipartFileContent in WebCmdlets #19467

CarloToso commented Apr 7, 2023 •

edited by SteveL-MSFT

Loading

daxian-dbw commented Apr 11, 2023

CarloToso commented Apr 11, 2023

daxian-dbw commented Apr 11, 2023 •

edited

Loading

ghost commented Apr 19, 2023

TravisEz13 commented May 1, 2023

CarloToso commented May 2, 2023

iSazonov commented May 3, 2023

TravisEz13 commented May 8, 2023

SteveL-MSFT commented May 8, 2023

JamesWTruher commented May 8, 2023

JamesWTruher left a comment

JamesWTruher May 8, 2023

CarloToso May 8, 2023 •

edited

Loading

pull-request-quantifier-deprecated bot commented May 8, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

ghost commented May 16, 2023

SteveL-MSFT commented Jun 7, 2023 •

edited

Loading

SteveL-MSFT left a comment

JamesWTruher left a comment

ghost commented Jun 29, 2023

marekvinkler commented Feb 2, 2024

rkeithhill-keysight Jun 27, 2024 •

edited

Loading

Add FileNameStar to MultipartFileContent in WebCmdlets #19467

Add FileNameStar to MultipartFileContent in WebCmdlets #19467

Conversation

CarloToso commented Apr 7, 2023 • edited by SteveL-MSFT Loading

PR Summary

PR Context

PR Checklist

daxian-dbw commented Apr 11, 2023

CarloToso commented Apr 11, 2023

daxian-dbw commented Apr 11, 2023 • edited Loading

ghost commented Apr 19, 2023

TravisEz13 commented May 1, 2023

CarloToso commented May 2, 2023

iSazonov commented May 3, 2023

TravisEz13 commented May 8, 2023

SteveL-MSFT commented May 8, 2023

JamesWTruher commented May 8, 2023

JamesWTruher left a comment

Choose a reason for hiding this comment

JamesWTruher May 8, 2023

Choose a reason for hiding this comment

CarloToso May 8, 2023 • edited Loading

Choose a reason for hiding this comment

pull-request-quantifier-deprecated bot commented May 8, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

ghost commented May 16, 2023

SteveL-MSFT commented Jun 7, 2023 • edited Loading

SteveL-MSFT left a comment

Choose a reason for hiding this comment

JamesWTruher left a comment

Choose a reason for hiding this comment

ghost commented Jun 29, 2023

marekvinkler commented Feb 2, 2024

rkeithhill-keysight Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

CarloToso commented Apr 7, 2023 •

edited by SteveL-MSFT

Loading

daxian-dbw commented Apr 11, 2023 •

edited

Loading

CarloToso May 8, 2023 •

edited

Loading

SteveL-MSFT commented Jun 7, 2023 •

edited

Loading

rkeithhill-keysight Jun 27, 2024 •

edited

Loading