@theia/playwright 1.45.0 → 1.46.0-next.72

package/src/theia-main-menu.ts

@@ -1,54 +1,54 @@
-// *****************************************************************************
-// 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 { TheiaMenu } from './theia-menu';
-import { TheiaPageObject } from './theia-page-object';
-import { normalizeId, toTextContentArray } from './util';
-
-export class TheiaMainMenu extends TheiaMenu {
-    override selector = '.p-Menu.p-MenuBar-menu';
-}
-
-export class TheiaMenuBar extends TheiaPageObject {
-
-    async openMenu(menuName: string): Promise<TheiaMainMenu> {
-        const menuBarItem = await this.menuBarItem(menuName);
-        const mainMenu = new TheiaMainMenu(this.app);
-        if (await mainMenu.isOpen()) {
-            await menuBarItem?.hover();
-        } else {
-            await menuBarItem?.click();
-        }
-        mainMenu.waitForVisible();
-        return mainMenu;
-    }
-
-    async visibleMenuBarItems(): Promise<string[]> {
-        const items = await this.page.$$(this.menuBarItemSelector());
-        return toTextContentArray(items);
-    }
-
-    protected menuBarItem(label = ''): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
-        return this.page.waitForSelector(this.menuBarItemSelector(label));
-    }
-
-    protected menuBarItemSelector(label = ''): string {
-        return `${normalizeId('#theia:menubar')} .p-MenuBar-itemLabel >> text=${label}`;
-    }
-
-}
+// *****************************************************************************
+// 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 { TheiaMenu } from './theia-menu';
+import { TheiaPageObject } from './theia-page-object';
+import { normalizeId, toTextContentArray } from './util';
+
+export class TheiaMainMenu extends TheiaMenu {
+    override selector = '.p-Menu.p-MenuBar-menu';
+}
+
+export class TheiaMenuBar extends TheiaPageObject {
+
+    async openMenu(menuName: string): Promise<TheiaMainMenu> {
+        const menuBarItem = await this.menuBarItem(menuName);
+        const mainMenu = new TheiaMainMenu(this.app);
+        if (await mainMenu.isOpen()) {
+            await menuBarItem?.hover();
+        } else {
+            await menuBarItem?.click();
+        }
+        mainMenu.waitForVisible();
+        return mainMenu;
+    }
+
+    async visibleMenuBarItems(): Promise<string[]> {
+        const items = await this.page.$$(this.menuBarItemSelector());
+        return toTextContentArray(items);
+    }
+
+    protected menuBarItem(label = ''): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.waitForSelector(this.menuBarItemSelector(label));
+    }
+
+    protected menuBarItemSelector(label = ''): string {
+        return `${normalizeId('#theia:menubar')} .p-MenuBar-itemLabel >> text=${label}`;
+    }
+
+}

package/src/theia-menu-item.ts

