refactor GitRepository to use GitRepositoryCache

Replaces caching logic within `GitRepository` with a new dedicated `GitRepositoryCache` class. Updates related classes and collections to utilize the cache through `GetOrWrap` methods, improving maintainability and reducing duplication.

Author: arturcic

src/GitVersion.LibGit2Sharp/Git/Branch.cs

@@ -10,18 +10,18 @@ internal sealed class Branch : IBranch
 
     private readonly LibGit2Sharp.Branch innerBranch;
 
-    internal Branch(LibGit2Sharp.Branch branch, LibGit2Sharp.Diff diff, GitRepository repo)
+    internal Branch(LibGit2Sharp.Branch branch, LibGit2Sharp.Diff diff, GitRepositoryCache repositoryCache)
     {
         diff.NotNull();
-        repo.NotNull();
+        repositoryCache.NotNull();
         this.innerBranch = branch.NotNull();
         Name = new(branch.CanonicalName);
 
         var commit = this.innerBranch.Tip;
-        Tip = commit is null ? null : repo.GetOrCreate(commit, diff);
+        Tip = commit is null ? null : repositoryCache.GetOrWrap(commit, diff);
 
         var commits = this.innerBranch.Commits;
-        Commits = new CommitCollection(commits, diff, repo);
+        Commits = new CommitCollection(commits, diff, repositoryCache);
     }
 
     public ReferenceName Name { get; }

src/GitVersion.LibGit2Sharp/Git/BranchCollection.cs

@@ -8,18 +8,17 @@ internal sealed class BranchCollection : IBranchCollection
     private readonly LibGit2Sharp.BranchCollection innerCollection;
     private readonly Lazy<IReadOnlyCollection<IBranch>> branches;
     private readonly Diff diff;
-    private readonly GitRepository repo;
+    private readonly GitRepositoryCache repositoryCache;
 
-    internal BranchCollection(LibGit2Sharp.BranchCollection collection, Diff diff, GitRepository repo)
+    internal BranchCollection(LibGit2Sharp.BranchCollection collection, Diff diff, GitRepositoryCache repositoryCache)
     {
         this.innerCollection = collection.NotNull();
-        this.branches = new Lazy<IReadOnlyCollection<IBranch>>(() => [.. this.innerCollection.Select(branch => repo.GetOrCreate(branch, diff))]);
+        this.branches = new Lazy<IReadOnlyCollection<IBranch>>(() => [.. this.innerCollection.Select(branch => repositoryCache.GetOrWrap(branch, diff))]);
         this.diff = diff.NotNull();
-        this.repo = repo.NotNull();
+        this.repositoryCache = repositoryCache.NotNull();
     }
 
-    public IEnumerator<IBranch> GetEnumerator()
-        => this.branches.Value.GetEnumerator();
+    public IEnumerator<IBranch> GetEnumerator() => this.branches.Value.GetEnumerator();
 
     IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
 
@@ -29,7 +28,7 @@ public IBranch? this[string name]
         {
             name = name.NotNull();
             var branch = this.innerCollection[name];
-            return branch is null ? null : this.repo.GetOrCreate(branch, this.diff);
+            return branch is null ? null : this.repositoryCache.GetOrWrap(branch, this.diff);
         }
     }
 

src/GitVersion.LibGit2Sharp/Git/Commit.cs

@@ -14,12 +14,12 @@ internal sealed class Commit : ICommit
     private readonly LibGit2Sharp.Commit innerCommit;
     private readonly LibGit2Sharp.Diff repoDiff;
 
