fix(store): run GC after squashing history to prevent loose object accumulation#1239
Conversation
Summary of ChangesHello @ThanhNguyxn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves an issue where the GitStore's local repository, particularly when utilizing Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request addresses an important issue of loose git objects accumulating in tmpfs by introducing garbage collection after squashing git history. The approach is sound, but my review identifies a significant improvement: the new code currently ignores errors from the garbage collection operations. I've suggested handling these errors to ensure the fix is robust and reliably prevents the tmpfs exhaustion problem.
internal/store/gitstore.go
Outdated
| _ = repo.Prune(git.PruneOptions{OnlyObjectsOlderThan: time.Now()}) | ||
| _ = repo.RepackObjects(&git.RepackConfig{}) |
There was a problem hiding this comment.
The errors returned by repo.Prune and repo.RepackObjects are being ignored. If these operations fail, loose objects will continue to accumulate, which would lead to the same tmpfs exhaustion issue this pull request is intended to fix. To make the fix more robust, these errors should be handled by returning them, which is consistent with the error handling in the rest of the function.
if err := repo.Prune(git.PruneOptions{OnlyObjectsOlderThan: time.Now()}); err != nil {
return fmt.Errorf("git token store: prune objects: %w", err)
}
if err := repo.RepackObjects(&git.RepackConfig{}); err != nil {
return fmt.Errorf("git token store: repack objects: %w", err)
}|
@gemini-code-assist I intentionally ignored these errors for the following reasons:
The fix is designed to be best-effort: we try to clean up after squashing, but don't fail the entire operation if cleanup doesn't succeed. |
|
Thanks for providing such a detailed explanation, @ThanhNguyxn! Your reasoning for not returning errors from I agree that the primary While the commit and push might succeed, if Suggestion: Instead of completely ignoring the errors, I recommend logging them. This would provide crucial observability into the health of the GC process without blocking the main operation. For example: errPrune := repo.Prune(git.PruneOptions{OnlyObjectsOlderThan: time.Now()})
if errPrune != nil {
// Log the error, but don't return it as the primary operation succeeded.
s.logger.Errorf("Failed to prune Git repository: %v", errPrune)
}
errRepack := repo.RepackObjects(&git.RepackConfig{})
if errRepack != nil {
// Log the error, but don't return it as the primary operation succeeded.
s.logger.Errorf("Failed to repack Git repository: %v", errRepack)
}This approach maintains your desired behavior of not failing the |
f0475d0 to
1ad98a4
Compare
|
@gemini-code-assist Good point. I've updated the code to log warnings on GC failures instead of silently ignoring them. This provides visibility into potential issues while keeping the main operation non-blocking. if errPrune := repo.Prune(git.PruneOptions{OnlyObjectsOlderThan: time.Now()}); errPrune != nil {
log.WithError(errPrune).Warn("git token store: failed to prune objects")
}
if errRepack := repo.RepackObjects(&git.RepackConfig{}); errRepack != nil {
log.WithError(errRepack).Warn("git token store: failed to repack objects")
}This follows the same logging pattern used in |
|
That's an excellent update, @ThanhNguyxn! Logging the GC failures as warnings with |
luispater
left a comment
There was a problem hiding this comment.
Summary:
Thanks for tackling the loose object accumulation. I found one blocking issue that must be fixed before merge.
Key findings:
- Blocking:
repo.Prune(git.PruneOptions{OnlyObjectsOlderThan: time.Now()})passes a zeroHandler. In go-git,Prunecallsopt.Handler(hash)without a nil check, which will panic at runtime. Please setHandler: repo.DeleteObject(or a wrapper that logs and continues). Consider handlingErrLooseObjectsNotSupportedgracefully if you want prune to be best-effort. - Non-blocking: Repacking on every write may be expensive; consider gating it (size/interval/threshold) if this path is hot.
Test plan:
- CI: build, ensure-no-translator-changes (passed)
- Local: not run
Address maintainer feedback on PR router-for-me#1239: - Add Handler: repo.DeleteObject to prevent nil panic in Prune - Handle ErrLooseObjectsNotSupported gracefully - Add 5-minute interval gating to avoid repack overhead on every write - Remove sirupsen/logrus dependency (best-effort silent GC) Fixes router-for-me#1104
1ad98a4 to
a406ca2
Compare
Summary
Fixes #1104 - GitStore local repo fills tmpfs due to accumulating loose git objects.
Problem
When using GitStore with tmpfs, the local repository grows unbounded because:
rewriteHeadAsSingleCommitSolution
Added
Prune()andRepackObjects()calls after squashing history incommitAndPushLocked(). This:Changes
internal/store/gitstore.go: Added GC calls afterrewriteHeadAsSingleCommitTesting