feat(namespace): Export @eclipse-che/plugin namespace using VS Code extension mechanism #994

benoitf · 2021-02-15T15:49:34Z

What does this PR do?

Export @eclipse-che/plugin namespace through export of VS Code extension export API

clients could lookup getExtension('@eclipse-che.ext-plugin') to grab this namespace

Screenshot/screencast of this PR

oxrKWYn0wV.mp4

What issues does this PR fix or reference?

eclipse-che/che#18837

How to test this PR?

Write an example using getExtension('@eclipse-che/ext-plugin') and then for example grab workspace details.
I've created a vscode extension doing this job

const eclipseCheExtPlugin = vscode.extensions.getExtension('@eclipse-che.ext-plugin');
if (eclipseCheExtPlugin) {
  // grab user
  const user = await eclipseCheExtPlugin.exports.user.getCurrentUser();
 vscode.window.showInformationMessage(`Eclipse Che user information: id ${user.id} with name ${user.name}`);
} else {
  vscode.window.showWarningMessage('Not running inside che, not displaying any che user information');
}

Here to try this VS Code extensionon che.openshift.io
https://che.openshift.io/f?url=https://gist.githubusercontent.com/benoitf/b646af9e1cb9aacc23e3e588e413af47/raw/1f42b0a67bc40ed927a4215e26252fc12c9a3e58/devfile.yaml

or workspaces.openshift.com
https://workspaces.openshift.com/f?url=https://gist.githubusercontent.com/benoitf/b646af9e1cb9aacc23e3e588e413af47/raw/1f42b0a67bc40ed927a4215e26252fc12c9a3e58/devfile.yaml

bring the command palette and search for a Test command

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=next

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

che-bot · 2021-02-15T16:20:01Z

❌ E2E Happy path tests failed ❗

See Details

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

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.

tsmaeder · 2021-02-16T08:25:35Z

Why would a plugin using that namespace not simply require the namespace at compilation time?

benoitf · 2021-02-16T08:33:58Z

@tsmaeder because it's not only 'compilation time'

tsmaeder · 2021-02-16T10:33:19Z

@benoitf I still don't get it. Can you give an example?

benoitf · 2021-02-16T13:34:55Z

@tsmaeder example is given in the attached issue.

fbricon · 2021-02-16T16:28:12Z

When testing this solution, I was able to properly identify Che user with the exposed API, for telemetry purposes

azatsarynnyy

I've tested it with the provided example. Everything works as described. 👍

azatsarynnyy · 2021-02-16T18:43:05Z

plugins/workspace-plugin/package.json

@@ -18,6 +18,9 @@
    "@theia/plugin": "next",
    "@theia/plugin-packager": "latest"
  },
