[js] Fix error message after a timeout looking for an element.

Fixes #966

Author: jleyba

javascript/node/selenium-webdriver/CHANGES.md

@@ -1,6 +1,8 @@
 ## v2.46.1
 
 * Fixed internal module loading on Windows.
+* Fixed error message format on timeouts for `until.elementLocated()`
+    and `until.elementsLocated()`.
 
 ## v2.46.0
 

javascript/webdriver/test/until_test.js

@@ -237,6 +237,35 @@ function testUntilElementLocated() {
       });
 }
 
+function runNoElementFoundTest(locator, locatorStr) {
+  executor.on(CommandName.FIND_ELEMENTS, function(cmd, callback) {
+    callback(null, bot.response.createResponse([]));
+  });
+
+  function expectedFailure() {
+    fail('expected condition to timeout');
+  }
+
+  return driver.wait(until.elementLocated(locator), 100)
+      .then(expectedFailure, function(error) {
+        var expected = 'Waiting for element to be located ' + locatorStr;
+        var lines = error.message.split(/\n/, 2);
+        assertEquals(expected, lines[0]);
+        assertRegExp(/^Wait timed out after \d+ms$/, lines[1]);
+      });
+}
+
+function testUntilElementLocated_elementNeverFound_byLocator() {
+  return runNoElementFoundTest(By.id('quux'), 'By.id("quux")');
+}
+
+function testUntilElementLocated_elementNeverFound_byHash() {
+  return runNoElementFoundTest({id: 'quux'}, 'By.id("quux")');
+}
+
+function testUntilElementLocated_elementNeverFound_byFunction() {
+  return runNoElementFoundTest(goog.nullFunction, 'by function()');
+}
 
 function testUntilElementsLocated() {
   var responses = [[], [{ELEMENT: 'abc123'}, {ELEMENT: 'foo'}], ['end']];
@@ -257,6 +286,36 @@ function testUntilElementsLocated() {
       });
 }
 
+function runNoElementsFoundTest(locator, locatorStr) {
+  executor.on(CommandName.FIND_ELEMENTS, function(cmd, callback) {
+    callback(null, bot.response.createResponse([]));
+  });
+
+  function expectedFailure() {
+    fail('expected condition to timeout');
+  }
+
+  return driver.wait(until.elementsLocated(locator), 100)
+      .then(expectedFailure, function(error) {
+        var expected =
+            'Waiting for at least one element to be located ' + locatorStr;
+        var lines = error.message.split(/\n/, 2);
+        assertEquals(expected, lines[0]);
+        assertRegExp(/^Wait timed out after \d+ms$/, lines[1]);
+      });
+}
+
+function testUntilElementsLocated_noElementsEverFound_byLocator() {
+  return runNoElementsFoundTest(By.id('quux'), 'By.id("quux")');
+}
+
+function testUntilElementsLocated_noElementsEverFound_byHash() {
+  return runNoElementsFoundTest({id: 'quux'}, 'By.id("quux")');
+}
+
+function testUntilElementsLocated_noElementsEverFound_byFunction() {
+  return runNoElementsFoundTest(goog.nullFunction, 'by function()');
+}
 
 function testUntilStalenessOf() {
   var responses = [

javascript/webdriver/until.js

@@ -44,6 +44,7 @@ goog.provide('webdriver.until');
 goog.require('bot.ErrorCode');
 goog.require('goog.array');
 goog.require('goog.string');
+goog.require('webdriver.Locator');
 
 
 
@@ -208,8 +209,9 @@ until.titleMatches = function(regex) {
  * @return {!until.Condition.<!webdriver.WebElement>} The new condition.
  */
 until.elementLocated = function(locator) {
-  var locatorStr = goog.isFunction(locator) ? 'function()' : locator + '';
-  return new until.Condition('element to be located by ' + locatorStr,
+  locator = webdriver.Locator.checkLocator(locator);
+  var locatorStr = goog.isFunction(locator) ? 'by function()' : locator + '';
+  return new until.Condition('for element to be located ' + locatorStr,
       function(driver) {
         return driver.findElements(locator).then(function(elements) {
           return elements[0];
@@ -228,9 +230,10 @@ until.elementLocated = function(locator) {
  *     condition.
  */
 until.elementsLocated = function(locator) {
-  var locatorStr = goog.isFunction(locator) ? 'function()' : locator + '';
+  locator = webdriver.Locator.checkLocator(locator);
+  var locatorStr = goog.isFunction(locator) ? 'by function()' : locator + '';
   return new until.Condition(
-      'at least one element to be located by ' + locatorStr,
+      'for at least one element to be located ' + locatorStr,
       function(driver) {
         return driver.findElements(locator).then(function(elements) {
           return elements.length > 0 ? elements : null;