codeceptjs 3.3.7-beta.1 → 3.3.8-beta.1

package/docs/build/TestCafe.js

@@ -575,7 +575,7 @@ class TestCafe extends Helper {
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
     const els = (await findElements.call(this, this.context, locator)).filterVisible();
-    await assertElementExists(els);
+    await assertElementExists(els, locator);
 
     return this.t
       .hover(els.nth(0), { offsetX, offsetY })
@@ -639,7 +639,7 @@ class TestCafe extends Helper {
       matcher = await els.nth(0);
     }
     const els = (await findClickable.call(this, matcher, locator)).filterVisible();
-    assertElementExists(els);
+    assertElementExists(els, locator);
     return this.t
       .rightClick(els.nth(0))
       .catch(mapError);
@@ -926,7 +926,7 @@ class TestCafe extends Helper {
   async seeElement(locator) {
     const exists = (await findElements.call(this, this.context, locator)).filterVisible().exists;
     return this.t
-      .expect(exists).ok(`No element "${locator}" found`)
+      .expect(exists).ok(`No element "${(new Locator(locator))}" found`)
       .catch(mapError);
   }
 
@@ -944,7 +944,7 @@ class TestCafe extends Helper {
   async dontSeeElement(locator) {
     const exists = (await findElements.call(this, this.context, locator)).filterVisible().exists;
     return this.t
-      .expect(exists).notOk(`Element "${locator}" is still visible`)
+      .expect(exists).notOk(`Element "${(new Locator(locator))}" is still visible`)
       .catch(mapError);
   }
 
@@ -962,7 +962,7 @@ class TestCafe extends Helper {
   async seeElementInDOM(locator) {
     const exists = (await findElements.call(this, this.context, locator)).exists;
     return this.t
-      .expect(exists).ok(`No element "${locator}" found in DOM`)
+      .expect(exists).ok(`No element "${(new Locator(locator))}" found in DOM`)
       .catch(mapError);
   }
 
@@ -980,7 +980,7 @@ class TestCafe extends Helper {
   async dontSeeElementInDOM(locator) {
     const exists = (await findElements.call(this, this.context, locator)).exists;
     return this.t
-      .expect(exists).notOk(`Element "${locator}" is still in DOM`)
+      .expect(exists).notOk(`Element "${(new Locator(locator))}" is still in DOM`)
       .catch(mapError);
   }
 
@@ -1135,10 +1135,10 @@ class TestCafe extends Helper {
     const outputFile = path.join(global.output_dir, fileName);
 
     const sel = await findElements.call(this, this.context, locator);
-    assertElementExists(sel);
+    assertElementExists(sel, locator);
     const firstElement = await sel.filterVisible().nth(0);
 
-    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    this.debug(`Screenshot of ${(new Locator(locator))} element has been saved to ${outputFile}`);
     return this.t.takeElementScreenshot(firstElement, fileName);
   }
 
@@ -1257,7 +1257,7 @@ class TestCafe extends Helper {
    */
   async grabTextFrom(locator) {
     const sel = await findElements.call(this, this.context, locator);
-    assertElementExists(sel);
+    assertElementExists(sel, locator);
     const texts = await this.grabTextFromAll(locator);
     if (texts.length > 1) {
       this.debugSection('GrabText', `Using first element out of ${texts.length}`);
@@ -1305,7 +1305,7 @@ class TestCafe extends Helper {
    */
   async grabAttributeFrom(locator, attr) {
     const sel = await findElements.call(this, this.context, locator);
-    assertElementExists(sel);
+    assertElementExists(sel, locator);
     const attrs = await this.grabAttributeFromAll(locator, attr);
     if (attrs.length > 1) {
       this.debugSection('GrabAttribute', `Using first element out of ${attrs.length}`);
@@ -1350,7 +1350,7 @@ class TestCafe extends Helper {
    */
   async grabValueFrom(locator) {
     const sel = await findElements.call(this, this.context, locator);
-    assertElementExists(sel);
+    assertElementExists(sel, locator);
     const values = await this.grabValueFromAll(locator);
     if (values.length > 1) {
       this.debugSection('GrabValue', `Using first element out of ${values.length}`);
@@ -1761,7 +1761,7 @@ class TestCafe extends Helper {
 
     return this.t
       .expect(createSelector(locator).with({ boundTestRun: this.t }).filterVisible().count)
-      .eql(num, `The number of elements (${locator}) is not ${num} after ${sec} sec`, { timeout: waitTimeout })
+      .eql(num, `The number of elements (${(new Locator(locator))}) is not ${num} after ${sec} sec`, { timeout: waitTimeout })
       .catch(mapError);
   }
 

package/docs/build/WebDriver.js

@@ -46,7 +46,7 @@ let version;
  * @prop {string} [host=localhost] - WebDriver host to connect.
  * @prop {number} [port=4444] - WebDriver port to connect.
  * @prop {string} [protocol=http] - protocol for WebDriver server.
- * @prop {string} [path=/wd/hub] - path to WebDriver server,
+ * @prop {string} [path=/wd/hub] - path to WebDriver server.
  * @prop {boolean} [restart=true] - restart browser between tests.
  * @prop {boolean|number} [smartWait=false] - **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
  * @prop {boolean} [disableScreenshots=false] - don't save screenshots on failure.
@@ -463,7 +463,7 @@ class WebDriver extends Helper {
       delete config.capabilities.selenoidOptions;
     }
 
-    config.waitForTimeout /= 1000; // convert to seconds
+    config.waitForTimeoutInSeconds = config.waitForTimeout / 1000; // convert to seconds
 
     if (!config.capabilities.platformName && (!config.url || !config.browser)) {
       throw new Error(`
@@ -1440,7 +1440,7 @@ class WebDriver extends Helper {
    */
   async grabHTMLFrom(locator) {
     const html = await this.grabHTMLFromAll(locator);
-    assertElementExists(html);
+    assertElementExists(html, locator);
     if (html.length > 1) {
       this.debugSection('GrabHTML', `Using first element out of ${html.length}`);
     }
@@ -1789,7 +1789,7 @@ class WebDriver extends Helper {
     const res = await this._locate(locator, true);
     assertElementExists(res, locator);
     const selected = await forEachAsync(res, async el => el.isDisplayed());
-    return truth(`elements of ${locator}`, 'to be seen').assert(selected);
+    return truth(`elements of ${(new Locator(locator))}`, 'to be seen').assert(selected);
   }
 
   /**
@@ -1807,10 +1807,10 @@ class WebDriver extends Helper {
   async dontSeeElement(locator) {
     const res = await this._locate(locator, false);
     if (!res || res.length === 0) {
-      return truth(`elements of ${locator}`, 'to be seen').negate(false);
+      return truth(`elements of ${(new Locator(locator))}`, 'to be seen').negate(false);
     }
     const selected = await forEachAsync(res, async el => el.isDisplayed());
-    return truth(`elements of ${locator}`, 'to be seen').negate(selected);
+    return truth(`elements of ${(new Locator(locator))}`, 'to be seen').negate(selected);
   }
 
   /**
@@ -1948,7 +1948,7 @@ class WebDriver extends Helper {
    */
   async seeNumberOfElements(locator, num) {
     const res = await this._locate(locator);
-    return assert.equal(res.length, num, `expected number of elements (${locator}) is ${num}, but found ${res.length}`);
+    return assert.equal(res.length, num, `expected number of elements (${(new Locator(locator))}) is ${num}, but found ${res.length}`);
   }
 
   /**
@@ -1967,7 +1967,7 @@ class WebDriver extends Helper {
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
-    return assert.equal(res, num, `expected number of visible elements (${locator}) is ${num}, but found ${res}`);
+    return assert.equal(res, num, `expected number of visible elements (${(new Locator(locator))}) is ${num}, but found ${res}`);
   }
 
   /**
@@ -2010,7 +2010,7 @@ class WebDriver extends Helper {
     });
     return assert.ok(
       chunked.length === elemAmount,
-      `expected all elements (${locator}) to have CSS property ${JSON.stringify(cssProperties)}`,
+      `expected all elements (${(new Locator(locator))}) to have CSS property ${JSON.stringify(cssProperties)}`,
     );
   }
 
@@ -2046,7 +2046,7 @@ class WebDriver extends Helper {
     });
     return assert.ok(
       chunked.length === elemAmount,
-      `expected all elements (${locator}) to have attributes ${JSON.stringify(attributes)}`,
+      `expected all elements (${(new Locator(locator))}) to have attributes ${JSON.stringify(attributes)}`,
     );
   }
 
@@ -2224,7 +2224,7 @@ class WebDriver extends Helper {
    */
   async scrollIntoView(locator, scrollIntoViewOptions) {
     const res = await this._locate(withStrictLocator(locator), true);
-    assertElementExists(res);
+    assertElementExists(res, locator);
     const elem = usingFirstElement(res);
     return elem.scrollIntoView(scrollIntoViewOptions);
   }
@@ -2254,12 +2254,12 @@ class WebDriver extends Helper {
 
     if (locator) {
       const res = await this._locate(withStrictLocator(locator), true);
-      assertElementExists(res);
+      assertElementExists(res, locator);
       const elem = usingFirstElement(res);
       const elementId = getElementId(elem);
       if (this.browser.isMobile && !this.browser.isW3C) return this.browser.touchScroll(offsetX, offsetY, elementId);
       const location = await elem.getLocation();
-      assertElementExists(location, 'Failed to receive', 'location');
+      assertElementExists(location, locator, 'Failed to receive', 'location');
       /* eslint-disable prefer-arrow-callback */
       return this.browser.execute(function (x, y) { return window.scrollTo(x, y); }, location.x + offsetX, location.y + offsetY);
       /* eslint-enable */
@@ -2316,7 +2316,7 @@ class WebDriver extends Helper {
     assertElementExists(res, locator);
     const elem = usingFirstElement(res);
 
-    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    this.debug(`Screenshot of ${(new Locator(locator))} element has been saved to ${outputFile}`);
     return elem.saveScreenshot(outputFile);
   }
 
@@ -2773,11 +2773,11 @@ class WebDriver extends Helper {
    */
   async dragAndDrop(srcElement, destElement) {
     let sourceEl = await this._locate(srcElement);
-    assertElementExists(sourceEl);
+    assertElementExists(sourceEl, srcElement);
     sourceEl = usingFirstElement(sourceEl);
 
     let destEl = await this._locate(destElement);
-    assertElementExists(destEl);
+    assertElementExists(destEl, destElement);
     destEl = usingFirstElement(destEl);
 
     return sourceEl.dragAndDrop(destEl);
@@ -2922,7 +2922,7 @@ class WebDriver extends Helper {
    * 
    */
   async waitForEnabled(locator, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
         const res = await this.$$(withStrictLocator(locator));
@@ -2967,17 +2967,17 @@ class WebDriver extends Helper {
    * 
    */
   async waitForElement(locator, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
         const res = await this.$$(withStrictLocator(locator));
         return res && res.length;
-      }, aSec * 1000, `element (${locator}) still not present on page after ${aSec} sec`);
+      }, aSec * 1000, `element (${(new Locator(locator))}) still not present on page after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       return res && res.length;
-    }, { timeout: aSec * 1000, timeoutMsg: `element (${locator}) still not present on page after ${aSec} sec` });
+    }, { timeout: aSec * 1000, timeoutMsg: `element (${(new Locator(locator))}) still not present on page after ${aSec} sec` });
   }
 
   /**
@@ -2995,7 +2995,7 @@ class WebDriver extends Helper {
    * 
    */
   async waitForClickable(locator, waitTimeout) {
-    waitTimeout = waitTimeout || this.options.waitForTimeout;
+    waitTimeout = waitTimeout || this.options.waitForTimeoutInSeconds;
     let res = await this._locate(locator);
     res = usingFirstElement(res);
     assertElementExists(res, locator);
@@ -3020,7 +3020,7 @@ class WebDriver extends Helper {
    */
   async waitInUrl(urlPart, sec = null) {
     const client = this.browser;
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     let currUrl = '';
     if (isWebDriver5()) {
       return client
@@ -3064,7 +3064,7 @@ class WebDriver extends Helper {
    * 
    */
   async waitUrlEquals(urlPart, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     const baseUrl = this.options.url;
     if (urlPart.indexOf('http') < 0) {
       urlPart = baseUrl + urlPart;
@@ -3101,7 +3101,7 @@ class WebDriver extends Helper {
    *
    */
   async waitForText(text, sec = null, context = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     const _context = context || this.root;
     if (isWebDriver5()) {
       return this.browser.waitUntil(
@@ -3149,7 +3149,7 @@ class WebDriver extends Helper {
    */
   async waitForValue(field, value, sec = null) {
     const client = this.browser;
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return client.waitUntil(
         async () => {
@@ -3195,7 +3195,7 @@ class WebDriver extends Helper {
    *
    */
   async waitForVisible(locator, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
         const res = await this.$$(withStrictLocator(locator));
@@ -3232,7 +3232,7 @@ class WebDriver extends Helper {
    * 
    */
   async waitNumberOfVisibleElements(locator, num, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
         const res = await this.$$(withStrictLocator(locator));
@@ -3269,7 +3269,7 @@ class WebDriver extends Helper {
    * 
    */
   async waitForInvisible(locator, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
         const res = await this.$$(withStrictLocator(locator));
@@ -3317,7 +3317,7 @@ class WebDriver extends Helper {
    * 
    */
   async waitForDetached(locator, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
         const res = await this._res(locator);
@@ -3366,7 +3366,7 @@ class WebDriver extends Helper {
       }
     }
 
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), aSec * 1000, '');
     }
@@ -3414,7 +3414,7 @@ class WebDriver extends Helper {
    * 
    */
   async switchToNextTab(num = 1, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     let target;
     const current = await this.browser.getWindowHandle();
 
@@ -3455,7 +3455,7 @@ class WebDriver extends Helper {
    * 
    */
   async switchToPreviousTab(num = 1, sec = null) {
-    const aSec = sec || this.options.waitForTimeout;
+    const aSec = sec || this.options.waitForTimeoutInSeconds;
     const current = await this.browser.getWindowHandle();
     let target;
 

package/docs/changelog.md

@@ -7,13 +7,48 @@ layout: Section
 
 # Releases
 
+## 3.3.7
+
+🛩️ Features
+
+* **Promise-based typings** for TypeScript definitions in [#3465](https://github.com/codeceptjs/CodeceptJS/issues/3465) by **[nlespiaucq](https://github.com/nlespiaucq)**. If you use TypeScript or use linters [check how it may be useful to you](https://bit.ly/3XIMq6n).
+* **Translation** improved to use [custom vocabulary](https://codecept.io/translation/). 
+* **[Playwright]** Added methods in [#3398](https://github.com/codeceptjs/CodeceptJS/issues/3398) by **[mirao](https://github.com/mirao)**
+  * `restartBrowser` - to restart a browser (with different config)
+  * `_createContextPage` - to create a new browser context with a page from a helper
+* Added [Cucumber custom types](/bdd#custom-types) for BDD in [#3435](https://github.com/codeceptjs/CodeceptJS/issues/3435) by **[Likstern](https://github.com/Likstern)** 
+* Propose using JSONResponse helper when initializing project for API testing. [#3455](https://github.com/codeceptjs/CodeceptJS/issues/3455) by **[PeterNgTr](https://github.com/PeterNgTr)** 
+* When translation enabled, generate tests using localized aliases. By **[davertmik](https://github.com/davertmik)**
+* **[Appium]** Added `checkIfAppIsInstalled` in [#3507](https://github.com/codeceptjs/CodeceptJS/issues/3507) by **[PeterNgTr](https://github.com/PeterNgTr)** 
+
+🐛 Bugfixes
+
+* Fixed [#3462](https://github.com/codeceptjs/CodeceptJS/issues/3462) `TypeError: Cannot read properties of undefined (reading 'setStatus')` by **[dwentland24](https://github.com/dwentland24)** in [#3438](https://github.com/codeceptjs/CodeceptJS/issues/3438)
+* Fixed creating steps file for TypeScript setup [#3459](https://github.com/codeceptjs/CodeceptJS/issues/3459) by **[PeterNgTr](https://github.com/PeterNgTr)** 
+* Fixed issue of after all event in `run-rerun` command after complete execution [#3464](https://github.com/codeceptjs/CodeceptJS/issues/3464) by **[jain-neeeraj](https://github.com/jain-neeeraj)** 
+* [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See [#3478](https://github.com/codeceptjs/CodeceptJS/issues/3478) by **[pmajewski24](https://github.com/pmajewski24)**. Fixes [#2589](https://github.com/codeceptjs/CodeceptJS/issues/2589)
+* [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes `Element "{null: undefined}" was not found` and `element ([object Object]) still not present` messages when using object locators. See [#3501](https://github.com/codeceptjs/CodeceptJS/issues/3501) and [#3502](https://github.com/codeceptjs/CodeceptJS/issues/3502) by **[pmajewski24](https://github.com/pmajewski24)**
+* **[Playwright]** Improved file names when downloading file in [#3449](https://github.com/codeceptjs/CodeceptJS/issues/3449) by **[PeterNgTr](https://github.com/PeterNgTr)**. Fixes [#3412](https://github.com/codeceptjs/CodeceptJS/issues/3412) and [#3409](https://github.com/codeceptjs/CodeceptJS/issues/3409)
+* Add default value to `profile` env variable. See [#3443](https://github.com/codeceptjs/CodeceptJS/issues/3443) by **[dwentland24](https://github.com/dwentland24)**. Resolves [#3339](https://github.com/codeceptjs/CodeceptJS/issues/3339)
+* **[Playwright]** Using system-native path separator when saving artifacts in [#3460](https://github.com/codeceptjs/CodeceptJS/issues/3460) by **[PeterNgTr](https://github.com/PeterNgTr)**
+* **[Playwright]** Saving videos and traces from multiple sessions in [#3505](https://github.com/codeceptjs/CodeceptJS/issues/3505) by **[davertmik](https://github.com/davertmik)**
+* **[Playwright]** Fixed `amOnPage` to navigate to `about:blank` by **[zaxoavoki](https://github.com/zaxoavoki)** in [#3470](https://github.com/codeceptjs/CodeceptJS/issues/3470) Fixes [#2311](https://github.com/codeceptjs/CodeceptJS/issues/2311)
+* Various typing improvements by **[AWolf81](https://github.com/AWolf81)** **[PeterNgTr](https://github.com/PeterNgTr)** **[mirao](https://github.com/mirao)**  
+
+📖 Documentation
+
+* Updated [Auickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init
+* Added [Translation](/translations/) guide
+* Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings
+* Reordered guides list on a website
+
 ## 3.3.6
 
 * [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by **[dwentland24](https://github.com/dwentland24)** in [#3436](https://github.com/codeceptjs/CodeceptJS/issues/3436). Use it to perform run multiple times and detect flaky tests
 * Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26
 * **[Playwright]** Fixed properties types "waitForNavigation" and "firefox" by **[mirao](https://github.com/mirao)** in [#3401](https://github.com/codeceptjs/CodeceptJS/issues/3401)
 * **[REST]** Changed "endpoint" to optional by **[mirao](https://github.com/mirao)** in [#3404](https://github.com/codeceptjs/CodeceptJS/issues/3404)
-* **[REST]** Use [`secret`]() for form encoded string by **[PeterNgTr](https://github.com/PeterNgTr)**:
+* **[REST]** Use [`secret`](/secrets) for form encoded string by **[PeterNgTr](https://github.com/PeterNgTr)**:
 
 ```js
 const secretData = secret('name=john&password=123456');