Add workspace setting in UI #1448

johnnyaug · 2024-04-29T12:49:57Z

Resolves #1145.

This feature allows OpenDevin to operate in the immediate subdirectories of the WORKSPACE_BASE directory.
The immediate children of WORKSPACE_SUBDIR now appear in the settings, and the OpenDevin agent will consider the selected directory as the working directory on the following tasks.

rbren · 2024-04-29T14:45:37Z

opendevin/sandbox/docker/exec_box.py

@@ -61,7 +62,7 @@ def __init__(
            raise ex

        self.instance_id = sid if sid is not None else str(uuid.uuid4())
-
+        self.workspace_mount_path = workspace_mount_path or config.get(ConfigType.WORKSPACE_MOUNT_PATH)


So this isn't quite the logic I think we should have.

Instead, WORKSPACE_MOUNT_PATH should be held constant, and the sandboxes should accept a relative directory, like ./app`

This way the user has a guarantee that we'll always mount on WORKSPACE_MOUNT_PATH or a subdirectory

rbren · 2024-04-29T14:46:18Z

Thanks for taking this on! Excited to add this bit

codecov-commenter · 2024-05-05T10:12:09Z

Codecov Report

Attention: Patch coverage is 63.15789% with 14 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (main@755a407). Click here to learn what that means.

Files	Patch %	Lines
opendevin/server/listen.py	0.00%	8 Missing ⚠️
opendevin/runtime/files.py	0.00%	5 Missing ⚠️
opendevin/server/agent/agent.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1448   +/-   ##
=======================================
  Coverage        ?   64.24%           
=======================================
  Files           ?       99           
  Lines           ?     4072           
  Branches        ?        0           
=======================================
  Hits            ?     2616           
  Misses          ?     1456           
  Partials        ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

neubig · 2024-05-11T15:16:13Z

Hey @johnnyaug , thanks for this! It seems that this is now out of sync, so if you could bring it back in sync with main we can take a look.

johnnyaug · 2024-05-12T07:32:26Z

Hey @neubig, sure - on it

johnnyaug · 2024-05-12T13:21:12Z

frontend/src/services/settings.ts

 */
-export const getSettingsDifference = (settings: Partial<Settings>) => {
-  const currentSettings = getSettings();
+export const getSettingsDifference = (


This change is for testability: The test for SettingsModal mocks getSettings.
Unfortunately, the internal call to getSettings from getSettingsDifference could not be mocked, because of this.

I think the new way is also better in terms of separation of concerns.

rbren · 2024-05-13T13:34:03Z

opendevin/runtime/runtime.py

+        return DockerExecBox(
+            sid=sid, timeout=config.sandbox_timeout, workspace_mount_path=workspace
+        )
    elif sandbox_type == 'local':
-        return LocalBox(timeout=config.sandbox_timeout)
+        return LocalBox(timeout=config.sandbox_timeout, workspace=workspace)
    elif sandbox_type == 'ssh':
-        return DockerSSHBox(sid=sid, timeout=config.sandbox_timeout)
+        return DockerSSHBox(
+            sid=sid, timeout=config.sandbox_timeout, workspace_mount_path=workspace
+        )


I think we should call the input parameter here the same thing, since these are all Sandbox objects. Maybe relative_workspace?

Then the mount path would be path.join(config.workspace_mount_path, relative_workspace)

I think it's also a good idea to keep the extra workspace directory param you're adding relative, rather than an absolute path. The base path varies between in-docker and out-of-docker, so it'd be nice to have a consistent reference to a subdirectory that's valid in both places

Good point - done!

rbren · 2024-05-14T16:53:54Z

Sorry @johnnyaug I should have tried to get this in before my PR.

The plumbing is a little different now--the runtime is instantiated outside the AgentController. Hopefully not too much work to merge

johnnyaug · 2024-05-15T15:15:16Z

opendevin/runtime/runtime.py

@@ -71,6 +81,9 @@ def __init__(
        self.event_stream.subscribe(EventStreamSubscriber.RUNTIME, self.on_event)
        self._bg_task = asyncio.create_task(self._start_background_observation_loop())

+    def set_workspace_subdir(self, workspace_subdir: str):


I'll admit it's not the best practice to change the state on an otherwise fixed-state object, so I'm happy to hear your suggestions.

johnnyaug · 2024-05-16T08:52:35Z

@rbren, no worries - I hope this cuts it, please take another look

rbren · 2024-05-16T13:19:16Z

@johnnyaug unfortunately the agent appears to continue editing the root directory even when I select a subdirectory...

Every time we save new settings, the agent controller and runtime are recreated--maybe instead of setting subdir on the fly, it should be passed directly into the sandbox init?

allow runcmd under workspace subdir wip wip wip Revert "wip" This reverts commit 135770ca5e0170a36827d4a1671b5e13fc944633. wip fix test test caught this! some reverts fix upload linta

johnnyaug · 2024-06-02T12:01:11Z

@rbren, could you please take another look?

mamoodi · 2024-06-04T16:05:00Z

Hi @johnnyaug, I have been tasked with testing this PR and will try to keep on top of testing it when you make changes. I'm running on MacOS. Here is my current structure:

workspace root
- test-dir
  - booboo.rb
  - deep dir
- another test-dir
  - file.rb

There's a couple of issues:

A lot of the times when I select another folder, it gives me this error
If I switch to test-dir folder and then to deep dir folder, it creates a deep dir folder at the workspace root. This seems to be an issue.
If I want to select deep dir, I first have to select test-dir then let the Agent initialize. Then select deep dir because this is two levels deep. In general what happens when I want to select a directory 6 levels deep. CC: @rbren

I tested the Workspace root and one level deep directories and it works well.

What I suggest is in the PR description, you describe how you expect the behavior of setting a new workspace directory should work. For example how you expect setting a directory one level deep vs three level deep should work. Make sure maintainers approve of that and then work out the issues. I will continue testing it as you resolve the issues as this seems like it would be very valuable.

rbren · 2024-06-04T16:53:58Z

IMO we only really need to go one directory deep here. I think the best experience would be:

Start in the root dir
In settings, provide options for:
- /
- /foo
- /bar
- etc

mamoodi · 2024-06-04T17:58:32Z

IMO we only really need to go one directory deep here. I think the best experience would be:

Start in the root dir

In settings, provide options for:

/

/foo

/bar

etc

@johnnyaug in that case things will be simpler. So if you have this directory structure:

Workspace Root
- sub-folder-1
  - deep-folder-1
- sub-folder-2
  - deep-folder-2
- sub-folder-3

The UI will always remain the same and always shows:

Workspace Root
sub-folder-1
sub-folder-2
sub-folder-3

Even if you select sub-folder-1.

I believe you have most of it working. Just need to address the error and always only show the level1 folders.

johnnyaug · 2024-06-05T08:54:57Z

@rbren @mamoodi Just so we're all on the same page - the feature allows exactly what @rbren is suggesting and allows to go only one level deep in the setting. When using the file explorer, you can go as many levels deep as you like, but this is unrelated to this feature.

@mamoodi Hey and thank you for looking into it!
I added the PR description, I hope this makes sense.

In your comments, when you refer to "selecting another directory" I wasn't sure whether you meant using the new subdirectory setting, or selecting using the file explorer. Please try to be unambiguous about it in the future.

Anyway I will take a look at the issues you're describing and report back here.

mamoodi · 2024-06-05T12:08:35Z

@johnnyaug my apologies if I wasn't clear! I am only using the new dropdown added in settings called "OpenDevin Workspace directory". I am unsure what you mean by using the file explorer.

My Workspace structure is like so:

workspace root
- test-dir
  - booboo.rb
  - deep dir

Notice that I've already selected test-dir for my workspace but now it allows me to select deep dir which is two levels deep compared to my workspace root.

tobitege · 2024-06-05T12:13:20Z

edit: comment outdated, removed.

neubig · 2024-06-26T23:11:27Z

Hi! @johnnyaug , are you still interested in this? If so we'd appreciate getting it in, but if not maybe we can close the PR.

mamoodi · 2024-06-30T15:11:39Z

I'm going to close this PR for now. If you happen to continue the work, please reopen the PR again. Thank you.

SmartManoj · 2024-07-11T14:19:08Z

Before changing:

After changing:

@mamoodi, I couldn't reproduce it.
I selected test-dir and click saved. Then I reopen the settings, I got a tick sign in the dropdown values for the selected one and deep dir is not listed for me. Did I miss any step?

mamoodi · 2024-07-11T15:48:51Z

@SmartManoj refresh the browser containing OpenDevin and see if it shows up.

SmartManoj · 2024-07-11T16:48:57Z

opendevin/server/listen.py

    try:
-        return request.state.session.agent_session.runtime.file_store.list(path)
+        files: list[str] = request.state.session.agent_session.runtime.file_store.list(


After selecting a sub_dir, file_store points to the sub_directory.
Then after a refresh, it lists the sub_dir's next-level folders. Should there be a separate option (as the session will not be started if any existing session) end-point and a file_store to fetch the workspace_base folders?

rbren reviewed Apr 29, 2024

View reviewed changes

johnnyaug force-pushed the add_workspace_setting branch from b9aa55a to 8cd7e47 Compare May 3, 2024 15:44

neubig assigned johnnyaug May 11, 2024

johnnyaug force-pushed the add_workspace_setting branch 2 times, most recently from 6250690 to 42da978 Compare May 12, 2024 12:31

johnnyaug commented May 12, 2024

View reviewed changes

johnnyaug marked this pull request as ready for review May 12, 2024 13:22

johnnyaug requested a review from rbren May 12, 2024 13:22

johnnyaug force-pushed the add_workspace_setting branch 2 times, most recently from 0c01662 to 494c1fe Compare May 13, 2024 11:08

rbren reviewed May 13, 2024

View reviewed changes

johnnyaug force-pushed the add_workspace_setting branch from a63cc13 to 350bdb1 Compare May 14, 2024 09:16

johnnyaug force-pushed the add_workspace_setting branch from 350bdb1 to 9668472 Compare May 15, 2024 15:07

johnnyaug requested a review from rbren May 15, 2024 15:14

johnnyaug commented May 15, 2024

View reviewed changes

johnnyaug force-pushed the add_workspace_setting branch from 9e12aa4 to f879e19 Compare May 16, 2024 13:44

rbren mentioned this pull request May 21, 2024

Refactor session management #1810

Merged

johnnyaug force-pushed the add_workspace_setting branch 4 times, most recently from ff9d91b to 3ebd638 Compare May 28, 2024 09:29

johnnyaug added 2 commits June 2, 2024 11:50

add workspace setting in ui

1bc1d27

allow runcmd under workspace subdir wip wip wip Revert "wip" This reverts commit 135770ca5e0170a36827d4a1671b5e13fc944633. wip fix test test caught this! some reverts fix upload linta

cont

9802ff1

johnnyaug force-pushed the add_workspace_setting branch from a950ef1 to 9802ff1 Compare June 2, 2024 08:52

add subdir test to sandbox

e5396d2

Merge branch 'main' into add_workspace_setting

5df1177

mamoodi closed this Jun 30, 2024

SmartManoj reviewed Jul 11, 2024

View reviewed changes

SmartManoj mentioned this pull request Jul 12, 2024

Feat: Add workspace setting in UI #2904

Closed

Add workspace setting in UI #1448

Add workspace setting in UI #1448

Uh oh!

Conversation

johnnyaug commented Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rbren Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rbren commented Apr 29, 2024

Uh oh!

codecov-commenter commented May 5, 2024 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

neubig commented May 11, 2024

Uh oh!

johnnyaug commented May 12, 2024

Uh oh!

johnnyaug May 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rbren May 13, 2024

Choose a reason for hiding this comment

Uh oh!

johnnyaug May 14, 2024

Choose a reason for hiding this comment

Uh oh!

rbren commented May 14, 2024

Uh oh!

johnnyaug May 15, 2024

Choose a reason for hiding this comment

Uh oh!

johnnyaug commented May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rbren commented May 16, 2024

Uh oh!

johnnyaug commented Jun 2, 2024

Uh oh!

mamoodi commented Jun 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rbren commented Jun 4, 2024

Uh oh!

mamoodi commented Jun 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnnyaug commented Jun 5, 2024

Uh oh!

mamoodi commented Jun 5, 2024

Uh oh!

tobitege commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neubig commented Jun 26, 2024

Uh oh!

mamoodi commented Jun 30, 2024

Uh oh!

SmartManoj commented Jul 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mamoodi commented Jul 11, 2024

Uh oh!

SmartManoj Jul 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

johnnyaug commented Apr 29, 2024 •

edited

Loading

rbren Apr 29, 2024 •

edited

Loading

codecov-commenter commented May 5, 2024 •

edited by codecov bot

Loading

johnnyaug May 12, 2024 •

edited

Loading

johnnyaug commented May 16, 2024 •

edited

Loading

mamoodi commented Jun 4, 2024 •

edited

Loading

mamoodi commented Jun 4, 2024 •

edited

Loading

tobitege commented Jun 5, 2024 •

edited

Loading

SmartManoj commented Jul 11, 2024 •

edited

Loading

SmartManoj Jul 11, 2024 •

edited

Loading