@@ -1,75 +1,75 @@
-// *****************************************************************************
-// 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 { elementContainsClass, textContent } from './util';
-
-export class TheiaMenuItem {
-
-    constructor(protected element: ElementHandle<SVGElement | HTMLElement>) { }
-
-    protected labelElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement>> {
-        return this.element.waitForSelector('.p-Menu-itemLabel');
-    }
-
-    protected shortCutElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement>> {
-        return this.element.waitForSelector('.p-Menu-itemShortcut');
-    }
-
-    protected isHidden(): Promise<boolean> {
-        return elementContainsClass(this.element, 'p-mod-collapsed');
-    }
-
-    async label(): Promise<string | undefined> {
-        if (await this.isHidden()) {
-            return undefined;
-        }
-        return textContent(this.labelElementHandle());
-    }
-
-    async shortCut(): Promise<string | undefined> {
-        if (await this.isHidden()) {
-            return undefined;
-        }
-        return textContent(this.shortCutElementHandle());
-    }
-
-    async hasSubmenu(): Promise<boolean> {
-        if (await this.isHidden()) {
-            return false;
-        }
-        return (await this.element.getAttribute('data-type')) === 'submenu';
-    }
-
-    async isEnabled(): Promise<boolean> {
-        const classAttribute = (await this.element.getAttribute('class'));
-        if (classAttribute === undefined || classAttribute === null) {
-            return false;
-        }
-        return !classAttribute.includes('p-mod-disabled') && !classAttribute.includes('p-mod-collapsed');
-    }
-
-    async click(): Promise<void> {
-        return this.element.waitForSelector('.p-Menu-itemLabel')
-            .then(labelElement => labelElement.click({ position: { x: 10, y: 10 } }));
-    }
-
-    async hover(): Promise<void> {
-        return this.element.hover();
-    }
-
-}
+// *****************************************************************************
+// 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 { elementContainsClass, textContent } from './util';
+
+export class TheiaMenuItem {
+
+    constructor(protected element: ElementHandle<SVGElement | HTMLElement>) { }
+
+    protected labelElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement>> {
+        return this.element.waitForSelector('.p-Menu-itemLabel');
+    }
+
+    protected shortCutElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement>> {
+        return this.element.waitForSelector('.p-Menu-itemShortcut');
+    }
+
+    protected isHidden(): Promise<boolean> {
+        return elementContainsClass(this.element, 'p-mod-collapsed');
+    }
+
+    async label(): Promise<string | undefined> {
+        if (await this.isHidden()) {
+            return undefined;
+        }
+        return textContent(this.labelElementHandle());
+    }
+
+    async shortCut(): Promise<string | undefined> {
+        if (await this.isHidden()) {
+            return undefined;
+        }
+        return textContent(this.shortCutElementHandle());
+    }
+
+    async hasSubmenu(): Promise<boolean> {
+        if (await this.isHidden()) {
+            return false;
+        }
+        return (await this.element.getAttribute('data-type')) === 'submenu';
+    }
+
+    async isEnabled(): Promise<boolean> {
+        const classAttribute = (await this.element.getAttribute('class'));
+        if (classAttribute === undefined || classAttribute === null) {
+            return false;
+        }
+        return !classAttribute.includes('p-mod-disabled') && !classAttribute.includes('p-mod-collapsed');
+    }
+
+    async click(): Promise<void> {
+        return this.element.waitForSelector('.p-Menu-itemLabel')
+            .then(labelElement => labelElement.click({ position: { x: 10, y: 10 } }));
+    }
+
+    async hover(): Promise<void> {
+        return this.element.hover();
+    }
+
+}

package/src/theia-menu.ts

