provider sandbox#15311
Draft
lgrammel wants to merge 1 commit into
Draft
Conversation
5 tasks
felixarntz
added a commit
that referenced
this pull request
May 18, 2026
… wrappers to `Experimental_Sandbox` abstraction (#15345) ## Background `Experimental_Sandbox` (previous: #14949, #15253, #15301) only exposed `description` and `runCommand`, so tools that needed file I/O had to wrap every read/write in a shell command (`cat`, `tee`, `echo > …`). That is fragile for binary content and impossible to type properly. ## Summary - Adds six file methods to `Experimental_Sandbox`: streaming `readFile`/`writeFile` as the foundation, plus `readBinaryFile`/`readTextFile` and `writeBinaryFile`/`writeTextFile` as convenience wrappers. - All methods take a single options object so additional fields can be added without breaking the signature. - Using a stream for the foundation is the most low-level and future-proof primitive, plus it handles large files better. - In a follow up PR, we'll add another reduced abstraction surface, because technically a sandbox provider shouldn't have to implement the convenience wrappers `readTextFile`, `writeTextFile`, etc. This can take inspiration from (or continue with) #15311. - Updates the three example sandbox implementations (`LocalSandbox`, `JustBashSandbox`, both `VercelSandbox` copies) to implement the new methods, using streaming `readFile`/`writeFile` as the foundation that the binary and text variants delegate to. ## Checklist - [x] All commits are signed (PRs with unsigned commits cannot be merged) - [x] Tests have been added / updated (for bug fixes / features) - [x] Documentation has been added / updated (for bug fixes / features) - [x] A _patch_ changeset for relevant packages has been added (for bug fixes / features - run `pnpm changeset` in the project root) - [x] I have reviewed this pull request (self-review) ## Future Work See above: We'll need to add that reduced abstraction surface so that only essential methods _have_ to be implemented by the provider. We can provide a helper function to fill in the convenience wrappers automatically.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
Summary
Manual Verification
Checklist
pnpm changesetin the project root)Future Work
Related Issues