WinGet Source COM Api #4813
Open
WinGet Source COM Api #4813
+1,507
−9
Conversation
This file contains 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
- Update IDL for new runtime classes and methods. - Add files and classes for package catalog operations (add, remove, reset, update). - Update `PackageManager` with async methods for catalog operations. [Compiles successfully]
Introduced new interfaces in the `Microsoft.Management.Deployment` namespace within the `PackageManager.idl` file. Added interfaces for handling collections of `AddPackageCatalogOptions`, `AddPackageCatalogResult`, `RemovePackageCatalogResult`, `ResetPackageCatalogResult`, and `UpdatePackageCatalogResult`.
- Update `Package.appxmanifest` with a new entry. - Add a new entry in `Microsoft.Management.Deployment.InProc.dll.manifest`. - Define new `constexpr CLSID` values for `AddPackageCatalogOptions` in `Factory.cpp`. - Update `s_nameCLSIDPairs` array to include `AddPackageCatalogOptions`.
- Add entry to type dictionary in ClassesDefinition.cs. - Introduce CreateAddPackageCatalogOptions method in WinGetProjectionFactory.cs.
JohnMcPMS
reviewed
Sep 16, 2024
…nager.idl - Renamed `CatalogName` to `Name` and `m_catalogName` to `m_name` in `AddPackageCatalogOptions`. - Removed `Arguments` property and its methods. - Added new boolean property `Explicit` with getter and setter. Updated `PackageManager.idl` to reflect these changes: - Renamed `CatalogName` to `Name` with updated comments. - Removed `Arguments` property. - Added `Explicit` property with explanatory comments. - Updated `RemovePackageCatalogAsync` description to use "catalog". - Removed several `IVector` and `IVectorView` interfaces related to package catalog options and results.
…thods - Simplified progress reporting for *CatalogPackageAsync operations in PackageManager by using a double type. - Updated method signatures and removed related enums and structures in PackageManager.cpp, PackageManager.h, and PackageManager.idl.
- Introduce new async methods in `PackageCatalogReference` for removing, resetting, and updating package catalogs. - These methods are defined in `PackageCatalogReference.h` and implemented as placeholders in `PackageCatalogReference.cpp`. - Remove corresponding methods from `PackageManager`, shifting responsibility to `PackageCatalogReference`. Update `PackageManager.idl` to reflect these changes: - Add enums and result classes for new operations. - Include new async methods in `PackageCatalogReference`. - Remove outdated methods from `PackageManager`.
- Refactored RemovePackageCatalogAsync and UpdatePackageCatalogAsync to exclude the catalogName parameter in PackageCatalogReference.cpp, PackageCatalogReference.h, and PackageManager.idl. - This modification eliminates the necessity of passing a catalog name, as the required context is now inherently loaded from PackageCatalogInfor within PackageCatalogReference. Note: These operations are not designed to support actions on multiple PackageCatalog/Source, such as ResetAll, UpdateAll, or RemoveAll. These mass operations are intended only for human interactions. For such operations, consumers are expected to recreate 'all' with a simple set of calls.
- Remove progress reporting from ResetPackageCatalogAsync. The underlying implementation for ResetPackageCatalog does not support progress in Repository::DropSource(..). Therefore, the reset API is now an async operation without progress. - The return type of the `ResetPackageCatalogAsync` method in the `PackageCatalogReference` class has been changed from `winrt::Windows::Foundation::IAsyncOperationWithProgress<winrt::Microsoft::Management::Deployment::ResetPackageCatalogResult, double>` to `winrt::Windows::Foundation::IAsyncOperation<winrt::Microsoft::Management::Deployment::ResetPackageCatalogResult>`. This change removes the progress reporting capability from the asynchronous operation. - Corresponding changes have been made in `PackageCatalogReference.h` and `PackageManager.idl` to reflect the new return type. - This simplifies the method's signature and potentially its implementation.
…ageCatalogAsync. - The reset operation is a subset of the remove operation but does not include cleanup. - The remove operation ensures that everything the PackageCatalog writes to the system is cleaned up, in addition to removing the package catalog entry from the winget package catalog list. Conversely, the reset operation only removes the entry without performing any cleanup.
… into user/masudars/WinGet_Source_COM_API
- Increased the size of the s_nameCLSIDPairs array from 9 to 10 elements in Factory.cpp within the Microsoft::Management::Deployment::OutOfProc namespace. - Added a new NameCLSIDPair entry for Microsoft.Management.Deployment.AddPackageCatalogOptions. Updated the last entry for Microsoft.Management.Deployment.RepairOptions to include a trailing comma.
… upcoming commit - Removed the implementation details for handling the removal and update of package catalogs in the `PackageCatalogReference` class. - Added TODO comments indicating future implementation plans.
- Introduced a new COM class `RemovePackageCatalogOptions` with corresponding CLSIDs and properties. - Updated project files and headers to include the new class. - Added RemovePackageCatalogAsync method to handle the new functionality in `PackageManager`. - Renamed `UpdatePackageCatalog` to `RefreshPackageCatalog` and - Removed the old `UpdatePackageCatalogResult` class and introduced `RefreshPackageCatalogResult`. - Added new properties to `AddPackageCatalogOptions`.
This comment has been minimized.
This comment has been minimized.
Corrected a typo in the comment for `AcceptSourceAgreements` from "PacakageCatalog" to "PackageCatalog". This change improves the readability and accuracy of the code documentation.
Reformatted the RemovePackageCatalogAsync method declaration in PackageManager.h for improved readability.
- Two new error codes, `SourceAgreementsNotAccepted` and `AuthenticationError`, were added to the `AddPackageCatalogResult` - enumeration in the `Microsoft.Management.Deployment` namespace. - The `InvalidOptions` error code was added to the `RemovePackageCatalogResult` enumeration in the same namespace. - The comment for the `RemovePackageCatalogAsync` method was updated to clarify that it unregisters a package catalog and eliminates system artifacts based on the provided options.
- Introduce CallbackDispatcherSink in AppInstaller namespace to manage and dispatch progress updates to registered callbacks. - Implement methods for initializing, updating, and ending progress, as well as adding and firing callbacks. - Ensure thread-safe access with a mutex. - Minor formatting changes included.
Introduced new functionalities for handling package catalog operations, including adding, refreshing, and removing package catalogs. These operations now feature detailed exception handling, progress reporting, and validation checks. Key changes include: - Added `WINGET_CATALOG_CATCH_STORE` macro in ExecutionContext.h. - Implemented `RefreshPackageCatalogAsync` in PackageCatalogReference.cpp. - Implemented `AddPackageCatalogAsync` and `RemovePackageCatalogAsync` in PackageManager.cpp. - Added various helper functions for status mapping and result creation. - Adjusted includes and formatting for consistency in RemovePackageCatalogOptions.h.
- The PackageCatalogInterop class handles package catalog operations for end-to-end tests, including adding, removing, and validating package catalogs. - It addresses edge cases like invalid options, duplicate names, and unaccepted source agreements.
…com/Madhusudhan-MSFT/winget-cli into user/masudars/WinGet_Source_COM_API
…method - Refactored status handling by introducing a template function `GetPackageCatalogOperationStatus` in `Converters.h`, replacing individual status conversion functions in `PackageCatalogReference.cpp` and `PackageManager.cpp`. - Simplified progress reporting by modifying callbacks to report only the current progress value. - Moved new functions `CheckForDuplicateSource`, `CreateSourceFromOptions`, and `GetMatchingSource` in `PackageManager.cpp` close all the private methods. - Included `<optional>` header to support `std::optional`. - Cleaned up redundant code and improved comments for better clarity.
The indentation of the `struct RepairOptions` declaration has been adjusted. Specifically, the indentation level has been decreased by one level, aligning it with the `[uuid(WINGET_OUTOFPROC_COM_CLSID_RepairOptions)]` attribute. This change improves code readability and consistency.
…kageCatalog COM APIs (as it is targetted for 1.10 release) Updated contract version from 11 to 12 in `winrt::Microsoft::Management::Deployment::implementation` and `Microsoft.Management.Deployment` namespaces. Changes include: - Updated comments and attributes in `PackageCatalogReference.h`, `PackageManager.h`, and `PackageManager.idl`. - Modified `contractversion` attribute in `PackageManager.idl` to 12. - Adjusted contract attributes for enums, runtime classes, and methods to version 12. These updates ensure the codebase aligns with the new contract version, incorporating any new features, improvements, or fixes.
This comment has been minimized.
This comment has been minimized.
Corrected the term "Packagecatalog" to "Package Catalog" in the comment for the RemovePackageCatalogAsync method in the Microsoft.Management.Deployment namespace.
This comment has been minimized.
This comment has been minimized.
Updated the comment for the RemoveNonExistingPackageCatalog method to enhance readability and grammatical correctness. Changed "Remove non existing package catalog." to "Remove a non-existent package catalog." to make the purpose of the method clearer.
This comment has been minimized.
This comment has been minimized.
Updated the comment for the RemoveNonExistingPackageCatalog method to improve clarity. The new comment "Remove a package catalog that is not present" is more straightforward and easier to understand.
Deleted the <ItemGroup> containing the <Natvis> element from the Microsoft.Management.Deployment.vcxproj.filters file. This change removes the inclusion of the wil.natvis file, which provided custom visualizations for native types in Visual Studio.
- Removed WINGET_CATALOG_CATCH_STORE macro from ExecutionContext.h. - Refactored GetPackageCatalogOperationStatus in Converters.h. - Updated PackageCatalogReference.cpp to use HandleException. - Refactored PackageManager.cpp for detailed exception handling. - Added new test cases for insecure URI and invalid type scenarios. - Updated PackageCatalogInterop.cs tests to use InvalidOptions status. - Added comments for admin validation checks in InProc/OutOfProc calls.
…tion - Introduced `TestClassTearDown` method with `[OneTimeTearDown]` attribute. - Added `AddUpdateRemovePackageCatalog` method for catalog management. - Added `RemovePackageCatalog` method for catalog removal. - Integrated `AddUpdateRemovePackageCatalog` into existing tests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
WinGet Source COM API Support
This update includes the following changes:
How Validated:
related: #4170
Microsoft Reviewers: Open in CodeFlow