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

package/src/node/environment-utils.ts

@@ -1,66 +1,66 @@
-// *****************************************************************************
-// Copyright (C) 2021 Ericsson 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 { injectable } from 'inversify';
-
-@injectable()
-export class EnvironmentUtils {
-
-    /**
-     * Merge a given record of environment variables with the process environment variables.
-     * Empty string values will not be included in the final env.
-     * @param env desired environment to merge with `process.env`.
-     * @returns a normalized merged record of valid environment variables.
-     */
-    mergeProcessEnv(env: Record<string, string | null> = {}): Record<string, string> {
-        env = this.normalizeEnv(env);
-        // eslint-disable-next-line no-null/no-null
-        const mergedEnv: Record<string, string> = Object.create(null);
-        for (const [key, value] of Object.entries(this.normalizeEnv(process.env))) {
-            // Ignore keys from `process.env` that are overridden in `env`. Accept only non-empty strings.
-            if (!(key in env) && value) { mergedEnv[key] = value; }
-        }
-        for (const [key, value] of Object.entries(env)) {
-            // Accept only non-empty strings from the `env` object.
-            if (value) { mergedEnv[key] = value; }
-        }
-        return mergedEnv;
-    }
-
-    /**
-     * Normalize an environment record for a given OS.
-     *
-     * On Windows it will uppercase all keys.
-     *
-     * @param env Environment variables map to normalize.
-     * @param platform Platform to normalize for.
-     * @returns New object with normalized environment variables.
-     */
-    normalizeEnv<T>(env: Record<string, T>): Record<string, T> {
-        if (this.getPlatform() !== 'win32') {
-            return { ...env };
-        }
-        const normalized: Record<string, T> = {};
-        for (const [key, value] of Object.entries(env)) {
-            normalized[key.toLocaleUpperCase()] = value;
-        }
-        return normalized;
-    }
-
-    protected getPlatform(): NodeJS.Platform {
-        return process.platform;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 Ericsson 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 { injectable } from 'inversify';
+
+@injectable()
+export class EnvironmentUtils {
+
+    /**
+     * Merge a given record of environment variables with the process environment variables.
+     * Empty string values will not be included in the final env.
+     * @param env desired environment to merge with `process.env`.
+     * @returns a normalized merged record of valid environment variables.
+     */
+    mergeProcessEnv(env: Record<string, string | null> = {}): Record<string, string> {
+        env = this.normalizeEnv(env);
+        // eslint-disable-next-line no-null/no-null
+        const mergedEnv: Record<string, string> = Object.create(null);
+        for (const [key, value] of Object.entries(this.normalizeEnv(process.env))) {
+            // Ignore keys from `process.env` that are overridden in `env`. Accept only non-empty strings.
+            if (!(key in env) && value) { mergedEnv[key] = value; }
+        }
+        for (const [key, value] of Object.entries(env)) {
+            // Accept only non-empty strings from the `env` object.
+            if (value) { mergedEnv[key] = value; }
+        }
+        return mergedEnv;
+    }
+
+    /**
+     * Normalize an environment record for a given OS.
+     *
+     * On Windows it will uppercase all keys.
+     *
+     * @param env Environment variables map to normalize.
+     * @param platform Platform to normalize for.
+     * @returns New object with normalized environment variables.
+     */
+    normalizeEnv<T>(env: Record<string, T>): Record<string, T> {
+        if (this.getPlatform() !== 'win32') {
+            return { ...env };
+        }
+        const normalized: Record<string, T> = {};
+        for (const [key, value] of Object.entries(env)) {
+            normalized[key.toLocaleUpperCase()] = value;
+        }
+        return normalized;
+    }
+
+    protected getPlatform(): NodeJS.Platform {
+        return process.platform;
+    }
+}

package/src/node/file-uri.spec.ts

@@ -1,76 +1,76 @@
-// *****************************************************************************
-// Copyright (C) 2017 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 * as os from 'os';
-import * as path from 'path';
-import * as chai from 'chai';
-import { FileUri } from '../common/file-uri';
-import { isWindows } from '../common/os';
-
-const expect = chai.expect;
-
-describe('file-uri', () => {
-
-    const filePaths: string[] = ['with.txt', 'with spaces.txt', 'with:colon.txt', 'with_Ö.txt'].map(filePath => path.join(os.tmpdir(), 'file-uri-folder', filePath));
-
-    it('create -> fsPath -> create should be symmetric', () => {
-        const orderedPaths = filePaths.map(filePath => filePath.toLowerCase()).sort();
-        expect(orderedPaths.map(filePath => FileUri.create(filePath)).map(uri => FileUri.fsPath(uri).toLowerCase()).sort()).to.be.deep.equal(orderedPaths);
-    });
-
-    it('fsPath -> create -> fsPath should be symmetric', () => {
-        filePaths.forEach(filePath => {
-            const expectedUri = FileUri.create(filePath);
-            const convertedPath = FileUri.fsPath(expectedUri);
-            const actualUri = FileUri.create(convertedPath);
-            expect(actualUri.toString()).to.be.equal(expectedUri.toString());
-        });
-    });
-
-    it('from /', () => {
-        const uri = FileUri.create('/');
-        expect(uri.toString(true)).to.be.equal('file:///');
-    });
-
-    it('from //', () => {
-        const uri = FileUri.create('//');
-        expect(uri.toString(true)).to.be.equal('file:///');
-    });
-
-    it('from c:', () => {
-        const uri = FileUri.create('c:');
-        expect(uri.toString(true)).to.be.equal('file:///c:');
-    });
-
-    it('from /c:', () => {
-        const uri = FileUri.create('/c:');
-        expect(uri.toString(true)).to.be.equal('file:///c:');
-    });
-
-    it('from /c:/', () => {
-        const uri = FileUri.create('/c:/');
-        expect(uri.toString(true)).to.be.equal('file:///c:/');
-    });
-
-    it('from file:///c%3A', function (): void {
-        if (!isWindows) {
-            this.skip();
-            return;
-        }
-        const fsPath = FileUri.fsPath('file:///c%3A');
-        expect(fsPath).to.be.equal('c:\\');
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2017 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 * as os from 'os';
+import * as path from 'path';
+import * as chai from 'chai';
+import { FileUri } from '../common/file-uri';
+import { isWindows } from '../common/os';
+
+const expect = chai.expect;
+
+describe('file-uri', () => {
+
+    const filePaths: string[] = ['with.txt', 'with spaces.txt', 'with:colon.txt', 'with_Ö.txt'].map(filePath => path.join(os.tmpdir(), 'file-uri-folder', filePath));
+
+    it('create -> fsPath -> create should be symmetric', () => {
+        const orderedPaths = filePaths.map(filePath => filePath.toLowerCase()).sort();
+        expect(orderedPaths.map(filePath => FileUri.create(filePath)).map(uri => FileUri.fsPath(uri).toLowerCase()).sort()).to.be.deep.equal(orderedPaths);
+    });
+
+    it('fsPath -> create -> fsPath should be symmetric', () => {
+        filePaths.forEach(filePath => {
+            const expectedUri = FileUri.create(filePath);
+            const convertedPath = FileUri.fsPath(expectedUri);
+            const actualUri = FileUri.create(convertedPath);
+            expect(actualUri.toString()).to.be.equal(expectedUri.toString());
+        });
+    });
+
+    it('from /', () => {
+        const uri = FileUri.create('/');
+        expect(uri.toString(true)).to.be.equal('file:///');
+    });
+
+    it('from //', () => {
+        const uri = FileUri.create('//');
+        expect(uri.toString(true)).to.be.equal('file:///');
+    });
+
+    it('from c:', () => {
+        const uri = FileUri.create('c:');
+        expect(uri.toString(true)).to.be.equal('file:///c:');
+    });
+
+    it('from /c:', () => {
+        const uri = FileUri.create('/c:');
+        expect(uri.toString(true)).to.be.equal('file:///c:');
+    });
+
+    it('from /c:/', () => {
+        const uri = FileUri.create('/c:/');
+        expect(uri.toString(true)).to.be.equal('file:///c:/');
+    });
+
+    it('from file:///c%3A', function (): void {
+        if (!isWindows) {
+            this.skip();
+            return;
+        }
+        const fsPath = FileUri.fsPath('file:///c%3A');
+        expect(fsPath).to.be.equal('c:\\');
+    });
+});

package/src/node/filesystem-locking.ts

@@ -1,77 +1,77 @@
-// *****************************************************************************
-// Copyright (C) 2023 Ericsson 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 { Mutex } from 'async-mutex';
-import { injectable, interfaces } from 'inversify';
-import * as path from 'path';
-
-export const FileSystemLocking = Symbol('FileSystemLocking') as symbol & interfaces.Abstract<FileSystemLocking>;
-/**
- * Use this backend service to help prevent race access to files on disk.
- */
-export interface FileSystemLocking {
-    /**
-     * Get exclusive access to a file for reading and/or writing.
-     * @param lockPath The path to request exclusive access to.
-     * @param transaction The job to do while having exclusive access.
-     * @param thisArg `this` argument used when calling `transaction`.
-     */
-    lockPath<T>(lockPath: string, transaction: (lockPath: string) => T | Promise<T>, thisArg?: unknown): Promise<T>;
-}
-
-@injectable()
-export class FileSystemLockingImpl implements FileSystemLocking {
-
-    lockPath<T>(lockPath: string, transaction: (lockPath: string) => T | Promise<T>, thisArg?: unknown): Promise<T> {
-        const resolvedLockPath = this.resolveLockPath(lockPath);
-        return this.getLock(resolvedLockPath).runExclusive(async () => transaction.call(thisArg, resolvedLockPath));
-    }
-
-    protected resolveLockPath(lockPath: string): string {
-        // try to normalize the path to avoid two paths pointing to the same file
-        return path.resolve(lockPath);
-    }
-
-    protected getLocks(): Map<string, Mutex> {
-        const kLocks = Symbol.for('FileSystemLockingImpl.Locks');
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return (globalThis as any)[kLocks] ??= this.initializeLocks();
-    }
-
-    protected initializeLocks(): Map<string, Mutex> {
-        const locks = new Map();
-        const cleanup = setInterval(() => this.cleanupLocks(locks), 60_000);
-        process.once('beforeExit', () => clearInterval(cleanup));
-        return locks;
-    }
-
-    protected cleanupLocks(locks: Map<string, Mutex>): void {
-        locks.forEach((lock, lockPath) => {
-            if (!lock.isLocked()) {
-                locks.delete(lockPath);
-            }
-        });
-    }
-
-    protected getLock(lockPath: string): Mutex {
-        const locks = this.getLocks();
-        let lock = locks.get(lockPath);
-        if (!lock) {
-            locks.set(lockPath, lock = new Mutex());
-        }
-        return lock;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson 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 { Mutex } from 'async-mutex';
+import { injectable, interfaces } from 'inversify';
+import * as path from 'path';
+
+export const FileSystemLocking = Symbol('FileSystemLocking') as symbol & interfaces.Abstract<FileSystemLocking>;
+/**
+ * Use this backend service to help prevent race access to files on disk.
+ */
+export interface FileSystemLocking {
+    /**
+     * Get exclusive access to a file for reading and/or writing.
+     * @param lockPath The path to request exclusive access to.
+     * @param transaction The job to do while having exclusive access.
+     * @param thisArg `this` argument used when calling `transaction`.
+     */
+    lockPath<T>(lockPath: string, transaction: (lockPath: string) => T | Promise<T>, thisArg?: unknown): Promise<T>;
+}
+
+@injectable()
+export class FileSystemLockingImpl implements FileSystemLocking {
+
+    lockPath<T>(lockPath: string, transaction: (lockPath: string) => T | Promise<T>, thisArg?: unknown): Promise<T> {
+        const resolvedLockPath = this.resolveLockPath(lockPath);
+        return this.getLock(resolvedLockPath).runExclusive(async () => transaction.call(thisArg, resolvedLockPath));
+    }
+
+    protected resolveLockPath(lockPath: string): string {
+        // try to normalize the path to avoid two paths pointing to the same file
+        return path.resolve(lockPath);
+    }
+
+    protected getLocks(): Map<string, Mutex> {
+        const kLocks = Symbol.for('FileSystemLockingImpl.Locks');
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return (globalThis as any)[kLocks] ??= this.initializeLocks();
+    }
+
+    protected initializeLocks(): Map<string, Mutex> {
+        const locks = new Map();
+        const cleanup = setInterval(() => this.cleanupLocks(locks), 60_000);
+        process.once('beforeExit', () => clearInterval(cleanup));
+        return locks;
+    }
+
+    protected cleanupLocks(locks: Map<string, Mutex>): void {
+        locks.forEach((lock, lockPath) => {
+            if (!lock.isLocked()) {
+                locks.delete(lockPath);
+            }
+        });
+    }
+
+    protected getLock(lockPath: string): Mutex {
+        const locks = this.getLocks();
+        let lock = locks.get(lockPath);
+        if (!lock) {
+            locks.set(lockPath, lock = new Mutex());
+        }
+        return lock;
+    }
+}

package/src/node/hosting/backend-application-hosts.ts

@@ -1,60 +1,60 @@
-// *****************************************************************************
-// Copyright (C) 2020 Ericsson 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 { injectable, postConstruct } from 'inversify';
-
-/**
- * **Important: This component is not bound on Electron.**
- *
- * Component handling the different hosts the Theia backend should be reachable at.
- *
- * Hosts should be set through the `THEIA_HOSTS` environment variable as a comma-separated list of hosts.
- *
- * If you do not set this variable, we'll consider that we don't know where the application is hosted at.
- */
-@injectable()
-export class BackendApplicationHosts {
-
-    protected readonly _hosts = new Set<string>();
-    /**
-     * Set of domains that the application is supposed to be reachable at.
-     * If the set is empty it means that we don't know where we are hosted.
-     * You can check for this with `.hasKnownHosts()`.
-     */
-    get hosts(): ReadonlySet<string> {
-        return this._hosts;
-    }
-
-    @postConstruct()
-    protected init(): void {
-        const theiaHostsEnv = process.env['THEIA_HOSTS'];
-        if (theiaHostsEnv) {
-            theiaHostsEnv.split(',').forEach(host => {
-                const trimmed = host.trim();
-                if (trimmed.length > 0) {
-                    this._hosts.add(trimmed);
-                }
-            });
-        }
-    }
-
-    /**
-     * Do we know where we are hosted?
-     */
-    hasKnownHosts(): boolean {
-        return this._hosts.size > 0;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2020 Ericsson 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 { injectable, postConstruct } from 'inversify';
+
+/**
+ * **Important: This component is not bound on Electron.**
+ *
+ * Component handling the different hosts the Theia backend should be reachable at.
+ *
+ * Hosts should be set through the `THEIA_HOSTS` environment variable as a comma-separated list of hosts.
+ *
+ * If you do not set this variable, we'll consider that we don't know where the application is hosted at.
+ */
+@injectable()
+export class BackendApplicationHosts {
+
+    protected readonly _hosts = new Set<string>();
+    /**
+     * Set of domains that the application is supposed to be reachable at.
+     * If the set is empty it means that we don't know where we are hosted.
+     * You can check for this with `.hasKnownHosts()`.
+     */
+    get hosts(): ReadonlySet<string> {
+        return this._hosts;
+    }
+
+    @postConstruct()
+    protected init(): void {
+        const theiaHostsEnv = process.env['THEIA_HOSTS'];
+        if (theiaHostsEnv) {
+            theiaHostsEnv.split(',').forEach(host => {
+                const trimmed = host.trim();
+                if (trimmed.length > 0) {
+                    this._hosts.add(trimmed);
+                }
+            });
+        }
+    }
+
+    /**
+     * Do we know where we are hosted?
+     */
+    hasKnownHosts(): boolean {
+        return this._hosts.size > 0;
+    }
+}

package/src/node/hosting/backend-hosting-module.ts

@@ -1,26 +1,26 @@
-// *****************************************************************************
-// Copyright (C) 2020 Ericsson 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 { ContainerModule } from 'inversify';
-import { WsRequestValidatorContribution } from '../ws-request-validators';
-import { BackendApplicationHosts } from './backend-application-hosts';
-import { WsOriginValidator } from './ws-origin-validator';
-
-export default new ContainerModule(bind => {
-    bind(BackendApplicationHosts).toSelf().inSingletonScope();
-    bind(WsOriginValidator).toSelf().inSingletonScope();
-    bind(WsRequestValidatorContribution).toService(WsOriginValidator);
-});
+// *****************************************************************************
+// Copyright (C) 2020 Ericsson 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 { ContainerModule } from 'inversify';
+import { WsRequestValidatorContribution } from '../ws-request-validators';
+import { BackendApplicationHosts } from './backend-application-hosts';
+import { WsOriginValidator } from './ws-origin-validator';
+
+export default new ContainerModule(bind => {
+    bind(BackendApplicationHosts).toSelf().inSingletonScope();
+    bind(WsOriginValidator).toSelf().inSingletonScope();
+    bind(WsRequestValidatorContribution).toService(WsOriginValidator);
+});