Open Che workspace with multiple workspace root #778

benoitf · 2020-06-23T13:55:19Z

What does this PR do?

Handle multiple workspace roots
Checks if there is a che.theia-workspace file.
if there is one, returns that file as being a workspace root
if none, generate the file by getting all clonedPath/path of the devfile projects

enhancements:

make it optional for now (like if there is a special attribute in devfile, use that mode)
track new folders in /projects and add them to the che.theia-workspace file automatically (and if we delete folders)
allow to customize/provide different projects to be added in workspace root. Could be useful for a maven project to see only sub-folders/modules

I think we could resolve those items ^^ in a separate issue: by default a workspace starts in OFF multi-root mode - so no breaking changes for the master branch

The current state of the PR - a workspace starts in OFF multi-root mode - so the behavior should be exactly as for master branch.
A user should add the following section to a devfile to turn on multi-root mode:

attributes:
 multiRoot: 'on'

Please let me know if you have a better idea for the attribute and value as marker for multi-root mode - it's easy to change on the current step.

Change-Id: Idfb9370dc503bcfb5504ba37446f7f1ab171b515
Signed-off-by: Florent Benoit fbenoit@redhat.com

What issues does this PR fix or reference?

eclipse-che/che#17212

TODO

Try it with two go projects, one with go modules, another without:
http://che.openshift.io/f/?url=https://gist.githubusercontent.com/benoitf/57ffa7e39e2e16a6a2f6756a44693e43/raw/5afea100c012fe05e325358f0a58577821a3cb99/golang-example.devfile.yaml

Happy Path Channel

HAPPY_PATH_CHANNEL=next

tsmaeder · 2020-06-29T12:40:01Z

I think an approach that computes the workspace roots at the same time as doing the cloning would make it easier keeping projects and workspace roots in sync as we evolve the code. We can also make sure language servers are not seeing half-cloned projects that way. #408 implements that approach and also cleans up the UI a bit. I would recommend we base our work on that PR.

sunix · 2020-08-10T12:10:14Z

From what i see in the exemple, it's only possible to define one workspace root per project.
But in some usecase, we would like to be able to use 1+ roots in subfolders (a maven project + nodejs) of the same git project)
What about that proposal:
eclipse-che/che#15347 (comment)

Also why adding a intermediate file? che.theia-workspace file

benoitf · 2020-08-10T12:13:05Z

@sunix: not yet as it requires a new devfile format

Also why adding a intermediate file? che.theia-workspace file

to make it persistent across workspace restart.

sunix · 2020-08-10T12:18:05Z

to make it persistent across workspace restart.

Ok, I feel like this is all temporary ... waiting for a new devfile format. What are the next steps?

RomanNikitenko · 2020-10-09T10:53:09Z

Faced with the issue related to cloning a project, investigating...

benoitf · 2020-10-09T11:04:07Z

@RomanNikitenko looks like it was related to my hack "commit"

RomanNikitenko · 2020-10-09T11:18:22Z

