Make IIssue immutable with Run and FileLink properties

Copilot · pascalberger · pascalberger · commit 1b03cdfbcc53 · 2025-10-14T00:41:00.000+02:00
Co-authored-by: pascalberger &lt;2190718+pascalberger@users.noreply.github.com&gt;
diff --git a/src/Cake.Issues.Tests/IssueReaderTests.cs b/src/Cake.Issues.Tests/IssueReaderTests.cs
@@ -175,8 +175,11 @@ public void Should_Read_Correct_Number_Of_Issues()
 
             // Then
             issues.Count.ShouldBe(2);
-            issues.ShouldContain(issue1);
-            issues.ShouldContain(issue2);
+            
+            // Since IIssue is now immutable, we verify the returned issues
+            // have the same identifiers as the original issues
+            issues.Select(x => x.Identifier).ShouldContain(issue1.Identifier);
+            issues.Select(x => x.Identifier).ShouldContain(issue2.Identifier);
         }
 
         [Fact]
@@ -207,8 +210,11 @@ public void Should_Read_Correct_Number_Of_Issues_Not_Related_To_A_File()
 
             // Then
             issues.Count.ShouldBe(2);
-            issues.ShouldContain(issue1);
-            issues.ShouldContain(issue2);
+            
+            // Since IIssue is now immutable, we verify the returned issues
+            // have the same identifiers as the original issues
+            issues.Select(x => x.Identifier).ShouldContain(issue1.Identifier);
+            issues.Select(x => x.Identifier).ShouldContain(issue2.Identifier);
         }
 
         [Fact]
@@ -259,10 +265,13 @@ public void Should_Read_Correct_Number_Of_Issues_From_Multiple_Providers()
 
             // Then
             issues.Count.ShouldBe(4);
-            issues.ShouldContain(issue1);
-            issues.ShouldContain(issue2);
-            issues.ShouldContain(issue3);
-            issues.ShouldContain(issue4);
+            
+            // Since IIssue is now immutable, we verify the returned issues
+            // have the same identifiers as the original issues
+            issues.Select(x => x.Identifier).ShouldContain(issue1.Identifier);
+            issues.Select(x => x.Identifier).ShouldContain(issue2.Identifier);
+            issues.Select(x => x.Identifier).ShouldContain(issue3.Identifier);
+            issues.Select(x => x.Identifier).ShouldContain(issue4.Identifier);
         }
 
         [Fact]
@@ -297,10 +306,15 @@ public void Should_Set_Run_Property()
 
             // Then
             issues.Count.ShouldBe(2);
-            issues.ShouldContain(issue1);
-            issue1.Run.ShouldBe(run);
-            issues.ShouldContain(issue2);
-            issue2.Run.ShouldBe(run);
+            
+            // Since IIssue is now immutable, the returned issues are new objects
+            // We check that the returned issues have the same content as originals
+            var returnedIssue1 = issues.First(x => x.Identifier == issue1.Identifier);
+            var returnedIssue2 = issues.First(x => x.Identifier == issue2.Identifier);
+            
+            // Verify the Run property is set on the returned issues
+            returnedIssue1.Run.ShouldBe(run);
+            returnedIssue2.Run.ShouldBe(run);
         }
 
         [Fact]
@@ -342,11 +356,16 @@ public void Should_Set_FileLink_Property()
 
             // Then
             issues.Count.ShouldBe(2);
-            issues.ShouldContain(issue1);
-            issue1.FileLink.ToString()
+            
+            // Since IIssue is now immutable, the returned issues are new objects  
+            // We check that the returned issues have the same content as originals
+            var returnedIssue1 = issues.First(x => x.Identifier == issue1.Identifier);
+            var returnedIssue2 = issues.First(x => x.Identifier == issue2.Identifier);
+            
+            // Verify the FileLink property is set on the returned issues
+            returnedIssue1.FileLink.ToString()
                 .ShouldBe($"{repoUrl}/blob/{branch}/{filePath1.Replace(@"\", "/")}#L{line1}-L{endLine1}");
-            issues.ShouldContain(issue2);
-            issue2.FileLink.ToString()
+            returnedIssue2.FileLink.ToString()
                 .ShouldBe($"{repoUrl}/blob/{branch}/{filePath2.Replace(@"\", "/")}#L{line2}");
         }
     }
diff --git a/src/Cake.Issues/IIssue.cs b/src/Cake.Issues/IIssue.cs
@@ -60,10 +60,10 @@ public interface IIssue
     int? EndColumn { get; }
 
     /// <summary>
