Throttle TextChanged to drastically decrease delay for fast typers

[InsanityGod]

throttle text update, this was the simplest way to do it but might want to look into options that allow for larger throttles.

Summary by CodeRabbit

• Bug Fixes

  • Eliminates flicker and incorrect auto-height jumps during rapid typing by batching text-change updates and ensuring main-thread layout updates.
  • Adds error handling and reliable reset of update state to prevent intermittent failures during text edits.

• Performance

  • Reduces redundant layout recalculations while editing, yielding smoother typing and improved responsiveness of auto-height text areas.

[coderabbitai]

Walkthrough

Adds a debounced two-step text-change flow to GuiElementTextArea: TextChanged now enqueues a main-thread task TextChangedBatched and sets a private debounce flag; TextChangedBatched recalculates auto-height/world bounds, calls base.TextChanged, and clears the flag.

Changes

Cohort / File(s)	Summary
Debounced TextChanged handling VTMLEditor/GuiElements/Vanilla/GuiElementTextArea.cs	Adds a private boolean textChangedBatchedQueued flag; changes TextChanged to enqueue a main-thread task TextChangedBatched instead of processing inline; implements TextChangedBatched to recalc auto-height bounds (if enabled), recalc world bounds, call base.TextChanged(), and reset the debounce flag inside a finally block with try/catch error logging.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    actor User
    participant TA as GuiElementTextArea
    participant UI as MainThread
    participant Base as BaseGuiElement

    User->>TA: Text input
    TA->>TA: TextChanged()\n(check textChangedBatchedQueued)
    alt not queued
        TA->>TA: set textChangedBatchedQueued = true
        TA->>UI: enqueue TextChangedBatched()
    else queued
        TA-->>User: return (debounced)
    end

    UI->>TA: TextChangedBatched()
    rect rgba(230,245,255,0.5)
    note over TA: If Autoheight enabled\nupdate auto-height bounds
    TA->>TA: Recalculate world bounds
    TA->>Base: base.TextChanged()
    end
    TA->>TA: textChangedBatchedQueued = false (finally)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I twitch my whiskers at queued bytes,
A buffered hop through quiet nights.
Batched and tidy, bounds align,
No frantic loops—just orderly time.
Rabbit nods: the editor's fine. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly summarizes the addition of throttling for the TextChanged event to reduce delays when typing quickly, which matches the core change in the PR. It's concise, specific, and free of unnecessary details, giving a clear indication of the primary functionality introduced.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 95217d7 and 57dc3b2.

📒 Files selected for processing (1)

• VTMLEditor/GuiElements/Vanilla/GuiElementTextArea.cs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• VTMLEditor/GuiElements/Vanilla/GuiElementTextArea.cs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

VTMLEditor/GuiElements/Vanilla/GuiElementTextArea.cs (1)

38-38: Consider adding a comment to explain the debounce mechanism.

The field name textChangeDelayed doesn't fully convey the coalescing behavior where rapid text changes are batched together. A brief comment would help future maintainers understand the intent.

Example:

+    // Prevents redundant text processing by batching rapid updates
     private bool textChangeDelayed;

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a726e9 and 5be29d0.

📒 Files selected for processing (1)

• VTMLEditor/GuiElements/Vanilla/GuiElementTextArea.cs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

VTMLEditor/GuiElements/Vanilla/GuiElementTextArea.cs (2)

VTMLEditor/GuiElements/Vanilla/GuiElementEditableTextBase.cs (1)

• TextChanged (552-557)

VTMLEditor/GuiElements/Vanilla/GuiElementTextBase.cs (1)

• GetMultilineTextHeight (49-52)