Add installation progress

services/DevHome.Services.WindowsPackageManager/Contracts/IWinGet.cs

@@ -6,6 +6,7 @@
 using System.Threading.Tasks;
 using DevHome.Services.WindowsPackageManager.Models;
 using DevHome.Services.WindowsPackageManager.Services;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Contracts;
 
@@ -24,7 +25,7 @@ public interface IWinGet
     public Task InitializeAsync();
 
     /// <inheritdoc cref="IWinGetOperations.InstallPackageAsync"/>
-    public Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId);
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId);
 
     /// <inheritdoc cref="IWinGetOperations.GetPackagesAsync"/>
     public Task<IList<IWinGetPackage>> GetPackagesAsync(IList<WinGetPackageUri> packageUris);

services/DevHome.Services.WindowsPackageManager/Contracts/IWinGetOperations.cs

@@ -5,13 +5,14 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using DevHome.Services.WindowsPackageManager.Models;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Contracts.Operations;
 
 internal interface IWinGetOperations
 {
     /// <inheritdoc cref="IWinGetInstallOperation.InstallPackageAsync"/>"
-    public Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId);
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId);
 
     /// <inheritdoc cref="IWinGetGetPackageOperation.GetPackagesAsync"/>"
     public Task<IList<IWinGetPackage>> GetPackagesAsync(IList<WinGetPackageUri> packageUris);

services/DevHome.Services.WindowsPackageManager/Contracts/IWinGetPackageInstaller.cs

@@ -4,6 +4,8 @@
 using System;
 using System.Threading.Tasks;
 using DevHome.Services.WindowsPackageManager.Models;
+using Microsoft.Management.Deployment;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Contracts;
 
@@ -17,5 +19,5 @@ internal interface IWinGetPackageInstaller
     /// <param name="version">Version of the package to install</param>
     /// <param name="activityId">Activity id for telemetry</param>
     /// <returns>Result of the installation</returns>
-    public Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetCatalog catalog, string packageId, string version, Guid activityId);
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetCatalog catalog, string packageId, string version, Guid activityId);
 }

services/DevHome.Services.WindowsPackageManager/Contracts/Operations/IWinGetInstallOperation.cs

@@ -2,8 +2,8 @@
 // Licensed under the MIT License.
 
 using System;
-using System.Threading.Tasks;
 using DevHome.Services.WindowsPackageManager.Models;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Contracts;
 
@@ -15,5 +15,5 @@ internal interface IWinGetInstallOperation
     /// <param name="packageUri">Uri of the package to install.</param>
     /// <param name="activityId">Activity id for telemetry.</param>
     /// <returns>Result of the installation.</returns>
-    public Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId);
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId);
 }

services/DevHome.Services.WindowsPackageManager/Models/WinGetInstallPackageProgress.cs

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.Management.Deployment;
+
+namespace DevHome.Services.WindowsPackageManager.Models;
+
+/// <summary>
+/// Represents the progress of a Windows Package Manager installation
+/// operation.
+/// </summary>
+public sealed class WinGetInstallPackageProgress
+{
+    public WinGetInstallPackageProgress(
+        WinGetInstallPackageProgressState state,
+        double downloadProgress,
+        double installationProgress)
+    {
+        State = state;
+        DownloadProgress = downloadProgress;
+        InstallationProgress = installationProgress;
+    }
+
+    internal WinGetInstallPackageProgress(InstallProgress progress)
+    {
+        State = (WinGetInstallPackageProgressState)progress.State;
+        DownloadProgress = progress.DownloadProgress;
+        InstallationProgress = progress.InstallationProgress;
+    }
+
+    /// <summary>
+    /// Gets the current state of the installation operation.
+    /// </summary>
+    public WinGetInstallPackageProgressState State { get; }
+
+    /// <summary>
+    /// Gets the download percentage complete.
+    /// </summary>
+    public double DownloadProgress { get; }
+
+    /// <summary>
+    /// Gets the installation percentage complete.
+    /// </summary>
+    public double InstallationProgress { get; }
+}

