🧹 Janitor: Refactor canonical checking to use new is_canonical API - #301
🧹 Janitor: Refactor canonical checking to use new is_canonical API#301matta wants to merge 1 commit into
is_canonical API#301Conversation
Extracted duplicated logic for checking if a task file matches its canonical format (reading disk, generating canonical, comparing) out of `commands_diagnostics.rs` and `commands_fix.rs`. Added `is_canonical` method to `TaskNode` model in `models.rs` to serve as a clean API. Co-authored-by: matta <37314+matta@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, 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 significantly improves the codebase's modularity by extracting and centralizing the logic for verifying the canonical state of task files. By introducing a dedicated Highlights
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
|
![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 is a good refactoring that centralizes the logic for checking if a task's on-disk representation is canonical. The new TaskNode::is_canonical method simplifies the call sites in commands_diagnostics.rs and commands_fix.rs and improves code clarity. I have one minor suggestion to optimize the implementation of the new method to fail faster on I/O errors.
| let canonical_content = self.get_content_for_disk()?; | ||
| let disk_content = fs::read_to_string(&self.path)?; | ||
| Ok(disk_content == canonical_content) |
There was a problem hiding this comment.
To improve performance and fail faster, it's better to read from disk before generating the canonical content. If reading the file fails, we can avoid the CPU work of serializing the task content. This also aligns with the order of operations in the original code before this refactoring.
| let canonical_content = self.get_content_for_disk()?; | |
| let disk_content = fs::read_to_string(&self.path)?; | |
| Ok(disk_content == canonical_content) | |
| let disk_content = fs::read_to_string(&self.path)?; | |
| let canonical_content = self.get_content_for_disk()?; | |
| Ok(disk_content == canonical_content) |
1 participant
📉 Diff: +11 lines, -11 lines
🎯 Goal: Factoring common logic into modular APIs
💡 Before: The logic to check if a task's disk content matched its canonical string form was duplicated verbatim across
commands_diagnostics.rsandcommands_fix.rs. This leaked model logic into the command implementations.✨ After: A new
is_canonicalAPI exists directly onTaskNode, keeping command implementations clean and semantic.✅ Verification:
cargo check,cargo fmt,cargo clippy, andjust testall pass. Architecture learning logged in.jules/janitor.md.PR created automatically by Jules for task 14174081800138709368 started by @matta