-    internal Commit(LibGit2Sharp.Commit innerCommit, LibGit2Sharp.Diff repoDiff, GitRepository repo)
+    internal Commit(LibGit2Sharp.Commit innerCommit, LibGit2Sharp.Diff repoDiff, GitRepositoryCache repositoryCache)
     {
         repoDiff.NotNull();
-        repo.NotNull();
+        repositoryCache.NotNull();
         this.innerCommit = innerCommit.NotNull();
-        this.parentsLazy = new(() => innerCommit.Parents.Select(parent => repo.GetOrCreate(parent, repoDiff)).ToList());
+        this.parentsLazy = new(() => [.. innerCommit.Parents.Select(parent => repositoryCache.GetOrWrap(parent, repoDiff))]);
         Id = new ObjectId(innerCommit.Id);
         Sha = innerCommit.Sha;
         When = innerCommit.Committer.When;

src/GitVersion.LibGit2Sharp/Git/CommitCollection.cs

@@ -8,18 +8,17 @@ internal sealed class CommitCollection : ICommitCollection
     private readonly ICommitLog innerCollection;
     private readonly Lazy<IReadOnlyCollection<ICommit>> commits;
     private readonly Diff diff;
-    private readonly GitRepository repo;
+    private readonly GitRepositoryCache repositoryCache;
 
-    internal CommitCollection(ICommitLog collection, Diff diff, GitRepository repo)
+    internal CommitCollection(ICommitLog collection, Diff diff, GitRepositoryCache repositoryCache)
     {
         this.innerCollection = collection.NotNull();
-        this.commits = new Lazy<IReadOnlyCollection<ICommit>>(() => [.. this.innerCollection.Select(commit => repo.GetOrCreate(commit, diff))]);
+        this.commits = new Lazy<IReadOnlyCollection<ICommit>>(() => [.. this.innerCollection.Select(commit => repositoryCache.GetOrWrap(commit, diff))]);
         this.diff = diff.NotNull();
-        this.repo = repo.NotNull();
+        this.repositoryCache = repositoryCache.NotNull();
     }
 
-    public IEnumerator<ICommit> GetEnumerator()
-        => this.commits.Value.GetEnumerator();
+    public IEnumerator<ICommit> GetEnumerator() => this.commits.Value.GetEnumerator();
 
     IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
 
@@ -38,7 +37,7 @@ public IEnumerable<ICommit> QueryBy(CommitFilter commitFilter)
             SortBy = (LibGit2Sharp.CommitSortStrategies)commitFilter.SortBy
         };
         var commitLog = ((IQueryableCommitLog)this.innerCollection).QueryBy(filter);
-        return new CommitCollection(commitLog, this.diff, this.repo);
+        return new CommitCollection(commitLog, this.diff, this.repositoryCache);
 
         static object? GetReacheableFrom(object? item) =>
             item switch

src/GitVersion.LibGit2Sharp/Git/GitRepository.cs

@@ -1,4 +1,3 @@
-using System.Collections.Concurrent;
 using GitVersion.Extensions;
 using GitVersion.Helpers;
 using LibGit2Sharp;
