Validate UberTask::RetryTask's wait value

[zzaakiirr]

What does this PR do?

This PR:

1. Sets 0 (i/o nil) as default wait value for UberTask::RetryTask
2. Validates that wait value is numeric and positive

Note

We need to validate value of wait attribute because we expect that value is Numeric. For example this will fail unexpectedly:

require 'uber_task'

UberTask.run("some task") do
  raise UberTask::RetryTask.new(reason: "some reason)
end

Backtrace:

lib/ruby/gems/3.2.0/gems/uber_task-0.1.0/lib/uber_task/task_context.rb:174:in `retry?': undefined method `positive?' for nil:NilClass (NoMethodError)

        if err.wait.positive?
	from lib/ruby/gems/3.2.0/gems/uber_task-0.1.0/lib/uber_task/task_context.rb:56:in `rescue in execute'

Summary by CodeRabbit

• Bug Fixes

  • Ensured the wait value in retry tasks is numeric and non-negative, improving stability and reliability.

• Tests

  • Added tests for the default wait value and validation checks, enhancing test coverage for retry tasks.

[coderabbitai]

Walkthrough

The RetryTask class in the retry_task.rb file was updated to validate the wait attribute, ensuring it is numeric and non-negative. The default value for wait is now set to 0. Corresponding tests were added to retry_task_spec.rb to cover these validation checks and to verify the default value functionality.

Changes

Files	Change Summary
lib/.../retry_task.rb	Validate wait attribute in RetryTask constructor; set default wait to 0.
spec/.../retry_task_spec.rb	Added tests for default wait value, non-numeric, and negative wait values.

Poem

In code so bright, where tasks retry,
A wait that's checked, no longer sly.
With zero set, and tests in tow,
Our program's strength begins to grow.

From bugs we leap, with joy we fly,
Our tasks robust, reach for the sky! 🐇✨

---

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

• 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>.
  • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d92f0da and 15e613f.

Files selected for processing (2)

• lib/uber_task/retry_task.rb (1 hunks)
• spec/uber_task/retry_task_spec.rb (1 hunks)

Additional comments not posted (5)

lib/uber_task/retry_task.rb (2)

10-12: LGTM! Ensure the default wait value is appropriate.

The default value of wait has been set to 0 and the value is validated. Ensure that 0 is the desired default value in all contexts.

---

20-23: LGTM! Validation logic is correct.

The validation logic correctly ensures that the wait value is numeric and non-negative.

spec/uber_task/retry_task_spec.rb (3)

23-25: LGTM! Test for default wait value is correct.

The test correctly verifies that the default value of wait is 0.

---

31-36: LGTM! Test for non-numeric wait value is correct.

The test correctly verifies that a non-numeric wait value raises an ArgumentError.

---

38-42: LGTM! Test for negative wait value is correct.

The test correctly verifies that a negative wait value raises an ArgumentError.