Skip to content

Improve io error handling and tests#107

Merged
leynos merged 3 commits intomainfrom
codex/add-error-handling-tests-for-file-operations
Jul 20, 2025
Merged

Improve io error handling and tests#107
leynos merged 3 commits intomainfrom
codex/add-error-handling-tests-for-file-operations

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 20, 2025

Summary

  • extract rewrite_with to handle shared IO processing logic
  • use the helper in rewrite and rewrite_no_wrap
  • add tests for missing file and permission denied scenarios

Testing

  • make fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_687cba29a7d08322ae1a08b4b41ce7b2

Summary by Sourcery

Extract shared file rewrite logic into a helper and streamline rewrite and rewrite_no_wrap functions; add tests for missing file and permission denied error scenarios

Enhancements:

  • Extract rewrite_with helper to consolidate IO processing logic
  • Refactor rewrite and rewrite_no_wrap to use the new helper

Tests:

  • Add tests for handling missing file errors
  • Add tests for handling permission denied errors

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 20, 2025

Reviewer's Guide

Refactored file rewriting functions to use a shared generic helper and added tests for missing file and permission denied error scenarios.

Class diagram for new and updated tests in io module

classDiagram
    class tests {
        +rewrite_table()
        +rewrite_missing_file()
        +rewrite_permission_denied()
    }
    tests : rewrite_missing_file and rewrite_permission_denied test error handling in rewrite
Loading

File-Level Changes

Change Details Files
Extract shared IO processing logic into rewrite_with helper
  • Added generic rewrite_with function encapsulating reading, processing, and writing logic
  • Updated rewrite() to delegate to rewrite_with with process_stream
  • Updated rewrite_no_wrap() to delegate to rewrite_with with process_stream_no_wrap
  • Removed duplicate inline file processing code
src/io.rs
Add tests for error scenarios
  • Added test for missing file (NotFound error)
  • Added test for permission denied error
src/io.rs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 20, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 34 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 870c91e and 8790585.

📒 Files selected for processing (2)
  • Cargo.toml (1 hunks)
  • src/io.rs (2 hunks)

Summary by CodeRabbit

  • Refactor

    • Improved internal file rewriting logic for better code reuse and maintainability.
  • Tests

    • Expanded test coverage to include additional error cases and edge conditions related to file rewriting.

Walkthrough

Refactor the rewrite function in src/io.rs to use a new internal generic helper, rewrite_with, which streamlines file processing logic. Expand the test suite to cover error handling and empty file scenarios. Add the libc crate as a development dependency in Cargo.toml for improved test coverage.

Changes

File(s) Change Summary
Cargo.toml Add libc version 0.2 as a development dependency.
src/io.rs Refactor rewrite logic into a generic helper rewrite_with. Simplify rewrite and rewrite_no_wrap. Add tests for error cases and empty file handling.

Poem

In code’s embrace, a helper appears,
To rewrite with less fuss, allayed are our fears.
Tests now abound for errors and blank,
With libc in tow, we’ve the OS to thank.
Refactored and tidy, the logic is clear—
Raise a toast to the code, and give it a cheer!

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/add-error-handling-tests-for-file-operations

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @leynos - I've reviewed your changes - here's some feedback:

  • The permission denied test uses a hardcoded /proc path which isn't portable; consider creating a temp file and removing write permissions for a more reliable cross‐platform test.
  • Consider adding similar error‐case tests for rewrite_no_wrap to ensure it exhibits the same IO error behavior as rewrite.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The permission denied test uses a hardcoded `/proc` path which isn't portable; consider creating a temp file and removing write permissions for a more reliable cross‐platform test.
- Consider adding similar error‐case tests for `rewrite_no_wrap` to ensure it exhibits the same IO error behavior as `rewrite`.

## Individual Comments

### Comment 1
<location> `src/io.rs:21` </location>
<code_context>
     let lines: Vec<String> = text.lines().map(str::to_string).collect();
-    let fixed = process_stream(&lines);
+    let fixed = f(&lines);
     fs::write(path, fixed.join("\n") + "\n")
 }

</code_context>

<issue_to_address>
Appending a newline unconditionally may introduce an extra newline if the processed content is empty.

If `fixed` is empty, the file will contain only a newline. Consider appending the newline only when `fixed` is not empty, if that's the desired behavior.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    let fixed = f(&lines);
    fs::write(path, fixed.join("\n") + "\n")
}
=======
    let fixed = f(&lines);
    let output = if fixed.is_empty() {
        String::new()
    } else {
        fixed.join("\n") + "\n"
    };
    fs::write(path, output)
}
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/io.rs
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e3395a and 870c91e.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • Cargo.toml (1 hunks)
  • src/io.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
Cargo.toml

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md
**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🔇 Additional comments (7)
src/io.rs (7)

7-27: Excellent extraction of common logic with proper error handling.

The rewrite_with helper function successfully eliminates code duplication whilst properly addressing the previous review concern about empty file handling. The generic design allows both processing functions to share the same I/O logic.

The documentation is clear and follows Rustdoc conventions. The function correctly handles the empty output case by writing an empty string rather than a newline, which addresses the past review comment.


33-33: Clean single-line function implementation.

The refactored rewrite function correctly follows the coding guideline of not using return in single-line functions. The delegation to rewrite_with maintains the same public API whilst benefiting from the shared implementation.


39-41: Consistent refactoring maintains API contract.

The rewrite_no_wrap function is consistently refactored to use the same helper pattern. The implementation is clean and maintains the existing function signature and behaviour.


45-50: Platform-specific imports are properly organised.

The conditional imports are well-structured with appropriate #[cfg(unix)] attributes. The libc import is correctly scoped to Unix platforms where geteuid() is available.


75-81: Thorough error testing for missing files.

The test correctly verifies that missing files produce NotFound errors. The test setup and assertions are appropriate.


104-110: Consistent error testing for the no-wrap variant.

The test maintains consistency with the wrapped variant whilst ensuring both functions handle missing files identically.


133-141: Essential test for empty file behaviour.

This test directly addresses the past review comment concern about empty files adding unwanted newlines. The test correctly verifies that empty files remain empty after processing.

Comment thread Cargo.toml Outdated
Comment thread src/io.rs Outdated
Comment thread src/io.rs Outdated
Comment thread src/io.rs Outdated
@leynos leynos merged commit 247b651 into main Jul 20, 2025
2 checks passed
@leynos leynos deleted the codex/add-error-handling-tests-for-file-operations branch July 20, 2025 13:33
@coderabbitai coderabbitai Bot mentioned this pull request Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant