codeceptjs 3.5.13-beta.2 → 3.5.13

package/docs/webapi/dontSeeTraffic.mustache

@@ -0,0 +1,13 @@
+Verifies that a certain request is not part of network traffic.
+
+Examples:
+
+```js
+I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
+I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
+```
+
+@param {Object} opts - options when checking the traffic network.
+@param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+@param {string|RegExp} opts.url Expected URL of request in network traffic. Can be a string or a regular expression.
+@return {void} automatically synchronized promise through #recorder

package/docs/webapi/flushNetworkTraffics.mustache

@@ -0,0 +1,5 @@
+Resets all recorded network requests.
+
+```js
+I.flushNetworkTraffics();
+```

package/docs/webapi/grabRecordedNetworkTraffics.mustache

@@ -0,0 +1,10 @@
+Grab the recording network traffics
+
+```js
+const traffics = await I.grabRecordedNetworkTraffics();
+expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+expect(traffics[0].response.status).to.equal(200);
+expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+```
+
+@return { Array } recorded network traffics

package/docs/webapi/seeTraffic.mustache

@@ -0,0 +1,36 @@
+Verifies that a certain request is part of network traffic.
+
+```js
+// checking the request url contains certain query strings
+I.amOnPage('https://openai.com/blog/chatgpt');
+I.startRecordingTraffic();
+await I.seeTraffic({
+    name: 'sentry event',
+    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+    parameters: {
+    width: '1919',
+    height: '1138',
+    },
+  });
+```
+
+```js
+// checking the request url contains certain post data
+I.amOnPage('https://openai.com/blog/chatgpt');
+I.startRecordingTraffic();
+await I.seeTraffic({
+    name: 'event',
+    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
+    requestPostData: {
+    st: 2,
+    },
+  });
+```
+
+@param {Object} opts - options when checking the traffic network.
+@param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+@param {string} opts.url Expected URL of request in network traffic
+@param {Object} [opts.parameters] Expected parameters of that request in network traffic
+@param {Object} [opts.requestPostData] Expected that request contains post data in network traffic
+@param {number} [opts.timeout] Timeout to wait for request in seconds. Default is 10 seconds.
+@return {void} automatically synchronized promise through #recorder

package/docs/webapi/startRecordingTraffic.mustache

@@ -0,0 +1,8 @@
+Starts recording the network traffics.
+This also resets recorded network requests.
+
+```js
+I.startRecordingTraffic();
+```
+
+@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/stopRecordingTraffic.mustache

@@ -0,0 +1,5 @@
+Stops recording of network traffic. Recorded traffic is not flashed.
+
+```js
+I.stopRecordingTraffic();
+```

package/lib/helper/Playwright.js

@@ -6,7 +6,6 @@ const { v4: uuidv4 } = require('uuid');
 const assert = require('assert');
 const promiseRetry = require('promise-retry');
 const Locator = require('../locator');
-const store = require('../store');
 const recorder = require('../recorder');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals } = require('../assert/equal');
@@ -51,6 +50,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
 const {
   seeElementError, dontSeeElementError, dontSeeElementInDOMError, seeElementInDOMError,
 } = require('./errors/ElementAssertion');
+const { createAdvancedTestResults, allParameterValuePairsMatchExtreme, extractQueryObjects } = require('./networkTraffics/utils');
 const { log } = require('../output');
 
 const pathSeparator = path.sep;
