Support for processing metaproj references from a solution file

This change adds a task to modify project references coming from a solution file. When project build order is used the solution file read by restore contains links to .metaproj files instead of the actual projects. The actual project can be found by removing the metaproj extension.

Cleaning up _SplitProjectReferencesByFileExistence, the outputs from this are not used since ProjectReference is used direcetly. There is no reason to depend on this external target.

Fixes NuGet/Home#4869
Fixes NuGet/Home#4578

src/NuGet.Core/NuGet.Build.Tasks/GetRestoreDotnetCliToolsTask.cs

@@ -1,4 +1,7 @@
-using System;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;

src/NuGet.Core/NuGet.Build.Tasks/GetRestorePackageReferencesTask.cs

@@ -1,4 +1,7 @@
-using System;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.Build.Framework;

src/NuGet.Core/NuGet.Build.Tasks/GetRestoreProjectJsonPathTask.cs

@@ -1,4 +1,7 @@
-using System.IO;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.IO;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 using Newtonsoft.Json;

src/NuGet.Core/NuGet.Build.Tasks/GetRestoreProjectReferencesTask.cs

@@ -1,4 +1,7 @@
-using System;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;

src/NuGet.Core/NuGet.Build.Tasks/GetRestoreSolutionProjectsTask.cs

@@ -0,0 +1,76 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using Microsoft.Build.Framework;
+using Microsoft.Build.Utilities;
+
+namespace NuGet.Build.Tasks
+{
+    /// <summary>
+    /// Convert .metaproj paths to project paths.
+    /// </summary>
+    public class GetRestoreSolutionProjectsTask : Task
+    {
+        private const string MetaProjExtension = ".metaproj";
+
+        /// <summary>
+        /// Solution project references.
+        /// </summary>
+        [Required]
+        public ITaskItem[] ProjectReferences { get; set; }
+
+        /// <summary>
+        /// Root path used for resolving the absolute project paths.
+        /// </summary>
+        [Required]
+        public string SolutionFilePath { get; set; }
+
+        /// <summary>
+        /// Output items
+        /// </summary>
+        [Output]
+        public ITaskItem[] OutputProjectReferences { get; set; }
+
+        public override bool Execute()
+        {
+            // Log inputs
+            var log = new MSBuildLogger(Log);
+            log.LogDebug($"(in) ProjectReferences '{string.Join(";", ProjectReferences.Select(p => p.ItemSpec))}'");
+            log.LogDebug($"(in) SolutionFilePath '{SolutionFilePath}'");
+
+            var entries = new List<ITaskItem>();
+            var parentDirectory = Path.GetDirectoryName(SolutionFilePath);
+
+            foreach (var project in ProjectReferences)
+            {
+                if (string.IsNullOrEmpty(project.ItemSpec))
+                {
+                    continue;
+                }
+
+                var projectPath = Path.GetFullPath(Path.Combine(parentDirectory, project.ItemSpec));
+
+                // Check for the metaproj extension, this is auto generated by solutions instead of 
+                // the actual project path when build order is set. For the purpose of restore 
+                // the order is not important so we remove the extension to get the real project path.
+                if (projectPath.EndsWith(MetaProjExtension, StringComparison.OrdinalIgnoreCase))
+                {
+                    // Remove .metaproj from the path.
+                    projectPath = projectPath.Substring(0, projectPath.Length - MetaProjExtension.Length);
+                }
+
+                // Clone items using the modified path
+                var newEntry = new TaskItem(projectPath, project.CloneCustomMetadata());
+                entries.Add(newEntry);
+            }
+
+            OutputProjectReferences = entries.ToArray();
+
+            return true;
+        }
+    }
+}

src/NuGet.Core/NuGet.Build.Tasks/NuGet.targets

@@ -76,6 +76,7 @@ Copyright (c) .NET Foundation. All rights reserved.
   <UsingTask TaskName="NuGet.Build.Tasks.GetRestorePackageReferencesTask" AssemblyFile="$(RestoreTaskAssemblyFile)" />
   <UsingTask TaskName="NuGet.Build.Tasks.GetRestoreDotnetCliToolsTask" AssemblyFile="$(RestoreTaskAssemblyFile)" />
   <UsingTask TaskName="NuGet.Build.Tasks.GetRestoreProjectFrameworks" AssemblyFile="$(RestoreTaskAssemblyFile)" />
+  <UsingTask TaskName="NuGet.Build.Tasks.GetRestoreSolutionProjectsTask" AssemblyFile="$(RestoreTaskAssemblyFile)" />
 
   <!--
     ============================================================
@@ -130,7 +131,7 @@ Copyright (c) .NET Foundation. All rights reserved.
       RestoreRecursive="$(RestoreRecursive)" />
   </Target>
 
-<!--
+  <!--
     ============================================================
     _LoadRestoreGraphEntryPoints
     Find project entry points and load them into items.
