-
Notifications
You must be signed in to change notification settings - Fork 413
Fix: DeploymentManager failing with error package downgrade #6021
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes a bug in DeploymentManager::GetStatus() that could cause ERROR_INSTALL_PACKAGE_DOWNGRADE errors during initialization. The issue occurred when the Main package was missing but a higher version of the Singleton package was already installed - an early break in the verification loop prevented the Singleton package from being tracked, leading to attempted reinstallation of a lower version.
Key Changes:
- Replaced early
breakwith result accumulation to ensure all packages are verified - Added comprehensive test coverage for various package installation scenarios
- Created a new test package (
Singleton2) with a higher version number for testing
Reviewed Changes
Copilot reviewed 8 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
dev/Deployment/DeploymentManager.cpp |
Fixed the verification loop to continue checking all packages instead of breaking early |
test/inc/WindowsAppRuntime.Test.Package.h |
Added test helper functions for the new Singleton2 test package |
test/Deployment/API/APITests.cpp |
Added four new test cases covering different package installation scenarios |
test/Deployment/data/WindowsAppRuntime.Test.Singleton2/appxmanifest.xml |
Created manifest for higher-versioned test package (4.1.1968.333) |
test/Deployment/data/WindowsAppRuntime.Test.Singleton2/WindowsAppRuntime.Test.Singleton2.vcxproj |
Added Visual Studio project for new test package |
test/Deployment/data/WindowsAppRuntime.Test.Singleton2/WindowsAppRuntime.Test.Singleton2.vcxproj.filters |
Added project filters for new test package |
test/Deployment/API/DeploymentTests.vcxproj |
Added project reference to the new Singleton2 test package |
WindowsAppRuntime.sln |
Integrated new test project into the solution with all build configurations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 8 out of 13 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 8 out of 13 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 8 out of 13 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
* Setting strict mode and error action preference to stop on remaining PS scripts (#5950) * Setting strict mode and error action preference to stop on remaining powershell scripts * Fixing install VCLibs script * Shorten VSIX DisplayName to fit 50 char limit when Experimental prefix is added (#5953) * [main] Update dependencies from microsoft/LiftedIXP/DCPP (#5955) * Update dependencies from https://dev.azure.com/microsoft/LiftedIXP/_git/DCPP build 20251029.6 On relative base path root Microsoft.FrameworkUdk , Microsoft.ProjectReunion.InteractiveExperiences.TransportPackage From Version 2.0.0-experimental-27200.1830.251013-1313.4 -> To Version 2.0.0-experimental-27200.1822.251028-1938.4 Microsoft.WindowsAppSDK.InteractiveExperiences From Version 2.0.1-experimental -> To Version 2.0.2-experimental * Update dependencies from https://dev.azure.com/microsoft/LiftedIXP/_git/DCPP build 20251030.2 On relative base path root Microsoft.FrameworkUdk , Microsoft.ProjectReunion.InteractiveExperiences.TransportPackage From Version 2.0.0-experimental-27200.1830.251013-1313.4 -> To Version 2.0.0-experimental-27200.1835.251029-1735.1 Microsoft.WindowsAppSDK.InteractiveExperiences From Version 2.0.1-experimental -> To Version 2.0.3-experimental --------- Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com> * Disabling flaky push notification test (#5980) * Update bug-report.yaml (#5983) * API Spec: PackageValidator API in PackageManagement.md (#5863) Added documentation for new proposed API for PackageValidation * update issue template for 1.8.3 and 2.0-exp3 (#5993) * [WinAppSDK]: Update resourceManagement.yml (#5988) * Update resourceManagement.yml close issue only if bot comment is posted * fix yml * minor improvements * Fix: getting activity context by reference (#6000) * Fix FileTypeChoices in Storage Pickers to preserve insertion order (#5948) **Description** This is a fix for issue: - #5827 The existing FileTypeChoices property was built on an unordered map, which does not preserve the user-defined order. However, in the FileOpenPicker and FileSavePicker, the FileTypeChoices need to be displayed in the order they were inserted, rather than in a random order. This is important for developers' and end-users' experience because: - Developers expect to see their file type options in the logical order they added them - The first added option is usually the default selection - Maintaining consistent ordering helps end users quickly locate the desired file type Additionaly, the insertion order is respected in the legacy UWP FileSavePicker. **Fix** This is a backward-compatible fix. The goal of this fix is to maintain the existing Map type API contract and its good performance while ensuring that the display order of FileTypeChoices meets expectations. This pull request refactors the implementation of the `FileTypeChoicesMap` to ensure that the insertion order of keys is preserved and provides efficient key lookups. It replaces the previous unordered map-based implementation with the implementation backed by a vector. The update also introduces custom iterator and view classes to support this ordered behavior and modifies related tests to verify the new insertion order. * Revert "Fix: getting activity context by reference (#6000)" (#6004) This reverts commit 2b9dff7. * Migrate net6 to net8 for the Test Sample app (#6003) * Migrate net6 to net8 for the Test Sample app * Rollback change for local test first * Fix also the runtime identifier path * Increasing timeout to try to avoid flakiness (#6010) * Reapply "Fix: getting activity context by reference (#6000)" (#6004) (#6009) This reverts commit 60ea859. * Bugfix: the filter name for FileOpenPicker.FileTypeFilters #6005 * Add localization for NuGet Install Wizard for the VS templates (#5989) * Initial localization commit * Realign and add missing package messages to resources * Update s_resourceManager to _resourceManager * Lazy initialize ResourceManager to make it thread safe * Make Resources not static * Dev in progress, adding error messaging * Resources load without error * Capture localization dev/test state * Undo dev/test configuration and remove wait dialog error check * Resolve conflicting Designer file * Move VSPackage.Designer files back to Common (where resources are) * Update Cpp error message string to include where to find details * Include satellite assemblies * Reset source.extension.vsixmanifests * Remove WizardStringHelper * Clean up null check and spacing * Add copyright headers to VSPackage.Designer.cs files * Passing activity context as argument for deployment methods (#6011) * Passing context as argument for deployment methods * Fixing call for add package methods * Fix: DeploymentManager failing with error package downgrade (#6021) * Dont break on first failure * Adding tests * Movint package removal to cleanup method * Changing GUID to a random one * Changing name from Singleton2 to SingletonHigherVersion * Adding check for registered packages * Fix on verify packages method * Test enhancements suggestion * Fix on verify packages method 2 * Revert "Fix on verify packages method 2" This reverts commit 10060a6. * Revert "Fix on verify packages method" This reverts commit 1c5eb9b. * Bugfix: FileSavePicker.PickSaveFileAsync() should not truncate file when the picked file exists. **Description** This PR is part of the solution of issue - #5976 In `PickSaveFileAsync`, if the picked file exists, user will see a warning prompt re-confirming if the picked file can be overwrite. <img width="1100" height="574" alt="image" src="https://github.com/user-attachments/assets/d956dd69-d4e0-4b11-85e6-b6a79e732418" /> **Then, if user selected "Yes", the FileSavePicker directly truncate the picked file to be empty.** This is not an expected behavior, and it can block some scenarios, such as: - Developers may need to read original content after the file is picked. - Developers may want to add some extra confirmation step before fully overwriting the file (as described in the issue). Additionally, the UWP FileSavePicker won't directly truncate the picked save file in method PickSaveFileAsync(). **Fix** Updating the file creation method to be: - If the picked file doesn't exist, create an empty file. - if the picked file already exist, do nothing, do not truncate it. * add missing samples ref (#5935) * Update dependencies from https://dev.azure.com/microsoft/ProjectReunion/_git/WindowsAppSDKAggregator build 2.0.251120.1-experimental (#6025) [main] Update dependencies from microsoft/ProjectReunion/WindowsAppSDKAggregator * Add ManualValidation step for RuntimeCompatibilityChange in servicing builds (#6028) * add a manual validation stage * variable to allow bypassing for experimental/preview * Update dependencies from https://dev.azure.com/microsoft/ProjectReunion/_git/WindowsAppSDKAggregator build 2.0.251125.1-experimental (#6038) [main] Update dependencies from microsoft/ProjectReunion/WindowsAppSDKAggregator * [Build] Replace LTSC2019 with LTSC2022 on Foundation repo (#6042) * Update WindowsContainerImage to use ltsc2022 * Update WindowsAppSDK-BuildDevCheck.yml * Add WindowsHostVersion parameter to YAML configuration * Add WindowsHostVersion parameter to YAML file * Add WindowsHostVersion parameter to YAML file * Add WindowsHostVersion parameter to YAML config * Update dependencies from https://dev.azure.com/microsoft/ProjectReunion/_git/WindowsAppSDKAggregator build 2.0.251128.1-experimental (#6046) [main] Update dependencies from microsoft/ProjectReunion/WindowsAppSDKAggregator * Update VS Template (#5994) * Localize strings in OutputWindowHelper (#6059) * Localize strings for OutputWindowHelper * Name strings with variables * Add back copyright for VSPackage.Designer.cs files * Keep OutputWindowHelper.cs newlines consistent with WizardImplementation.cs * Remove extra string variables for performance * Making verify package method default to the highest version found (#6026) * Fix on verify packages method * Initializing highest version found to the version being search * Removing match boolean * Using variable instead of winrt call * Using versions to comparisons * Adding singleton lower version package and test * Adding verification for package registering in test * Adding test with multiple singleton versions * Getting Started Documentation: Improving common errors session readability (#6041) * Improving common errors session of getting started doc * Removing extra empty line * Update VSIX resource files to include NuGet wizard strings (#6067) * Update README.md (#6073) * Update dependencies from https://dev.azure.com/microsoft/LiftedIXP/_git/DCPP build 20251216.1 (#6079) On relative base path root Microsoft.FrameworkUdk , Microsoft.ProjectReunion.InteractiveExperiences.TransportPackage From Version 2.0.0-experimental-27200.1835.251029-1735.1 -> To Version 2.0.0-experimental-27200.1845.251215-1020.3 Microsoft.WindowsAppSDK.InteractiveExperiences From Version 2.0.3-experimental -> To Version 2.0.4-experimental Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com> * Test-VisualStudioComponent now detects missing components (#6092) --------- Co-authored-by: Felipe G <guima.felipec@gmail.com> Co-authored-by: Lauren Ciha <laurenciha@microsoft.com> Co-authored-by: dotnet-maestro[bot] <42748379+dotnet-maestro[bot]@users.noreply.github.com> Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com> Co-authored-by: Roy <59626501+RDMacLachlan@users.noreply.github.com> Co-authored-by: letao-msft <72979394+letao-msft@users.noreply.github.com> Co-authored-by: ssparach <128866445+ssparach@users.noreply.github.com> Co-authored-by: Dinah Xiaoman G <116714259+DinahK-2SO@users.noreply.github.com> Co-authored-by: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com> Co-authored-by: alexlamtest <68841560+alexlamtest@users.noreply.github.com> Co-authored-by: Niels Laute <niels.laute@live.nl> Co-authored-by: Ryan Shepherd <ryansh@microsoft.com>
On current telemetry on experimental builds, the majority of the failures on the deployment initialize method is due to ERROR_INSTALL_PACKAGE_DOWNGRADE.
This PR tracks one of the possible ways of that happening in the current code.
When we call
GetStatus()(either by itself or inside theInitialize()method), it tries to go over all the packages (Main and Singleton, in that order) and check if they are already installed or not (in the methodVerifyPackage()).The problem is that in the current way this is written, if the Main package is not installed in the machine, but the Singleton package is installed in a higher version, in the for loop, it will verify that Main is not installed and break from the loop. This break will make Singleton package not be verified, and it will not be added to the global map that tracks the versions of the currently installed packages.
Then, on the
AddOrRegisterPackages()method in the Deploy stage, we will try to install both packages. But as Singleton was not added to theg_existingTargetPackagesIfHigherVersionmap because of the early break, it will attempt to install it when a higher version is already installed.Tests added
With this PR, 4 new tests were added.
Initialize()when Main and Singleton are already installedInitialize()when Main is installedInitialize()when Singleton is installedInitialize()when a higher version of the Singleton package is installed (test that fails for the current version of the code)For the last test, was added a new test package
SingletonHigherVersionto simulate the existence of a higher version of the singleton package in the machine.A microsoft employee must use /azp run to validate using the pipelines below.
WARNING:
Comments made by azure-pipelines bot maybe inaccurate.
Please see pipeline link to verify that the build is being ran.
For status checks on the main branch, please use TransportPackage-Foundation-PR
(https://microsoft.visualstudio.com/ProjectReunion/_build?definitionId=81063&_a=summary)
and run the build against your PR branch with the default parameters.