Camel Plugin for Che 7

[slemeur]

Camel Plugin for Che 7

Goals

• Have features from VS Code Camel Tooling available in Che 7

  • for Camel XML DSL
  • for Camel Java DSL

Organization of the work

Che team will work to implement/fix what is needed to have VS Code Camel extension working. They will provide documentation to Fuse team to integrate the VS Code extension in plugin registry and in stack.

Sub-tasks

Symbiotic LS running in parallel
The Camel tooling is relying on other Language Server to provide its capabilities: XML and Java. Che must be providing support to allow multiple Language Servers, running in parallel.

• Multiple LS running in parallel
  • Support diagnostic of 2 LS on same file Diagnostic from a language server is overriding diagnostic from other Language servers contributing to the same file #13154 Diagnostic from a language server is overriding diagnostic from other Language servers contributing to the same file eclipse-theia/theia#4929
  • Support xml, Java and Camel extension altogether seems not working, Java extension is KO Java plugin not working in a Che 7 workspace with 2 other plugins on che.openshift.io (not respecting memory limit) #13146

XML Plugin in Che
The Camel tooling is relying exhaustively on XML. As such, Che should be providing XML tooling, which will work along with the VSCode Camel Extension.

• Support VS Code XML Tooling in Theia theia-ide/theia#3317
• Add Theia Plugin APIs to support VS Code XML Tooling Add Theia Plugin APIs to support VS Code XML Tooling #11775
• Cannot read property 'editor.autoClosingBrackets' of undefined VS Code xml extension not working with error UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'editor.autoClosingBrackets' of undefined #12536

Will fix:

• Provide an xml editor with xsd completion and validation Provide an xml editor with xsd completion and validation #6925
• Che 7 plugin: vscode-xml Che 7 plugin: vscode-xml #12437

Java Plugin in Che
In order for the Camel extension to be working in Che, it requires the Java LS. It also requires to be running as a Che Plugin (running in its own sidecar container).

• Che Java Plugin: Che 7 plugin: vscode-java #12436
• Theia Java Plugin: theia-ide/theia#3778

Camel Plugin in Che

• Avoid case of diagnostic with empty message reason Wrong Apache Camel Validation returned when uri is finishing with & camel-tooling/camel-language-server#225
• Avoid log for undocumented protocol messages ( $/setTraceNotification ) Ignore undocumented protocol messages camel-tooling/camel-language-server#226
• "Request completionItem/resolve failed." fro Camel VS Code extension "Request completionItem/resolve failed." fro Camel VS Code extension eclipse-theia/theia#4856
• "Error: Request 'updateContent' failed" in docker output when there is a validation error on a Camel file "Error: Request 'updateContent' failed" in docker output when there is a validation error on a Camel file eclipse-theia/theia#4857
• "Find all references" is not available "Find All references" is always disabled #13183

Camel specific features working with XML

• Have Camel specific features and classic XML support working with XML in Theia in the same editor
• Verify that Camel specific features and classic XML support working with XML in Che in the same editor

Camel specific features working with Java

• Have Camel specific features and classic Java support working with Java in Theia in the same editor

• Have Camel specific features and classic Java support working with Java in Che in the same editor

  • with a proper Java project (can use a Camel SpringBoot example)
  • with a standalone java file out of a project (lower priority)

• Be able to install successfully in Che the Camel VS Code extension

Packaging of the Camel VSCode extension in Che

• Have Camel VS Code extension in plugin registry Include Apache Camel Language Support VS Code Extension che-plugin-registry#109

Che Stacks Integration

• Have a Fuse stack using the Camel VS Code extension from the plugin registry with sample projects to be used with Provide Camel stack for Che 7 #13182

Documentation

• Publication of a blog post about Camel on Che Blog
• Publication of an how to use Camel in Eclipse Che on the documentation

QE:Integration Tests

• Have tests for Eclipse Theia integration
• Have test for Eclipse Che integration

Notes

Main "Camel specific features" are described in the description https://marketplace.visualstudio.com/items?itemName=camel-tooling.vscode-apache-camel
It includes:

• completion of Camel URI
• Hover on Camel URI
• Document symbol for Camel Context and Camel route
• Diagnostic on Camel URI

[apupier]

waiting for the rights to edit this epic, I put here issues that I detected with new version of Theia which allows to test Camel plugin and XML plugin altogether:

• "Error: Request 'updateContent' failed" in docker output when there is a validation error on a Camel file eclipse-theia/theia#4857
• "Request completionItem/resolve failed." fro Camel VS Code extension eclipse-theia/theia#4856
• Unsupported notification method: $/setTraceNotification message when installing Camel language VS Code extension eclipse-theia/theia#4855

these problems which should come from language Server are visible only in Eclipse Theia:

• Wrong Apache Camel Validation returned when uri is finishing with & camel-tooling/camel-language-server#225
• Ignore undocumented protocol messages camel-tooling/camel-language-server#226

Issues related to Che:

