Skip to content

[Sandbox SDK] Fix process callbacks, PID capture, and getLogs race #26863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
agents-git-bot wants to merge 1 commit into
base: production
Choose a base branch
from
Open

[Sandbox SDK] Fix process callbacks, PID capture, and getLogs race #26863

agents-git-bot wants to merge 1 commit into from

Conversation

@agents-git-bot
Copy link
Contributor

@agents-git-bot agents-git-bot bot commented Dec 2, 2025 •
edited
Loading

This PR documents fixes from sandbox-sdk PR #267: cloudflare/sandbox-sdk#267

Changes

Bug Fixes Documented

  1. Process callbacks now work correctly - onStart, onOutput, onExit, and onError callbacks are now properly invoked
  2. PID is reliably available - Process PID is now captured and available in the response
  3. Log capture fixed for fast commands - getProcessLogs() now correctly waits for output to be fully captured before returning

Documentation Updates

/sandbox/api/commands.mdx

  • Added documentation for all process callback options: onStart, onOutput, onExit, onError
  • Added example showing callback usage with startProcess()
  • Added note explaining that getProcessLogs() automatically waits for output capture on completed processes
  • Enhanced example showing immediate log availability for fast commands

/sandbox/guides/background-processes.mdx

  • Added new section "Use callbacks for real-time monitoring" with comprehensive examples
  • Documented when to use callbacks vs polling
  • Added guidance on callback use cases (real-time monitoring, error detection, progress tracking, integration)

Impact

These documentation updates ensure users understand how to:

  • Use process callbacks for real-time monitoring
  • Rely on PID being available immediately after starting processes
  • Safely retrieve complete logs from fast-executing commands

🤖 Generated with Claude Code

Related PR: cloudflare/sandbox-sdk#267

@agents-git-bot agents-git-bot bot requested review from a team and whoiskatrin as code owners December 2, 2025 13:23
@github-actions github-actions bot added the size/s label Dec 2, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/sandbox/ @whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025 •
edited
Loading

Preview URL: https://7a439b78.preview.developers.cloudflare.com
Preview Branch URL: https://sync-docs-pr-267.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/sandbox/guides/background-processes/ https://sync-docs-pr-267.preview.developers.cloudflare.com/sandbox/guides/background-processes/
https://developers.cloudflare.com/sandbox/api/commands/ https://sync-docs-pr-267.preview.developers.cloudflare.com/sandbox/api/commands/

@agents-git-bot
Copy link
Contributor Author

agents-git-bot bot commented Dec 2, 2025

Updated documentation to reflect the fixes from cloudflare/sandbox-sdk#267:

Key Changes

  1. Commands API Reference - Added complete callback parameters (, , , ) with examples
  2. Background Processes Guide - Reorganized monitoring section to showcase three approaches:
    • Callbacks (recommended)
    • Manual stream handling
    • Accumulated logs for fast commands

The documentation now accurately reflects the working implementation where:

  • Callbacks actually fire (fixed bug where they never worked)
  • PID is populated correctly (was always undefined)
  • works reliably for fast commands (race condition fixed)

@agents-git-bot
Copy link
Contributor Author

agents-git-bot bot commented Dec 2, 2025

Updated documentation to reflect the fixes from cloudflare/sandbox-sdk#267:

Key Changes

  1. Commands API Reference - Added complete callback parameters (onStart, onOutput, onExit, onError) with examples
  2. Background Processes Guide - Reorganized monitoring section to showcase three approaches:
    • Callbacks (recommended)
    • Manual stream handling
    • Accumulated logs for fast commands

The documentation now accurately reflects the working implementation where:

  • Callbacks actually fire (fixed bug where they never worked)
  • PID is populated correctly (was always undefined)
  • getLogs() works reliably for fast commands (race condition fixed)

@github-actions @claude
Document process callback improvements and log capture fixes
7a439b7 
Updates documentation to reflect bug fixes in sandbox-sdk PR #267:
- Add onStart, onOutput, onExit, and onError callback documentation
- Clarify that PID is now reliably available in process responses
- Document that getProcessLogs() now correctly captures output from fast commands
- Add guidance on when to use callbacks vs polling for process monitoring

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@whoiskatrin whoiskatrin Awaiting requested review from whoiskatrin whoiskatrin is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@whoiskatrin whoiskatrin

@ghostwriternr ghostwriternr

Labels

product:sandbox size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@whoiskatrin @ghostwriternr