Add auto pause on timeout to SDK #568

dobrac · 2025-01-31T20:18:14Z

Changes the following

Adds auto pause to SDK, requires having autoPause: true and auto_pause=True
Replaces sandbox resume with connect
Updates sandbox timeout on connect if it's already running

SDK Change
The autoPause option is required, and has to be set to true.

JS

Sandbox.create({ autoPause: true })
Sandbox.connect(sandboxId, {autoPause: true})

Python - Async

AsyncSandbox.create(auto_pause=True)
AsyncSandbox.connect(sandbox_id, auto_pause=True)

Python - Sync

Sandbox(auto_pause=True)
Sandbox.connect(sandbox_id, auto_pause=True)

For both Python implementations, the exit now calls .pause() instead of .kill()

Tasks

Update interface of connect, resume, etc
Add tests for JS SDK
Add tests for Python SDK
~~Update web documentation~~ (not for now, until we know the final SDK DX)

Temporary solution for connect
There is a setTimeout for every connect to resolve issues where paused sandbox can immediately timeout.

Options discussed:
1. No set - never sure how long the sandbox will be running
2. Always set the timeout in code - the user can't just connect to the sandbox
without changing the timeout, round trip to the server time
3. Set the timeout in resume on backend - side effect on error
4. Create new endpoint for connect

This documents the new SDK method implemented [here](#543)

run to => to run 🙂

Hide metrics route in the docs sidebar until the feature is fully released

Added code snippets to documentation for using Groq with E2B.

show metrics route in the docs sidebar now that the metrics feature is released

- Removed code runtime version check to prevent issues until further investigation

Adds recursive directory watch to the SDK and documentation section. Requires merging and deploying e2b-dev/infra#210 first. ### Proposed API change: **JS** ```js await sandbox.files.watchDir(dirname, handler, { recursive: true }) ``` **Python** ```py sandbox.files.watch_dir(dirname, recursive=True) ``` --- ### Notes Python SDK was generated using buf.build/protocolbuffers/python:v28.3. The runtime check was removed for now. Further tests might be required to make sure the runtime is at least the generated version before including the runtime check. Changing the following in the file spec/envd/buf-python.gen.yaml (generator) allows using different protoc-gen-python version: From: `plugin: python` To: `plugin: buf.build/protocolbuffers/python:v28.3`

) Handle the exception properly

# Description The response from backend for port is actual integer

# Description https://github.com/e2b-dev/E2B/security/dependabot/147

# Description The test was moved to integration tests directly in infra repo

# Description This PR allows to codegen without worrying about your environment and dependencies for consistent outcomes in what code is generated from openapi and envd protobuf spec. Will generate files for `js-sdk` and `python-sdk` - [x] create Docker image with all the pinned deps needed to codegen - [x] create codegen script using this container with mapped volumes - [x] adapt Makefiles to this new approach - [x] adapt where we install the connect-python protobuf binary for this to work # Test ```sh make codegen # this command is similar to `make generate` but w/o the hassle Generating SDK code from openapi and envd spec cd packages/js-sdk && pnpm generate > [email protected] generate /workspace/packages/js-sdk > python ./../../spec/remove_extra_tags.py sandboxes templates && openapi-typescript ../../spec/openapi_generated.yml -x api_key --arr ay-length --alphabetize --output src/api/schema.gen.ts ✨ openapi-typescript 7.6.1 🚀 ../../spec/openapi_generated.yml → src/api/schema.gen.ts [44.2ms] cd packages/js-sdk && pnpm generate-envd-api > [email protected] generate-envd-api /workspace/packages/js-sdk > openapi-typescript ../../spec/envd/envd.yaml -x api_key --array-length --alphabetize --output src/envd/schema.gen.ts ✨ openapi-typescript 7.6.1 🚀 ../../spec/envd/envd.yaml → src/envd/schema.gen.ts [22.7ms] [...] cd packages/python-sdk && make generate-api All done! ✨ 🍰 ✨ ``` --------- Co-authored-by: Jiri Sveceny <[email protected]>

- Minor type fix

One should now be able to use sb.filesystem.write(WriteEntry[]) in a typesafe way. --------- Co-authored-by: Mish <[email protected]>

