Integrate E2B sandbox as an alternative to a Docker container #727

mlejva · 2024-04-04T18:26:53Z

This is a draft PR for integrating E2B sandbox for OpenDevin's agents. The E2B sandbox is a secure micro VM made for running AI agents and AI generated code in the cloud.

I'll be updating the following todo list as I go:

Bring E2B sandbox to the parity in terms of functionality with the current sandbox.py
Common interface between Docker container and E2B sandbox
Update fileops to happen inside sandbox when using E2B
~~Use E2B sandbox for running swe-bench evals end-to-end~~ (will be done in separate PR)

foragerr · 2024-04-04T18:40:37Z

curious: Can e2b run inside docker?

mlejva · 2024-04-04T18:42:38Z

curious: Can e2b run inside docker?

No. E2B sandbox is a VM so it sits on a "lower level" compared to a container. What will be possible in the future is to run Docker inside E2B.

rbren

Looking good!

We can probably formalize the sandbox interface with an abstract class--doesn't need to be in this PR though

opendevin/controller/command_manager.py

mlejva · 2024-04-05T18:06:08Z

Looking good!

We can probably formalize the sandbox interface with an abstract class--doesn't need to be in this PR though

I'm planning on updating the PR today/tomorrow with proper config and env vars setup and make it match the functionality of the current sandbox.
Once that all will look good to you guys, happy to start working on the common interface.

mlejva · 2024-04-07T05:36:10Z

@rbren a short update, still work in progress.

I updated the PR so the E2B sandbox matches the functionality of the current Docker sandbox. Specifically the background commands are now supported. Also rebased to main to stay up to date with the new code style rules.

Next step is to:

1. Clean up and improve types so we can build a shared interface between E2B sandbox and Docker sandbox
2. Add config option to allow switching between E2B sandbox and Docker sandbox
3. Enable filesystem operations. Currently, the filesystem operations with Docker sandbox are happening through a mounted volume because the container is running locally. WIth E2B sandbox, everything should happen inside the sandbox - sandbox.filesystem.write('...') - you're interacting right with the filesystem inside the sandbox. We can't currently mount a local folder to the sandbox. I'm thinking introducing a config flag (as mentioned above) to allow users switch sandbox and change how filesystem ops work based on that.

I think I should be able to finish the whole PR this Sunday

mlejva · 2024-04-07T21:40:26Z

@rbren similar to what @foragerr did in #874 I think we should also build a common interface for process (what's known as command at the moment). It'd be something fairly simple like

from abc import ABC, abstractmethod

class Process(ABC):
    @abstractmethod
    def kill(self):
        pass

    @abstractmethod
    def read_logs(self) -> str:
        pass
    
    @property
    @abstractmethod
    def id(self) -> int:
        pass

    @property
    @abstractmethod
    def command(self) -> str:
        pass

    @property
    @abstractmethod
    def exit_code(self) -> int | None: # The reason it can be none is because the process can still be running
       pass

What do you think?

rbren · 2024-04-09T16:45:07Z

@mlejva that seems reasonable to me!

mlejva · 2024-04-09T19:15:31Z

curious: Can e2b run inside docker?

@foragerr I realized I might have misunderstood your question. I thought you're talking about self-hosting. With self-hosting what I wrote stands - E2B sandbox is a VM so it sits on a "lower level" compared to a container. What will be possible in the future is to run Docker inside E2B.

But you can definitely use E2B SDK for launching sandboxes in our cloud from Docker and Dockerize the whole app.

I just wanted to clear that up

neubig

Looks great, thanks a bunch for the contribution! I just have a few small comments.

opendevin/sandbox/__init__.py

opendevin/sandbox/e2b/e2b.Dockerfile

opendevin/sandbox/e2b/sandbox.py

opendevin/sandbox/process.py

rbren · 2024-04-15T05:36:53Z

opendevin/action/fileop.py

-        with open(whole_path, "w", encoding="utf-8") as file:
-            file.write(self.content)
-        return FileWriteObservation(content="", path=self.path)
+        if isinstance(controller.command_manager.sandbox, E2BBox):


This feels leaky to me. But passing controller into run is already kind of leaky. Curious if you have any ideas on how to improve this.

Maybe sandbox should handle all the run logic...

We can come back to this in a future PR

Yeah I agree this doesn't feel right. Happy to refactorize this once we merge this PR

rbren

Excited to get this in!

…o e2b-sandbox

mlejva · 2024-04-16T06:26:42Z

Hey @rbren thank you so much for the code review. I merged the main branch. I'm struggling a bit with understanding why the build didn't pass though.

I built it locally with both Python 3.11 and 3.12 and it looks like it's passing.

The errors in GitHub actions seem to only show error code and nothing else though:

I'm not sure why it's not passing, I you have any tips, it would be super helpful!

mlejva · 2024-04-16T06:34:05Z

I also did a bit of refactorization in this PR.

