docs: Add documentation to safeRegexTest

[mtrezza]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.

Issue

Add documentation to safeRegexTest

Tasks

• Add tests
• Add changes to documentation (guides, repository pages, code comments)
• Add security check
• Add new Parse Error codes to Parse JS SDK

Summary by CodeRabbit

• Performance
  • Optimized regex evaluation performance through improved caching mechanisms.

[parse-github-assistant]

🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review.

Tip

• Keep pull requests small. Large PRs will be rejected. Break complex features into smaller, incremental PRs.
• Use Test Driven Development. Write failing tests before implementing functionality. Ensure tests pass.
• Group code into logical blocks. Add a short comment before each block to explain its purpose.
• We offer conceptual guidance. Coding is up to you. PRs must be merge-ready for human review.
• Our review focuses on concept, not quality. PRs with code issues will be rejected. Use an AI agent.
• Human review time is precious. Avoid review ping-pong. Inspect and test your AI-generated code.

Note

Please respond to review comments from AI agents just like you would to comments from a human reviewer. Let the reviewer resolve their own comments, unless they have reviewed and accepted your commit, or agreed with your explanation for why the feedback was incorrect.

Caution

Pull requests must be written using an AI agent with human supervision. Pull requests written entirely by a human will likely be rejected, because of lower code quality, higher review effort and the higher risk of introducing bugs. Please note that AI review comments on this pull request alone do not satisfy this requirement.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b65cd38-6997-4e0f-8ba1-e2d344863fe0

📥 Commits

Reviewing files that changed from the base of the PR and between eba2656 and 078386a.

📒 Files selected for processing (1)

• src/LiveQuery/QueryTools.js

---

📝 Walkthrough

Walkthrough

The change adds VM context and script cache persistence to QueryTools.js to optimize regex evaluation performance through context reuse while introducing explicit synchronization constraints requiring all operations to remain strictly synchronous.

Changes

Cohort / File(s)	Summary
VM Context & Script Cache Optimization src/LiveQuery/QueryTools.js	Introduces shared vmContext and scriptCache with size limits for improved regex evaluation performance. Adds synchronization constraints requiring safeRegexTest and vmContext usage to remain strictly synchronous, with guard comments documenting these requirements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• test: LiveQuery regex timeout and context isolation are not exploitable #10226 — Tests directly target the same VM context, regex timeout, and isolation behavior being introduced in this QueryTools change.
• fix: Regular Expression Denial of Service (ReDoS) via $regex query in LiveQuery (GHSA-mf3j-86qx-cq5j) #10118 — Modifies the same QueryTools implementation, adding VM-based safeRegexTest, script cache/vmContext state management, and regex timeout configuration.

✨ Finishing Touches

🧪 Generate unit tests (beta)

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

📝 Coding Plan

• Generate coding plan for human review comments

---

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.}

[parseplatformorg]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.60%. Comparing base (eba2656) to head (078386a).
⚠️ Report is 3 commits behind head on alpha.

Additional details and impacted files

@@           Coverage Diff           @@
##            alpha   #10227   +/-   ##
=======================================
  Coverage   92.60%   92.60%           
=======================================
  Files         192      192           
  Lines       16322    16322           
  Branches      199      199           
=======================================
  Hits        15115    15115           
  Misses       1190     1190           
  Partials       17       17           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[parseplatformorg]

🎉 This change has been released in version 9.6.0-alpha.33