@@ -8,13 +7,7 @@ namespace GitVersion.Git;
 internal sealed partial class GitRepository
 {
     private Lazy<IRepository>? repositoryLazy;
-
-    private readonly ConcurrentDictionary<string, Branch> cachedBranches = new();
-    private readonly ConcurrentDictionary<string, Commit> cachedCommits = new();
-    private readonly ConcurrentDictionary<string, Tag> cachedTags = new();
-    private readonly ConcurrentDictionary<string, Remote> cachedRemotes = new();
-    private readonly ConcurrentDictionary<string, Reference> cachedReferences = new();
-    private readonly ConcurrentDictionary<string, RefSpec> cachedRefSpecs = new();
+    private readonly GitRepositoryCache repositoryCache = new();
 
     private IRepository RepositoryInstance
     {
@@ -28,13 +21,21 @@ private IRepository RepositoryInstance
     public string WorkingDirectory => RepositoryInstance.Info.WorkingDirectory;
     public bool IsHeadDetached => RepositoryInstance.Info.IsHeadDetached;
     public bool IsShallow => RepositoryInstance.Info.IsShallow;
-    public IBranch Head => GetOrCreate(RepositoryInstance.Head, RepositoryInstance.Diff);
+    public IBranch Head => this.repositoryCache.GetOrWrap(RepositoryInstance.Head, RepositoryInstance.Diff);
+
+    private ITagCollection? tags;
+    public ITagCollection Tags => this.tags ??= new TagCollection(RepositoryInstance.Tags, RepositoryInstance.Diff, this.repositoryCache);
+
+    public IBranchCollection Branches => new BranchCollection(RepositoryInstance.Branches, RepositoryInstance.Diff, this.repositoryCache);
+
+    private ICommitCollection? commits;
+    public ICommitCollection Commits => this.commits ??= new CommitCollection(RepositoryInstance.Commits, RepositoryInstance.Diff, this.repositoryCache);
 
-    public ITagCollection Tags => new TagCollection(RepositoryInstance.Tags, RepositoryInstance.Diff, this);
-    public IBranchCollection Branches => new BranchCollection(RepositoryInstance.Branches, RepositoryInstance.Diff, this);
-    public ICommitCollection Commits => new CommitCollection(RepositoryInstance.Commits, RepositoryInstance.Diff, this);
-    public IRemoteCollection Remotes => new RemoteCollection(RepositoryInstance.Network.Remotes, this);
-    public IReferenceCollection References => new ReferenceCollection(RepositoryInstance.Refs, this);
+    private IRemoteCollection? remotes;
+    public IRemoteCollection Remotes => this.remotes ??= new RemoteCollection(RepositoryInstance.Network.Remotes, this.repositoryCache);
+
+    private IReferenceCollection? references;
+    public IReferenceCollection References => this.references ??= new ReferenceCollection(RepositoryInstance.Refs, this.repositoryCache);
 
     public void DiscoverRepository(string? gitDirectory)
     {
@@ -56,7 +57,7 @@ public void DiscoverRepository(string? gitDirectory)
             var first = (Commit)commit;
             var second = (Commit)otherCommit;
             var mergeBase = RepositoryInstance.ObjectDatabase.FindMergeBase(first, second);
-            return mergeBase == null ? null : GetOrCreate(mergeBase, RepositoryInstance.Diff);
+            return mergeBase == null ? null : this.repositoryCache.GetOrWrap(mergeBase, RepositoryInstance.Diff);
         });
     }
 
@@ -66,29 +67,6 @@ public int UncommittedChangesCount()
         return retryAction.Execute(GetUncommittedChangesCountInternal);
     }
 
