@redhat-developer/page-objects 1.23.0 → 1.24.0

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

@@ -60,6 +60,40 @@ export declare class TextEditor extends Editor {
      * @returns Promise resolving to ContentAssist object when opening, void otherwise
      */
     toggleContentAssist(open: boolean): Promise<ContentAssist | void>;
+    /**
+     * Find out whether this editor currently has VS Code keyboard focus
+     * @returns Promise resolving to true when the editor's text input is focused
+     */
+    hasFocus(): Promise<boolean>;
+    /**
+     * Bring VS Code keyboard focus into this editor without moving the cursor.
+     *
+     * Editor commands (select all, clipboard actions, the `:Ln,Col` go-to prompt)
+     * and the status bar cursor position all target whichever editor VS Code has
+     * focused, and the editor's zero-width `native-edit-context` input element only
+     * accepts keys while it is the focused element. With several editor groups open
+     * this makes the page object act on its own editor instance instead of on the
+     * group that happened to be focused before.
+     *
+     * @returns Promise resolving once the editor has focus
+     */
+    focus(): Promise<void>;
+    /**
+     * Open the command palette with this editor focused, so editor commands
+     * (select all, clipboard actions, the `:Ln,Col` go-to prompt) run against
+     * this editor instance.
+     *
+     * Focus is moved into this editor first, then the palette is opened with the
+     * global `Ctrl/Cmd+Shift+P` chord. `Workbench.openCommandPrompt()` cannot be
+     * reused here: while any webview editor is open it sends the key to the first
+     * active tab of whatever group, which need not be this editor's group.
+     */
+    private openCommandPrompt;
+    /**
+     * Execute a command from the command palette opened on this editor
+     * @param command id or title of the command
+     */
+    private executeCommand;
     /**
      * Get all text from the editor
      * @returns Promise resolving to editor text

package/out/components/editor/TextEditor.js

@@ -113,6 +113,76 @@ class TextEditor extends Editor_1.Editor {
             }
         });
     }
+    /**
+     * Find out whether this editor currently has VS Code keyboard focus
+     * @returns Promise resolving to true when the editor's text input is focused
+     */
+    async hasFocus() {
+        const container = await this.findElement(TextEditor.locators.TextEditor.editorContainer);
+        const klass = (await container.getAttribute('class')) ?? '';
+        return klass.split(/\s+/).includes('focused');
+    }
+    /**
+     * Bring VS Code keyboard focus into this editor without moving the cursor.
+     *
+     * Editor commands (select all, clipboard actions, the `:Ln,Col` go-to prompt)
+     * and the status bar cursor position all target whichever editor VS Code has
+     * focused, and the editor's zero-width `native-edit-context` input element only
+     * accepts keys while it is the focused element. With several editor groups open
+     * this makes the page object act on its own editor instance instead of on the
+     * group that happened to be focused before.
+     *
+     * @returns Promise resolving once the editor has focus
+     */
+    async focus() {
+        if (await this.hasFocus()) {
+            return;
+        }
+        const inputarea = await this.findElement(TextEditor.locators.Editor.inputArea);
+        await this.getDriver().executeScript('arguments[0].focus()', inputarea);
+        await this.getWaitHelper().forCondition(() => this.hasFocus(), {
+            timeout: 2000,
+            pollInterval: 50,
+            message: 'Editor did not receive focus',
+        });
+    }
+    /**
+     * Open the command palette with this editor focused, so editor commands
+     * (select all, clipboard actions, the `:Ln,Col` go-to prompt) run against
+     * this editor instance.
+     *
+     * Focus is moved into this editor first, then the palette is opened with the
+     * global `Ctrl/Cmd+Shift+P` chord. `Workbench.openCommandPrompt()` cannot be
+     * reused here: while any webview editor is open it sends the key to the first
+     * active tab of whatever group, which need not be this editor's group.
+     */
+    async openCommandPrompt() {
+        await this.focus();
+        await this.getDriver()
+            .actions()
+            .keyDown(AbstractElement_1.AbstractElement.ctlKey)
+            .keyDown(selenium_webdriver_1.Key.SHIFT)
+            .sendKeys('p')
+            .keyUp(selenium_webdriver_1.Key.SHIFT)
+            .keyUp(AbstractElement_1.AbstractElement.ctlKey)
+            .perform();
+        return await __1.InputBox.create();
+    }
+    /**
+     * Execute a command from the command palette opened on this editor
+     * @param command id or title of the command
+     */
+    async executeCommand(command) {
+        const prompt = await this.openCommandPrompt();
+        await prompt.setText(`>${command}`);
+        const quickPicks = await Promise.all((await prompt.getQuickPicks()).map((item) => item.getLabel()));
+        if (quickPicks.includes(command)) {
+            await prompt.selectQuickPick(command);
+        }
+        else {
+            await prompt.confirm();
+        }
+    }
     /**
      * Get all text from the editor
      * @returns Promise resolving to editor text
@@ -128,12 +198,14 @@ class TextEditor extends Editor_1.Editor {
                 // workaround issue https://github.com/redhat-developer/vscode-extension-tester/issues/835
                 // do not fail if clipboard is empty
             }
+            // The status bar position, the select-all/copy commands and the cursor
+            // restore below all act on the focused editor: make sure it is this one.
+            await self.focus();
             // Store current position
-            const [line, col] = await this.getCoordinates();
+            const [line, col] = await self.getCoordinates();
             // Select/copy contents
-            const bench = new __1.Workbench();
-            await bench.executeCommand('editor.action.selectAll');
-            await bench.executeCommand('editor.action.clipboardCopyAction');
+            await self.executeCommand('editor.action.selectAll');
+            await self.executeCommand('editor.action.clipboardCopyAction');
             // Wait for clipboard operation to complete
             await self.getWaitHelper().forCondition(async () => {
                 try {
@@ -150,10 +222,10 @@ class TextEditor extends Editor_1.Editor {
             }
             try {
                 // Restore original cursor position
-                await this.setCursor(line, col);
+                await self.setCursor(line, col);
             }
             catch {
-                await this.sendKeys(selenium_webdriver_1.Key.UP);
+                await self.sendKeys(selenium_webdriver_1.Key.UP);
             }
             return text;
         });
@@ -174,10 +246,10 @@ class TextEditor extends Editor_1.Editor {
             // workaround issue https://github.com/redhat-developer/vscode-extension-tester/issues/835
             // do not fail if clipboard is empty
         }
+        await this.focus();
         const inputarea = await this.findElement(TextEditor.locators.Editor.inputArea);
         clipboard.writeSync(text);
-        const bench = new __1.Workbench();
-        await bench.executeCommand('editor.action.selectAll');
+        await this.executeCommand('editor.action.selectAll');
         await inputarea.sendKeys(selenium_webdriver_1.Key.chord(TextEditor.ctlKey, 'v'));
         if (originalClipboard.length > 0) {
             clipboard.writeSync(originalClipboard);
@@ -358,7 +430,7 @@ class TextEditor extends Editor_1.Editor {
      * @returns Promise resolving when the cursor has reached the given coordinates
      */
     async setCursor(line, column, timeout = 2_500) {
-        const input = await new __1.Workbench().openCommandPrompt();
+        const input = await this.openCommandPrompt();
         await input.setText(`:${line},${column}`);
         try {
             await this.getWaitHelper().forCondition(async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redhat-developer/page-objects",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "Page Object API implementation for a VS Code editor used by ExTester framework.",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -46,8 +46,8 @@
     "fs-extra": "^11.4.0"
   },
   "peerDependencies": {
-    "selenium-webdriver": "^4.48.0",
+    "selenium-webdriver": "^4.49.0",
     "typescript": ">=4.6.2"
   },
-  "gitHead": "2333228475aff111f91b91d06e50a5b98e371886"
+  "gitHead": "ff2802ca28fb11e04d1511e645d555cb67709eb3"
 }