fix: resolve race condition in singleton highlighter (issue #1009)#1189
Open
maynkxx wants to merge 1 commit intoshikijs:mainfrom
Open
fix: resolve race condition in singleton highlighter (issue #1009)#1189maynkxx wants to merge 1 commit intoshikijs:mainfrom
maynkxx wants to merge 1 commit intoshikijs:mainfrom
Conversation
✅ Deploy Preview for shiki-matsu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for shiki-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1189 +/- ##
==========================================
- Coverage 95.20% 95.20% -0.01%
==========================================
Files 92 92
Lines 7922 7920 -2
Branches 1689 1688 -1
==========================================
- Hits 7542 7540 -2
Misses 374 374
Partials 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Description
This PR addresses a race condition encountered when using singleton highlighters in concurrent environments.
Previously,
internal-sync.tsincluded an optimization that skipped synchronizing the registry if the requested theme matched the last used theme. While efficient in single-threaded contexts, this caused issues during concurrent requests. If multiple requests hit the highlighter simultaneously, the internal state could become stale, leading to the wrong theme being applied or tokenization errors.I have removed this optimization in
packages/core/src/constructors/internal-sync.ts. Now, the registry explicitly synchronizes the theme for every request. This ensures that the state is always consistent, preventing stale usage regardless of concurrency.Linked Issues
Fixes #1009
Additional context
This change trades a small micro-optimization for significantly better stability in server-side or high-concurrency usage (e.g., when Shiki is used in an API route handling multiple requests at once).