Make IIssue immutable by removing mutable Run and FileLink properties #1269
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR restores immutability to the
IIssue
interface by making theRun
andFileLink
properties read-only and implementing a copy-based enhancement pattern inIssuesReader
.Problem
The
IIssue
interface was no longer immutable due to two properties that were settable:Run { get; set; }
FileLink { get; set; }
These properties couldn't be made read-only in the original design because they are not set by issue providers during construction, but rather generically for all issue providers by the
IssuesReader
after creation.Solution
Following the approach suggested in the issue, this PR implements cloning and enhancement of issues in the
IssuesReader
:Run
andFileLink
to{ get; }
in bothIIssue
interface andIssue
classIssue.WithRunAndFileLink()
that creates a newIssue
instance with updatedRun
andFileLink
valuesKey Changes
Core immutability changes:
Copy-based enhancement:
IssuesReader enhancement pattern:
Benefits
IIssue
objects cannot be modified after creationTesting
All 3000+ tests pass, including comprehensive test updates to handle the new immutable behavior. Tests now compare issues by content (identifier) rather than reference equality since the reader returns enhanced copies.
Fixes #194.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.