Warn when Properties metadata overrides ProjectReference expansions metadata

Resolves 8967

Author: robmen

src/wix/WixToolset.BuildTasks/UpdateProjectReferenceMetadata.cs

@@ -364,7 +364,26 @@ public static ProjectReferenceFacade CreateFacade(ITaskItem projectReference, Ta
                     }
                 }
 
-                return new ProjectReferenceFacade(projectReference, configurations, null, platforms, null, targetFrameworks, null, runtimeIdentifiersValue.Values, null, publishBaseDir);
+                // If the Properties metadata is specified MSBuild will not use TargetFramework inference and require explicit declaration of
+                // our expansions (Configurations, Platforms, TargetFrameworks, RuntimeIdentifiers). Rather that try to interoperate, we'll
+                // warn the user that we're disabling our expansion behavior.
+                var propertiesValue = projectReference.GetMetadata("Properties");
+
+                if (!String.IsNullOrWhiteSpace(propertiesValue) && (configurationsValue.HadValue || platformsValue.HadValue || targetFrameworksValue.HadValue || runtimeIdentifiersValue.HadValue))
+                {
+                    logger.LogWarning(
+                        "ProjectReference '{0}' specifies 'Properties' metadata. " +
+                        "That overrides ProjectReference expansion so the 'Configurations', 'Platforms', 'TargetFrameworks', and 'RuntimeIdentifiers' metadata was ignored. " +
+                        "Instead, use the 'AdditionalProperties' metadata to pass properties to the referenced project without disabling ProjectReference expansion.",
+                        projectReference.ItemSpec);
+
+                    // Return a facade that does not participate in expansion.
+                    return new ProjectReferenceFacade(projectReference, Array.Empty<string>(), null, Array.Empty<string>(), null, Array.Empty<string>(), null, Array.Empty<string>(), null, publishBaseDir);
+                }
+                else
+                {
+                    return new ProjectReferenceFacade(projectReference, configurations, null, platforms, null, targetFrameworks, null, runtimeIdentifiersValue.Values, null, publishBaseDir);
+                }
             }
 
             public string CalculatePublishDir()

src/wix/test/WixToolsetTest.Sdk/MsbuildFixture.cs

@@ -14,7 +14,6 @@ namespace WixToolsetTest.Sdk
     using WixInternal.MSTestSupport;
     using WixToolset.Data;
     using WixToolset.Data.Symbols;
-    using WixToolset.Data.WindowsInstaller.Rows;
 
     [TestClass]
     public class MsbuildFixture
@@ -814,6 +813,36 @@ public void CanBuildMultiTargetingWixlibUsingRids(BuildSystem buildSystem)
             }
         }
 
+        [TestMethod]
+        [DataRow(BuildSystem.DotNetCoreSdk)]
+        [DataRow(BuildSystem.MSBuild)]
+        [DataRow(BuildSystem.MSBuild64)]
+        public void CanBuildUsingExplicitProperties(BuildSystem buildSystem)
+        {
+            var sourceFolder = TestData.Get(@"TestData", "MultiTargetingWixlib");
+
+            using (var fs = new TestDataFolderFileSystem())
+            {
+                fs.Initialize(sourceFolder);
+                var baseFolder = Path.Combine(fs.BaseFolder, "PackageUsingExplicitProperties");
+                var binFolder = Path.Combine(baseFolder, @"bin\");
+                var filesFolder = Path.Combine(binFolder, "Release", @"PFiles\");
+                var projectPath = Path.Combine(baseFolder, "PackageUsingExplicitProperties.wixproj");
+
+                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, [
+                    "-Restore",
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "WixMSBuildProps", MsbuildFixture.WixPropsPath)
+                    ]);
+                result.AssertSuccess();
+
+                var warnings = result.Output.Where(line => line.Contains(": warning")).Select(line => ExtractWarningFromMessage(line, baseFolder)).Distinct().ToArray();
+                WixAssert.CompareLineByLine(
+                [
+                    @": ProjectReference '..\TestExe\TestExe.csproj' specifies 'Properties' metadata. That overrides ProjectReference expansion so the 'Configurations', 'Platforms', 'TargetFrameworks', and 'RuntimeIdentifiers' metadata was ignored. Instead, use the 'AdditionalProperties' metadata to pass properties to the referenced project without disabling ProjectReference expansion.",
+                ], warnings);
+            }
+        }
+
         [TestMethod]
         [DataRow(BuildSystem.DotNetCoreSdk)]
         [DataRow(BuildSystem.MSBuild)]

src/wix/test/WixToolsetTest.Sdk/TestData/MultiTargetingWixlib/PackageUsingExplicitProperties/Package.wxs

@@ -0,0 +1,15 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+    <Package Name="Test Package" Manufacturer="~Test" Version="0" Compressed="false" UpgradeCode="11111111-1111-1111-1111-111111111111">
+        <Feature Id="Main">
+            <ComponentGroupRef Id="Stuff"/>
+        </Feature>
+    </Package>
+
+    <Fragment>
+        <ComponentGroup Id="Stuff" Directory="ProgramFilesFolder">
+            <Component Subdirectory="net8_x64">
+                <File Id="net8_x64" Source="!(bindpath.TestExe)\e_sqlite3.dll" />
+            </Component>
+        </ComponentGroup>
+    </Fragment>
+</Wix>

src/wix/test/WixToolsetTest.Sdk/TestData/MultiTargetingWixlib/PackageUsingExplicitProperties/PackageUsingExplicitProperties.wixproj

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project>
+  <Import Project="$(WixMSBuildProps)" />
+
+  <ItemGroup>
+    <ProjectReference Include="..\TestExe\TestExe.csproj" Publish="true" TargetFrameworks="net472" RuntimeIdentifiers="win-x86">
+      <!-- Not recommended, these disable the values on the ProjectReference -->
+      <Properties>TargetFramework=net8.0;RuntimeIdentifier=win-x64</Properties>
+    </ProjectReference>
+  </ItemGroup>
+
+  <Import Project="$(WixTargetsPath)" />
+</Project>