Skip to content

fix: record file extension (e.g. .tsv) in between workflow cache records in order to avoid that files of the wrong format are erroneously returned by the cache. This will lead to some cache misses. But avoiding errors induced by the previous behavior of ignoring file extensions when seeking for cache records is more important.#3314

Merged
johanneskoester merged 2 commits intomainfrom
fix/cache-file-extension
Feb 27, 2025

Conversation

@johanneskoester
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester commented Feb 27, 2025

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

  • New Features
    • Improved caching of job outputs by incorporating file extensions. This update ensures that output files are more accurately identified and retrieved from the cache, reducing potential mismatches.

…rds in order to avoid that files of the wrong format are erroneously returned by the cache. This will lead to some cache misses. But avoiding errors induced by the previous behavior of ignoring file extensions when seeking for cache records is more important.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 27, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • tests/test_output_file_cache/expected-results/cache/6250074792e6b1aa4d9fbd820673cc22fe30525099db88b6918fa513fb003a66.out is excluded by !**/*.out
  • tests/test_output_file_cache/expected-results/cache/fa466047205bfd2dc7fe1fcbd5ec3591e3c1c5f73e8c7112493092191af2bee8.out is excluded by !**/*.out

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This pull request updates the get_outputfiles method in the AbstractOutputFileCache class. The method now yields a tuple containing the output file and its file extension—calculated using Path(job.output[0]).suffix—instead of an empty string. Comments have been added to clarify the need for including the file extension in the caching mechanism to properly distinguish cacheable objects. The overall control flow remains the same.

Changes

File Change Summary
snakemake/caching/init.py Modified the get_outputfiles method to yield a tuple with the output file and its file extension (derived via Path(job.output[0]).suffix), with added comments to clarify the caching mechanism.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Cache as AbstractOutputFileCache
    participant PathLib as Path Library

    Caller->>Cache: call get_outputfiles(job)
    Cache->>PathLib: compute file extension from job.output[0]
    PathLib-->>Cache: return file extension
    Cache->>Caller: yield (job.output[0], extension)
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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 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.

@sonarqubecloud
Copy link
Copy Markdown

@johanneskoester johanneskoester merged commit 4912f00 into main Feb 27, 2025
39 checks passed
@johanneskoester johanneskoester deleted the fix/cache-file-extension branch February 27, 2025 11:10
johanneskoester pushed a commit that referenced this pull request Feb 27, 2025
🤖 I have created a release *beep* *boop*
---


##
[8.29.0](v8.28.0...v8.29.0)
(2025-02-27)


### Features

* provide mechanism to link between report items (snakemake.report_href,
see docs) ([#3224](#3224))
([a024e60](a024e60))
* toggles for binary labels in report
([#3296](#3296))
([7690998](7690998))


### Bug Fixes

* add missing [@conda](https://github.com/conda) annotations
([#3298](#3298))
([0b541cc](0b541cc))
* properly handle remote storage when waiting for pipes
([#3317](#3317))
([9f7e092](9f7e092))
* provide proper error messages if output file preparation (pipe, mkdir)
fails ([#3309](#3309))
([77ef176](77ef176))
* record file extension (e.g. .tsv) in between workflow cache records in
order to avoid that files of the wrong format are erroneously returned
by the cache. This will lead to some cache misses. But avoiding errors
induced by the previous behavior of ignoring file extensions when
seeking for cache records is more important.
([#3314](#3314))
([4912f00](4912f00))
* sort results lexicographically by labels in their order of appearance
([#3293](#3293))
([a19a0ac](a19a0ac))


### Documentation

* update best practices
([7270eb3](7270eb3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
…rds in order to avoid that files of the wrong format are erroneously returned by the cache. This will lead to some cache misses. But avoiding errors induced by the previous behavior of ignoring file extensions when seeking for cache records is more important. (snakemake#3314)

<!--Add a description of your PR here-->

### 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

- **New Features**
- Improved caching of job outputs by incorporating file extensions. This
update ensures that output files are more accurately identified and
retrieved from the cache, reducing potential mismatches.

<!-- 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*
---


##
[8.29.0](snakemake/snakemake@v8.28.0...v8.29.0)
(2025-02-27)


### Features

* provide mechanism to link between report items (snakemake.report_href,
see docs) ([snakemake#3224](snakemake#3224))
([a024e60](snakemake@a024e60))
* toggles for binary labels in report
([snakemake#3296](snakemake#3296))
([7690998](snakemake@7690998))


### Bug Fixes

* add missing [@conda](https://github.com/conda) annotations
([snakemake#3298](snakemake#3298))
([0b541cc](snakemake@0b541cc))
* properly handle remote storage when waiting for pipes
([snakemake#3317](snakemake#3317))
([9f7e092](snakemake@9f7e092))
* provide proper error messages if output file preparation (pipe, mkdir)
fails ([snakemake#3309](snakemake#3309))
([77ef176](snakemake@77ef176))
* record file extension (e.g. .tsv) in between workflow cache records in
order to avoid that files of the wrong format are erroneously returned
by the cache. This will lead to some cache misses. But avoiding errors
induced by the previous behavior of ignoring file extensions when
seeking for cache records is more important.
([snakemake#3314](snakemake#3314))
([4912f00](snakemake@4912f00))
* sort results lexicographically by labels in their order of appearance
([snakemake#3293](snakemake#3293))
([a19a0ac](snakemake@a19a0ac))


### Documentation

* update best practices
([7270eb3](snakemake@7270eb3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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