Reapply changes for new message rpc #40
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ns) (eclipse-theia#11011) Refactors and improves the prototype of a faster JSON-RPC protocol initially contributed by @tsmaeder (See also eclipse-theia#10781). The encoding approach used in the initial POC has some performance drawbacks when encoding plain JSON objects. We refactored the protocol to improve the performance for JSON objects whilst maintaining the excellent performance for encoding objects that contain binary data. Integrates the new message-rpc prototype into the core messaging API (replacing vscode-ws-jsonrpc). This has major impacts on the Messaging API as we no longer expose a `Connection` object (which was provided by vscode-ws-jsonrpc) and directly rely on a generic transport `Channel` implementation instead. - Introduce `Channel` as the main transport concept for messages (instead of the dedicated `Connection` from vscode-jsonrpc) - Replace usage of `vscode-ws-jsonrpc` with a custom binary RPC protocol. - Remove 'vscode-ws-jsonrpc' depdency from "@theia/core/shared". - Refactor all connection providers to use the new binary protocol. - Ensure that the `RemoteFileSystemProvider` API uses `Uint8Arrays` over plain number arrays. This enables direct serialization as buffers and reduces the overhead of unnecessarily converting from and to `Uint8Arrays`. - Refactor terminal widget and terminal backend contribution so that the widgets communicates with the underlying terminal process using the new rpc protocol. - Rework the IPC bootstrap protocol so that it uses a binary pipe for message transmission instead of the `ipc` pipe which only supports string encoding. - Extend the `JsonRpcProxyFactory` with an optional `RpcConnectionFactory` that enables adopter to creates proxies with a that use a custom `RpcProtocol`/`RpcConnection`. The plugin API still uses its own RPC protocol implementation. This will be addressed in a follow-up PR. (See eclipse-theia#11093) Contributed on behalf of STMicroelectronics. Closes eclipse-theia#10684 Co-authored-by: Thomas Mäder <[email protected]>
|
@tortmayr it would be helpful for the review if you told us what caused the bugs you fixed in the latest commit and how they are addressed. |
- eclipse-theiaGH-11196 Remove dev/debug logoutput from IPCChannel - eclipse-theiaGH-11199 Refactor connection provider and channel multiplexer to properly handle a reconnecting backend - Remove console log in websocket-channel if the socket is not connected. Otherwise we end up in an endless loop. - Ensure that channels & RpcProtocol instances proplery dispose all resources if the backend disconnects. - Ensure that all previously open channels and RpcProtocol instances are properly restored once the backend reconnects. - eclipse-theia#11203 Ensure that debugging is handled gracefully (implicitly fixed with the fix for eclipse-theia#11199) - Remove dependency to `reconnecting-websocket` which is no longer needed since the swap to socket.io Fixes eclipse-theia#11196 Fixes eclipse-theia#11199 Contributed on behalf of STMicroelectronics
lucas-koehler
approved these changes
May 31, 2022
|
@lucas-koehler Thanks. So I will go ahead and open the "real" PR in the main Theia repository |
ndoschek
added a commit
that referenced
this pull request
Jul 30, 2024
Co-authored-by: Olaf Lessenich <[email protected]>
ndoschek
added a commit
that referenced
this pull request
Jul 30, 2024
Co-authored-by: Olaf Lessenich <[email protected]>
1 task
ndoschek
added a commit
that referenced
this pull request
Jul 30, 2024
ndoschek
added a commit
that referenced
this pull request
Jul 30, 2024
Co-authored-by: Olaf Lessenich <[email protected]>
ndoschek
added a commit
that referenced
this pull request
Jul 30, 2024
Co-authored-by: Olaf Lessenich <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
Reapplies the changes for the binary message rpc, originally introduced with eclipse-theia#11011 and fixes the critical issues with lead to reverting the original change.
In particular the following issues are addressed:
These bugs were caused by a combination of underlying issues:
console.warn. Using console logging in the browser indirectly also triggers an RPC call to theLoggerServer. Naturally this call also fails and due to the console logging triggers another rpc call => we end up in and endless loop. Fixed by removing the console.warn statement inwebsocket-channel.ts.RpcProtocolinstances were only partly disposed. This means once the backend reconnected did end up with multipleRpcProtoclinstances for the same proxy which lead to weird issues e.g. Sending a request from one instance but the reply for the request is then handled by the other instance.This is now fixed by ensuring that all components involved in the rpc communication (websocket main channel, multiplexer, multiplexed service channels,
RpcProtocolinstances) are fully disposed on disconnect and re-instantiated on reconnect.connection-servicewas informed too early i.e. before all previously open channels have been restored. As a consequence some RPC calls (e.g. ping requests) were triggered before the responsible service channel was available.Fixed in
WebSocketConnectionProviderby ensuring that theonSocketDidOpenevent is fired after all previously openend channels have been restored.onIncomingMessgeActivityevent of theWebSocketConnectionProviderwas never fired.How to test
To test the fix for #111999:
To test the fix for eclipse-theia#11203
Review checklist
Reminder for reviewers