Implement functionality to open and close projects in dashboard #13994

4e6 · 2025-09-11T16:41:08Z

Pull Request Description

close #13891
close #14006
followup #13832

PR adds the rest of the project management functionality to the dashboard.

Changelog:

add: remaining project manager methods:
- project/open
- project/close
- project/delete
- project/duplicate
- project/rename
add: dependency to npm trash package to delete the projects into the system trash bin
add: ProjectService.test.ts test suite checking the project management logic
update: initialize the project manager WebSocket connection lazily. Since all the logic is implemented in the dashboard, we only need the connection if the enableProjectService feature flag is disabled

Important Notes

How to enable the new dashboard project management

Dev Mode

Run the dev server as usual (you can skip the rest if you only develop gui)

corepack pnpm compile
corepack pnpm run dev:gui

Locate enso executable

The dev:gui script looks into the built-distribution/ directory for an enso executable (enso.exe or enso.bat on Windows). This way it will automatically pick up the dev enso version built with sbt buildEngineDistribution

app/gui dev:vite: Found enso executable: /home/dbushev/projects/luna/enso/built-distribution/enso-engine-0.0.0-dev-linux-amd64/enso-0.0.0-dev/bin/enso

if nothing was found, the script will download the latest nightly

app/gui dev:vite: Downloading latest Enso engine (prerelease)...
app/gui dev:vite: Downloading enso-engine-2025.3.1-nightly.2025.9.19-linux-amd64.tar.gz...
app/gui dev:vite: Extracting to /home/dbushev/projects/luna/enso/built-distribution/enso-engine-2025.3.1-nightly.2025.9.19-linux-amd64...
app/gui dev:vite: Enso engine downloaded and extracted to /home/dbushev/projects/luna/enso/built-distribution/enso-engine-2025.3.1-nightly.2025.9.19-linux-amd64
app/gui dev:vite: Found enso executable: /home/dbushev/projects/luna/enso/built-distribution/enso-engine-2025.3.1-nightly.2025.9.19-linux-amd64/enso-2025.3.1-nightly.2025.9.19/bin/enso

Override enso executable

ENSO_RUNNER_PATH environment variable can be used to set the absolute path to specific enso executable

ENSO_RUNNER_PATH=/home/dbushev/projects/luna/enso/built-distribution-1/enso-engine-2025.3.1-dev-linux-amd64/enso-2025.3.1-dev/bin/enso pnpm run dev:gui

Electron app

If you want to enable new project management logic in Electron, you have to manually edit the local storage and enable the feature flag: enableProjectService: true (run the app with --debug.dev-tools cli option)

Then set the ENSO_RUNNER_PATH environment variable and re-run the app (you can add --no-server flag to ensure no project manager process running)

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated, if necessary.
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Scala,
Java,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
Unit tests have been written where possible.
If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
or the Snowflake database integration, a run of the Extra Tests has been scheduled.
- If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

app/gui/src/dashboard/services/ProjectManager/ProjectManager.ts

farmaazon

My a bit delayed twopenny:

farmaazon · 2025-09-19T10:19:02Z

app/gui/src/dashboard/services/ProjectManager/ProjectManager.ts

+    // This is a Vue function, not a React hook, so the React hooks rule doesn't apply
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const enableProjectService = useFeatureFlag('enableProjectService')
+    if (!enableProjectService.value) {
+      this.socketPromise = this.reconnect()
+    }


You don't make use of Vue reactivity here, so you may just add getFeatureFlag method there with body:

return flagsStore.getState().featureFlags[key]

Also, one thing looks strange: we reconnect only when ProjectService is not enabled? I thought it should be the other way round...

I see, there's some confusion in the naming. The new logic is called ProjectService because there is a ProjectService.scala which I ported to TypeScript. In other words, the project service is the new logic in dashboard and the project manager is the old java process

app/gui/src/dashboard/services/ProjectManager/ProjectManager.ts

app/gui/project-manager-shim-middleware/index.ts

farmaazon · 2025-09-19T10:31:31Z

.github/workflows/gui-checks.yml

+      - name: 📥 Download Enso Engine
+        continue-on-error: true
+        working-directory: app/project-manager-shim
+        run: pnpm run download-engine
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+


Is this a check if we're able to download engine, or we need to download engine for one of these checks?

We need the enso executable to run the ProjectService.test.ts test suite

farmaazon · 2025-09-19T10:37:39Z

app/project-manager-shim/src/projectService/ensoRunner.ts

+    // Check if the project is already running
+    const runningProject = this.runningProjects.get(projectId)
+    if (runningProject) {
+      // Return the existing language server sockets
+      return runningProject.sockets
+    }
+
+    // Generate a random root ID for this language server session
+    const rootId = crypto.randomUUID()
+
+    // Find available ports for the language server
+    const jsonPort = await this.findAvailablePort(DEFAULT_JSONRPC_PORT)


