Theia creates 2 web-sockets if we override the WebSocketConnectionProvider class

[safisa]

Bug Description:

Hi,
It could be difficult to explain the issue I am facing on the latest Theia (1.43.1), but I will try:

I have a class that extends the WebSocketConnectionProvider:

export class CustomWebSocketConnectionProvider extends WebSocketConnectionProvider {
    protected override createWebSocket(url: string): Socket {
        ...
    }
}

And here is the binding code:

bind(CustomWebSocketConnectionProvider).toSelf().inSingletonScope();
rebind(WebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);

It was working correctly until I upgraded to 1.43.1 (from 1.40). I see now in the dev-tools on the network tab that there are two web sockets, and only one is actually working (before that there was only one).

If I debug the code from dev-tools and put a breakpoint inside the createWebSocket method in both classes (CustomWebSocketConnectionProvider and the base WebSocketConnectionProvider class), and reload the page, the break point breaks in both of them! this should not be the case, since I override this class and rebind it to the new one.

I think this issue is caused by the Remote SSH PR from 1.43: #12618

Steps to Reproduce:

1. create a new class that extends the WebSocketConnectionProvider
2. it can be an empty class, no need to override anything
3. add the binding as above
4. reload and check the network tab with WS filtering
5. you will see 2 WS
6. also you can override the createWebSocket, you can just call the super once, and put the breakpoint as described above..

Additional Information

• Operating System: Mac
• Theia Version: 1.43.1

[msujew]

@safisa You probably need to rebind the local websocket connection provider then as well:

rebind(LocalWebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);

See also our own messaging module.

[safisa]

@msujew I already tried this but didn't help, same issue.

[safisa]

@msujew I think it is related to the PR from 1.42 and not the one above: 12590

But, I don't know how to make my custom binding work at the preload level.
I tried to move my binding from my frontend module to a new preload module like this:

src/browser/preload/custom-preload-module.ts:

export default new ContainerModule((bind, unbind, isBound, rebind) => {
    bind(CustomWebSocketConnectionProvider).toSelf().inSingletonScope();
    rebind(WebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);
    //rebind(LocalWebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);
});

package.json:

"theiaExtensions": [
    {
      "frontendPreload": "lib/browser/preload/custom-preload-module"
    },
    {....}

but this also not working, the custom preload file is not loaded at all. Maybe this is not how we can contribute to preload step!

Can you help?

Thanks

[msujew]

Right, it's likely more related to #12590

but this also not working, the custom preload file is not loaded at all. Maybe this is not how we can contribute to preload step!

It should work though. Can you see whether your frontendPreload gets generated to the preload method in src-gen/frontend/index.js of your Theia app?

Note that you need to rebind the WebSocketConnectionProvider both on frontend and frontendPreload level.

[safisa]

@msujew
Finally, it is working :)
First I was in watch mode, thus the index.js was not updated, I had to rebuild it using yarn, and then restart my app.
Also, I had to do the binding as you said in the frontend 👍

Thanks a lot.

[msujew]

Alright, that's good to know. Closing the issue :)

[safisa]

Hi @msujew

I see that there is an error message on the browser console log regarding the rebind above:

index.js:48 Failed to run preload scripts.

index.js:50 Error: Could not unbind serviceIdentifier: WebSocketConnectionProvider
    at Container._removeServiceFromDictionary (container.ts:699:13)
    at Container.unbind (container.ts:201:10)
    at Container.rebind (container.ts:184:10)
    at container.ts:526:38
    at ContainerModule.registry (custom-preload-module.ts:11:5)
    at Container.load (container.ts:119:21)
    at index.js:35:1
    at async preload (index.js:43:1)
    at async index.js:59:1

My custom class works as expected, but does the error above affect anything?

I tried to do just bind not rebind in the preload module, in this case, there is no error message in the log, but I see 2 web socket connections in the network (dev tools), one is active (all the messages go through it) and the other one has several messages only...

Thanks

[msujew]

My custom class works as expected, but does the error above affect anything?

Yes, it will prevent all preload scripts from running (as indicated in the error message), i.e. identifying backend OS and loading translations.

Instead of calling rebind it might be enough to just call bind. Since all rebind does is call unbind and then bind.

[safisa]

@msujew but once I tried to do only bind, I see 2 web sockets in the network tab in dev tools:

In the image above the selected one is the inactive one.
So why we do now have 2 sockets instead of one?

[hyddel]

@msujew as mentioned here, localizations are still not loading.

I have created a preload-module where I have only one customization which is websocket one:

bind(CustomWebSocketConnectionProvider).toSelf().inSingletonScope();
rebind(WebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);

so here is my setting:

"theiaExtensions": [
    {
      "frontendPreload": "lib/browser/preload/preload-module-ws"
    },
    {
      "frontend": "lib/browser/<our-custom-module>",
      "backend": "lib/node/<our-custom-module>"
    }
  ]

The frontend is pointing to all other customizations. Even then, language translations are not loading.

In addition, I see errors in the console logs:

Failed to run preload scripts.

Error: Could not unbind serviceIdentifier: n
    _removeServiceFromDictionary container.ts:699
    unbind container.ts:201
    rebind container.ts:184
    qe container.ts:526
    default preload-module.ts:8
    load container.ts:119
    r index.js:43
    promise callback*r index.js:43
    85340 index.js:51
    exports index.js:67
    85340 index.js:63
    i main.js:2222
    <anonymous> main.js:2222
    <anonymous> main.js:2222

[hyddel]

@msujew any thoughts ?

[hyddel]

@msujew I have tried the following in the preload module after which localizations were loading but websocket connection was not getting established.

bind(CustomWebSocketConnectionProvider).toSelf().inSingletonScope();
bind(WebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);

One thing to mention here is that we have the following code in our custom-frontend-application-module where we have all rebindings and this module is pointed by the frontend mentioned in the package.json file

NOTE - WebSocketConnectionProvider is getting rebinded twice. One occurrence is in the preload module and other one is in the frontend module

bind(CustomWebSocketConnectionProvider).toSelf().inSingletonScope();
rebind(WebSocketConnectionProvider).toService(CustomWebSocketConnectionProvider);

bind(CustomPluginViewRegistry).toSelf().inSingletonScope();
rebind(PluginViewRegistry).toService(CustomPluginViewRegistry);

bind(CustomWorkspaceService).toSelf().inSingletonScope();
rebind(WorkspaceService).toService(CustomWorkspaceService);

bind(CustomFrontendApplicationContribution).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).to(CustomFrontendApplicationContribution).inSingletonScope();

bind(CustomCommonFrontendContribution).toSelf().inSingletonScope();
rebind(CommonFrontendContribution).toService(CustomCommonFrontendContribution);

[hyddel]

@msujew could you please try rebind something(preferrably websocket connection provider) in frontendPreload ? I think frontendPreload is not able to unbind and rebind. Without unbinding and rebinding, custom WS connection providers cannot be loaded.