@@ -1,96 +1,96 @@
-// *****************************************************************************
-// 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 { TheiaMenuItem } from './theia-menu-item';
-import { TheiaPageObject } from './theia-page-object';
-import { isDefined } from './util';
-
-export class TheiaMenu extends TheiaPageObject {
-
-    selector = '.p-Menu';
-
-    protected async menuElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
-        return this.page.$(this.selector);
-    }
-
-    async waitForVisible(): Promise<void> {
-        await this.page.waitForSelector(this.selector, { state: 'visible' });
-    }
-
-    async isOpen(): Promise<boolean> {
-        const menu = await this.menuElementHandle();
-        return !!menu && menu.isVisible();
-    }
-
-    async close(): Promise<void> {
-        if (!await this.isOpen()) {
-            return;
-        }
-        await this.page.mouse.click(0, 0);
-        await this.page.waitForSelector(this.selector, { state: 'detached' });
-    }
-
-    async menuItems(): Promise<TheiaMenuItem[]> {
-        const menuHandle = await this.menuElementHandle();
-        if (!menuHandle) {
-            return [];
-        }
-        const items = await menuHandle.$$('.p-Menu-content .p-Menu-item');
-        return items.map(element => new TheiaMenuItem(element));
-    }
-
-    async clickMenuItem(name: string): Promise<void> {
-        return (await this.page.waitForSelector(this.menuItemSelector(name))).click();
-    }
-
-    async menuItemByName(name: string): Promise<TheiaMenuItem | undefined> {
-        const menuItems = await this.menuItems();
-        for (const item of menuItems) {
-            const label = await item.label();
-            if (label === name) {
-                return item;
-            }
-        }
-        return undefined;
-    }
-
-    async menuItemByNamePath(...names: string[]): Promise<TheiaMenuItem | undefined> {
-        let item;
-        for (let index = 0; index < names.length; index++) {
-            item = await this.page.waitForSelector(this.menuItemSelector(names[index]), { state: 'visible' });
-            await item.hover();
-        }
-
-        const menuItemHandle = await item?.$('xpath=..');
-        if (menuItemHandle) {
-            return new TheiaMenuItem(menuItemHandle);
-        }
-        return undefined;
-    }
-
-    protected menuItemSelector(label = ''): string {
-        return `.p-Menu-content .p-Menu-itemLabel >> text=${label}`;
-    }
-
-    async visibleMenuItems(): Promise<string[]> {
-        const menuItems = await this.menuItems();
-        const labels = await Promise.all(menuItems.map(item => item.label()));
-        return labels.filter(isDefined);
-    }
-
-}
+// *****************************************************************************
+// 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 { TheiaMenuItem } from './theia-menu-item';
+import { TheiaPageObject } from './theia-page-object';
+import { isDefined } from './util';
+
+export class TheiaMenu extends TheiaPageObject {
+
+    selector = '.p-Menu';
+
+    protected async menuElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.$(this.selector);
+    }
+
+    async waitForVisible(): Promise<void> {
+        await this.page.waitForSelector(this.selector, { state: 'visible' });
+    }
+
+    async isOpen(): Promise<boolean> {
+        const menu = await this.menuElementHandle();
+        return !!menu && menu.isVisible();
+    }
+
+    async close(): Promise<void> {
+        if (!await this.isOpen()) {
+            return;
+        }
+        await this.page.mouse.click(0, 0);
+        await this.page.waitForSelector(this.selector, { state: 'detached' });
+    }
+
+    async menuItems(): Promise<TheiaMenuItem[]> {
+        const menuHandle = await this.menuElementHandle();
+        if (!menuHandle) {
+            return [];
+        }
+        const items = await menuHandle.$$('.p-Menu-content .p-Menu-item');
+        return items.map(element => new TheiaMenuItem(element));
+    }
+
+    async clickMenuItem(name: string): Promise<void> {
+        return (await this.page.waitForSelector(this.menuItemSelector(name))).click();
+    }
+
+    async menuItemByName(name: string): Promise<TheiaMenuItem | undefined> {
+        const menuItems = await this.menuItems();
+        for (const item of menuItems) {
+            const label = await item.label();
+            if (label === name) {
+                return item;
+            }
+        }
+        return undefined;
+    }
+
+    async menuItemByNamePath(...names: string[]): Promise<TheiaMenuItem | undefined> {
+        let item;
+        for (let index = 0; index < names.length; index++) {
+            item = await this.page.waitForSelector(this.menuItemSelector(names[index]), { state: 'visible' });
+            await item.hover();
+        }
+
+        const menuItemHandle = await item?.$('xpath=..');
+        if (menuItemHandle) {
+            return new TheiaMenuItem(menuItemHandle);
+        }
+        return undefined;
+    }
+
+    protected menuItemSelector(label = ''): string {
+        return `.p-Menu-content .p-Menu-itemLabel >> text=${label}`;
+    }
+
+    async visibleMenuItems(): Promise<string[]> {
+        const menuItems = await this.menuItems();
+        const labels = await Promise.all(menuItems.map(item => item.label()));
+        return labels.filter(isDefined);
+    }
+
+}

package/src/theia-monaco-editor.ts