Sandbox is now separated to docker and e2b
BackgroundCommand is now Process with separate `
I added readme to E2B sandbox to get people started easily
I pre-built a custom E2B sandbox for OpenDevin called open-devin.
- Currently, it's only 0.5GB RAM and 2vCPU and people need to use their on SDK key but once we get OpenDevin to a cloud hosted webapp, we'll upgrade it to better machine, and sponsor all needed compute for OpenDevin's team API key

rbren

This LGTM as-is! A couple minor notes though

rbren · 2024-04-16T14:14:04Z

containers/e2b-sandbox/README.md

+
+1. Build the sandbox
+  ```sh
+  e2b template build --dockerfile ./Dockerfile --name "open-devin"


Can we e2b template from a remote image like ubuntu or ghcr.io/opendevin/sandbox? Or does the user have to build it from scratch?

Would be nice not to have to maintain a new Dockerfile, or to at least build it for them in our CI/CD pipeline

You can share the same Dockerfile and use a remote image. We just have some restrictions on what images and Dockerfile commands we support. Generally, you should be good. I'll set it up to use the same Dockerfile image

rbren · 2024-04-16T14:14:49Z

containers/e2b-sandbox/e2b.toml

@@ -0,0 +1,14 @@
+# This is a config for E2B sandbox template.


I don't see this file getting used anywhere?

It's used by the E2B CLI, it's something like Cloudflare Workers have their wrangler.toml

rbren · 2024-04-16T14:17:30Z

opendevin/sandbox/e2b/README.md

