Add support for 1.9 manifest in rest source parsing and winget utils interop (#4906)

yao-msft · ryfu-msft · commit ede0074a9a1d · 2024-10-25T17:53:24.000-04:00
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
@@ -322,6 +322,7 @@
     <ClCompile Include="RestInterface_1_5.cpp" />
     <ClCompile Include="RestInterface_1_6.cpp" />
     <ClCompile Include="RestInterface_1_7.cpp" />
+    <ClCompile Include="RestInterface_1_9.cpp" />
     <ClCompile Include="ResumeFlow.cpp" />
     <ClCompile Include="Runtime.cpp" />
     <ClCompile Include="SearchRequestSerializer.cpp" />
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters
@@ -365,6 +365,9 @@
     <ClCompile Include="Sixel.cpp">
       <Filter>Source Files\CLI</Filter>
     </ClCompile>
+    <ClCompile Include="RestInterface_1_9.cpp">
+      <Filter>Source Files\Repository</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />
diff --git a/src/AppInstallerCLITests/RestClient.cpp b/src/AppInstallerCLITests/RestClient.cpp
@@ -51,7 +51,7 @@ TEST_CASE("GetSupportedInterface", "[RestSource]")
     REQUIRE(RestClient::GetSupportedInterface(TestRestUri, {}, info, {}, version, {})->GetVersion() == version);
 
     // Update this test to next version so that we don't forget to add to supported versions before rest e2e tests are available.
-    Version invalid{ "1.8.0" };
+    Version invalid{ "1.10.0" };
     REQUIRE_THROWS_HR(RestClient::GetSupportedInterface(TestRestUri, {}, info, {}, invalid, {}), APPINSTALLER_CLI_ERROR_RESTSOURCE_INVALID_VERSION);
 
     Authentication::AuthenticationArguments authArgs;
diff --git a/src/AppInstallerCLITests/RestInterface_1_9.cpp b/src/AppInstallerCLITests/RestInterface_1_9.cpp
diff --git a/src/AppInstallerCLITests/YamlManifest.cpp b/src/AppInstallerCLITests/YamlManifest.cpp
@@ -1330,6 +1330,37 @@ TEST_CASE("WriteV1_7SingletonManifestAndVerifyContents", "[ManifestCreation]")
     VerifyV1ManifestContent(generatedMultiFileManifest, false, ManifestVer{ s_ManifestVersionV1_7 }, true);
 }
 
