Change RestoreTarget.TargetGraphName to use the alias (#6923)

Author: nkolev92

src/NuGet.Core/NuGet.Commands/RestoreCommand/IRestoreTargetGraph.cs

@@ -14,6 +14,11 @@ namespace NuGet.Commands
 {
     public interface IRestoreTargetGraph
     {
+        /// <summary>
+        /// Gets the target graph name.
+        /// The target graph name is two parts; the first part, when there is an alias this is the alias name; otherwise, it's the framework name
+        /// For the second part, when there is a runtime identifier, this is a `/` followed by the runtime identifier; otherwise, it's empty.
+        /// </summary>
         string TargetGraphName { get; }
 
         /// <summary>

src/NuGet.Core/NuGet.Commands/RestoreCommand/LockFileBuilder.cs

@@ -52,11 +52,7 @@ public LockFile CreateLockFile(LockFile previousLockFile,
 
             if (project.RestoreMetadata?.ProjectStyle == ProjectStyle.PackageReference)
             {
-                AddProjectFileDependenciesForPackageReference(project, lockFile, targetGraphs);
-            }
-            else
-            {
-                AddProjectFileDependenciesForSpec(project, lockFile);
+                AddProjectFileDependenciesForPackageReference(project, lockFile, targetGraphs.AsList());
             }
 
             // Record all libraries used
@@ -393,20 +389,6 @@ private static string GetFallbackFrameworkString(NuGetFramework framework)
             return string.Join(", ", frameworks);
         }
 
-        private static void AddProjectFileDependenciesForSpec(PackageSpec project, LockFile lockFile)
-        {
-            foreach (var frameworkInfo in project.TargetFrameworks
-                .OrderBy(framework => framework.FrameworkName.ToString(),
-                    StringComparer.Ordinal))
-            {
-                lockFile.ProjectFileDependencyGroups.Add(new ProjectFileDependencyGroup(
-                    frameworkInfo.FrameworkName.ToString(),
-                    frameworkInfo.Dependencies
-                        .Select(x => x.LibraryRange.ToLockFileDependencyGroupString())
-                        .OrderBy(dependency => dependency, StringComparer.Ordinal)));
-            }
-        }
-
         private static void AddProjectFileDependenciesForPackageReference(PackageSpec project, LockFile lockFile, IEnumerable<RestoreTargetGraph> targetGraphs)
         {
             // For NETCore put everything under a TFM section

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

@@ -154,7 +154,7 @@ public RestoreCommand(RestoreRequest request)
             _lockFileBuilderCache = request.LockFileBuilderCache;
 
             // Validate the lock file version requested
-            if (_request.LockFileVersion < 1 || _request.LockFileVersion > LockFileFormat.Version)
+            if (_request.LockFileVersion < 3 || _request.LockFileVersion > LockFileFormat.Version)
             {
                 throw new ArgumentOutOfRangeException(
                     paramName: nameof(request),
@@ -249,7 +249,7 @@ public async Task<RestoreResult> ExecuteAsync(CancellationToken token)
 
                 // if success == false, it generates an empty restore graph suitable to create an assets file with errors.
                 // Since the graph is empty, any code that analyzes the graph (like audit) will have nothing to do.
-                (successfulResult, var graphs) = await GenerateRestoreGraphsAsync(telemetry, contextForProject, success, token);
+                (successfulResult, List<RestoreTargetGraph> graphs) = await GenerateRestoreGraphsAsync(telemetry, contextForProject, success, token);
                 success &= successfulResult;
 
                 bool auditRan = false;
@@ -571,9 +571,9 @@ private async Task<EvaluateLockFileResult>
             return new EvaluateLockFileResult(success, isLockFileValid, regenerateLockFile, packagesLockFilePath, packagesLockFile);
         }
 
-        private async Task<(bool, IEnumerable<RestoreTargetGraph>)> GenerateRestoreGraphsAsync(TelemetryActivity telemetry, RemoteWalkContext contextForProject, bool success, CancellationToken token)
+        private async Task<(bool, List<RestoreTargetGraph>)> GenerateRestoreGraphsAsync(TelemetryActivity telemetry, RemoteWalkContext contextForProject, bool success, CancellationToken token)
         {
-            IEnumerable<RestoreTargetGraph> graphs = null;
+            List<RestoreTargetGraph> graphs = null;
             if (success)
             {
                 using (telemetry.StartIndependentInterval(GenerateRestoreGraphDuration))
@@ -608,23 +608,25 @@ private async Task<EvaluateLockFileResult>
                 // caller of RestoreCommand to have provided at least one AdditionalMessage in RestoreArgs.
                 // The other scenario is when the lock file is not up to date and we're running locked mode.
                 // In that case we want to write a `target` for each target framework to avoid missing target errors from the SDK build tasks.
-                var frameworkRuntimePair = CreateFrameworkRuntimeDefinitions(_request.Project, RequestRuntimeUtility.GetRestoreRuntimes(_request));
-                graphs = frameworkRuntimePair.Select(e =>
+                var frameworkRuntimePairs = CreateFrameworkRuntimeDefinitions(_request.Project, RequestRuntimeUtility.GetRestoreRuntimes(_request));
+                graphs = new(frameworkRuntimePairs.Count);
+                for (var i = 0; i < frameworkRuntimePairs.Count; i++)
                 {
-                    return RestoreTargetGraph.Create(_request.Project.RuntimeGraph, Enumerable.Empty<GraphNode<RemoteResolveResult>>(), contextForProject, _logger, e.TargetAlias, e.Framework, e.RuntimeIdentifier);
-                });
+                    var restoreTargetGraph = RestoreTargetGraph.Create(_request.Project.RuntimeGraph, Enumerable.Empty<GraphNode<RemoteResolveResult>>(), contextForProject, _logger, frameworkRuntimePairs[i].TargetAlias, frameworkRuntimePairs[i].Framework, frameworkRuntimePairs[i].RuntimeIdentifier);
+                    graphs.Add(restoreTargetGraph);
+                }
             }
 
             return (success, graphs);
         }
 
-        private async Task<(bool, IEnumerable<MSBuildOutputFile>, string, string, LockFile, IEnumerable<RestoreTargetGraph>, PackagesLockFile, string, CacheFile)> ProcessRestoreResultAsync(TelemetryActivity telemetry,
+        private async Task<(bool, IEnumerable<MSBuildOutputFile>, string, string, LockFile, List<RestoreTargetGraph>, PackagesLockFile, string, CacheFile)> ProcessRestoreResultAsync(TelemetryActivity telemetry,
             List<NuGetv3LocalRepository> localRepositories,
             RemoteWalkContext contextForProject,
             bool isLockFileValid,
             bool regenerateLockFile,
             LockFile assetsFile,
-            IEnumerable<RestoreTargetGraph> graphs,
+            List<RestoreTargetGraph> graphs,
             PackagesLockFile packagesLockFile,
             string packagesLockFilePath,
             CacheFile cacheFile,
@@ -663,9 +665,6 @@ private async Task<EvaluateLockFileResult>
                         _logger);
                 }
 
-                // If the request is for a lower lock file version, downgrade it appropriately
-                DowngradeLockFileIfNeeded(assetsFile);
-
                 // Revert to the original case if needed
                 await FixCaseForLegacyReaders(graphs, assetsFile, token);
 
@@ -758,7 +757,7 @@ private async Task<EvaluateLockFileResult>
         /// <param name="telemetry">The <see cref="TelemetryActivity"/> to log NuGetAudit telemetry to.</param>
         /// <param name="token">A <see cref="CancellationToken"/> to cancel obtaining a vulnerability database. Once the database is downloaded, audit is quick to complete.</param>
         /// <returns>False if no vulnerability database could be found (so packages were not scanned for vulnerabilities), true otherwise.</returns>
-        private async Task<bool> PerformAuditAsync(IEnumerable<RestoreTargetGraph> graphs, TelemetryActivity telemetry, CancellationToken token)
+        private async Task<bool> PerformAuditAsync(List<RestoreTargetGraph> graphs, TelemetryActivity telemetry, CancellationToken token)
         {
             var audit = new AuditUtility(
                 _request.Project.RestoreMetadata.RestoreAuditProperties,
@@ -1436,14 +1435,6 @@ private string GetAssetsFilePath(LockFile lockFile)
             return Path.GetFullPath(projectLockFilePath);
         }
 
-        private void DowngradeLockFileIfNeeded(LockFile lockFile)
-        {
-            if (_request.LockFileVersion <= 1)
-            {
-                DowngradeLockFileToV1(lockFile);
-            }
-        }
-
         private async Task FixCaseForLegacyReaders(
             IEnumerable<RestoreTargetGraph> graphs,
             LockFile lockFile,
@@ -1467,7 +1458,7 @@ private async Task FixCaseForLegacyReaders(
         private LockFile BuildAssetsFile(
             LockFile existingLockFile,
             PackageSpec project,
-            IEnumerable<RestoreTargetGraph> graphs,
+            List<RestoreTargetGraph> graphs,
             IReadOnlyList<NuGetv3LocalRepository> localRepositories,
             RemoteWalkContext contextForProject)
         {
@@ -1661,7 +1652,7 @@ private static async Task<IList<CompatibilityCheckResult>> VerifyCompatibilityAs
             return checkResults;
         }
 
-        private async Task<(bool, IEnumerable<RestoreTargetGraph>)> ExecuteLegacyRestoreAsync(
+        private async Task<(bool, List<RestoreTargetGraph>)> ExecuteLegacyRestoreAsync(
             NuGetv3LocalRepository userPackageFolder,
             IReadOnlyList<NuGetv3LocalRepository> fallbackPackageFolders,
             RemoteWalkContext context,
@@ -1675,7 +1666,7 @@ private static async Task<IList<CompatibilityCheckResult>> VerifyCompatibilityAs
                 await _logger.LogAsync(RestoreLogMessage.CreateError(NuGetLogCode.NU1001, message));
 
                 success = false;
-                return (success, Enumerable.Empty<RestoreTargetGraph>());
+                return (success, []);
             }
             _logger.LogInformation(string.Format(CultureInfo.CurrentCulture, Strings.Log_RestoringPackages, _request.Project.FilePath));
 
@@ -1838,7 +1829,7 @@ private static async Task<IList<CompatibilityCheckResult>> VerifyCompatibilityAs
             return (success, allGraphs);
         }
 
-        private async Task<(bool, IEnumerable<RestoreTargetGraph>)> ExecuteRestoreAsync(
+        private async Task<(bool, List<RestoreTargetGraph>)> ExecuteRestoreAsync(
             NuGetv3LocalRepository userPackageFolder,
             IReadOnlyList<NuGetv3LocalRepository> fallbackPackageFolders,
             RemoteWalkContext context,
@@ -1853,7 +1844,7 @@ private static async Task<IList<CompatibilityCheckResult>> VerifyCompatibilityAs
 
                 success = false;
 
-                return (success, Enumerable.Empty<RestoreTargetGraph>());
+                return (success, []);
             }
 
             var projectRestoreRequest = new ProjectRestoreRequest(_request, _request.Project, _request.ExistingLockFile, _logger)
@@ -2057,37 +2048,6 @@ private static RemoteWalkContext CreateRemoteWalkContext(RestoreRequest request,
             return context;
         }
 
-        private static void DowngradeLockFileToV1(LockFile lockFile)
-        {
-            // Remove projects from the library section
-            var libraryProjects = lockFile.Libraries.Where(lib => lib.Type == LibraryType.Project).ToArray();
-
-            foreach (var library in libraryProjects)
-            {
-                lockFile.Libraries.Remove(library);
-            }
-
-            // Remove projects from the targets section
-            foreach (var target in lockFile.Targets)
-            {
-                var targetProjects = target.Libraries.Where(lib => lib.Type == LibraryType.Project).ToArray();
-
-                foreach (var library in targetProjects)
-                {
-                    target.Libraries.Remove(library);
-                }
-            }
-
-            foreach (var library in lockFile.Targets.SelectMany(target => target.Libraries))
-            {
-                // Null out all target types, these did not exist in v1
-                library.Type = null;
-            }
-
-            // Remove the package spec
-            lockFile.PackageSpec = null;
-        }
-
         private static ExternalProjectReference ToExternalProjectReference(PackageSpec project)
         {
             return new ExternalProjectReference(

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreTargetGraph.cs

@@ -3,8 +3,10 @@
 
 #nullable disable
 
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Globalization;
 using System.Linq;
 using NuGet.Client;
 using NuGet.Common;
@@ -80,7 +82,7 @@ internal RestoreTargetGraph(IEnumerable<ResolverConflict> conflicts,
             RuntimeGraph = runtimeGraph;
             Framework = framework;
             Graphs = graphs;
-            TargetGraphName = FrameworkRuntimePair.GetTargetGraphName(Framework, RuntimeIdentifier);
+            TargetGraphName = string.IsNullOrEmpty(TargetAlias) ? FrameworkRuntimePair.GetTargetGraphName(Framework, RuntimeIdentifier) : GetTargetGraphName(TargetAlias, RuntimeIdentifier);
             Conventions = new ManagedCodeConventions(runtimeGraph);
 
             Install = install;
@@ -90,6 +92,24 @@ internal RestoreTargetGraph(IEnumerable<ResolverConflict> conflicts,
             ResolvedDependencies = resolvedDependencies;
         }
 
+        internal static string GetTargetGraphName(string targetAlias, string runtimeIdentifier)
+        {
+            if (string.IsNullOrEmpty(targetAlias)) throw new ArgumentNullException(nameof(targetAlias));
+
+            if (string.IsNullOrEmpty(runtimeIdentifier))
+            {
+                return targetAlias;
+            }
+            else
+            {
+                return string.Format(
+                    CultureInfo.InvariantCulture,
+                    "{0}/{1}",
+                    targetAlias,
+                    runtimeIdentifier);
+            }
+        }
+
         internal static RestoreTargetGraph Create(IEnumerable<GraphNode<RemoteResolveResult>> graphs, RemoteWalkContext context, ILogger logger, string targetAlias, NuGetFramework framework)
         {
             return Create(RuntimeGraph.Empty, graphs, context, logger, targetAlias, framework, runtimeIdentifier: null);

src/NuGet.Core/NuGet.Commands/RestoreCommand/Utility/AuditUtility.cs

@@ -23,7 +23,7 @@ internal class AuditUtility
     {
         private readonly RestoreAuditProperties? _restoreAuditProperties;
         private readonly string _projectFullPath;
-        private readonly IEnumerable<RestoreTargetGraph> _targetGraphs;
+        private readonly List<RestoreTargetGraph> _targetGraphs;
         private readonly IReadOnlyList<IVulnerabilityInformationProvider> _vulnerabilityInfoProviders;
         private readonly ILogger _logger;
         private readonly IList<TargetFrameworkInformation> _targetFrameworks;
@@ -62,7 +62,7 @@ internal class AuditUtility
         public AuditUtility(
             RestoreAuditProperties? restoreAuditProperties,
             string projectFullPath,
-            IEnumerable<RestoreTargetGraph> graphs,
+            List<RestoreTargetGraph> graphs,
             IReadOnlyList<IVulnerabilityInformationProvider> vulnerabilityInformationProviders,
             IList<TargetFrameworkInformation> targetFrameworks,
             ILogger logger)

src/NuGet.Core/NuGet.ProjectModel/LockFile/LockFileExtensions.cs

@@ -33,8 +33,7 @@ public static IEnumerable<LockFileTarget> GetTargetGraphs(this IAssetsLogMessage
             {
                 return assetsFile.Targets;
             }
-
-            return assetsFile.Targets.Where(target => message.TargetGraphs.Contains(target.Name, StringComparer.OrdinalIgnoreCase));
+            return assetsFile.Targets.Where(target => message.TargetGraphs.Contains(target.TargetAlias + (string.IsNullOrEmpty(target.RuntimeIdentifier) ? "" : "/" + target.RuntimeIdentifier), StringComparer.OrdinalIgnoreCase));
         }
 
         /// <summary>

src/NuGet.Core/NuGet.ProjectModel/TargetFrameworkInformation.cs

@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using NuGet.Common;
 using NuGet.Frameworks;
 using NuGet.LibraryModel;
@@ -25,7 +26,7 @@ public class TargetFrameworkInformation : IEquatable<TargetFrameworkInformation>
 
         public string TargetAlias { get; init; } = string.Empty;
 
-        public NuGetFramework FrameworkName { get; init; }
+        public required NuGetFramework FrameworkName { get; init; }
 
         public ImmutableArray<LibraryDependency> Dependencies
         {
@@ -114,6 +115,7 @@ public IReadOnlyDictionary<string, PrunePackageReference> PackagesToPrune
         /// </summary>
         public string RuntimeIdentifierGraphPath { get; init; }
 
+        [SetsRequiredMembers]
         public TargetFrameworkInformation()
         {
             TargetAlias = string.Empty;
@@ -125,6 +127,7 @@ public TargetFrameworkInformation()
             PackagesToPrune = ImmutableDictionary<string, PrunePackageReference>.Empty;
         }
 
+        [SetsRequiredMembers]
         public TargetFrameworkInformation(TargetFrameworkInformation cloneFrom)
         {
             TargetAlias = cloneFrom.TargetAlias;