Use filtered global properties for node ids (#61)

* Use filtered global properties for node ids

* globalProperties -> filteredGlobalProperties

Author: dfederm

src/Common/Fingerprinting/FingerprintFactory.cs

@@ -86,7 +86,7 @@ void AddSettingToFingerprint(IReadOnlyCollection<Glob>? patterns, string setting
                     CreateFingerprintEntry(nodeContext.ProjectFileRelativePath)
                 };
 
-                foreach (KeyValuePair<string, string> property in nodeContext.GlobalProperties)
+                foreach (KeyValuePair<string, string> property in nodeContext.FilteredGlobalProperties)
                 {
                     entries.Add(CreateFingerprintEntry($"{property.Key}={property.Value}"));
                 }

src/Common/MSBuildCachePluginBase.cs

@@ -298,7 +298,7 @@ private async Task BeginBuildInnerAsync(CacheContext context, PluginLoggerBase l
             }
 
             NodeDescriptor nodeDescriptor = _nodeDescriptorFactory.Create(node.ProjectInstance);
-            NodeContext nodeContext = new(Settings.LogDirectory, node, parserInfo.ProjectFileRelativePath, nodeDescriptor.GlobalProperties, inputs, targetNames);
+            NodeContext nodeContext = new(Settings.LogDirectory, node, parserInfo.ProjectFileRelativePath, nodeDescriptor.FilteredGlobalProperties, inputs, targetNames);
 
             dumpParserInfoTasks.Add(Task.Run(() => DumpParserInfoAsync(logger, nodeContext, parserInfo), cancellationToken));
             nodeContexts.Add(nodeDescriptor, nodeContext);
@@ -733,7 +733,7 @@ async Task DumpNodeContextAsync(NodeContext nodeContext)
                 jsonWriter.WriteString("projectFileRelativePath", nodeContext.ProjectFileRelativePath);
 
                 jsonWriter.WriteStartObject("globalProperties");
-                foreach (KeyValuePair<string, string> kvp in nodeContext.GlobalProperties)
+                foreach (KeyValuePair<string, string> kvp in nodeContext.FilteredGlobalProperties)
                 {
                     jsonWriter.WriteString(kvp.Key, kvp.Value);
                 }

src/Common/NodeContext.cs

@@ -22,15 +22,15 @@ public NodeContext(
         string baseLogDirectory,
         ProjectGraphNode node,
         string projectFileRelativePath,
-        IReadOnlyDictionary<string, string> globalProperties,
+        IReadOnlyDictionary<string, string> filteredGlobalProperties,
         IReadOnlyList<string> inputs,
         HashSet<string> targetNames)
     {
-        Id = GenerateId(projectFileRelativePath, node);
+        Id = GenerateId(projectFileRelativePath, filteredGlobalProperties);
         _logDirectory = Path.Combine(baseLogDirectory, Id);
         Node = node;
         ProjectFileRelativePath = projectFileRelativePath;
-        GlobalProperties = globalProperties;
+        FilteredGlobalProperties = filteredGlobalProperties;
         Inputs = inputs;
         TargetNames = targetNames;
     }
@@ -56,7 +56,7 @@ public string LogDirectory
 
     public string ProjectFileRelativePath { get; }
 
-    public IReadOnlyDictionary<string, string> GlobalProperties { get; }
+    public IReadOnlyDictionary<string, string> FilteredGlobalProperties { get; }
 
     public IReadOnlyList<string> Inputs { get; }
 
@@ -85,9 +85,17 @@ public void SetBuildResult(NodeBuildResult buildResult)
     /// <summary>
     /// Generate a stable Id which we can use for sorting and comparison purposes across builds.
     /// </summary>
-    private static string GenerateId(string projectFileRelativePath, ProjectGraphNode node)
+    private static string GenerateId(string projectFileRelativePath, IReadOnlyDictionary<string, string> filteredGlobalProperties)
     {
-        SortedDictionary<string, string> sortedProperties = new(node.ProjectInstance.GlobalProperties, StringComparer.OrdinalIgnoreCase);
+        // In practice, the dictionary we're given is SortedDictionary<string, string>, so try casting.
+        if (filteredGlobalProperties is not SortedDictionary<string, string> sortedProperties)
+        {
+            sortedProperties = new(StringComparer.OrdinalIgnoreCase);
+            foreach (KeyValuePair<string, string> kvp in filteredGlobalProperties)
+            {
+                sortedProperties.Add(kvp.Key, kvp.Value);
+            }
+        }
 
 #pragma warning disable CA5351 // Do Not Use Broken Cryptographic Algorithms. This is not used for crypto.
         using MD5 hasher = MD5.Create();

src/Common/NodeDescriptor.cs

@@ -10,18 +10,18 @@ namespace Microsoft.MSBuildCache;
 {
     private readonly string _projectFullPath;
 
-    private readonly SortedDictionary<string, string> _globalProperties;
+    private readonly SortedDictionary<string, string> _filteredGlobalProperties;
 
-    public NodeDescriptor(string projectFullPath, SortedDictionary<string, string> globalProperties)
+    public NodeDescriptor(string projectFullPath, SortedDictionary<string, string> filteredGlobalProperties)
     {
         _projectFullPath = projectFullPath;
-        _globalProperties = globalProperties;
+        _filteredGlobalProperties = filteredGlobalProperties;
     }
 
     /// <summary>
     /// Sorted by StringComparison.OrdinalIgnoreCase.
     /// </summary>
-    public IReadOnlyDictionary<string, string> GlobalProperties => _globalProperties;
+    public IReadOnlyDictionary<string, string> FilteredGlobalProperties => _filteredGlobalProperties;
 
     public bool Equals(NodeDescriptor other)
     {
@@ -30,14 +30,14 @@ public bool Equals(NodeDescriptor other)
             return false;
         }
 
-        if (_globalProperties.Count != other._globalProperties.Count)
+        if (_filteredGlobalProperties.Count != other._filteredGlobalProperties.Count)
         {
             return false;
         }
 
-        foreach (KeyValuePair<string, string> kvp in _globalProperties)
+        foreach (KeyValuePair<string, string> kvp in _filteredGlobalProperties)
         {
-            if (!other._globalProperties.TryGetValue(kvp.Key, out string? otherValue))
+            if (!other._filteredGlobalProperties.TryGetValue(kvp.Key, out string? otherValue))
             {
                 return false;
             }
@@ -62,7 +62,7 @@ public override int GetHashCode()
         HashCode hashCode = new();
         hashCode.Add(_projectFullPath, StringComparer.OrdinalIgnoreCase);
 
-        foreach (KeyValuePair<string, string> kvp in _globalProperties)
+        foreach (KeyValuePair<string, string> kvp in _filteredGlobalProperties)
         {
             hashCode.Add(kvp.Key, StringComparer.OrdinalIgnoreCase);
             hashCode.Add(kvp.Value, StringComparer.OrdinalIgnoreCase);

src/Common/NodeDescriptorFactory.cs

@@ -29,7 +29,7 @@ public NodeDescriptor Create(string projectFullPath, IReadOnlyDictionary<string,
     {
         // Sort to ensure a consistent hash for equivalent sets of properties.
         // This allocates with the assumption that the hash code is used multiple times.
-        SortedDictionary<string, string> sortedGlobalProperties = new(StringComparer.OrdinalIgnoreCase);
+        SortedDictionary<string, string> filteredGlobalProperties = new(StringComparer.OrdinalIgnoreCase);
         foreach (KeyValuePair<string, string> kvp in globalProperties)
         {
             if (kvp.Key.StartsWith(MSBuildProjectInstancePrefix, StringComparison.OrdinalIgnoreCase))
@@ -42,10 +42,10 @@ public NodeDescriptor Create(string projectFullPath, IReadOnlyDictionary<string,
                 continue;
             }
 
-            sortedGlobalProperties.Add(kvp.Key, kvp.Value);
+            filteredGlobalProperties.Add(kvp.Key, kvp.Value);
         }
 
-        return new NodeDescriptor(projectFullPath, sortedGlobalProperties);
+        return new NodeDescriptor(projectFullPath, filteredGlobalProperties);
     }
 
     // Adapts IDictionary to IReadOnlyDictionary