-    public Branch GetOrCreate(LibGit2Sharp.Branch innerBranch, Diff repoDiff)
-    {
-        var cacheKey = innerBranch.Tip is null
-            ? $"{innerBranch.RemoteName}/{innerBranch.CanonicalName}"
-            : $"{innerBranch.RemoteName}/{innerBranch.CanonicalName}@{innerBranch.Tip.Sha}";
-        return cachedBranches.GetOrAdd(cacheKey, _ => new Branch(innerBranch, repoDiff, this));
-    }
-
-    public Commit GetOrCreate(LibGit2Sharp.Commit innerCommit, Diff repoDiff)
-        => cachedCommits.GetOrAdd(innerCommit.Sha, _ => new Commit(innerCommit, repoDiff, this));
-
-    public Tag GetOrCreate(LibGit2Sharp.Tag innerTag, Diff repoDiff)
-        => cachedTags.GetOrAdd(innerTag.CanonicalName, _ => new Tag(innerTag, repoDiff, this));
-
-    public Remote GetOrCreate(LibGit2Sharp.Remote innerRemote)
-        => cachedRemotes.GetOrAdd(innerRemote.Name, _ => new Remote(innerRemote, this));
-
-    public Reference GetOrCreate(LibGit2Sharp.Reference innerReference)
-        => cachedReferences.GetOrAdd(innerReference.CanonicalName, _ => new Reference(innerReference));
-
-    public RefSpec GetOrCreate(LibGit2Sharp.RefSpec innerRefSpec)
-        => cachedRefSpecs.GetOrAdd(innerRefSpec.Specification, _ => new RefSpec(innerRefSpec));
-
     public void Dispose()
     {
         if (this.repositoryLazy is { IsValueCreated: true }) RepositoryInstance.Dispose();

src/GitVersion.LibGit2Sharp/Git/GitRepositoryCache.cs

@@ -0,0 +1,37 @@
+using System.Collections.Concurrent;
+using LibGit2Sharp;
+
+namespace GitVersion.Git;
+
+internal class GitRepositoryCache
+{
+    private readonly ConcurrentDictionary<string, Branch> cachedBranches = new();
+    private readonly ConcurrentDictionary<string, Commit> cachedCommits = new();
+    private readonly ConcurrentDictionary<string, Tag> cachedTags = new();
+    private readonly ConcurrentDictionary<string, Remote> cachedRemotes = new();
+    private readonly ConcurrentDictionary<string, Reference> cachedReferences = new();
+    private readonly ConcurrentDictionary<string, RefSpec> cachedRefSpecs = new();
+
+    public Branch GetOrWrap(LibGit2Sharp.Branch innerBranch, Diff repoDiff)
+    {
+        var cacheKey = innerBranch.Tip is null
+            ? $"{innerBranch.RemoteName}/{innerBranch.CanonicalName}"
+            : $"{innerBranch.RemoteName}/{innerBranch.CanonicalName}@{innerBranch.Tip.Sha}";
+        return cachedBranches.GetOrAdd(cacheKey, _ => new Branch(innerBranch, repoDiff, this));
+    }
+
+    public Commit GetOrWrap(LibGit2Sharp.Commit innerCommit, Diff repoDiff)
+        => cachedCommits.GetOrAdd(innerCommit.Sha, _ => new Commit(innerCommit, repoDiff, this));
+
+    public Tag GetOrWrap(LibGit2Sharp.Tag innerTag, Diff repoDiff)
+        => cachedTags.GetOrAdd(innerTag.CanonicalName, _ => new Tag(innerTag, repoDiff, this));
+
+    public Remote GetOrWrap(LibGit2Sharp.Remote innerRemote)
+        => cachedRemotes.GetOrAdd(innerRemote.Name, _ => new Remote(innerRemote, this));
+
+    public Reference GetOrWrap(LibGit2Sharp.Reference innerReference)
+        => cachedReferences.GetOrAdd(innerReference.CanonicalName, _ => new Reference(innerReference));
+
+    public RefSpec GetOrWrap(LibGit2Sharp.RefSpec innerRefSpec)
+        => cachedRefSpecs.GetOrAdd(innerRefSpec.Specification, _ => new RefSpec(innerRefSpec));
+}

src/GitVersion.LibGit2Sharp/Git/RefSpecCollection.cs

@@ -6,10 +6,10 @@ internal sealed class RefSpecCollection : IRefSpecCollection
 {
     private readonly Lazy<IReadOnlyCollection<IRefSpec>> refSpecs;
 
-    internal RefSpecCollection(LibGit2Sharp.RefSpecCollection innerCollection, GitRepository repo)
+    internal RefSpecCollection(LibGit2Sharp.RefSpecCollection innerCollection, GitRepositoryCache repositoryCache)
     {
         innerCollection = innerCollection.NotNull();
-        this.refSpecs = new Lazy<IReadOnlyCollection<IRefSpec>>(() => [.. innerCollection.Select(repo.GetOrCreate)]);
+        this.refSpecs = new Lazy<IReadOnlyCollection<IRefSpec>>(() => [.. innerCollection.Select(repositoryCache.GetOrWrap)]);
     }
 
     public IEnumerator<IRefSpec> GetEnumerator() => this.refSpecs.Value.GetEnumerator();

src/GitVersion.LibGit2Sharp/Git/ReferenceCollection.cs

@@ -5,13 +5,13 @@ namespace GitVersion.Git;
 internal sealed class ReferenceCollection : IReferenceCollection
 {
     private readonly LibGit2Sharp.ReferenceCollection innerCollection;
-    private readonly GitRepository repo;
+    private readonly GitRepositoryCache repositoryCache;
     private Lazy<IReadOnlyCollection<IReference>> references = null!;
 
-    internal ReferenceCollection(LibGit2Sharp.ReferenceCollection collection, GitRepository repo)
+    internal ReferenceCollection(LibGit2Sharp.ReferenceCollection collection, GitRepositoryCache repositoryCache)
     {
         this.innerCollection = collection.NotNull();
-        this.repo = repo.NotNull();
+        this.repositoryCache = repositoryCache.NotNull();
         InitializeReferencesLazy();
     }
 
@@ -24,7 +24,7 @@ public IReference? this[string name]
         get
         {
             var reference = this.innerCollection[name];
-            return reference is null ? null : this.repo.GetOrCreate(reference);
+            return reference is null ? null : this.repositoryCache.GetOrWrap(reference);
         }
     }
 
@@ -33,7 +33,7 @@ public IReference? this[string name]
     public IReference? Head => this["HEAD"];
 
     public IEnumerable<IReference> FromGlob(string prefix)
-        => this.innerCollection.FromGlob(prefix).Select(reference => this.repo.GetOrCreate(reference));
+        => this.innerCollection.FromGlob(prefix).Select(reference => this.repositoryCache.GetOrWrap(reference));
 
     public void Add(string name, string canonicalRefNameOrObject, bool allowOverwrite = false) =>
         RepositoryExtensions.RunSafe(() =>
@@ -50,5 +50,5 @@ public void UpdateTarget(IReference directRef, IObjectId targetId) =>
         });
 
     private void InitializeReferencesLazy()
-        => this.references = new Lazy<IReadOnlyCollection<IReference>>(() => [.. this.innerCollection.Select(repo.GetOrCreate)]);
+        => this.references = new Lazy<IReadOnlyCollection<IReference>>(() => [.. this.innerCollection.Select(repositoryCache.GetOrWrap)]);
 }

