`LanguageParser.Parse` infinite loops on malformed input

Open Beginner friendly
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp
Domain
compilers

Research direction

Start at ColorCode.Parsing.LanguageParser.Parse, the loop that drives Match.NextMatch() and assumes the scan position advances. Run the issue's minimal repro console snippet with the json language to watch it hang, then add a no-progress guard (break when the match index and length do not move) so malformed input degrades instead of spinning. Done when the repro returns and the existing parser tests still pass.

Written by the indexing model from the issue text.

Description

AI Disclosure: The bug report below is being co-written by AI.


ColorCode.Core 2.0.15 (CommunityToolkit/ColorCode-Universal)

ColorCode.Parsing.LanguageParser.Parse enters a non-terminating loop for certain malformed source strings, burning a CPU core forever on the calling thread. In our case this was on the UI thread, so the entire app froze.

Why is this important

There are many cases where there can be invalid input passed into the library. For example, AI chat rendering that AI writes the code that need to be syntax highlighted.

Reproduction

Highlighting the following source with the json language:

state.status = "completed"
state.metadata = { "status": "running", "shellID": "sh_1df528…", "pid": 133242 }
content = [
  "Command moved to the background (shell ID: sh_1df528…).…\nOutput is streaming to: …/sh_1df528…out",
  "You will be notified automatically when the command finishes.…"
]

The body is not valid JSON. LanguageParser.Parse does not return.

Minimal repro:

using System;
using System.Collections.Generic;
using System.Threading;
using ColorCode;
using ColorCode.Common;
using ColorCode.Compilation;
using ColorCode.Parsing;

var malformed = """
    state.status = "completed"
    state.metadata = { "status": "running", "shellID": "sh_1df528…", "pid": 133242 }
    content = [
      "Command moved to the background (shell ID: sh_1df528…).…\nOutput is streaming to: …/sh_1df528…out",
      "You will be notified automatically when the command finishes.…"
    ]
    """;

var compiler = new LanguageCompiler(new Dictionary<string, CompiledLanguage>(), new ReaderWriterLockSlim());
var repo = new LanguageRepository(new Dictionary<string, ILanguage> { ["json"] = Languages.FindById("json") });
var parser = new LanguageParser(compiler, repo);

parser.Parse(malformed, Languages.FindById("json"), (parsed, scopes) => { }); // never returns
Expected behavior

Parse returns (the input is simply malformed; highlighting should degrade gracefully or throw a parse error, not hang).

Actual behavior

Parse spins forever in Regex.Match.NextMatch() and never terminates. The thread is unkillable and consumes 100% CPU indefinitely.

Stack trace (from a real hang)
System.Text.RegularExpressions.RegexInterpreter.TryMatchAtCurrentPosition
System.Text.RegularExpressions.RegexInterpreter.Scan
System.Text.RegularExpressions.Regex.ScanInternal
System.Text.RegularExpressions.Regex.RunSingleMatch
System.Text.RegularExpressions.Match.NextMatch        // non-terminating loop
ColorCode.Parsing.LanguageParser.Parse
Root-cause hypothesis

A language rule matches without advancing the scan position, so Match.NextMatch() keeps returning matches at the same position forever. I suspect one of the json language's regex rules can produce a zero-width match on this input, causing the loop in LanguageParser.Parse (which drives the regex and relies on position advancing) to never make progress.

Suggested fix area
  • LanguageParser.Parse: guard against no-progress iterations (e.g. bail if match.Index / match length doesn't advance), or add a safety bound on iterations.
  • Alternatively, consider a timeout/token the caller can use — though note .NET has no way to abort a non-terminating regex, so a prevention guard (zero-width match detection) is more robust than cancellation.
Dominant language
C#
Stars
267
Forks
59
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CommunityToolkit/ColorCode-Universal

All issues in CommunityToolkit/ColorCode-Universal

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.