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

package/src/electron-main/messaging/electron-messaging-service.ts

@@ -1,35 +1,35 @@
-// *****************************************************************************
-// 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 { Channel } from '../../common/message-rpc/channel';
-
-export interface ElectronMessagingService {
-    /**
-     * Accept an ipc channel on the given path.
-     * A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.
-     */
-    ipcChannel(path: string, callback: (params: ElectronMessagingService.PathParams, socket: Channel) => void): void;
-}
-
-export namespace ElectronMessagingService {
-    export interface PathParams {
-        [name: string]: string
-    }
-    export const Contribution = Symbol('ElectronMessagingService.Contribution');
-    export interface Contribution {
-        configure(service: ElectronMessagingService): void;
-    }
-}
+// *****************************************************************************
+// 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 { Channel } from '../../common/message-rpc/channel';
+
+export interface ElectronMessagingService {
+    /**
+     * Accept an ipc channel on the given path.
+     * A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.
+     */
+    ipcChannel(path: string, callback: (params: ElectronMessagingService.PathParams, socket: Channel) => void): void;
+}
+
+export namespace ElectronMessagingService {
+    export interface PathParams {
+        [name: string]: string
+    }
+    export const Contribution = Symbol('ElectronMessagingService.Contribution');
+    export interface Contribution {
+        configure(service: ElectronMessagingService): void;
+    }
+}

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

