fix(gitutils): Fix for how we cache head info when searching for tags.

jwalton · Feb 2, 2022 · 934b5ad · 934b5ad
1 parent 1711f68
commit 934b5ad
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/internal/gitutils/caching.go b/internal/gitutils/caching.go
@@ -17,9 +17,10 @@ type caching struct {
 	ahead                int
 	behind               int
 
-	headInfo *HeadInfo
-	state    *RepositoryState
-	stats    *GitStats
+	headInfoTagsSearched int
+	headInfo             *HeadInfo
+	state                *RepositoryState
+	stats                *GitStats
 }
 
 // NewCaching returns a new caching instance of Git.  The returned instance
@@ -79,7 +80,9 @@ func (c *caching) GetAheadBehind(localRef string, remoteRef string) (ahead int,
 
 // Head returns information about the current head.
 func (c *caching) Head(maxTagsToSearch int) (head HeadInfo, err error) {
-	if c.headInfo == nil {
+	haveHeadInfo := c.headInfo != nil && (!c.headInfo.Detached || c.headInfo.IsTag || maxTagsToSearch < c.headInfoTagsSearched)
+	if !haveHeadInfo {
+		c.headInfoTagsSearched = maxTagsToSearch
 		headInfo, err := c.underlying.Head(maxTagsToSearch)
 		if err != nil {
 			return HeadInfo{}, err

diff --git a/internal/gitutils/demo.go b/internal/gitutils/demo.go
@@ -15,6 +15,8 @@ type DemoGit struct {
 	HeadDescription string `yaml:"headDescription"`
 	// IsDetached is true if HEAD is detached.
 	IsDetached bool `yaml:"isDetached"`
+	// IsTag is true if HeadDescription is for a tag.
+	IsTag bool `yaml:"isTag"`
 	// CurrentBranchUpstream is the current upstream branch, or "" if none.
 	CurrentBranchUpstream string `yaml:"currentBranchUpstream"`
 
@@ -83,6 +85,7 @@ func (git DemoGit) Head(maxTagsToSearch int) (head HeadInfo, err error) {
 		Description: headDescription,
 		Detached:    git.IsDetached,
 		Hash:        git.HeadDescription,
+		IsTag:       git.IsTag,
 	}, nil
 }
 

diff --git a/internal/gitutils/gitUtils.go b/internal/gitutils/gitUtils.go
@@ -42,6 +42,8 @@ type HeadInfo struct {
 	Detached bool
 	// Hash is the current hash of the head.
 	Hash string
+	// IsTag is true if the current head matches a tag.
+	IsTag bool
 }
 
 // Git is an interface for interacting with a git repository.

diff --git a/internal/gitutils/head.go b/internal/gitutils/head.go
@@ -33,9 +33,11 @@ func (g *gitUtils) Head(maxTagsToSearch int) (HeadInfo, error) {
 	}
 
 	// If we don't have a description, try to get a tag name
+	isTag := false
 	if description == "" {
 		tag, err := g.GetTagNameForHash(headHash, maxTagsToSearch)
 		if err == nil && tag != "" {
+			isTag = true
 			description = "(" + strings.TrimSpace(tag) + ")"
 		}
 	}
@@ -53,6 +55,7 @@ func (g *gitUtils) Head(maxTagsToSearch int) (HeadInfo, error) {
 		Description: description,
 		Detached:    isDetached,
 		Hash:        headHash,
+		IsTag:       isTag,
 	}, nil
 }