@benoitf
hack "commit" was on task plugin side (if i'm not mistaken)
current problem is related to cloning
but probably removing the commit somehow broke the behavior...

it's also strange for me because yesterday I tested after removing the commit using my another devfile with theia and che-theia projects and it worked well
today I took a devfile from happy path tests and faced with the issue...

benoitf · 2020-10-09T11:20:43Z

@RomanNikitenko as you've a launch.json in the workspace root folder, theia try to clone project but it can't as there is already some files there

RomanNikitenko · 2020-10-27T11:53:56Z

I think an approach that computes the workspace roots at the same time as doing the cloning would make it easier keeping projects and workspace roots in sync as we evolve the code. We can also make sure language servers are not seeing half-cloned projects that way. #408 implements that approach and also cleans up the UI a bit. I would recommend we base our work on that PR.

@tsmaeder
I tried to apply your idea, so adding a workspace folder directly after cloning a project.
I'm worried about the behavior related to project tree with this approach.
You have not yet added a folder to the workspace message and Add Folder button is displayed while a project is cloning.
Sure in the right bottom area the notification about cloning project process is displayed at the same time.
But I guess the behavior can confuse an user, especially for case of slow connection or a big project.

tsmaeder · 2020-10-27T13:10:54Z

@RomanNikitenko I agree this can be confusing when there is a long wait before cloning starts. A couple of ideas:

Unbind the UI that shows the "Open Workspace" button.
Maybe open some (closable) modal UI at startup that tells the user cloning will start shortly?

RomanNikitenko · 2020-10-27T15:14:40Z

@tsmaeder

I agree this can be confusing when there is a long wait before cloning starts.

To clarify: in my implementation a workspace folder is added when cloning is completed, because you mentioned that:

We can also make sure language servers are not seeing half-cloned projects that way.

tsmaeder · 2020-10-27T15:22:03Z

To clarify: in my implementation a workspace folder is added when cloning is completed, because you mentioned that:

I understand that...but when the user sees that projects are being added, she knows something is going on; when the IDE just sits there, it's much worse.

RomanNikitenko · 2020-10-27T15:32:10Z

I understand that...but when the user sees that projects are being added, she knows something is going on; when the IDE just sits there, it's much worse.

I agree. I just highlighted some details in my previous comment to be sure that we speak about the same things.

azatsarynnyy · 2020-10-28T11:19:43Z

Let's try the solution we've agreed on during our standup call, yesterday.
Customize the Explorer in Che Theia to get rid of the existing text + button and display some progress instead, while cloning.

To not spend much time creating something new, we can try to reuse the existing progress indicator - this fast-moving line for example:

... and some text, e.g. Cloning the sources...

RomanNikitenko · 2020-11-12T10:52:28Z

I aligned the corresponding plugin API of Theia with VS Code and provided the ability to display progress for views from plugin side, so now we can improve the behavior described here and apply this approach

che-bot · 2020-11-19T07:29:49Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:778
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:778

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

RomanNikitenko · 2020-11-19T08:19:51Z

[crw-ci-test]

che-bot · 2020-11-19T08:33:43Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:778
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:778

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

benoitf · 2020-11-19T09:01:21Z

[crw-ci-test]

che-bot · 2021-02-18T16:06:28Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:778
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:778

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

che-bot · 2021-02-18T19:10:40Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:778
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:778

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

azatsarynnyy

After several rounds of testing, I don't see any issues anymore.
I think it's ready now and all other enhancements we could make in further iterations.

RomanNikitenko · 2021-02-19T12:56:23Z

I have rebased the branch and added the handling of /home/theia-dev case according to #778 (comment)

@tsmaeder
please take a look at the changes ecbb10b

thanks in advance!

che-bot · 2021-02-19T14:14:32Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:778
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:778

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

benoitf · 2021-02-19T14:48:19Z

I can't approve the PR as I created it :-)

azatsarynnyy · 2021-02-19T15:00:02Z

I can't approve the PR as I created it :-)

@benoitf We'll take this ^ as your approvement 😄

…ts (or what has been configured as ROOT folder) Checks if there is a che.theia-workspace file. if there is one, returns that file as being a workspace root if none, generate the file by getting all clonedPath/path of the devfile projects enhancements: 1. make it optional for now (like if there is a special attribute in devfile, use that mode) 2. track new folders in /projects and add them to the che.theia-workspace file automatically (and if we delete folders) 3. allow to customize/provide different projects to be added in workspace root. Could be useful for a maven project to see only sub-folders/modules Change-Id: Idfb9370dc503bcfb5504ba37446f7f1ab171b515 Signed-off-by: Florent Benoit <fbenoit@redhat.com>

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

…file level Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

RomanNikitenko · 2021-02-24T15:14:22Z

I have resolved the conflicts (the changes for some files were too close to the merged recently PR) and rebased my branch.
I'm going to merge the changes tomorrow morning if there are no objections and the tests are happy.

codecov · 2021-02-24T15:18:22Z

Codecov Report

Merging #778 (dee2d73) into master (4e9f582) will decrease coverage by 1.63%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master     #778      +/-   ##
==========================================
- Coverage   58.02%   56.38%   -1.64%     
==========================================
  Files          46       47       +1     
  Lines        2032     2091      +59     
  Branches      333      345      +12     
==========================================
  Hits         1179     1179              
- Misses        843      900      +57     
- Partials       10       12       +2

Impacted Files	Coverage Δ
plugins/workspace-plugin/src/theia-commands.ts	`0.00% <0.00%> (ø)`
...s/workspace-plugin/src/workspace-folder-updater.ts	`0.00% <0.00%> (ø)`
...workspace-plugin/src/workspace-projects-manager.ts	`0.00% <0.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4e9f582...dee2d73. Read the comment docs.

che-bot · 2021-02-24T15:46:32Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:778
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:778

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

benoitf changed the title ~~Handle multiple workspace root~~ Open Che workspace with multiple workspace root Jun 23, 2020

This comment has been minimized.

Sign in to view

benoitf mentioned this pull request Aug 10, 2020

WIP Make Che use multi root workspaces by default #408

Closed

RomanNikitenko force-pushed the devfile-workspace-root branch from de2de5a to 0e2b132 Compare October 7, 2020 11:46

This comment has been minimized.

Sign in to view

RomanNikitenko force-pushed the devfile-workspace-root branch from 0e2b132 to 23712a2 Compare October 8, 2020 13:39

This comment has been minimized.

Sign in to view

azatsarynnyy mentioned this pull request Nov 2, 2020

Editors Sprint 192 eclipse-che/che#18257

Closed

16 tasks

azatsarynnyy mentioned this pull request Nov 18, 2020

Editors Sprint 193 eclipse-che/che#18403

Closed

15 tasks

RomanNikitenko force-pushed the devfile-workspace-root branch from b969cdc to aced978 Compare November 19, 2020 07:05

This comment has been minimized.

Sign in to view

RomanNikitenko force-pushed the devfile-workspace-root branch from f08c3ea to 62bab14 Compare February 18, 2021 14:58

This comment has been minimized.

Sign in to view

RomanNikitenko force-pushed the devfile-workspace-root branch from 62bab14 to ed974ab Compare February 18, 2021 15:25

RomanNikitenko force-pushed the devfile-workspace-root branch from ed974ab to 39499e2 Compare February 18, 2021 18:32

azatsarynnyy approved these changes Feb 18, 2021

View reviewed changes

RomanNikitenko mentioned this pull request Feb 18, 2021

Multi-root: workspace folders auto detection eclipse-che/che#19101

Closed

RomanNikitenko force-pushed the devfile-workspace-root branch from 39499e2 to 2b27dfe Compare February 19, 2021 12:45

benoitf and others added 10 commits February 24, 2021 17:07

Replace CheApiService by WorkspaceService

0f38c80

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Add project as a workspace folder when the project has cloned

cf6fbf9

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Ensure config storage directories exist

b87256b

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Ensure workspace folder creation when a project is imported

a0f24fc

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Add workspace folders in turn

24d9418

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Use 'onDidChangeWorkspaceFolders' event to handle readme files

7f6ffdf

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Fix: file watcher should fire an event at launch.json file creation

9659215

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Fix 'Open Configurations' and 'Add configuration' actions

058aaad

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

An ability to switch (turn on and turn off ) multi-root mode on a dev…

dee2d73

…file level Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

RomanNikitenko force-pushed the devfile-workspace-root branch from 2b27dfe to dee2d73 Compare February 24, 2021 15:08

RomanNikitenko merged commit 0fc5809 into eclipse-che:master Feb 25, 2021

che-bot added this to the 7.27 milestone Feb 25, 2021

Open Che workspace with multiple workspace root #778

Open Che workspace with multiple workspace root #778

Conversation

benoitf commented Jun 23, 2020 • edited by RomanNikitenko Loading

What does this PR do?

What issues does this PR fix or reference?

TODO

Happy Path Channel

This comment has been minimized.

tsmaeder commented Jun 29, 2020

sunix commented Aug 10, 2020 • edited Loading

benoitf commented Aug 10, 2020

sunix commented Aug 10, 2020

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

RomanNikitenko commented Oct 9, 2020

benoitf commented Oct 9, 2020

RomanNikitenko commented Oct 9, 2020

benoitf commented Oct 9, 2020

RomanNikitenko commented Oct 27, 2020

tsmaeder commented Oct 27, 2020

RomanNikitenko commented Oct 27, 2020

tsmaeder commented Oct 27, 2020

RomanNikitenko commented Oct 27, 2020

azatsarynnyy commented Oct 28, 2020

RomanNikitenko commented Nov 12, 2020

che-bot commented Nov 19, 2020

RomanNikitenko commented Nov 19, 2020

che-bot commented Nov 19, 2020

benoitf commented Nov 19, 2020

This comment has been minimized.

This comment has been minimized.

che-bot commented Feb 18, 2021

che-bot commented Feb 18, 2021

azatsarynnyy left a comment

Choose a reason for hiding this comment

RomanNikitenko commented Feb 19, 2021

che-bot commented Feb 19, 2021

benoitf commented Feb 19, 2021

azatsarynnyy commented Feb 19, 2021

RomanNikitenko commented Feb 24, 2021 • edited Loading

codecov bot commented Feb 24, 2021 • edited Loading

Codecov Report

che-bot commented Feb 24, 2021

benoitf commented Jun 23, 2020 •

edited by RomanNikitenko

Loading

sunix commented Aug 10, 2020 •

edited

Loading

RomanNikitenko commented Feb 24, 2021 •

edited

Loading

codecov bot commented Feb 24, 2021 •

edited

Loading