forked from eclipse-theia/theia
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[WIP] Integrate new message-rpc protocol into plugin API
- Refactor plugin-ext rpc protocol to reuse the new binary message-rpc protocol. - - Remove custom RPC message encoding and handling reuse message-rpc -- Implement `QueuingChannelMultiplexer`that queues messages and sends them accumlated on the next process.tick (replaces the old `Multiplexer` implementation -- Refactors proxy handlers and remote target handlers -- Use `Channel` instead of `MessageConnection` for creating new instances of `RPCProtocol` -- Implement special message encoders and decoders for the plugin communication - Adapt the `HostedPluginServer` and `HostedPluginClient` API to send/receive messages in binary format instead of strings. - Implement a message protocol for process pipe streams to be able to send messages in binary format between the hosted-plugin-process and the plugin-host. Contributed on behalf of STMicroelectronics Part of eclipse-theia#10684
- Loading branch information
Showing
21 changed files
with
603 additions
and
429 deletions.
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /******************************************************************************** | ||
| * Copyright (C) 2021 Red Hat, Inc. and others. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the Eclipse | ||
| * Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| * with the GNU Classpath Exception which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
| /* eslint-disable @typescript-eslint/no-explicit-any */ | ||
| import { Channel } from '@theia/core/'; | ||
| import { RpcClient, RpcServer } from '@theia/core'; | ||
| import { Deferred } from '@theia/core/lib/common/promise-util'; | ||
| import { RpcMessageDecoder, RpcMessageEncoder } from '@theia/core/lib/common/message-rpc/rpc-message-encoder'; | ||
|
|
||
| export interface RpcMessageParser { | ||
| encoder: RpcMessageEncoder, | ||
| decoder: RpcMessageDecoder | ||
| } | ||
| /** | ||
| * A proxy handler that will send any method invocation on the proxied object | ||
| * as a rcp protocol message over a channel. | ||
| */ | ||
| export class ClientProxyHandler<T extends object> implements ProxyHandler<T> { | ||
| private channelDeferred: Deferred<RpcClient> = new Deferred(); | ||
|
|
||
| constructor(protected readonly id: string, protected readonly parser: RpcMessageParser) { | ||
| } | ||
|
|
||
| listen(channel: Channel): void { | ||
| const client = new RpcClient(channel, this.parser); | ||
| this.channelDeferred.resolve(client); | ||
| } | ||
|
|
||
| get(target: any, name: string, receiver: any): any { | ||
| if (target[name] || name.charCodeAt(0) !== 36 /* CharCode.DollarSign */) { | ||
| return target[name]; | ||
| } | ||
| const isNotify = this.isNotification(name); | ||
| return (...args: any[]) => { | ||
| const method = name.toString(); | ||
| return this.channelDeferred.promise.then((connection: RpcClient) => | ||
| new Promise((resolve, reject) => { | ||
| try { | ||
| if (isNotify) { | ||
| connection.sendNotification(method, args); | ||
| resolve(undefined); | ||
| } else { | ||
| const resultPromise = connection.sendRequest(method, args) as Promise<any>; | ||
| resultPromise.then((result: any) => { | ||
| resolve(result); | ||
| }).catch(e => { | ||
| reject(e); | ||
| }); | ||
| } | ||
| } catch (err) { | ||
| reject(err); | ||
| } | ||
| }) | ||
| ); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Return whether the given property represents a notification. If true, | ||
| * the promise returned from the invocation will resolve immediately to `undefined` | ||
| * | ||
| * A property leads to a notification rather than a method call if its name | ||
| * begins with `notify` or `on`. | ||
| * | ||
| * @param p - The property being called on the proxy. | ||
| * @return Whether `p` represents a notification. | ||
| */ | ||
| protected isNotification(p: PropertyKey): boolean { | ||
| let propertyString = p.toString(); | ||
| if (propertyString.charCodeAt(0) === 36/* CharCode.DollarSign */) { | ||
| propertyString = propertyString.substring(1); | ||
| } | ||
| return propertyString.startsWith('notify') || propertyString.startsWith('on'); | ||
| } | ||
| } | ||
|
|
||
| export class RpcInvocationHandler { | ||
|
|
||
| constructor(readonly id: string, readonly target: any, protected readonly parser: RpcMessageParser) { | ||
| } | ||
|
|
||
| listen(channel: Channel): void { | ||
| const server = new RpcServer(channel, (method: string, args: any[]) => this.handleRequest(method, args), this.parser); | ||
| server.onNotification((e: { method: string, args: any }) => this.onNotification(e.method, e.args)); | ||
| } | ||
|
|
||
| protected async handleRequest(method: string, args: any[]): Promise<any> { | ||
| return this.target[method](...args); | ||
| } | ||
|
|
||
| protected onNotification(method: string, args: any[]): void { | ||
| this.target[method](...args); | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.