@@ -143,15 +144,20 @@ Copyright (c) .NET Foundation. All rights reserved.
       <RestoreGraphProjectInputItems Include="$(RestoreGraphProjectInput)" />
     </ItemGroup>
 
-    <!-- Solution case -->
-    <ItemGroup Condition=" $(MSBuildProjectFullPath.EndsWith('.metaproj')) == 'true' AND @(RestoreGraphProjectInputItems) == '' ">
-      <RestoreGraphProjectInputItems Include="@(ProjectReference)" />
-    </ItemGroup>
-
     <!-- Project case -->
     <ItemGroup Condition=" $(MSBuildProjectFullPath.EndsWith('.metaproj')) != 'true' AND @(RestoreGraphProjectInputItems) == '' ">
       <RestoreGraphProjectInputItems Include="$(MSBuildProjectFullPath)" />
     </ItemGroup>
+
+    <!-- Solution case -->
+    <GetRestoreSolutionProjectsTask
+      Condition=" $(MSBuildProjectFullPath.EndsWith('.metaproj')) == 'true' AND @(RestoreGraphProjectInputItems) == '' "
+      ProjectReferences="@(ProjectReference)"
+      SolutionFilePath="$(MSBuildProjectFullPath)">
+      <Output
+        TaskParameter="OutputProjectReferences"
+        ItemName="RestoreGraphProjectInputItems" />
+    </GetRestoreSolutionProjectsTask>
   </Target>
 
   <!--
@@ -188,7 +194,7 @@ Copyright (c) .NET Foundation. All rights reserved.
                    AND '%(RestoreGraphProjectInputItems.Extension)' != '.vcxitems'
                    AND '%(RestoreGraphProjectInputItems.Extension)' != '' " />
     </ItemGroup>
-  
+
     <!-- No filtering -->
     <ItemGroup Condition=" '$(RestoreProjectFilterMode)' != 'exclusionlist' AND '$(RestoreProjectFilterMode)' != 'inclusionlist' ">
       <_FilteredRestoreGraphProjectInputItemsTmp
@@ -210,7 +216,7 @@ Copyright (c) .NET Foundation. All rights reserved.
     Entry point for creating the project to project restore graph.
     ============================================================
   -->
-  <Target Name="_GenerateRestoreGraph" 
+  <Target Name="_GenerateRestoreGraph"
         DependsOnTargets="_FilterRestoreGraphProjectInputItems;_GetAllRestoreProjectPathItems"
         Returns="@(_RestoreGraphEntry)">
     <Message Text="Generating dg file" Importance="low" />
@@ -321,7 +327,7 @@ Copyright (c) .NET Foundation. All rights reserved.
     Returns="$(_CurrentProjectJsonPath)">
     <!-- Get project.json path -->
     <!-- Skip this if the project style is already set. -->
-    <GetRestoreProjectJsonPathTask 
+    <GetRestoreProjectJsonPathTask
       ProjectPath="$(MSBuildProjectFullPath)"
       Condition=" '$(RestoreProjectStyle)' == 'ProjectJson' OR '$(RestoreProjectStyle)' == '' ">
       <Output TaskParameter="ProjectJsonPath" PropertyName="_CurrentProjectJsonPath" />
@@ -452,12 +458,12 @@ Copyright (c) .NET Foundation. All rights reserved.
     <PropertyGroup Condition=" '$(RestoreProjectStyle)' == 'PackageReference' AND '$(TargetFrameworks)' != '' ">
       <_RestoreCrossTargeting>true</_RestoreCrossTargeting>
     </PropertyGroup>
-    
+
     <!-- Determine if ContentFiles should be written by NuGet -->
     <PropertyGroup Condition=" '$(RestoreProjectStyle)' == 'PackageReference' AND '$(_RestoreSkipContentFileWrite)' == '' ">
       <_RestoreSkipContentFileWrite Condition=" '$(TargetFrameworks)' == '' AND '$(TargetFramework)' == '' ">true</_RestoreSkipContentFileWrite>
     </PropertyGroup>
-    
+
     <!-- Write properties for the top level entry point -->
     <ItemGroup Condition=" '$(RestoreProjectStyle)' == 'PackageReference' ">
       <_RestoreGraphEntry Include="$([System.Guid]::NewGuid())">
@@ -607,7 +613,6 @@ Copyright (c) .NET Foundation. All rights reserved.
     ============================================================
   -->
   <Target Name="_GenerateRestoreProjectPathItemsPerFramework"
-    DependsOnTargets="_SplitProjectReferencesByFileExistence"
     Returns="@(_RestoreProjectPathItems)">
 
     <!-- Get the absolute paths to all projects -->

src/NuGet.Core/NuGet.Build.Tasks/WriteRestoreGraphTask.cs

@@ -1,4 +1,7 @@
-using System.IO;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.IO;
 using System.Linq;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;