@theia/core 1.45.0 → 1.46.0-next.72

package/src/browser/window/default-window-service.ts

@@ -1,167 +1,167 @@
-// *****************************************************************************
-// 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 { inject, injectable, named } from 'inversify';
-import { Event, Emitter } from '../../common';
-import { CorePreferences } from '../core-preferences';
-import { ContributionProvider } from '../../common/contribution-provider';
-import { FrontendApplicationContribution, OnWillStopAction } from '../frontend-application-contribution';
-import { WindowService } from './window-service';
-import { DEFAULT_WINDOW_HASH } from '../../common/window';
-import { confirmExit } from '../dialogs';
-import { StopReason } from '../../common/frontend-application-state';
-import { FrontendApplication } from '../frontend-application';
-
-@injectable()
-export class DefaultWindowService implements WindowService, FrontendApplicationContribution {
-
-    protected frontendApplication: FrontendApplication;
-    protected allowVetoes = true;
-
-    protected onUnloadEmitter = new Emitter<void>();
-    get onUnload(): Event<void> {
-        return this.onUnloadEmitter.event;
-    }
-
-    @inject(CorePreferences)
-    protected readonly corePreferences: CorePreferences;
-
-    @inject(ContributionProvider)
-    @named(FrontendApplicationContribution)
-    protected readonly contributions: ContributionProvider<FrontendApplicationContribution>;
-
-    onStart(app: FrontendApplication): void {
-        this.frontendApplication = app;
-        this.registerUnloadListeners();
-    }
-
-    openNewWindow(url: string): undefined {
-        window.open(url, undefined, 'noopener');
-        return undefined;
-    }
-
-    openNewDefaultWindow(): void {
-        this.openNewWindow(`#${DEFAULT_WINDOW_HASH}`);
-    }
-
-    /**
-     * Returns a list of actions that {@link FrontendApplicationContribution}s would like to take before shutdown
-     * It is expected that this will succeed - i.e. return an empty array - at most once per session. If no vetoes are received
-     * during any cycle, no further checks will be made. In that case, shutdown should proceed unconditionally.
-     */
-    protected collectContributionUnloadVetoes(): OnWillStopAction[] {
-        const vetoes: OnWillStopAction[] = [];
-        if (this.allowVetoes) {
-            const shouldConfirmExit = this.corePreferences['application.confirmExit'];
-            for (const contribution of this.contributions.getContributions()) {
-                const veto = contribution.onWillStop?.(this.frontendApplication);
-                if (veto && shouldConfirmExit !== 'never') { // Ignore vetoes if we should not prompt the user on exit.
-                    if (OnWillStopAction.is(veto)) {
-                        vetoes.push(veto);
-                    } else {
-                        vetoes.push({ reason: 'No reason given', action: () => false });
-                    }
-                }
-            }
-            vetoes.sort((a, b) => (a.priority ?? -Infinity) - (b.priority ?? -Infinity));
-            if (vetoes.length === 0 && shouldConfirmExit === 'always') {
-                vetoes.push({ reason: 'application.confirmExit preference', action: () => confirmExit() });
-            }
-            if (vetoes.length === 0) {
-                this.allowVetoes = false;
-            }
-        }
-        return vetoes;
-    }
-
-    /**
-     * Implement the mechanism to detect unloading of the page.
-     */
-    protected registerUnloadListeners(): void {
-        window.addEventListener('beforeunload', event => this.handleBeforeUnloadEvent(event));
-        // In a browser, `unload` is correctly fired when the page unloads, unlike Electron.
-        // If `beforeunload` is cancelled, the user will be prompted to leave or stay.
-        // If the user stays, the page won't be unloaded, so `unload` is not fired.
-        // If the user leaves, the page will be unloaded, so `unload` is fired.
-        window.addEventListener('unload', () => this.onUnloadEmitter.fire());
-    }
-
-    async isSafeToShutDown(stopReason: StopReason): Promise<boolean> {
-        const vetoes = this.collectContributionUnloadVetoes();
-        if (vetoes.length === 0) {
-            return true;
-        }
-        const preparedValues = await Promise.all(vetoes.map(e => e.prepare?.(stopReason)));
-        console.debug('Shutdown prevented by', vetoes.map(({ reason }) => reason).join(', '));
-        for (let i = 0; i < vetoes.length; i++) {
-            try {
-                const result = await vetoes[i].action(preparedValues[i], stopReason);
-                if (!result) {
-                    return false;
-                }
-            } catch (e) {
-                console.error(e);
-            }
-        }
-        console.debug('OnWillStop actions resolved; allowing shutdown');
-        this.allowVetoes = false;
-        return true;
-    }
-
-    setSafeToShutDown(): void {
-        this.allowVetoes = false;
-    }
-
-    /**
-     * Called when the `window` is about to `unload` its resources.
-     * At this point, the `document` is still visible and the [`BeforeUnloadEvent`](https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event)
-     * event will be canceled if the return value of this method is `false`.
-     *
-     * In Electron, handleCloseRequestEvent is is run instead.
-     */
-    protected handleBeforeUnloadEvent(event: BeforeUnloadEvent): string | void {
-        const vetoes = this.collectContributionUnloadVetoes();
-        if (vetoes.length) {
-            // In the browser, we don't call the functions because this has to finish in a single tick, so we treat any desired action as a veto.
-            console.debug('Shutdown prevented by', vetoes.map(({ reason }) => reason).join(', '));
-            return this.preventUnload(event);
-        }
-        console.debug('Shutdown will proceed.');
-    }
-
-    /**
-     * Notify the browser that we do not want to unload.
-     *
-     * Notes:
-     *  - Shows a confirmation popup in browsers.
-     *  - Prevents the window from closing without confirmation in electron.
-     *
-     * @param event The beforeunload event
-     */
-    protected preventUnload(event: BeforeUnloadEvent): string | void {
-        event.returnValue = '';
-        event.preventDefault();
-        return '';
-    }
-
-    reload(): void {
-        this.isSafeToShutDown(StopReason.Reload).then(isSafe => {
-            if (isSafe) {
-                window.location.reload();
-            }
-        });
-    }
-}
+// *****************************************************************************
+// 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 { inject, injectable, named } from 'inversify';
+import { Event, Emitter } from '../../common';
+import { CorePreferences } from '../core-preferences';
+import { ContributionProvider } from '../../common/contribution-provider';
+import { FrontendApplicationContribution, OnWillStopAction } from '../frontend-application-contribution';
+import { WindowService } from './window-service';
+import { DEFAULT_WINDOW_HASH } from '../../common/window';
+import { confirmExit } from '../dialogs';
+import { StopReason } from '../../common/frontend-application-state';
+import { FrontendApplication } from '../frontend-application';
+
+@injectable()
+export class DefaultWindowService implements WindowService, FrontendApplicationContribution {
+
+    protected frontendApplication: FrontendApplication;
+    protected allowVetoes = true;
+
+    protected onUnloadEmitter = new Emitter<void>();
+    get onUnload(): Event<void> {
+        return this.onUnloadEmitter.event;
+    }
+
+    @inject(CorePreferences)
+    protected readonly corePreferences: CorePreferences;
+
+    @inject(ContributionProvider)
+    @named(FrontendApplicationContribution)
+    protected readonly contributions: ContributionProvider<FrontendApplicationContribution>;
+
+    onStart(app: FrontendApplication): void {
+        this.frontendApplication = app;
+        this.registerUnloadListeners();
+    }
+
+    openNewWindow(url: string): undefined {
+        window.open(url, undefined, 'noopener');
+        return undefined;
+    }
+
+    openNewDefaultWindow(): void {
+        this.openNewWindow(`#${DEFAULT_WINDOW_HASH}`);
+    }
+
+    /**
+     * Returns a list of actions that {@link FrontendApplicationContribution}s would like to take before shutdown
+     * It is expected that this will succeed - i.e. return an empty array - at most once per session. If no vetoes are received
+     * during any cycle, no further checks will be made. In that case, shutdown should proceed unconditionally.
+     */
+    protected collectContributionUnloadVetoes(): OnWillStopAction[] {
+        const vetoes: OnWillStopAction[] = [];
+        if (this.allowVetoes) {
+            const shouldConfirmExit = this.corePreferences['application.confirmExit'];
+            for (const contribution of this.contributions.getContributions()) {
+                const veto = contribution.onWillStop?.(this.frontendApplication);
+                if (veto && shouldConfirmExit !== 'never') { // Ignore vetoes if we should not prompt the user on exit.
+                    if (OnWillStopAction.is(veto)) {
+                        vetoes.push(veto);
+                    } else {
+                        vetoes.push({ reason: 'No reason given', action: () => false });
+                    }
+                }
+            }
+            vetoes.sort((a, b) => (a.priority ?? -Infinity) - (b.priority ?? -Infinity));
+            if (vetoes.length === 0 && shouldConfirmExit === 'always') {
+                vetoes.push({ reason: 'application.confirmExit preference', action: () => confirmExit() });
+            }
+            if (vetoes.length === 0) {
+                this.allowVetoes = false;
+            }
+        }
+        return vetoes;
+    }
+
+    /**
+     * Implement the mechanism to detect unloading of the page.
+     */
+    protected registerUnloadListeners(): void {
+        window.addEventListener('beforeunload', event => this.handleBeforeUnloadEvent(event));
+        // In a browser, `unload` is correctly fired when the page unloads, unlike Electron.
+        // If `beforeunload` is cancelled, the user will be prompted to leave or stay.
+        // If the user stays, the page won't be unloaded, so `unload` is not fired.
+        // If the user leaves, the page will be unloaded, so `unload` is fired.
+        window.addEventListener('unload', () => this.onUnloadEmitter.fire());
+    }
+
+    async isSafeToShutDown(stopReason: StopReason): Promise<boolean> {
+        const vetoes = this.collectContributionUnloadVetoes();
+        if (vetoes.length === 0) {
+            return true;
+        }
+        const preparedValues = await Promise.all(vetoes.map(e => e.prepare?.(stopReason)));
+        console.debug('Shutdown prevented by', vetoes.map(({ reason }) => reason).join(', '));
+        for (let i = 0; i < vetoes.length; i++) {
+            try {
+                const result = await vetoes[i].action(preparedValues[i], stopReason);
+                if (!result) {
+                    return false;
+                }
+            } catch (e) {
+                console.error(e);
+            }
+        }
+        console.debug('OnWillStop actions resolved; allowing shutdown');
+        this.allowVetoes = false;
+        return true;
+    }
+
+    setSafeToShutDown(): void {
+        this.allowVetoes = false;
+    }
+
+    /**
+     * Called when the `window` is about to `unload` its resources.
+     * At this point, the `document` is still visible and the [`BeforeUnloadEvent`](https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event)
+     * event will be canceled if the return value of this method is `false`.
+     *
+     * In Electron, handleCloseRequestEvent is is run instead.
+     */
+    protected handleBeforeUnloadEvent(event: BeforeUnloadEvent): string | void {
+        const vetoes = this.collectContributionUnloadVetoes();
+        if (vetoes.length) {
+            // In the browser, we don't call the functions because this has to finish in a single tick, so we treat any desired action as a veto.
+            console.debug('Shutdown prevented by', vetoes.map(({ reason }) => reason).join(', '));
+            return this.preventUnload(event);
+        }
+        console.debug('Shutdown will proceed.');
+    }
+
+    /**
+     * Notify the browser that we do not want to unload.
+     *
+     * Notes:
+     *  - Shows a confirmation popup in browsers.
+     *  - Prevents the window from closing without confirmation in electron.
+     *
+     * @param event The beforeunload event
+     */
+    protected preventUnload(event: BeforeUnloadEvent): string | void {
+        event.returnValue = '';
+        event.preventDefault();
+        return '';
+    }
+
+    reload(): void {
+        this.isSafeToShutDown(StopReason.Reload).then(isSafe => {
+            if (isSafe) {
+                window.location.reload();
+            }
+        });
+    }
+}

