Skip to content

fix: pass correct local storage prefix in case an executor spawns an inner job#3488

Merged
johanneskoester merged 3 commits into
mainfrom
fix/spawn-inner-jobs-local-storage-prefix
Mar 26, 2025
Merged

fix: pass correct local storage prefix in case an executor spawns an inner job#3488
johanneskoester merged 3 commits into
mainfrom
fix/spawn-inner-jobs-local-storage-prefix

Conversation

@johanneskoester

@johanneskoester johanneskoester commented Mar 26, 2025

Copy link
Copy Markdown
Contributor

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

  • Refactor
    • Enhanced the job submission logic by clarifying the handling of local and remote execution modes, improving the transparency and maintainability of storage settings.

@coderabbitai

coderabbitai Bot commented Mar 26, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

The changes update the general_args method within the SpawnedJobArgsFactory class. The conditional assignment for the local_storage_prefix variable has been refactored to use an explicit if statement. This condition now separately checks if executor_common_settings.non_local_exec is true and self.workflow.remote_exec is false. Depending on this check, the prefix is obtained from one of two different configuration keys in the settings object, with comments clarifying the logic for remote versus local execution scenarios.

Changes

Files Change Summary
src/snakemake/spawn_jobs.py Refactored the assignment of local_storage_prefix in the general_args method. Switched from a ternary-like approach to an explicit if condition, and added comments to distinguish between remote and local execution cases.

Sequence Diagram(s)

sequenceDiagram
    participant ArgsFactory as SpawnedJobArgsFactory
    participant Executor as executor_common_settings
    participant Workflow as workflow
    participant Config as w2a

    ArgsFactory->>Executor: Evaluate non_local_exec flag
    ArgsFactory->>Workflow: Evaluate remote_exec flag
    alt non_local_exec true and remote_exec false
        ArgsFactory->>Config: Get "storage_settings.remote_job_local_storage_prefix"
        Config-->>ArgsFactory: Return remote_storage_prefix
    else
        ArgsFactory->>Config: Get "storage_settings.local_storage_prefix"
        Config-->>ArgsFactory: Return local_storage_prefix
    end
Loading

📜 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 7a9475b and 79da48e.

📒 Files selected for processing (1)
  • src/snakemake/spawn_jobs.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/snakemake/spawn_jobs.py
⏰ Context from checks skipped due to timeout of 90000ms (34)
  • GitHub Check: tests (10, windows-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py311)
  • GitHub Check: tests (9, windows-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py311)
  • GitHub Check: tests (8, windows-latest, py312)
  • GitHub Check: tests (8, ubuntu-latest, py312)
  • GitHub Check: tests (8, ubuntu-latest, py311)
  • GitHub Check: tests (7, windows-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py311)
  • GitHub Check: tests (6, windows-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py311)
  • GitHub Check: tests (5, macos-latest, py312)
  • GitHub Check: tests (5, windows-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py311)
  • GitHub Check: tests (4, windows-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py311)
  • GitHub Check: tests (3, macos-latest, py312)
  • GitHub Check: tests (3, windows-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py311)
  • GitHub Check: tests (2, macos-latest, py312)
  • GitHub Check: tests (2, windows-latest, py312)
  • GitHub Check: tests (2, ubuntu-latest, py311)
  • GitHub Check: tests (1, macos-latest, py312)
  • GitHub Check: tests (1, windows-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py311)
  • GitHub Check: apidocs

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions

Copy link
Copy Markdown
Contributor

Please format your code with black: black snakemake tests/*.py.

@johanneskoester johanneskoester merged commit 1454ca1 into main Mar 26, 2025
@johanneskoester johanneskoester deleted the fix/spawn-inner-jobs-local-storage-prefix branch March 26, 2025 21:26
johanneskoester pushed a commit that referenced this pull request Mar 28, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.1.3](v9.1.2...v9.1.3)
(2025-03-26)


### Bug Fixes

* pass correct local storage prefix in case an executor spawns an inner
job ([#3488](#3488))
([1454ca1](1454ca1))
* setup_logfile in setup logger to ensure logfile handler is added
([#3486](#3486))
([2ed13fc](2ed13fc))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
…inner job (snakemake#3488)

### QC
<!-- Make sure that you can tick the boxes below. -->

* [x] The PR contains a test case for the changes or the changes are
already covered by an existing test case.
* [x] The documentation (`docs/`) is updated to reflect the changes or
this is not necessary (e.g. if the change does neither modify the
language nor the behavior or functionalities of Snakemake).


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Enhanced the job submission logic by clarifying the handling of local
and remote execution modes, improving the transparency and
maintainability of storage settings.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.1.3](snakemake/snakemake@v9.1.2...v9.1.3)
(2025-03-26)


### Bug Fixes

* pass correct local storage prefix in case an executor spawns an inner
job ([snakemake#3488](snakemake#3488))
([1454ca1](snakemake@1454ca1))
* setup_logfile in setup logger to ensure logfile handler is added
([snakemake#3486](snakemake#3486))
([2ed13fc](snakemake@2ed13fc))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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.

1 participant