@@ -1,214 +1,219 @@
-// *****************************************************************************
-// Copyright (C) 2022 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 { FrontendApplicationConfig } from '@theia/application-package';
-import { FrontendApplicationState, StopReason } from '../common/frontend-application-state';
-import { BrowserWindow, BrowserWindowConstructorOptions } from '../../electron-shared/electron';
-import { inject, injectable, postConstruct } from '../../shared/inversify';
-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 '../common/file-uri';
-import { TheiaRendererAPI } from './electron-api-main';
-
-/**
- * Theia tracks the maximized state of Electron Browser Windows.
- */
-export interface TheiaBrowserWindowOptions extends BrowserWindowConstructorOptions {
-    isMaximized?: boolean;
-    isFullScreen?: boolean;
-    /**
-     * Represents the complete screen layout for all available displays.
-     * This field is used to determine if the layout was updated since the electron window was last opened,
-     * in which case we want to invalidate the stored options and use the default options instead.
-     */
-    screenLayout?: string;
-    /**
-     * By default, the window will be shown as soon as the content is ready to render.
-     * This can be prevented by handing over preventAutomaticShow: `true`.
-     * Use this for fine-grained control over when to show the window, e.g. to coordinate with a splash screen.
-     */
-    preventAutomaticShow?: boolean;
-}
-
-export const TheiaBrowserWindowOptions = Symbol('TheiaBrowserWindowOptions');
-
-export const WindowApplicationConfig = Symbol('WindowApplicationConfig');
-export type WindowApplicationConfig = FrontendApplicationConfig;
-
-enum ClosingState {
-    initial,
-    inProgress,
-    readyToClose
-}
-
-@injectable()
-export class TheiaElectronWindow {
-    @inject(TheiaBrowserWindowOptions) protected readonly options: TheiaBrowserWindowOptions;
-    @inject(WindowApplicationConfig) protected readonly config: WindowApplicationConfig;
-    @inject(ElectronMainApplicationGlobals) protected readonly globals: ElectronMainApplicationGlobals;
-
-    protected onDidCloseEmitter = new Emitter<void>();
-
-    get onDidClose(): Event<void> {
-        return this.onDidCloseEmitter.event;
-    }
-
-    protected readonly toDispose = new DisposableCollection(this.onDidCloseEmitter);
-
-    protected _window: BrowserWindow;
-    get window(): BrowserWindow {
-        return this._window;
-    }
-
-    protected closeIsConfirmed = false;
-    protected applicationState: FrontendApplicationState = 'init';
-
-    @postConstruct()
-    protected init(): void {
-        this._window = new BrowserWindow(this.options);
-        this._window.setMenuBarVisibility(false);
-        if (!this.options.preventAutomaticShow) {
-            this.attachReadyToShow();
-        }
-        this.restoreMaximizedState();
-        this.attachCloseListeners();
-        this.trackApplicationState();
-        this.attachReloadListener();
-        this.attachSecondaryWindowListener();
-    }
-
-    protected attachSecondaryWindowListener(): void {
-        createDisposableListener(this._window.webContents, 'did-create-window', (newWindow: BrowserWindow) => {
-            let closingState = ClosingState.initial;
-            newWindow.on('close', event => {
-                if (closingState === ClosingState.initial) {
-                    closingState = ClosingState.inProgress;
-                    event.preventDefault();
-                    TheiaRendererAPI.requestSecondaryClose(this._window.webContents, newWindow.webContents).then(shouldClose => {
-                        if (shouldClose) {
-                            closingState = ClosingState.readyToClose;
-                            newWindow.close();
-                        } else {
-                            closingState = ClosingState.initial;
-                        }
-                    });
-                } else if (closingState === ClosingState.inProgress) {
-                    // When the extracted widget is disposed programmatically, a dispose listener on it will try to close the window.
-                    // if we dispose the widget because of closing the window, we'll get a recursive call to window.close()
-                    event.preventDefault();
-                }
-            });
-        });
-    }
-    /**
-     * Only show the window when the content is ready.
-     */
-    protected attachReadyToShow(): void {
-        this._window.once('ready-to-show', () => this._window.show());
-    }
-
-    protected attachCloseListeners(): void {
-        createDisposableListener<Electron.Event>(this._window, 'closed', () => {
-            this.onDidCloseEmitter.fire();
-            this.dispose();
-        }, this.toDispose);
-        createDisposableListener<Electron.Event>(this._window, 'close', async event => {
-            // User has already indicated that it is OK to close this window, or the window is being closed before it's ready.
-            if (this.closeIsConfirmed || this.applicationState !== 'ready') {
-                return;
-            }
-            event.preventDefault();
-            this.handleStopRequest(() => this.doCloseWindow(), StopReason.Close);
-        }, this.toDispose);
-    }
-
-    protected async doCloseWindow(): Promise<void> {
-        this.closeIsConfirmed = true;
-        await TheiaRendererAPI.sendAboutToClose(this._window.webContents);
-        this._window.close();
-    }
-
-    close(reason: StopReason = StopReason.Close): Promise<boolean> {
-        return this.handleStopRequest(() => this.doCloseWindow(), reason);
-    }
-
-    protected reload(newUrl?: string): void {
-        this.handleStopRequest(async () => {
-            this.applicationState = 'init';
-            if (newUrl) {
-                this._window.loadURL(newUrl);
-            } else {
-                this._window.reload();
-            }
-        }, StopReason.Reload);
-    }
-
-    protected async handleStopRequest(onSafeCallback: () => Promise<unknown>, reason: StopReason): Promise<boolean> {
-        // Only confirm close to windows that have loaded our frontend.
-        // Both the windows's URL and the FS path of the `index.html` should be converted to the "same" format to be able to compare them. (#11226)
-        // Notes:
-        //  - Windows: file:///C:/path/to/somewhere vs file:///c%3A/path/to/somewhere
-        //  - macOS: file:///Applications/App%20Name.app/Contents vs /Applications/App Name.app/Contents
-        // This URL string comes from electron, we can expect that this is properly encoded URL. For example, a space is `%20`
-        const currentUrl = new URI(this.window.webContents.getURL()).toString();
-        // THEIA_FRONTEND_HTML_PATH is an FS path, we have to covert to an encoded URI string.
-        const frontendUri = FileUri.create(this.globals.THEIA_FRONTEND_HTML_PATH).toString();
-        const safeToClose = !currentUrl.includes(frontendUri) || await this.checkSafeToStop(reason);
-        if (safeToClose) {
-            try {
-                await onSafeCallback();
-                return true;
-            } catch (e) {
-                console.warn(`Request ${StopReason[reason]} failed.`, e);
-            }
-        }
-        return false;
-    }
-
-    protected checkSafeToStop(reason: StopReason): Promise<boolean> {
-        return TheiaRendererAPI.requestClose(this.window.webContents, reason);
-    }
-
-    protected restoreMaximizedState(): void {
-        if (this.options.isMaximized) {
-            this._window.maximize();
-        } else {
-            this._window.unmaximize();
-        }
-    }
-
-    protected trackApplicationState(): void {
-        this.toDispose.push(TheiaRendererAPI.onApplicationStateChanged(this.window.webContents, state => {
-            this.applicationState = state;
-        }));
-    }
-
-    protected attachReloadListener(): void {
-        this.toDispose.push(TheiaRendererAPI.onRequestReload(this.window.webContents, (newUrl?: string) => this.reload(newUrl)));
-    }
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-}
-
-export interface TheiaElectronWindowFactory {
-    (options: TheiaBrowserWindowOptions, config: FrontendApplicationConfig): TheiaElectronWindow;
-}
-
-export const TheiaElectronWindowFactory = Symbol('TheiaElectronWindowFactory');
+// *****************************************************************************
+// Copyright (C) 2022 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 { FrontendApplicationConfig } from '@theia/application-package';
+import { FrontendApplicationState, StopReason } from '../common/frontend-application-state';
+import { BrowserWindow, BrowserWindowConstructorOptions } from '../../electron-shared/electron';
+import { inject, injectable, postConstruct } from '../../shared/inversify';
+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 '../common/file-uri';
+import { TheiaRendererAPI } from './electron-api-main';
+
+/**
+ * Theia tracks the maximized state of Electron Browser Windows.
+ */
+export interface TheiaBrowserWindowOptions extends BrowserWindowConstructorOptions {
+    isMaximized?: boolean;
+    isFullScreen?: boolean;
+    /**
+     * Represents the complete screen layout for all available displays.
+     * This field is used to determine if the layout was updated since the electron window was last opened,
+     * in which case we want to invalidate the stored options and use the default options instead.
+     */
+    screenLayout?: string;
+    /**
+     * By default, the window will be shown as soon as the content is ready to render.
+     * This can be prevented by handing over preventAutomaticShow: `true`.
+     * Use this for fine-grained control over when to show the window, e.g. to coordinate with a splash screen.
+     */
+    preventAutomaticShow?: boolean;
+}
+
+export const TheiaBrowserWindowOptions = Symbol('TheiaBrowserWindowOptions');
+
+export const WindowApplicationConfig = Symbol('WindowApplicationConfig');
+export type WindowApplicationConfig = FrontendApplicationConfig;
+
+enum ClosingState {
+    initial,
+    inProgress,
+    readyToClose
+}
+
+@injectable()
+export class TheiaElectronWindow {
+
+    @inject(TheiaBrowserWindowOptions) protected readonly options: TheiaBrowserWindowOptions;
+    @inject(WindowApplicationConfig) protected readonly config: WindowApplicationConfig;
+    @inject(ElectronMainApplicationGlobals) protected readonly globals: ElectronMainApplicationGlobals;
+
+    protected onDidCloseEmitter = new Emitter<void>();
+
+    get onDidClose(): Event<void> {
+        return this.onDidCloseEmitter.event;
+    }
+
+    protected readonly toDispose = new DisposableCollection(this.onDidCloseEmitter);
+
+    protected _window: BrowserWindow;
+    get window(): BrowserWindow {
+        return this._window;
+    }
+
+    protected closeIsConfirmed = false;
+    protected applicationState: FrontendApplicationState = 'init';
+
+    @postConstruct()
+    protected init(): void {
+        this._window = new BrowserWindow(this.options);
+        this._window.setMenuBarVisibility(false);
+        if (!this.options.preventAutomaticShow) {
+            this.attachReadyToShow();
+        }
+        this.restoreMaximizedState();
+        this.attachCloseListeners();
+        this.trackApplicationState();
+        this.attachReloadListener();
+        this.attachSecondaryWindowListener();
+    }
+
+    protected attachSecondaryWindowListener(): void {
+        createDisposableListener(this._window.webContents, 'did-create-window', (newWindow: BrowserWindow) => {
+            let closingState = ClosingState.initial;
+            newWindow.on('close', event => {
+                if (closingState === ClosingState.initial) {
+                    closingState = ClosingState.inProgress;
+                    event.preventDefault();
+                    TheiaRendererAPI.requestSecondaryClose(this._window.webContents, newWindow.webContents).then(shouldClose => {
+                        if (shouldClose) {
+                            closingState = ClosingState.readyToClose;
+                            newWindow.close();
+                        } else {
+                            closingState = ClosingState.initial;
+                        }
+                    });
+                } else if (closingState === ClosingState.inProgress) {
+                    // When the extracted widget is disposed programmatically, a dispose listener on it will try to close the window.
+                    // if we dispose the widget because of closing the window, we'll get a recursive call to window.close()
+                    event.preventDefault();
+                }
+            });
+        });
+    }
+    /**
+     * Only show the window when the content is ready.
+     */
+    protected attachReadyToShow(): void {
+        this._window.once('ready-to-show', () => this._window.show());
+    }
+
+    protected attachCloseListeners(): void {
+        createDisposableListener<Electron.Event>(this._window, 'closed', () => {
+            this.onDidCloseEmitter.fire();
+            this.dispose();
+        }, this.toDispose);
+        createDisposableListener<Electron.Event>(this._window, 'close', async event => {
+            // User has already indicated that it is OK to close this window, or the window is being closed before it's ready.
+            if (this.closeIsConfirmed || this.applicationState !== 'ready') {
+                return;
+            }
+            event.preventDefault();
+            this.handleStopRequest(() => this.doCloseWindow(), StopReason.Close);
+        }, this.toDispose);
+    }
+
+    protected async doCloseWindow(): Promise<void> {
+        this.closeIsConfirmed = true;
+        await TheiaRendererAPI.sendAboutToClose(this._window.webContents);
+        this._window.close();
+    }
+
+    close(reason: StopReason = StopReason.Close): Promise<boolean> {
+        return this.handleStopRequest(() => this.doCloseWindow(), reason);
+    }
+
+    protected reload(newUrl?: string): void {
+        this.handleStopRequest(async () => {
+            this.applicationState = 'init';
+            if (newUrl) {
+                this._window.loadURL(newUrl);
+            } else {
+                this._window.reload();
+            }
+        }, StopReason.Reload);
+    }
+
+    protected async handleStopRequest(onSafeCallback: () => Promise<unknown>, reason: StopReason): Promise<boolean> {
+        // Only confirm close to windows that have loaded our frontend.
+        // Both the windows's URL and the FS path of the `index.html` should be converted to the "same" format to be able to compare them. (#11226)
+        // Notes:
+        //  - Windows: file:///C:/path/to/somewhere vs file:///c%3A/path/to/somewhere
+        //  - macOS: file:///Applications/App%20Name.app/Contents vs /Applications/App Name.app/Contents
+        // This URL string comes from electron, we can expect that this is properly encoded URL. For example, a space is `%20`
+        const currentUrl = new URI(this.window.webContents.getURL()).toString();
+        // THEIA_FRONTEND_HTML_PATH is an FS path, we have to covert to an encoded URI string.
+        const frontendUri = FileUri.create(this.globals.THEIA_FRONTEND_HTML_PATH).toString();
+        const safeToClose = !currentUrl.includes(frontendUri) || await this.checkSafeToStop(reason);
+        if (safeToClose) {
+            try {
+                await onSafeCallback();
+                return true;
+            } catch (e) {
+                console.warn(`Request ${StopReason[reason]} failed.`, e);
+            }
+        }
+        return false;
+    }
+
+    protected checkSafeToStop(reason: StopReason): Promise<boolean> {
+        return TheiaRendererAPI.requestClose(this.window.webContents, reason);
+    }
+
+    protected restoreMaximizedState(): void {
+        if (this.options.isMaximized) {
+            this._window.maximize();
+        } else {
+            this._window.unmaximize();
+        }
+    }
+
+    protected trackApplicationState(): void {
+        this.toDispose.push(TheiaRendererAPI.onApplicationStateChanged(this.window.webContents, state => {
+            this.applicationState = state;
+        }));
+    }
+
+    protected attachReloadListener(): void {
+        this.toDispose.push(TheiaRendererAPI.onRequestReload(this.window.webContents, (newUrl?: string) => this.reload(newUrl)));
+    }
+
+    openUrl(url: string): Promise<boolean> {
+        return TheiaRendererAPI.openUrl(this.window.webContents, url);
+    }
+
+    dispose(): void {
+        this.toDispose.dispose();
+    }
+}
+
+export interface TheiaElectronWindowFactory {
+    (options: TheiaBrowserWindowOptions, config: FrontendApplicationConfig): TheiaElectronWindow;
+}
+
+export const TheiaElectronWindowFactory = Symbol('TheiaElectronWindowFactory');

