codeceptjs 3.3.2 → 3.3.5-beta.1

package/docs/wiki/Upgrading-to-CodeceptJS-3.md

@@ -1,7 +1,7 @@
-🚀 CodeceptJS 3 is in beta now. Install it:
+🚀 CodeceptJS 3 is out now. Install it:
 
 ```
-npm i codeceptjs@3.0.0-beta.3
+npm i codeceptjs
 ```
 
 * [COMPLETE CHANGELOG](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/CHANGELOG.md#300-beta)

package/lib/cli.js

@@ -19,7 +19,7 @@ class Cli extends Base {
     if (opts.debug) level = 2;
     if (opts.verbose) level = 3;
     output.level(level);
-    output.print(`CodeceptJS v${require('./codecept').version()}`);
+    output.print(`CodeceptJS v${require('./codecept').version()} ${output.standWithUkraine()}`);
     output.print(`Using test root "${global.codecept_dir}"`);
 
     const showSteps = level >= 1;

package/lib/command/generate.js

@@ -33,6 +33,7 @@ module.exports.test = function (genPath) {
       type: 'input',
       name: 'feature',
       message: 'Feature which is being tested (ex: account, login, etc)',
+      validate: (val) => !!val,
     },
     {
       type: 'input',
@@ -85,6 +86,7 @@ module.exports.pageObject = function (genPath, opts) {
     type: 'input',
     name: 'name',
     message: `Name of a ${kind} object`,
+    validate: (val) => !!val,
   }, {
     type: 'input',
     name: 'filename',
@@ -156,6 +158,7 @@ module.exports.helper = function (genPath) {
     type: 'input',
     name: 'name',
     message: 'Name of a Helper',
+    validate: (val) => !!val,
   }, {
     type: 'input',
     name: 'filename',

package/lib/command/init.js

@@ -18,8 +18,6 @@ const defaultConfig = {
   output: '',
   helpers: {},
   include: {},
-  bootstrap: null,
-  mocha: {},
 };
 
 const helpers = ['Playwright', 'WebDriver', 'Puppeteer', 'REST', 'GraphQL', 'Appium', 'TestCafe', 'Nightmare'];
@@ -28,10 +26,13 @@ const translations = Object.keys(require('../../translations'));
 const noTranslation = 'English (no localization)';
 translations.unshift(noTranslation);
 
-let packages;
+const packages = [];
+let isTypeScript = false;
+let extension = 'js';
 
 const configHeader = `const { setHeadlessWhen, setCommonPlugins } = require('@codeceptjs/configure');
 
+
 // turn on headless mode when running with HEADLESS=true environment variable
 // export HEADLESS=true && npx codeceptjs run
 setHeadlessWhen(process.env.HEADLESS);
@@ -53,6 +54,10 @@ module.exports = function() {
 }
 `;
 
+const tsNodeRequired = `require('ts-node/register');
+
+`;
+
 module.exports = function (initPath) {
   const testsPath = getTestRoot(initPath);
 
@@ -80,11 +85,23 @@ module.exports = function (initPath) {
     return;
   }
 
+  const typeScriptconfigFile = path.join(testsPath, 'codecept.conf.ts');
+  if (fileExists(typeScriptconfigFile)) {
+    error(`Config is already created at ${typeScriptconfigFile}`);
+    return;
+  }
+
   inquirer.prompt([
+    {
+      name: 'typescript',
+      type: 'confirm',
+      default: false,
+      message: 'Do you plan to write tests in TypeScript?',
+    },
     {
       name: 'tests',
       type: 'input',
-      default: './*_test.js',
+      default: (answers) => `./*_test.${answers.typescript ? 'ts' : 'js'}`,
       message: 'Where are your tests located?',
     },
     {
@@ -105,23 +122,29 @@ module.exports = function (initPath) {
       choices: translations,
     },
   ]).then((result) => {
+    if (result.typescript === true) {
+      isTypeScript = true;
+      extension = isTypeScript === true ? 'ts' : 'js';
+      packages.push('typescript');
+      packages.push('ts-node');
+      packages.push('@types/node');
+    }
+
     const config = defaultConfig;
     config.name = testsPath.split(path.sep).pop();
     config.output = result.output;
 
     config.tests = result.tests;
+    if (isTypeScript) {
+      config.tests = `${config.tests.replace(/\.js$/, `.${extension}`)}`;
+    }
+
     // create a directory tests if it is included in tests path
     const matchResults = config.tests.match(/[^*.]+/);
     if (matchResults) {
       mkdirp.sync(path.join(testsPath, matchResults[0]));
     }
 
-    // append file mask to the end of tests
-    if (!config.tests.match(/\*(.*?)$/)) {
-      config.tests = `${config.tests.replace(/\/+$/, '')}/*_test.js`;
-      print(`Adding default test mask: ${config.tests}`);
-    }
-
     if (result.translation !== noTranslation) config.translation = result.translation;
 
     const helperName = result.helper;
@@ -132,7 +155,7 @@ module.exports = function (initPath) {
     try {
       const Helper = require(`../helper/${helperName}`);
       if (Helper._checkRequirements) {
-        packages = Helper._checkRequirements();
+        packages.concat(Helper._checkRequirements());
       }
 
       if (!Helper._config()) return;
@@ -148,20 +171,28 @@ module.exports = function (initPath) {
 
     const finish = async () => {
       // create steps file by default
-      const stepFile = './steps_file.js';
-      fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
-      config.include.I = stepFile;
-      print(`Steps file created at ${stepFile}`);
+      if (!isTypeScript) { // no extra step file for typescript (as it doesn't match TS conventions)
+        const stepFile = `./steps_file.${extension}`;
+        fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
+        config.include.I = stepFile;
+        print(`Steps file created at ${stepFile}`);
+      }
 
-      let configSource = beautify(`exports.config = ${inspect(config, false, 4, false)}`);
+      let configSource = beautify(`/** @type {CodeceptJS.MainConfig} */\nexports.config = ${inspect(config, false, 4, false)}`);
 
       if (require.resolve('@codeceptjs/configure') && isLocal && !initPath) {
         // prepend @codeceptjs/configure only when this module can be required in config
         configSource = configHeader + configSource;
       }
 
-      fs.writeFileSync(configFile, configSource, 'utf-8');
-      print(`Config created at ${configFile}`);
+      if (isTypeScript) {
+        configSource = `${tsNodeRequired}\n${configSource}`;
+        fs.writeFileSync(typeScriptconfigFile, configSource, 'utf-8');
+        print(`Config created at ${typeScriptconfigFile}`);
+      } else {
+        fs.writeFileSync(configFile, configSource, 'utf-8');
+        print(`Config created at ${configFile}`);
+      }
 
       if (config.output) {
         if (!fileExists(config.output)) {
@@ -177,13 +208,41 @@ module.exports = function (initPath) {
           allowJs: true,
         },
       };
-      const jsconfigJson = beautify(JSON.stringify(jsconfig));
-      const jsconfigFile = path.join(testsPath, 'jsconfig.json');
-      if (fileExists(jsconfigFile)) {
-        print(`jsconfig.json already exists at ${jsconfigFile}`);
+
+      const tsconfig = {
+        'ts-node': {
+          files: true,
+        },
+        compilerOptions: {
+          target: 'es2018',
+          lib: ['es2018', 'DOM'],
+          esModuleInterop: true,
+          module: 'commonjs',
+          strictNullChecks: false,
+          types: ['codeceptjs', 'node'],
+          declaration: true,
+          skipLibCheck: true,
+        },
+        exclude: ['node_modules'],
+      };
+
+      if (isTypeScript) {
+        const tsconfigJson = beautify(JSON.stringify(tsconfig));
+        const tsconfigFile = path.join(testsPath, 'tsconfig.json');
+        if (fileExists(tsconfigFile)) {
+          print(`tsconfig.json already exists at ${tsconfigFile}`);
+        } else {
+          fs.writeFileSync(tsconfigFile, tsconfigJson);
+        }
       } else {
-        fs.writeFileSync(jsconfigFile, jsconfigJson);
-        print(`Intellisense enabled in ${jsconfigFile}`);
+        const jsconfigJson = beautify(JSON.stringify(jsconfig));
+        const jsconfigFile = path.join(testsPath, 'jsconfig.json');
+        if (fileExists(jsconfigFile)) {
+          print(`jsconfig.json already exists at ${jsconfigFile}`);
+        } else {
+          fs.writeFileSync(jsconfigFile, jsconfigJson);
+          print(`Intellisense enabled in ${jsconfigFile}`);
+        }
       }
 
       const generateDefinitionsManually = colors.bold(`To get auto-completion support, please generate type definitions: ${colors.green('npx codeceptjs def')}`);

package/lib/command/interactive.js

@@ -21,7 +21,7 @@ module.exports = async function (path, options) {
 
     if (options.verbose) output.level(3);
 
-    output.print('String interactive shell for current suite...');
+    output.print('Starting interactive shell for current suite...');
     recorder.start();
     event.emit(event.suite.before, {
       fullTitle: () => 'Interactive Shell',

package/lib/command/run-workers.js

@@ -25,7 +25,7 @@ module.exports = async function (workerCount, options) {
 
   const numberOfWorkers = parseInt(workerCount, 10);
 
-  output.print(`CodeceptJS v${require('../codecept').version()}`);
+  output.print(`CodeceptJS v${require('../codecept').version()} ${output.standWithUkraine()}`);
   output.print(`Running tests in ${output.styles.bold(numberOfWorkers)} workers...`);
   output.print();
 

package/lib/command/workers/runTests.js

@@ -114,6 +114,13 @@ function initializeListeners() {
       parent.title = test.parent.title;
     }
 
+    if (test.opts) {
+      Object.keys(test.opts).forEach(k => {
+        if (typeof test.opts[k] === 'object') delete test.opts[k];
+        if (typeof test.opts[k] === 'function') delete test.opts[k];
+      });
+    }
+
     return {
       opts: test.opts || {},
       tags: test.tags || [],
@@ -148,6 +155,14 @@ function initializeListeners() {
     if (step.metaStep) {
       parent.title = step.metaStep.actor;
     }
+
+    if (step.opts) {
+      Object.keys(step.opts).forEach(k => {
+        if (typeof step.opts[k] === 'object') delete step.opts[k];
+        if (typeof step.opts[k] === 'function') delete step.opts[k];
+      });
+    }
+
     return {
       opts: step.opts || {},
       workerIndex,

package/lib/helper/JSONResponse.js

@@ -1,3 +1,4 @@
+const assert = require('assert');
 const chai = require('chai');
 const joi = require('joi');
 const chaiDeepMatch = require('chai-deep-match');
@@ -173,12 +174,30 @@ class JSONResponse extends Helper {
    *
    * I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
    * ```
+   * If an array is received, checks that at least one element contains JSON
+   * ```js
+   * // response.data == [{ user: { name: 'jon', email: 'jon@doe.com' } }]
+   *
+   * I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
+   * ```
    *
    * @param {object} json
    */
   seeResponseContainsJson(json = {}) {
     this._checkResponseReady();
-    expect(this.response.data).to.deep.match(json);
+    if (Array.isArray(this.response.data)) {
+      let fails = 0;
+      for (const el of this.response.data) {
+        try {
+          expect(el).to.deep.match(json);
+        } catch (err) {
+          fails++;
+        }
+      }
+      assert.ok(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`);
+    } else {
+      expect(this.response.data).to.deep.match(json);
+    }
   }
 
   /**
@@ -189,12 +208,22 @@ class JSONResponse extends Helper {
    *
    * I.dontSeeResponseContainsJson({ user: 2 });
    * ```
+   * If an array is received, checks that no element of array contains json:
+   * ```js
+   * // response.data == [{ user: 1 }, { user: 3 }]
+   *
+   * I.dontSeeResponseContainsJson({ user: 2 });
+   * ```
    *
    * @param {object} json
    */
   dontSeeResponseContainsJson(json = {}) {
     this._checkResponseReady();
-    expect(this.response.data).not.to.deep.match(json);
+    if (Array.isArray(this.response.data)) {
+      this.response.data.forEach(data => expect(data).not.to.deep.match(json));
+    } else {
+      expect(this.response.data).not.to.deep.match(json);
+    }
   }
 
   /**
@@ -206,11 +235,23 @@ class JSONResponse extends Helper {
    * I.seeResponseContainsKeys(['user']);
    * ```
    *
+   * If an array is received, check is performed for each element of array:
+   *
+   * ```js
+   * // response.data == [{ user: 'jon' }, { user: 'matt'}]
+   *
+   * I.seeResponseContainsKeys(['user']);
+   * ```
+   *
    * @param {array} keys
    */
   seeResponseContainsKeys(keys = []) {
     this._checkResponseReady();
-    expect(this.response.data).to.include.keys(keys);
+    if (Array.isArray(this.response.data)) {
+      this.response.data.forEach(data => expect(data).to.include.keys(keys));
+    } else {
+      expect(this.response.data).to.include.keys(keys);
+    }
   }
 
   /**

package/lib/helper/Playwright.js

@@ -44,6 +44,46 @@ const {
 } = require('./extras/PlaywrightRestartOpts');
 const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine');
 
+/**
+ * ## Configuration
+ *
+ * This helper should be configured in codecept.conf.js
+ *
+ * @typedef PlaywrightConfig
+ * @type {object}
+ * @prop {string} url - base url of website to be tested
+ * @prop {string} browser - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
+ * @prop {boolean} [show=false] - show browser window.
+ * @prop {string|boolean} [restart=false] - restart strategy between tests. Possible values:
+ *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
+ *   * 'browser' or **true** - closes browser and opens it again between tests.
+ *   * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
+ * @prop {number} [timeout=1000] - -  [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
+ * @prop {boolean} [disableScreenshots=false] - don't save screenshot on failure.
+ * @prop {any} [emulate] - browser in device emulation mode.
+ * @prop {boolean} [video=false] - enables video recording for failed tests; videos are saved into `output/videos` folder
+ * @prop {boolean} [trace=false] - record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
+ * @prop {boolean} [fullPageScreenshots=false] - make full page screenshots on failure.
+ * @prop {boolean} [uniqueScreenshotNames=false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+ * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to 'session'.
+ * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` is set to 'session'.
+ * @prop {number} [waitForAction] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+ * @prop {number} [waitForNavigation] - When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
+ * @prop {number} [pressKeyDelay=10] - Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
+ * @prop {number} [getPageTimeout] - config option to set maximum navigation time in milliseconds.
+ * @prop {number} [waitForTimeout] - default wait* timeout in ms. Default: 1000.
+ * @prop {object} [basicAuth] - the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+ * @prop {string} [windowSize] - default window size. Set a dimension like `640x480`.
+ * @prop {string} [colorScheme] - default color scheme. Possible values: `dark` | `light` | `no-preference`.
+ * @prop {string} [userAgent] - user-agent string.
+ * @prop {string} [locale] - locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
+ * @prop {boolean} [manualStart] - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
+ * @prop {object} [chromium] - pass additional chromium options
+ * @prop {object} [electron] - (pass additional electron options
+ * @prop {any} [channel] - (While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
+ */
+const config = {};
+
 /**
  * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
  *
@@ -65,46 +105,14 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  *
  * Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
  *
- * ## Configuration
  *
- * This helper should be configured in codecept.json or codecept.conf.js
- *
- * * `url`: base url of website to be tested
- * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
- * * `show`: (optional, default: false) - show browser window.
- * * `restart`: (optional, default: false) - restart strategy between tests. Possible values:
- *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
- *   * 'browser' or **true** - closes browser and opens it again between tests.
- *   * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
- * * `timeout`: (optional, default: 1000) -  [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
- * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
- * * `emulate`: (optional, default: {}) launch browser in device emulation mode.
- * * `video`: (optional, default: false) enables video recording for failed tests; videos are saved into `output/videos` folder
- * * `trace`: (optional, default: false) record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
- * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
- * * `uniqueScreenshotNames`: (optional, default: false)  - option to prevent screenshot override if you have scenarios with the same name in different suites.
- * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to 'session'.
- * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to 'session'.
- * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
- * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
- * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
- * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
- * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
- * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
- * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
- * * `colorScheme`: (optional) default color scheme. Possible values: `dark` | `light` | `no-preference`.
- * * `userAgent`: (optional) user-agent string.
- * * `locale`: (optional) locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
- * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
- * * `chromium`: (optional) pass additional chromium options
- * * `electron`: (optional) pass additional electron options
- * * `channel`: (optional) While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
+ * <!-- configuration -->
  *
  * #### Video Recording Customization
  *
  * By default, video is saved to `output/video` dir. You can customize this path by passing `dir` option to `recordVideo` option.
  *
- * * `video`: enables video recording for failed tests; videos are saved into `output/videos` folder
+ * `video`: enables video recording for failed tests; videos are saved into `output/videos` folder
  * * `keepVideoForPassedTests`: - save videos for passed tests
  * * `recordVideo`: [additional options for videos customization](https://playwright.dev/docs/next/api/class-browser#browser-new-context)
  *
@@ -167,7 +175,8 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  *      Playwright: {
  *        url: "http://localhost",
  *        chromium: {
- *          browserWSEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a'
+ *          browserWSEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a',
+ *          cdpConnection: false // default is false
  *        }
  *      }
  *    }
@@ -256,8 +265,6 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * const { browserContext } = this.helpers.Playwright;
  * await browserContext.cookies(); // get current browser context
  * ```
- *
- * ## Methods
  */
 class Playwright extends Helper {
   constructor(config) {
@@ -272,6 +279,7 @@ class Playwright extends Helper {
     this.sessionPages = {};
     this.activeSessionName = '';
     this.isElectron = false;
+    this.isCDPConnection = false;
     this.electronSessions = [];
     this.storageState = null;
 
@@ -347,6 +355,7 @@ class Playwright extends Helper {
     this.isRemoteBrowser = !!this.playwrightOptions.browserWSEndpoint;
     this.isElectron = this.options.browser === 'electron';
     this.userDataDir = this.playwrightOptions.userDataDir;
+    this.isCDPConnection = this.playwrightOptions.cdpConnection;
     popupStore.defaultAction = this.options.defaultPopupAction;
   }
 
@@ -692,6 +701,15 @@ class Playwright extends Helper {
   async _startBrowser() {
     if (this.isElectron) {
       this.browser = await playwright._electron.launch(this.playwrightOptions);
+    } else if (this.isRemoteBrowser && this.isCDPConnection) {
+      try {
+        this.browser = await playwright[this.options.browser].connectOverCDP(this.playwrightOptions);
+      } catch (err) {
+        if (err.toString().indexOf('ECONNREFUSED')) {
+          throw new RemoteBrowserConnectionRefused(err);
+        }
+        throw err;
+      }
     } else if (this.isRemoteBrowser) {
       try {
         this.browser = await playwright[this.options.browser].connect(this.playwrightOptions);
@@ -1054,6 +1072,7 @@ class Playwright extends Helper {
     if (!page) {
       throw new Error(`There is no ability to switch to next tab with offset ${num}`);
     }
+    targetCreatedHandler.call(this, page);
     await this._setPage(page);
     return this._waitForAction();
   }
@@ -1136,7 +1155,9 @@ class Playwright extends Helper {
     if (this.isElectron) {
       throw new Error('Cannot open new tabs inside an Electron container');
     }
-    await this._setPage(await this.browserContext.newPage(options));
+    const page = await this.browserContext.newPage(options);
+    targetCreatedHandler.call(this, page);
+    await this._setPage(page);
     return this._waitForAction();
   }
 
@@ -1558,9 +1579,11 @@ class Playwright extends Helper {
    * Get JS log from browser.
    *
    * ```js
-   * let logs = await I.grabBrowserLogs();
-   * console.log(JSON.stringify(logs))
+   * const logs = await I.grabBrowserLogs();
+   * const errors = logs.map(l => ({ type: l.type(), text: l.text() })).filter(l => l.type === 'error');
+   * console.log(JSON.stringify(errors));
    * ```
+   * [Learn more about console messages](https://playwright.dev/docs/api/class-consolemessage)
    * @return {Promise<any[]>}
    */
   async grabBrowserLogs() {