add caching for remotes, references, and ref specs

Introduces caching mechanisms for remotes, references, and ref specs in `GitRepository`. Refactors related collections to utilize the new cache for improved efficiency and consistency.

Author: arturcic

src/GitVersion.LibGit2Sharp/Git/GitRepository.cs

@@ -12,6 +12,9 @@ internal sealed partial class GitRepository
     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 IRepository RepositoryInstance
     {
@@ -30,8 +33,8 @@ private IRepository RepositoryInstance
     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);
-    public IReferenceCollection References => new ReferenceCollection(RepositoryInstance.Refs);
+    public IRemoteCollection Remotes => new RemoteCollection(RepositoryInstance.Network.Remotes, this);
+    public IReferenceCollection References => new ReferenceCollection(RepositoryInstance.Refs, this);
 
     public void DiscoverRepository(string? gitDirectory)
     {
@@ -77,6 +80,15 @@ public Commit GetOrCreate(LibGit2Sharp.Commit innerCommit, Diff repoDiff)
     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/RefSpecCollection.cs

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

src/GitVersion.LibGit2Sharp/Git/ReferenceCollection.cs

@@ -5,23 +5,17 @@ namespace GitVersion.Git;
 internal sealed class ReferenceCollection : IReferenceCollection
 {
     private readonly LibGit2Sharp.ReferenceCollection innerCollection;
-    private IReadOnlyCollection<IReference>? references;
+    private readonly GitRepository repo;
+    private Lazy<IReadOnlyCollection<IReference>> references;
 
-    internal ReferenceCollection(LibGit2Sharp.ReferenceCollection collection) => this.innerCollection = collection.NotNull();
-
-    public IEnumerator<IReference> GetEnumerator()
+    internal ReferenceCollection(LibGit2Sharp.ReferenceCollection collection, GitRepository repo)
     {
-        this.references ??= [.. this.innerCollection.Select(reference => new Reference(reference))];
-        return this.references.GetEnumerator();
+        this.innerCollection = collection.NotNull();
+        this.repo = repo.NotNull();
+        this.references = new Lazy<IReadOnlyCollection<IReference>>(() => [.. this.innerCollection.Select(repo.GetOrCreate)]);
     }
 
-    public void Add(string name, string canonicalRefNameOrObject, bool allowOverwrite = false) => this.innerCollection.Add(name, canonicalRefNameOrObject, allowOverwrite);
-
-    public void UpdateTarget(IReference directRef, IObjectId targetId)
-    {
-        RepositoryExtensions.RunSafe(() => this.innerCollection.UpdateTarget((Reference)directRef, (ObjectId)targetId));
-        this.references = null;
-    }
+    public IEnumerator<IReference> GetEnumerator() => this.references.Value.GetEnumerator();
 
     IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
 
@@ -30,13 +24,31 @@ public IReference? this[string name]
         get
         {
             var reference = this.innerCollection[name];
-            return reference is null ? null : new Reference(reference);
+            return reference is null ? null : this.repo.GetOrCreate(reference);
         }
     }
 
     public IReference? this[ReferenceName referenceName] => this[referenceName.Canonical];
 
     public IReference? Head => this["HEAD"];
 
-    public IEnumerable<IReference> FromGlob(string prefix) => this.innerCollection.FromGlob(prefix).Select(reference => new Reference(reference));
+    public IEnumerable<IReference> FromGlob(string prefix)
+        => this.innerCollection.FromGlob(prefix).Select(reference => this.repo.GetOrCreate(reference));
+
+    public void Add(string name, string canonicalRefNameOrObject, bool allowOverwrite = false) =>
+        RepositoryExtensions.RunSafe(() =>
+        {
+            this.innerCollection.Add(name, canonicalRefNameOrObject, allowOverwrite);
+            InitializeReferencesLazy();
+        });
+
+    public void UpdateTarget(IReference directRef, IObjectId targetId) =>
+        RepositoryExtensions.RunSafe(() =>
+        {
+            this.innerCollection.UpdateTarget((Reference)directRef, (ObjectId)targetId);
+            InitializeReferencesLazy();
+        });
+
+    private void InitializeReferencesLazy()
+        => this.references = new Lazy<IReadOnlyCollection<IReference>>(() => [.. this.innerCollection.Select(repo.GetOrCreate)]);
 }

