Fix SlurmClusterExecutor bug

[jan-janssen]

Fixes #688

Summary by CodeRabbit

• Bug Fixes
  • Improved reliability in detecting output cache files, ensuring tasks are executed and input files are saved only when appropriate.

[coderabbitai]

Walkthrough

The logic for checking the existence of an output cache file in the task scheduler was updated. Instead of checking for a filename in a list, the code now checks for the full file path in the cache directory, potentially affecting task execution and cache utilization behavior.

Changes

File(s)	Change Summary
executorlib/task_scheduler/file/shared.py	Modified output cache file existence check to use full file path

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SlurmClusterExecutor
    participant TaskScheduler
    participant FileSystem

    User->>SlurmClusterExecutor: submit(foo, 1)
    SlurmClusterExecutor->>TaskScheduler: submit task
    TaskScheduler->>FileSystem: get_cache_files(cache_directory)
    TaskScheduler->>FileSystem: Check if full output file path exists
    alt Output file exists
        TaskScheduler-->>SlurmClusterExecutor: Return cached result
    else Output file does not exist
        TaskScheduler->>FileSystem: Dump input data file
        TaskScheduler->>SlurmClusterExecutor: Schedule task execution
    end
    SlurmClusterExecutor-->>User: Return result

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Prevent SlurmClusterExecutor from resubmitting jobs when an output cache file already exists (#688)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

• [Feature] More efficient cache directory structure #681: Refactored cache file naming and directory structure, which is directly related to the logic updated in this PR.

Poem

A bunny hopped through code so neat,
To check the cache, not miss a beat.
Now with full path, it finds the file,
And skips the rerun with a smile.
No wasted hops, no needless task—
The clever fix, just what we asked! 🐇

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

---

📜 Recent 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 504b08b.

📒 Files selected for processing (1)

• executorlib/task_scheduler/file/shared.py (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

executorlib/task_scheduler/file/shared.py (1)

executorlib/standalone/cache.py (1)

• get_cache_files (16-30)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: notebooks_integration
• GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
• GitHub Check: notebooks
• GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)

🔇 Additional comments (1)

executorlib/task_scheduler/file/shared.py (1)

115-117: LGTM! Critical cache logic bug fixed.

This change correctly fixes the cache file existence check. The previous implementation was comparing a filename against a list of full file paths returned by get_cache_files(), which would never match. This bug caused tasks to always be re-executed even when cached results were available, severely impacting performance.

The fix properly constructs the full file path for comparison, ensuring the cache mechanism works as intended.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.81%. Comparing base (5f87bb4) to head (504b08b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #697   +/-   ##
=======================================
  Coverage   96.81%   96.81%           
=======================================
  Files          29       29           
  Lines        1317     1317           
=======================================
  Hits         1275     1275           
  Misses         42       42           

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