@redhat-developer/page-objects 1.13.0 → 1.14.1

package/out/components/AbstractElement.d.ts

@@ -17,7 +17,7 @@
 import { WebElement, WebDriver, Locator } from 'selenium-webdriver';
 import { Locators } from '../locators/locators';
 /**
- * Default wrapper for webelement
+ * Default wrapper for webElement
  */
 export declare abstract class AbstractElement extends WebElement {
     static readonly ctlKey: string;
@@ -30,7 +30,7 @@ export declare abstract class AbstractElement extends WebElement {
     protected enclosingItem: WebElement;
     /**
      * Constructs a new element from a Locator or an existing WebElement
-     * @param base WebDriver compatible Locator for the given element or a reference to an existing WeBelement
+     * @param base WebDriver compatible Locator for the given element or a reference to an existing WebElement
      * @param enclosingItem Locator or a WebElement reference to an element containing the element being constructed
      * this will be used to narrow down the search for the underlying DOM element
      */
@@ -48,4 +48,6 @@ export declare abstract class AbstractElement extends WebElement {
      */
     getEnclosingElement(): WebElement;
     static init(locators: Locators, driver: WebDriver, browser: string, version: string): void;
+    withRecovery<T>(fn: (self: this) => Promise<T>): Promise<T>;
+    protected reinitialize(): Promise<this>;
 }

package/out/components/AbstractElement.js

@@ -19,7 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractElement = void 0;
 const selenium_webdriver_1 = require("selenium-webdriver");
 /**
- * Default wrapper for webelement
+ * Default wrapper for webElement
  */
 class AbstractElement extends selenium_webdriver_1.WebElement {
     static ctlKey = process.platform === 'darwin' ? selenium_webdriver_1.Key.COMMAND : selenium_webdriver_1.Key.CONTROL;
@@ -29,7 +29,7 @@ class AbstractElement extends selenium_webdriver_1.WebElement {
     enclosingItem;
     /**
      * Constructs a new element from a Locator or an existing WebElement
-     * @param base WebDriver compatible Locator for the given element or a reference to an existing WeBelement
+     * @param base WebDriver compatible Locator for the given element or a reference to an existing WebElement
      * @param enclosingItem Locator or a WebElement reference to an element containing the element being constructed
      * this will be used to narrow down the search for the underlying DOM element
      */
@@ -80,6 +80,24 @@ class AbstractElement extends selenium_webdriver_1.WebElement {
         AbstractElement.driver = driver;
         AbstractElement.versionInfo = { version: version, browser: browser };
     }
+    async withRecovery(fn) {
+        try {
+            return await fn(this);
+        }
+        catch (err) {
+            if (err.name === 'StaleElementReferenceError' ||
+                err.name === 'ElementNotInteractableError' ||
+                /element.*(detached|not interactable)/i.test(err.message)) {
+                const reinit = await this.reinitialize();
+                return await fn(reinit);
+            }
+            throw err;
+        }
+    }
+    async reinitialize() {
+        // Implement generic fallback if possible — otherwise force override in subclasses
+        throw new Error(`reinitialize() not implemented in ${this.constructor.name}`);
+    }
 }
 exports.AbstractElement = AbstractElement;
 //# sourceMappingURL=AbstractElement.js.map

package/out/components/ActionButtonElementDropdown.js

@@ -23,12 +23,14 @@ const selenium_webdriver_1 = require("selenium-webdriver");
 class ActionButtonElementDropdown extends AbstractElement_1.AbstractElement {
     async open() {
         await this.click();
+        await this.getDriver().sleep(500);
         const shadowRootHost = await this.enclosingItem.findElements(ActionButtonElementDropdown.locators.ContextMenu.shadowRootHost);
         const actions = this.getDriver().actions();
         await actions.clear();
         if (shadowRootHost.length > 0) {
             if ((await this.getAttribute('aria-expanded')) !== 'true') {
                 await this.click();
+                await this.getDriver().sleep(500);
             }
             const shadowRoot = await shadowRootHost[0].getShadowRoot();
             return new ContextMenu_1.ContextMenu(await shadowRoot.findElement(selenium_webdriver_1.By.className('monaco-menu-container'))).wait();

package/out/components/bottomBar/AbstractViews.js

@@ -50,7 +50,7 @@ class ChannelView extends ElementWithContextMenu_1.ElementWithContextMenu {
             throw Error(`DEPRECATED METHOD! The 'ChannelView.getCurrentChannel' method is broken! Read more information in 'Known Issues > Limitations in testing with VS Code 1.87+' - https://github.com/microsoft/vscode/issues/206897.`);
         }
         const combo = await this.enclosingItem.findElement(ChannelView.locators.BottomBarViews.channelCombo);
-        return await combo.getAttribute('title');
+        return await combo.getAttribute(ChannelView.locators.OutputView.currentChannelAttribute);
     }
     /**
      * Select a channel using the selector combo
@@ -72,25 +72,27 @@ class TextView extends ChannelView {
      * @returns Promise resolving to the view's text
      */
     async getText() {
-        const clipboard = (await import('clipboardy')).default;
-        let originalClipboard = '';
-        try {
-            originalClipboard = clipboard.readSync();
-        }
-        catch (error) {
-            // workaround issue https://github.com/redhat-developer/vscode-extension-tester/issues/835
-            // do not fail if clipboard is empty
-        }
-        const textarea = await this.findElement(ChannelView.locators.BottomBarViews.textArea);
-        await textarea.sendKeys(selenium_webdriver_1.Key.chord(TextView.ctlKey, 'a'));
-        await textarea.sendKeys(selenium_webdriver_1.Key.chord(TextView.ctlKey, 'c'));
-        const text = clipboard.readSync();
-        // workaround as we are getting "element click intercepted" during the send keys actions.
-        // await textarea.click();
-        if (originalClipboard.length > 0) {
-            clipboard.writeSync(originalClipboard);
-        }
-        return text;
+        return this.withRecovery(async (self) => {
+            const clipboard = (await import('clipboardy')).default;
+            let originalClipboard = '';
+            try {
+                originalClipboard = clipboard.readSync();
+            }
+            catch (error) {
+                // workaround issue https://github.com/redhat-developer/vscode-extension-tester/issues/835
+                // do not fail if clipboard is empty
+            }
+            const textarea = await self.findElement(ChannelView.locators.BottomBarViews.textArea);
+            await textarea.sendKeys(selenium_webdriver_1.Key.chord(TextView.ctlKey, 'a'));
+            await textarea.sendKeys(selenium_webdriver_1.Key.chord(TextView.ctlKey, 'c'));
+            const text = clipboard.readSync();
+            // workaround as we are getting "element click intercepted" during the send keys actions.
+            // await textarea.click();
+            if (originalClipboard.length > 0) {
+                clipboard.writeSync(originalClipboard);
+            }
+            return text;
+        });
     }
     /**
      * Clear the text in the current channel

package/out/components/bottomBar/Views.d.ts

@@ -22,6 +22,7 @@ import { ElementWithContextMenu } from '../ElementWithContextMenu';
  */
 export declare class OutputView extends TextView {
     constructor(panel?: BottomBarPanel);
+    protected reinitialize(): Promise<this>;
     /**
      * Select a channel using the selector combo
      * @param name name of the channel to open
@@ -34,6 +35,7 @@ export declare class OutputView extends TextView {
  */
 export declare class DebugConsoleView extends ElementWithContextMenu {
     constructor(panel?: BottomBarPanel);
+    protected reinitialize(): Promise<this>;
     /**
      * Clear the console of all text
      */

package/out/components/bottomBar/Views.js

@@ -29,6 +29,11 @@ class OutputView extends AbstractViews_1.TextView {
         super(OutputView.locators.OutputView.constructor, panel);
         this.actionsLabel = OutputView.locators.OutputView.actionsLabel;
     }
+    async reinitialize() {
+        const panel = this.enclosingItem;
+        const view = await panel.openOutputView();
+        return view;
+    }
     /**
      * Select a channel using the selector combo
      * @param name name of the channel to open
@@ -46,6 +51,11 @@ class DebugConsoleView extends ElementWithContextMenu_1.ElementWithContextMenu {
     constructor(panel = new __1.BottomBarPanel()) {
         super(DebugConsoleView.locators.DebugConsoleView.constructor, panel);
     }
+    async reinitialize() {
+        const panel = this.enclosingItem;
+        const view = await panel.openDebugConsoleView();
+        return view;
+    }
     /**
      * Clear the console of all text
      */
@@ -58,9 +68,11 @@ class DebugConsoleView extends ElementWithContextMenu_1.ElementWithContextMenu {
      * @param expression expression in form of a string
      */
     async setExpression(expression) {
-        const textarea = await this.findElement(DebugConsoleView.locators.BottomBarViews.textArea);
-        await textarea.clear();
-        await textarea.sendKeys(expression);
+        await this.withRecovery(async (self) => {
+            const textarea = await self.findElement(DebugConsoleView.locators.BottomBarViews.textArea);
+            await textarea.sendKeys(selenium_webdriver_1.Key.chord(DebugConsoleView.ctlKey, 'a'));
+            await textarea.sendKeys(expression);
+        });
     }
     /**
      * Evaluate an expression:
@@ -70,11 +82,13 @@ class DebugConsoleView extends ElementWithContextMenu_1.ElementWithContextMenu {
      * @param expression expression to evaluate. To use existing contents of the debug console text area instead, don't define this argument
      */
     async evaluateExpression(expression) {
-        const textarea = await this.findElement(DebugConsoleView.locators.BottomBarViews.textArea);
-        if (expression) {
-            await this.setExpression(expression);
-        }
-        await textarea.sendKeys(selenium_webdriver_1.Key.ENTER);
+        await this.withRecovery(async (self) => {
+            const textarea = await self.findElement(DebugConsoleView.locators.BottomBarViews.textArea);
+            if (expression) {
+                await self.setExpression(expression);
+            }
+            await textarea.sendKeys(selenium_webdriver_1.Key.ENTER);
+        });
     }
     /**
      * Create a content assist page object

package/out/components/editor/Editor.d.ts

@@ -22,6 +22,7 @@ import { WebElement, Locator } from 'selenium-webdriver';
  */
 export declare abstract class Editor extends ElementWithContextMenu {
     constructor(view?: EditorView | EditorGroup, base?: Locator | WebElement);
+    protected reinitialize(): Promise<this>;
     /**
      * Get title/name of the open editor
      */

package/out/components/editor/Editor.js

@@ -26,6 +26,16 @@ class Editor extends ElementWithContextMenu_1.ElementWithContextMenu {
     constructor(view = new __1.EditorView(), base = Editor.locators.Editor.constructor) {
         super(base, view);
     }
+    async reinitialize() {
+        const editorView = this.enclosingItem;
+        const title = await this.getTitle();
+        const reopened = await editorView.openEditor(title);
+        // Check if we got the same type back
+        if (!(reopened instanceof this.constructor)) {
+            throw new Error(`Reopened editor is not the same type as original.`);
+        }
+        return reopened;
+    }
     /**
      * Get title/name of the open editor
      */

package/out/components/editor/EditorView.d.ts

@@ -92,9 +92,10 @@ export declare class EditorView extends AbstractElement {
      * Get editor action of a select editor group, search by title or predicate
      * @param predicateOrTitle title or predicate to be used in search process
      * @param groupIndex zero based index of the editor group (leftmost group has index 0), default 0
+     * @param timeout timeout in milliseconds to wait for the action to appear, default 5000
      * @returns promise resolving to EditorAction object if found, undefined otherwise
      */
-    getAction(predicateOrTitle: string | ((action: EditorAction) => boolean | PromiseLike<boolean>), groupIndex?: number): Promise<EditorAction | undefined>;
+    getAction(predicateOrTitle: string | ((action: EditorAction) => boolean | PromiseLike<boolean>), groupIndex?: number, timeout?: number): Promise<EditorAction | undefined>;
 }
 /**
  * Page object representing an editor group

package/out/components/editor/EditorView.js

@@ -169,11 +169,14 @@ class EditorView extends AbstractElement_1.AbstractElement {
      * Get editor action of a select editor group, search by title or predicate
      * @param predicateOrTitle title or predicate to be used in search process
      * @param groupIndex zero based index of the editor group (leftmost group has index 0), default 0
+     * @param timeout timeout in milliseconds to wait for the action to appear, default 5000
      * @returns promise resolving to EditorAction object if found, undefined otherwise
      */
-    async getAction(predicateOrTitle, groupIndex = 0) {
-        const group = await this.getEditorGroup(groupIndex);
-        return group.getAction(predicateOrTitle);
+    async getAction(predicateOrTitle, groupIndex = 0, timeout = 5000) {
+        return this.getDriver().wait(async () => {
+            const group = await this.getEditorGroup(groupIndex);
+            return group.getAction(predicateOrTitle);
+        }, timeout, `Expected action - '${predicateOrTitle}' was not found.`);
     }
 }
 exports.EditorView = EditorView;

package/out/components/editor/SettingsEditor.d.ts

@@ -25,6 +25,7 @@ import { EditorView, EditorGroup } from '../..';
 export declare class SettingsEditor extends Editor {
     private divider;
     constructor(view?: EditorView | EditorGroup);
+    protected reinitialize(): Promise<this>;
     /**
      * Search for a setting with a particular title and category.
      * Returns an appropriate Setting object if the label is found,

package/out/components/editor/SettingsEditor.js

@@ -30,6 +30,14 @@ class SettingsEditor extends Editor_1.Editor {
     constructor(view = new __1.EditorView()) {
         super(view);
     }
+    async reinitialize() {
+        const reopened = await new __1.Workbench().openSettings();
+        // Check if we got the same type back
+        if (!(reopened instanceof this.constructor)) {
+            throw new Error(`Reopened editor is not the same type as original.`);
+        }
+        return reopened;
+    }
     /**
      * Search for a setting with a particular title and category.
      * Returns an appropriate Setting object if the label is found,
@@ -43,11 +51,13 @@ class SettingsEditor extends Editor_1.Editor {
      * @returns Promise resolving to a Setting object if found, undefined otherwise
      */
     async findSetting(title, ...categories) {
-        const category = categories.join(this.divider);
-        const searchBox = await this.findElement(SettingsEditor.locators.Editor.inputArea);
-        await searchBox.sendKeys(selenium_webdriver_1.Key.chord(SettingsEditor.ctlKey, 'a'));
-        await searchBox.sendKeys(`${category}>${title}`);
-        return await this._getSettingItem(title, category);
+        return this.withRecovery(async (self) => {
+            const category = categories.join(self.divider);
+            const searchBox = await self.findElement(SettingsEditor.locators.Editor.inputArea);
+            await searchBox.sendKeys(selenium_webdriver_1.Key.chord(SettingsEditor.ctlKey, 'a'));
+            await searchBox.sendKeys(`${category}>${title}`);
+            return await self._getSettingItem(title, category);
+        });
     }
     /**
      * Search for a setting with a precise ID.

package/out/components/editor/TextEditor.d.ts

@@ -117,7 +117,7 @@ export declare class TextEditor extends Editor {
      * @returns Selection page object
      */
     getSelection(): Promise<Selection | undefined>;
-    openFindWidget(): Promise<FindWidget>;
+    openFindWidget(timeout?: number): Promise<FindWidget>;
     /**
      * Add the given text to the given coordinates
      * @param line number of the line to type into
@@ -274,6 +274,7 @@ export declare class CodeLens extends AbstractElement {
  */
 export declare class FindWidget extends AbstractElement {
     constructor(element: WebElement, editor: TextEditor);
+    protected reinitialize(): Promise<this>;
     /**
      * Toggle between find and replace mode
      * @param replace true for replace, false for find

package/out/components/editor/TextEditor.js

@@ -83,57 +83,61 @@ class TextEditor extends Editor_1.Editor {
      * @returns Promise resolving to ContentAssist object when opening, void otherwise
      */
     async toggleContentAssist(open) {
-        let isHidden = true;
-        try {
-            const assist = await this.findElement(TextEditor.locators.ContentAssist.constructor);
-            const klass = await assist.getAttribute('class');
-            const visibility = await assist.getCssValue('visibility');
-            isHidden = klass.indexOf('visible') < 0 || visibility === 'hidden';
-        }
-        catch (err) {
-            isHidden = true;
-        }
-        const inputarea = await this.findElement(TextEditor.locators.Editor.inputArea);
-        if (open) {
-            if (isHidden) {
-                await inputarea.sendKeys(selenium_webdriver_1.Key.chord(selenium_webdriver_1.Key.CONTROL, selenium_webdriver_1.Key.SPACE));
-                await this.getDriver().wait(selenium_webdriver_1.until.elementLocated(TextEditor.locators.ContentAssist.constructor), 2000);
+        return this.withRecovery(async (self) => {
+            let isHidden = true;
+            try {
+                const assist = await self.findElement(TextEditor.locators.ContentAssist.constructor);
+                const klass = await assist.getAttribute('class');
+                const visibility = await assist.getCssValue('visibility');
+                isHidden = klass.indexOf('visible') < 0 || visibility === 'hidden';
             }
-            const assist = await new __1.ContentAssist(this).wait();
-            await this.getDriver().wait(() => {
-                return assist.isLoaded();
-            }, 10000);
-            return assist;
-        }
-        else {
-            if (!isHidden) {
-                await inputarea.sendKeys(selenium_webdriver_1.Key.ESCAPE);
+            catch (err) {
+                isHidden = true;
             }
-        }
+            const inputarea = await self.findElement(TextEditor.locators.Editor.inputArea);
+            if (open) {
+                if (isHidden) {
+                    await inputarea.sendKeys(selenium_webdriver_1.Key.chord(selenium_webdriver_1.Key.CONTROL, selenium_webdriver_1.Key.SPACE));
+                    await self.getDriver().wait(selenium_webdriver_1.until.elementLocated(TextEditor.locators.ContentAssist.constructor), 2000);
+                }
+                const assist = await new __1.ContentAssist(self).wait();
+                await self.getDriver().wait(() => {
+                    return assist.isLoaded();
+                }, 10000);
+                return assist;
+            }
+            else {
+                if (!isHidden) {
+                    await inputarea.sendKeys(selenium_webdriver_1.Key.ESCAPE);
+                }
+            }
+        });
     }
     /**
      * Get all text from the editor
      * @returns Promise resolving to editor text
      */
     async getText() {
-        const clipboard = (await import('clipboardy')).default;
-        let originalClipboard = '';
-        try {
-            originalClipboard = clipboard.readSync();
-        }
-        catch (error) {
-            // workaround issue https://github.com/redhat-developer/vscode-extension-tester/issues/835
-            // do not fail if clipboard is empty
-        }
-        const inputarea = await this.findElement(TextEditor.locators.Editor.inputArea);
-        await inputarea.sendKeys(selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'a'), selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'c'));
-        await new Promise((res) => setTimeout(res, 500));
-        const text = clipboard.readSync();
-        await inputarea.sendKeys(selenium_webdriver_1.Key.UP);
-        if (originalClipboard.length > 0) {
-            clipboard.writeSync(originalClipboard);
-        }
-        return text;
+        return this.withRecovery(async (self) => {
+            const clipboard = (await import('clipboardy')).default;
+            let originalClipboard = '';
+            try {
+                originalClipboard = clipboard.readSync();
+            }
+            catch (error) {
+                // workaround issue https://github.com/redhat-developer/vscode-extension-tester/issues/835
+                // do not fail if clipboard is empty
+            }
+            const inputarea = await self.findElement(TextEditor.locators.Editor.inputArea);
+            await inputarea.sendKeys(selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'a'), selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'c'));
+            await new Promise((res) => setTimeout(res, 500));
+            const text = clipboard.readSync();
+            await inputarea.sendKeys(selenium_webdriver_1.Key.UP);
+            if (originalClipboard.length > 0) {
+                clipboard.writeSync(originalClipboard);
+            }
+            return text;
+        });
     }
     /**
      * Replace the contents of the editor with a given text
@@ -166,9 +170,11 @@ class TextEditor extends Editor_1.Editor {
      * @returns Promise resolving once the text is deleted
      */
     async clearText() {
-        const inputarea = await this.findElement(TextEditor.locators.Editor.inputArea);
-        await inputarea.sendKeys(selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'a'));
-        await inputarea.sendKeys(selenium_webdriver_1.Key.BACK_SPACE);
+        return this.withRecovery(async (self) => {
+            const input = await self.findElement(TextEditor.locators.Editor.inputArea);
+            await input.sendKeys(selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'a'));
+            await input.sendKeys(selenium_webdriver_1.Key.BACK_SPACE);
+        });
     }
     /**
      * Get text from a given line
@@ -291,12 +297,12 @@ class TextEditor extends Editor_1.Editor {
         }
         return new Selection(selection[0], this);
     }
-    async openFindWidget() {
+    async openFindWidget(timeout = 2_000) {
         const actions = this.getDriver().actions();
         await actions.clear();
         await actions.keyDown(TextEditor.ctlKey).sendKeys('f').keyUp(TextEditor.ctlKey).perform();
-        const widget = await this.getDriver().wait(selenium_webdriver_1.until.elementLocated(TextEditor.locators.TextEditor.findWidget), 2000);
-        await this.getDriver().wait(selenium_webdriver_1.until.elementIsVisible(widget), 2000);
+        const widget = await this.getDriver().wait(selenium_webdriver_1.until.elementLocated(TextEditor.locators.TextEditor.findWidget), timeout);
+        await this.getDriver().wait(selenium_webdriver_1.until.elementIsVisible(widget), timeout);
         return new FindWidget(widget, this);
     }
     /**
@@ -695,6 +701,11 @@ class FindWidget extends AbstractElement_1.AbstractElement {
     constructor(element, editor) {
         super(element, editor);
     }
+    async reinitialize() {
+        const editor = this.enclosingItem;
+        const widgetElement = await editor.findElement(FindWidget.locators.TextEditor.findWidget);
+        return new this.constructor(widgetElement, editor);
+    }
     /**
      * Toggle between find and replace mode
      * @param replace true for replace, false for find

package/out/components/sidebar/debug/DebugView.js

@@ -38,7 +38,7 @@ class DebugView extends SideBarView_1.SideBarView {
         }
         const action = await this.getTitlePart().findElement(DebugView.locators.DebugView.launchCombo);
         const combo = await action.findElement(DebugView.locators.DebugView.launchSelect);
-        return await combo.getAttribute('title');
+        return await combo.getAttribute(DebugView.locators.DebugView.launchSelectAttribute);
     }
     /**
      * Get titles of all available launch configurations

package/out/locators/locators.d.ts

@@ -98,6 +98,7 @@ export interface Locators {
         constructor: By;
         actionsLabel: string;
         optionByName: (name: string) => By;
+        currentChannelAttribute: string;
     };
     WebviewView: {
         iframe: By;
@@ -445,6 +446,7 @@ export interface Locators {
     DebugView: {
         launchCombo: By;
         launchSelect: By;
+        launchSelectAttribute: string;
         launchOption: By;
         optionByName: (name: string) => By;
         startButton: By;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redhat-developer/page-objects",
-  "version": "1.13.0",
+  "version": "1.14.1",
   "description": "Page Object API implementation for a VS Code editor used by ExTester framework.",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -47,5 +47,5 @@
     "selenium-webdriver": ">=4.6.1",
     "typescript": ">=4.6.2"
   },
-  "gitHead": "4db425755901a5152c4379656b75ab97193c1988"
+  "gitHead": "f7c20839e93f93fdfe96e56a53c55b3d2c7fde92"
 }