Update to WinAppSDK 1.5 and .NET8; PublishSingleFile for unpackaged c…

…onfigs; fix compile warnings (#1483)
microsoft · Mar 12, 2024 · 2f7da4d · 2f7da4d
1 parent b9d1ad8
commit 2f7da4d
Show file tree

Hide file tree

Showing 15 changed files with 77 additions and 114 deletions.
diff --git a/WinUIGallery/Common/SuspensionManager.cs b/WinUIGallery/Common/SuspensionManager.cs
@@ -1,11 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.Serialization;
-using System.Text;
 using System.Threading.Tasks;
-using Windows.ApplicationModel;
 using Windows.Storage;
 using Windows.Storage.Streams;
 using Microsoft.UI.Xaml;
@@ -47,15 +45,17 @@ public static Dictionary<string, object> SessionState
         public static List<Type> KnownTypes
         {
             get { return _knownTypes; }
-        }
-
+        }
+
         /// <summary>
         /// Save the current <see cref="SessionState"/>.  Any <see cref="Frame"/> instances
         /// registered with <see cref="RegisterFrame"/> will also preserve their current
         /// navigation stack, which in turn gives their active <see cref="Page"/> an opportunity
         /// to save its state.
         /// </summary>
         /// <returns>An asynchronous task that reflects when session state has been saved.</returns>
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026",
+            Justification = "From manual inspection, _sessionState only serializes Dictionaries of strings")]
         public static async Task SaveAsync()
         {
             try
@@ -72,7 +72,7 @@ public static async Task SaveAsync()
                 // Serialize the session state synchronously to avoid asynchronous access to shared
                 // state
                 MemoryStream sessionData = new MemoryStream();
-                DataContractSerializer serializer = new DataContractSerializer(typeof(Dictionary<string, object>), _knownTypes);
+                DataContractSerializer serializer = new DataContractSerializer(typeof(Dictionary<string, object>), _knownTypes);
                 serializer.WriteObject(sessionData, _sessionState);
 
                 // Get an output stream for the SessionState file and write the state asynchronously
@@ -99,6 +99,8 @@ public static async Task SaveAsync()
         /// <returns>An asynchronous task that reflects when session state has been read.  The
         /// content of <see cref="SessionState"/> should not be relied upon until this task
         /// completes.</returns>
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026",
+            Justification = "From manual inspection, _sessionState only serializes Dictionaries of strings")]
         public static async Task RestoreAsync()
         {
             _sessionState = new Dictionary<string, object>();

diff --git a/WinUIGallery/ControlPages/DesignGuidance/IconsPage.xaml.cs b/WinUIGallery/ControlPages/DesignGuidance/IconsPage.xaml.cs
@@ -33,7 +33,6 @@ public sealed partial class IconsPage : Page
             };
 
         private string currentSearch = null;
-        private Thread searchThread = null;
 
         public IconData SelectedItem
         {

diff --git a/WinUIGallery/DataModel/ControlInfoDataSource.cs b/WinUIGallery/DataModel/ControlInfoDataSource.cs
@@ -11,9 +11,11 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Linq;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 using WinUIGallery.Common;
-using System.Text.Json;
+using WinUIGallery.DesktopWap.DataModel;
 
 // The data model defined by this file serves as a representative example of a strongly-typed
 // model.  The property names chosen coincide with data bindings in the standard item templates.
@@ -29,6 +31,12 @@ public class Root
     {
         public ObservableCollection<ControlInfoDataGroup> Groups { get; set; }
     }
+    [JsonSourceGenerationOptions(PropertyNameCaseInsensitive = true)]
+    [JsonSerializable(typeof(Root))]
+    internal partial class RootContext : JsonSerializerContext
+    {
+    }
+
     /// <summary>
     /// Generic item data model.
     /// </summary>
@@ -173,11 +181,8 @@ private async Task GetControlInfoDataAsync()
                 }
             }
 
-            var jsonText = await FileLoader.LoadText("DataModel/ControlInfoData.json");
-            var controlInfoDataGroup = JsonSerializer.Deserialize<Root>(jsonText, new JsonSerializerOptions
-            {
-                PropertyNameCaseInsensitive = true
-            });
+            var jsonText = await FileLoader.LoadText("DataModel/ControlInfoData.json");
+            var controlInfoDataGroup = JsonSerializer.Deserialize(jsonText, typeof(Root), RootContext.Default) as Root;
 
             lock (_lock)
             {

diff --git a/WinUIGallery/DataModel/IconsDataSource.cs b/WinUIGallery/DataModel/IconsDataSource.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 using WinUIGallery.Common;
 
@@ -14,6 +15,11 @@ public class IconData
         public string Character => char.ConvertFromUtf32(Convert.ToInt32(Code, 16));
         public string CodeGlyph => "\\u" + Code;
         public string TextGlyph => "&#x" + Code + ";";
+    }
+    [JsonSourceGenerationOptions(PropertyNameCaseInsensitive = true)]
+    [JsonSerializable(typeof(List<IconData>))]
+    internal partial class IconDataListContext : JsonSerializerContext
+    {
     }
 
     internal class IconsDataSource
