Support webview in dedicate container #947

vzhukovs · 2020-12-07T19:56:49Z

What does this PR do?

This changes proposal adds an ability to run extension that provides webviews in dedicate container. The problem was in resource loading mechanism, that didn't support resource loading by file service from remote containers. This changes proposal modifies webview creation step by providing custom scheme: file-sidecar-${machineName} instead of default file for vscode-resource or theia-resource resources.

Depends on:

Signed-off-by: Vladyslav Zhukovskyi vzhukovs@redhat.com

Screenshot/screencast of this PR

Provided steps to test.

What issues does this PR fix or reference?

eclipse-che/che#16870

How to test this PR?

Create workspace from workspace.yaml
It will open a workspace with dedicate extension: didact
Open a didact sample
Webview should be displayed the same as it was run in the same container with Theia.

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Happy Path Channel

HAPPY_PATH_CHANNEL=stable

dmytro-ndp · 2020-12-09T07:12:30Z

[crw-ci-test --rebuild]

che-bot · 2020-12-09T07:44:00Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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-12-09T11:43:14Z

extensions/eclipse-che-theia-plugin-remote/src/node/webviews-content-aware.ts

+
+export class RemoteWebview extends WebviewImpl {}
+
+export class WebviewsContentAware {


Probably will need to spend some times on bringing DI in upstream for the plug-in host

I tried to digg into this thing and from what I saw, this requires some refactoring in plugin initializing mechanism. Am I right?

eclipse-theia/theia#5761

benoitf · 2020-12-09T11:46:53Z

extensions/eclipse-che-theia-plugin-remote/src/node/webviews-content-aware.ts

+  }
+
+  // Browser part perform preprocess initial html content by replacing vscode-resource:/path/to/file
+  // to https://authority/webview/theia-resource/file/path/to/file. To be able to operate with custom


we can't for example just patch webview/normalizeRequestUri https://github.com/eclipse-theia/theia/blob/fd0a8ce093273011ecf4500d673a982854af9e55/packages/plugin-ext/src/main/browser/webview/webview.ts ?

I tried this solution, but it seems, that this won't work. The problem is extending the WebviewWidget won't get a proper effect, because this code is run on browser part on Theia sidecar and we need to provide the container name from environment variable on the sidecar from plugin.

I tried this solution, but it seems, that this won't work.

sorry @vzhukovs but it's not clear to me if
you think that this will not work OR you have tried and this didn't work
Could you please clarify it? 🙂

I've tried. The main problem here is that rebound class will be executing on Theia's container where we don't have any sidecar specific information. As far as rebound class will execute from the browser part we also don't have ability to get environment information. So it better to intercept this method's calls from server side on sidecar directly:

VS Code extension (sidecar server side) > Method intercept and link modification (sidecar server side) > Plugin Ext (sidecar server side > theia browser side) > Theia (theia browser side).

we can't only rebind only in sidecar usecase ?

From what I saw, I couldn't get this worked

azatsarynnyy

My browser's console is cluttered with tons of output like this one:

I guess that was needed for debugging purposes. Can we disable it?

azatsarynnyy

Everything works perfectly with a brand new Workapce. But after refreshing the page, the test plug-in is failed to start:

azatsarynnyy · 2020-12-10T08:14:43Z

[crw-ci-test --rebuild]

che-bot · 2020-12-10T10:31:48Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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.

vzhukovs · 2020-12-14T10:07:51Z

My browser's console is cluttered with tons of output like this one:

I guess that was needed for debugging purposes. Can we disable it?

The image that provided in how to test section is conjunction of #946, eclipse-theia/theia#8832 and eclipse-theia/theia#8833 code base. So additional console output is might be in case. But this PR doesn't have additional console output logs. It was done just for the debug purposes.

vzhukovs · 2020-12-14T10:08:08Z

Everything works perfectly with a brand new Workapce. But after refreshing the page, the test plug-in is failed to start:

Checking it now.

azatsarynnyy · 2020-12-15T10:27:01Z

Everything works perfectly with a brand new Workapce. But after refreshing the page, the test plug-in is failed to start:

Checking it now.

