⚡ Bolt: Optimize validation regex and set construction#140
⚡ Bolt: Optimize validation regex and set construction#140
Conversation
- Pre-compile `RULE_PATTERN` to avoid recompilation overhead in hot loops. - Move `DANGEROUS_CHARS` set to module level to avoid reconstruction. - Verified with existing tests. Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
Merging to
|
Summary of ChangesHello @abhimehro, 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 introduces significant performance improvements by optimizing frequently called validation functions. By pre-compiling a regular expression and moving a character set to a module-level constant, the changes aim to reduce CPU usage during synchronization processes. A micro-benchmark indicated approximately a 50% reduction in execution time for the affected validation function, leading to a more efficient system. Highlights
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a performance optimization by pre-compiling a regular expression and moving a set construction to a module-level constant. The changes are well-implemented and achieve the goal of reducing overhead in frequently called validation functions. I have one suggestion to further improve the robustness of the code by using an immutable frozenset for the new constant, which will prevent accidental modifications at runtime.
|
|
||
| # Validation Patterns | ||
| RULE_PATTERN = re.compile(r"^[a-zA-Z0-9.\-_:*\/]+$") | ||
| DANGEROUS_CHARS = set("<>\"'`") |
There was a problem hiding this comment.
For module-level constants that are collections, it's a good practice to use an immutable version to prevent accidental modification at runtime. This can prevent subtle bugs and potential security vulnerabilities if other parts of the code were to modify this set. Consider using frozenset.
| DANGEROUS_CHARS = set("<>\"'`") | |
| DANGEROUS_CHARS = frozenset("<>\"'`") |
There was a problem hiding this comment.
Pull request overview
This PR optimizes the performance-critical is_valid_rule function by pre-compiling the validation regex pattern and moving the dangerous characters set to module-level constants. The function is called for every rule in every blocklist (potentially hundreds of thousands of times), making this optimization impactful.
Changes:
- Added pre-compiled
RULE_PATTERNconstant for regex validation - Added
DANGEROUS_CHARSset as a module-level constant - Refactored
is_valid_ruleto use the pre-compiled pattern and simplified logic - Updated
is_valid_folder_nameto reference the module-levelDANGEROUS_CHARSconstant
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Validation Patterns | ||
| RULE_PATTERN = re.compile(r"^[a-zA-Z0-9.\-_:*\/]+$") | ||
| DANGEROUS_CHARS = set("<>\"'`") |
There was a problem hiding this comment.
Consider using frozenset instead of set for DANGEROUS_CHARS since this constant is never modified. This would better signal the immutability of the constant and prevent accidental modification. While this doesn't affect correctness or performance significantly, it's a minor best practice for module-level constants.
Example: DANGEROUS_CHARS = frozenset("<>\"'")`
| DANGEROUS_CHARS = set("<>\"'`") | |
| DANGEROUS_CHARS = frozenset("<>\"'`") |
…itization, add dry-run plan details Incorporates the best changes from 36 Jules PRs, addressing review feedback: Bolt (Performance) - from PR #173: - Pre-compile PROFILE_ID_PATTERN and RULE_PATTERN at module level - Use compiled patterns in is_valid_profile_id_format, validate_profile_id, and is_valid_rule - Supersedes PRs: #140, #143, #152, #155, #158, #161, #167, #170, #173 Sentinel (Security) - from PR #172 with review feedback: - Enhance sanitize_for_log to redact Basic Auth credentials in URLs - Redact sensitive query parameters (token, key, secret, password, etc.) - Handle fragment separators (#) per Gemini Code Assist review - Use [^&#\s]* pattern per Copilot reviewer suggestion - Update docstring per reviewer suggestion - Supersedes PRs: #142, #145, #148, #151, #154, #157, #160, #169, #172 Palette (UX) - from PR #174 with lint fixes: - Add print_plan_details function for dry-run visibility - Fix duplicate render_progress_bar definition bug - Supersedes PRs: #139, #141, #144, #147, #150, #153, #156, #159, #162, #165, #168, #171, #174 Also: #146, #149, #164 (parallel folder deletion) and #166 (auto-fix .env perms) are independent features not consolidated here. Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
…itization, add dry-run plan details Incorporates the best changes from 36 Jules PRs, addressing review feedback: Bolt (Performance) - from PR #173: - Pre-compile PROFILE_ID_PATTERN and RULE_PATTERN at module level - Use compiled patterns in is_valid_profile_id_format, validate_profile_id, and is_valid_rule - Supersedes PRs: #140, #143, #152, #155, #158, #161, #167, #170, #173 Sentinel (Security) - from PR #172 with review feedback: - Enhance sanitize_for_log to redact Basic Auth credentials in URLs - Redact sensitive query parameters (token, key, secret, password, etc.) - Handle fragment separators (#) per Gemini Code Assist review - Use [^&#\s]* pattern per Copilot reviewer suggestion - Update docstring per reviewer suggestion - Supersedes PRs: #142, #145, #148, #151, #154, #157, #160, #169, #172 Palette (UX) - from PR #174 with lint fixes: - Add print_plan_details function for dry-run visibility - Fix duplicate render_progress_bar definition bug - Supersedes PRs: #139, #141, #144, #147, #150, #153, #156, #159, #162, #165, #168, #171, #174 Also: #146, #149, #164 (parallel folder deletion) and #166 (auto-fix .env perms) are independent features not consolidated here. Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
is_valid_ruleis called for every single rule in every blocklist (potentially hundreds of thousands of times). Avoiding regex compilation and set construction overhead reduces CPU usage during sync.uv run pytest.PR created automatically by Jules for task 13058679069321960613 started by @abhimehro