@theia/playwright 1.47.1 → 1.48.1

package/src/theia-app.ts

@@ -1,188 +1,188 @@
-// *****************************************************************************
-// Copyright (C) 2021-2023 logi.cals GmbH, 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 { Page } from '@playwright/test';
-import { TheiaEditor } from './theia-editor';
-import { DOT_FILES_FILTER, TheiaExplorerView } from './theia-explorer-view';
-import { TheiaMenuBar } from './theia-main-menu';
-import { TheiaPreferenceScope, TheiaPreferenceView } from './theia-preference-view';
-import { TheiaQuickCommandPalette } from './theia-quick-command-palette';
-import { TheiaStatusBar } from './theia-status-bar';
-import { TheiaTerminal } from './theia-terminal';
-import { TheiaView } from './theia-view';
-import { TheiaWorkspace } from './theia-workspace';
-
-export interface TheiaAppData {
-    loadingSelector: string;
-    shellSelector: string;
-};
-
-export const DefaultTheiaAppData: TheiaAppData = {
-    loadingSelector: '.theia-preload',
-    shellSelector: '.theia-ApplicationShell'
-};
-
-export class TheiaApp {
-
-    statusBar: TheiaStatusBar;
-    quickCommandPalette: TheiaQuickCommandPalette;
-    menuBar: TheiaMenuBar;
-
-    protected appData = DefaultTheiaAppData;
-
-    public constructor(
-        public page: Page,
-        public workspace: TheiaWorkspace,
-        public isElectron: boolean,
-    ) {
-        this.statusBar = this.createStatusBar();
-        this.quickCommandPalette = this.createQuickCommandPalette();
-        this.menuBar = this.createMenuBar();
-    }
-
-    protected createStatusBar(): TheiaStatusBar {
-        return new TheiaStatusBar(this);
-    }
-
-    protected createQuickCommandPalette(): TheiaQuickCommandPalette {
-        return new TheiaQuickCommandPalette(this);
-    }
-
-    protected createMenuBar(): TheiaMenuBar {
-        return new TheiaMenuBar(this);
-    }
-
-    async isShellVisible(): Promise<boolean> {
-        return this.page.isVisible(this.appData.shellSelector);
-    }
-
-    async waitForShellAndInitialized(): Promise<void> {
-        await this.page.waitForSelector(this.appData.loadingSelector, { state: 'detached' });
-        await this.page.waitForSelector(this.appData.shellSelector);
-        await this.waitForInitialized();
-    }
-
-    async isMainContentPanelVisible(): Promise<boolean> {
-        const contentPanel = await this.page.$('#theia-main-content-panel');
-        return !!contentPanel && contentPanel.isVisible();
-    }
-
-    async openPreferences(viewFactory: { new(app: TheiaApp): TheiaPreferenceView }, preferenceScope = TheiaPreferenceScope.Workspace): Promise<TheiaPreferenceView> {
-        const view = new viewFactory(this);
-        if (await view.isTabVisible()) {
-            await view.activate();
-            return view;
-        }
-        await view.open(preferenceScope);
-        return view;
-    }
-
-    async openView<T extends TheiaView>(viewFactory: { new(app: TheiaApp): T }): Promise<T> {
-        const view = new viewFactory(this);
-        if (await view.isTabVisible()) {
-            await view.activate();
-            return view;
-        }
-        await view.open();
-        return view;
-    }
-
-    async openEditor<T extends TheiaEditor>(filePath: string, editorFactory: { new(filePath: string, app: TheiaApp): T },
-        editorName?: string, expectFileNodes = true): Promise<T> {
-        const explorer = await this.openView(TheiaExplorerView);
-        if (!explorer) {
-            throw Error('TheiaExplorerView could not be opened.');
-        }
-        if (expectFileNodes) {
-            await explorer.waitForVisibleFileNodes();
-            const fileStatElements = await explorer.visibleFileStatNodes(DOT_FILES_FILTER);
-            if (fileStatElements.length < 1) {
-                throw Error('TheiaExplorerView is empty.');
-            }
-        }
-        const fileNode = await explorer.fileStatNode(filePath);
-        if (!fileNode || ! await fileNode?.isFile()) {
-            throw Error(`Specified path '${filePath}' could not be found or isn't a file.`);
-        }
-
-        const editor = new editorFactory(filePath, this);
-        const contextMenu = await fileNode.openContextMenu();
-        const editorToUse = editorName ? editorName : editor.name ? editor.name : undefined;
-        if (editorToUse) {
-            const menuItem = await contextMenu.menuItemByNamePath('Open With', editorToUse);
-            if (!menuItem) {
-                throw Error(`Editor named '${editorName}' could not be found in "Open With" menu.`);
-            }
-            await menuItem.click();
-        } else {
-            await contextMenu.clickMenuItem('Open');
-        }
-
-        await editor.waitForVisible();
-        return editor;
-    }
-
-    async activateExistingEditor<T extends TheiaEditor>(filePath: string, editorFactory: { new(filePath: string, app: TheiaApp): T }): Promise<T> {
-        const editor = new editorFactory(filePath, this);
-        if (!await editor.isTabVisible()) {
-            throw new Error(`Could not find opened editor for file ${filePath}`);
-        }
-        await editor.activate();
-        await editor.waitForVisible();
-        return editor;
-    }
-
-    async openTerminal<T extends TheiaTerminal>(terminalFactory: { new(id: string, app: TheiaApp): T }): Promise<T> {
-        const mainMenu = await this.menuBar.openMenu('Terminal');
-        const menuItem = await mainMenu.menuItemByName('New Terminal');
-        if (!menuItem) {
-            throw Error('Menu item \'New Terminal\' could not be found.');
-        }
-
-        const newTabIds = await this.runAndWaitForNewTabs(() => menuItem.click());
-        if (newTabIds.length > 1) {
-            console.warn('More than one new tab detected after opening the terminal');
-        }
-
-        return new terminalFactory(newTabIds[0], this);
-    }
-
-    protected async runAndWaitForNewTabs(command: () => Promise<void>): Promise<string[]> {
-        const tabIdsBefore = await this.visibleTabIds();
-        await command();
-        return (await this.waitForNewTabs(tabIdsBefore)).filter(item => !tabIdsBefore.includes(item));
-    }
-
-    protected async waitForNewTabs(tabIds: string[]): Promise<string[]> {
-        let tabIdsCurrent: string[];
-        while ((tabIdsCurrent = (await this.visibleTabIds())).length <= tabIds.length) {
-            console.debug('Awaiting a new tab to appear');
-        }
-        return tabIdsCurrent;
-    }
-
-    protected async visibleTabIds(): Promise<string[]> {
-        const tabs = await this.page.$$('.p-TabBar-tab');
-        const tabIds = (await Promise.all(tabs.map(tab => tab.getAttribute('id')))).filter(id => !!id);
-        return tabIds as string[];
-    }
-
-    /** Specific Theia apps may add additional conditions to wait for. */
-    async waitForInitialized(): Promise<void> {
-        // empty by default
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2021-2023 logi.cals GmbH, 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 { Page } from '@playwright/test';
+import { TheiaEditor } from './theia-editor';
+import { DOT_FILES_FILTER, TheiaExplorerView } from './theia-explorer-view';
+import { TheiaMenuBar } from './theia-main-menu';
+import { TheiaPreferenceScope, TheiaPreferenceView } from './theia-preference-view';
+import { TheiaQuickCommandPalette } from './theia-quick-command-palette';
+import { TheiaStatusBar } from './theia-status-bar';
+import { TheiaTerminal } from './theia-terminal';
+import { TheiaView } from './theia-view';
+import { TheiaWorkspace } from './theia-workspace';
+
+export interface TheiaAppData {
+    loadingSelector: string;
+    shellSelector: string;
+};
+
+export const DefaultTheiaAppData: TheiaAppData = {
+    loadingSelector: '.theia-preload',
+    shellSelector: '.theia-ApplicationShell'
+};
+
+export class TheiaApp {
+
+    statusBar: TheiaStatusBar;
+    quickCommandPalette: TheiaQuickCommandPalette;
+    menuBar: TheiaMenuBar;
+
+    protected appData = DefaultTheiaAppData;
+
+    public constructor(
+        public page: Page,
+        public workspace: TheiaWorkspace,
+        public isElectron: boolean,
+    ) {
+        this.statusBar = this.createStatusBar();
+        this.quickCommandPalette = this.createQuickCommandPalette();
+        this.menuBar = this.createMenuBar();
+    }
+
+    protected createStatusBar(): TheiaStatusBar {
+        return new TheiaStatusBar(this);
+    }
+
+    protected createQuickCommandPalette(): TheiaQuickCommandPalette {
+        return new TheiaQuickCommandPalette(this);
+    }
+
+    protected createMenuBar(): TheiaMenuBar {
+        return new TheiaMenuBar(this);
+    }
+
+    async isShellVisible(): Promise<boolean> {
+        return this.page.isVisible(this.appData.shellSelector);
+    }
+
+    async waitForShellAndInitialized(): Promise<void> {
+        await this.page.waitForSelector(this.appData.loadingSelector, { state: 'detached' });
+        await this.page.waitForSelector(this.appData.shellSelector);
+        await this.waitForInitialized();
+    }
+
+    async isMainContentPanelVisible(): Promise<boolean> {
+        const contentPanel = await this.page.$('#theia-main-content-panel');
+        return !!contentPanel && contentPanel.isVisible();
+    }
+
+    async openPreferences(viewFactory: { new(app: TheiaApp): TheiaPreferenceView }, preferenceScope = TheiaPreferenceScope.Workspace): Promise<TheiaPreferenceView> {
+        const view = new viewFactory(this);
+        if (await view.isTabVisible()) {
+            await view.activate();
+            return view;
+        }
+        await view.open(preferenceScope);
+        return view;
+    }
+
+    async openView<T extends TheiaView>(viewFactory: { new(app: TheiaApp): T }): Promise<T> {
+        const view = new viewFactory(this);
+        if (await view.isTabVisible()) {
+            await view.activate();
+            return view;
+        }
+        await view.open();
+        return view;
+    }
+
+    async openEditor<T extends TheiaEditor>(filePath: string, editorFactory: { new(filePath: string, app: TheiaApp): T },
+        editorName?: string, expectFileNodes = true): Promise<T> {
+        const explorer = await this.openView(TheiaExplorerView);
+        if (!explorer) {
+            throw Error('TheiaExplorerView could not be opened.');
+        }
+        if (expectFileNodes) {
+            await explorer.waitForVisibleFileNodes();
+            const fileStatElements = await explorer.visibleFileStatNodes(DOT_FILES_FILTER);
+            if (fileStatElements.length < 1) {
+                throw Error('TheiaExplorerView is empty.');
+            }
+        }
+        const fileNode = await explorer.fileStatNode(filePath);
+        if (!fileNode || ! await fileNode?.isFile()) {
+            throw Error(`Specified path '${filePath}' could not be found or isn't a file.`);
+        }
+
+        const editor = new editorFactory(filePath, this);
+        const contextMenu = await fileNode.openContextMenu();
+        const editorToUse = editorName ? editorName : editor.name ? editor.name : undefined;
+        if (editorToUse) {
+            const menuItem = await contextMenu.menuItemByNamePath('Open With', editorToUse);
+            if (!menuItem) {
+                throw Error(`Editor named '${editorName}' could not be found in "Open With" menu.`);
+            }
+            await menuItem.click();
+        } else {
+            await contextMenu.clickMenuItem('Open');
+        }
+
+        await editor.waitForVisible();
+        return editor;
+    }
+
+    async activateExistingEditor<T extends TheiaEditor>(filePath: string, editorFactory: { new(filePath: string, app: TheiaApp): T }): Promise<T> {
+        const editor = new editorFactory(filePath, this);
+        if (!await editor.isTabVisible()) {
+            throw new Error(`Could not find opened editor for file ${filePath}`);
+        }
+        await editor.activate();
+        await editor.waitForVisible();
+        return editor;
+    }
+
+    async openTerminal<T extends TheiaTerminal>(terminalFactory: { new(id: string, app: TheiaApp): T }): Promise<T> {
+        const mainMenu = await this.menuBar.openMenu('Terminal');
+        const menuItem = await mainMenu.menuItemByName('New Terminal');
+        if (!menuItem) {
+            throw Error('Menu item \'New Terminal\' could not be found.');
+        }
+
+        const newTabIds = await this.runAndWaitForNewTabs(() => menuItem.click());
+        if (newTabIds.length > 1) {
+            console.warn('More than one new tab detected after opening the terminal');
+        }
+
+        return new terminalFactory(newTabIds[0], this);
+    }
+
+    protected async runAndWaitForNewTabs(command: () => Promise<void>): Promise<string[]> {
+        const tabIdsBefore = await this.visibleTabIds();
+        await command();
+        return (await this.waitForNewTabs(tabIdsBefore)).filter(item => !tabIdsBefore.includes(item));
+    }
+
+    protected async waitForNewTabs(tabIds: string[]): Promise<string[]> {
+        let tabIdsCurrent: string[];
+        while ((tabIdsCurrent = (await this.visibleTabIds())).length <= tabIds.length) {
+            console.debug('Awaiting a new tab to appear');
+        }
+        return tabIdsCurrent;
+    }
+
+    protected async visibleTabIds(): Promise<string[]> {
+        const tabs = await this.page.$$('.p-TabBar-tab');
+        const tabIds = (await Promise.all(tabs.map(tab => tab.getAttribute('id')))).filter(id => !!id);
+        return tabIds as string[];
+    }
+
+    /** Specific Theia apps may add additional conditions to wait for. */
+    async waitForInitialized(): Promise<void> {
+        // empty by default
+    }
+
+}

package/src/theia-context-menu.ts

@@ -1,42 +1,42 @@
-// *****************************************************************************
-// Copyright (C) 2021 logi.cals GmbH, 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 { ElementHandle } from '@playwright/test';
-
-import { TheiaApp } from './theia-app';
-import { TheiaMenu } from './theia-menu';
-
-export class TheiaContextMenu extends TheiaMenu {
-
-    public static async openAt(app: TheiaApp, x: number, y: number): Promise<TheiaContextMenu> {
-        await app.page.mouse.move(x, y);
-        await app.page.mouse.click(x, y, { button: 'right' });
-        return TheiaContextMenu.returnWhenVisible(app);
-    }
-
-    public static async open(app: TheiaApp, element: () => Promise<ElementHandle<SVGElement | HTMLElement>>): Promise<TheiaContextMenu> {
-        const elementHandle = await element();
-        await elementHandle.click({ button: 'right' });
-        return TheiaContextMenu.returnWhenVisible(app);
-    }
-
-    private static async returnWhenVisible(app: TheiaApp): Promise<TheiaContextMenu> {
-        const menu = new TheiaContextMenu(app);
-        await menu.waitForVisible();
-        return menu;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2021 logi.cals GmbH, 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 { ElementHandle } from '@playwright/test';
+
+import { TheiaApp } from './theia-app';
+import { TheiaMenu } from './theia-menu';
+
+export class TheiaContextMenu extends TheiaMenu {
+
+    public static async openAt(app: TheiaApp, x: number, y: number): Promise<TheiaContextMenu> {
+        await app.page.mouse.move(x, y);
+        await app.page.mouse.click(x, y, { button: 'right' });
+        return TheiaContextMenu.returnWhenVisible(app);
+    }
+
+    public static async open(app: TheiaApp, element: () => Promise<ElementHandle<SVGElement | HTMLElement>>): Promise<TheiaContextMenu> {
+        const elementHandle = await element();
+        await elementHandle.click({ button: 'right' });
+        return TheiaContextMenu.returnWhenVisible(app);
+    }
+
+    private static async returnWhenVisible(app: TheiaApp): Promise<TheiaContextMenu> {
+        const menu = new TheiaContextMenu(app);
+        await menu.waitForVisible();
+        return menu;
+    }
+
+}