What if runningProject changes while we're searching for available port, or stuck at any other await in this function?

JaroslavTulach · 2025-09-22T08:28:18Z

@4e6, please update https://github.com/enso-org/enso/blob/develop/docs/CONTRIBUTING.md#running-ide with the new recommended steps.

app/ide-desktop/client/src/server.ts

app/gui/src/dashboard/services/ProjectManager/ProjectManager.ts

somebody1234

CR ✅

4e6 self-assigned this Sep 11, 2025

4e6 added the CI: No changelog needed Do not require a changelog entry for this PR. label Sep 11, 2025

somebody1234 reviewed Sep 12, 2025

View reviewed changes

app/gui/src/dashboard/services/ProjectManager/ProjectManager.ts Show resolved Hide resolved

Akirathan mentioned this pull request Sep 16, 2025

Cannot create new local project #13957

Closed

2 tasks

4e6 force-pushed the wip/db/13891-dashboard-projects-open-close branch from 586865b to cb8fbd0 Compare September 16, 2025 16:21

4e6 added 14 commits September 16, 2025 17:21

DRAFT: openProject

7bf196f

DRAFT: deleteProject

610ca97

update: use UUID

b843942

add: duplicate project

84907be

add: download engine script

f8f8db9

fix: lint

d8dbc8b

fix: format

1afec1f

update: set runner env variable

4b203da

fix: unit tests

786bd8f

update: download release

235d92f

update: simplify download logic

ea87127

DRAFT: renameProject

f5a3fed

update: rename runnging project

cb8fbd0

misc: format

468a1b9

4e6 marked this pull request as ready for review September 16, 2025 19:12

4e6 requested review from Frizi, farmaazon, vitvakatu, kazcw, AdRiley, PabloBuchu, indiv0, jdunkerley and hubertp as code owners September 16, 2025 19:12

update: extract zip

94220cc

4e6 added 6 commits September 17, 2025 10:03

update: find enso.bat

7b10100

update: comment lints

4f1804f

update: lazy project manager connection

2c78488

misc: missing comment

b2ebab5

misc: open project

875dccd

refactor: project manager shim handlers

41d2539

farmaazon reviewed Sep 19, 2025

View reviewed changes

4e6 added 5 commits September 19, 2025 12:25

add: project service handler

8e2bebd

misc: cleanup

c060712

test: open two projects

75913a9

Merge branch 'develop' into wip/db/13891-dashboard-projects-open-close

a2ea49d

fix: after merge

d1a79ba

somebody1234 reviewed Sep 22, 2025

View reviewed changes

app/ide-desktop/client/src/server.ts Outdated Show resolved Hide resolved

somebody1234 reviewed Sep 22, 2025

View reviewed changes

app/gui/src/dashboard/services/ProjectManager/ProjectManager.ts Outdated Show resolved Hide resolved

somebody1234 approved these changes Sep 22, 2025

View reviewed changes

hubertp approved these changes Sep 24, 2025

View reviewed changes

4e6 added 2 commits September 26, 2025 08:01

misc: review comments

f800dfc

Merge branch 'develop' into wip/db/13891-dashboard-projects-open-close

c9c872e

4e6 added the CI: Ready to merge This PR is eligible for automatic merge label Sep 26, 2025

mergify bot merged commit 408d8ca into develop Sep 26, 2025
62 checks passed

mergify bot deleted the wip/db/13891-dashboard-projects-open-close branch September 26, 2025 08:03

vitvakatu mentioned this pull request Sep 28, 2025

No project is opening locally in dev-server #14072

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement functionality to open and close projects in dashboard #13994

Implement functionality to open and close projects in dashboard #13994

Uh oh!

4e6 commented Sep 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

farmaazon left a comment

Uh oh!

farmaazon Sep 19, 2025

Uh oh!

farmaazon Sep 19, 2025

Uh oh!

4e6 Sep 19, 2025

Uh oh!

Uh oh!

Uh oh!

farmaazon Sep 19, 2025

Uh oh!

4e6 Sep 19, 2025

Uh oh!

farmaazon Sep 19, 2025

Uh oh!

JaroslavTulach commented Sep 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

somebody1234 left a comment

Uh oh!

Uh oh!

Uh oh!

Implement functionality to open and close projects in dashboard #13994

Implement functionality to open and close projects in dashboard #13994

Uh oh!

Conversation

4e6 commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

Important Notes

Dev Mode

Locate enso executable

Override enso executable

Electron app

Checklist

Uh oh!

Uh oh!

farmaazon left a comment

Choose a reason for hiding this comment

Uh oh!

farmaazon Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

farmaazon Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

4e6 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

farmaazon Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

4e6 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

farmaazon Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

somebody1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

4e6 commented Sep 11, 2025 •

edited

Loading

JaroslavTulach commented Sep 22, 2025 •

edited

Loading