Fix Shiki hang on inline struct type highlighting#2962
Conversation
Summary of ChangesHello, 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 a critical performance issue in the Shiki syntax highlighter, specifically targeting a regular expression within the Go+ TextMate grammar. The previous regex caused significant delays or hangs when processing complex inline struct type definitions, particularly those involving nested function parameters. The updated grammar rule prevents this catastrophic backtracking, ensuring efficient and correct highlighting for Go+ code without impacting standard struct field highlighting. 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. Changelog
Activity
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 effectively resolves a performance issue with the syntax highlighter by replacing a complex and inefficient regular expression. This simplification prevents catastrophic backtracking and is a significant improvement. I have identified a minor issue in the new regex concerning the matching of variable lists, which could result in incorrect highlighting for certain valid code formats. My suggestion aims to enhance the robustness of this matching.
There was a problem hiding this comment.
Pull request overview
This PR updates the xgo (GoPlus) TextMate grammar used by Shiki in spx-gui to avoid catastrophic regex behavior when highlighting inline struct{...} types containing semicolon-separated fields, addressing a browser hang during tokenization.
Changes:
- Replaced the inline-struct “semicolon field” matching rule with a simpler regex intended to avoid catastrophic backtracking.
- Kept capture-based highlighting for struct field names and types via existing
#type-declarationspatterns.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Solid fix. The catastrophic backtracking (ReDoS) in the old regex was caused by nested quantifiers around |
Summary
Testing
codeToTokensandcodeToHtmlcomplete successfully after the grammar changetype T struct{X_0 int; X_1 float64}sample still produces highlighted HTMLCloses #2932