core: improve & refactor rpc protocol #12581

tortmayr · 2023-05-30T21:29:34Z

What it does

Implements the tweaks and fixes for the rpc system discussed in #12368

Ensure that pending requests are properly rejected when the underlying service channel is closed.
Remove obsolete id-property from NotificationMessages. Ids are only required fro matching request-response pairs.
Use a deferred in the RpcProxyFactory for protocol initialization

Contributed on behalf of STMicroelectronics

How to test

Nothing to test in particular. The change should not break any functionality. Everything should work as before

Review checklist

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

Fixes #12581

Reminder for reviewers

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

- Ensure that pending requests are properly rejected when the underlying service channel is closed. - Remove obsolete id-property from `NotificationMessage`s. Ids are only required fro matching request-response pairs. - Rename `JsonRpcProxyFactory` and related types to `RpcProxyFactory` (Rpc*). The naming scheme was a remainder of the old vscode jsonr-rpc based protocol. By simply using the `Rpc` suffix the class names are less misleading and protocol agnostic. - Keep deprecated declarations of the old `JsonRpc*` namespace. The components are heavily used by adopters so we should maintain this deprecated symbols for a while to enable graceful migration without hard API breaks. - Use a deferred in the `RpcProxyFactory` for protocol initialization Fixes #12581

Updates the outdated documentation for setting up RPC services by - Removing any notion of the old vscode json-rpc protocol. The neutral term RPC is used instead - Replacing the outdated loggingServer example with a current version of the taskServer - Removing sections of the documentation that are now obsolete because the underlying framework code has been reworked Note: he code snippets are based on eclipse-theia/theia#12581. So this PR is blocked until the referenced PR is approved and merged (the last section Part of eclipse-theia/theia#12368

tsmaeder

A couple of comments inline. In general, it might have been easier to make the renames a separate, non-functional PR. Right now the renames hide the functional changes a bit.

packages/core/src/browser/messaging/ws-connection-provider.ts

tsmaeder · 2023-05-31T08:13:46Z

packages/core/src/common/message-rpc/rpc-message-encoder.ts

@@ -111,7 +110,7 @@ export interface RpcMessageDecoder {
 export interface RpcMessageEncoder {
    cancel(buf: WriteBuffer, requestId: number): void;

-    notification(buf: WriteBuffer, requestId: number, method: string, args: any[]): void
+    notification(buf: WriteBuffer, method: string, args: any[]): void


I'm wondering if the request id has a use as an ordering tool: it allows us to determine the sequence of messages sent from a particular RPC endpoint.

Good point. I opted for making the notification id optional. This way we can still use it for tracing with the base protocol.
Adopters that use a custom protocol or reuse the RpcMessageEncoder can simply omit the id if they don't need.

tsmaeder · 2023-05-31T08:21:06Z

packages/core/src/common/messaging/proxy-factory.ts

                this.onDidCloseConnectionEmitter.fire(undefined);
                // Wait for connection in case the backend reconnects
                this.waitForConnection();
            });
