Add Theia Plugin APIs to support VS Code Kubernetes Tooling

[l0rd]

The goal is to be able to run VSCode Kubernetes Tooling as a Theia plugin. To achieve it we should extend Theia Plugin API.

This is the list of initial k8s tooling commands we want to support:

• apply
• get
• describe
• follow
• logs
• follow events

TODO: List the needed API
Workspace API's:

• workspace.registerTextDocumentContentProvider [plug-in] API for registering Text Document Content Provider  eclipse-theia/theia#2786
• workspace.registerFileSystemProvider [plug-in] API for register a filesystem provider eclipse-theia/theia#2861
• workspace.applyEdit [plug-in] Add API to apply workspace edit eclipse-theia/theia#2784
• workspace.onDidSaveTextDocument [plug-in] Add API for onDidSaveTextDocument in workspace namespace eclipse-theia/theia#3201

Languages API's: eclipse-theia/theia#2341

• - languages.registerHoverProvider [plug-in][languages] Register hover provider eclipse-theia/theia#2601
• - languages.registerDocumentLinkProvider [plug-in][languages] Register a document link provider eclipse-theia/theia#2964
• - languages.registerCodeLensProvider [plug-in][languages] Register a code lens provider eclipse-theia/theia#3199
• - languages.registerTelemetry
• - languages.registerDocumentSymbolProvider [plug-in][languages] Register a document symbol provider eclipse-theia/theia#3200

Window :

• window.registerTreeDataProvider [plug-in] Add Tree View and Tree Data Provider APIs eclipse-theia/theia#2782
• window.showTextDocument [plug-in] API endpoint for window.showTextDocument eclipse-theia/theia#2801
• window.withProgress [plug-in] API endpoint for window.withProgress eclipse-theia/theia#2802

Debug:

• debug.registerDebugConfigurationProvider
• debug.activeDebugSession
• onDidTerminateDebugSession
• onDidChangeActiveDebugSession
• startDebugging

Menu API :

• Menu Plugin API [plug-in] Menu Plugin API  eclipse-theia/theia#2785
• Add support for the context menus in the contributed views Add support for the context menus in the contributed views eclipse-theia/theia#3646
• Add support for 'when' expressions Add support for 'when' expressions eclipse-theia/theia#3658

Contribution Points used in package.json :

• - confuguration
• - views
• - menus [plug-in] Menu Plugin API  eclipse-theia/theia#2785
• - commands
• - languages
• - debuggers

Related PR's:

• support vscode.workspace.findFiles Initial commit for support vscode.workspace.findFiles feature eclipse-theia/theia#3128

[l0rd]

cc @evidolob @benoitf @ashumilova @slemeur

[l0rd]

@vparfonov @slemeur I added the list of commands to support first:

• apply
• get
• describe
• follow
• logs
• follow events

[apupier]

It would be nice to cover the use case of Camel Language Server https://marketplace.visualstudio.com/items?itemName=camel-tooling.vscode-apache-camel
The VS Code plugin is here https://github.com/camel-tooling/camel-lsp-client-vscode
The Server code is here https://github.com/camel-tooling/camel-language-server

I'm not sure how to know all the API/commands that are used.

On Language Server side, we can see the "activated" features here https://github.com/camel-tooling/camel-language-server/blob/c50fb5954cf521b3471651e2856ca4e1ce00b8a9/src/main/java/com/github/cameltooling/lsp/internal/CamelLanguageServer.java#L78-L86

Please note that for now when using the released VS Code plugin NPEs are thrown, which seems to be due to the fact that exitServer is called before a startServer. I made it more robust to avoid NPE camel-tooling/camel-language-server#166 and it will be better in next release.
Even wit this new version, it is not working, there is no more errors or logs.
Reported camel-tooling/camel-lsp-client-vscode#72 to be able to remote debug the server part.

[slemeur]

Hi @apupier.
Are you asking to prioritize the different plugin APIs that you might need for the Camel Language Server?
Or do you have a particular use case related to a Camel with Kubernetes that you'd like to see covered?

[apupier]

Are you asking to prioritize the different plugin APIs that you might need for the Camel Language Server?

Yes, i'm asking if it possible to cover the different plugin APIs that Camel Language Server is using.

Or do you have a particular use case related to a Camel with Kubernetes that you'd like to see covered?

The Camel Language server is independent from Kubernetes. I have some Kubernetes related stuff but it is not related to this request.

[slemeur]

ok :)
That's why I asked. This issue is related to the work needed to support the VSCode Kubernetes plugin in Che.
Do you mind creating a separate issue for your requirement?

[apupier]

That's why I asked. This issue is related to the work needed to support the VSCode Kubernetes plugin in Che.

oups sorry, I thought it was a top level issue for all VS code plugins. my bad.

Do you mind creating a separate issue for your requirement?

here it is #11705

[l0rd]

For apply command we need eclipse-theia/theia#2979 to be merged upstream

[azatsarynnyy]

For context menus we need eclipse-theia/theia#3646

[azatsarynnyy]

I've updated the description with a couple of tasks related to Menu API

[vparfonov]

Need to fix:

• Command "Kubernetes: Delete Context" of Kubernetes Tolling don't work in Theia Command "Kubernetes: Delete Context" of Kubernetes Tolling don't work in Theia  #12745
• Command "Kubernetes: Set Kubeconfig" of Kubernetes Tolling don't work in Theia Command "Kubernetes: Set Kubeconfig" of Kubernetes Tolling don't work in Theia #12746
• Terminal API doesn't work for a plugin running in a sidecar container Terminal API doesn't work for a plugin running in a sidecar container che-theia#112
• Pass the selected tree item to a command's argument [views] pass the selected tree item to a command's argument eclipse-theia/theia#3882
• Kubernetes: Diff command doesn't open diff view when running in a sidecar [Kubernetes Plugin] Kubernetes: Diff command doesn't open diff view when running in a sidecar #13044
• Show Dependencies command opens extra tab Kubernetes Plugin: Show Dependencies command opens extra tab #13037
• Implement vscode.executeDocumentSymbolProvider command implement vscode.executeDocumentSymbolProvider command for emmet VS Code extension eclipse-theia/theia#4048. It's needed for Helm: Convert to Template Parameter command
• Kubernetes Tooling Plugin: error when executing the commands that rely on Theia terminal Kubernetes Tooling Plugin: error when executing the commands that rely on Theia terminal #12887
• Support custom icons in the TreeView [plug-in] Support custom icons in the TreeView eclipse-theia/theia#3330
• Kubernetes:Run command should work w/o Docker [k8s plugin] Kubernetes:Run command should work w/o Docker #13316
• Refreshing the tree causes collapsing all nodes [k8s plugin] Refreshing the tree causes collapsing all nodes #13331

[PavelSosin]

Hint: if you had minikube installed on you computer ( desktop/laptop) and now is trying to switch to Docker desktop Kubernetes cluste) you can experience context switch glitch - minikube is the only choice. It is easily repairable: rename you minikube config.json to something like configOld.json and set KUBECONFIG system variable pointing to kubeconfig file create by Docker Desktop installation.

[vparfonov]

Going to close this epic, will continue working on some separate issues like:
[k8s plugin] Kubernetes:Run command should work w/o Docker che #13316