Skip to content

fix: return empty set if rate limiter at max#3060

Merged
johanneskoester merged 1 commit intosnakemake:mainfrom
fgvieira:rate_limiter_reached
Sep 4, 2024
Merged

fix: return empty set if rate limiter at max#3060
johanneskoester merged 1 commit intosnakemake:mainfrom
fgvieira:rate_limiter_reached

Conversation

@fgvieira
Copy link
Copy Markdown
Contributor

@fgvieira fgvieira commented Aug 30, 2024 •
edited by coderabbitai bot
Loading

When running locally with a rate limiter, if rate limiter reaches the max number of jobs job_selector function returns None and snakemake fails on line:

snakemake/snakemake/scheduler.py

Lines 278 to 281 in f955478

logger.debug(
f"Selected jobs ({len(run)})"
# + "\n\t".join(map(str, run))
)

with error:

TypeError: object of type 'NoneType' has no len()

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

  • Bug Fixes
    • Improved job selection logic to ensure an empty set is returned when no free jobs are available, enhancing system reliability and preventing unintended behavior.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 30, 2024 •
edited
Loading

Walkthrough

The change modifies the job_selector method in the snakemake/scheduler.py file by adding a return statement that returns an empty set when there are no free jobs available. This ensures that the method consistently returns a set, enhancing control flow and preventing potential errors when no jobs can be selected.

Changes

Files Change Summary
snakemake/scheduler.py Added a return statement to job_selector to return an empty set when n_free_jobs is zero.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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

sonarqubecloud bot commented Aug 30, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

coderabbitai[bot]
coderabbitai bot reviewed Aug 30, 2024
View reviewed changes
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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f955478 and f74d1a3.

Files selected for processing (1)
  • snakemake/scheduler.py (1 hunks)
Additional context used
Path-based instructions (1)
snakemake/scheduler.py (1)

Pattern **/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

@fgvieira fgvieira mentioned this pull request Aug 30, 2024
Closed
@fgvieira fgvieira linked an issue Aug 30, 2024 that may be closed by this pull request
snakemake produce Error when using "--max-jobs-per-timespan" switch #3030
Closed
@fgvieira fgvieira mentioned this pull request Aug 30, 2024
Closed
johanneskoester
johanneskoester approved these changes Sep 4, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester left a comment

Choose a reason for hiding this comment

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

Thanks, good catch!

@johanneskoester johanneskoester merged commit 4e59963 into snakemake:main Sep 4, 2024
@github-actions github-actions bot mentioned this pull request Sep 4, 2024
Merged
@fgvieira fgvieira deleted the rate_limiter_reached branch September 4, 2024 08:43
johanneskoester added a commit that referenced this pull request Sep 4, 2024
@github-actions @johanneskoester
chore(main): release 8.19.1 (#3065)
9f39e85 
🤖 I have created a release *beep* *boop*
---


##
[8.19.1](v8.19.0...v8.19.1)
(2024-09-04)


### Bug Fixes

* fix issues with misinterpretation of max-jobs-per-timespan and
max-jobs-per-seconds
([#3067](#3067))
([d82453b](d82453b))
* pip deployment path
([#3062](#3062))
([bf9305b](bf9305b))
* return empty set if rate limiter at max
([#3060](#3060))
([4e59963](4e59963))
* use wrapt_timeout_decorator, instead of stopit
([#2938](#2938))
([3b64e41](3b64e41))
* Wrong linenumbers reported when linting
([#2985](#2985))
([3a8bd36](3a8bd36))


### Documentation

* update `doc-environment.yml` file and Documentation Setup
documentation
([#3058](#3058))
([a540a2e](a540a2e))

---
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>
Co-authored-by: Johannes Köster <johannes.koester@tu-dortmund.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@johanneskoester johanneskoester johanneskoester approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

snakemake produce Error when using "--max-jobs-per-timespan" switch

2 participants

@fgvieira @johanneskoester