Skip to content

make CheckPath logic clear #20823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 17 additions & 21 deletions modules/git/repo_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -190,24 +190,18 @@ func (c *CheckAttributeReader) Run() error {

// CheckPath check attr for given path
func (c *CheckAttributeReader) CheckPath(path string) (rs map[string]string, err error) {
defer func() {
if err != nil {
log.Error("CheckPath returns error: %v", err)
}
}()
rs = make(map[string]string)

select {
case <-c.ctx.Done():
return nil, c.ctx.Err()
return
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't we disable these kind of returns?

default:
}

if _, err = c.stdinWriter.Write([]byte(path + "\x00")); err != nil {
defer c.Close()
return nil, err
}

rs = make(map[string]string)
for range c.Attributes {
select {
case attr, ok := <-c.stdOut.ReadAttribute():
Expand All @@ -216,7 +210,7 @@ func (c *CheckAttributeReader) CheckPath(path string) (rs map[string]string, err
}
rs[attr.Attribute] = attr.Value
case <-c.ctx.Done():
return nil, c.ctx.Err()
return rs, nil
}
}
return rs, nil
Expand Down Expand Up @@ -394,10 +388,10 @@ func (wr *lineSeparatedAttributeWriter) Close() error {
}

// Create a check attribute reader for the current repository and provided commit ID
func (repo *Repository) CheckAttributeReader(commitID string) (*CheckAttributeReader, context.CancelFunc) {
func (repo *Repository) CheckAttributeReader(commitID string) (*CheckAttributeReader, context.CancelFunc, error) {
indexFilename, worktree, deleteTemporaryFile, err := repo.ReadTreeToTemporaryIndex(commitID)
if err != nil {
return nil, func() {}
return nil, func() {}, err
}

checker := &CheckAttributeReader{
Expand All @@ -408,21 +402,23 @@ func (repo *Repository) CheckAttributeReader(commitID string) (*CheckAttributeRe
}
ctx, cancel := context.WithCancel(repo.Ctx)
if err := checker.Init(ctx); err != nil {
log.Error("Unable to open checker for %s. Error: %v", commitID, err)
} else {
go func() {
err := checker.Run()
if err != nil && err != ctx.Err() {
log.Error("Unable to open checker for %s. Error: %v", commitID, err)
}
cancel()
}()
cancel()
return nil, nil, fmt.Errorf("unable to open checker for %s. Error: %v", commitID, err)
}

go func() {
err := checker.Run()
if err != nil && err != ctx.Err() {
log.Error("Unable to open checker for %s. Error: %v", commitID, err)
}
cancel()
}()

deferable := func() {
_ = checker.Close()
cancel()
deleteTemporaryFile()
}

return checker, deferable
return checker, deferable, nil
}
9 changes: 7 additions & 2 deletions modules/git/repo_language_stats_gogit.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ func (repo *Repository) GetLanguageStats(commitID string) (map[string]int64, err
return nil, err
}

checker, deferable := repo.CheckAttributeReader(commitID)
checker, deferable, err := repo.CheckAttributeReader(commitID)
if err != nil {
return nil, err
}
defer deferable()

sizes := make(map[string]int64)
Expand All @@ -55,7 +58,9 @@ func (repo *Repository) GetLanguageStats(commitID string) (map[string]int64, err

if checker != nil {
attrs, err := checker.CheckPath(f.Name)
if err == nil {
if err != nil {
log.Error("CheckPath returns error: %v", err)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not

return err

here?
So either

Suggested change
log.Error("CheckPath returns error: %v", err)
log.Error("CheckPath returns error: %w", err)
return err

or

Suggested change
log.Error("CheckPath returns error: %v", err)
return err

} else {
if vendored, has := attrs["linguist-vendored"]; has {
if vendored == "set" || vendored == "true" {
return nil
Expand Down
10 changes: 7 additions & 3 deletions modules/git/repo_language_stats_nogogit.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,10 @@ func (repo *Repository) GetLanguageStats(commitID string) (map[string]int64, err
return nil, err
}

checker, deferable := repo.CheckAttributeReader(commitID)
checker, deferable, err := repo.CheckAttributeReader(commitID)
if err != nil {
return nil, err
}
defer deferable()

contentBuf := bytes.Buffer{}
Expand All @@ -87,7 +90,9 @@ func (repo *Repository) GetLanguageStats(commitID string) (map[string]int64, err

if checker != nil {
attrs, err := checker.CheckPath(f.Name())
if err == nil {
if err != nil {
log.Error("CheckPath returns error: %v", err)
} else {
if vendored, has := attrs["linguist-vendored"]; has {
if vendored == "set" || vendored == "true" {
continue
Expand Down Expand Up @@ -125,7 +130,6 @@ func (repo *Repository) GetLanguageStats(commitID string) (map[string]int64, err
continue
}
}

}
}

Expand Down
12 changes: 7 additions & 5 deletions services/gitdiff/gitdiff.go
Original file line number Diff line number Diff line change
Expand Up @@ -1147,16 +1147,20 @@ func GetDiff(gitRepo *git.Repository, opts *DiffOptions, files ...string) (*Diff
}
diff.Start = opts.SkipTo

checker, deferable := gitRepo.CheckAttributeReader(opts.AfterCommitID)
checker, deferable, err := gitRepo.CheckAttributeReader(opts.AfterCommitID)
if err != nil {
return nil, err
}
defer deferable()

for _, diffFile := range diff.Files {

gotVendor := false
gotGenerated := false
if checker != nil {
attrs, err := checker.CheckPath(diffFile.Name)
if err == nil {
if err != nil {
log.Error("CheckPath returns error: %v", err)
} else {
if vendored, has := attrs["linguist-vendored"]; has {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, we have the same code in two different files?
Should we perhaps extract the common things into one method?

if vendored == "set" || vendored == "true" {
diffFile.IsVendored = true
Expand All @@ -1178,8 +1182,6 @@ func GetDiff(gitRepo *git.Repository, opts *DiffOptions, files ...string) (*Diff
} else if language, has := attrs["gitlab-language"]; has && language != "unspecified" && language != "" {
diffFile.Language = language
}
} else {
log.Error("Unexpected error: %v", err)
}
}

Expand Down