🐛 save file names during gitfile handler setup to avoid data race #4522
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
go-git is not thread-safe, so the old method would lead to race conditions when multiple checks called ListFiles at the same time. This was reproducible when built with `-race`, and now no longer occurs because it's done inside a sync.Once. Signed-off-by: Spencer Schrock <[email protected]>
spencerschrock
requested review from
justaugustus and
raghavkaul
and removed request for
a team
spencerschrock
temporarily deployed
to
gitlab
GitHub Actions
Inactive
spencerschrock
temporarily deployed
to
integration-test
GitHub Actions
Inactive
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4522 +/- ##
==========================================
+ Coverage 66.80% 68.19% +1.39%
==========================================
Files 230 247 +17
Lines 16602 18635 +2033
==========================================
+ Hits 11091 12709 +1618
- Misses 4808 5083 +275
- Partials 703 843 +140 |
spencerschrock
changed the title
spencerschrock
changed the title
balteravishay
pushed a commit
to PrinceAsiedu/scorecard
that referenced
this pull request
Feb 17, 2025
go-git is not thread-safe, so the old method would lead to race conditions when multiple checks called ListFiles at the same time. This was reproducible when built with `-race`, and now no longer occurs because it's done inside a sync.Once. Signed-off-by: Spencer Schrock <[email protected]> Signed-off-by: balteravishay <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What kind of change does this PR introduce?
bug fix from #4474
What is the current behavior?
Each call to
ListFileswould walk the HEAD commit's tree, butgo-gitis not thread-safe.So the old method would lead to race conditions when multiple checks called
ListFilesat the same time. This slipped by my development but was reproducible when built with-race:What is the new behavior (if this is a feature change)?**
The data race no longer occurs because the files are enumerated from the git tree inside a
sync.Once, so only one thread.These files are put in a slice where they can concurrently be read by multiple goroutines later.
Which issue(s) this PR fixes
NONE
Special notes for your reviewer
Does this PR introduce a user-facing change?
For user-facing changes, please add a concise, human-readable release note to
the
release-note(In particular, describe what changes users might need to make in their
application as a result of this pull request.)