Very short waits count towards compute usage

[nicktrn]

Summary by CodeRabbit

• Documentation

  • Updated the explanation of task wait behavior. The revised content now clearly describes how waiting periods are handled without impacting compute usage.

• New Features

  • Improved wait operations with enhanced validations and warnings for brief wait durations, along with more robust error handling for time calculations.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 01c64ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update revises the documentation and the wait behavior in the SDK. The documentation now explains that during task triggering and waiting, the parent task is checkpointed and waiting time (after 5 seconds) does not count towards compute usage. In the SDK, a new 5000 ms threshold constant and a function to log warnings for waits below this threshold have been added. The wait.for and wait.until methods are enhanced to perform these checks and to handle error conditions for durations that are zero, negative, or in the past.

Changes

File(s)	Change Summary
docs/snippets/paused-execution-free.mdx	Removed the old <Note> block and replaced it with a detailed explanation on task execution: checkpointing the parent task during subtasks waits and clarifying that wait time beyond 5 seconds does not count towards compute usage.
packages/trigger-sdk/src/v3/wait.ts	Added the constant DURATION_WAIT_CHARGE_THRESHOLD_MS (5000 ms) and the function printWaitBelowThreshold() to log warnings for short waits. Modified wait.for and wait.until to check the duration against the threshold and enhanced error handling for invalid wait times.

Sequence Diagram(s)

sequenceDiagram
    participant User as Caller
    participant WaitMethod as wait.for()/wait.until()
    participant Checker as Duration Checker
    participant Logger as printWaitBelowThreshold()
    
    User->>WaitMethod: Invoke wait method with duration/datetime
    WaitMethod->>Checker: Calculate & check duration
    alt Duration <= 5000 ms
        Checker-->>WaitMethod: Duration below threshold
        WaitMethod->>Logger: Log warning message
    else Duration > 5000 ms
        Checker-->>WaitMethod: Duration acceptable
    end
    WaitMethod->>User: Proceed with wait (checkpoint if needed)

Loading

Poem

I'm a hopping rabbit with a code delight,
Updating docs and SDK to get it just right.
Waiting times checked, warnings now shine,
Every little threshold makes our code divine.
Leaping into the future with a joyful byte!
🐇💻 Hop on, devs!

---

📜 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 32d2992 and 01c64ec.

📒 Files selected for processing (2)

• docs/snippets/paused-execution-free.mdx (1 hunks)
• packages/trigger-sdk/src/v3/wait.ts (3 hunks)

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