fix(badge): make thread-safe with sync.Mutex#147
Open
vaskozl wants to merge 1 commit intokashalls:mainfrom
Open
fix(badge): make thread-safe with sync.Mutex#147vaskozl wants to merge 1 commit intokashalls:mainfrom
vaskozl wants to merge 1 commit intokashalls:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses concurrency issues in the format=badge response path by making go-badge usage thread-safe within the HTTP handler, preventing sporadic panics under concurrent requests.
Changes:
- Add a
sync.MutextoKromgoHandlerto serialize access to the sharedbadge.Generator. - Refactor badge rendering to generate SVG bytes under the mutex, then write the response.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+147
to
+157
| h.badgeMu.Lock() | ||
| var badgeBytes []byte | ||
| switch badgeStyle { | ||
| case "plastic": | ||
| badgeBytes = h.BadgeGenerator.GeneratePlastic(title, message, hex) | ||
| case "flat-square": | ||
| badgeBytes = h.BadgeGenerator.GenerateFlatSquare(title, message, hex) | ||
| default: | ||
| badgeBytes = h.BadgeGenerator.GenerateFlat(title, message, hex) | ||
| } | ||
| if badgeStyle == "flat-square" { | ||
| w.Write(h.BadgeGenerator.GenerateFlatSquare(title, message, hex)) | ||
| return | ||
| } | ||
| //if badgeStyle == "flat" || badgeStyle == "" { | ||
| // w.Write(h.BadgeGenerator.GenerateFlat(title, message, hex)) | ||
| // return | ||
| //} | ||
| h.badgeMu.Unlock() |
There was a problem hiding this comment.
The mutex is manually unlocked after the switch. To avoid accidental deadlocks if this block changes in the future (e.g., a new early-return path or an unexpected panic/recover), prefer Lock() followed immediately by defer Unlock() so the unlock is guaranteed.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Currently
go-badgeis not thread safe.This sometimes results in panics when using format=badge.