Add possibility to specify reference or registry url for chePlugin/cheEditor type components #13297

mshaposhnik · 2019-05-08T14:00:56Z

This is a PR containing WS master part of adding possibility to define chePlugin/cheEditor type components using absolute reference to plugin meta or using custom registryUrl-s.

Example:

specVersion: 0.0.1
name: terminal-sample
components:
  - type: chePlugin
    reference: https://raw.githubusercontent.com/eclipse/che-plugin-registry/myplugin/meta.yaml

specVersion: 0.0.1
name: terminal-sample
components:
  - type: chePlugin
    registryUrl: https://raw.githubusercontent.com/eclipse/che-plugin-registry/master/
    id: publisher/terminal-sample/0.0.1

Fixes Introduce registryUrl field for cheEditor/chePlugin components #13104

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

metlos · 2019-05-13T08:22:59Z

...lipse/che/api/devfile/server/convert/component/editor/EditorComponentToWorkspaceApplier.java

+    if (!isNullOrEmpty(reference)) {
+      workspaceConfig.getAttributes().put(WORKSPACE_TOOLING_EDITOR_ATTRIBUTE, reference);
+    } else {
+      String compositeId = registryUrl != null ? registryUrl + "#" + editorId : editorId;


Why not make this a method of the PluginFQNParser or maybe rather PluginFQN? Could be combined with the logic of parsePluginFQN below and result in a simpler flow here.

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

...core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/devfile/Component.java

...vfile/src/main/java/org/eclipse/che/api/devfile/server/convert/DefaultEditorProvisioner.java

wsmaster/che-core-api-devfile/src/main/resources/schema/devfile.json

...e/src/test/java/org/eclipse/che/api/devfile/server/validator/DevfileSchemaValidatorTest.java

...rces/schema_test/editor_plugin_component/devfile_editor_component_with_id_and_reference.yaml

...t/resources/schema_test/editor_plugin_component/devfile_editor_component_with_reference.yaml

...-workspace/src/main/java/org/eclipse/che/api/workspace/server/wsplugins/PluginFQNParser.java

sleshchenko · 2019-05-22T11:12:44Z

@mshaposhnik Please link it with the issue you're working on

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

amisevsk

I'm becoming increasingly against our current format of using one raw string to specify 5-6 fields about a plugin (see #13414).

There will always be corner and edge cases we can't handle when we're trying to extract structure from a raw string (e.g. valid URLs with # in them) and these changes make the plugin reference spec even more arcane and difficult for users to understand.

If this PR already contains breaking changes, why not replace plugin references with json instead of strings?

{
  "registry": "https://mycustomregistry.optional",
  "id": "publisher/name/version",
  "reference": "optional direct link"
}

Is much easier to handle, and in the common case (reference to a plugin in the default registry) would simplify to what we currently have:

{"id": "publisher/name/version"}

I think we're focussed too much on sticking to non-ideal format just becuase it's what's already used.

mshaposhnik · 2019-05-27T11:19:46Z

@amisevsk We discussed your proposal and all agreed that we definitely need to try with json, but in separate issue/PR. Before that, we will also create another issue to remove outdated devfile API which stores workspaces with old properties format into DB, to minimalize amount of broken WS after we migrate to the new format.

mshaposhnik · 2019-06-05T13:02:05Z

ci-build

...ema/src/main/resources/che-schema/7.0.0-beta6.0/2__add_registry_url_to_devfile_component.sql

skabashnyuk

other looks good

metlos

LGTM. I only have a couple of minor comments.

...ace/src/main/java/org/eclipse/che/api/workspace/server/devfile/convert/DevfileConverter.java

...api/workspace/server/devfile/convert/component/plugin/PluginComponentToWorkspaceApplier.java

.../java/org/eclipse/che/api/workspace/server/devfile/convert/DefaultEditorProvisionerTest.java

...pace-shared/src/main/java/org/eclipse/che/api/workspace/shared/dto/devfile/ComponentDto.java

wsmaster/che-core-api-workspace/README-devfile.md

...-workspace/src/main/java/org/eclipse/che/api/workspace/server/wsplugins/PluginFQNParser.java

wsmaster/che-core-api-workspace/src/main/resources/schema/devfile.json

wsmaster/che-core-api-workspace/src/test/resources/.che.json

...-workspace/src/main/java/org/eclipse/che/api/workspace/server/wsplugins/PluginFQNParser.java

wsmaster/che-core-api-workspace/src/main/resources/schema/devfile.json

mshaposhnik · 2019-06-10T11:02:23Z

ci-test

wsmaster/che-core-api-workspace/src/main/resources/schema/devfile.json

sleshchenko

Great job 👍
This PR brings a really useful feature!

mshaposhnik · 2019-06-10T13:12:46Z

ci-build

che-bot · 2019-06-10T14:13:06Z

Results of automated E2E tests of Eclipse Che Multiuser on OCP:
Build details
Test report
docker image: eclipseche/che-server:13297
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

artaleks9 · 2019-06-10T14:25:22Z

Selenium tests execution on Eclipse Che Multiuser on OCP (https://ci.codenvycorp.com/job/che-pullrequests-test-ocp/1844/) doesn't show any regression against this Pull Request.

mshaposhnik added 7 commits May 3, 2019 14:49

Add registryUrl into editor/plugin components

77e53d7

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

Put reference into PluginFQN

d238e59

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

Fixes for the components with references

10b5e1b

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

Fix typo

7fb6445

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

Fix in FQN parser

337e76c

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

FQN paresr fixes

bf2e2b2

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

fixup! FQN paresr fixes

7adb88f

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

metlos reviewed May 13, 2019

View reviewed changes

Merge branch 'master' into registryUrl

9608e3d

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

sleshchenko reviewed May 22, 2019

View reviewed changes

Prefetch plugins with references

e1b5380

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

mshaposhnik mentioned this pull request May 24, 2019

WIP Make plugin references without version use 'latest' implicitly #13414

Closed

mshaposhnik added 3 commits May 24, 2019 11:45

Merge with master

5fefb23

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

More fixups

b82ef32

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

Make default plugin resolving respect referenced pluins

849787a

Signed-off-by: Max Shaposhnik <mshaposh@redhat.com>

amisevsk reviewed May 24, 2019

View reviewed changes

l0rd mentioned this pull request May 28, 2019

Che 7 GA #12696

Closed

mshaposhnik added 11 commits May 28, 2019 15:22

Merge branch 'master' into registryUrl

16b3780

User FileContentProvider

a793855

Move some classes to WS api

2adeba4

Merge branch 'master' into registryUrl

b6b709d

Use FileContentProvider in tests

c28e5f5

Use FileContentProvider in tests

e36e710

Merge witj latest master

4a3a2fb

Use per-request file content provider

0111a48

Fixup test

04dc344

Fixup test

1997b6a

Code feractoring

a71d436

mshaposhnik added 3 commits June 5, 2019 12:18

Merge branch 'master' into registryUrl

245428d

Add doc example about references and registry url-s

d1e011c

Merge branch 'master' into registryUrl

1ba01b5

skabashnyuk reviewed Jun 6, 2019

View reviewed changes

...ema/src/main/resources/che-schema/7.0.0-beta6.0/2__add_registry_url_to_devfile_component.sql Outdated Show resolved Hide resolved

skabashnyuk approved these changes Jun 6, 2019

View reviewed changes

Change schema version

c232369

metlos approved these changes Jun 6, 2019

View reviewed changes

FIx review comments

34cac61

sleshchenko reviewed Jun 6, 2019

View reviewed changes

Fix typos & comments

110f77b

sleshchenko reviewed Jun 6, 2019

View reviewed changes

mshaposhnik added 4 commits June 6, 2019 16:32

Review fixes

2c179f9

refactor FQN parsing

79fbde3

Code fix

0c13775

Javadoc fixup

669f3ad

sleshchenko reviewed Jun 10, 2019

View reviewed changes

...-workspace/src/main/java/org/eclipse/che/api/workspace/server/wsplugins/PluginFQNParser.java Outdated Show resolved Hide resolved

wsmaster/che-core-api-workspace/src/main/resources/schema/devfile.json Outdated Show resolved Hide resolved

Review fixups & broker version

d736c7d

mshaposhnik requested a review from ibuziuk as a code owner June 10, 2019 10:59

sleshchenko reviewed Jun 10, 2019

View reviewed changes

wsmaster/che-core-api-workspace/src/main/resources/schema/devfile.json Outdated Show resolved Hide resolved

sleshchenko approved these changes Jun 10, 2019

View reviewed changes

Fixup regex

7541cb1

mshaposhnik merged commit f601f16 into master Jun 10, 2019

mshaposhnik deleted the registryUrl branch June 11, 2019 07:09

ibuziuk mentioned this pull request Jun 11, 2019

Che 7 stacks should use version "latest" of plugins #13426

Closed

sleshchenko mentioned this pull request Jul 15, 2019

NPE when a devfile command references theia #13842

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add possibility to specify reference or registry url for chePlugin/cheEditor type components #13297

Add possibility to specify reference or registry url for chePlugin/cheEditor type components #13297

mshaposhnik commented May 8, 2019 •

edited

Loading

metlos May 13, 2019

sleshchenko commented May 22, 2019

amisevsk left a comment

mshaposhnik commented May 27, 2019

mshaposhnik commented Jun 5, 2019

skabashnyuk left a comment

metlos left a comment

mshaposhnik commented Jun 10, 2019

sleshchenko left a comment

mshaposhnik commented Jun 10, 2019

che-bot commented Jun 10, 2019

artaleks9 commented Jun 10, 2019

Add possibility to specify reference or registry url for chePlugin/cheEditor type components #13297

Add possibility to specify reference or registry url for chePlugin/cheEditor type components #13297

Conversation

mshaposhnik commented May 8, 2019 • edited Loading

metlos May 13, 2019

Choose a reason for hiding this comment

sleshchenko commented May 22, 2019

amisevsk left a comment

Choose a reason for hiding this comment

mshaposhnik commented May 27, 2019

mshaposhnik commented Jun 5, 2019

skabashnyuk left a comment

Choose a reason for hiding this comment

metlos left a comment

Choose a reason for hiding this comment

mshaposhnik commented Jun 10, 2019

sleshchenko left a comment

Choose a reason for hiding this comment

mshaposhnik commented Jun 10, 2019

che-bot commented Jun 10, 2019

artaleks9 commented Jun 10, 2019

mshaposhnik commented May 8, 2019 •

edited

Loading