@theia/core 1.38.0-next.7 → 1.39.0-next.1

package/src/common/index.ts

@@ -46,4 +46,5 @@ export * from './strings';
 export * from './types';
 export { default as URI } from './uri';
 export * from './view-column';
+export * from './telemetry';
 

package/src/common/logger.ts

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { inject, injectable } from 'inversify';
+import { inject, injectable, postConstruct } from 'inversify';
 import { LoggerWatcher } from './logger-watcher';
 import { ILoggerServer, LogLevel, ConsoleLogger, rootLoggerName } from './logger-protocol';
 
@@ -235,30 +235,28 @@ export class Logger implements ILogger {
     /* A promise resolved when the logger has been created by the backend.  */
     protected created: Promise<void>;
 
-    /**
-     * Build a new Logger.
-     */
-    constructor(
-        @inject(ILoggerServer) protected readonly server: ILoggerServer,
-        @inject(LoggerWatcher) protected readonly loggerWatcher: LoggerWatcher,
-        @inject(LoggerFactory) protected readonly factory: LoggerFactory,
-        @inject(LoggerName) protected name: string) {
+    @inject(ILoggerServer) protected readonly server: ILoggerServer;
+    @inject(LoggerWatcher) protected readonly loggerWatcher: LoggerWatcher;
+    @inject(LoggerFactory) protected readonly factory: LoggerFactory;
+    @inject(LoggerName) protected name: string;
 
-        if (name !== rootLoggerName) {
+    @postConstruct()
+    protected init(): void {
+        if (this.name !== rootLoggerName) {
             /* Creating a child logger.  */
-            this.created = server.child(name);
+            this.created = this.server.child(this.name);
         } else {
             /* Creating the root logger (it already exists at startup).  */
             this.created = Promise.resolve();
         }
 
         /* Fetch the log level so it's cached in the frontend.  */
-        this._logLevel = this.created.then(_ => this.server.getLogLevel(name));
+        this._logLevel = this.created.then(_ => this.server.getLogLevel(this.name));
 
         /* Update the log level if it changes in the backend. */
-        loggerWatcher.onLogLevelChanged(event => {
+        this.loggerWatcher.onLogLevelChanged(event => {
             this.created.then(() => {
-                if (event.loggerName === name) {
+                if (event.loggerName === this.name) {
                     this._logLevel = Promise.resolve(event.newLogLevel);
                 }
             });

package/src/common/messaging/proxy-factory.ts

@@ -241,6 +241,10 @@ export class JsonRpcProxyFactory<T extends object> implements ProxyHandler<T> {
         if (p === 'onDidCloseConnection') {
             return this.onDidCloseConnectionEmitter.event;
         }
+        if (p === 'then') {
+            // Prevent inversify from identifying this proxy as a promise object.
+            return undefined;
+        }
         const isNotify = this.isNotification(p);
         return (...args: any[]) => {
             const method = p.toString();

package/src/common/objects.ts

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { isObject } from './types';
+import { isObject, isUndefined } from './types';
 
 export function deepClone<T>(obj: T): T {
     if (!isObject(obj)) {
@@ -70,3 +70,50 @@ export function notEmpty<T>(arg: T | undefined | null): arg is T {
 export function isEmpty(arg: Object): boolean {
     return Object.keys(arg).length === 0 && arg.constructor === Object;
 }
+
+// copied and modified from https://github.com/microsoft/vscode/blob/1.76.0/src/vs/base/common/objects.ts#L45-L83
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function cloneAndChange(obj: any, changer: (orig: any) => any, seen: Set<any>): any {
+    // impossible to clone an undefined or null object
+    // eslint-disable-next-line no-null/no-null
+    if (isUndefined(obj) || obj === null) {
+        return obj;
+    }
+
+    const changed = changer(obj);
+    if (!isUndefined(changed)) {
+        return changed;
+    }
+
+    if (Array.isArray(obj)) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const r1: any[] = [];
+        for (const e of obj) {
+            r1.push(cloneAndChange(e, changer, seen));
+        }
+        return r1;
+    }
+
+    if (isObject(obj)) {
+        if (seen.has(obj)) {
+            throw new Error('Cannot clone recursive data-structure');
+        }
+        seen.add(obj);
+        const r2 = {};
+        for (const i2 in obj) {
+            if (_hasOwnProperty.call(obj, i2)) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                (r2 as any)[i2] = cloneAndChange(obj[i2], changer, seen);
+            }
+        }
+        seen.delete(obj);
+        return r2;
+    }
+
+    return obj;
+}

package/src/common/path.ts

@@ -51,12 +51,12 @@ export class Path {
         if (path.length >= 3 && path.charCodeAt(0) === 47 /* '/' */ && path.charCodeAt(2) === 58 /* ':' */) {
             const code = path.charCodeAt(1);
             if (code >= 65 /* A */ && code <= 90 /* Z */) {
-                path = `/${String.fromCharCode(code + 32)}:${path.substr(3)}`; // "/c:".length === 3
+                path = `/${String.fromCharCode(code + 32)}:${path.substring(3)}`; // "/c:".length === 3
             }
         } else if (path.length >= 2 && path.charCodeAt(1) === 58 /* ':' */) {
             const code = path.charCodeAt(0);
             if (code >= 65 /* A */ && code <= 90 /* Z */) {
-                path = `${String.fromCharCode(code + 32)}:${path.substr(2)}`; // "c:".length === 2
+                path = `${String.fromCharCode(code + 32)}:${path.substring(2)}`; // "c:".length === 2
             }
             if (path.charCodeAt(0) !== 47 /* '/' */) {
                 path = `${String.fromCharCode(47)}${path}`;
@@ -147,13 +147,13 @@ export class Path {
         const firstIndex = this.raw.indexOf(Path.separator);
         const lastIndex = this.raw.lastIndexOf(Path.separator);
         this.isAbsolute = firstIndex === 0;
-        this.base = lastIndex === -1 ? this.raw : this.raw.substr(lastIndex + 1);
+        this.base = lastIndex === -1 ? this.raw : this.raw.substring(lastIndex + 1);
         this.isRoot = this.isAbsolute && firstIndex === lastIndex && (!this.base || Path.isDrive(this.base));
         this.root = this.computeRoot();
 
         const extIndex = this.base.lastIndexOf('.');
-        this.name = extIndex === -1 ? this.base : this.base.substr(0, extIndex);
-        this.ext = extIndex === -1 ? '' : this.base.substr(extIndex);
+        this.name = extIndex === -1 ? this.base : this.base.substring(0, extIndex);
+        this.ext = extIndex === -1 ? '' : this.base.substring(extIndex);
     }
 
     protected computeRoot(): Path | undefined {
@@ -173,7 +173,7 @@ export class Path {
         }
         // '/c:/foo/bar' -> '/c:'
         // '/foo/bar' -> '/'
-        return new Path(this.raw.substr(0, index)).root;
+        return new Path(this.raw.substring(0, index)).root;
     }
 
     /**
@@ -204,10 +204,10 @@ export class Path {
         if (this.isAbsolute) {
             const firstIndex = this.raw.indexOf(Path.separator);
             if (firstIndex === lastIndex) {
-                return new Path(this.raw.substr(0, firstIndex + 1));
+                return new Path(this.raw.substring(0, firstIndex + 1));
             }
         }
-        return new Path(this.raw.substr(0, lastIndex));
+        return new Path(this.raw.substring(0, lastIndex));
     }
 
     join(...paths: string[]): Path {
@@ -274,7 +274,7 @@ export class Path {
         if (!path.raw.startsWith(raw)) {
             return undefined;
         }
-        const relativePath = path.raw.substr(raw.length);
+        const relativePath = path.raw.substring(raw.length);
         return new Path(relativePath);
     }
 

package/src/common/paths.ts

@@ -55,7 +55,7 @@ export function basename(path: string): string {
     } else if (~idx === path.length - 1) {
         return basename(path.substring(0, path.length - 1));
     } else {
-        return path.substr(~idx + 1);
+        return path.substring(~idx + 1);
     }
 }
 

package/src/common/performance/stopwatch.ts

@@ -50,7 +50,7 @@ export abstract class Stopwatch {
     @inject(ILogger)
     protected readonly logger: ILogger;
 
-    protected constructor(protected readonly defaultLogOptions: LogOptions) {
+    constructor(protected readonly defaultLogOptions: LogOptions) {
         if (!defaultLogOptions.defaultLogLevel) {
             defaultLogOptions.defaultLogLevel = DEFAULT_LOG_LEVEL;
         }

package/src/common/severity.ts

@@ -101,7 +101,7 @@ export namespace Severity {
         } else if (severity === Severity.Log || severity === log) {
             return nls.localize('theia/core/severity/log', 'Log');
         } else {
-            return nls.localize('theia/core/severity/all', 'All');
+            return nls.localizeByDefault('All');
         }
     }
 

package/src/common/telemetry.ts

@@ -0,0 +1,45 @@
+// *****************************************************************************
+// Copyright (C) 2023 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export class TelemetryTrustedValue<T> {
+    readonly value: T;
+
+    constructor(value: T) {
+        this.value = value;
+    }
+}
+
+export interface TelemetryLogger {
+    readonly sender: TelemetrySender;
+    readonly options: TelemetryLoggerOptions | undefined;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    logUsage(eventName: string, data?: Record<string, any | TelemetryTrustedValue<any>>): void;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    logError(eventNameOrException: string | Error, data?: Record<string, any | TelemetryTrustedValue<any>>): void;
+
+    dispose(): void;
+}
+
+interface TelemetrySender {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    sendEventData(eventName: string, data?: Record<string, any>): void;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    sendErrorData(error: Error, data?: Record<string, any>): void;
+    flush?(): void | Thenable<void>;
+}
+
+interface TelemetryLoggerOptions {
+}

package/src/electron-browser/keyboard/electron-keyboard-layout-change-notifier.ts

@@ -32,7 +32,7 @@ export class ElectronKeyboardLayoutChangeNotifier implements KeyboardLayoutChang
     }
 
     @postConstruct()
-    protected initialize(): void {
+    protected init(): void {
         window.electronTheiaCore.onKeyboardLayoutChanged((newLayout: NativeKeyboardLayout) => this.nativeLayoutChanged.fire(newLayout));
     }
 

package/src/electron-browser/menu/electron-context-menu-renderer.ts

@@ -90,7 +90,11 @@ export class ElectronContextMenuRenderer extends BrowserContextMenuRenderer {
     }
 
     @postConstruct()
-    protected async init(): Promise<void> {
+    protected init(): void {
+        this.doInit();
+    }
+
+    protected async doInit(): Promise<void> {
         this.useNativeStyle = await window.electronTheiaCore.getTitleBarStyleAtStartup() === 'native';
     }
 

package/src/electron-browser/menu/electron-main-menu-factory.ts

@@ -35,6 +35,12 @@ export interface ElectronMenuOptions {
      * Defaults to `true`.
      */
     readonly showDisabled?: boolean;
+
+    /**
+     * Controls whether to render disabled items as disabled
+     * Defaults to `true`
+     */
+    readonly honorDisabled?: boolean;
     /**
      * A DOM context to use when evaluating any `when` clauses
      * of menu items registered for this item.
@@ -108,7 +114,7 @@ export class ElectronMainMenuFactory extends BrowserMainMenuFactory {
         const maxWidget = document.getElementsByClassName(MAXIMIZED_CLASS);
         if (preference === 'visible' || (preference === 'classic' && maxWidget.length === 0)) {
             const menuModel = this.menuProvider.getMenu(MAIN_MENU_BAR);
-            this._menu = this.fillMenuTemplate([], menuModel, [], { rootMenuPath: MAIN_MENU_BAR });
+            this._menu = this.fillMenuTemplate([], menuModel, [], { honorDisabled: false, rootMenuPath: MAIN_MENU_BAR });
             if (isOSX) {
                 this._menu.unshift(this.createOSXMenu());
             }
@@ -121,7 +127,7 @@ export class ElectronMainMenuFactory extends BrowserMainMenuFactory {
 
     createElectronContextMenu(menuPath: MenuPath, args?: any[], context?: HTMLElement, contextKeyService?: ContextMatcher): MenuDto[] {
         const menuModel = this.menuProvider.getMenu(menuPath);
-        return this.fillMenuTemplate([], menuModel, args, { showDisabled: false, context, rootMenuPath: menuPath, contextKeyService });
+        return this.fillMenuTemplate([], menuModel, args, { showDisabled: true, context, rootMenuPath: menuPath, contextKeyService });
     }
 
     protected fillMenuTemplate(parentItems: MenuDto[],
@@ -130,6 +136,7 @@ export class ElectronMainMenuFactory extends BrowserMainMenuFactory {
         options: ElectronMenuOptions
     ): MenuDto[] {
         const showDisabled = options?.showDisabled !== false;
+        const honorDisabled = options?.honorDisabled !== false;
 
         if (CompoundMenuNode.is(menu) && menu.children.length && this.undefinedOrMatch(options.contextKeyService ?? this.contextKeyService, menu.when, options.context)) {
             const role = CompoundMenuNode.getRole(menu);
@@ -181,7 +188,7 @@ export class ElectronMainMenuFactory extends BrowserMainMenuFactory {
                 label: node.label,
                 type: this.commandRegistry.getToggledHandler(commandId, ...args) ? 'checkbox' : 'normal',
                 checked: this.commandRegistry.isToggled(commandId, ...args),
-                enabled: true, // https://github.com/eclipse-theia/theia/issues/446
+                enabled: !honorDisabled || this.commandRegistry.isEnabled(commandId, ...args), // see https://github.com/eclipse-theia/theia/issues/446
                 visible: true,
                 accelerator,
                 execute: () => this.execute(commandId, args, options.rootMenuPath)

package/src/electron-browser/preload.ts

@@ -71,7 +71,7 @@ const api: TheiaCoreAPI = {
         commandHandlers.set(mainMenuId, handlers);
         ipcRenderer.send(CHANNEL_SET_MENU, mainMenuId, convertMenu(menu, handlers));
     },
-    getSecurityToken: () => ipcRenderer.invoke(CHANNEL_GET_SECURITY_TOKEN),
+    getSecurityToken: () => ipcRenderer.sendSync(CHANNEL_GET_SECURITY_TOKEN),
     focusWindow: (name: string) => ipcRenderer.send(CHANNEL_FOCUS_WINDOW, name),
     showItemInFolder: fsPath => {
         ipcRenderer.send(CHANNEL_SHOW_ITEM_IN_FOLDER, fsPath);

package/src/electron-common/electron-api.ts

@@ -41,7 +41,7 @@ export type InternalMenuDto = Omit<MenuDto, 'execute' | 'submenu'> & {
 export type WindowEvent = 'maximize' | 'unmaximize' | 'focus';
 
 export interface TheiaCoreAPI {
-    getSecurityToken: () => Promise<string>;
+    getSecurityToken: () => string;
     attachSecurityToken: (endpoint: string) => Promise<void>;
 
     setMenuBarVisible(visible: boolean, windowName?: string): void;

package/src/electron-main/electron-api-main.ts

@@ -64,7 +64,9 @@ export class TheiaMainApi implements ElectronMainApplicationContribution {
 
     onStart(application: ElectronMainApplication): MaybePromise<void> {
         // electron security token
-        ipcMain.handle(CHANNEL_GET_SECURITY_TOKEN, () => this.electronSecurityToken.value);
+        ipcMain.on(CHANNEL_GET_SECURITY_TOKEN, event => {
+            event.returnValue = this.electronSecurityToken.value;
+        });
 
         ipcMain.handle(CHANNEL_ATTACH_SECURITY_TOKEN, (event, endpoint) => session.defaultSession.cookies.set({
             url: endpoint,

package/src/electron-node/token/electron-token-validator.ts

@@ -31,7 +31,7 @@ export class ElectronTokenValidator implements WsRequestValidatorContribution {
     protected electronSecurityToken: ElectronSecurityToken;
 
     @postConstruct()
-    protected postConstruct(): void {
+    protected init(): void {
         this.electronSecurityToken = this.getToken();
     }
 

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

@@ -40,6 +40,7 @@ import { ProxyCliContribution } from './request/proxy-cli-contribution';
 import { bindNodeStopwatch, bindBackendStopwatchServer } from './performance';
 import { OSBackendApplicationContribution } from './os-backend-application-contribution';
 import { BackendRequestFacade } from './request/backend-request-facade';
+import { FileSystemLocking, FileSystemLockingImpl } from './filesystem-locking';
 
 decorate(injectable(), ApplicationPackage);
 
@@ -128,4 +129,6 @@ export const backendApplicationModule = new ContainerModule(bind => {
 
     bindNodeStopwatch(bind);
     bindBackendStopwatchServer(bind);
+
+    bind(FileSystemLocking).to(FileSystemLockingImpl).inSingletonScope();
 });

package/src/node/backend-application.ts

@@ -196,6 +196,10 @@ export class BackendApplication {
     }
 
     @postConstruct()
+    protected init(): void {
+        this.configure();
+    }
+
     protected async configure(): Promise<void> {
         // Do not await the initialization because contributions are expected to handle
         // concurrent initialize/configure in undefined order if they provide both

package/src/node/filesystem-locking.ts

@@ -0,0 +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 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

@@ -39,7 +39,7 @@ export class BackendApplicationHosts {
     }
 
     @postConstruct()
-    protected postConstruct(): void {
+    protected init(): void {
         const theiaHostsEnv = process.env['THEIA_HOSTS'];
         if (theiaHostsEnv) {
             theiaHostsEnv.split(',').forEach(host => {

package/src/node/index.ts

@@ -19,3 +19,4 @@ export * from './debug';
 export * from './file-uri';
 export * from './messaging';
 export * from './cli';
+export { FileSystemLocking } from './filesystem-locking';

package/src/node/messaging/ipc-connection-provider.ts

@@ -90,7 +90,7 @@ export class IPCConnectionProvider {
         const inspectArgPrefix = `--${options.serverName}-inspect`;
         const inspectArg = process.argv.find(v => v.startsWith(inspectArgPrefix));
         if (inspectArg !== undefined) {
-            forkOptions.execArgv = ['--nolazy', `--inspect${inspectArg.substr(inspectArgPrefix.length)}`];
+            forkOptions.execArgv = ['--nolazy', `--inspect${inspectArg.substring(inspectArgPrefix.length)}`];
         }
 
         const childProcess = cp.fork(path.join(__dirname, 'ipc-bootstrap'), options.args, forkOptions);