-    /// Gets or sets a link to the position in the file where the issue occurred.
+    /// Gets a link to the position in the file where the issue occurred.
     /// <c>null</c> if <see cref="IReadIssuesSettings.FileLinkSettings"/> was not set while reading issue.
     /// </summary>
-    Uri FileLink { get; set; }
+    Uri FileLink { get; }
 
     /// <summary>
     /// Gets the message of the issue in text format.
@@ -111,10 +111,10 @@ public interface IIssue
     Uri RuleUrl { get; }
 
     /// <summary>
-    /// Gets or sets the description of the run.
+    /// Gets the description of the run.
     /// Can be <c>null</c> or <see cref="string.Empty"/> if no run information is provided.
     /// </summary>
-    string Run { get; set; }
+    string Run { get; }
 
     /// <summary>
     /// Gets the type of the issue provider.
diff --git a/src/Cake.Issues/Issue.cs b/src/Cake.Issues/Issue.cs
@@ -202,7 +202,7 @@ public Issue(
     public int? EndColumn { get; }
 
     /// <inheritdoc/>
-    public Uri FileLink { get; set; }
+    public Uri FileLink { get; }
 
     /// <inheritdoc/>
     public string MessageText { get; }
@@ -229,7 +229,7 @@ public Issue(
     public Uri RuleUrl { get; }
 
     /// <inheritdoc/>
-    public string Run { get; set; }
+    public string Run { get; }
 
     /// <inheritdoc/>
     public string ProviderType { get; }
@@ -245,4 +245,36 @@ public Issue(
 
     /// <inheritdoc/>
     public string SourceLanguage { get; }
+    
+    /// <summary>
+    /// Creates a new instance of this issue with updated Run and FileLink values.
+    /// This method enables immutability by creating a copy of the issue with new values
+    /// instead of modifying the existing instance.
+    /// </summary>
+    /// <param name="run">The new run value.</param>
+    /// <param name="fileLink">The new file link value.</param>
+    /// <returns>A new Issue instance with the updated values.</returns>
+    public Issue WithRunAndFileLink(string run, Uri fileLink) =>
+        new(
+            this.Identifier,
+            this.ProjectFileRelativePath?.ToString(),
+            this.ProjectName,
+            this.AffectedFileRelativePath?.ToString(),
+            this.Line,
+            this.EndLine,
+            this.Column,
+            this.EndColumn,
+            fileLink,
+            this.MessageText,
+            this.MessageHtml,
+            this.MessageMarkdown,
+            this.Priority,
+            this.PriorityName,
+            this.RuleId,
+            this.RuleName,
+            this.RuleUrl,
+            run,
+            this.ProviderType,
+            this.ProviderName,
+            this.AdditionalInformation);
 }
diff --git a/src/Cake.Issues/IssuesReader.cs b/src/Cake.Issues/IssuesReader.cs
@@ -1,5 +1,6 @@
 ﻿namespace Cake.Issues;
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using Cake.Core.Diagnostics;
@@ -57,17 +58,31 @@ public IEnumerable<IIssue> ReadIssues()
                     currentIssues.Count,
                     providerName);
 
-                currentIssues.ForEach(x =>
+                // Create enhanced issues with the Run and FileLink properties set
+                // This maintains immutability by creating copies instead of mutating originals
+                var enhancedIssues = new List<IIssue>();
+                foreach (var issue in currentIssues)
                 {
-                    x.Run = this.settings.Run;
+                    var run = this.settings.Run;
+                    var fileLink = this.settings.FileLinkSettings?.GetFileLink(issue);
 
-                    if (this.settings.FileLinkSettings != null)
+                    // Always create a new issue instance to ensure immutability
+                    if (issue is Issue originalIssue)
                     {
-                        x.FileLink = this.settings.FileLinkSettings.GetFileLink(x);
+                        var enhancedIssue = originalIssue.WithRunAndFileLink(run, fileLink);
+                        enhancedIssues.Add(enhancedIssue);
                     }
-                });
+                    else
+                    {
+                        // If it's a custom IIssue implementation, we can't enhance it while maintaining immutability
+                        // This is a limitation - custom implementations would need to handle this themselves
+                        throw new NotSupportedException(
+                            $"Issue type {issue.GetType().Name} does not support immutable enhancement. " +
+                            "Custom IIssue implementations should handle Run and FileLink setting during construction.");
+                    }
+                }
 
-                issues.AddRange(currentIssues);
+                issues.AddRange(enhancedIssues);
             }
             else
             {
