Add RestSource and tests for Manifest v1.12 (#5695)

dkbennett · web-flow · commit ddb86d48d52b · 2025-08-27T19:36:27.000-07:00
Closes #5694 Updates the RestSource and interface to support v1.12 Manifest schema. * Added Manifest 1.12 Schema to the Rest source and support for the new installer type. * Added tests for v1.12 rest source. * Added unit tests for WinGetUtilInterop for the v1.12 merged manifest and validating the new installertype. Tested: * WinGetUtilInterop Unit tests passed, verified in debugger that the new v1.12 manifest and manifest properties were being tested and validated. * AppInstallerCLITests for [RestSource] and the new [Interface_1_12] both pass.  (This is part of schema update for 1.12 so nothing new to add to release notes.) - [x] I have signed the [Contributor License Agreement](https://cla.opensource.microsoft.com/microsoft/winget-pkgs). - [x] I have updated the [Release Notes](../doc/ReleaseNotes.md). - [x] This pull request is related to an issue. -----
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
@@ -278,6 +278,7 @@
     <ClCompile Include="RestInterface_1_0.cpp" />
     <ClCompile Include="RestInterface_1_1.cpp" />
     <ClCompile Include="RestInterface_1_10.cpp" />
+    <ClCompile Include="RestInterface_1_12.cpp" />
     <ClCompile Include="RestInterface_1_4.cpp" />
     <ClCompile Include="RestInterface_1_5.cpp" />
     <ClCompile Include="RestInterface_1_6.cpp" />
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters
@@ -377,6 +377,9 @@
     <ClCompile Include="RestInterface_1_10.cpp">
       <Filter>Source Files\Repository</Filter>
     </ClCompile>
+    <ClCompile Include="RestInterface_1_12.cpp">
+      <Filter>Source Files\Repository</Filter>
+    </ClCompile>
     <ClCompile Include="ManifestComparator.cpp">
       <Filter>Source Files\Common</Filter>
     </ClCompile>
diff --git a/src/AppInstallerCLITests/RestClient.cpp b/src/AppInstallerCLITests/RestClient.cpp
@@ -61,7 +61,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.11.0" };
+    Version invalid{ "1.13.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_12.cpp b/src/AppInstallerCLITests/RestInterface_1_12.cpp
diff --git a/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj b/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj
@@ -383,6 +383,8 @@
     <ClInclude Include="Rest\Schema\1_0\Json\SearchResponseDeserializer.h" />
     <ClInclude Include="Rest\Schema\1_10\Interface.h" />
     <ClInclude Include="Rest\Schema\1_10\Json\ManifestDeserializer.h" />
+    <ClInclude Include="Rest\Schema\1_12\Interface.h" />
+    <ClInclude Include="Rest\Schema\1_12\Json\ManifestDeserializer.h" />
     <ClInclude Include="Rest\Schema\1_1\Interface.h" />
     <ClInclude Include="Rest\Schema\1_1\Json\ManifestDeserializer.h" />
     <ClInclude Include="Rest\Schema\1_1\Json\SearchRequestSerializer.h" />
@@ -480,6 +482,8 @@
     <ClCompile Include="Rest\Schema\1_0\Json\SearchResponseDeserializer_1_0.cpp" />
     <ClCompile Include="Rest\Schema\1_10\Json\ManifestDeserializer_1_10.cpp" />
     <ClCompile Include="Rest\Schema\1_10\RestInterface_1_10.cpp" />
+    <ClCompile Include="Rest\Schema\1_12\Json\ManifestDeserializer_1_12.cpp" />
+    <ClCompile Include="Rest\Schema\1_12\RestInterface_1_12.cpp" />
     <ClCompile Include="Rest\Schema\1_1\Json\ManifestDeserializer_1_1.cpp" />
     <ClCompile Include="Rest\Schema\1_1\Json\SearchRequestSerializer_1_1.cpp" />
     <ClCompile Include="Rest\Schema\1_1\RestInterface_1_1.cpp" />
diff --git a/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj.filters b/src/AppInstallerRepositoryCore/AppInstallerRepositoryCore.vcxproj.filters
@@ -115,6 +115,12 @@
     <Filter Include="Rest\Schema\1_10\Json">
       <UniqueIdentifier>{1a1efb9f-7332-4094-bb98-a4c51ea68b24}</UniqueIdentifier>
     </Filter>
+    <Filter Include="Rest\Schema\1_12">
+      <UniqueIdentifier>{c29ae113-5eb6-41af-b64d-fac925dcf2c2}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="Rest\Schema\1_12\Json">
+      <UniqueIdentifier>{2075b51e-aa11-473a-bae0-e0d4366f926b}</UniqueIdentifier>
+    </Filter>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="pch.h">
@@ -486,6 +492,12 @@
     <ClInclude Include="Rest\Schema\1_10\Json\ManifestDeserializer.h">
       <Filter>Rest\Schema\1_10\Json</Filter>
     </ClInclude>
+      <ClInclude Include="Rest\Schema\1_12\Interface.h">
+      <Filter>Rest\Schema\1_12</Filter>
+    </ClInclude>
+    <ClInclude Include="Rest\Schema\1_12\Json\ManifestDeserializer.h">
+      <Filter>Rest\Schema\1_12\Json</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.cpp">
@@ -758,6 +770,12 @@
     <ClCompile Include="Rest\Schema\1_10\Json\ManifestDeserializer_1_10.cpp">
       <Filter>Rest\Schema\1_10\Json</Filter>
     </ClCompile>
+    <ClCompile Include="Rest\Schema\1_12\RestInterface_1_12.cpp">
+      <Filter>Rest\Schema\1_12</Filter>
+    </ClCompile>
+    <ClCompile Include="Rest\Schema\1_12\Json\ManifestDeserializer_1_12.cpp">
+      <Filter>Rest\Schema\1_12\Json</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />
diff --git a/src/AppInstallerRepositoryCore/ManifestJSONParser.cpp b/src/AppInstallerRepositoryCore/ManifestJSONParser.cpp
@@ -10,6 +10,7 @@
 #include "Rest/Schema/1_7/Json/ManifestDeserializer.h"
 #include "Rest/Schema/1_9/Json/ManifestDeserializer.h"
 #include "Rest/Schema/1_10/Json/ManifestDeserializer.h"
+#include "Rest/Schema/1_12/Json/ManifestDeserializer.h"
 
 namespace AppInstaller::Repository::JSON
 {
@@ -56,10 +57,14 @@ namespace AppInstaller::Repository::JSON
             {
                 m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_9::Json::ManifestDeserializer>();
             }
-            else
+            else if (parts.size() > 1 && parts[1].Integer < 12)
             {
                 m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_10::Json::ManifestDeserializer>();
             }
+            else
+            {
+                m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_12::Json::ManifestDeserializer>();
+            }
         }
         else
         {
diff --git a/src/AppInstallerRepositoryCore/Rest/RestClient.cpp b/src/AppInstallerRepositoryCore/Rest/RestClient.cpp
@@ -10,6 +10,7 @@
 #include "Rest/Schema/1_7/Interface.h"
 #include "Rest/Schema/1_9/Interface.h"
 #include "Rest/Schema/1_10/Interface.h"
+#include "Rest/Schema/1_12/Interface.h"
 #include "Rest/Schema/InformationResponseDeserializer.h"
 #include "Rest/Schema/CommonRestConstants.h"
 #include <winget/HttpClientHelper.h>
@@ -24,7 +25,17 @@ 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, Version_1_9_0, Version_1_10_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,
+        Version_1_10_0,
+        Version_1_12_0,
+    };
 
     constexpr std::string_view WindowsPackageManagerHeader = "Windows-Package-Manager"sv;
     constexpr size_t WindowsPackageManagerHeaderMaxLength = 1024;
@@ -186,6 +197,10 @@ namespace AppInstaller::Repository::Rest
         {
             return std::make_unique<Schema::V1_10::Interface>(api, helper, information, additionalHeaders, authArgs);
         }
+        else if (version == Version_1_12_0)
+        {
+            return std::make_unique<Schema::V1_12::Interface>(api, helper, information, additionalHeaders, authArgs);
+        }
 
         THROW_HR(APPINSTALLER_CLI_ERROR_RESTSOURCE_INVALID_VERSION);
     }
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_12/Interface.h b/src/AppInstallerRepositoryCore/Rest/Schema/1_12/Interface.h
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#pragma once
+#include "Rest/Schema/1_10/Interface.h"
+
+namespace AppInstaller::Repository::Rest::Schema::V1_12
+{
+    // Interface to this schema version exposed through IRestClient.
+    struct Interface : public V1_10::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_12/Json/ManifestDeserializer.h b/src/AppInstallerRepositoryCore/Rest/Schema/1_12/Json/ManifestDeserializer.h
@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#pragma once
+#include "Rest/Schema/1_10/Json/ManifestDeserializer.h"
+
+namespace AppInstaller::Repository::Rest::Schema::V1_12::Json
+{
+    // Manifest Deserializer.
+    struct ManifestDeserializer : public V1_10::Json::ManifestDeserializer
+    {
+    protected:
+
+        Manifest::InstallerTypeEnum ConvertToInstallerType(std::string_view in) const override;
+
+        Manifest::ManifestVer GetManifestVersion() const override;
+    };
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_12/Json/ManifestDeserializer_1_12.cpp b/src/AppInstallerRepositoryCore/Rest/Schema/1_12/Json/ManifestDeserializer_1_12.cpp
@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "ManifestDeserializer.h"
+#include "Rest/Schema/AuthenticationInfoParser.h"
+#include <winget/JsonUtil.h>
+
+using namespace AppInstaller::Manifest;
+
+namespace AppInstaller::Repository::Rest::Schema::V1_12::Json
+{
+    Manifest::InstallerTypeEnum ManifestDeserializer::ConvertToInstallerType(std::string_view in) const
+    {
+        std::string inStrLower = Utility::ToLower(in);
+
+        if (inStrLower == "font")
+        {
+            return InstallerTypeEnum::Font;
+        }
+
+        return V1_10::Json::ManifestDeserializer::ConvertToInstallerType(inStrLower);
+    }
+
+    Manifest::ManifestVer ManifestDeserializer::GetManifestVersion() const
+    {
+        return Manifest::s_ManifestVersionV1_12;
+    }
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/1_12/RestInterface_1_12.cpp b/src/AppInstallerRepositoryCore/Rest/Schema/1_12/RestInterface_1_12.cpp
@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "Rest/Schema/1_12/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_12
+{
+    Interface::Interface(
+        const std::string& restApi,
+        const Http::HttpClientHelper& httpClientHelper,
+        IRestClient::Information information,
+        const Http::HttpClientHelper::HttpRequestHeaders& additionalHeaders,
+        Authentication::AuthenticationArguments authArgs) : V1_10::Interface(restApi, httpClientHelper, std::move(information), additionalHeaders, std::move(authArgs))
+    {
+        m_requiredRestApiHeaders[JSON::GetUtilityString(ContractVersion)] = JSON::GetUtilityString(Version_1_12_0.ToString());
+    }
+
+    Utility::Version Interface::GetVersion() const
+    {
+        return Version_1_12_0;
+    }
+}
diff --git a/src/AppInstallerRepositoryCore/Rest/Schema/CommonRestConstants.h b/src/AppInstallerRepositoryCore/Rest/Schema/CommonRestConstants.h
@@ -14,6 +14,7 @@ namespace AppInstaller::Repository::Rest::Schema
     const Utility::Version Version_1_7_0{ "1.7.0" };
     const Utility::Version Version_1_9_0{ "1.9.0" };
     const Utility::Version Version_1_10_0{ "1.10.0" };
+    const Utility::Version Version_1_12_0{ "1.12.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
@@ -37,6 +37,7 @@ private enum TestManifestVersion
             V1_7_0,
             V1_9_0,
             V1_10_0,
+            V1_12_0,
         }
 
         /// <summary>
@@ -75,6 +76,11 @@ public void ReadV1ManifestsAndVerifyContents()
                 Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "TestCollateral", ManifestStrings.V1_10_0ManifestMerged));
 
             this.ValidateManifestFields(v1_10_0manifest, TestManifestVersion.V1_10_0);
+
+            Manifest v1_12_0manifest = Manifest.CreateManifestFromPath(
+                Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "TestCollateral", ManifestStrings.V1_12_0ManifestMerged));
+
+            this.ValidateManifestFields(v1_12_0manifest, TestManifestVersion.V1_12_0);
         }
 
         /// <summary>