@vzhukovs I'm able to reproduce the error constantly on Hosted Che with the Devfile you provided in How to test this PR? section:

azatsarynnyy · 2020-12-17T15:38:29Z

Everything works perfectly with a brand new Workapce. But after refreshing the page, the test plug-in is failed to start:

It's not related to the PR changes. The same error is present in master branch.
@vzhukovs will you file a corresponding issue as we've discussed it offline?

azatsarynnyy

I've tested it according to the provided How to test steps.
I was able to get the Didact tutorial rendered correctly, which is based on a Webview from a separate sidecar.

che-bot · 2020-12-20T22:35:13Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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.

Signed-off-by: Vladyslav Zhukovskyi <vzhukovs@redhat.com>

che-bot · 2020-12-21T00:26:11Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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.

vzhukovs added kind/bug Something isn't working severity/P1 labels Dec 7, 2020

vzhukovs requested review from benoitf, azatsarynnyy and RomanNikitenko December 7, 2020 19:56

vzhukovs self-assigned this Dec 7, 2020

eclipse-che deleted a comment from che-bot Dec 9, 2020

benoitf reviewed Dec 9, 2020

View reviewed changes

This was referenced Dec 9, 2020

Editors Sprint 194/195 eclipse-che/che#18568

Closed

Che-Theia build is failed sporadically within the HappyPath test jobs eclipse-che/che#18575

Closed

azatsarynnyy reviewed Dec 9, 2020

View reviewed changes

eclipse-che deleted a comment from che-bot Dec 10, 2020

azatsarynnyy approved these changes Dec 17, 2020

View reviewed changes

Support webview in dedicate container

c848d28

Signed-off-by: Vladyslav Zhukovskyi <vzhukovs@redhat.com>

vzhukovs force-pushed the che#16870 branch from 276b27c to c848d28 Compare December 20, 2020 23:53

vzhukovs merged commit 0e97886 into master Dec 21, 2020

vzhukovs deleted the che#16870 branch December 21, 2020 00:26

azatsarynnyy mentioned this pull request Dec 21, 2020

Che Theia Web View doesn't work properly when a plugin is running in its own sidecar eclipse-che/che#16870

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support webview in dedicate container #947

Support webview in dedicate container #947

vzhukovs commented Dec 7, 2020

dmytro-ndp commented Dec 9, 2020

che-bot commented Dec 9, 2020

benoitf Dec 9, 2020

vzhukovs Dec 14, 2020

azatsarynnyy Dec 18, 2020

benoitf Dec 9, 2020 •

edited

Loading

vzhukovs Dec 14, 2020

azatsarynnyy Dec 18, 2020

vzhukovs Dec 18, 2020

benoitf Dec 18, 2020

vzhukovs Dec 21, 2020

azatsarynnyy left a comment

azatsarynnyy left a comment

azatsarynnyy commented Dec 10, 2020

che-bot commented Dec 10, 2020

vzhukovs commented Dec 14, 2020

vzhukovs commented Dec 14, 2020

azatsarynnyy commented Dec 15, 2020

azatsarynnyy commented Dec 17, 2020

azatsarynnyy left a comment

che-bot commented Dec 20, 2020

che-bot commented Dec 21, 2020


		export class RemoteWebview extends WebviewImpl {}

		export class WebviewsContentAware {

Support webview in dedicate container #947

Support webview in dedicate container #947

Conversation

vzhukovs commented Dec 7, 2020

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

Happy Path Channel

dmytro-ndp commented Dec 9, 2020

che-bot commented Dec 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benoitf Dec 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azatsarynnyy left a comment

Choose a reason for hiding this comment

azatsarynnyy left a comment

Choose a reason for hiding this comment

azatsarynnyy commented Dec 10, 2020

che-bot commented Dec 10, 2020

vzhukovs commented Dec 14, 2020

vzhukovs commented Dec 14, 2020

azatsarynnyy commented Dec 15, 2020

azatsarynnyy commented Dec 17, 2020

azatsarynnyy left a comment

Choose a reason for hiding this comment

che-bot commented Dec 20, 2020

che-bot commented Dec 21, 2020

benoitf Dec 9, 2020 •

edited

Loading