@theia/core 1.53.0-next.4 → 1.53.0-next.55

package/src/common/message-rpc/message-buffer.ts

@@ -1,105 +1,105 @@
-// *****************************************************************************
-// 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/**
- * A buffer maintaining a write position capable of writing primitive values
- */
-export interface WriteBuffer {
-    writeUint8(byte: number): this
-    writeUint16(value: number): this
-    writeUint32(value: number): this
-    writeString(value: string): this
-    writeBytes(value: Uint8Array): this
-    writeNumber(value: number): this
-    writeLength(value: number): this
-    writeRaw(bytes: Uint8Array): this;
-    /**
-     * Makes any writes to the buffer permanent, for example by sending the writes over a channel.
-     * You must obtain a new write buffer after committing
-     */
-    commit(): void;
-}
-
-export class ForwardingWriteBuffer implements WriteBuffer {
-    constructor(protected readonly underlying: WriteBuffer) {
-    }
-
-    writeUint8(byte: number): this {
-        this.underlying.writeUint8(byte);
-        return this;
-    }
-
-    writeUint16(value: number): this {
-        this.underlying.writeUint16(value);
-        return this;
-    }
-
-    writeUint32(value: number): this {
-        this.underlying.writeUint32(value);
-        return this;
-    }
-
-    writeLength(value: number): this {
-        this.underlying.writeLength(value);
-        return this;
-    }
-
-    writeString(value: string): this {
-        this.underlying.writeString(value);
-        return this;
-    }
-
-    writeBytes(value: Uint8Array): this {
-        this.underlying.writeBytes(value);
-        return this;
-    }
-
-    writeNumber(value: number): this {
-        this.underlying.writeNumber(value);
-        return this;
-    }
-
-    writeRaw(bytes: Uint8Array): this {
-        this.underlying.writeRaw(bytes);
-        return this;
-    }
-
-    commit(): void {
-        this.underlying.commit();
-    }
-}
-
-/**
- * A buffer maintaining a read position in a buffer containing a received message capable of
- * reading primitive values.
- */
-export interface ReadBuffer {
-    readUint8(): number;
-    readUint16(): number;
-    readUint32(): number;
-    readString(): string;
-    readNumber(): number,
-    readLength(): number,
-    readBytes(): Uint8Array;
-
-    /**
-     * Returns a new read buffer  whose starting read position is the current read position of this buffer.
-     * This is useful to create read buffers sub messages.
-     * (e.g. when using a multiplexer the beginning of the message might contain some protocol overhead which should not be part
-     * of the message reader that is sent to the target channel)
-     */
-    sliceAtReadPosition(): ReadBuffer
-}
+// *****************************************************************************
+// 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/**
+ * A buffer maintaining a write position capable of writing primitive values
+ */
+export interface WriteBuffer {
+    writeUint8(byte: number): this
+    writeUint16(value: number): this
+    writeUint32(value: number): this
+    writeString(value: string): this
+    writeBytes(value: Uint8Array): this
+    writeNumber(value: number): this
+    writeLength(value: number): this
+    writeRaw(bytes: Uint8Array): this;
+    /**
+     * Makes any writes to the buffer permanent, for example by sending the writes over a channel.
+     * You must obtain a new write buffer after committing
+     */
+    commit(): void;
+}
+
+export class ForwardingWriteBuffer implements WriteBuffer {
+    constructor(protected readonly underlying: WriteBuffer) {
+    }
+
+    writeUint8(byte: number): this {
+        this.underlying.writeUint8(byte);
+        return this;
+    }
+
+    writeUint16(value: number): this {
+        this.underlying.writeUint16(value);
+        return this;
+    }
+
+    writeUint32(value: number): this {
+        this.underlying.writeUint32(value);
+        return this;
+    }
+
+    writeLength(value: number): this {
+        this.underlying.writeLength(value);
+        return this;
+    }
+
+    writeString(value: string): this {
+        this.underlying.writeString(value);
+        return this;
+    }
+
+    writeBytes(value: Uint8Array): this {
+        this.underlying.writeBytes(value);
+        return this;
+    }
+
+    writeNumber(value: number): this {
+        this.underlying.writeNumber(value);
+        return this;
+    }
+
+    writeRaw(bytes: Uint8Array): this {
+        this.underlying.writeRaw(bytes);
+        return this;
+    }
+
+    commit(): void {
+        this.underlying.commit();
+    }
+}
+
+/**
+ * A buffer maintaining a read position in a buffer containing a received message capable of
+ * reading primitive values.
+ */
+export interface ReadBuffer {
+    readUint8(): number;
+    readUint16(): number;
+    readUint32(): number;
+    readString(): string;
+    readNumber(): number,
+    readLength(): number,
+    readBytes(): Uint8Array;
+
+    /**
+     * Returns a new read buffer  whose starting read position is the current read position of this buffer.
+     * This is useful to create read buffers sub messages.
+     * (e.g. when using a multiplexer the beginning of the message might contain some protocol overhead which should not be part
+     * of the message reader that is sent to the target channel)
+     */
+    sliceAtReadPosition(): ReadBuffer
+}