package/src/electron-node/cli/electron-backend-cli-module.ts

@@ -1,24 +1,24 @@
-// *****************************************************************************
-// Copyright (C) 2024 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 { ContainerModule } from 'inversify';
-import { ElectronCliContribution } from './electron-cli-contribution';
-import { CliContribution } from '../../node';
-
-export default new ContainerModule(bind => {
-    bind(ElectronCliContribution).toSelf().inSingletonScope();
-    bind(CliContribution).toService(ElectronCliContribution);
-});
+// *****************************************************************************
+// Copyright (C) 2024 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 { ContainerModule } from 'inversify';
+import { ElectronCliContribution } from './electron-cli-contribution';
+import { CliContribution } from '../../node';
+
+export default new ContainerModule(bind => {
+    bind(ElectronCliContribution).toSelf().inSingletonScope();
+    bind(CliContribution).toService(ElectronCliContribution);
+});

package/src/electron-node/cli/electron-cli-contribution.ts

@@ -1,35 +1,35 @@
-/********************************************************************************
- * Copyright (C) 2024 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 { injectable } from 'inversify';
-import { Argv, Arguments } from 'yargs';
-import { CliContribution } from '../../node';
-import { MaybePromise } from '../../common';
-
-@injectable()
-export class ElectronCliContribution implements CliContribution {
-
-    configure(conf: Argv): void {
-        conf.option('electronUserData', {
-            type: 'string',
-            describe: 'The area where the electron main process puts its data'
-        });
-    }
-
-    setArguments(args: Arguments): MaybePromise<void> {
-    }
-
-}
+/********************************************************************************
+ * Copyright (C) 2024 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 { injectable } from 'inversify';
+import { Argv, Arguments } from 'yargs';
+import { CliContribution } from '../../node';
+import { MaybePromise } from '../../common';
+
+@injectable()
+export class ElectronCliContribution implements CliContribution {
+
+    configure(conf: Argv): void {
+        conf.option('electronUserData', {
+            type: 'string',
+            describe: 'The area where the electron main process puts its data'
+        });
+    }
+
+    setArguments(args: Arguments): MaybePromise<void> {
+    }
+
+}