Skip to content

Conversation

@jan-janssen
Copy link
Member

@jan-janssen jan-janssen commented Jul 2, 2025

Before a ValueError was raised when the job file was recreated, now the previous file is removed this guarantees that the resources are correctly updated.

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of existing input files to prevent issues when reusing task cache directories.
  • Tests

    • Added tests to verify correct behavior when cache directories contain existing or corrupted files.
    • Enhanced existing tests to check the number of files in the cache directory after execution.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 2, 2025

"""

Walkthrough

A file existence check and removal step was added before dumping new HDF5 input files for tasks, ensuring old files are deleted to prevent conflicts. Corresponding tests were introduced to verify executor behavior when cache files already exist or are corrupted, including checks for correct file counts in the cache directory after executions.

Changes

File(s) Change Summary
executorlib/task_scheduler/file/shared.py Added logic to remove existing HDF5 input files before dumping new ones during task execution.
tests/test_fluxclusterexecutor.py Added a new test for executor behavior with pre-existing and corrupted cache files, including cache file count checks.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Suite
    participant Executor as FluxClusterExecutor
    participant FS as File System

    Test->>Executor: Submit task with input
    Executor->>FS: Check if .h5 file exists
    alt File exists
        Executor->>FS: Remove existing .h5 file
    end
    Executor->>FS: Dump new .h5 input file
    Executor->>FS: Execute task and manage cache
    Test->>FS: Check cache directory file count
Loading

Possibly related PRs

  • Fix SlurmClusterExecutor bug #697: Modifies the same file and logic to handle existing cache files before dumping new input files, closely related to managing cache file replacement.
  • Implement Caching #435: Enhances caching mechanism and cache-aware task execution, complementing the current PR’s handling of overwriting existing HDF5 input files.

Poem

In the cache where files may hide,
A bunny hops with cautious pride.
Old .h5s swept out of sight,
New tasks sparkle, futures bright.
Tests ensure the count is right—
Hopping forward, code delight!
🐇✨
"""

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Pylint (3.3.7)
executorlib/task_scheduler/file/shared.py
tests/test_fluxclusterexecutor.py
✨ Finishing Touches
  • 📝 Generate Docstrings

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

@codecov
Copy link

codecov bot commented Jul 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.89%. Comparing base (94dfa66) to head (f7e1bcd).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #699   +/-   ##
=======================================
  Coverage   96.89%   96.89%           
=======================================
  Files          29       29           
  Lines        1319     1321    +2     
=======================================
+ Hits         1278     1280    +2     
  Misses         41       41           

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

@jan-janssen jan-janssen linked an issue Jul 2, 2025 that may be closed by this pull request
Copy link
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: 0

🧹 Nitpick comments (1)
tests/test_fluxclusterexecutor.py (1)

72-72: Fix whitespace formatting issue.

Remove the extra space before the closing parenthesis as flagged by static analysis.

-                file_path = os.path.join("executorlib_cache", file_name )
+                file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5f87bb4 and 39d53fc.

📒 Files selected for processing (2)
  • executorlib/task_scheduler/file/shared.py (1 hunks)
  • tests/test_fluxclusterexecutor.py (1 hunks)
🧰 Additional context used
🪛 Flake8 (7.2.0)
tests/test_fluxclusterexecutor.py

[error] 72-72: whitespace before ')'

(E202)

⏰ Context from checks skipped due to timeout of 90000ms (14)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_mpich (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: unittest_mpich (ubuntu-latest, 3.13)
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_win
  • GitHub Check: notebooks
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: notebooks_integration
🔇 Additional comments (3)
executorlib/task_scheduler/file/shared.py (1)

119-120: LGTM! Excellent defensive programming approach.

The file existence check and removal before dumping new data effectively addresses the ValueError issue mentioned in the PR objectives. This ensures a clean state when recreating job files during resubmission of crashed jobs.

tests/test_fluxclusterexecutor.py (2)

44-44: Good addition of cache directory file count verification.

Adding the assertion to check the number of files in the cache directory helps ensure consistent behavior across test runs.


47-88: Excellent comprehensive test coverage for existing files scenario.

The test effectively validates the file removal logic by:

  1. Running initial execution to populate cache
  2. Re-running with existing cache files
  3. Creating corrupted .h5 files and verifying robust handling
  4. Ensuring consistent file count throughout

This directly supports the changes made in shared.py and provides confidence in the crash job resubmission functionality.

@jan-janssen jan-janssen marked this pull request as draft July 2, 2025 17:38
@jan-janssen jan-janssen changed the base branch from main to queue_bug July 2, 2025 17:39
@jan-janssen jan-janssen marked this pull request as ready for review July 2, 2025 18:25
Base automatically changed from queue_bug to main July 3, 2025 01:34
Copy link
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: 0

🧹 Nitpick comments (1)
tests/test_fluxclusterexecutor.py (1)

61-91: Excellent test coverage for existing file handling with minor formatting fix needed.

This test method effectively validates the fix mentioned in the PR objectives by:

  1. Creating a scenario where cache files exist from a previous execution
  2. Simulating corrupted/existing input files by creating dummy _i.h5 files
  3. Verifying that the executor can still function correctly when these files exist

The test logic is sound and directly addresses the issue where resubmission of crashed jobs could fail due to existing files.

Fix the whitespace issue flagged by static analysis:

-                file_path = os.path.join("executorlib_cache", file_name )
+                file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 39d53fc and f7e1bcd.

📒 Files selected for processing (2)
  • executorlib/task_scheduler/file/shared.py (1 hunks)
  • tests/test_fluxclusterexecutor.py (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • executorlib/task_scheduler/file/shared.py
🧰 Additional context used
🪛 Flake8 (7.2.0)
tests/test_fluxclusterexecutor.py

[error] 74-74: whitespace before ')'

(E202)

🔇 Additional comments (1)
tests/test_fluxclusterexecutor.py (1)

11-11: LGTM: Import addition supports new test functionality.

The dump import is correctly added to support the new test method that creates dummy HDF5 input files.

@jan-janssen jan-janssen merged commit e019a0b into main Jul 3, 2025
72 of 76 checks passed
@jan-janssen jan-janssen deleted the queue_crash branch July 3, 2025 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] ClusterExecutor - handle cancelled jobs

3 participants