+  "extensionDependencies": [


Sorry, I didn't get why the Workspace Plug-in has to depend on it?
Could you please elaborate a bit?

If it's just for bootstrapping, isn't the * activation event enough?

It's to make sure that it's loaded as first plug-ins because there is no concept of optional dependency in VScode api

plugins/ext-plugin/README.md

azatsarynnyy · 2021-02-16T18:53:53Z

che-theia-init-sources.yml

@@ -22,6 +22,7 @@ sources:
    - extensions/eclipse-che-theia-remote-impl-che-server
  plugins:
    - plugins/containers-plugin
+    - plugins/ext-plugin


Maybe something more descriptive? E.g. che-api-export-plugin

The name of the folder can be as long as you want (can change it easily) but for the name of the plug-in it looks a bit too long/verbose for consumers.

Agree, it's important to have the name as short as possible here. I just forgot it's supposed to be used by the external VS Code extensions.

If you've a better short name suggestion, I can rename it

It's good. Nevermind )

tsmaeder

After inspecting the vsix provided by @fbricon I'm convinced the vsix is not properly packaged (see comment on the issue). Until we clear this up, I don't think we should merge a workaround.

azatsarynnyy

All my notes have been addressed. Thanks!

che-bot · 2021-02-17T09:20:22Z

❌ E2E Happy path tests failed ❗

See Details

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

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 · 2021-02-17T10:28:15Z

Please, see my comments on eclipse-che/che#18837 (comment)

benoitf · 2021-02-19T07:55:28Z

@tsmaeder this PR is not about fixing a bug or providing a workaround.
It's to simplify users that want to use Che API from a VS Code extension without even importing a 3rd party module.

About lacking of type checking at compilation time, while developers coming from Java world may like it, VS Code extensions may be written in javascript and not in typescript. And again we don't remove the current way of importing namespace.

It's a free will for developers, they should have the choice.

tsmaeder · 2021-02-19T09:48:27Z

@benoitf I've understood that by now: if this is a community request, I'm fine with it. Can you tell me if this is something clients requested? I was going to talk to @fbricon when he gets back on monday. My impression was he just wants "something that works".

benoitf · 2021-02-19T09:53:31Z

It's when I saw how people struggle on how to import a namespace that I added this improvement so that in a couple of seconds you have something that works immediately. Nothing to debug/understand.

See issue.

…xtension mechanism Change-Id: I4d8d6c49b6797bd98b76486127ec3e38f243e120 Signed-off-by: Florent Benoit <fbenoit@redhat.com>

codecov · 2021-02-23T17:48:21Z

Codecov Report

Merging #994 (01ff09a) into master (88ead27) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #994      +/-   ##
==========================================
+ Coverage   57.93%   58.02%   +0.08%     
==========================================
  Files          45       46       +1     
  Lines        2028     2032       +4     
  Branches      333      333              
==========================================
+ Hits         1175     1179       +4     
  Misses        843      843              
  Partials       10       10

Impacted Files	Coverage Δ
plugins/ext-plugin/src/ext-plugin.ts	`100.00% <100.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 88ead27...01ff09a. Read the comment docs.

che-bot · 2021-02-23T18:16:46Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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-23T18:16:49Z

✅ E2E Happy path tests succeed 🎉

See Details

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

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.

ericwill · 2021-02-23T20:48:47Z

Let's merge 👍

@benoitf please do us the honours

benoitf · 2021-02-24T12:27:04Z

doc PR merged, merging there.

benoitf marked this pull request as ready for review February 16, 2021 09:44

benoitf requested review from azatsarynnyy, ericwill, sunix, svor, tsmaeder, vinokurig and vitaliy-guliy as code owners February 16, 2021 09:44

azatsarynnyy reviewed Feb 16, 2021

View reviewed changes

tsmaeder previously requested changes Feb 16, 2021

View reviewed changes

benoitf force-pushed the CHE-18837 branch 2 times, most recently from 1c5d5f7 to 31b73f5 Compare February 17, 2021 08:21

azatsarynnyy approved these changes Feb 17, 2021

View reviewed changes

RomanNikitenko mentioned this pull request Feb 17, 2021

Happy path tests are failing on 'Validation of workspace build and run' step eclipse-che/che#19085

Closed

3 tasks

azatsarynnyy mentioned this pull request Feb 17, 2021

Provides @eclipse-che/plugin namespace to VS Code extensions eclipse-che/che#18837

Closed

benoitf force-pushed the CHE-18837 branch from 31b73f5 to c711368 Compare February 23, 2021 17:27

feat(namespace): Export @eclipse-che/plugin namespace using VS Code e…

01ff09a

…xtension mechanism Change-Id: I4d8d6c49b6797bd98b76486127ec3e38f243e120 Signed-off-by: Florent Benoit <fbenoit@redhat.com>

benoitf force-pushed the CHE-18837 branch from c711368 to 01ff09a Compare February 23, 2021 17:38

benoitf merged commit 4e9f582 into eclipse-che:master Feb 24, 2021

benoitf deleted the CHE-18837 branch February 24, 2021 12:27

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(namespace): Export @eclipse-che/plugin namespace using VS Code extension mechanism #994

feat(namespace): Export @eclipse-che/plugin namespace using VS Code extension mechanism #994

benoitf commented Feb 15, 2021 •

edited

Loading

che-bot commented Feb 15, 2021

tsmaeder commented Feb 16, 2021 •

edited

Loading

benoitf commented Feb 16, 2021

tsmaeder commented Feb 16, 2021

benoitf commented Feb 16, 2021

fbricon commented Feb 16, 2021

azatsarynnyy left a comment •

edited

Loading

azatsarynnyy Feb 16, 2021

benoitf Feb 16, 2021

azatsarynnyy Feb 16, 2021

benoitf Feb 16, 2021

azatsarynnyy Feb 16, 2021

benoitf Feb 16, 2021

azatsarynnyy Feb 17, 2021

tsmaeder left a comment

azatsarynnyy left a comment

che-bot commented Feb 17, 2021

azatsarynnyy commented Feb 17, 2021

benoitf commented Feb 19, 2021

tsmaeder commented Feb 19, 2021

benoitf commented Feb 19, 2021

codecov bot commented Feb 23, 2021 •

edited

Loading

che-bot commented Feb 23, 2021

che-bot commented Feb 23, 2021

ericwill commented Feb 23, 2021

benoitf commented Feb 24, 2021

feat(namespace): Export @eclipse-che/plugin namespace using VS Code extension mechanism #994

feat(namespace): Export @eclipse-che/plugin namespace using VS Code extension mechanism #994

Conversation

benoitf commented Feb 15, 2021 • edited Loading

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

che-bot commented Feb 15, 2021

tsmaeder commented Feb 16, 2021 • edited Loading

benoitf commented Feb 16, 2021

tsmaeder commented Feb 16, 2021

benoitf commented Feb 16, 2021

fbricon commented Feb 16, 2021

azatsarynnyy left a comment • edited Loading

Choose a reason for hiding this comment

azatsarynnyy Feb 16, 2021

Choose a reason for hiding this comment

benoitf Feb 16, 2021

Choose a reason for hiding this comment

azatsarynnyy Feb 16, 2021

Choose a reason for hiding this comment

benoitf Feb 16, 2021

Choose a reason for hiding this comment

azatsarynnyy Feb 16, 2021

Choose a reason for hiding this comment

benoitf Feb 16, 2021

Choose a reason for hiding this comment

azatsarynnyy Feb 17, 2021

Choose a reason for hiding this comment

tsmaeder left a comment

Choose a reason for hiding this comment

azatsarynnyy left a comment

Choose a reason for hiding this comment

che-bot commented Feb 17, 2021

azatsarynnyy commented Feb 17, 2021

benoitf commented Feb 19, 2021

tsmaeder commented Feb 19, 2021

benoitf commented Feb 19, 2021

codecov bot commented Feb 23, 2021 • edited Loading

Codecov Report

che-bot commented Feb 23, 2021

che-bot commented Feb 23, 2021

ericwill commented Feb 23, 2021

benoitf commented Feb 24, 2021

benoitf commented Feb 15, 2021 •

edited

Loading

tsmaeder commented Feb 16, 2021 •

edited

Loading

azatsarynnyy left a comment •

edited

Loading

codecov bot commented Feb 23, 2021 •

edited

Loading