@theia/core 1.45.0 → 1.46.0

package/src/common/menu/menu.spec.ts

@@ -14,10 +14,10 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { CommandContribution, CommandRegistry } from '../command';
-import { MenuContribution, MenuModelRegistry } from './menu-model-registry';
 import * as chai from 'chai';
+import { CommandContribution, CommandRegistry } from '../command';
 import { CompositeMenuNode } from './composite-menu-node';
+import { MenuContribution, MenuModelRegistry } from './menu-model-registry';
 
 const expect = chai.expect;
 
@@ -61,6 +61,25 @@ describe('menu-model-registry', () => {
             expect(openGroup.children.length).equals(2);
             expect(openGroup.label).undefined;
         });
+
+        it('Should not allow to register cyclic menus.', () => {
+            const fileMenu = ['main', 'File'];
+            const fileOpenMenu = [...fileMenu, '0_open'];
+            const fileCloseMenu = [...fileMenu, '1_close'];
+            const service = createMenuRegistry({
+                registerMenus(menuRegistry: MenuModelRegistry): void {
+                    menuRegistry.registerSubmenu(fileMenu, 'File');
+                    // open menu should not be added to open menu
+                    menuRegistry.linkSubmenu(fileOpenMenu, fileOpenMenu);
+                    // close menu should be added
+                    menuRegistry.linkSubmenu(fileOpenMenu, fileCloseMenu);
+                }
+            }, {
+                registerCommands(reg: CommandRegistry): void { }
+            });
+            const all = service.getMenu() as CompositeMenuNode;
+            expect(menuStructureToString(all.children[0] as CompositeMenuNode)).equals('File(0_open(1_close),1_close())');
+        });
     });
 });
 
@@ -71,3 +90,12 @@ function createMenuRegistry(menuContrib: MenuContribution, commandContrib: Comma
     menuReg.onStart();
     return menuReg;
 }
+
+function menuStructureToString(node: CompositeMenuNode): string {
+    return node.children.map(c => {
+        if (c instanceof CompositeMenuNode) {
+            return `${c.id}(${menuStructureToString(c)})`;
+        }
+        return c.id;
+    }).join(',');
+}

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

@@ -21,7 +21,7 @@ import { addExtension } from 'msgpackr';
  * 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.
+ * 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();

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

@@ -16,7 +16,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { CancellationToken, CancellationTokenSource } from '../cancellation';
-import { Disposable, DisposableCollection } from '../disposable';
+import { DisposableWrapper, Disposable, DisposableCollection } from '../disposable';
 import { Emitter, Event } from '../event';
 import { Deferred } from '../promise-util';
 import { Channel } from './channel';