services/DevHome.Services.WindowsPackageManager/Models/WinGetInstallPackageProgressState.cs

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace DevHome.Services.WindowsPackageManager.Models;
+
+/// <summary>
+/// Represents the state of the installation progress.
+/// </summary>
+/// <remarks>
+/// Reference: https://github.com/microsoft/winget-cli/blob/master/src/Microsoft.Management.Deployment/PackageManager.idl
+/// </remarks>
+public enum WinGetInstallPackageProgressState
+{
+    Queued = unchecked((int)0),
+    Downloading = unchecked((int)0x1),
+    Installing = unchecked((int)0x2),
+    PostInstall = unchecked((int)0x3),
+    Finished = unchecked((int)0x4),
+}

services/DevHome.Services.WindowsPackageManager/Services/Operations/WinGetInstallOperation.cs

@@ -2,10 +2,10 @@
 // Licensed under the MIT License.
 
 using System;
-using System.Threading.Tasks;
+using System.Runtime.InteropServices.WindowsRuntime;
 using DevHome.Services.WindowsPackageManager.Contracts;
-using DevHome.Services.WindowsPackageManager.Contracts.Operations;
 using DevHome.Services.WindowsPackageManager.Models;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Services.Operations;
 
@@ -32,12 +32,19 @@ public WinGetInstallOperation(
     }
 
     /// <inheritdoc />
-    public async Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId)
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId)
     {
-        return await _recovery.DoWithRecoveryAsync(async () =>
+        return AsyncInfo.Run<IWinGetInstallPackageResult, WinGetInstallPackageProgress>(async (_, progress) =>
         {
-            var catalog = await _protocolParser.ResolveCatalogAsync(packageUri);
-            return await _packageInstaller.InstallPackageAsync(catalog, packageUri.PackageId, packageUri.Options.Version, activityId);
+            // If recovery was initiated due to RPC failure, we need to
+            // re-attempt the operation and restart the progress reporting.
+            return await _recovery.DoWithRecoveryAsync(async () =>
+            {
+                var catalog = await _protocolParser.ResolveCatalogAsync(packageUri);
+                var install = _packageInstaller.InstallPackageAsync(catalog, packageUri.PackageId, packageUri.Options.Version, activityId);
+                install.Progress += (_, p) => progress.Report(p);
+                return await install;
+            });
         });
     }
 }

services/DevHome.Services.WindowsPackageManager/Services/WinGet.cs

@@ -7,6 +7,7 @@
 using DevHome.Services.WindowsPackageManager.Contracts;
 using DevHome.Services.WindowsPackageManager.Contracts.Operations;
 using DevHome.Services.WindowsPackageManager.Models;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Services;
 
@@ -46,7 +47,7 @@ public async Task InitializeAsync()
     }
 
     /// <inheritdoc/>
-    public async Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId) => await _operations.InstallPackageAsync(packageUri, activityId);
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId) => _operations.InstallPackageAsync(packageUri, activityId);
 
     /// <inheritdoc/>
     public async Task<IList<IWinGetPackage>> GetPackagesAsync(IList<WinGetPackageUri> packageUris) => await _operations.GetPackagesAsync(packageUris);

services/DevHome.Services.WindowsPackageManager/Services/WinGetOperations.cs

@@ -7,6 +7,7 @@
 using DevHome.Services.WindowsPackageManager.Contracts;
 using DevHome.Services.WindowsPackageManager.Contracts.Operations;
 using DevHome.Services.WindowsPackageManager.Models;
+using Windows.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Services;
 
@@ -27,7 +28,7 @@ public WinGetOperations(
     }
 
     /// <inheritdoc />
-    public async Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId) => await _installOperation.InstallPackageAsync(packageUri, activityId);
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetPackageUri packageUri, Guid activityId) => _installOperation.InstallPackageAsync(packageUri, activityId);
 
     /// <inheritdoc />
     public async Task<IList<IWinGetPackage>> GetPackagesAsync(IList<WinGetPackageUri> packageUris) => await _getPackageOperation.GetPackagesAsync(packageUris);

services/DevHome.Services.WindowsPackageManager/Services/WinGetPackageInstaller.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Runtime.InteropServices.WindowsRuntime;
 using System.Threading;
 using System.Threading.Tasks;
 using DevHome.Services.Core.Extensions;
@@ -13,6 +14,7 @@
 using DevHome.Telemetry;
 using Microsoft.Extensions.Logging;
 using Microsoft.Management.Deployment;
+using Windows.Foundation;
 using Windows.Win32.Foundation;
 
 namespace DevHome.Services.WindowsPackageManager.Services;
@@ -39,7 +41,7 @@ public WinGetPackageInstaller(
     }
 
     /// <inheritdoc />