+            protocol.channel.onError(err => {
+                if (this.rpcDeferred.state !== 'resolved') {


What does Deferred do if the state is resolved?

Removed the lines in question. They were committed on accident (rebasing shenanigans)

packages/core/src/common/messaging/proxy-factory.ts

tsmaeder · 2023-05-31T08:26:29Z

packages/core/src/common/messaging/proxy-factory.ts

-        );
-        this.connectionPromise.then(connection => {
-            connection.channel.onClose(() => {
+        this.rpcDeferred.promise.then(protocol => {


This is not exactly the same as before: waitForConnection can be called more than once, but we a single Deferred instance can only be resolved once. I think we have to allocate a new instance here.

tsmaeder · 2023-05-31T08:27:17Z

packages/core/src/common/messaging/proxy-factory.ts

-const defaultRPCConnectionFactory: RpcConnectionFactory = (channel, requestHandler) => new RpcProtocol(channel, requestHandler);
+const defaultRpcProtocolFactory: RpcProtocolFactory = (channel, requestHandler) => new RpcProtocol(channel, requestHandler);
+
+export interface RpcProxyFactoryOptions {


This interface seems unused.

packages/core/src/node/logger-backend-module.ts

- Ensure that pending requests are properly rejected when the underlying service channel is closed. - Make id-property from `NotificationMessage`s. optional. Ids in notification are not strictly required and can be safely omitted. - Rename `RpcConnectionFactory` to `RpcProtocolFactory` - Use a deferred in the `RpcProxyFactory` for protocol initialization Part of #12581

tortmayr · 2023-06-01T09:52:58Z

In general, it might have been easier to make the renames a separate, non-functional PR. Right now the renames hide the functional changes a bit.

Yeah that a good point. I have addressed your review and pushed an update that removes the renames and only contains the functional changes.

I will open a separate PR for the renaming changes.

- Rename `JsonRpcProxyFactory` and related types to `RpcProxyFactory` (Rpc*). The naming scheme was a remainder of the old vscode jsonr-rpc based protocol. By simply using the `Rpc` suffix the class names are less misleading and protocol agnostic. - Keep deprecated declarations of the old `JsonRpc*` namespace. The components are heavily used by adopters so we should maintain this deprecated symbols for a while to enable graceful migration without hard API breaks. Naturally this is open for discussion, but judging from the files I had to touch in the core framework alone I think it's definitely a good idea to give adopters a grace period. Complementary website PR: eclipse-theia/theia-website#422 Fixes #12581 Contributed on behalf of STMicroelectronics

tsmaeder · 2023-06-07T10:07:17Z

@tortmayr I checked out the latest state of the branch and for me, it is quite broken: plugins do not start at all. There is nothing obviously wrong when looking at the logs.

tsmaeder · 2023-06-07T12:40:42Z

@tortmayr something might be wrong with my system. Hold on before you start panicking ;-)

tsmaeder

Looks good, now.

- Rename `JsonRpcProxyFactory` and related types to `RpcProxyFactory` (Rpc*). The naming scheme was a remainder of the old vscode jsonr-rpc based protocol. By simply using the `Rpc` suffix the class names are less misleading and protocol agnostic. - Keep deprecated declarations of the old `JsonRpc*` namespace. The components are heavily used by adopters so we should maintain this deprecated symbols for a while to enable graceful migration without hard API breaks. Naturally this is open for discussion, but judging from the files I had to touch in the core framework alone I think it's definitely a good idea to give adopters a grace period. Complementary website PR: eclipse-theia/theia-website#422 Fixes #12581 Contributed on behalf of STMicroelectronics

* Update RPC documentation Updates the outdated documentation for setting up RPC services by - Removing any notion of the old vscode json-rpc protocol. The neutral term RPC is used instead - Replacing the outdated loggingServer example with a current version of the taskServer - Removing sections of the documentation that are now obsolete because the underlying framework code has been reworked Note: he code snippets are based on eclipse-theia/theia#12581. So this PR is blocked until the referenced PR is approved and merged (the last section Part of eclipse-theia/theia#12368

tortmayr force-pushed the tortmayr/12368 branch from d273b71 to 94d2bf4 Compare May 30, 2023 21:35

tortmayr mentioned this pull request May 30, 2023

Update RPC documentation eclipse-theia/theia-website#422

Merged

tortmayr requested a review from tsmaeder May 31, 2023 06:08

tortmayr mentioned this pull request May 31, 2023

Dirty editors cannot be saved after application recovers from "offline" mode #12195

Open

tsmaeder reviewed May 31, 2023

View reviewed changes

vince-fugnitto added jsonrpc issues related to jsonrpc messaging issues related to messaging labels May 31, 2023

tortmayr force-pushed the tortmayr/12368 branch from 94d2bf4 to 53b1987 Compare June 1, 2023 09:50

tortmayr requested a review from tsmaeder June 1, 2023 09:56

tortmayr mentioned this pull request Jun 1, 2023

Rename JsonRpcProxyFactory and related types #12588

Merged

1 task

tsmaeder approved these changes Jun 7, 2023

View reviewed changes

tsmaeder merged commit c42adc2 into master Jun 7, 2023
9 checks passed

github-actions bot added this to the 1.39.0 milestone Jun 7, 2023

tortmayr deleted the tortmayr/12368 branch April 29, 2024 07:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

core: improve & refactor rpc protocol #12581

core: improve & refactor rpc protocol #12581

tortmayr commented May 30, 2023 •

edited

tsmaeder left a comment

tsmaeder May 31, 2023

tortmayr Jun 1, 2023

tsmaeder May 31, 2023

tortmayr Jun 1, 2023

tsmaeder May 31, 2023

tortmayr Jun 1, 2023

tsmaeder May 31, 2023

tortmayr Jun 1, 2023

tortmayr commented Jun 1, 2023 •

edited

tsmaeder commented Jun 7, 2023

tsmaeder commented Jun 7, 2023

tsmaeder left a comment

core: improve & refactor rpc protocol #12581

core: improve & refactor rpc protocol #12581

Conversation

tortmayr commented May 30, 2023 • edited

What it does

How to test

Review checklist

Reminder for reviewers

tsmaeder left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tortmayr commented Jun 1, 2023 • edited

tsmaeder commented Jun 7, 2023

tsmaeder commented Jun 7, 2023

tsmaeder left a comment

Choose a reason for hiding this comment

tortmayr commented May 30, 2023 •

edited

tortmayr commented Jun 1, 2023 •

edited