codeceptjs 2.4.3 → 2.6.2

package/docs/build/Protractor.js

@@ -1557,6 +1557,12 @@ class Protractor extends Helper {
   /**
    * Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
    * given string.
+   * 
+   * ```js
+   * I.seeInPopup('Popup text');
+   * ```
+   * @param {string} text value to check.
+   * 
    */
   async seeInPopup(text) {
     const popupAlert = await this.browser.switchTo().alert();
@@ -2256,13 +2262,21 @@ class Protractor extends Helper {
   }
 
   /**
-   * Sets a cookie.
+   * Sets cookie(s).
+   * 
+   * Can be a single cookie object or an array of cookies:
    * 
    * ```js
    * I.setCookie({name: 'auth', value: true});
+   * 
+   * // as array
+   * I.setCookie([
+   *   {name: 'auth', value: true},
+   *   {name: 'agree', value: true}
+   * ]);
    * ```
    * 
-   * @param {object} cookie a cookie object.
+   * @param {object|array} cookie a cookie object or array of cookie objects.
    */
   setCookie(cookie) {
     return this.browser.manage().addCookie(cookie);

package/docs/build/Puppeteer.js

@@ -36,7 +36,6 @@ const findReact = require('./extras/React');
 
 let puppeteer;
 let perfTiming;
-let isAuthenticated = false;
 const popupStore = new Popup();
 const consoleLogStore = new Console();
 
@@ -168,11 +167,14 @@ class Puppeteer extends Helper {
   constructor(config) {
     super(config);
 
-    puppeteer = requireg(config.browser === 'firefox' ? 'puppeteer-firefox' : 'puppeteer');
+    puppeteer = requireg('puppeteer');
 
     // set defaults
     this.isRemoteBrowser = false;
     this.isRunning = false;
+    this.isAuthenticated = false;
+    this.sessionPages = {};
+    this.activeSessionName = '';
 
     // override defaults with config
     this._setConfig(config);
@@ -201,7 +203,7 @@ class Puppeteer extends Helper {
   }
 
   _getOptions(config) {
-    return config.browser === 'firefox' ? this.options.firefox : this.options.chrome;
+    return config.browser === 'firefox' ? Object.assign(this.options.firefox, { product: 'firefox' }) : this.options.chrome;
   }
 
   _setConfig(config) {
@@ -220,6 +222,9 @@ class Puppeteer extends Helper {
       {
         name: 'show', message: 'Show browser window', default: true, type: 'confirm',
       },
+      {
+        name: 'windowSize', message: 'Browser viewport size', default: '1200x900',
+      },
     ];
   }
 
@@ -227,7 +232,7 @@ class Puppeteer extends Helper {
     try {
       requireg('puppeteer');
     } catch (e) {
-      return ['puppeteer@^1.6.0'];
+      return ['puppeteer@^3.0.1'];
     }
   }
 
@@ -243,6 +248,7 @@ class Puppeteer extends Helper {
 
 
   async _before() {
+    this.sessionPages = {};
     recorder.retry({
       retries: 5,
       when: err => err.message.indexOf('context') > -1, // ignore context errors
@@ -257,7 +263,8 @@ class Puppeteer extends Helper {
 
     // close other sessions
     const contexts = this.browser.browserContexts();
-    contexts.shift();
+    const defaultCtx = contexts.shift();
+
     await Promise.all(contexts.map(c => c.close()));
 
     if (this.options.restart) {
@@ -265,6 +272,12 @@ class Puppeteer extends Helper {
       return this._stopBrowser();
     }
 
+    // ensure this.page is from default context
+    if (this.page) {
+      const existingPages = defaultCtx.targets().filter(t => t.type() === 'page');
+      await this._setPage(await existingPages[0].page());
+    }
+
     if (this.options.keepBrowserState) return;
 
     if (!this.options.keepCookies) {
@@ -291,11 +304,13 @@ class Puppeteer extends Helper {
 
   _session() {
     return {
-      start: async () => {
+      start: async (name = '', config) => {
         this.debugSection('Incognito Tab', 'opened');
+        this.activeSessionName = name;
 
         const bc = await this.browser.createIncognitoBrowserContext();
-        await bc.newPage();
+        const page = await bc.newPage();
+
         // Create a new page inside context.
         return bc;
       },
@@ -304,12 +319,21 @@ class Puppeteer extends Helper {
       },
       loadVars: async (context) => {
         const existingPages = context.targets().filter(t => t.type() === 'page');
-        return this._setPage(await existingPages[0].page());
+        this.sessionPages[this.activeSessionName] = await existingPages[0].page();
+        return this._setPage(this.sessionPages[this.activeSessionName]);
       },
-      restoreVars: async () => {
+      restoreVars: async (session) => {
         this.withinLocator = null;
-        const existingPages = await this.browser.targets().filter(t => t.type() === 'page');
+
+        if (!session) {
+          this.activeSessionName = '';
+        } else {
+          this.activeSessionName = session;
+        }
+        const defaultCtx = this.browser.defaultBrowserContext();
+        const existingPages = defaultCtx.targets().filter(t => t.type() === 'page');
         await this._setPage(await existingPages[0].page());
+
         return this._waitForAction();
       },
     };
@@ -363,6 +387,12 @@ class Puppeteer extends Helper {
   /**
    * Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
    * given string.
+   * 
+   * ```js
+   * I.seeInPopup('Popup text');
+   * ```
+   * @param {string} text value to check.
+   * 
    */
   async seeInPopup(text) {
     popupStore.assertPopupVisible();
@@ -475,6 +505,7 @@ class Puppeteer extends Helper {
     this._setPage(null);
     this.context = null;
     popupStore.clear();
+    this.isAuthenticated = false;
     if (this.isRemoteBrowser) {
       await this.browser.disconnect();
     } else {
@@ -552,10 +583,10 @@ class Puppeteer extends Helper {
       url = this.options.url + url;
     }
 
-    if (this.config.basicAuth && (isAuthenticated !== true)) {
+    if (this.config.basicAuth && (this.isAuthenticated !== true)) {
       if (url.includes(this.options.url)) {
-        this.page.authenticate(this.config.basicAuth);
-        isAuthenticated = true;
+        await this.page.authenticate(this.config.basicAuth);
+        this.isAuthenticated = true;
       }
     }
 
@@ -1056,6 +1087,63 @@ class Puppeteer extends Helper {
     return proceedClick.call(this, locator, context);
   }
 
+  /**
+   * Perform an emulated click on a link or a button, given by a locator.
+   * Unlike normal click instead of sending native event, emulates a click with JavaScript.
+   * This works on hidden, animated or inactive elements as well.
+   * 
+   * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
+   * For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
+   * For images, the "alt" attribute and inner text of any parent links are searched.
+   * 
+   * The second parameter is a context (CSS or XPath locator) to narrow the search.
+   * 
+   * ```js
+   * // simple link
+   * I.forceClick('Logout');
+   * // button of form
+   * I.forceClick('Submit');
+   * // CSS button
+   * I.forceClick('#form input[type=submit]');
+   * // XPath
+   * I.forceClick('//form/*[@type=submit]');
+   * // link in context
+   * I.forceClick('Logout', '#nav');
+   * // using strict locator
+   * I.forceClick({css: 'nav a.login'});
+   * ```
+   * 
+   * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+   * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * 
+   *
+   * {{ react }}
+   */
+  async forceClick(locator, context = null) {
+    let matcher = await this.context;
+    if (context) {
+      const els = await this._locate(context);
+      assertElementExists(els, context);
+      matcher = els[0];
+    }
+
+    const els = await findClickable.call(this, matcher, locator);
+    if (context) {
+      assertElementExists(els, locator, 'Clickable element', `was not found inside element ${new Locator(context).toString()}`);
+    } else {
+      assertElementExists(els, locator, 'Clickable element');
+    }
+    const elem = els[0];
+    return this.executeScript((el) => {
+      if (document.activeElement instanceof HTMLElement) {
+        document.activeElement.blur();
+      }
+      const event = document.createEvent('MouseEvent');
+      event.initEvent('click', true, true);
+      return el.dispatchEvent(event);
+    }, elem);
+  }
+
   /**
    * Performs a click on a link and waits for navigation before moving on.
    * 
@@ -1533,6 +1621,8 @@ class Puppeteer extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
    * @param {string} pathToFile local file path relative to codecept.json config file.
+   *
+   * > ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1](https://github.com/puppeteer/puppeteer/issues/5420), downgrade to 2.0.0 if you face it.
    */
   async attachFile(locator, pathToFile) {
     const file = path.join(global.codecept_dir, pathToFile);
@@ -1831,13 +1921,21 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Sets a cookie.
+   * Sets cookie(s).
+   * 
+   * Can be a single cookie object or an array of cookies:
    * 
    * ```js
    * I.setCookie({name: 'auth', value: true});
+   * 
+   * // as array
+   * I.setCookie([
+   *   {name: 'auth', value: true},
+   *   {name: 'agree', value: true}
+   * ]);
    * ```
    * 
-   * @param {object} cookie a cookie object.
+   * @param {object|array} cookie a cookie object or array of cookie objects.
    */
   async setCookie(cookie) {
     if (Array.isArray(cookie)) {
@@ -2248,10 +2346,19 @@ class Puppeteer extends Helper {
     const outputFile = screenshotOutputFolder(fileName);
 
     this.debug(`Screenshot is saving to ${outputFile}`);
-    const openSessions = await this.browser.pages();
-    if (openSessions.length > 1) {
-      this.page = await this.browser.targets()[this.browser.targets().length - 1].page();
+
+    if (this.activeSessionName) {
+      const activeSessionPage = this.sessionPages[this.activeSessionName];
+
+      if (activeSessionPage) {
+        return activeSessionPage.screenshot({
+          path: outputFile,
+          fullPage: fullPageOption,
+          type: 'png',
+        });
+      }
     }
+
     return this.page.screenshot({ path: outputFile, fullPage: fullPageOption, type: 'png' });
   }
 
@@ -2626,7 +2733,7 @@ class Puppeteer extends Helper {
         }, { timeout: waitTimeout }, locator.value, text, $XPath.toString());
       }
     } else {
-      waiter = contextObject.waitForFunction(text => document.body.innerText.indexOf(text) > -1, { timeout: waitTimeout }, text);
+      waiter = contextObject.waitForFunction(text => document.body && document.body.innerText.indexOf(text) > -1, { timeout: waitTimeout }, text);
     }
 
     return waiter.catch((err) => {

package/docs/build/REST.js

@@ -75,7 +75,9 @@ class REST extends Helper {
     }
 
     if ((typeof request.data) === 'string') {
-      request.headers = Object.assign(request.headers, { 'Content-Type': 'application/x-www-form-urlencoded' });
+      if (!request.headers || !request.headers['Content-Type']) {
+        request.headers = Object.assign(request.headers, { 'Content-Type': 'application/x-www-form-urlencoded' });
+      }
     }
 
     if (this.config.onRequest) {

package/docs/build/TestCafe.js

@@ -1339,13 +1339,21 @@ class TestCafe extends Helper {
   // TODO Add url assertions
 
   /**
-   * Sets a cookie.
+   * Sets cookie(s).
+   * 
+   * Can be a single cookie object or an array of cookies:
    * 
    * ```js
    * I.setCookie({name: 'auth', value: true});
+   * 
+   * // as array
+   * I.setCookie([
+   *   {name: 'auth', value: true},
+   *   {name: 'agree', value: true}
+   * ]);
    * ```
    * 
-   * @param {object} cookie a cookie object.
+   * @param {object|array} cookie a cookie object or array of cookie objects.
    */
   async setCookie(cookie) {
     if (Array.isArray(cookie)) {
@@ -1747,7 +1755,7 @@ async function proceedClick(locator, context = null) {
     await assertElementExists(els, locator, 'Clickable element');
   }
 
-  const firstElement = await els.nth(0);
+  const firstElement = await els.filterVisible().nth(0);
 
   return this.t
     .click(firstElement)