@@ -57,6 +57,7 @@ export class RpcProtocol {
     static readonly CANCELLATION_TOKEN_KEY = 'add.cancellation.token';
 
     protected readonly pendingRequests: Map<number, Deferred<any>> = new Map();
+    protected readonly pendingRequestCancellationEventListeners: Map<number, DisposableWrapper> = new Map();
 
     protected nextMessageId: number = 0;
 
@@ -80,6 +81,8 @@ export class RpcProtocol {
         channel.onClose(event => {
             this.pendingRequests.forEach(pending => pending.reject(new Error(event.reason)));
             this.pendingRequests.clear();
+            this.pendingRequestCancellationEventListeners.forEach(disposable => disposable.dispose());
+            this.pendingRequestCancellationEventListeners.clear();
             this.toDispose.dispose();
         });
         this.toDispose.push(channel.onMessage(readBuffer => this.handleMessage(this.decoder.parse(readBuffer()))));
@@ -131,6 +134,7 @@ export class RpcProtocol {
         } else {
             throw new Error(`No reply handler for reply with id: ${id}`);
         }
+        this.disposeCancellationEventListener(id);
     }
 
     protected handleReplyErr(id: number, error: any): void {
@@ -141,6 +145,15 @@ export class RpcProtocol {
         } else {
             throw new Error(`No reply handler for error reply with id: ${id}`);
         }
+        this.disposeCancellationEventListener(id);
+    }
+
+    protected disposeCancellationEventListener(id: number): void {
+        const toDispose = this.pendingRequestCancellationEventListeners.get(id);
+        if (toDispose) {
+            this.pendingRequestCancellationEventListeners.delete(id);
+            toDispose.dispose();
+        }
     }
 
     sendRequest<T>(method: string, args: any[]): Promise<T> {
@@ -157,6 +170,10 @@ export class RpcProtocol {
 
         this.pendingRequests.set(id, reply);
 
+        // register disposable before output.commit() even when not available yet
+        const disposableWrapper = new DisposableWrapper();
+        this.pendingRequestCancellationEventListeners.set(id, disposableWrapper);
+
         const output = this.channel.getWriteBuffer();
         this.encoder.request(output, id, method, args);
         output.commit();
@@ -164,7 +181,10 @@ export class RpcProtocol {
         if (cancellationToken?.isCancellationRequested) {
             this.sendCancel(id);
         } else {
-            cancellationToken?.onCancellationRequested(() => this.sendCancel(id));
+            const disposable = cancellationToken?.onCancellationRequested(() => this.sendCancel(id));
+            if (disposable) {
+                disposableWrapper.set(disposable);
+            }
         }
 
         return reply.promise;

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

@@ -168,14 +168,7 @@ export class RpcProxyFactory<T extends object> implements ProxyHandler<T> {
                 throw new Error(`no target was set to handle ${method}`);
             }
         } catch (error) {
-            const e = this.serializeError(error);
-            if (e instanceof ResponseError) {
-                throw e;
-            }
-            const reason = e.message || '';
-            const stack = e.stack || '';
-            console.error(`Request ${method} failed with error: ${reason}`, stack);
-            throw e;
+            throw this.serializeError(error);
         }
     }
 

package/src/common/quick-pick-service.ts

@@ -131,7 +131,7 @@ export namespace QuickInputButton {
 }
 
 export interface QuickInputButtonHandle extends QuickInputButton {
-    index: number; // index of where they are in buttons array if QuickInputButton or -1 if QuickInputButtons.Back
+    handle: number; // index of where the button is in buttons array if QuickInputButton or -1 if QuickInputButtons.Back
 }
 
 export enum QuickInputHideReason {

package/src/common/uuid.ts

@@ -21,6 +21,8 @@
 
 // based on https://github.com/microsoft/vscode/blob/1.72.2/src/vs/base/common/uuid.ts
 
+import { v5 } from 'uuid';
+
 const _UUIDPattern = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 
 export function isUUID(value: string): boolean {
@@ -97,3 +99,14 @@ export const generateUuid = (function (): () => string {
         return result;
     };
 })();
+
+const NAMESPACE = '4c90ee4f-d952-44b1-83ca-f04121ab8e05';
+/**
+ * This function will hash the given value using SHA1. The result will be a uuid.
+ * @param value the string to hash
+ * @returns a uuid
+ */
+export function hashValue(value: string): string {
+    // as opposed to v4, v5 is deterministic and uses SHA1 hashing
+    return v5(value, NAMESPACE);
+}

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

@@ -24,7 +24,7 @@ import { existsSync, mkdirSync } from 'fs-extra';
 import { fork, ForkOptions } from 'child_process';
 import { DefaultTheme, FrontendApplicationConfig } from '@theia/application-package/lib/application-props';
 import URI from '../common/uri';
-import { FileUri } from '../node/file-uri';
+import { FileUri } from '../common/file-uri';
 import { Deferred } from '../common/promise-util';
 import { MaybePromise } from '../common/types';
 import { ContributionProvider } from '../common/contribution-provider';

package/src/electron-main/theia-electron-window.ts

@@ -22,7 +22,7 @@ import { ElectronMainApplicationGlobals } from './electron-main-constants';
 import { DisposableCollection, Emitter, Event } from '../common';
 import { createDisposableListener } from './event-utils';
 import { URI } from '../common/uri';
-import { FileUri } from '../node/file-uri';
+import { FileUri } from '../common/file-uri';
 import { TheiaRendererAPI } from './electron-api-main';
 
 /**

package/src/node/application-server.ts

@@ -37,11 +37,18 @@ export class ApplicationServerImpl implements ApplicationServer {
             const name = pck.name;
             const version = pck.version;
 
-            return Promise.resolve({ name, version });
+            return Promise.resolve({
+                name,
+                version
+            });
         }
         return Promise.resolve(undefined);
     }
 
+    getApplicationRoot(): Promise<string> {
+        return Promise.resolve(this.applicationPackage.projectPath);
+    }
+
     async getBackendOS(): Promise<OS.Type> {
         return OS.type();
     }

package/src/node/env-variables/env-variables-server.ts

@@ -21,7 +21,7 @@ import * as drivelist from 'drivelist';
 import { pathExists, mkdir } from 'fs-extra';
 import { EnvVariable, EnvVariablesServer } from '../../common/env-variables';
 import { isWindows } from '../../common/os';
-import { FileUri } from '../file-uri';
+import { FileUri } from '../../common/file-uri';
 
 @injectable()
 export class EnvVariablesServerImpl implements EnvVariablesServer {

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

@@ -17,7 +17,7 @@
 import * as os from 'os';
 import * as path from 'path';
 import * as chai from 'chai';
-import { FileUri } from './file-uri';
+import { FileUri } from '../common/file-uri';
 import { isWindows } from '../common/os';
 
 const expect = chai.expect;

package/src/node/index.ts

@@ -16,7 +16,7 @@
 
 export * from './backend-application';
 export * from './debug';
-export * from './file-uri';
+export * from '../common/file-uri';
 export * from './messaging';
 export * from './cli';
 export { FileSystemLocking } from './filesystem-locking';

package/src/node/messaging/websocket-frontend-connection-service.ts

@@ -51,7 +51,9 @@ export class WebsocketFrontendConnectionService implements FrontendConnectionSer
             if (this.connectionsByFrontend.has(frontEndId)) {
                 this.closeConnection(frontEndId, 'reconnecting same front end');
             }
-            channelCreatedHandler(this.createConnection(socket, frontEndId));
+            const channel = this.createConnection(socket, frontEndId);
+            this.handleSocketDisconnect(socket, channel, frontEndId);
+            channelCreatedHandler(channel);
             socket.emit(ConnectionManagementMessages.INITIAL_CONNECT);
         };
 
@@ -63,6 +65,7 @@ export class WebsocketFrontendConnectionService implements FrontendConnectionSer
                 console.info(`Reconnecting to front end ${frontEndId}`);
                 socket.emit(ConnectionManagementMessages.RECONNECT, true);
                 channel.connect(socket);
+                this.handleSocketDisconnect(socket, channel, frontEndId);
                 const pendingTimeout = this.closeTimeouts.get(frontEndId);
                 clearTimeout(pendingTimeout);
                 this.closeTimeouts.delete(frontEndId);
@@ -89,11 +92,16 @@ export class WebsocketFrontendConnectionService implements FrontendConnectionSer
         connection.close();
     }
 
-    protected createConnection(socket: Socket, frontEndId: string): Channel {
+    protected createConnection(socket: Socket, frontEndId: string): ReconnectableSocketChannel {
         console.info(`creating connection for ${frontEndId}`);
         const channel = new ReconnectableSocketChannel();
         channel.connect(socket);
 
+        this.connectionsByFrontend.set(frontEndId, channel);
+        return channel;
+    }
+
+    handleSocketDisconnect(socket: Socket, channel: ReconnectableSocketChannel, frontEndId: string): void {
         socket.on('disconnect', evt => {
             console.info('socked closed');
             channel.disconnect();
@@ -111,9 +119,6 @@ export class WebsocketFrontendConnectionService implements FrontendConnectionSer
                 // timeout < 0: never close the back end
             }
         });
-
-        this.connectionsByFrontend.set(frontEndId, channel);
-        return channel;
     }
 
     markForClose(channelId: string): void {

package/lib/node/file-uri.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-uri.d.ts","sourceRoot":"","sources":["../../src/node/file-uri.ts"],"names":[],"mappings":"AAiBA,OAAO,GAAG,MAAM,eAAe,CAAC;AAGhC,yBAAiB,OAAO,CAAC;IAIrB;;;OAGG;IACH,SAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAE3C;IAED;;;;OAIG;IACH,SAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,MAAM,CAqBhD;CAEJ"}

package/lib/node/file-uri.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-uri.js","sourceRoot":"","sources":["../../src/node/file-uri.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAEhF,2CAAwC;AACxC,uCAAgC;AAChC,qCAAyC;AAEzC,IAAiB,OAAO,CAwCvB;AAxCD,WAAiB,OAAO;IAEpB,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,SAAgB,MAAM,CAAC,OAAe;QAClC,OAAO,IAAI,aAAG,CAAC,gBAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACtC,CAAC;IAFe,cAAM,SAErB,CAAA;IAED;;;;OAIG;IACH,SAAgB,MAAM,CAAC,GAAiB;QACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACzB,OAAO,MAAM,CAAC,IAAI,aAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SAC/B;aAAM;YACH;;;;;;eAMG;YACH,8DAA8D;YAC9D,MAAM,mBAAmB,GAAI,GAAW,CAAC,OAAO,CAAC,MAAM,CAAC;YACxD,IAAI,cAAS,EAAE;gBACX,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;gBACvE,IAAI,kBAAkB,EAAE;oBACpB,OAAO,mBAAmB,GAAG,IAAI,CAAC;iBACrC;aACJ;YACD,OAAO,mBAAmB,CAAC;SAC9B;IACL,CAAC;IArBe,cAAM,SAqBrB,CAAA;AAEL,CAAC,EAxCgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAwCvB"}