Update progress

Author: peombwa

src/readme.graph.md

@@ -564,10 +564,11 @@ directive:
         return $;
       } else {
         let outFileParameterRegex = /(^\s*)public\s*global::System\.String\s*OutFile\s*/gmi
-        if($.match(outFileParameterRegex)) {
-          let overrideOnOkCallRegex = /(^\s*)(overrideOnOk\(\s*responseMessage\s*,\s*response\s*,\s*ref\s*_returnNow\s*\);)/gmi
+        let streamResponseRegex = /global::System\.Threading\.Tasks\.Task<global::System\.IO\.Stream>\s*response/gmi
+        if($.match(outFileParameterRegex) && $.match(streamResponseRegex)) {
           // Handle file download.
-          $ = $.replace(overrideOnOkCallRegex, '$1$2\n$1using(var stream = await response){ this.WriteToFile(stream, this.GetProviderPath(OutFile, false), _cancellationTokenSource.Token); _returnNow = global::System.Threading.Tasks.Task<bool>.FromResult(true);}\n$1');
+          let overrideOnOkCallRegex = /(^\s*)(overrideOnOk\(\s*responseMessage\s*,\s*response\s*,\s*ref\s*_returnNow\s*\);)/gmi
+          $ = $.replace(overrideOnOkCallRegex, '$1$2\n$1using(var stream = await response){ this.WriteToFile(responseMessage, stream, this.GetProviderPath(OutFile, false), _cancellationTokenSource.Token); _returnNow = global::System.Threading.Tasks.Task<bool>.FromResult(true);}\n$1');
         }
         return $;
       }
@@ -592,7 +593,7 @@ directive:
 
           // Handle file upload.
           let processRecordCallRegex = /(^\s*)(asyncCommandRuntime\.Wait\(\s*ProcessRecordAsync\s*\(\))/gmi
-          $ = $.replace(processRecordCallRegex, 'if (!MyInvocation.BoundParameters.ContainsKey(nameof(BodyParameter))){BodyParameter = GetFileAsStream() ?? BodyParameter;}\n$1$2');
+          $ = $.replace(processRecordCallRegex, '$1if (!MyInvocation.BoundParameters.ContainsKey(nameof(BodyParameter))){BodyParameter = GetFileAsStream() ?? BodyParameter;}\n$1$2');
         }
         return $;
       }

tools/Custom/PSCmdletExtensions.cs

@@ -8,6 +8,7 @@ namespace Microsoft.Graph.PowerShell
     using System.Collections.ObjectModel;
     using System.IO;
     using System.Management.Automation;
+    using System.Net.Http;
     using System.Threading;
     using System.Threading.Tasks;
 
@@ -58,47 +59,63 @@ internal static string GetProviderPath(this PSCmdlet cmdlet, string filePath, bo
         /// Saves a stream to a file on disk.
         /// </summary>
         /// <param name="cmdlet">The calling <see cref="PSCmdlet"/>.</param>
+        /// <param name="response">The HTTP response from the service.</param>
         /// <param name="inputStream">The stream to write to file.</param>
         /// <param name="filePath">The path to write the file to. This should include the file name and extension.</param>
         /// <param name="cancellationToken">A cancellation token that will be used to cancel the operation by the user.</param>
-        internal static void WriteToFile(this PSCmdlet cmdlet, Stream inputStream, string filePath, CancellationToken cancellationToken)
+        internal static void WriteToFile(this PSCmdlet cmdlet, HttpResponseMessage response, Stream inputStream, string filePath, CancellationToken cancellationToken)
         {
             using (var fileProvider = ProtectedFileProvider.CreateFileProvider(filePath, FileProtection.ExclusiveWrite, new DiskDataStore()))
             {
-                cmdlet.WriteToStream(inputStream, fileProvider.Stream, cancellationToken);
+                string downloadUrl = response?.RequestMessage?.RequestUri.ToString();
+                cmdlet.WriteToStream(inputStream, fileProvider.Stream, downloadUrl, cancellationToken);
             }
         }
 
         /// <summary>
-        /// Write an input stream to an output stream.
+        /// Writes an input stream to an output stream.
         /// </summary>
         /// <param name="cmdlet">The calling <see cref="PSCmdlet"/>.</param>
         /// <param name="inputStream">The stream to write to an output stream.</param>
         /// <param name="outputStream">The stream to write the input stream to.</param>
         /// <param name="cancellationToken">A cancellation token that will be used to cancel the operation by the user.</param>
-        private static void WriteToStream(this PSCmdlet cmdlet, Stream inputStream, Stream outputStream, CancellationToken cancellationToken)
+        private static void WriteToStream(this PSCmdlet cmdlet, Stream inputStream, Stream outputStream, string downloadUrl, CancellationToken cancellationToken)
         {
-            var copyTask = inputStream.CopyToAsync(outputStream);
-            var record = new ProgressRecord(000000000, "WriteRequestProgressActivity", "WriteRequestProgressStatus");
+            Task copyTask = inputStream.CopyToAsync(outputStream);
+            ProgressRecord record = new ProgressRecord(
+                activityId: 0,
+                activity: $"Downloading {downloadUrl ?? "file"}",
+                statusDescription: $"{outputStream.Position} of {outputStream.Length} bytes downloaded.");
             try
             {
                 do
                 {
-                    record.StatusDescription = string.Format("Number of bytes processed {0}", outputStream.Position);
-                    cmdlet.WriteProgress(record);
+                    cmdlet.WriteProgress(GetProgress(record, outputStream));
 
                     Task.Delay(1000, cancellationToken).Wait(cancellationToken);
                 } while (!copyTask.IsCompleted && !cancellationToken.IsCancellationRequested);
 
                 if (copyTask.IsCompleted)
                 {
-                    record.StatusDescription = string.Format("Number of bytes processed {0}", outputStream.Position);
-                    cmdlet.WriteProgress(record);
+                    cmdlet.WriteProgress(GetProgress(record, outputStream));
                 }
             }
             catch (OperationCanceledException)
             {
             }
         }
+
+        /// <summary>
+        /// Calculates and updates the progress record of the provided stream.
+        /// </summary>
+        /// <param name="currentProgressRecord">The <see cref="ProgressRecord"/> to update.</param>
+        /// <param name="stream">The stream to calculate its progress.</param>
+        /// <returns>An updated <see cref="ProgressRecord"/>.</returns>
+        private static ProgressRecord GetProgress(ProgressRecord currentProgressRecord, Stream stream)
+        {
+            currentProgressRecord.StatusDescription = $"{stream.Position} of {stream.Length} bytes downloaded.";
+            currentProgressRecord.PercentComplete = (int)Math.Round((double)(100 * stream.Position) / stream.Length);
+            return currentProgressRecord;
+        }
     }
 }