+
+1. [Get your API key](https://e2b.dev/docs/getting-started/api-key)
+
+1. Set your E2B API key in the `config.toml` file as `E2B_API_KEY`


We're mostly getting rid of config.toml now that everything is running inside docker. Maybe this should be passed into docker run with -e?

Yeah, that should work, I can update it. So config.py isn't used anymore and instead we should pass the env vars, right?

I updated the readme to instruct users to set the E2B API key to the E2B_API_KEY env var.

If there's nothing else you think should change, this PR should be good to go!

rbren · 2024-04-17T16:15:04Z

auto-merge enabled! 🚀

Thanks for all the work here!

rbren · 2024-04-17T16:19:58Z

Sorry, merge conflicts 😭

SWE-agent implemented start and end lines for read/write operations, which I suppose we'll need to support with e2b. Hopefully that's not too hard...

mlejva · 2024-04-17T16:21:09Z

Sorry, merge conflicts 😭

SWE-agent implemented start and end lines for read/write operations, which I suppose we'll need to support with e2b. Hopefully that's not too hard...

Looking into it in 1-2 hours!

…o e2b-sandbox

mlejva · 2024-04-18T22:50:55Z

Hey @rbren I finally got to resolving the conflicts. Sorry it took longer.
Can you please check it when you have a moment and if it looks good to you merge it?

Thank you!

…o e2b-sandbox

rbren reviewed Apr 5, 2024

View reviewed changes

opendevin/controller/command_manager.py Outdated Show resolved Hide resolved

opendevin/controller/command_manager.py Outdated Show resolved Hide resolved

foragerr mentioned this pull request Apr 5, 2024

Create Dockerfile for running OpenDevin end to end #110

Closed

mlejva force-pushed the e2b-sandbox branch from 6a7e425 to 1f1f5cf Compare April 7, 2024 04:46

mlejva added 5 commits April 7, 2024 09:16

add e2b sandbox [wip]

d52066f

Install e2b package

f2fd723

Add basic E2B sandbox integration

37cb891

Update dependencies and fix command execution in E2BSandbox

5162c27

Udpate e2b

959f4b1

mlejva force-pushed the e2b-sandbox branch from 1f1f5cf to 959f4b1 Compare April 7, 2024 16:51

foragerr mentioned this pull request Apr 7, 2024

Create a CommandExecutor abstract class #874

Merged

Add comment

9f81ea3

mlejva added 3 commits April 7, 2024 20:58

Lint

0352988

Lint

6e03131

Remove unnecessary type conversion

6a44869

mlejva added 4 commits April 10, 2024 11:35

Resolve merge conflicts

ed58bc7

Lint

10e7b87

Fix linting

28b6781

Fix types

36ddfd0

mlejva marked this pull request as ready for review April 13, 2024 02:09

mlejva requested a review from rbren April 13, 2024 03:34

Merge branch 'main' into e2b-sandbox

1cb9ef9

neubig self-requested a review April 14, 2024 01:36

neubig reviewed Apr 14, 2024

View reviewed changes

opendevin/sandbox/__init__.py Outdated Show resolved Hide resolved

opendevin/sandbox/e2b/e2b.Dockerfile Outdated Show resolved Hide resolved

opendevin/sandbox/e2b/sandbox.py Show resolved Hide resolved

opendevin/sandbox/process.py Outdated Show resolved Hide resolved

rbren reviewed Apr 15, 2024

View reviewed changes

rbren approved these changes Apr 15, 2024

View reviewed changes

mlejva added 3 commits April 15, 2024 23:12

Fix errors

93bb5e6

Merge branch 'e2b-sandbox' of https://github.com/mlejva/OpenDevin int…

63aa722

…o e2b-sandbox

Fix log

fba3ba4

rbren approved these changes Apr 16, 2024

View reviewed changes

rbren reviewed Apr 16, 2024

View reviewed changes

mlejva added 3 commits April 16, 2024 10:32

Merge branch 'main' into e2b-sandbox

416a39b

Fix errors

0526d8c

Update E2B readme

d180be0

rbren enabled auto-merge (squash) April 17, 2024 16:14

Merge branch 'main' into e2b-sandbox

5dd854e

mlejva added 2 commits April 18, 2024 13:14

Fix errors

d20a829

Merge branch 'e2b-sandbox' of https://github.com/mlejva/OpenDevin int…

84f6b81

…o e2b-sandbox

auto-merge was automatically disabled April 18, 2024 20:14
Head branch was pushed to by a user without write access

Lint

43168a4

Merge branch 'main' into e2b-sandbox

2e7115e

rbren enabled auto-merge (squash) April 19, 2024 16:50

mlejva added 4 commits April 19, 2024 10:24

Merge branch 'main' into e2b-sandbox

a24da7e

Merge branch 'e2b-sandbox' of https://github.com/mlejva/OpenDevin int…

94d2f35

…o e2b-sandbox

Merge branch 'main' into e2b-sandbox

c1fa7f7

poetry lock

436ea9e

auto-merge was automatically disabled April 19, 2024 18:09
Head branch was pushed to by a user without write access

rbren merged commit 76b81ca into OpenDevin:main Apr 19, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate E2B sandbox as an alternative to a Docker container #727

Integrate E2B sandbox as an alternative to a Docker container #727

mlejva commented Apr 4, 2024 •

edited

foragerr commented Apr 4, 2024

mlejva commented Apr 4, 2024 •

edited

rbren left a comment

mlejva commented Apr 5, 2024

mlejva commented Apr 7, 2024 •

edited

mlejva commented Apr 7, 2024 •

edited

rbren commented Apr 9, 2024

mlejva commented Apr 9, 2024

neubig left a comment

rbren Apr 15, 2024 •

edited

mlejva Apr 16, 2024 •

edited

rbren left a comment

mlejva commented Apr 16, 2024 •

edited

mlejva commented Apr 16, 2024

rbren left a comment

rbren Apr 16, 2024

mlejva Apr 16, 2024 •

edited

rbren Apr 16, 2024

mlejva Apr 16, 2024 •

edited

rbren Apr 16, 2024

mlejva Apr 17, 2024

mlejva Apr 17, 2024

rbren commented Apr 17, 2024

rbren commented Apr 17, 2024

mlejva commented Apr 17, 2024

mlejva commented Apr 18, 2024

		@@ -0,0 +1,14 @@
		# This is a config for E2B sandbox template.


		1. [Get your API key](https://e2b.dev/docs/getting-started/api-key)

		1. Set your E2B API key in the `config.toml` file as `E2B_API_KEY`

Integrate E2B sandbox as an alternative to a Docker container #727

Integrate E2B sandbox as an alternative to a Docker container #727

Conversation

mlejva commented Apr 4, 2024 • edited

foragerr commented Apr 4, 2024

mlejva commented Apr 4, 2024 • edited

rbren left a comment

Choose a reason for hiding this comment

mlejva commented Apr 5, 2024

mlejva commented Apr 7, 2024 • edited

mlejva commented Apr 7, 2024 • edited

rbren commented Apr 9, 2024

mlejva commented Apr 9, 2024

neubig left a comment

Choose a reason for hiding this comment

rbren Apr 15, 2024 • edited

Choose a reason for hiding this comment

mlejva Apr 16, 2024 • edited

Choose a reason for hiding this comment

rbren left a comment

Choose a reason for hiding this comment

mlejva commented Apr 16, 2024 • edited

mlejva commented Apr 16, 2024

rbren left a comment

Choose a reason for hiding this comment

rbren Apr 16, 2024

Choose a reason for hiding this comment

mlejva Apr 16, 2024 • edited

Choose a reason for hiding this comment

rbren Apr 16, 2024

Choose a reason for hiding this comment

mlejva Apr 16, 2024 • edited

Choose a reason for hiding this comment

rbren Apr 16, 2024

Choose a reason for hiding this comment

mlejva Apr 17, 2024

Choose a reason for hiding this comment

mlejva Apr 17, 2024

Choose a reason for hiding this comment

rbren commented Apr 17, 2024

rbren commented Apr 17, 2024

mlejva commented Apr 17, 2024

mlejva commented Apr 18, 2024

mlejva commented Apr 4, 2024 •

edited

mlejva commented Apr 4, 2024 •

edited

mlejva commented Apr 7, 2024 •

edited

mlejva commented Apr 7, 2024 •

edited

rbren Apr 15, 2024 •

edited

mlejva Apr 16, 2024 •

edited

mlejva commented Apr 16, 2024 •

edited

mlejva Apr 16, 2024 •

edited

mlejva Apr 16, 2024 •

edited