@@ -2678,6 +2678,7 @@ class Playwright extends Helper {
    */
   async waitForText(text, sec = null, context = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
+    const errorMessage = `Text "${text}" was not found on page after ${waitTimeout / 1000} sec.`;
     let waiter;
 
     const contextObject = await this._getContext();
@@ -2688,18 +2689,21 @@ class Playwright extends Helper {
         try {
           await contextObject.locator(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()} >> text=${text}`).first().waitFor({ timeout: waitTimeout, state: 'visible' });
         } catch (e) {
-          console.log(e);
-          throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec\n${e.message}`);
+          throw new Error(`${errorMessage}\n${e.message}`);
         }
       }
 
       if (locator.isXPath()) {
-        waiter = contextObject.waitForFunction(([locator, text, $XPath]) => {
-          eval($XPath); // eslint-disable-line no-eval
-          const el = $XPath(null, locator);
-          if (!el.length) return false;
-          return el[0].innerText.indexOf(text) > -1;
-        }, [locator.value, text, $XPath.toString()], { timeout: waitTimeout });
+        try {
+          await contextObject.waitForFunction(([locator, text, $XPath]) => {
+            eval($XPath); // eslint-disable-line no-eval
+            const el = $XPath(null, locator);
+            if (!el.length) return false;
+            return el[0].innerText.indexOf(text) > -1;
+          }, [locator.value, text, $XPath.toString()], { timeout: waitTimeout });
+        } catch (e) {
+          throw new Error(`${errorMessage}\n${e.message}`);
+        }
       }
     } else {
       // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
@@ -2713,7 +2717,7 @@ class Playwright extends Helper {
         count += 1000;
       } while (count <= waitTimeout);
 
-      if (!waiter) throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec`);
+      if (!waiter) throw new Error(`${errorMessage}`);
     }
   }
 
@@ -2976,14 +2980,8 @@ class Playwright extends Helper {
   }
 
   /**
-   * Starts recording the network traffics.
-   * This also resets recorded network requests.
+   * {{> flushNetworkTraffics }}
    *
-   * ```js
-   * I.startRecordingTraffic();
-   * ```
-   *
-   * @return {void}
    */
   startRecordingTraffic() {
     this.flushNetworkTraffics();
@@ -3010,18 +3008,8 @@ class Playwright extends Helper {
   }
 
   /**
-  *  Grab the recording network traffics
-  *
-  * ```js
-  * const traffics = await I.grabRecordedNetworkTraffics();
-  * expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
-  * expect(traffics[0].response.status).to.equal(200);
-  * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
-  * ```
-  *
-  * @return { Promise<Array<any>> }
-  *
-  */
+   * {{> grabRecordedNetworkTraffics }}
+   */
   async grabRecordedNetworkTraffics() {
     if (!this.recording || !this.recordedAtLeastOnce) {
       throw new Error('Failure in test automation. You use "I.grabRecordedNetworkTraffics", but "I.startRecordingTraffic" was never called before.');
@@ -3129,18 +3117,14 @@ class Playwright extends Helper {
   }
 
   /**
-   * Resets all recorded network requests.
+   * {{> flushNetworkTraffics }}
    */
   flushNetworkTraffics() {
     this.requests = [];
   }
 
   /**
-   * Stops recording of network traffic. Recorded traffic is not flashed.
-   *
-   * ```js
-   * I.stopRecordingTraffic();
-   * ```
+   * {{> stopRecordingTraffic }}
    */
   stopRecordingTraffic() {
     this.page.removeAllListeners('request');
@@ -3148,42 +3132,7 @@ class Playwright extends Helper {
   }
 
   /**
-   * Verifies that a certain request is part of network traffic.
-   *
-   * ```js
-   * // checking the request url contains certain query strings
-   * I.amOnPage('https://openai.com/blog/chatgpt');
-   * I.startRecordingTraffic();
-   * await I.seeTraffic({
-   *    name: 'sentry event',
-   *    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
-   *    parameters: {
-   *       width: '1919',
-   *       height: '1138',
-   *     },
-   * });
-   * ```
-   *
-   * ```js
-   * // checking the request url contains certain post data
-   * I.amOnPage('https://openai.com/blog/chatgpt');
-   * I.startRecordingTraffic();
-   * await I.seeTraffic({
-   *    name: 'event',
-   *    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-   *    requestPostData: {
-   *       st: 2,
-   *     },
-   * });
-   * ```
-   *
-   * @param {Object} opts - options when checking the traffic network.
-   * @param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-   * @param {string} opts.url Expected URL of request in network traffic
-   * @param {Object} [opts.parameters] Expected parameters of that request in network traffic
-   * @param {Object} [opts.requestPostData] Expected that request contains post data in network traffic
-   * @param {number} [opts.timeout] Timeout to wait for request in seconds. Default is 10 seconds.
-   * @return { Promise<*> }
+   * {{> seeTraffic }}
    */
   async seeTraffic({
     name, url, parameters, requestPostData, timeout = 10,
@@ -3265,18 +3214,7 @@ class Playwright extends Helper {
   }
 
   /**
-   * Verifies that a certain request is not part of network traffic.
-   *
-   * Examples:
-   *
-   * ```js
-   * I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
-   * I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
-   * ```
-   *
-   * @param {Object} opts - options when checking the traffic network.
-   * @param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-   * @param {string|RegExp} opts.url Expected URL of request in network traffic. Can be a string or a regular expression.
+   * {{> dontSeeTraffic }}
    *
    */
   dontSeeTraffic({ name, url }) {
@@ -3988,134 +3926,3 @@ async function highlightActiveElement(element) {
     });
   }
 }
-
-const createAdvancedTestResults = (url, dataToCheck, requests) => {
-  // Creates advanced test results for a network traffic check.
-  // Advanced test results only applies when expected parameters are set
-  if (!dataToCheck) return '';
-
-  let urlFound = false;
-  let advancedResults;
-  requests.forEach((request) => {
-    // url not found in this request. continue with next request
-    if (urlFound || !request.url.match(new RegExp(url))) return;
-    urlFound = true;
-
-    // Url found. Now we create advanced test report for that URL and show which parameters failed
-    if (!request.requestPostData) {
-      advancedResults = allParameterValuePairsMatchExtreme(extractQueryObjects(request.url), dataToCheck);
-    } else if (request.requestPostData) {
-      advancedResults = allRequestPostDataValuePairsMatchExtreme(request.requestPostData, dataToCheck);
-    }
-  });
-  return advancedResults;
-};
-
-const extractQueryObjects = (queryString) => {
-  // Converts a string of GET parameters into an array of parameter objects. Each parameter object contains the properties "name" and "value".
-  if (queryString.indexOf('?') === -1) {
-    return [];
-  }
-  const queryObjects = [];
-
-  const queryPart = queryString.split('?')[1];
-
-  const queryParameters = queryPart.split('&');
-
-  queryParameters.forEach((queryParameter) => {
-    const keyValue = queryParameter.split('=');
-    const queryObject = {};
-    // eslint-disable-next-line prefer-destructuring
-    queryObject.name = keyValue[0];
-    queryObject.value = decodeURIComponent(keyValue[1]);
-    queryObjects.push(queryObject);
-  });
-
-  return queryObjects;
-};
-
-const allParameterValuePairsMatchExtreme = (queryStringObject, advancedExpectedParameterValuePairs) => {
-  // More advanced check if all request parameters match with the expectations
-  let littleReport = '\nQuery parameters:\n';
-  let success = true;
-
-  for (const expectedKey in advancedExpectedParameterValuePairs) {
-    if (!Object.prototype.hasOwnProperty.call(advancedExpectedParameterValuePairs, expectedKey)) {
-      continue;
-    }
-    let parameterFound = false;
-    const expectedValue = advancedExpectedParameterValuePairs[expectedKey];
-
-    for (const queryParameter of queryStringObject) {
-      if (queryParameter.name === expectedKey) {
-        parameterFound = true;
-        if (expectedValue === undefined) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')}\n`;
-        } else if (typeof expectedValue === 'object' && expectedValue.base64) {
-          const decodedActualValue = Buffer.from(queryParameter.value, 'base64').toString('utf8');
-          if (decodedActualValue === expectedValue.base64) {
-            littleReport += `   ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})\n`;
-          } else {
-            littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})     -> actual value: "base64(${decodedActualValue})"\n`;
-            success = false;
-          }
-        } else if (queryParameter.value === expectedValue) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')} = ${expectedValue}\n`;
-        } else {
-          littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = ${expectedValue}      -> actual value: "${queryParameter.value}"\n`;
-          success = false;
-        }
-      }
-    }
-
-    if (parameterFound === false) {
-      littleReport += ` ✖ ${expectedKey.padStart(10, ' ')}${expectedValue ? ` = ${JSON.stringify(expectedValue)}` : ''}      -> parameter not found in request\n`;
-      success = false;
-    }
-  }
-
-  return success ? true : littleReport;
-};
-
-const allRequestPostDataValuePairsMatchExtreme = (RequestPostDataObject, advancedExpectedRequestPostValuePairs) => {
-  // More advanced check if all request post data match with the expectations
-  let littleReport = '\nRequest Post Data:\n';
-  let success = true;
-
-  for (const expectedKey in advancedExpectedRequestPostValuePairs) {
-    if (!Object.prototype.hasOwnProperty.call(advancedExpectedRequestPostValuePairs, expectedKey)) {
-      continue;
-    }
-    let keyFound = false;
-    const expectedValue = advancedExpectedRequestPostValuePairs[expectedKey];
-
-    for (const [key, value] of Object.entries(RequestPostDataObject)) {
-      if (key === expectedKey) {
-        keyFound = true;
-        if (expectedValue === undefined) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')}\n`;
-        } else if (typeof expectedValue === 'object' && expectedValue.base64) {
-          const decodedActualValue = Buffer.from(value, 'base64').toString('utf8');
-          if (decodedActualValue === expectedValue.base64) {
-            littleReport += `   ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})\n`;
-          } else {
-            littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})     -> actual value: "base64(${decodedActualValue})"\n`;
-            success = false;
-          }
-        } else if (value === expectedValue) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')} = ${expectedValue}\n`;
-        } else {
-          littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = ${expectedValue}      -> actual value: "${value}"\n`;
-          success = false;
-        }
-      }
-    }
-
-    if (keyFound === false) {
-      littleReport += ` ✖ ${expectedKey.padStart(10, ' ')}${expectedValue ? ` = ${JSON.stringify(expectedValue)}` : ''}      -> key not found in request\n`;
-      success = false;
-    }
-  }
-
-  return success ? true : littleReport;
-};

package/lib/helper/Puppeteer.js

@@ -486,7 +486,7 @@ class Puppeteer extends Helper {
     if (!page) return;
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await this.page.$('body');
-    if (this.config.browser === 'chrome') {
+    if (this.options.browser === 'chrome') {
       await page.bringToFront();
     }
   }
@@ -658,9 +658,9 @@ class Puppeteer extends Helper {
       url = this.options.url + url;
     }
 
-    if (this.config.basicAuth && (this.isAuthenticated !== true)) {
+    if (this.options.basicAuth && (this.isAuthenticated !== true)) {
       if (url.includes(this.options.url)) {
-        await this.page.authenticate(this.config.basicAuth);
+        await this.page.authenticate(this.options.basicAuth);
         this.isAuthenticated = true;
       }
     }

package/lib/helper/REST.js

@@ -72,9 +72,12 @@ class REST extends Helper {
       this.options.maxBodyLength = maxContentLength;
     }
 
-    this.options = { ...this.options, ...config };
+    // override defaults with config
+    this._setConfig(config);
+
     this.headers = { ...this.options.defaultHeaders };
     this.axios = axios.create();
+    // @ts-ignore
     this.axios.defaults.headers = this.options.defaultHeaders;
   }