src/GitVersion.LibGit2Sharp/Git/Remote.cs

@@ -9,12 +9,12 @@ internal sealed class Remote : IRemote
     private static readonly LambdaKeyComparer<IRemote, string> comparerHelper = new(x => x.Name);
 
     private readonly LibGit2Sharp.Remote innerRemote;
-    private readonly GitRepository repo;
+    private readonly GitRepositoryCache repositoryCache;
 
-    internal Remote(LibGit2Sharp.Remote remote, GitRepository repo)
+    internal Remote(LibGit2Sharp.Remote remote, GitRepositoryCache repositoryCache)
     {
         this.innerRemote = remote.NotNull();
-        this.repo = repo.NotNull();
+        this.repositoryCache = repositoryCache.NotNull();
     }
 
     public int CompareTo(IRemote? other) => comparerHelper.Compare(this, other);
@@ -29,7 +29,7 @@ private IEnumerable<IRefSpec> RefSpecs
             var refSpecs = this.innerRemote.RefSpecs;
             return refSpecs is null
                 ? []
-                : new RefSpecCollection((LibGit2Sharp.RefSpecCollection)refSpecs, repo);
+                : new RefSpecCollection((LibGit2Sharp.RefSpecCollection)refSpecs, this.repositoryCache);
         }
     }
 

src/GitVersion.LibGit2Sharp/Git/RemoteCollection.cs

@@ -5,13 +5,13 @@ namespace GitVersion.Git;
 internal sealed class RemoteCollection : IRemoteCollection
 {
     private readonly LibGit2Sharp.RemoteCollection innerCollection;
-    private readonly GitRepository repo;
+    private readonly GitRepositoryCache repositoryCache;
     private Lazy<IReadOnlyCollection<IRemote>> remotes = null!;
 
-    internal RemoteCollection(LibGit2Sharp.RemoteCollection collection, GitRepository repo)
+    internal RemoteCollection(LibGit2Sharp.RemoteCollection collection, GitRepositoryCache repositoryCache)
     {
         this.innerCollection = collection.NotNull();
-        this.repo = repo.NotNull();
+        this.repositoryCache = repositoryCache.NotNull();
         InitializeRemotesLazy();
     }
 
@@ -24,7 +24,7 @@ public IRemote? this[string name]
         get
         {
             var remote = this.innerCollection[name];
-            return remote is null ? null : this.repo.GetOrCreate(remote);
+            return remote is null ? null : this.repositoryCache.GetOrWrap(remote);
         }
     }
 
@@ -43,5 +43,5 @@ public void Update(string remoteName, string refSpec) =>
         });
 
     private void InitializeRemotesLazy()
-        => this.remotes = new Lazy<IReadOnlyCollection<IRemote>>(() => [.. this.innerCollection.Select(repo.GetOrCreate)]);
+        => this.remotes = new Lazy<IReadOnlyCollection<IRemote>>(() => [.. this.innerCollection.Select(repositoryCache.GetOrWrap)]);
 }