• Support diagnostic of 2 LS on same file Diagnostic from a language server is overriding diagnostic from other Language servers contributing to the same file #13154 Diagnostic from a language server is overriding diagnostic from other Language servers contributing to the same file eclipse-theia/theia#4929
• Support xml, Java and Camel extension altogether seems not working, Java extension is KO Java plugin not working in a Che 7 workspace with 2 other plugins on che.openshift.io (not respecting memory limit) #13146

[tsmaeder]

Running the API usage report (#12996) shows no missing API

[tsmaeder]

How do I build the extension? npm install fails with Error: Cannot find module 'mvn-artifact-download'

you need to build one time with npm install --ignore-script
https://github.com/camel-tooling/camel-lsp-client-vscode/blob/master/Contributing.md#how-to-start-development

[apupier]

created eclipse-che/che-plugin-registry#109 for the inclusion of Camel extension in Che plugin registry

[apupier]

Duplicating to propose an updated version as i don't have edit rights on original comment

Camel Plugin for Che 7

Goals

• Have features from VS Code Camel Tooling available in Che 7

  • for Camel XML DSL
  • for Camel Java DSL

Organization of the work

Che team will work to implement/fix what is needed to have VS Code Camel extension working. They will provide documentation to Fuse team to integrate the VS Code extension in plugin registry and in stack.

Sub-tasks

Symbiotic LS running in parallel
The Camel tooling is relying on other Language Server to provide its capabilities: XML and Java. Che must be providing support to allow multiple Language Servers, running in parallel.

• Multiple LS running in parallel
  • Support diagnostic of 2 LS on same file Diagnostic from a language server is overriding diagnostic from other Language servers contributing to the same file #13154 Diagnostic from a language server is overriding diagnostic from other Language servers contributing to the same file eclipse-theia/theia#4929
  • Support xml, Java and Camel extension altogether seems not working, Java extension is KO Java plugin not working in a Che 7 workspace with 2 other plugins on che.openshift.io (not respecting memory limit) #13146

XML Plugin in Che
The Camel tooling is relying exhaustively on XML. As such, Che should be providing XML tooling, which will work along with the VSCode Camel Extension.

• Support VS Code XML Tooling in Theia theia-ide/theia#3317
• Add Theia Plugin APIs to support VS Code XML Tooling Add Theia Plugin APIs to support VS Code XML Tooling #11775
• Cannot read property 'editor.autoClosingBrackets' of undefined VS Code xml extension not working with error UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'editor.autoClosingBrackets' of undefined #12536

Will fix:

• Provide an xml editor with xsd completion and validation Provide an xml editor with xsd completion and validation #6925
• Che 7 plugin: vscode-xml Che 7 plugin: vscode-xml #12437

Java Plugin in Che
In order for the Camel extension to be working in Che, it requires the Java LS. It also requires to be running as a Che Plugin (running in its own sidecar container).

• Che Java Plugin: Che 7 plugin: vscode-java #12436
• Theia Java Plugin: theia-ide/theia#3778

Camel Plugin in Che

• Avoid case of diagnostic with empty message reason Wrong Apache Camel Validation returned when uri is finishing with & camel-tooling/camel-language-server#225
• Avoid log for undocumented protocol messages ( $/setTraceNotification ) Ignore undocumented protocol messages camel-tooling/camel-language-server#226
• "Request completionItem/resolve failed." fro Camel VS Code extension "Request completionItem/resolve failed." fro Camel VS Code extension eclipse-theia/theia#4856
• "Error: Request 'updateContent' failed" in docker output when there is a validation error on a Camel file "Error: Request 'updateContent' failed" in docker output when there is a validation error on a Camel file eclipse-theia/theia#4857
• "Find all references" is not available "Find All references" is always disabled #13183

Camel specific features working with XML

• Have Camel specific features and classic XML support working with XML in Theia in the same editor
• Verify that Camel specific features and classic XML support working with XML in Che in the same editor

Camel specific features working with Java

• Have Camel specific features and classic Java support working with Java in Theia in the same editor

• Have Camel specific features and classic Java support working with Java in Che in the same editor

  • with a proper Java project (can use a Camel SpringBoot example)
  • with a standalone java file out of a project (lower priority)

• Be able to install successfully in Che the Camel VS Code extension

Packaging of the Camel VSCode extension in Che

• Have Camel VS Code extension in plugin registry Include Apache Camel Language Support VS Code Extension che-plugin-registry#109

Che Stacks Integration

• Have a Fuse stack using the Camel VS Code extension from the plugin registry with sample projects to be used with Provide Camel stack for Che 7 #13182

Documentation

• Publication of a blog post about Camel on Che Blog
• Publication of an how to use Camel in Eclipse Che on the documentation

QE:Integration Tests

• Have tests for Eclipse Theia integration
• Have test for Eclipse Che integration

Notes

Main "Camel specific features" are described in the description https://marketplace.visualstudio.com/items?itemName=camel-tooling.vscode-apache-camel
It includes:

• completion of Camel URI
• Hover on Camel URI
• Document symbol for Camel Context and Camel route
• Diagnostic on Camel URI

[slemeur]

Closing this epic as most of the work has been completed. Missing the documentation on Che docs - #14778

[apupier]

another important part is missing non-regression tests.
created #14780

[che-bot]

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.