Skip to content

Add OutFile property in WebResponseObject #24047

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.

Sign up for GitHub

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

Merged
daxian-dbw merged 5 commits into from
Jul 23, 2024
Merged

Add OutFile property in WebResponseObject #24047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
40781e0
Added OutFile as a property of WebResponseObject. Output file path wi…
Jul 11, 2024
2f5adf1
Merge branch 'master' into issue-21082-fix
jshigetomi Jul 17, 2024
063e741
internal set
Jul 18, 2024
c5438a5
Merge branch 'issue-21082-fix' of https://github.com/jshigetomi/Power…
Jul 18, 2024
b7c05f6
Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Web…
daxian-dbw Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ...PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ public class WebResponseObject
/// </summary>
public string StatusDescription => WebResponseHelper.GetStatusDescription(BaseResponse);

/// <summary>
/// Gets or sets the output file path.
/// </summary>
public string? OutFile { get; internal set; }

#endregion Properties

#region Protected Fields
Expand Down
7 changes: 4 additions & 3 deletions ...ll.Commands.Utility/commands/utility/WebCmdlet/CoreCLR/InvokeWebRequestCommand.CoreClr.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ internal override void ProcessResponse(HttpResponseMessage response)
ArgumentNullException.ThrowIfNull(response);
TimeSpan perReadTimeout = ConvertTimeoutSecondsToTimeSpan(OperationTimeoutSeconds);
Stream responseStream = StreamHelper.GetResponseStream(response, _cancelToken.Token);
string outFilePath = WebResponseHelper.GetOutFilePath(response, _qualifiedOutFile);

if (ShouldWriteToPipeline)
{
// Creating a MemoryStream wrapper to response stream here to support IsStopping.
Expand All @@ -50,6 +52,7 @@ internal override void ProcessResponse(HttpResponseMessage response)
_cancelToken.Token);
WebResponseObject ro = WebResponseHelper.IsText(response) ? new BasicHtmlWebResponseObject(response, responseStream, perReadTimeout, _cancelToken.Token) : new WebResponseObject(response, responseStream, perReadTimeout, _cancelToken.Token);
ro.RelationLink = _relationLink;
ro.OutFile = outFilePath;
WriteObject(ro);

// Use the rawcontent stream from WebResponseObject for further
Expand All @@ -61,9 +64,7 @@ internal override void ProcessResponse(HttpResponseMessage response)

if (ShouldSaveToOutFile)
{
string outFilePath = WebResponseHelper.GetOutFilePath(response, _qualifiedOutFile);

WriteVerbose(string.Create(System.Globalization.CultureInfo.InvariantCulture, $"File Name: {Path.GetFileName(outFilePath)}"));
WriteVerbose($"File Name: {Path.GetFileName(outFilePath)}");

// ContentLength is always the partial length, while ContentRange is the full length
// Without Request.Range set, ContentRange is null and partial length (ContentLength) equals to full length
Expand Down
23 changes: 22 additions & 1 deletion test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -786,6 +786,28 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
Get-Item $outFile | Select-Object -ExpandProperty Length | Should -Be $content.Content.Length
}

It "Invoke-WebRequest -PassThru -OutFile <directory> saves the downloaded file path as a property in WebResponseObject"{
$uri = Get-WebListenerUrl -Test 'Get'
$content = Invoke-WebRequest -Uri $uri -PassThru -OutFile $TestDrive
$content.OutFile | Should -exist
$content.OutFile | Should -Be (Join-Path $TestDrive 'Get')
}

It "Invoke-WebRequest -PassThru -OutFile <file> saves the downloaded file path as a property in WebResponseObject"{
$uri = Get-WebListenerUrl -Test 'Get'
$filePath = Join-Path $TestDrive "pestertest-outfile"
$content = Invoke-WebRequest -Uri $uri -PassThru -OutFile $filePath
$content.OutFile | Should -exist
$content.OutFile | Should -Be $filePath
}

It "Invoke-WebRequest -PassThru -OutFile -Verbose File Name reflects the downloaded file name" {
$uri = Get-WebListenerUrl -Test 'Get'
$filePath = Join-Path $TestDrive "pestertest-outfile"
$content = Invoke-WebRequest -Verbose -Uri $uri -PassThru -OutFile $filePath 4>variable:verbo
$verbo[-1].Message | Should -Match "pestertest-outfile"
}

It "Invoke-WebRequest should fail if -OutFile is <Name>." -TestCases @(
@{ Name = "empty"; Value = [string]::Empty }
@{ Name = "null"; Value = $null }
Expand Down Expand Up @@ -4638,7 +4660,6 @@ Describe 'Invoke-WebRequest and Invoke-RestMethod support OperationTimeoutSecond
}
}


Describe "Invoke-RestMethod should run in the default synchronization context (threadpool)" -Tag "CI" {
BeforeAll {
$oldProgress = $ProgressPreference
Expand Down