browsertime 26.3.2 → 27.0.0

package/lib/core/engine/command/addText.js

@@ -1,5 +1,7 @@
-import { By } from 'selenium-webdriver';
+import webdriver, { By } from 'selenium-webdriver';
 import { getLogger } from '@sitespeed.io/log';
+import { executeCommand } from './commandHelper.js';
+import { parseSelector } from './selectorParser.js';
 const log = getLogger('browsertime.command.addText');
 
 /**
@@ -8,17 +10,71 @@ const log = getLogger('browsertime.command.addText');
  * @hideconstructor
  */
 export class AddText {
-  constructor(browser) {
+  constructor(browser, options) {
     /**
      * @private
      */
     this.browser = browser;
+    /**
+     * @private
+     */
+    this.options = options;
+  }
+
+  /**
+   * @private
+   */
+  async _waitForElement(driver, locator) {
+    const timeout = this.options?.timeouts?.elementWait ?? 0;
+    if (timeout > 0) {
+      await driver.wait(webdriver.until.elementLocated(locator), timeout);
+    }
+  }
+
+  /**
+   * @private
+   */
+  async _getUrl() {
+    try {
+      return ` on ${await this.browser.getDriver().getCurrentUrl()}`;
+    } catch {
+      return '';
+    }
+  }
+
+  /**
+   * Adds text to an element using a unified selector string.
+   * Supports CSS selectors (default), and prefix-based strategies:
+   * 'id:myId', 'xpath://input', 'name:email', 'class:input-field'.
+   *
+   * @async
+   * @param {string} selector - The selector string. CSS by default, or use a prefix.
+   * @param {string} text - The text string to add.
+   * @returns {Promise<void>} A promise that resolves when the text has been added.
+   * @throws {Error} Throws an error if the element is not found.
+   */
+  async run(selector, text) {
+    const { locator, description } = parseSelector(selector);
+    return executeCommand(
+      log,
+      'Could not add text %s to %s',
+      description,
+      async () => {
+        const driver = this.browser.getDriver();
+        await this._waitForElement(driver, locator);
+        const element = await driver.findElement(locator);
+        await element.clear();
+        return element.sendKeys(text);
+      },
+      this.browser
+    );
   }
 
   /**
    * Adds text to an element identified by its ID.
    *
    * @async
+   * @private
    * @example commands.addText.byId('mytext', 'id');
    * @param {string} text - The text string to add.
    * @param {string} id - The ID of the element.
@@ -28,11 +84,14 @@ export class AddText {
   async byId(text, id) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(By.id(id));
+      const locator = By.id(id);
+      await this._waitForElement(driver, locator);
+      const element = await driver.findElement(locator);
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
     } catch (error) {
+      const url = await this._getUrl();
       log.error(
         'Could not add text %s to id %s error:%s',
         text,
@@ -40,7 +99,7 @@ export class AddText {
         error.message
       );
       log.verbose(error);
-      throw new Error(`Could not add text ${text} to id ${id}`);
+      throw new Error(`Could not add text ${text} to id ${id}${url}`);
     }
   }
 
@@ -48,6 +107,7 @@ export class AddText {
    * Adds text to an element identified by its XPath.
    *
    * @async
+   * @private
    * @example commands.addText.byXpath('mytext', 'xpath');
    * @param {string} text - The text string to add.
    * @param {string} xpath - The XPath of the element.
@@ -57,11 +117,14 @@ export class AddText {
   async byXpath(text, xpath) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(By.xpath(xpath));
+      const locator = By.xpath(xpath);
+      await this._waitForElement(driver, locator);
+      const element = await driver.findElement(locator);
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
     } catch (error) {
+      const url = await this._getUrl();
       log.error(
         'Could not add text %s to xpath %s error: %s',
         text,
@@ -69,7 +132,7 @@ export class AddText {
         error.message
       );
       log.verbose(error);
-      throw new Error(`Could not add text ${text} to xpath ${xpath}`);
+      throw new Error(`Could not add text ${text} to xpath ${xpath}${url}`);
     }
   }
 
@@ -77,6 +140,7 @@ export class AddText {
    * Adds text to an element identified by its CSS selector.
    *
    * @async
+   * @private
    * @example commands.addText.bySelector('mytext', 'selector');
    * @param {string} text - The text string to add.
    * @param {string} selector - The CSS selector of the element.
@@ -86,11 +150,14 @@ export class AddText {
   async bySelector(text, selector) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(By.css(selector));
+      const locator = By.css(selector);
+      await this._waitForElement(driver, locator);
+      const element = await driver.findElement(locator);
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
     } catch (error) {
+      const url = await this._getUrl();
       log.error(
         'Could not add text %s to selector %s error: %s',
         text,
@@ -98,7 +165,9 @@ export class AddText {
         error.message
       );
       log.verbose(error);
-      throw new Error(`Could not add text ${text} to selector ${selector}`);
+      throw new Error(
+        `Could not add text ${text} to selector ${selector}${url}`
+      );
     }
   }
 
@@ -106,6 +175,7 @@ export class AddText {
    * Adds text to an element identified by its class name.
    *
    * @async
+   * @private
    * @example commands.addText.byClassName('mytext', 'className');
    * @param {string} text - The text string to add.
    * @param {string} className - The class name of the element.
@@ -115,11 +185,14 @@ export class AddText {
   async byClassName(text, className) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(By.className(className));
+      const locator = By.className(className);
+      await this._waitForElement(driver, locator);
+      const element = await driver.findElement(locator);
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
     } catch (error) {
+      const url = await this._getUrl();
       log.error(
         'Could not add text %s to class name %s error: %s',
         text,
@@ -127,7 +200,9 @@ export class AddText {
         error.message
       );
       log.verbose(error);
-      throw new Error(`Could not add text ${text} to class name ${className}`);
+      throw new Error(
+        `Could not add text ${text} to class name ${className}${url}`
+      );
     }
   }
 
@@ -135,6 +210,7 @@ export class AddText {
    * Adds text to an element identified by its name attribute.
    *
    * @async
+   * @private
    * @example commands.addText.byName('mytext', 'name');
    * @param {string} text - The text string to add.
    * @param {string} name - The name attribute of the element.
@@ -144,11 +220,14 @@ export class AddText {
   async byName(text, name) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(By.name(name));
+      const locator = By.name(name);
+      await this._waitForElement(driver, locator);
+      const element = await driver.findElement(locator);
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
     } catch (error) {
+      const url = await this._getUrl();
       log.error(
         'Could not add text %s to name attribute %s error: %s',
         text,
@@ -156,7 +235,9 @@ export class AddText {
         error.message
       );
       log.verbose(error);
-      throw new Error(`Could not add text ${text} to name attribute ${name}`);
+      throw new Error(
+        `Could not add text ${text} to name attribute ${name}${url}`
+      );
     }
   }
 }