@@ -41,11 +47,8 @@ public async Task<List<IconData>> LoadIcons()
             lock (_lock)
             {
                 if (icons.Count == 0)
-                {
-                    icons = JsonSerializer.Deserialize<List<IconData>>(jsonText, new JsonSerializerOptions
-                    {
-                        PropertyNameCaseInsensitive = true
-                    });
+                {
+                    icons = JsonSerializer.Deserialize(jsonText, typeof(List<IconData>), IconDataListContext.Default) as List<IconData>;
                 }
                 return icons;
             }

diff --git a/...erties/PublishProfiles/win10-arm64.pubxml → ...operties/PublishProfiles/win-arm64.pubxml b/...erties/PublishProfiles/win10-arm64.pubxml → ...operties/PublishProfiles/win-arm64.pubxml
@@ -6,12 +6,11 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
   <PropertyGroup>
     <PublishProtocol>FileSystem</PublishProtocol>
     <Platform>ARM64</Platform>
-    <RuntimeIdentifier>win10-arm64</RuntimeIdentifier>
+    <RuntimeIdentifier>win-arm64</RuntimeIdentifier>
     <!--NOTE: this refers to .NET (not WinAppSDK) self-containment which must always be true, 
         since there is no Windows framework package available for .NET 5+ -->
     <SelfContained>True</SelfContained>
-    <PublishSingleFile>False</PublishSingleFile>
-    <PublishAppxPackage>True</PublishAppxPackage>
+    <PublishAppxPackage>$(Packaged)</PublishAppxPackage>
     <PublishReadyToRun>False</PublishReadyToRun>
     <PublishTrimmed>$(Optimized)</PublishTrimmed>
     <!--With .NET 7, trimming mode default changed from partial to full which is more 

diff --git a/...operties/PublishProfiles/win10-x64.pubxml → ...Properties/PublishProfiles/win-x64.pubxml b/...operties/PublishProfiles/win10-x64.pubxml → ...Properties/PublishProfiles/win-x64.pubxml
@@ -6,12 +6,11 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
   <PropertyGroup>
     <PublishProtocol>FileSystem</PublishProtocol>
     <Platform>x64</Platform>
-    <RuntimeIdentifier>win10-x64</RuntimeIdentifier>
+    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
     <!--NOTE: this refers to .NET (not WinAppSDK) self-containment which must always be true, 
         since there is no Windows framework package available for .NET 5+ -->
     <SelfContained>True</SelfContained>
-    <PublishSingleFile>False</PublishSingleFile>
-    <PublishAppxPackage>True</PublishAppxPackage>
+    <PublishAppxPackage>$(Packaged)</PublishAppxPackage>
     <PublishReadyToRun>False</PublishReadyToRun>
     <PublishTrimmed>$(Optimized)</PublishTrimmed>
     <!--With .NET 7, trimming mode default changed from partial to full which is more 

diff --git a/...operties/PublishProfiles/win10-x86.pubxml → ...Properties/PublishProfiles/win-x86.pubxml b/...operties/PublishProfiles/win10-x86.pubxml → ...Properties/PublishProfiles/win-x86.pubxml
@@ -6,12 +6,11 @@ https://go.microsoft.com/fwlink/?LinkID=208121.
   <PropertyGroup>
     <PublishProtocol>FileSystem</PublishProtocol>
     <Platform>x86</Platform>
-    <RuntimeIdentifier>win10-x86</RuntimeIdentifier>
+    <RuntimeIdentifier>win-x86</RuntimeIdentifier>
     <!--NOTE: this refers to .NET (not WinAppSDK) self-containment which must always be true, 
         since there is no Windows framework package available for .NET 5+ -->
     <SelfContained>True</SelfContained>
-    <PublishSingleFile>False</PublishSingleFile>
-    <PublishAppxPackage>True</PublishAppxPackage>
+    <PublishAppxPackage>$(Packaged)</PublishAppxPackage>
     <PublishReadyToRun>False</PublishReadyToRun>
     <PublishTrimmed>$(Optimized)</PublishTrimmed>
     <!--With .NET 7, trimming mode default changed from partial to full which is more 

diff --git a/WinUIGallery/Properties/PublishProfiles/win10-arm64-unpackaged.pubxml b/WinUIGallery/Properties/PublishProfiles/win10-arm64-unpackaged.pubxml
diff --git a/WinUIGallery/Properties/PublishProfiles/win10-x64-unpackaged.pubxml b/WinUIGallery/Properties/PublishProfiles/win10-x64-unpackaged.pubxml
diff --git a/WinUIGallery/Properties/PublishProfiles/win10-x86-unpackaged.pubxml b/WinUIGallery/Properties/PublishProfiles/win10-x86-unpackaged.pubxml
diff --git a/WinUIGallery/WinUIGallery.DesktopWap.Package.wapproj b/WinUIGallery/WinUIGallery.DesktopWap.Package.wapproj
@@ -38,7 +38,7 @@
   <Import Project="common.props" />
   <PropertyGroup>
     <ProjectGuid>4c7b20d7-5f5c-440e-8da3-b19a328cc8bd</ProjectGuid>
-    <TargetPlatformVersion>10.0.19041.0</TargetPlatformVersion>
+    <TargetPlatformVersion>10.0.22621.0</TargetPlatformVersion>
     <TargetPlatformMinVersion>10.0.17763.0</TargetPlatformMinVersion>
     <DefaultLanguage>en-US</DefaultLanguage>
     <AppxPackageSigningEnabled>True</AppxPackageSigningEnabled>
@@ -90,7 +90,7 @@
   <ItemGroup>
     <ProjectReference Include="WinUIGallery.csproj">
       <SkipGetTargetFrameworkProperties>True</SkipGetTargetFrameworkProperties>
-      <PublishProfile>Properties\PublishProfiles\win10-$(Platform).pubxml</PublishProfile>
+      <PublishProfile>Properties\PublishProfiles\win-$(Platform).pubxml</PublishProfile>
     </ProjectReference>
   </ItemGroup>
   <ItemGroup Condition="'$(WindowsAppSdkPackageVersion)' != ''">

diff --git a/WinUIGallery/WinUIGallery.csproj b/WinUIGallery/WinUIGallery.csproj
@@ -1,16 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <Sdk Name="Microsoft.Build.CentralPackageVersions" Version="2.0.1" />
     <PropertyGroup>
-        <TargetFramework>$(SamplesTargetFrameworkMoniker)</TargetFramework>
-        <TargetPlatformMinVersion>10.0.17763.0</TargetPlatformMinVersion>
         <OutputType>WinExe</OutputType>
+        <TargetFramework>$(SamplesTargetFrameworkMoniker)</TargetFramework>
+        <TargetPlatformVersion>$(WindowsSdkTargetPlatformVersion)</TargetPlatformVersion>
+        <TargetPlatformMinVersion>$(WindowsAppSdkTargetPlatformVersion)</TargetPlatformMinVersion>
         <UseWinUI>true</UseWinUI>
-        <DefineConstants Condition="'$(WindowsAppSdkSelfContained)'==''">$(DefineConstants);WindowsAppSdkRuntimeDependent</DefineConstants>
         <ApplicationManifest>app.manifest</ApplicationManifest>
         <Platforms>x86;x64;ARM64</Platforms>
         <NoWarn>8305</NoWarn>
         <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
-        <RuntimeIdentifiers>win10-x86;win10-x64;win10-arm64</RuntimeIdentifiers>
+        <RuntimeIdentifiers>win-x86;win-x64;win-arm64</RuntimeIdentifiers>
         <NoWarn>
             0108;   <!-- 'x' hides inherited member 'y'. Use the new keyword if hiding was intended. -->
             8305    <!-- 'x' is for evaluation purposes only and is subject to change or removal in future updates. -->
@@ -26,19 +26,25 @@
         <Packaged Condition="'$(Configuration)' == 'Debug-Unpackaged' Or '$(Configuration)' == 'Release-Unpackaged'">false</Packaged>
         <Optimized>true</Optimized>
         <Optimized Condition="'$(Configuration)' == 'Debug-Unpackaged' Or '$(Configuration)' == 'Debug'">false</Optimized>
+        <!-- In .NET 8, serialization is prohibited by default - we can safely use it since we're not dealing with UDTs. -->
+        <JsonSerializerIsReflectionEnabledByDefault>true</JsonSerializerIsReflectionEnabledByDefault>
         <SingleProject>true</SingleProject>
         <SingleProject Condition="'$(SolutionName)' == 'WinUIGallery.DesktopWap'">false</SingleProject>
         <WindowsAppSdkIncludeVersionInfo>true</WindowsAppSdkIncludeVersionInfo>
+        <PublishProfile>win-$(Platform).pubxml</PublishProfile>
+        <PublishSingleFile Condition="'$(PublishSingleFile)' == '' and '$(Packaged)' != 'true'">true</PublishSingleFile>
+        <WindowsAppSdkSelfContained Condition="'$(WindowsAppSdkSelfContained)' == '' and '$(PublishSingleFile)' == 'true'">true</WindowsAppSdkSelfContained>
+        <!-- Enable ExplicitlyIncludeVersionInfo workaround by setting WindowsAppSdkSelfContained earlier than the mock package would -->
+        <WindowsAppSdkSelfContained Condition="'$(IsInWinUIRepo)' == 'true' and '$(WindowsAppSdkSelfContained)'==''">true</WindowsAppSdkSelfContained>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(Packaged)' != 'true' and '$(SingleProject)'=='true'">
-        <PublishProfile>win10-$(Platform)-unpackaged.pubxml</PublishProfile>
         <EnableMsixTooling>false</EnableMsixTooling>
+        <EnableMsixTooling Condition="'$(PublishSingleFile)'=='true'">true</EnableMsixTooling>
         <WindowsPackageType>None</WindowsPackageType>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(Packaged)' == 'true' and '$(SingleProject)'=='true'">
-        <PublishProfile>win10-$(Platform).pubxml</PublishProfile>
         <WindowsPackageType>MSIX</WindowsPackageType>
         <AppxBundleNameForOutput>WinUIGallery</AppxBundleNameForOutput>
         <EnableMsixTooling>true</EnableMsixTooling>
@@ -60,7 +66,7 @@
         <PackageCertificateKeyFile Condition="Exists('$(PfxFile)')">$(PfxFile)</PackageCertificateKeyFile>
     </PropertyGroup>
 
-    <ItemGroup Condition="'$(SingleProject)'=='true'">
+    <ItemGroup Condition="'$(Packaged)' == 'true' and '$(SingleProject)'=='true'">
         <AppxManifest Include="Package.appxmanifest" Condition="'$(Release)' == 'true'">
             <SubType>Designer</SubType>
         </AppxManifest>
@@ -85,6 +91,7 @@
       <EmbeddedResource Remove="Assets\ControlIcons\**" />
       <None Remove="Assets\ControlIcons\**" />
       <Page Remove="Assets\ControlIcons\**" />
+      <PRIResource Remove="Assets\ControlIcons\**" />
     </ItemGroup>
 
     <!-- In the WinUI repo, package reference versions are controlled centrally by a Packages.props.  We will
@@ -175,6 +182,7 @@
         <Content Include="Assets\Typography.light.png" />
         <Content Include="ControlPagesSampleCode\Icons\FontIconSample2_xaml.txt" />
         <Content Include="DataModel\IconsData.json" />
+        <Content Include="DataModel\ControlInfoData.json" />
     </ItemGroup>
     <ItemGroup>
         <Content Include="ControlPagesSampleCode\Typography\TypographySample_xaml.txt" />
@@ -255,18 +263,31 @@
         <Page Update="Controls\DesignGuidance\ColorSections\TextSection.xaml">
             <Generator>MSBuild:Compile</Generator>
         </Page>
+        <Page Update="ControlPages\SelectorBarPage.xaml">
+            <Generator>MSBuild:Compile</Generator>
+        </Page>
         <Page Update="SamplePages\SampleBuiltInSystemBackdropsWindow.xaml">
             <XamlRuntime>$(DefaultXamlRuntime)</XamlRuntime>
         </Page>
     </ItemGroup>
     <Import Project="ContentIncludes.props" />
-    <ItemGroup>
-      <PRIResource Remove="Assets\ControlIcons\**" />
-    </ItemGroup>
-    <ItemGroup>
-      <Page Update="ControlPages\SelectorBarPage.xaml">
-        <Generator>MSBuild:Compile</Generator>
-      </Page>
-    </ItemGroup>
-
+    <!--Per comment in Microsoft.Common.CurrentVersion.targets, the default GetCopyToPublishDirectoryItems 
+        just returns GetCopyToOutputDirectoryItems, which automatically includes the ContentWithTargetPath
+        and _NoneWithTargetPath items in the MSIX package.  The .NET GetCopyToPublishDirectoryItems 
+        overrides this and drops all these items unless they're specifically set to copy to the output
+        directory.  The default behavior is easier, so we'll mimic that here.-->
+    <Target Name="AddCopyToPublishDirectoryItems" Condition="'$(PublishSingleFile)'=='true'" BeforeTargets="GetCopyToPublishDirectoryItems" DependsOnTargets="AssignTargetPaths">
+        <ItemGroup>
+            <CurrentContentWithTargetPath Include="@(ContentWithTargetPath)"/>
+            <ContentWithTargetPath Remove="@(CurrentContentWithTargetPath )"/>
+            <ContentWithTargetPath Include="@(CurrentContentWithTargetPath )">
+                <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+            </ContentWithTargetPath>
+            <CurrentNoneWithTargetPath Include="@(_NoneWithTargetPath)"/>
+            <_NoneWithTargetPath Remove="@(CurrentNoneWithTargetPath )"/>
+            <_NoneWithTargetPath Include="@(CurrentNoneWithTargetPath )">
+                <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+            </_NoneWithTargetPath>
+        </ItemGroup>
+    </Target> 
 </Project>