package/src/common/message-rpc/msg-pack-extension-manager.ts

@@ -1,70 +1,70 @@
-// *****************************************************************************
-// Copyright (C) 2022 STMicroelectronics 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { addExtension } from 'msgpackr';
-
-/**
- * Handles the global registration of custom MsgPackR extensions
- * required for the default RPC communication. MsgPackR extensions
- * are installed globally on both ends of the communication channel.
- * (frontend-backend, pluginExt-pluginMain).
- * Is implemented as singleton as it is also used in plugin child processes which have no access to inversify.
- */
-export class MsgPackExtensionManager {
-    private static readonly INSTANCE = new MsgPackExtensionManager();
-    public static getInstance(): MsgPackExtensionManager {
-        return this.INSTANCE;
-    }
-
-    private extensions = new Map<number, MsgPackExtension>();
-
-    private constructor() {
-    }
-
-    registerExtensions(...extensions: MsgPackExtension[]): void {
-        extensions.forEach(extension => {
-            if (extension.tag < 1 || extension.tag > 100) {
-                // MsgPackR reserves the tag range 1-100 for custom extensions.
-                throw new Error(`MsgPack extension tag should be a number from 1-100 but was '${extension.tag}'`);
-            }
-            if (this.extensions.has(extension.tag)) {
-                throw new Error(`Another MsgPack extension with the tag '${extension.tag}' is already registered`);
-            }
-            this.extensions.set(extension.tag, extension);
-            addExtension({
-                Class: extension.class,
-                type: extension.tag,
-                write: extension.serialize,
-                read: extension.deserialize
-            });
-        });
-    }
-
-    getExtension(tag: number): MsgPackExtension | undefined {
-        return this.extensions.get(tag);
-    }
-}
-
-export interface MsgPackExtension {
-    class: Function,
-    tag: number,
-    serialize(instance: unknown): unknown,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    deserialize(serialized: any): unknown
-}
-
-export type Constructor<T> = new (...params: unknown[]) => T;
-
+// *****************************************************************************
+// Copyright (C) 2022 STMicroelectronics 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { addExtension } from 'msgpackr';
+
+/**
+ * Handles the global registration of custom MsgPackR extensions
+ * required for the default RPC communication. MsgPackR extensions
+ * are installed globally on both ends of the communication channel.
+ * (frontend-backend, pluginExt-pluginMain).
+ * Is implemented as singleton as it is also used in plugin child processes which have no access to inversify.
+ */
+export class MsgPackExtensionManager {
+    private static readonly INSTANCE = new MsgPackExtensionManager();
+    public static getInstance(): MsgPackExtensionManager {
+        return this.INSTANCE;
+    }
+
+    private extensions = new Map<number, MsgPackExtension>();
+
+    private constructor() {
+    }
+
+    registerExtensions(...extensions: MsgPackExtension[]): void {
+        extensions.forEach(extension => {
+            if (extension.tag < 1 || extension.tag > 100) {
+                // MsgPackR reserves the tag range 1-100 for custom extensions.
+                throw new Error(`MsgPack extension tag should be a number from 1-100 but was '${extension.tag}'`);
+            }
+            if (this.extensions.has(extension.tag)) {
+                throw new Error(`Another MsgPack extension with the tag '${extension.tag}' is already registered`);
+            }
+            this.extensions.set(extension.tag, extension);
+            addExtension({
+                Class: extension.class,
+                type: extension.tag,
+                write: extension.serialize,
+                read: extension.deserialize
+            });
+        });
+    }
+
+    getExtension(tag: number): MsgPackExtension | undefined {
+        return this.extensions.get(tag);
+    }
+}
+
+export interface MsgPackExtension {
+    class: Function,
+    tag: number,
+    serialize(instance: unknown): unknown,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    deserialize(serialized: any): unknown
+}
+
+export type Constructor<T> = new (...params: unknown[]) => T;
+

