doc: improve WebSocketConnectionProvider deprecation message

eclipse-theia / theia

Eclipse Theia is a cloud & desktop IDE framework implemented in TypeScript.

http://theia-ide.org

Eclipse Public License 2.0

19.94k stars 2.49k forks source link

doc: improve WebSocketConnectionProvider deprecation message #13713

Closed eneufeld closed 4 months ago

eneufeld commented 4 months ago

The current deprecation message leads to confusion as the referenced class is not exported and not usable as an injection symbol. The message is improved and the new ServiceConnectionProvider is exported.

Contributed on behalf of STMicroelectronics

What it does

How to test

Follow-ups

Review checklist

[ ] As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

As a reviewer, I agree to behave in accordance with the review guidelines

JonasHelming commented 4 months ago

@tortmayr Why do we actually a different symbol compared to the type?

tortmayr commented 3 months ago

I don't know the exact reasoning for that, we would have to ask @tsmaeder.

However, I have now migrated a couple of Theia projects to the latest version and I agree that having a separate type and symbol is quite cumbersome. But I'm not sure if there is an easy way to fix this.

tsmaeder commented 3 months ago

Does https://github.com/eclipse-theia/theia/pull/13805 explain why? It's because of remote back ends.

msujew commented 3 months ago

To explain it in short: In any Electron app, there can be two instances of a ServiceConnectionProvider, one for the local backend and one for the remote one. To differentiate them, we need two symbols.