dev CLI: cleanup deprecated background worker files (fixes #1572)

[ericallam]

Summary by CodeRabbit

Release Notes

• New Features

  • Added --keep-tmp-files option for development sessions, allowing users to retain temporary files for debugging purposes

• Improvements

  • Enhanced error handling for temporary directory management
  • Refined background worker lifecycle management

• Bug Fixes

  • Improved handling of temporary file cleanup across different operating systems

[changeset-bot]

🦋 Changeset detected

Latest commit: 0b838f2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages

Name	Type
trigger.dev	Patch
@trigger.dev/build	Patch
@trigger.dev/core	Patch
@trigger.dev/react-hooks	Patch
@trigger.dev/rsc	Patch
@trigger.dev/sdk	Patch
@trigger.dev/database	Patch
@trigger.dev/otlp-importer	Patch
@internal/redis-worker	Patch
@internal/zod-worker	Patch
references-nextjs-realtime	Patch
@internal/testcontainers	Patch

Not sure what this means? Click here to learn what changesets are.

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/cli-v3/src/commands/dev.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces enhancements to the Trigger.dev CLI development workflow, focusing on temporary file management and worker runtime configuration. The changes add a new --keep-tmp-files option, modify background worker handling, and improve error management for temporary directory operations. These modifications provide developers with more control over development session file retention and worker initialization processes.

Changes

File	Change Summary
.changeset/unlucky-meals-develop.md	Patch for trigger.dep configuration, addressing cleanup of deprecated background worker files
packages/cli-v3/src/commands/dev.ts	Added keepTmpFiles option with CLI flag --keep-tmp-files for temporary file retention
packages/cli-v3/src/dev/backgroundWorker.ts	Refactored worker management, removed close method, introduced stop mechanism and #tryStopWorker method
packages/cli-v3/src/dev/devSession.ts	Added clearTmpDirs function, updated temporary directory handling with keepTmpFiles option
packages/cli-v3/src/dev/workerRuntime.ts	Modified initializeWorker method to include stop function for enhanced error handling
packages/cli-v3/src/utilities/tempDirectories.ts	Improved temporary directory removal logic with error handling, added clearTmpDirs function

Sequence Diagram

sequenceDiagram
    participant CLI as Dev CLI
    participant Session as DevSession
    participant Worker as WorkerRuntime
    participant BgWorker as BackgroundWorker

    CLI->>Session: Start with keepTmpFiles option
    Session->>Session: Configure temp directory
    Session->>Worker: Initialize worker
    Worker->>BgWorker: Create background worker
    Worker-->>Worker: Check initialization conditions
    alt Initialization Fails
        Worker->>BgWorker: Stop worker
    end
    Session-->>CLI: Complete development session

Loading

Poem

🐰 In the realm of code, where temp files dance,
A rabbit's CLI takes a clever stance
Keep files or clear, the choice is yours
Debug with ease, through development's doors
Trigger.dev magic, with a hop and a glee! 🚀

---

📜 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 472e5f9 and 0b838f2.

📒 Files selected for processing (6)

• .changeset/unlucky-meals-develop.md (1 hunks)
• packages/cli-v3/src/commands/dev.ts (3 hunks)
• packages/cli-v3/src/dev/backgroundWorker.ts (4 hunks)
• packages/cli-v3/src/dev/devSession.ts (6 hunks)
• packages/cli-v3/src/dev/workerRuntime.ts (4 hunks)
• packages/cli-v3/src/utilities/tempDirectories.ts (2 hunks)

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, 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. (Beta)
• @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.

[pkg-pr-new]

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1595

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1595

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1595

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1595

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1595

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1595

commit: 0b838f2