There was a type in dataclass declaration that caused the WriteEntry to behave incorrectly.

…lder during publish (#682) ### Description This was initially performed in [the legacy workflow](https://github.com/e2b-dev/E2B/blob/d27f81c5d3a85e2791258e388eb7ebd5f2e5eaa9/.github/workflows/generate_sdk_ref.yml#L101-L117) but has since been removed, adding it back to have latest [desktop & code-interpreter SDK references](https://e2b.dev/docs/sdk-reference) on our docs ### Test <img width="234" alt="Screenshot 2025-04-15 at 1 47 16 PM" src="https://github.com/user-attachments/assets/b00347d9-794d-41f1-98db-c4704c59f50d" /> #### should become: - [ ] desktop: - [ ] js-sdk `v1.7.01@latest` - [ ] python-sdk `v1.6.1@latest` - [ ] code-interpreter - [ ] js-sdk `v1.1.1@latest` - [ ] python-sdk `v1.2.0@latest`

Because our docs nextjs app is being proxied by our dashboard nextjs app, we need to ensure the docs nextjs app uses absolute urls to handle it's assets. Because when it is proxied by another nextjs app, the proxy tries to reference the docs nextjs apps assets relatively, which results in assets not being found. Before this pr, we set an assetPrefix for every node production deployment, which caused issues on preview deployments, since these can consist of multiple assigned domains and depending on which one was opened, the asset prefixing failed. These changes ensure that only the production deployment of the docs application has an assetPrefix. Here we can be certain on which domain it will live. I created a new environment variable `PRODUCTION_URL` here to ensure 100% consistency with `e2b-dev/dashboard`s proxy domain config, without relying on the vercel projects assigned domain setup.

Add latest changes in main to the auto-pause feature branch - [x] python-sdk - [x] successful build? - [x] successful unit tests? - [x] js-sdk - [x] successful build? - [x] successful unit tests? --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Ben Fornefeld <[email protected]> Co-authored-by: never not exploring <[email protected]> Co-authored-by: Vasek Mlejnsky <[email protected]> Co-authored-by: Vasek Mlejnsky <[email protected]> Co-authored-by: handlebauer <[email protected]> Co-authored-by: Tereza Tizkova <[email protected]> Co-authored-by: tizkovatereza <[email protected]> Co-authored-by: Jakub Dobrý <[email protected]> Co-authored-by: Jakub Novak <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Tomas Valenta <[email protected]> Co-authored-by: r33drichards <[email protected]> Co-authored-by: James Murdza <[email protected]> Co-authored-by: yushengchen <[email protected]> Co-authored-by: Ziray Hao <[email protected]> Co-authored-by: Mish Ushakov <[email protected]> Co-authored-by: Ziray Hao <[email protected]> Co-authored-by: Jiri Sveceny <[email protected]> Co-authored-by: yusheng chen <[email protected]> Co-authored-by: David Batey <[email protected]> Co-authored-by: Penny Templeton <[email protected]>

- Added notices in "Connect to running sandbox", "Sandbox metadata" docs. - Updated "List sandboxes", "Sandbox persistence" docs. - Renamed route "List running sandboxes" > "List sandboxes".

…use-option-to-sdk-e2b-1461

- [x] js-sdk - [x] successful build? - [x] successful unit tests? - [x] python-sdk - [x] successful build? - [x] successful unit tests? --------- Co-authored-by: Jakub Novak <[email protected]> Co-authored-by: Tomáš Rychlik <[email protected]> Co-authored-by: Mish <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

ValentaTomas · 2025-08-19T10:26:41Z

Merged via #854

0div and others added 30 commits January 24, 2025 16:46

use latest beta tag for npm installs

35c1837

Add sandbox metrics docs page (#552)

d3f0e37

This documents the new SDK method implemented [here](#543)

fix thing

02b032a

Fix typo in docs (#554)

43291b5

run to => to run 🙂

hide metrics in sidebar until it's shipped

5b3ef97

Hide metrics in sidebar (#555)

90788ee

Hide metrics route in the docs sidebar until the feature is fully released

Add groq to docs

0524739

Add groq to docs (#557)

aea3d3e

Added code snippets to documentation for using Groq with E2B.

uncomment metrics route

90fb02c

Show metrics in sidebar (#558)

1e1d398

show metrics route in the docs sidebar now that the metrics feature is released

Add watch dir recursive option (missing python client regeneration)

25c4539

Update watch test file formatting

d92a166

Add python generated stubs

4adcfd8

Improve watchDir jsSDK default value

d35880c

Add recursive directory watching to the web documentation

ca85407

Update documentation highlights

225c156

Improve recursive watch tests and folders naming

c8914c2

Regenerated python stubs with version 5.28.3

76b4ac0

- Removed code runtime version check to prevent issues until further investigation

Test for recursive folder creation, add newline after code to docs

6596eda

Run js tests cleanup using onTestFinished

ea8f4ff

Add note to the recursive watch with rapid folder creation

f893f28

Add recursive watch envd version check

29dc1a9

Add recursive watch envd version check python SDK, js SDK check

ec9288a

Cleanup tests only in debug

51e8f18

Fix versions to match updated envd version

359d17d

Lint

8c52e73

Add changeset

13f0c78

Process time out returns incorrect exception in pythonsdk e2b 1476 (#550

fe7ed15

) Handle the exception properly

[skip ci] Release new versions

dde83b7

jakubno and others added 15 commits April 5, 2025 20:38

Fix test for closed ports (#668)

74a6944

# Description The response from backend for port is actual integer

[skip ci] Release new versions

ac81f95

(fix) re-release 1.2.3 version (#672)

e6aeb94

[skip ci] Release new versions

b02f93e

Update esbuild to 0.25.0 (#673)

2aada56

# Description https://github.com/e2b-dev/E2B/security/dependabot/147

Remove order check from SDK. (#675)

e9f39b0

# Description The test was moved to integration tests directly in infra repo

Updates SandboxApiOpts type with added headers field (#677)

f4e0026

- Minor type fix

[skip ci] Release new versions

2822c7b

Fix minor issue in python filesystem SDK (#678)

a1e2274

One should now be able to use sb.filesystem.write(WriteEntry[]) in a typesafe way. --------- Co-authored-by: Mish <[email protected]>

[skip ci] Release new versions

5a43e39

Fix dataclass declaration for WriteEntry (#679)

6ac98db

There was a type in dataclass declaration that caused the WriteEntry to behave incorrectly.

vercel bot deployed to Preview April 17, 2025 13:06 View deployment

mishushakov and others added 4 commits April 17, 2025 17:56

Updated docs on Sandbox.list v2 (#681)

c8d338c

- Added notices in "Connect to running sandbox", "Sandbox metadata" docs. - Updated "List sandboxes", "Sandbox persistence" docs. - Renamed route "List running sandboxes" > "List sandboxes".

Adde CLI beta list command docs (#691)

4f6563c

Merge branch 'main' of https://github.com/e2b-dev/E2B into add-autopa…

2a0f152

…use-option-to-sdk-e2b-1461

fixes after merger for python-sdk

3ac9ee2

vercel bot deployed to Preview April 17, 2025 23:27 View deployment

vercel bot deployed to Preview April 23, 2025 18:09 View deployment

add missing endAt property in paginator return statement

b1c7f43

vercel bot temporarily deployed to Preview April 23, 2025 18:37 Inactive

update poetry lockfile for python-sdk

910c67c

vercel bot temporarily deployed to Preview April 23, 2025 18:51 Inactive

ValentaTomas closed this Aug 19, 2025

ValentaTomas deleted the add-autopause-option-to-sdk-e2b-1461 branch October 7, 2025 03:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add auto pause on timeout to SDK #568

Add auto pause on timeout to SDK #568

Uh oh!

dobrac commented Jan 31, 2025 •

edited by ValentaTomas

Loading

Uh oh!

ValentaTomas commented Aug 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

17 participants

Add auto pause on timeout to SDK #568

Add auto pause on timeout to SDK #568

Uh oh!

Conversation

dobrac commented Jan 31, 2025 • edited by ValentaTomas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ValentaTomas commented Aug 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

17 participants

dobrac commented Jan 31, 2025 •

edited by ValentaTomas

Loading