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

package/src/common/messaging/socket-write-buffer.ts

@@ -1,52 +1,52 @@
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox 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 { WebSocket } from './web-socket-channel';
-
-export class SocketWriteBuffer {
-    private static DISCONNECTED_BUFFER_SIZE = 100 * 1024;
-
-    private disconnectedBuffer: Uint8Array | undefined;
-    private bufferWritePosition = 0;
-
-    buffer(data: Uint8Array): void {
-        this.ensureWriteBuffer(data.byteLength);
-        this.disconnectedBuffer?.set(data, this.bufferWritePosition);
-        this.bufferWritePosition += data.byteLength;
-    }
-
-    protected ensureWriteBuffer(byteLength: number): void {
-        if (!this.disconnectedBuffer) {
-            this.disconnectedBuffer = new Uint8Array(SocketWriteBuffer.DISCONNECTED_BUFFER_SIZE);
-            this.bufferWritePosition = 0;
-        }
-
-        if (this.bufferWritePosition + byteLength > this.disconnectedBuffer.byteLength) {
-            throw new Error(`Max disconnected buffer size exceeded by adding ${byteLength} bytes`);
-        }
-    }
-
-    flush(socket: WebSocket): void {
-        if (this.disconnectedBuffer) {
-            socket.send(this.disconnectedBuffer.slice(0, this.bufferWritePosition));
-            this.disconnectedBuffer = undefined;
-        }
-    }
-
-    drain(): void {
-        this.disconnectedBuffer = undefined;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox 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 { WebSocket } from './web-socket-channel';
+
+export class SocketWriteBuffer {
+    private static DISCONNECTED_BUFFER_SIZE = 100 * 1024;
+
+    private disconnectedBuffer: Uint8Array | undefined;
+    private bufferWritePosition = 0;
+
+    buffer(data: Uint8Array): void {
+        this.ensureWriteBuffer(data.byteLength);
+        this.disconnectedBuffer?.set(data, this.bufferWritePosition);
+        this.bufferWritePosition += data.byteLength;
+    }
+
+    protected ensureWriteBuffer(byteLength: number): void {
+        if (!this.disconnectedBuffer) {
+            this.disconnectedBuffer = new Uint8Array(SocketWriteBuffer.DISCONNECTED_BUFFER_SIZE);
+            this.bufferWritePosition = 0;
+        }
+
+        if (this.bufferWritePosition + byteLength > this.disconnectedBuffer.byteLength) {
+            throw new Error(`Max disconnected buffer size exceeded by adding ${byteLength} bytes`);
+        }
+    }
+
+    flush(socket: WebSocket): void {
+        if (this.disconnectedBuffer) {
+            socket.send(this.disconnectedBuffer.slice(0, this.bufferWritePosition));
+            this.disconnectedBuffer = undefined;
+        }
+    }
+
+    drain(): void {
+        this.disconnectedBuffer = undefined;
+    }
+}

package/src/common/messaging/web-socket-channel.ts

@@ -1,76 +1,76 @@
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox 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
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import { WriteBuffer } from '../message-rpc';
-import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '../message-rpc/uint8-array-message-buffer';
-import { AbstractChannel } from '../message-rpc/channel';
-import { Socket as ClientSocket } from 'socket.io-client';
-import { Socket as ServerSocket } from 'socket.io';
-import { Emitter } from 'vscode-languageserver-protocol';
-
-export type WebSocket = ClientSocket | ServerSocket;
-
-/**
- * A channel that manages the main websocket connection between frontend and backend. All service channels
- * are reusing this main channel. (multiplexing). An {@link IWebSocket} abstraction is used to keep the implementation
- * independent of the actual websocket implementation and its execution context (backend vs. frontend).
- */
-export class WebSocketChannel extends AbstractChannel {
-    static wsPath = '/services';
-
-    private onDidConnectEmitter = new Emitter<void>();
-    onDidConnect = this.onDidConnectEmitter.event;
-
-    constructor(protected readonly socket: WebSocket) {
-        super();
-        socket.on('connect', () => {
-            this.onDidConnectEmitter.fire();
-        });
-
-        socket.on('disconnect', reason => {
-            this.onCloseEmitter.fire({
-                reason: reason
-            });
-        });
-
-        socket.on('error', reason => this.onErrorEmitter.fire(reason));
-        socket.on('message', data => {
-            // In the browser context socketIO receives binary messages as ArrayBuffers.
-            // So we have to convert them to a Uint8Array before delegating the message to the read buffer.
-            const buffer = data instanceof ArrayBuffer ? new Uint8Array(data) : data;
-            this.onMessageEmitter.fire(() => new Uint8ArrayReadBuffer(buffer));
-        });
-    }
-
-    getWriteBuffer(): WriteBuffer {
-        const result = new Uint8ArrayWriteBuffer();
-
-        result.onCommit(buffer => {
-            if (this.socket.connected) {
-                this.socket.send(buffer);
-            }
-        });
-
-        return result;
-    }
-
-    override close(): void {
-        this.socket.disconnect();
-        super.close();
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox 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
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { WriteBuffer } from '../message-rpc';
+import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '../message-rpc/uint8-array-message-buffer';
+import { AbstractChannel } from '../message-rpc/channel';
+import { Socket as ClientSocket } from 'socket.io-client';
+import { Socket as ServerSocket } from 'socket.io';
+import { Emitter } from 'vscode-languageserver-protocol';
+
+export type WebSocket = ClientSocket | ServerSocket;
+
+/**
+ * A channel that manages the main websocket connection between frontend and backend. All service channels
+ * are reusing this main channel. (multiplexing). An {@link IWebSocket} abstraction is used to keep the implementation
+ * independent of the actual websocket implementation and its execution context (backend vs. frontend).
+ */
+export class WebSocketChannel extends AbstractChannel {
+    static wsPath = '/services';
+
+    private onDidConnectEmitter = new Emitter<void>();
+    onDidConnect = this.onDidConnectEmitter.event;
+
+    constructor(protected readonly socket: WebSocket) {
+        super();
+        socket.on('connect', () => {
+            this.onDidConnectEmitter.fire();
+        });
+
+        socket.on('disconnect', reason => {
+            this.onCloseEmitter.fire({
+                reason: reason
+            });
+        });
+
+        socket.on('error', reason => this.onErrorEmitter.fire(reason));
+        socket.on('message', data => {
+            // In the browser context socketIO receives binary messages as ArrayBuffers.
+            // So we have to convert them to a Uint8Array before delegating the message to the read buffer.
+            const buffer = data instanceof ArrayBuffer ? new Uint8Array(data) : data;
+            this.onMessageEmitter.fire(() => new Uint8ArrayReadBuffer(buffer));
+        });
+    }
+
+    getWriteBuffer(): WriteBuffer {
+        const result = new Uint8ArrayWriteBuffer();
+
+        result.onCommit(buffer => {
+            if (this.socket.connected) {
+                this.socket.send(buffer);
+            }
+        });
+
+        return result;
+    }
+
+    override close(): void {
+        this.socket.disconnect();
+        super.close();
+    }
+}

package/src/common/nls.ts

@@ -1,151 +1,151 @@
-// *****************************************************************************
-// Copyright (C) 2021 TypeFox 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 { FormatType, Localization } from './i18n/localization';
-
-export namespace nls {
-
-    export let localization: Localization | undefined;
-
-    export const defaultLocale = 'en';
-
-    export const localeId = 'localeId';
-
-    export const locale = typeof window === 'object' && window && window.localStorage.getItem(localeId) || undefined;
-
-    let keyProvider: LocalizationKeyProvider | undefined;
-
-    /**
-     * Automatically localizes a text if that text also exists in the vscode repository.
-     */
-    export function localizeByDefault(defaultValue: string, ...args: FormatType[]): string {
-        if (localization) {
-            const key = getDefaultKey(defaultValue);
-            if (key) {
-                return localize(key, defaultValue, ...args);
-            } else {
-                console.warn(`Could not find translation key for default value: "${defaultValue}"`);
-            }
-        }
-        return Localization.format(defaultValue, args);
-    }
-
-    export function getDefaultKey(defaultValue: string): string {
-        if (!keyProvider) {
-            keyProvider = new LocalizationKeyProvider();
-        }
-        const key = keyProvider.get(defaultValue);
-        if (key) {
-            return key;
-        }
-        return '';
-    }
-
-    export function localize(key: string, defaultValue: string, ...args: FormatType[]): string {
-        return Localization.localize(localization, key, defaultValue, ...args);
-    }
-
-    export function isSelectedLocale(id: string): boolean {
-        if (locale === undefined && id === defaultLocale) {
-            return true;
-        }
-        return locale === id;
-    }
-
-    export function setLocale(id: string): void {
-        window.localStorage.setItem(localeId, id);
-    }
-}
-
-interface NlsKeys {
-    [key: string]: (string | NlsInfo)[]
-}
-
-interface NlsInfo {
-    key: string
-    comment: string[]
-}
-
-class LocalizationKeyProvider {
-
-    private preferredKeys = new Set([
-        // We only want the `File` translation used in the menu
-        'vscode/fileActions.contribution/filesCategory',
-        // Needed for `Close Editor` translation
-        'vscode/editor.contribution/closeEditor'
-    ]);
-    private data = this.buildData();
-
-    get(defaultValue: string): string | undefined {
-        const normalized = Localization.normalize(defaultValue);
-        return this.data.get(normalized) || this.data.get(normalized.toUpperCase());
-    }
-
-    /**
-     * Transforms the data coming from the `nls.metadata.json` file into a map.
-     * The original data contains arrays of keys and messages.
-     * The result is a map that matches each message to the key that belongs to it.
-     *
-     * This allows us to skip the key in the localization process and map the original english default values to their translations in different languages.
-     */
-    private buildData(): Map<string, string> {
-        const bundles = require('../../src/common/i18n/nls.metadata.json');
-        const keys: NlsKeys = bundles.keys;
-        const messages: Record<string, string[]> = bundles.messages;
-        const data = new Map<string, string>();
-        const foundPreferredKeys = new Set<string>();
-        const keysAndMessages = this.buildKeyMessageTuples(keys, messages);
-        for (const { key, message } of keysAndMessages) {
-            if (!foundPreferredKeys.has(message)) {
-                data.set(message, key);
-                if (this.preferredKeys.has(key)) {
-                    // Prevent messages with preferred keys to be overridden
-                    foundPreferredKeys.add(message);
-                }
-            }
-        }
-        // Second pass adds each message again in upper case, if the message doesn't already exist in upper case
-        // The second pass is needed to not accidentally override any translations which actually use the upper case message
-        for (const { key, message } of keysAndMessages) {
-            const upperMessage = message.toUpperCase();
-            if (!data.has(upperMessage)) {
-                data.set(upperMessage, key);
-            }
-        }
-        return data;
-    }
-
-    private buildKeyMessageTuples(keys: NlsKeys, messages: Record<string, string[]>): { key: string, message: string }[] {
-        const list: { key: string, message: string }[] = [];
-        for (const [fileKey, messageBundle] of Object.entries(messages)) {
-            const keyBundle = keys[fileKey];
-            for (let i = 0; i < messageBundle.length; i++) {
-                const message = Localization.normalize(messageBundle[i]);
-                const key = keyBundle[i];
-                const localizationKey = this.buildKey(typeof key === 'string' ? key : key.key, fileKey);
-                list.push({
-                    key: localizationKey,
-                    message
-                });
-            }
-        }
-        return list;
-    }
-
-    private buildKey(key: string, filepath: string): string {
-        return `vscode/${Localization.transformKey(filepath)}/${key}`;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 TypeFox 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 { FormatType, Localization } from './i18n/localization';
+
+export namespace nls {
+
+    export let localization: Localization | undefined;
+
+    export const defaultLocale = 'en';
+
+    export const localeId = 'localeId';
+
+    export const locale = typeof window === 'object' && window && window.localStorage.getItem(localeId) || undefined;
+
+    let keyProvider: LocalizationKeyProvider | undefined;
+
+    /**
+     * Automatically localizes a text if that text also exists in the vscode repository.
+     */
+    export function localizeByDefault(defaultValue: string, ...args: FormatType[]): string {
+        if (localization) {
+            const key = getDefaultKey(defaultValue);
+            if (key) {
+                return localize(key, defaultValue, ...args);
+            } else {
+                console.warn(`Could not find translation key for default value: "${defaultValue}"`);
+            }
+        }
+        return Localization.format(defaultValue, args);
+    }
+
+    export function getDefaultKey(defaultValue: string): string {
+        if (!keyProvider) {
+            keyProvider = new LocalizationKeyProvider();
+        }
+        const key = keyProvider.get(defaultValue);
+        if (key) {
+            return key;
+        }
+        return '';
+    }
+
+    export function localize(key: string, defaultValue: string, ...args: FormatType[]): string {
+        return Localization.localize(localization, key, defaultValue, ...args);
+    }
+
+    export function isSelectedLocale(id: string): boolean {
+        if (locale === undefined && id === defaultLocale) {
+            return true;
+        }
+        return locale === id;
+    }
+
+    export function setLocale(id: string): void {
+        window.localStorage.setItem(localeId, id);
+    }
+}
+
+interface NlsKeys {
+    [key: string]: (string | NlsInfo)[]
+}
+
+interface NlsInfo {
+    key: string
+    comment: string[]
+}
+
+class LocalizationKeyProvider {
+
+    private preferredKeys = new Set([
+        // We only want the `File` translation used in the menu
+        'vscode/fileActions.contribution/filesCategory',
+        // Needed for `Close Editor` translation
+        'vscode/editor.contribution/closeEditor'
+    ]);
+    private data = this.buildData();
+
+    get(defaultValue: string): string | undefined {
+        const normalized = Localization.normalize(defaultValue);
+        return this.data.get(normalized) || this.data.get(normalized.toUpperCase());
+    }
+
+    /**
+     * Transforms the data coming from the `nls.metadata.json` file into a map.
+     * The original data contains arrays of keys and messages.
+     * The result is a map that matches each message to the key that belongs to it.
+     *
+     * This allows us to skip the key in the localization process and map the original english default values to their translations in different languages.
+     */
+    private buildData(): Map<string, string> {
+        const bundles = require('../../src/common/i18n/nls.metadata.json');
+        const keys: NlsKeys = bundles.keys;
+        const messages: Record<string, string[]> = bundles.messages;
+        const data = new Map<string, string>();
+        const foundPreferredKeys = new Set<string>();
+        const keysAndMessages = this.buildKeyMessageTuples(keys, messages);
+        for (const { key, message } of keysAndMessages) {
+            if (!foundPreferredKeys.has(message)) {
+                data.set(message, key);
+                if (this.preferredKeys.has(key)) {
+                    // Prevent messages with preferred keys to be overridden
+                    foundPreferredKeys.add(message);
+                }
+            }
+        }
+        // Second pass adds each message again in upper case, if the message doesn't already exist in upper case
+        // The second pass is needed to not accidentally override any translations which actually use the upper case message
+        for (const { key, message } of keysAndMessages) {
+            const upperMessage = message.toUpperCase();
+            if (!data.has(upperMessage)) {
+                data.set(upperMessage, key);
+            }
+        }
+        return data;
+    }
+
+    private buildKeyMessageTuples(keys: NlsKeys, messages: Record<string, string[]>): { key: string, message: string }[] {
+        const list: { key: string, message: string }[] = [];
+        for (const [fileKey, messageBundle] of Object.entries(messages)) {
+            const keyBundle = keys[fileKey];
+            for (let i = 0; i < messageBundle.length; i++) {
+                const message = Localization.normalize(messageBundle[i]);
+                const key = keyBundle[i];
+                const localizationKey = this.buildKey(typeof key === 'string' ? key : key.key, fileKey);
+                list.push({
+                    key: localizationKey,
+                    message
+                });
+            }
+        }
+        return list;
+    }
+
+    private buildKey(key: string, filepath: string): string {
+        return `vscode/${Localization.transformKey(filepath)}/${key}`;
+    }
+}

package/src/common/numbers.ts

@@ -1,21 +1,21 @@
-// *****************************************************************************
-// Copyright (C) 2021 TypeFox 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
-// *****************************************************************************
-
-/**
- * The maximum safe integer (`2^32-1`) is used as a placeholder for large numbers which are not allowed to be floats.
- * For example as line/column arguments for monaco-ranges.
- */
-export const MAX_SAFE_INTEGER = 2147483647;
+// *****************************************************************************
+// Copyright (C) 2021 TypeFox 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
+// *****************************************************************************
+
+/**
+ * The maximum safe integer (`2^32-1`) is used as a placeholder for large numbers which are not allowed to be floats.
+ * For example as line/column arguments for monaco-ranges.
+ */
+export const MAX_SAFE_INTEGER = 2147483647;