@@ -293,7 +299,15 @@ private void ValidateManifestFields(Manifest manifest, TestManifestVersion manif
             }
 
             // Individual installers
-            Assert.Equal(2, manifest.Installers.Count);
+            if (manifestVersion >= TestManifestVersion.V1_12_0)
+            {
+                Assert.Equal(4, manifest.Installers.Count);
+            }
+            else
+            {
+                Assert.Equal(2, manifest.Installers.Count);
+            }
+
             ManifestInstaller installer1 = manifest.Installers[0];
             Assert.Equal("x86", installer1.Arch);
             Assert.Equal("en-GB", installer1.InstallerLocale);
@@ -462,6 +476,30 @@ private void ValidateManifestFields(Manifest manifest, TestManifestVersion manif
                 Assert.Equal("32x32", icon.IconResolution);
                 Assert.Equal("png", icon.IconFileType);
             }
+
+            if (manifestVersion >= TestManifestVersion.V1_12_0)
+            {
+                // Manifest v12 adds support for the Font installer type and NestedInstallerType,
+                // with two additional installers added to the merged manifest to verify these.
+                ManifestInstaller installer3 = manifest.Installers[2];
+                Assert.Equal("neutral", installer3.Arch);
+                Assert.Equal("zip", installer3.InstallerType);
+                Assert.Equal("https://www.microsoft.com/msixsdk/msixsdkx64.exe", installer3.Url);
+                Assert.Equal("69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82", installer3.Sha256);
+                Assert.Equal("font", installer3.NestedInstallerType);
+                Assert.Equal(5, installer3.NestedInstallerFiles.Count);
+                Assert.Equal("relativeFilePath1.otf", installer3.NestedInstallerFiles[0].RelativeFilePath);
+                Assert.Equal("relativeFilePath2.ttf", installer3.NestedInstallerFiles[1].RelativeFilePath);
+                Assert.Equal("relativeFilePath3.fnt", installer3.NestedInstallerFiles[2].RelativeFilePath);
+                Assert.Equal("relativeFilePath4.ttc", installer3.NestedInstallerFiles[3].RelativeFilePath);
+                Assert.Equal("relativeFilePath5.otc", installer3.NestedInstallerFiles[4].RelativeFilePath);
+
+                ManifestInstaller installer4 = manifest.Installers[3];
+                Assert.Equal("neutral", installer4.Arch);
+                Assert.Equal("font", installer4.InstallerType);
+                Assert.Equal("https://www.microsoft.com/msixsdk/msixsdkx64.exe", installer4.Url);
+                Assert.Equal("69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82", installer4.Sha256);
+            }
         }
 
         /// <summary>