+TEST_CASE("WriteV1_9SingletonManifestAndVerifyContents", "[ManifestCreation]")
+{
+    TempDirectory singletonDirectory{ "SingletonManifest" };
+    CopyTestDataFilesToFolder({ "ManifestV1_9-Singleton.yaml" }, singletonDirectory);
+    Manifest singletonManifest = YamlParser::CreateFromPath(singletonDirectory);
+
+    TempDirectory exportedSingletonDirectory{ "exportedSingleton" };
+    std::filesystem::path generatedSingletonManifestPath = exportedSingletonDirectory.GetPath() / "testSingletonManifest.yaml";
+    YamlWriter::OutputYamlFile(singletonManifest, singletonManifest.Installers[0], generatedSingletonManifestPath);
+
+    REQUIRE(std::filesystem::exists(generatedSingletonManifestPath));
+    Manifest generatedSingletonManifest = YamlParser::CreateFromPath(exportedSingletonDirectory);
+    VerifyV1ManifestContent(generatedSingletonManifest, true, ManifestVer{ s_ManifestVersionV1_9 }, true);
+
+    TempDirectory multiFileDirectory{ "MultiFileManifest" };
+    CopyTestDataFilesToFolder({
+        "ManifestV1_9-MultiFile-Version.yaml",
+        "ManifestV1_9-MultiFile-Installer.yaml",
+        "ManifestV1_9-MultiFile-DefaultLocale.yaml",
+        "ManifestV1_9-MultiFile-Locale.yaml" }, multiFileDirectory);
+
+    Manifest multiFileManifest = YamlParser::CreateFromPath(multiFileDirectory);
+    TempDirectory exportedMultiFileDirectory{ "exportedMultiFile" };
+    std::filesystem::path generatedMultiFileManifestPath = exportedMultiFileDirectory.GetPath() / "testMultiFileManifest.yaml";
+    YamlWriter::OutputYamlFile(multiFileManifest, multiFileManifest.Installers[0], generatedMultiFileManifestPath);
+
+    REQUIRE(std::filesystem::exists(generatedMultiFileManifestPath));
+    Manifest generatedMultiFileManifest = YamlParser::CreateFromPath(exportedMultiFileDirectory);
+    VerifyV1ManifestContent(generatedMultiFileManifest, false, ManifestVer{ s_ManifestVersionV1_9 }, true);
+}
+
 TEST_CASE("WriteManifestWithMultipleLocale", "[ManifestCreation]")
 {
     Manifest multiLocaleManifest = YamlParser::CreateFromPath(TestDataFile("Manifest-Good-MultiLocale.yaml"));
diff --git a/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj b/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj
@@ -451,6 +451,8 @@
     <ClInclude Include="Rest\Schema\1_6\Json\ManifestDeserializer.h" />
     <ClInclude Include="Rest\Schema\1_7\Interface.h" />
     <ClInclude Include="Rest\Schema\1_7\Json\ManifestDeserializer.h" />
+    <ClInclude Include="Rest\Schema\1_9\Interface.h" />
+    <ClInclude Include="Rest\Schema\1_9\Json\ManifestDeserializer.h" />
     <ClInclude Include="Rest\Schema\AuthenticationInfoParser.h" />
     <ClInclude Include="Rest\Schema\CommonRestConstants.h" />
     <ClInclude Include="Rest\Schema\InformationResponseDeserializer.h" />
@@ -544,6 +546,8 @@
     <ClCompile Include="Rest\Schema\1_6\RestInterface_1_6.cpp" />
     <ClCompile Include="Rest\Schema\1_7\Json\ManifestDeserializer_1_7.cpp" />
     <ClCompile Include="Rest\Schema\1_7\RestInterface_1_7.cpp" />
+    <ClCompile Include="Rest\Schema\1_9\Json\ManifestDeserializer_1_9.cpp" />
+    <ClCompile Include="Rest\Schema\1_9\RestInterface_1_9.cpp" />
     <ClCompile Include="Rest\Schema\AuthenticationInfoParser.cpp" />
     <ClCompile Include="Rest\Schema\InformationResponseDeserializer.cpp" />
     <ClCompile Include="Rest\Schema\SearchRequestComposer.cpp" />
diff --git a/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj.filters b/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj.filters
@@ -103,6 +103,12 @@
     <Filter Include="Microsoft\Schema\2_0">
       <UniqueIdentifier>{34442899-29e5-4183-96ba-a1e8740146be}</UniqueIdentifier>
     </Filter>
+    <Filter Include="Rest\Schema\1_9">
+      <UniqueIdentifier>{8edd7018-8836-4b15-84c1-998391e19038}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="Rest\Schema\1_9\Json">
+      <UniqueIdentifier>{7464e3ff-7a60-4bb6-8806-70562382043b}</UniqueIdentifier>
+    </Filter>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="pch.h">
@@ -462,6 +468,12 @@
     <ClInclude Include="Microsoft\SQLiteIndexSourceV2.h">
       <Filter>Microsoft</Filter>
     </ClInclude>
+    <ClInclude Include="Rest\Schema\1_9\Json\ManifestDeserializer.h">
+      <Filter>Rest\Schema\1_9\Json</Filter>
+    </ClInclude>
+    <ClInclude Include="Rest\Schema\1_9\Interface.h">
+      <Filter>Rest\Schema\1_9</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.cpp">
@@ -722,6 +734,12 @@
     <ClCompile Include="Microsoft\SQLiteIndexSourceV2.cpp">
       <Filter>Microsoft</Filter>
     </ClCompile>
+    <ClCompile Include="Rest\Schema\1_9\Json\ManifestDeserializer_1_9.cpp">
+      <Filter>Rest\Schema\1_9\Json</Filter>
+    </ClCompile>
+    <ClCompile Include="Rest\Schema\1_9\RestInterface_1_9.cpp">
+      <Filter>Rest\Schema\1_9</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />
diff --git a/src/AppInstallerRepositoryCore/ManifestJSONParser.cpp b/src/AppInstallerRepositoryCore/ManifestJSONParser.cpp
@@ -8,6 +8,7 @@
 #include "Rest/Schema/1_5/Json/ManifestDeserializer.h"
 #include "Rest/Schema/1_6/Json/ManifestDeserializer.h"
 #include "Rest/Schema/1_7/Json/ManifestDeserializer.h"
+#include "Rest/Schema/1_9/Json/ManifestDeserializer.h"
 
 namespace AppInstaller::Repository::JSON
 {
@@ -46,10 +47,14 @@ namespace AppInstaller::Repository::JSON
             {
                 m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_6::Json::ManifestDeserializer>();
             }
-            else
+            else if (parts.size() > 1 && parts[1].Integer < 9)
             {
                 m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_7::Json::ManifestDeserializer>();
             }
+            else
+            {
+                m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_9::Json::ManifestDeserializer>();
+            }
         }
         else
         {
diff --git a/src/AppInstallerRepositoryCore/Rest/RestClient.cpp b/src/AppInstallerRepositoryCore/Rest/RestClient.cpp
@@ -8,6 +8,7 @@
 #include "Rest/Schema/1_5/Interface.h"
 #include "Rest/Schema/1_6/Interface.h"
 #include "Rest/Schema/1_7/Interface.h"
+#include "Rest/Schema/1_9/Interface.h"
 #include "Rest/Schema/InformationResponseDeserializer.h"
 #include "Rest/Schema/CommonRestConstants.h"
 #include <winget/HttpClientHelper.h>
@@ -22,7 +23,7 @@ using namespace AppInstaller::Http;
 namespace AppInstaller::Repository::Rest
 {
     // Supported versions
-    std::set<Version> WingetSupportedContracts = { Version_1_0_0, Version_1_1_0, Version_1_4_0, Version_1_5_0, Version_1_6_0, Version_1_7_0 };
+    std::set<Version> WingetSupportedContracts = { Version_1_0_0, Version_1_1_0, Version_1_4_0, Version_1_5_0, Version_1_6_0, Version_1_7_0, Version_1_9_0 };
 
     constexpr std::string_view WindowsPackageManagerHeader = "Windows-Package-Manager"sv;
     constexpr size_t WindowsPackageManagerHeaderMaxLength = 1024;
@@ -176,6 +177,10 @@ namespace AppInstaller::Repository::Rest
         {
             return std::make_unique<Schema::V1_7::Interface>(api, helper, information, additionalHeaders, authArgs);
         }
+        else if (version == Version_1_9_0)
+        {
+            return std::make_unique<Schema::V1_9::Interface>(api, helper, information, additionalHeaders, authArgs);
+        }
 
         THROW_HR(APPINSTALLER_CLI_ERROR_RESTSOURCE_INVALID_VERSION);
     }
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_9/Interface.h b/src/AppInstallerRepositoryCore/Rest/Schema/1_9/Interface.h
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#pragma once
+#include "Rest/Schema/1_7/Interface.h"
+
+namespace AppInstaller::Repository::Rest::Schema::V1_9
+{
+    // Interface to this schema version exposed through IRestClient.
+    struct Interface : public V1_7::Interface
+    {
+        Interface(const std::string& restApi, const Http::HttpClientHelper& helper, IRestClient::Information information, const Http::HttpClientHelper::HttpRequestHeaders& additionalHeaders = {}, Authentication::AuthenticationArguments authArgs = {});
+
+        Interface(const Interface&) = delete;
+        Interface& operator=(const Interface&) = delete;
+
+        Interface(Interface&&) = default;
+        Interface& operator=(Interface&&) = default;
+
+        Utility::Version GetVersion() const override;
+    };
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_9/Json/ManifestDeserializer.h b/src/AppInstallerRepositoryCore/Rest/Schema/1_9/Json/ManifestDeserializer.h
@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#pragma once
+#include "Rest/Schema/1_7/Json/ManifestDeserializer.h"
+
+namespace AppInstaller::Repository::Rest::Schema::V1_9::Json
+{
+    // Manifest Deserializer.
+    struct ManifestDeserializer : public V1_7::Json::ManifestDeserializer
+    {
+    protected:
+
+        std::optional<Manifest::ManifestInstaller> DeserializeInstaller(const web::json::value& installerJsonObject) const override;
+
+        Manifest::ManifestVer GetManifestVersion() const override;
+    };
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_9/Json/ManifestDeserializer_1_9.cpp b/src/AppInstallerRepositoryCore/Rest/Schema/1_9/Json/ManifestDeserializer_1_9.cpp
@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "ManifestDeserializer.h"
+#include <winget/JsonUtil.h>
+
+using namespace AppInstaller::Manifest;
+
+namespace AppInstaller::Repository::Rest::Schema::V1_9::Json
+{
+    namespace
+    {
+        // Installer
+        constexpr std::string_view ArchiveBinariesDependOnPath = "ArchiveBinariesDependOnPath"sv;
+    }
+
+    std::optional<Manifest::ManifestInstaller> ManifestDeserializer::DeserializeInstaller(const web::json::value& installerJsonObject) const
+    {
+        auto result = V1_7::Json::ManifestDeserializer::DeserializeInstaller(installerJsonObject);
+
+        if (result)
+        {
+            auto& installer = result.value();
+
+            installer.ArchiveBinariesDependOnPath = JSON::GetRawBoolValueFromJsonNode(installerJsonObject, JSON::GetUtilityString(ArchiveBinariesDependOnPath)).value_or(false);
+        }
+
+        return result;
+    }
+
+    Manifest::ManifestVer ManifestDeserializer::GetManifestVersion() const
+    {
+        return Manifest::s_ManifestVersionV1_9;
+    }
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_9/RestInterface_1_9.cpp b/src/AppInstallerRepositoryCore/Rest/Schema/1_9/RestInterface_1_9.cpp
@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "Rest/Schema/1_9/Interface.h"
+#include "Rest/Schema/CommonRestConstants.h"
+#include "Rest/Schema/IRestClient.h"
+#include <winget/HttpClientHelper.h>
+#include <winget/JsonUtil.h>
+
+namespace AppInstaller::Repository::Rest::Schema::V1_9
+{
+    Interface::Interface(
+        const std::string& restApi,
+        const Http::HttpClientHelper& httpClientHelper,
+        IRestClient::Information information,
+        const Http::HttpClientHelper::HttpRequestHeaders& additionalHeaders,
+        Authentication::AuthenticationArguments authArgs) : V1_7::Interface(restApi, httpClientHelper, std::move(information), additionalHeaders, std::move(authArgs))
+    {
+        m_requiredRestApiHeaders[JSON::GetUtilityString(ContractVersion)] = JSON::GetUtilityString(Version_1_9_0.ToString());
+    }
+
+    Utility::Version Interface::GetVersion() const
+    {
+        return Version_1_9_0;
+    }
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/CommonRestConstants.h b/src/AppInstallerRepositoryCore/Rest/Schema/CommonRestConstants.h
@@ -12,6 +12,7 @@ namespace AppInstaller::Repository::Rest::Schema
     const Utility::Version Version_1_5_0{ "1.5.0" };
     const Utility::Version Version_1_6_0{ "1.6.0" };
     const Utility::Version Version_1_7_0{ "1.7.0" };
+    const Utility::Version Version_1_9_0{ "1.9.0" };
 
     // General API response constants
     constexpr std::string_view Data = "Data"sv;
diff --git a/src/WinGetUtilInterop.UnitTests/ManifestUnitTest/V1ManifestReadTest.cs b/src/WinGetUtilInterop.UnitTests/ManifestUnitTest/V1ManifestReadTest.cs
@@ -1,4 +1,4 @@
-﻿// -----------------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 // <copyright file="V1ManifestReadTest.cs" company="Microsoft Corporation">
 //     Copyright (c) Microsoft Corporation. Licensed under the MIT License.
 // </copyright>
@@ -35,6 +35,7 @@ private enum TestManifestVersion
             V110,
             V160,
             V170,
+            V190,
         }
 
         /// <summary>
@@ -63,6 +64,11 @@ public void ReadV1ManifestsAndVerifyContents()
                 Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "TestCollateral", ManifestStrings.V170ManifestMerged));
 
             this.ValidateManifestFields(v170manifest, TestManifestVersion.V170);
+
+            Manifest v190manifest = Manifest.CreateManifestFromPath(
+                Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "TestCollateral", ManifestStrings.V190ManifestMerged));
+
+            this.ValidateManifestFields(v190manifest, TestManifestVersion.V190);
         }
 
         /// <summary>
@@ -266,6 +272,11 @@ private void ValidateManifestFields(Manifest manifest, TestManifestVersion manif
                 Assert.Equal("uninstaller", manifest.RepairBehavior);
             }
 
+            if (manifestVersion >= TestManifestVersion.V190)
+            {
+                Assert.True(manifest.ArchiveBinariesDependOnPath);
+            }
+
             // Individual installers
             Assert.Equal(2, manifest.Installers.Count);
             ManifestInstaller installer1 = manifest.Installers[0];
@@ -370,6 +381,11 @@ private void ValidateManifestFields(Manifest manifest, TestManifestVersion manif
                 Assert.Equal("modify", installer1.RepairBehavior);
             }
 
+            if (manifestVersion >= TestManifestVersion.V190)
+            {
+                Assert.False(installer1.ArchiveBinariesDependOnPath);
+            }
+
             // Additional Localizations
             Assert.Single(manifest.Localization);
             ManifestLocalization localization1 = manifest.Localization[0];
@@ -448,6 +464,11 @@ internal class ManifestStrings
             /// </summary>
             public const string V170ManifestMerged = "V1_7ManifestMerged.yaml";
 
+            /// <summary>
+            /// Merged v1.9 manifest.
+            /// </summary>
+            public const string V190ManifestMerged = "V1_9ManifestMerged.yaml";
+
             /// <summary>
             /// Merged v1 manifest without localization.
             /// </summary>
diff --git a/src/WinGetUtilInterop.UnitTests/TestCollateral/V1_9ManifestMerged.yaml b/src/WinGetUtilInterop.UnitTests/TestCollateral/V1_9ManifestMerged.yaml
diff --git a/src/WinGetUtilInterop.UnitTests/WinGetUtilInterop.UnitTests.csproj b/src/WinGetUtilInterop.UnitTests/WinGetUtilInterop.UnitTests.csproj
diff --git a/src/WinGetUtilInterop/Manifest/V1/Manifest.cs b/src/WinGetUtilInterop/Manifest/V1/Manifest.cs
diff --git a/src/WinGetUtilInterop/Manifest/V1/ManifestInstaller.cs b/src/WinGetUtilInterop/Manifest/V1/ManifestInstaller.cs

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`#include "Rest/Schema/1_5/Json/ManifestDeserializer.h"`
`9`	`9`	`#include "Rest/Schema/1_6/Json/ManifestDeserializer.h"`
`10`	`10`	`#include "Rest/Schema/1_7/Json/ManifestDeserializer.h"`
	`11`	`+#include "Rest/Schema/1_9/Json/ManifestDeserializer.h"`
`11`	`12`
`12`	`13`	`namespace AppInstaller::Repository::JSON`
`13`	`14`	`{`
`@@ -46,10 +47,14 @@ namespace AppInstaller::Repository::JSON`
`46`	`47`	`{`
`47`	`48`	`m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_6::Json::ManifestDeserializer>();`
`48`	`49`	`}`
`49`		`- else`
	`50`	`+ else if (parts.size() > 1 && parts[1].Integer < 9)`
`50`	`51`	`{`
`51`	`52`	`m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_7::Json::ManifestDeserializer>();`
`52`	`53`	`}`
	`54`	`+ else`
	`55`	`+ {`
	`56`	`+ m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_9::Json::ManifestDeserializer>();`
	`57`	`+ }`
`53`	`58`	`}`
`54`	`59`	`else`
`55`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`#include "Rest/Schema/1_5/Interface.h"`
`9`	`9`	`#include "Rest/Schema/1_6/Interface.h"`
`10`	`10`	`#include "Rest/Schema/1_7/Interface.h"`
	`11`	`+#include "Rest/Schema/1_9/Interface.h"`
`11`	`12`	`#include "Rest/Schema/InformationResponseDeserializer.h"`
`12`	`13`	`#include "Rest/Schema/CommonRestConstants.h"`
`13`	`14`	`#include <winget/HttpClientHelper.h>`
`@@ -22,7 +23,7 @@ using namespace AppInstaller::Http;`
`22`	`23`	`namespace AppInstaller::Repository::Rest`
`23`	`24`	`{`
`24`	`25`	`// Supported versions`
`25`		`- std::set<Version> WingetSupportedContracts = { Version_1_0_0, Version_1_1_0, Version_1_4_0, Version_1_5_0, Version_1_6_0, Version_1_7_0 };`
	`26`	`+ std::set<Version> WingetSupportedContracts = { Version_1_0_0, Version_1_1_0, Version_1_4_0, Version_1_5_0, Version_1_6_0, Version_1_7_0, Version_1_9_0 };`
`26`	`27`
`27`	`28`	`constexpr std::string_view WindowsPackageManagerHeader = "Windows-Package-Manager"sv;`
`28`	`29`	`constexpr size_t WindowsPackageManagerHeaderMaxLength = 1024;`
`@@ -176,6 +177,10 @@ namespace AppInstaller::Repository::Rest`
`176`	`177`	`{`
`177`	`178`	`return std::make_unique<Schema::V1_7::Interface>(api, helper, information, additionalHeaders, authArgs);`
`178`	`179`	`}`
	`180`	`+ else if (version == Version_1_9_0)`
	`181`	`+ {`
	`182`	`+ return std::make_unique<Schema::V1_9::Interface>(api, helper, information, additionalHeaders, authArgs);`
	`183`	`+ }`
`179`	`184`
`180`	`185`	`THROW_HR(APPINSTALLER_CLI_ERROR_RESTSOURCE_INVALID_VERSION);`
`181`	`186`	`}`