src/GitVersion.LibGit2Sharp/Git/Remote.cs

@@ -9,22 +9,27 @@ 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;
 
-    internal Remote(LibGit2Sharp.Remote remote) => this.innerRemote = remote.NotNull();
+    internal Remote(LibGit2Sharp.Remote remote, GitRepository repo)
+    {
+        this.innerRemote = remote.NotNull();
+        this.repo = repo.NotNull();
+    }
 
     public int CompareTo(IRemote? other) => comparerHelper.Compare(this, other);
     public bool Equals(IRemote? other) => equalityHelper.Equals(this, other);
     public string Name => this.innerRemote.Name;
     public string Url => this.innerRemote.Url;
 
-    public IEnumerable<IRefSpec> RefSpecs
+    private IEnumerable<IRefSpec> RefSpecs
     {
         get
         {
             var refSpecs = this.innerRemote.RefSpecs;
             return refSpecs is null
                 ? []
-                : new RefSpecCollection((LibGit2Sharp.RefSpecCollection)refSpecs);
+                : new RefSpecCollection((LibGit2Sharp.RefSpecCollection)refSpecs, repo);
         }
     }
 

src/GitVersion.LibGit2Sharp/Git/RemoteCollection.cs

@@ -5,36 +5,43 @@ namespace GitVersion.Git;
 internal sealed class RemoteCollection : IRemoteCollection
 {
     private readonly LibGit2Sharp.RemoteCollection innerCollection;
-    private IReadOnlyCollection<IRemote>? remotes;
+    private readonly GitRepository repo;
+    private Lazy<IReadOnlyCollection<IRemote>> remotes;
 
-    internal RemoteCollection(LibGit2Sharp.RemoteCollection collection) => this.innerCollection = collection.NotNull();
-
-    public IEnumerator<IRemote> GetEnumerator()
+    internal RemoteCollection(LibGit2Sharp.RemoteCollection collection, GitRepository repo)
     {
-        this.remotes ??= [.. this.innerCollection.Select(reference => new Remote(reference))];
-        return this.remotes.GetEnumerator();
+        this.innerCollection = collection.NotNull();
+        this.repo = repo.NotNull();
+        InitializeRemotesLazy();
     }
 
+    public IEnumerator<IRemote> GetEnumerator() => this.remotes.Value.GetEnumerator();
+
     IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
 
     public IRemote? this[string name]
     {
         get
         {
             var remote = this.innerCollection[name];
-            return remote is null ? null : new Remote(remote);
+            return remote is null ? null : this.repo.GetOrCreate(remote);
         }
     }
 
-    public void Remove(string remoteName)
-    {
-        this.innerCollection.Remove(remoteName);
-        this.remotes = null;
-    }
+    public void Remove(string remoteName) =>
+        RepositoryExtensions.RunSafe(() =>
+        {
+            this.innerCollection.Remove(remoteName);
+            InitializeRemotesLazy();
+        });
 
-    public void Update(string remoteName, string refSpec)
-    {
-        this.innerCollection.Update(remoteName, r => r.FetchRefSpecs.Add(refSpec));
-        this.remotes = null;
-    }
+    public void Update(string remoteName, string refSpec) =>
+        RepositoryExtensions.RunSafe(() =>
+        {
+            this.innerCollection.Update(remoteName, r => r.FetchRefSpecs.Add(refSpec));
+            InitializeRemotesLazy();
+        });
+
+    private void InitializeRemotesLazy()
+        => this.remotes = new Lazy<IReadOnlyCollection<IRemote>>(() => [.. this.innerCollection.Select(repo.GetOrCreate)]);
 }