-
Notifications
You must be signed in to change notification settings - Fork 8.4k
Invoke-WebRequest: Display downloaded bytes in human readable format and display total expected download size #14611
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
Merged
daxian-dbw
merged 23 commits into
PowerShell:master
from
bergmeister:InvokeWebrequest-Progress
Sep 19, 2022
Merged
Changes from 14 commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
c4b6ba6
Invoke-WebRequest: Display downloaded bytes in human readable format …
bergmeister f01fa76
fix typo
bergmeister 016c017
simplify diff and address style issues
bergmeister 7cf8c3d
Fix NullReferenceExceptions that caused test failures
bergmeister 58eab36
address PR comment around named parameter and tweak message
bergmeister 7557873
fix spacing issue of codefactor
bergmeister e7a3819
Apply the same pattern also to the code path that saves a stream to a…
bergmeister 49ca9f4
cap percentage at 100 as special test cases using -Resume parameter m…
bergmeister df87e7d
Calculate total download size only once
bergmeister 8ff6e01
Merge branch 'master' of https://github.com/bergmeister/PowerShell in…
bergmeister 1503a9e
Move DisplayHumanReadableFileSize into Utils.cs and cleanup using the…
bergmeister 19bd009
Merge branch 'master' of https://github.com/PowerShell/PowerShell int…
bergmeister 0b125c7
Use switch statement instead of doing maths to compute file size unit
bergmeister 6d59cab
Merge branch 'PowerShell:master' into InvokeWebrequest-Progress
bergmeister bfd8e27
Apply suggestions from code review(Byte -> Bytes)
bergmeister e4eb7ac
Fix upper range for GB and add more test cases
bergmeister b4c242b
Fix expected test result of new test cases
bergmeister a1b8a67
Merge branch 'master' of https://github.com/PowerShell/PowerShell int…
bergmeister df26c3a
Merge branch 'master' into InvokeWebrequest-Progress
SteveL-MSFT e8532db
Rename totalLength to totalRead to address Keith's comment: https://g…
bergmeister cae26c2
Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Web…
bergmeister 25185e5
Reverse order in switch statement of DisplayHumanReadableFileSize
bergmeister 5c95fca
Fix syntax error in last commit as switch statement requires default …
bergmeister File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ internal class WebResponseContentMemoryStream : MemoryStream | |
| { | ||
| #region Data | ||
|
|
||
| private readonly long? _contentLength; | ||
| private readonly Stream _originalStreamToProxy; | ||
| private bool _isInitialized = false; | ||
| private readonly Cmdlet _ownerCmdlet; | ||
|
|
@@ -37,9 +38,11 @@ internal class WebResponseContentMemoryStream : MemoryStream | |
| /// <param name="stream"></param> | ||
| /// <param name="initialCapacity"></param> | ||
| /// <param name="cmdlet">Owner cmdlet if any.</param> | ||
| internal WebResponseContentMemoryStream(Stream stream, int initialCapacity, Cmdlet cmdlet) | ||
| /// <param name="contentLength">Expected download size in Bytes.</param> | ||
| internal WebResponseContentMemoryStream(Stream stream, int initialCapacity, Cmdlet cmdlet, long? contentLength) | ||
| : base(initialCapacity) | ||
| { | ||
| this._contentLength = contentLength; | ||
| _originalStreamToProxy = stream; | ||
| _ownerCmdlet = cmdlet; | ||
| } | ||
|
|
@@ -221,11 +224,20 @@ private void Initialize() | |
| long totalLength = 0; | ||
| byte[] buffer = new byte[StreamHelper.ChunkSize]; | ||
| ProgressRecord record = new(StreamHelper.ActivityId, WebCmdletStrings.ReadResponseProgressActivity, "statusDescriptionPlaceholder"); | ||
| string totalDownloadSize = _contentLength is null ? "???" : Utils.DisplayHumanReadableFileSize((long)_contentLength); | ||
| for (int read = 1; read > 0; totalLength += read) | ||
| { | ||
| if (_ownerCmdlet != null) | ||
| { | ||
| record.StatusDescription = StringUtil.Format(WebCmdletStrings.ReadResponseProgressStatus, totalLength); | ||
| record.StatusDescription = StringUtil.Format( | ||
| WebCmdletStrings.ReadResponseProgressStatus, | ||
| Utils.DisplayHumanReadableFileSize(totalLength), | ||
| totalDownloadSize); | ||
| if (_contentLength != null && _contentLength > 0) | ||
| { | ||
| record.PercentComplete = Math.Min((int)(totalLength * 100 / (long)_contentLength), 100); | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Once you add |
||
| } | ||
|
|
||
| _ownerCmdlet.WriteProgress(record); | ||
|
|
||
| if (_ownerCmdlet.IsStopping) | ||
|
|
@@ -276,7 +288,7 @@ internal static class StreamHelper | |
|
|
||
| #region Static Methods | ||
|
|
||
| internal static void WriteToStream(Stream input, Stream output, PSCmdlet cmdlet, CancellationToken cancellationToken) | ||
| internal static void WriteToStream(Stream input, Stream output, PSCmdlet cmdlet, long? contentLength, CancellationToken cancellationToken) | ||
| { | ||
| if (cmdlet == null) | ||
| { | ||
|
|
@@ -289,11 +301,21 @@ internal static void WriteToStream(Stream input, Stream output, PSCmdlet cmdlet, | |
| ActivityId, | ||
| WebCmdletStrings.WriteRequestProgressActivity, | ||
| WebCmdletStrings.WriteRequestProgressStatus); | ||
| string totalDownloadSize = contentLength is null ? "???" : Utils.DisplayHumanReadableFileSize((long)contentLength); | ||
| try | ||
| { | ||
| do | ||
| { | ||
| record.StatusDescription = StringUtil.Format(WebCmdletStrings.WriteRequestProgressStatus, output.Position); | ||
| record.StatusDescription = StringUtil.Format( | ||
| WebCmdletStrings.WriteRequestProgressStatus, | ||
| Utils.DisplayHumanReadableFileSize(output.Position), | ||
| totalDownloadSize); | ||
|
|
||
| if (contentLength != null && contentLength > 0) | ||
| { | ||
| record.PercentComplete = Math.Min((int)(output.Position * 100 / (long)contentLength), 100); | ||
| } | ||
|
|
||
| cmdlet.WriteProgress(record); | ||
|
|
||
| Task.Delay(1000).Wait(cancellationToken); | ||
|
|
@@ -318,13 +340,14 @@ internal static void WriteToStream(Stream input, Stream output, PSCmdlet cmdlet, | |
| /// <param name="stream">Input stream.</param> | ||
| /// <param name="filePath">Output file name.</param> | ||
| /// <param name="cmdlet">Current cmdlet (Invoke-WebRequest or Invoke-RestMethod).</param> | ||
| /// <param name="contentLength">Expected download size in Bytes.</param> | ||
| /// <param name="cancellationToken">CancellationToken to track the cmdlet cancellation.</param> | ||
| internal static void SaveStreamToFile(Stream stream, string filePath, PSCmdlet cmdlet, CancellationToken cancellationToken) | ||
| internal static void SaveStreamToFile(Stream stream, string filePath, PSCmdlet cmdlet, long? contentLength, CancellationToken cancellationToken) | ||
| { | ||
| // If the web cmdlet should resume, append the file instead of overwriting. | ||
| FileMode fileMode = cmdlet is WebRequestPSCmdlet webCmdlet && webCmdlet.ShouldResume ? FileMode.Append : FileMode.Create; | ||
| using FileStream output = new(filePath, fileMode, FileAccess.Write, FileShare.Read); | ||
| WriteToStream(stream, output, cmdlet, cancellationToken); | ||
| WriteToStream(stream, output, cmdlet, contentLength, cancellationToken); | ||
| } | ||
|
|
||
| private static string StreamToString(Stream stream, Encoding encoding) | ||
|
|
||
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.