package/src/common/message-rpc/rpc-message-encoder.spec.ts

@@ -1,65 +1,65 @@
-// *****************************************************************************
-// 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { expect } from 'chai';
-import {
-    EncodingError, MsgPackMessageDecoder, MsgPackMessageEncoder
-} from './rpc-message-encoder';
-import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from './uint8-array-message-buffer';
-
-describe('PPC Message Encoder & Decoder', () => {
-    describe('MsgPack  Encoder & Decoder', () => {
-        it('should encode object into binary message and decode the message back into the original object', () => {
-            const buffer = new Uint8Array(1024);
-            const writer = new Uint8ArrayWriteBuffer(buffer);
-            const testObject = {
-                string: 'string',
-                boolean: true,
-                integer: 5,
-                float: 14.5,
-                array: ['1', 2, { three: 'three' }],
-                set: new Set([1, 2, 3]),
-                map: new Map([[1, 1], [2, 2], [3, 3]]),
-                buffer: new TextEncoder().encode('ThisIsAUint8Array'),
-                object: { foo: 'bar', baz: true },
-                undefined: undefined,
-                // eslint-disable-next-line no-null/no-null
-                null: null
-            };
-
-            const encoder = new MsgPackMessageEncoder();
-            encoder.encode(writer, testObject);
-            const written = writer.getCurrentContents();
-
-            const reader = new Uint8ArrayReadBuffer(written);
-
-            const decoder = new MsgPackMessageDecoder();
-            const decoded = decoder.decode(reader);
-
-            expect(decoded).deep.equal(testObject);
-        });
-        it('should fail with an EncodingError when trying to encode the object ', () => {
-            const x = new Set();
-            const y = new Set();
-            x.add(y);
-            y.add(x);
-
-            const writer = new Uint8ArrayWriteBuffer();
-            const encoder = new MsgPackMessageEncoder();
-            expect(() => encoder.encode(writer, x)).to.throw(EncodingError);
-        });
-    });
-});
+// *****************************************************************************
+// 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { expect } from 'chai';
+import {
+    EncodingError, MsgPackMessageDecoder, MsgPackMessageEncoder
+} from './rpc-message-encoder';
+import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from './uint8-array-message-buffer';
+
+describe('PPC Message Encoder & Decoder', () => {
+    describe('MsgPack  Encoder & Decoder', () => {
+        it('should encode object into binary message and decode the message back into the original object', () => {
+            const buffer = new Uint8Array(1024);
+            const writer = new Uint8ArrayWriteBuffer(buffer);
+            const testObject = {
+                string: 'string',
+                boolean: true,
+                integer: 5,
+                float: 14.5,
+                array: ['1', 2, { three: 'three' }],
+                set: new Set([1, 2, 3]),
+                map: new Map([[1, 1], [2, 2], [3, 3]]),
+                buffer: new TextEncoder().encode('ThisIsAUint8Array'),
+                object: { foo: 'bar', baz: true },
+                undefined: undefined,
+                // eslint-disable-next-line no-null/no-null
+                null: null
+            };
+
+            const encoder = new MsgPackMessageEncoder();
+            encoder.encode(writer, testObject);
+            const written = writer.getCurrentContents();
+
+            const reader = new Uint8ArrayReadBuffer(written);
+
+            const decoder = new MsgPackMessageDecoder();
+            const decoded = decoder.decode(reader);
+
+            expect(decoded).deep.equal(testObject);
+        });
+        it('should fail with an EncodingError when trying to encode the object ', () => {
+            const x = new Set();
+            const y = new Set();
+            x.add(y);
+            y.add(x);
+
+            const writer = new Uint8ArrayWriteBuffer();
+            const encoder = new MsgPackMessageEncoder();
+            expect(() => encoder.encode(writer, x)).to.throw(EncodingError);
+        });
+    });
+});