@@ -1,83 +1,83 @@
-// *****************************************************************************
-// Copyright (C) 2023 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 { TheiaPageObject } from './theia-page-object';
-import { TheiaApp } from './theia-app';
-
-export class TheiaMonacoEditor extends TheiaPageObject {
-    constructor(protected readonly selector: string, app: TheiaApp) {
-        super(app);
-    }
-
-    async waitForVisible(): Promise<void> {
-        await this.page.waitForSelector(this.selector, { state: 'visible' });
-    }
-
-    protected viewElement(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
-        return this.page.$(this.selector);
-    }
-
-    async numberOfLines(): Promise<number | undefined> {
-        await this.waitForVisible();
-        const viewElement = await this.viewElement();
-        const lineElements = await viewElement?.$$('.view-lines .view-line');
-        return lineElements?.length;
-    }
-
-    async textContentOfLineByLineNumber(lineNumber: number): Promise<string | undefined> {
-        await this.waitForVisible();
-        const lineElement = await this.lineByLineNumber(lineNumber);
-        const content = await lineElement?.textContent();
-        return content ? this.replaceEditorSymbolsWithSpace(content) : undefined;
-    }
-
-    async lineByLineNumber(lineNumber: number): Promise<ElementHandle<SVGElement | HTMLElement> | undefined> {
-        await this.waitForVisible();
-        const viewElement = await this.viewElement();
-        const lines = await viewElement?.$$('.view-lines > .view-line');
-        if (!lines) {
-            throw new Error('Couldn\'t retrieve lines of monaco editor');
-        }
-
-        const linesWithXCoordinates = [];
-        for (const lineElement of lines) {
-            const box = await lineElement.boundingBox();
-            linesWithXCoordinates.push({ x: box ? box.x : Number.MAX_VALUE, lineElement });
-        }
-        linesWithXCoordinates.sort((a, b) => a.x.toString().localeCompare(b.x.toString()));
-        return linesWithXCoordinates[lineNumber - 1].lineElement;
-    }
-
-    async textContentOfLineContainingText(text: string): Promise<string | undefined> {
-        await this.waitForVisible();
-        const lineElement = await this.lineContainingText(text);
-        const content = await lineElement?.textContent();
-        return content ? this.replaceEditorSymbolsWithSpace(content) : undefined;
-    }
-
-    async lineContainingText(text: string): Promise<ElementHandle<SVGElement | HTMLElement> | undefined> {
-        const viewElement = await this.viewElement();
-        return viewElement?.waitForSelector(`.view-lines .view-line:has-text("${text}")`);
-    }
-
-    protected replaceEditorSymbolsWithSpace(content: string): string | Promise<string | undefined> {
-        // [ ] &nbsp; => \u00a0 -- NO-BREAK SPACE
-        // [·] &middot; => \u00b7 -- MIDDLE DOT
-        // [] &zwnj; => \u200c -- ZERO WIDTH NON-JOINER
-        return content.replace(/[\u00a0\u00b7]/g, ' ').replace(/[\u200c]/g, '');
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 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 { TheiaPageObject } from './theia-page-object';
+import { TheiaApp } from './theia-app';
+
+export class TheiaMonacoEditor extends TheiaPageObject {
+    constructor(protected readonly selector: string, app: TheiaApp) {
+        super(app);
+    }
+
+    async waitForVisible(): Promise<void> {
+        await this.page.waitForSelector(this.selector, { state: 'visible' });
+    }
+
+    protected viewElement(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.$(this.selector);
+    }
+
+    async numberOfLines(): Promise<number | undefined> {
+        await this.waitForVisible();
+        const viewElement = await this.viewElement();
+        const lineElements = await viewElement?.$$('.view-lines .view-line');
+        return lineElements?.length;
+    }
+
+    async textContentOfLineByLineNumber(lineNumber: number): Promise<string | undefined> {
+        await this.waitForVisible();
+        const lineElement = await this.lineByLineNumber(lineNumber);
+        const content = await lineElement?.textContent();
+        return content ? this.replaceEditorSymbolsWithSpace(content) : undefined;
+    }
+
+    async lineByLineNumber(lineNumber: number): Promise<ElementHandle<SVGElement | HTMLElement> | undefined> {
+        await this.waitForVisible();
+        const viewElement = await this.viewElement();
+        const lines = await viewElement?.$$('.view-lines > .view-line');
+        if (!lines) {
+            throw new Error('Couldn\'t retrieve lines of monaco editor');
+        }
+
+        const linesWithXCoordinates = [];
+        for (const lineElement of lines) {
+            const box = await lineElement.boundingBox();
+            linesWithXCoordinates.push({ x: box ? box.x : Number.MAX_VALUE, lineElement });
+        }
+        linesWithXCoordinates.sort((a, b) => a.x.toString().localeCompare(b.x.toString()));
+        return linesWithXCoordinates[lineNumber - 1].lineElement;
+    }
+
+    async textContentOfLineContainingText(text: string): Promise<string | undefined> {
+        await this.waitForVisible();
+        const lineElement = await this.lineContainingText(text);
+        const content = await lineElement?.textContent();
+        return content ? this.replaceEditorSymbolsWithSpace(content) : undefined;
+    }
+
+    async lineContainingText(text: string): Promise<ElementHandle<SVGElement | HTMLElement> | undefined> {
+        const viewElement = await this.viewElement();
+        return viewElement?.waitForSelector(`.view-lines .view-line:has-text("${text}")`);
+    }
+
+    protected replaceEditorSymbolsWithSpace(content: string): string | Promise<string | undefined> {
+        // [ ] &nbsp; => \u00a0 -- NO-BREAK SPACE
+        // [·] &middot; => \u00b7 -- MIDDLE DOT
+        // [] &zwnj; => \u200c -- ZERO WIDTH NON-JOINER
+        return content.replace(/[\u00a0\u00b7]/g, ' ').replace(/[\u200c]/g, '');
+    }
+}