package/src/browser/window/secondary-window-service.ts

@@ -1,39 +1,39 @@
-// *****************************************************************************
-// Copyright (C) 2022 STMicroelectronics, Ericsson, ARM, EclipseSource 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 { ApplicationShell } from '../shell';
-import { ExtractableWidget } from '../widgets';
-
-export const SecondaryWindowService = Symbol('SecondaryWindowService');
-
-/**
- * Service for opening new secondary windows to contain widgets extracted from the application shell.
- *
- * @experimental The functionality provided by this service and its implementation is still under development. Use with caution.
- */
-export interface SecondaryWindowService {
-    /**
-     * Creates a new secondary window for a widget to be extracted from the application shell.
-     * The created window is closed automatically when the current theia instance is closed.
-     *
-     * @param onClose optional callback that is invoked when the secondary window is closed
-     * @returns the created window or `undefined` if it could not be created
-     */
-    createSecondaryWindow(widget: ExtractableWidget, shell: ApplicationShell): Window | undefined;
-
-    /** Handles focussing the given secondary window in the browser and on Electron. */
-    focus(win: Window): void;
-}
+// *****************************************************************************
+// Copyright (C) 2022 STMicroelectronics, Ericsson, ARM, EclipseSource 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 { ApplicationShell } from '../shell';
+import { ExtractableWidget } from '../widgets';
+
+export const SecondaryWindowService = Symbol('SecondaryWindowService');
+
+/**
+ * Service for opening new secondary windows to contain widgets extracted from the application shell.
+ *
+ * @experimental The functionality provided by this service and its implementation is still under development. Use with caution.
+ */
+export interface SecondaryWindowService {
+    /**
+     * Creates a new secondary window for a widget to be extracted from the application shell.
+     * The created window is closed automatically when the current theia instance is closed.
+     *
+     * @param onClose optional callback that is invoked when the secondary window is closed
+     * @returns the created window or `undefined` if it could not be created
+     */
+    createSecondaryWindow(widget: ExtractableWidget, shell: ApplicationShell): Window | undefined;
+
+    /** Handles focussing the given secondary window in the browser and on Electron. */
+    focus(win: Window): void;
+}

