@theia/plugin-ext 1.18.0 → 1.21.0-next.12

package/src/common/plugin-message-reader.ts

@@ -1,111 +0,0 @@
-/********************************************************************************
- * Copyright (C) 2018 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
- ********************************************************************************/
-
-import { DataCallback, Emitter, Event, PartialMessageInfo } from '@theia/core/shared/vscode-ws-jsonrpc';
-
-export abstract class AbstractMessageReader {
-    protected errorEmitter = new Emitter<Error>();
-    protected closeEmitter = new Emitter<void>();
-    protected partialMessageEmitter = new Emitter<PartialMessageInfo>();
-    dispose(): void {
-        this.errorEmitter.dispose();
-        this.closeEmitter.dispose();
-    }
-    get onError(): Event<Error> {
-        return this.errorEmitter.event;
-    }
-    fireError(error: Error): void {
-        this.errorEmitter.fire(this.asError(error));
-    }
-    get onClose(): Event<void> {
-        return this.closeEmitter.event;
-    }
-    fireClose(): void {
-        this.closeEmitter.fire(undefined);
-    }
-    get onPartialMessage(): Event<PartialMessageInfo> {
-        return this.partialMessageEmitter.event;
-    }
-    firePartialMessage(info: PartialMessageInfo): void {
-        this.partialMessageEmitter.fire(info);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    asError(error: any): Error {
-        if (error instanceof Error) {
-            return error;
-        } else {
-            return new Error(`Reader received error. Reason: ${typeof error.message === 'string' ? error.message : 'unknown'}`);
-        }
-    }
-}
-
-/**
- * Support for reading string message through RPC protocol.
- */
-export class PluginMessageReader extends AbstractMessageReader {
-    protected state: 'initial' | 'listening' | 'closed' = 'initial';
-    protected callback: DataCallback | undefined;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    protected readonly events: { message?: any, error?: any }[] = [];
-
-    constructor() {
-        super();
-    }
-
-    listen(callback: DataCallback): void {
-        if (this.state === 'initial') {
-            this.state = 'listening';
-            this.callback = callback;
-            while (this.events.length !== 0) {
-                const event = this.events.pop()!;
-                if (event.message) {
-                    this.readMessage(event.message);
-                } else if (event.error) {
-                    this.fireError(event.error);
-                } else {
-                    this.fireClose();
-                }
-            }
-        }
-    }
-
-    readMessage(message: string): void {
-        if (this.state === 'initial') {
-            this.events.splice(0, 0, { message });
-        } else if (this.state === 'listening') {
-            const data = JSON.parse(message);
-            this.callback!(data);
-        }
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    fireError(error: any): void {
-        if (this.state === 'initial') {
-            this.events.splice(0, 0, { error });
-        } else if (this.state === 'listening') {
-            super.fireError(error);
-        }
-    }
-
-    fireClose(): void {
-        if (this.state === 'initial') {
-            this.events.splice(0, 0, {});
-        } else if (this.state === 'listening') {
-            super.fireClose();
-        }
-        this.state = 'closed';
-    }
-}

package/src/common/plugin-message-writer.ts

@@ -1,65 +0,0 @@
-/********************************************************************************
- * Copyright (C) 2018 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
- ********************************************************************************/
-
-import { Message, MessageWriter, Emitter, Event } from '@theia/core/shared/vscode-ws-jsonrpc';
-import { ConnectionMain, ConnectionExt } from './plugin-api-rpc';
-
-export abstract class AbstractMessageWriter {
-    protected errorEmitter = new Emitter<[Error, Message | undefined, number | undefined]>();
-    protected closeEmitter = new Emitter<void>();
-    dispose(): void {
-        this.errorEmitter.dispose();
-        this.closeEmitter.dispose();
-    }
-    get onError(): Event<[Error, Message | undefined, number | undefined]> {
-        return this.errorEmitter.event;
-    }
-    fireError(error: Error, message: Message | undefined, count: number | undefined): void {
-        this.errorEmitter.fire([this.asError(error), message, count]);
-    }
-    get onClose(): Event<void> {
-        return this.closeEmitter.event;
-    }
-    fireClose(): void {
-        this.closeEmitter.fire(undefined);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    asError(error: any): Error {
-        if (error instanceof Error) {
-            return error;
-        } else {
-            return new Error(`Writer received error. Reason: ${typeof error.message === 'string' ? error.message : 'unknown'}`);
-        }
-    }
-}
-
-/**
- * Support for writing string message through RPC protocol.
- */
-export class PluginMessageWriter extends AbstractMessageWriter implements MessageWriter {
-    constructor(
-        protected readonly id: string,
-        protected readonly proxy: ConnectionMain | ConnectionExt) {
-        super();
-    }
-
-    write(message: string): void;
-    write(message: Message): void;
-    write(arg: string | Message): void {
-        const content = JSON.stringify(arg);
-        this.proxy.$sendMessage(this.id, content);
-    }
-}

package/src/main/browser/connection-main.ts

@@ -1,107 +0,0 @@
-/********************************************************************************
- * Copyright (C) 2018 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
- ********************************************************************************/
-
-import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
-import { MAIN_RPC_CONTEXT, ConnectionMain, ConnectionExt } from '../../common/plugin-api-rpc';
-import { RPCProtocol } from '../../common/rpc-protocol';
-import { PluginConnection } from '../../common/connection';
-import { PluginMessageReader } from '../../common/plugin-message-reader';
-import { PluginMessageWriter } from '../../common/plugin-message-writer';
-
-/**
- * Implementation of connection system of the plugin API.
- * Creates holds the connections to the plugins. Allows to send a message to the plugin by getting already created connection via id.
- */
-export class ConnectionMainImpl implements ConnectionMain, Disposable {
-
-    private readonly proxy: ConnectionExt;
-    private readonly connections = new Map<string, PluginConnection>();
-    private readonly toDispose = new DisposableCollection();
-    constructor(rpc: RPCProtocol) {
-        this.proxy = rpc.getProxy(MAIN_RPC_CONTEXT.CONNECTION_EXT);
-    }
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-
-    /**
-     * Gets the connection between plugin by id and sends string message to it.
-     *
-     * @param id connection's id
-     * @param message incoming message
-     */
-    async $sendMessage(id: string, message: string): Promise<void> {
-        if (this.connections.has(id)) {
-            this.connections.get(id)!.reader.readMessage(message);
-        } else {
-            console.warn('It is not possible to read message. Connection missed.');
-        }
-    }
-
-    /**
-     * Instantiates a new connection by the given id.
-     * @param id the connection id
-     */
-    async $createConnection(id: string): Promise<void> {
-        await this.doEnsureConnection(id);
-    }
-
-    /**
-     * Deletes a connection.
-     * @param id the connection id
-     */
-    async $deleteConnection(id: string): Promise<void> {
-        this.connections.delete(id);
-    }
-
-    /**
-     * Returns existed connection or creates a new one.
-     * @param id the connection id
-     */
-    async ensureConnection(id: string): Promise<PluginConnection> {
-        const connection = await this.doEnsureConnection(id);
-        await this.proxy.$createConnection(id);
-        return connection;
-    }
-
-    /**
-     * Returns existed connection or creates a new one.
-     * @param id the connection id
-     */
-    async doEnsureConnection(id: string): Promise<PluginConnection> {
-        const connection = this.connections.get(id) || await this.doCreateConnection(id);
-        this.connections.set(id, connection);
-        return connection;
-    }
-
-    protected async doCreateConnection(id: string): Promise<PluginConnection> {
-        const reader = new PluginMessageReader();
-        const writer = new PluginMessageWriter(id, this.proxy);
-        const connection = new PluginConnection(
-            reader,
-            writer,
-            () => {
-                this.connections.delete(id);
-                if (!toClose.disposed) {
-                    this.proxy.$deleteConnection(id);
-                }
-            });
-        const toClose = new DisposableCollection(Disposable.create(() => reader.fireClose()));
-        this.toDispose.push(toClose);
-        return connection;
-    }
-}

package/src/plugin/connection-ext.ts

@@ -1,95 +0,0 @@
-/********************************************************************************
- * Copyright (C) 2018 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
- ********************************************************************************/
-
-import { ConnectionExt, PLUGIN_RPC_CONTEXT, ConnectionMain } from '../common/plugin-api-rpc';
-import { RPCProtocol } from '../common/rpc-protocol';
-import { PluginConnection } from '../common/connection';
-import { PluginMessageReader } from '../common/plugin-message-reader';
-import { PluginMessageWriter } from '../common/plugin-message-writer';
-
-/**
- * Implementation of connection system of the plugin API.
- * It allows to communicate with main side to send and read messages.
- */
-export class ConnectionExtImpl implements ConnectionExt {
-    private proxy: ConnectionMain;
-    private connections = new Map<string, PluginConnection>();
-    constructor(rpc: RPCProtocol) {
-        this.proxy = rpc.getProxy(PLUGIN_RPC_CONTEXT.CONNECTION_MAIN);
-    }
-
-    /**
-     * Gets the connection between plugin by id and sends string message to it.
-     *
-     * @param id connection's id
-     * @param message incoming message
-     */
-    async $sendMessage(id: string, message: string): Promise<void> {
-        if (this.connections.has(id)) {
-            this.connections.get(id)!.reader.readMessage(message);
-        } else {
-            console.warn('It is not possible to read message. Connection missed.');
-        }
-    }
-
-    /**
-     * Instantiates a new connection by the given id.
-     * @param id the connection id
-     */
-    async $createConnection(id: string): Promise<void> {
-        await this.doEnsureConnection(id);
-    }
-
-    /**
-     * Deletes a connection.
-     * @param id the connection id
-     */
-    async $deleteConnection(id: string): Promise<void> {
-        this.connections.delete(id);
-    }
-
-    /**
-     * Returns existed connection or creates a new one.
-     * @param id the connection id
-     */
-    async ensureConnection(id: string): Promise<PluginConnection> {
-        const connection = await this.doEnsureConnection(id);
-        this.proxy.$createConnection(id);
-        return connection;
-    }
-
-    /**
-     * Returns existed connection or creates a new one.
-     * @param id the connection id
-     */
-    async doEnsureConnection(id: string): Promise<PluginConnection> {
-        const connection = this.connections.get(id) || await this.doCreateConnection(id);
-        this.connections.set(id, connection);
-        return connection;
-    }
-
-    protected async doCreateConnection(id: string): Promise<PluginConnection> {
-        const reader = new PluginMessageReader();
-        const writer = new PluginMessageWriter(id, this.proxy);
-        return new PluginConnection(
-            reader,
-            writer,
-            () => {
-                this.connections.delete(id);
-                this.proxy.$deleteConnection(id);
-            });
-    }
-}