Adding a workaround for a nullref in MSBuild logging (#5144)

There's a nullref in MSBuild logging that's currently affecting multiple repos: microsoft/azure-pipelines-tasks#14904 The workaround is to turn off logging until the issue is fixed. This also contains fixes to get WpfApp building in VS 16.10.
microsoft · Jun 7, 2021 · c9a7f08 · c9a7f08
1 parent f068430
commit c9a7f08
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 8 deletions.
diff --git a/build/AzurePipelinesTemplates/MUX-BuildProject-Steps.yml b/build/AzurePipelinesTemplates/MUX-BuildProject-Steps.yml
@@ -56,6 +56,8 @@ steps:
       vsVersion: 16.0
       platform: '$(buildPlatform)'
       configuration: '$(buildConfiguration)'
+      # Workaround for an MSBuild logging nullref - remove when https://github.com/microsoft/azure-pipelines-tasks/issues/14904 is fixed.
+      enableDefaultLogger: false
       msbuildArgs: '/restore /p:UseInsiderSDK=$(UseInsiderSDK) /p:AppxPackageDir="${{ parameters.appxPackageDir }}" /p:AppxBundle=Never /p:AppxSymbolPackageEnabled=false /binaryLogger:$(Build.SourcesDirectory)/${{ parameters.solutionPath }}.$(buildPlatform).$(buildConfiguration).binlog /p:MUXVersionBuild=$(builddate_yymm) /p:MUXVersionRevision=$(builddate_dd)$(buildrevision) /p:VCToolsInstallDir="$(VCToolsInstallDir)\" /p:PGOBuildMode=$(PGOBuildMode)'
 
   - task: PublishBuildArtifacts@1

diff --git a/test/MUXControlsReleaseTest/MUXControls.ReleaseTest/XamlIslandsTests.cs b/test/MUXControlsReleaseTest/MUXControls.ReleaseTest/XamlIslandsTests.cs
@@ -30,6 +30,7 @@ public class XamlIslandsTests : XamlIslandsTestsBase
         [TestProperty("Classification", "Integration")]
         [TestProperty("TestPass:IncludeOnlyOn", "Desktop")]
         [TestProperty("NugetPkgTestsOnly", "True")] // WPF apps don't properly pick up framework packages' contents.
+        [TestProperty("Ignore", "True")] // Remove once https://github.com/microsoft/microsoft-ui-xaml/issues/5152 is fixed.
         public static void ClassInitialize(TestContext testContext)
         {
             if (!PlatformConfiguration.IsOsVersionGreaterThan(OSVersion.Redstone5))

diff --git a/test/MUXControlsReleaseTest/XamlIslandsTestApp/WpfApp/WpfApp.Package.wapproj b/test/MUXControlsReleaseTest/XamlIslandsTestApp/WpfApp/WpfApp.Package.wapproj
@@ -38,6 +38,7 @@
     <AppxPackageName>WpfApp</AppxPackageName>
     <AppxBundleNameForOutput>WpfApp</AppxBundleNameForOutput>
     <PackageCertificateKeyFile>..\..\..\..\build\MSTest.pfx</PackageCertificateKeyFile>
+    <AppxValidateAppxManifest>false</AppxValidateAppxManifest>
   </PropertyGroup>
   <ItemGroup>
     <AppxManifest Include="Package.appxmanifest">
@@ -73,6 +74,74 @@
       <Version>2.1.190606001</Version>
     </PackageReference>
   </ItemGroup>
+  <!-- For reasons that are unclear, MSBuild generates an AppX manifest that has two duplicate entries for Microsoft.UI.Xaml.dll
+       and does not point the other DLLs at the version in the WpfApp subfolder.  We want them all to point at the WpfApp subfolder,
+       so we'll remove the one entry that already points there and point the rest there. -->
+  <UsingTask TaskName="RepathRootWinMDEntries" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
+    <ParameterGroup>
+      <PathToAppxManifest ParameterType="System.String" Required="true" />
+    </ParameterGroup>
+    <Task>
+        <Reference Include="System.Xml" />
+        <Using Namespace="System" />
+        <Using Namespace="System.Xml" />
+        <Using Namespace="System.Collections.Generic" />
+        <Using Namespace="System.IO" />
+        <Code Type="Fragment" Language="cs"><![CDATA[
+            if (File.Exists(PathToAppxManifest))
+            {
+                Log.LogMessage(File.ReadAllText(PathToAppxManifest));
+                
+                // Load AppxManifest.xml
+                XmlDocument appxManifest = new XmlDocument();
+                appxManifest.Load(PathToAppxManifest);
+
+                XmlNamespaceManager namespaceManager = new XmlNamespaceManager(appxManifest.NameTable);
+                namespaceManager.AddNamespace("w", "http://schemas.microsoft.com/appx/manifest/foundation/windows10");
+
+                // For each extension node, if it doesn't have a "WpfApp\" subfolder prefix in its path, add one.
+                // If we've already seen the path, then we'll remove it to avoid duplication.
+                XmlNode extensionsNode = null;
+
+                foreach (XmlNode node in appxManifest.DocumentElement.SelectNodes("//w:Package/w:Extensions", namespaceManager))
+                {
+                    extensionsNode = node;
+                    break;
+                }
+
+                if (extensionsNode != null)
+                {
+                    List<string> pathsSeen = new List<string>();
+                    XmlNodeList xmlNodeList = appxManifest.DocumentElement.SelectNodes("//w:Package/w:Extensions/w:Extension", namespaceManager);
+
+                    foreach (XmlNode node in xmlNodeList)
+                    {
+                        XmlNode pathNode = node.SelectSingleNode("w:InProcessServer/w:Path", namespaceManager);
+                        string path = pathNode.InnerText.Replace(@"WpfApp\", "");
+                        
+                        if (pathsSeen.Contains(path))
+                        {
+                            extensionsNode.RemoveChild(node);
+                        }
+                        else
+                        {
+                            pathNode.InnerText = @"WpfApp\" + path;
+                            pathsSeen.Add(path);
+                        }
+                    }
+                }
+
+                // Save the updated AppxManifest.xml file
+                appxManifest.Save(PathToAppxManifest);
+                Log.LogMessage(File.ReadAllText(PathToAppxManifest));
+            }
+        ]]></Code>
+    </Task>
+  </UsingTask>
+  <Target Name="RepathRootWinMDEntries" AfterTargets="_ValidateAppxPackage" BeforeTargets="_GenerateAppxPackageFile" Inputs="$(FinalAppxManifestName)" Outputs="$(FinalAppxManifestName).incremental">
+    <RepathRootWinMDEntries PathToAppxManifest="$(FinalAppxManifestName)" />
+    <Touch Files="$(FinalAppxManifestName).incremental" AlwaysCreate="True" />
+  </Target>
   <!-- For reasons that are unclear, _RemoveExtraPriFiles fails to remove an instance of AppTestAutomationHelpers.pri,
        which causes an duplicate item issue during MakePri.exe.  We'll remove it explicitly to avoid that. -->
   <Target Name="RemoveAnotherExtraPriFile" AfterTargets="_RemoveExtraPriFiles" BeforeTargets="_GenerateProjectPriConfigurationFiles">
@@ -88,9 +157,15 @@
   <Target Name="PlaceEverythingInAppDirectory" AfterTargets="_ValidateAppxPackage" BeforeTargets="_GenerateAppxPackageFile">
     <ItemGroup>
       <AppxPackagePayloadToCopy Include="@(AppxPackagePayload)" Condition="'%(TargetPath)' == '%(Filename)%(Extension)' and ('%(Extension)' == '.dll' or '%(Extension)' == '.winmd')" />
+      <AppxPackagePayload Remove="@(AppxPackagePayloadToCopy)" />
       <AppxPackagePayload Include="@(AppxPackagePayloadToCopy)">
         <TargetPath>$(AppxPackageName)\%(Filename)%(Extension)</TargetPath>
       </AppxPackagePayload>
+      <AppxUploadPackagePayloadToCopy Include="@(AppxUploadPackagePayload)" Condition="'%(TargetPath)' == '%(Filename)%(Extension)' and ('%(Extension)' == '.dll' or '%(Extension)' == '.winmd')" />
+      <AppxUploadPackagePayload Remove="@(AppxUploadPackagePayloadToCopy)" />
+      <AppxUploadPackagePayload Include="@(AppxUploadPackagePayloadToCopy)">
+        <TargetPath>$(AppxPackageName)\%(Filename)%(Extension)</TargetPath>
+      </AppxUploadPackagePayload>
     </ItemGroup>
   </Target>
   <!-- We also need to remove the UWP app payload that conflicts with the desktop DLLs.

diff --git a/test/MUXControlsReleaseTest/XamlIslandsTestApp/WpfApp/WpfApp.csproj b/test/MUXControlsReleaseTest/XamlIslandsTestApp/WpfApp/WpfApp.csproj
@@ -20,6 +20,10 @@
     <PublishSingleFile>False</PublishSingleFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Page Remove="bin\**\*" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Toolkit.Wpf.UI.XamlHost" Version="6.1.2" />
   </ItemGroup>
@@ -53,16 +57,16 @@
     <Unzip SourceFiles="$(VCLibsLocation)Microsoft.VCLibs.$(Platform)$(VCLibsDebug).14.00.appx" DestinationFolder="$(VCLibsTempDir)" />
     <Unzip SourceFiles="$(VCLibsDesktopLocation)Microsoft.VCLibs.$(Platform)$(VCLibsDebug).14.00.Desktop.appx" DestinationFolder="$(VCLibsDesktopTempDir)" />
     <ItemGroup>
-      <VCLibsDlls Include="$(VCLibsTempDir)msvcp140_app.dll" />
-      <VCLibsDlls Include="$(VCLibsTempDir)vcruntime140_app.dll" />
-      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)msvcp140.dll" />
-      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)vcruntime140.dll" />
+      <VCLibsDlls Include="$(VCLibsTempDir)msvcp140*_app.dll" />
+      <VCLibsDlls Include="$(VCLibsTempDir)vcruntime140*_app.dll" />
+      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)msvcp140*.dll" />
+      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)vcruntime*140.dll" />
     </ItemGroup>
     <ItemGroup Condition="'$(Configuration)' == 'Debug'">
-      <VCLibsDlls Include="$(VCLibsTempDir)msvcp140d_app.dll" />
-      <VCLibsDlls Include="$(VCLibsTempDir)vcruntime140d_app.dll" />
-      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)msvcp140d.dll" />
-      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)vcruntime140d.dll" />
+      <VCLibsDlls Include="$(VCLibsTempDir)msvcp140*d_app.dll" />
+      <VCLibsDlls Include="$(VCLibsTempDir)vcruntime140*d_app.dll" />
+      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)msvcp140*d.dll" />
+      <VCLibsDesktopDlls Include="$(VCLibsDesktopTempDir)vcruntime140*d.dll" />
     </ItemGroup>
     <Copy SourceFiles="@(VCLibsDlls)" DestinationFiles="@(VCLibsDlls -> '$(OutDir)%(Filename)%(Extension)')" SkipUnchangedFiles="True" />
     <RemoveDir Directories="$(VCLibsTempDir)" Condition="Exists('$(VCLibsTempDir)')" />