package/src/browser/window/test/mock-window-service.ts

@@ -1,28 +1,28 @@
-// *****************************************************************************
-// Copyright (C) 2017 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';
-import { Event } from '../../../common/event';
-import { WindowService } from '../window-service';
-
-@injectable()
-export class MockWindowService implements WindowService {
-    openNewWindow(): undefined { return undefined; }
-    openNewDefaultWindow(): void { }
-    reload(): void { }
-    isSafeToShutDown(): Promise<boolean> { return Promise.resolve(true); }
-    setSafeToShutDown(): void { }
-    get onUnload(): Event<void> { return Event.None; }
-}
+// *****************************************************************************
+// Copyright (C) 2017 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';
+import { Event } from '../../../common/event';
+import { WindowService } from '../window-service';
+
+@injectable()
+export class MockWindowService implements WindowService {
+    openNewWindow(): undefined { return undefined; }
+    openNewDefaultWindow(): void { }
+    reload(): void { }
+    isSafeToShutDown(): Promise<boolean> { return Promise.resolve(true); }
+    setSafeToShutDown(): void { }
+    get onUnload(): Event<void> { return Event.None; }
+}

package/src/browser/window/window-service.ts

@@ -1,68 +1,68 @@
-// *****************************************************************************
-// 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 { StopReason } from '../../common/frontend-application-state';
-import { Event } from '../../common/event';
-import { NewWindowOptions, WindowSearchParams } from '../../common/window';
-
-/**
- * Service for opening new browser windows.
- */
-export const WindowService = Symbol('WindowService');
-
-export interface WindowService {
-    /**
-     * Opens a new window and loads the content from the given URL.
-     * In a browser, opening a new Theia tab or open a link is the same thing.
-     * But in Electron, we want to open links in a browser, not in Electron.
-     */
-    openNewWindow(url: string, options?: NewWindowOptions): undefined;
-
-    /**
-     * Opens a new default window.
-     * - In electron and in the browser it will open the default window without a pre-defined content.
-     */
-    openNewDefaultWindow(params?: WindowSearchParams): void;
-
-    /**
-     * Fires when the `window` unloads. The unload event is inevitable. On this event, the frontend application can save its state and release resource.
-     * Saving the state and releasing any resources must be a synchronous call. Any asynchronous calls invoked after emitting this event might be ignored.
-     */
-    readonly onUnload: Event<void>;
-
-    /**
-     * Checks `FrontendApplicationContribution#willStop` for impediments to shutdown and runs any actions returned.
-     * Can be used safely in browser and Electron when triggering reload or shutdown programmatically.
-     * Should _only_ be called before a shutdown - if this returns `true`, `FrontendApplicationContribution#willStop`
-     * will not be called again in the current session. I.e. if this return `true`, the shutdown should proceed without
-     * further condition.
-     */
-    isSafeToShutDown(reason: StopReason): Promise<boolean>;
-
-    /**
-     * Will prevent subsequent checks of `FrontendApplicationContribution#willStop`. Should only be used after requesting
-     * user confirmation.
-     *
-     * This is primarily intended programmatic restarts due to e.g. change of display language. It allows for a single confirmation
-     * of intent, rather than one warning and then several warnings from other contributions.
-     */
-    setSafeToShutDown(): void;
-
-    /**
-     * Reloads the window according to platform.
-     */
-    reload(params?: WindowSearchParams): void;
-}
+// *****************************************************************************
+// 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 { StopReason } from '../../common/frontend-application-state';
+import { Event } from '../../common/event';
+import { NewWindowOptions, WindowSearchParams } from '../../common/window';
+
+/**
+ * Service for opening new browser windows.
+ */
+export const WindowService = Symbol('WindowService');
+
+export interface WindowService {
+    /**
+     * Opens a new window and loads the content from the given URL.
+     * In a browser, opening a new Theia tab or open a link is the same thing.
+     * But in Electron, we want to open links in a browser, not in Electron.
+     */
+    openNewWindow(url: string, options?: NewWindowOptions): undefined;
+
+    /**
+     * Opens a new default window.
+     * - In electron and in the browser it will open the default window without a pre-defined content.
+     */
+    openNewDefaultWindow(params?: WindowSearchParams): void;
+
+    /**
+     * Fires when the `window` unloads. The unload event is inevitable. On this event, the frontend application can save its state and release resource.
+     * Saving the state and releasing any resources must be a synchronous call. Any asynchronous calls invoked after emitting this event might be ignored.
+     */
+    readonly onUnload: Event<void>;
+
+    /**
+     * Checks `FrontendApplicationContribution#willStop` for impediments to shutdown and runs any actions returned.
+     * Can be used safely in browser and Electron when triggering reload or shutdown programmatically.
+     * Should _only_ be called before a shutdown - if this returns `true`, `FrontendApplicationContribution#willStop`
+     * will not be called again in the current session. I.e. if this return `true`, the shutdown should proceed without
+     * further condition.
+     */
+    isSafeToShutDown(reason: StopReason): Promise<boolean>;
+
+    /**
+     * Will prevent subsequent checks of `FrontendApplicationContribution#willStop`. Should only be used after requesting
+     * user confirmation.
+     *
+     * This is primarily intended programmatic restarts due to e.g. change of display language. It allows for a single confirmation
+     * of intent, rather than one warning and then several warnings from other contributions.
+     */
+    setSafeToShutDown(): void;
+
+    /**
+     * Reloads the window according to platform.
+     */
+    reload(params?: WindowSearchParams): void;
+}