Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce Plug-in System #2007

Merged
merged 40 commits into from
Jun 20, 2018
Merged

Introduce Plug-in System #2007

merged 40 commits into from
Jun 20, 2018

Conversation

benoitf
Copy link
Contributor

@benoitf benoitf commented May 31, 2018

This PR brings a new way to extend Theia by using plugins (in addition to extension)

The plugin model is having (compared to Extension) :

  • code runtime isolation (separated node instance or in a web worker)
  • self-contained (no need to download external dependencies)
  • no dependency requirement (like inversify) except the dependency to the API type. @theia/plugin
  • no need to rebuild the IDE
  • simple API with a single entrypoint (theia object)
  • lifecycle with a start and stop method

More details on the original issue: #1482

Documentation on the API is provided

There are still missing API but it will come as enhancements to the current model.

Here is a quick video on youtube (click on the image)
Plugin in a running Che

Please feel to add any reviewer to review the PR.

@benoitf benoitf added the plug-in system issues related to the plug-in system label May 31, 2018
@benoitf benoitf requested review from svenefftinge and akosyakov May 31, 2018 14:53
@akosyakov
Copy link
Member

Impressive work!

What are reasons/benefits of:

@benoitf
Copy link
Contributor Author

benoitf commented Jun 18, 2018

@akosyakov
1.
on the travis file, it was to publish it on a different scope to try it. But this commit is flagged as TO BE DELETED before the merge. So of course, we won't merge any travis change at all (or appveyor or any other)

  1. On code organization rule, it was to enforce a clear separation on what will be used in "forked" instance to the remaining one (by default on the linked document, the code is either on browser or or node but never in a forked instance

On custom RCP-Protocol, you mean by using vscode-jsonrpc one ? (I tried to search because I was almost sure we already discussed that point but I didn't find the content online) But if I remember well we said we could postpone that RPC rewrite a bit later.

@akosyakov
Copy link
Member

@benoitf ok, could you adjust commits and i will have a look once more?

@benoitf
Copy link
Contributor Author

benoitf commented Jun 18, 2018

@akosyakov you think we can reach merging state soon ? (if I adjust commits to get rid of .Travis CI changes)

@akosyakov
Copy link
Member

akosyakov commented Jun 18, 2018 •
edited
Loading

@benoitf if it does not break any existing code i am fine to merge it that you can continue on master. The package structure, rewriting RPC and any other issues can be improved with follow-up PRs.

AlexTugarev
AlexTugarev reviewed Jun 18, 2018
View reviewed changes
packages/plugin-ext/src/common/editor-options.ts Outdated
/**
* The style in which the editor's cursor should be rendered.
*/
export enum TextEditorCursorStyle {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it's copied from vscode. If so, please attribute with MIT license in the header.

@benoitf
Copy link
Contributor Author

benoitf commented Jun 18, 2018

@akosyakov ok rebased and removing travis ci commits

@akosyakov
Copy link
Member

@benoitf it seems that not all commits are signed off

evidolob and others added 14 commits June 19, 2018 11:13
@evidolob @benoitf
POC of the new Plug-in System
a3595b6 
Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>
@benoitf
Cleanup the code, registerPlugin being handled differently now
b5e366d 
Also move to dev dependencies the core package so plugin's won't have transitive dependencies to core

Change-Id: I2b08265ba411fdf561d52b822dde3c517622a3f3
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
Remove main entry from the module: there is no export from this modul…
07757fe 
…e, Linking is performed dynamically by providing '@theia/plugin' object on the fly

Only the module declaration should be exported in package.json
-> So we provide a node cache entry of '@theia/plugin' on the fly

Change-Id: I3af8883122c2d0ecfad94c69c1eaf15cb94a0071
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
Add alias for plugin package
d553999 
Change-Id: I5288617ebdf93469d33fe0e1508919ea137657d5
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@evidolob @benoitf
eclipse-che/che#9286 introduce quick pick api
42620dd 
Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>
@benoitf
Add test file to enable tests
501759d 
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@akurinnoy @benoitf
Theia plugin metadata (#1)
57bdceb 
this PR implements
- retrieving metadata from plugins and using the metadata for plugin activation and deactivation;
- pluggability, which allows extending the plugin system to run different types of plugins.

Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@mmorhun @benoitf
Add Hosted Plugin Manager
0ea0c90 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@benoitf
split plugin module in two : one module for API, one module for the e…
c26a493 
…xtension

Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@mmorhun @benoitf
Handle blocking of opening of new tab
25eb1b1 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@benoitf
Split hosted and main part in two folders (#7)
a735801 
* Split hosted and main part in two folders
also make CI green again
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@evidolob @benoitf
move some files related to plugin API implementation to 'plugin' folder
b1c9b8d 
Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>
@benoitf
Fix code based on upstream changes
738e6f0 
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
Sync with upstream
a2e0db2 
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
benoitf and others added 24 commits June 19, 2018 11:16
@benoitf
Handle the deployment with deployers (#11)
50a9ed7 
* Handle the deployment with deployers

ENV THEIA_PLUGINS can be set for example to
local-dir:/Users/benoitf/theia-plugins

to deploy all plugins from this directory at startup

Also add widget view and some vscode handlers

Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
Split vscode into a new module
c92853d 
allow to override more stuff on init and load steps

Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@mmorhun @benoitf
Make HostedPluginUriPostProcessor symbol global (#15)
77cd3d7 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@mmorhun @benoitf
Add dev dependency to @theia/plugin module from @theia/plugin-ext (#16)
13d8a0c 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@mmorhun @benoitf
Moves @theia/plugin dependency from dev to main
8cb59d9 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@benoitf
Add support for plugins hosted on github repository in releases secti…
4443d59 
…on (#17)

Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
Add support for vscode:extension/ resolver and http(s):// resolver (#19)
f1004f1 
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@mmorhun @benoitf
Use process tree to shutdown Theia instance (#10)
44a46a9 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@mmorhun @benoitf
Add window state API (#21)
c3fd269 
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@benoitf
Introduce a command to deploy on the fly a plugin into Theia (#22)
9b5432c 
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@olexii4 @benoitf
CHE-9494 add the status bar API
40e0148 
Signed-off-by: Oleksii Orel <oorel@redhat.com>
@olexii4 @benoitf
fix dependency
3f94e8e 
Signed-off-by: Oleksii Orel <oorel@redhat.com>
@olexii4 @benoitf
code cleanup
e639dd4 
Signed-off-by: Oleksii Orel <oorel@redhat.com>
@benoitf
avoid Shadowed variable
7b90da6 
Change-Id: I956a52b82ed3374062942f9aebaa203614cc6a25
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
merge with upstream changes with maxListener on events
612b21a 
Change-Id: I22313a01998bb965152db0385f6adcd96e3998ae
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
UI for manage Theia development mode (#13)
d0ca188 
* UI for development mode

* Code improvements

Signed-off-by: Vitaliy Gulyy <vguliy@codenvy.com>
@mmorhun @benoitf
Add dialog window to ask user if opening of a new tab is blocked by b…
823b1e4 
…rowser (#26)

Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@benoitf
Fix problem with stopping instance of hosted plugin (#27)
6d059a8 
Signed-off-by: Vitaliy Gulyy <vguliy@codenvy.com>
@evidolob @benoitf
eclipse-che/che#9434 implement all editor objects (#28)
df13fb7 
Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>
@benoitf
Update to 0.3.11 version
d5edd8b 
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@mmorhun @benoitf
CHE-9845: Introduce new namespace for current environment in Plugins …
d1ec795 
…APi (#29)

Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
@akurinnoy @benoitf
Add Preference API (#30)
9af4333 
* implement Preference API

Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
@evidolob @benoitf
Add editor life cycle methods: open, save and close (#31)
ad0f594 
eclipse-che/che#9435 add editor life cycle methods: open, save and close

Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>
@olexii4 @benoitf
CHE-9836 add output channel API (#32)
b9a2ee8 
Signed-off-by: Oleksii Orel <oorel@redhat.com>
@benoitf
Copy link
Contributor Author

benoitf commented Jun 19, 2018

@akosyakov now DCO Sign-off is ok
appveyor build is failing due to the API rate limit

Downloading ripgrep failed: Error: API rate limit exceeded for 67.225.139.144. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

@benoitf
Copy link
Contributor Author

benoitf commented Jun 19, 2018

@akosyakov now, is it ok for you as well ?

akosyakov
akosyakov approved these changes Jun 20, 2018
View reviewed changes
Copy link
Member

@akosyakov akosyakov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

@benoitf benoitf merged commit 6eb6065 into eclipse-theia:master Jun 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexTugarev AlexTugarev AlexTugarev left review comments

@akosyakov akosyakov akosyakov approved these changes

@svenefftinge svenefftinge svenefftinge approved these changes

Assignees
No one assigned
Labels
plug-in system issues related to the plug-in system
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@benoitf @akosyakov @svenefftinge @AlexTugarev @evidolob @akurinnoy @mmorhun @olexii4