-    public async Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetCatalog catalog, string packageId, string version, Guid activityId)
+    public IAsyncOperationWithProgress<IWinGetInstallPackageResult, WinGetInstallPackageProgress> InstallPackageAsync(WinGetCatalog catalog, string packageId, string version, Guid activityId)
     {
         if (catalog == null)
         {
@@ -51,29 +53,34 @@ public async Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetCatalog
 
         try
         {
-            // 1. Find package
-            var package = await FindPackageOrThrowAsync(catalog, packageId);
-
-            // 2. Install package
-            _logger.LogInformation($"Starting package installation for {packageId} from catalog {catalog.GetDescriptiveName()}");
-            var installResult = await InstallPackageInternalAsync(package, version, activityId);
-            var extendedErrorCode = installResult.ExtendedErrorCode?.HResult ?? HRESULT.S_OK;
-            var installErrorCode = installResult.GetValueOrDefault(res => res.InstallerErrorCode, HRESULT.S_OK); // WPM API V4
-
-            // 3. Report install result
-            _logger.LogInformation($"Install result: Status={installResult.Status}, InstallerErrorCode={installErrorCode}, ExtendedErrorCode={extendedErrorCode}, RebootRequired={installResult.RebootRequired}");
-            if (installResult.Status != InstallResultStatus.Ok)
+            return AsyncInfo.Run<IWinGetInstallPackageResult, WinGetInstallPackageProgress>(async (_, progress) =>
             {
-                throw new InstallPackageException(installResult.Status, extendedErrorCode, installErrorCode);
-            }
-
-            _logger.LogInformation($"Completed package installation for {packageId} from catalog {catalog.GetDescriptiveName()}");
-            TelemetryFactory.Get<ITelemetry>().Log("AppInstall_InstallSucceeded", Telemetry.LogLevel.Critical, new AppInstallResultEvent(package.Id, catalog.Catalog.Info.Id), activityId);
-            return new WinGetInstallPackageResult()
-            {
-                ExtendedErrorCode = extendedErrorCode,
-                RebootRequired = installResult.RebootRequired,
-            };
+                // 1. Find package
+                var package = await FindPackageOrThrowAsync(catalog, packageId);
+
+                // 2. Install package
+                _logger.LogInformation($"Starting package installation for {packageId} from catalog {catalog.GetDescriptiveName()}");
+                var install = InstallPackageInternalAsync(package, version, activityId);
+                install.Progress += (_, p) => progress.Report(new(p));
+                var installResult = await install;
+                var extendedErrorCode = installResult.ExtendedErrorCode?.HResult ?? HRESULT.S_OK;
+                var installErrorCode = installResult.GetValueOrDefault(res => res.InstallerErrorCode, HRESULT.S_OK); // WPM API V4
+
+                // 3. Report install result
+                _logger.LogInformation($"Install result: Status={installResult.Status}, InstallerErrorCode={installErrorCode}, ExtendedErrorCode={extendedErrorCode}, RebootRequired={installResult.RebootRequired}");
+                if (installResult.Status != InstallResultStatus.Ok)
+                {
+                    throw new InstallPackageException(installResult.Status, extendedErrorCode, installErrorCode);
+                }
+
+                _logger.LogInformation($"Completed package installation for {packageId} from catalog {catalog.GetDescriptiveName()}");
+                TelemetryFactory.Get<ITelemetry>().Log("AppInstall_InstallSucceeded", Telemetry.LogLevel.Critical, new AppInstallResultEvent(package.Id, catalog.Catalog.Info.Id), activityId);
+                return new WinGetInstallPackageResult()
+                {
+                    ExtendedErrorCode = extendedErrorCode,
+                    RebootRequired = installResult.RebootRequired,
+                };
+            });
         }
         catch
         {
@@ -88,7 +95,7 @@ public async Task<IWinGetInstallPackageResult> InstallPackageAsync(WinGetCatalog
     /// </summary>
     /// <param name="package">Package to install</param>
     /// <returns>Install result</returns>
-    private async Task<InstallResult> InstallPackageInternalAsync(CatalogPackage package, string version, Guid activityId)
+    private IAsyncOperationWithProgress<InstallResult, InstallProgress> InstallPackageInternalAsync(CatalogPackage package, string version, Guid activityId)
     {
         var installOptions = _wingetFactory.CreateInstallOptions();
         installOptions.PackageInstallMode = PackageInstallMode.Silent;
@@ -106,7 +113,7 @@ private async Task<InstallResult> InstallPackageInternalAsync(CatalogPackage pac
         }
 
         var packageManager = _wingetFactory.CreatePackageManager();
-        return await packageManager.InstallPackageAsync(package, installOptions).AsTask();
+        return packageManager.InstallPackageAsync(package, installOptions);
     }
 
     /// <summary>

tools/SetupFlow/DevHome.SetupFlow.ElevatedComponent/ElevatedComponentOperation.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System.Runtime.InteropServices.WindowsRuntime;
 using DevHome.Services.Core.Extensions;
 using DevHome.Services.DesiredStateConfiguration.Extensions;
 using DevHome.Services.WindowsPackageManager.Extensions;
@@ -63,18 +64,23 @@ public void WriteToStdOut(string value)
         Console.WriteLine(value);
     }
 
-    public IAsyncOperation<ElevatedInstallTaskResult> InstallPackageAsync(string packageId, string catalogName, string version, Guid activityId)
+    public IAsyncOperationWithProgress<ElevatedInstallTaskResult, ElevatedInstallTaskProgress> InstallPackageAsync(string packageId, string catalogName, string version, Guid activityId)
     {
         var taskArguments = GetInstallPackageTaskArguments(packageId, catalogName, version);
-        return ValidateAndExecuteAsync(
-            taskArguments,
-            async () =>
-            {
-                _logger.LogInformation($"Installing package elevated: '{packageId}' from '{catalogName}'");
-                var task = new ElevatedInstallTask();
-                return await task.InstallPackage(taskArguments.PackageId, taskArguments.CatalogName, version, activityId);
-            },
-            result => result.TaskSucceeded).AsAsyncOperation();
+        return AsyncInfo.Run<ElevatedInstallTaskResult, ElevatedInstallTaskProgress>(async (_, progress) =>
+        {
+            return await ValidateAndExecuteAsync(
+                taskArguments,
+                async () =>
+                {
+                    _logger.LogInformation($"Installing package elevated: '{packageId}' from '{catalogName}'");
+                    var task = new ElevatedInstallTask();
+                    var install = task.InstallPackageAsync(taskArguments.PackageId, taskArguments.CatalogName, version, activityId);
+                    install.Progress += (_, p) => progress.Report(p);
+                    return await install;
+                },
+                result => result.TaskSucceeded).AsAsyncOperation();
+        });
     }
 
     public IAsyncOperation<int> CreateDevDriveAsync()

tools/SetupFlow/DevHome.SetupFlow.ElevatedComponent/Helpers/ElevatedInstallTaskProgress.cs

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using DevHome.Services.WindowsPackageManager.Models;
+
+namespace DevHome.SetupFlow.ElevatedComponent.Helpers;
+
+public sealed class ElevatedInstallTaskProgress
+{
+    public ElevatedInstallTaskProgress(int state, double downloadProgress, double installationProgress)
+    {
+        State = state;
+        DownloadProgress = downloadProgress;
+        InstallationProgress = installationProgress;
+    }
+
+    internal ElevatedInstallTaskProgress(WinGetInstallPackageProgress progress)
+        : this((int)progress.State, progress.DownloadProgress, progress.InstallationProgress)
+    {
+    }
+
+    public int State { get; }
+
+    public double DownloadProgress { get; }
+
+    public double InstallationProgress { get; }
+}

tools/SetupFlow/DevHome.SetupFlow.ElevatedComponent/IElevatedComponentOperation.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using DevHome.SetupFlow.ElevatedComponent.Helpers;
+using DevHome.SetupFlow.ElevatedComponent.Tasks;
 using Windows.Foundation;
 
 namespace DevHome.SetupFlow.ElevatedComponent;
@@ -36,7 +37,7 @@ public interface IElevatedComponentOperation
     /// <param name="catalogName">Package catalog name</param>
     /// <param name="version">Package version</param>
     /// <returns>Install package operation result</returns>
-    public IAsyncOperation<ElevatedInstallTaskResult> InstallPackageAsync(string packageId, string catalogName, string version, Guid activityId);
+    public IAsyncOperationWithProgress<ElevatedInstallTaskResult, ElevatedInstallTaskProgress> InstallPackageAsync(string packageId, string catalogName, string version, Guid activityId);
 
     /// <summary>
     /// Create a dev drive