@@ -499,6 +537,11 @@ internal class ManifestStrings
             /// Merged v1.10 manifest.
             /// </summary>
             public const string V1_10_0ManifestMerged = "V1_10ManifestMerged.yaml";
+
+            /// <summary>
+            /// Merged v1.12 manifest.
+            /// </summary>
+            public const string V1_12_0ManifestMerged = "V1_12ManifestMerged.yaml";
 #pragma warning restore SA1310 // FieldNamesMustNotContainUnderscore
 
             /// <summary>
diff --git a/src/WinGetUtilInterop.UnitTests/TestCollateral/V1_12ManifestMerged.yaml b/src/WinGetUtilInterop.UnitTests/TestCollateral/V1_12ManifestMerged.yaml
diff --git a/src/WinGetUtilInterop.UnitTests/WinGetUtilInterop.UnitTests.csproj b/src/WinGetUtilInterop.UnitTests/WinGetUtilInterop.UnitTests.csproj

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`#include "Rest/Schema/1_7/Json/ManifestDeserializer.h"`
`11`	`11`	`#include "Rest/Schema/1_9/Json/ManifestDeserializer.h"`
`12`	`12`	`#include "Rest/Schema/1_10/Json/ManifestDeserializer.h"`
	`13`	`+#include "Rest/Schema/1_12/Json/ManifestDeserializer.h"`
`13`	`14`
`14`	`15`	`namespace AppInstaller::Repository::JSON`
`15`	`16`	`{`
`@@ -56,10 +57,14 @@ namespace AppInstaller::Repository::JSON`
`56`	`57`	`{`
`57`	`58`	`m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_9::Json::ManifestDeserializer>();`
`58`	`59`	`}`
`59`		`- else`
	`60`	`+ else if (parts.size() > 1 && parts[1].Integer < 12)`
`60`	`61`	`{`
`61`	`62`	`m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_10::Json::ManifestDeserializer>();`
`62`	`63`	`}`
	`64`	`+ else`
	`65`	`+ {`
	`66`	`+ m_pImpl->m_deserializer = std::make_unique<Rest::Schema::V1_12::Json::ManifestDeserializer>();`
	`67`	`+ }`
`63`	`68`	`}`
`64`	`69`	`else`
`65`	`70`	`{`