codeceptjs 3.7.0-beta.6 → 3.7.0-beta.7

package/README.md

@@ -5,13 +5,13 @@
 
 ## Build Status
 
-| Type      | Engine     | Status                                                                                                                                                                                                     |
-| --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 🌐 Web    | Playwright | [![Playwright Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml)                      |
-| 🌐 Web    | Puppeteer  | [![Puppeteer Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml)                         |
-| 🌐 Web    | WebDriver  | [![WebDriver Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml)                         |
-| 🌐 Web    | TestCafe   | [![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml)                            |
-| 📱 Mobile | Appium     | [![Appium V2 Tests - Android](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_Android.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_Android.yml) |
+| Type      | Engine     | Status                                                                                                                                                                                              |
+| --------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 🌐 Web    | Playwright | [![Playwright Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml)               |
+| 🌐 Web    | Puppeteer  | [![Puppeteer Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml)                  |
+| 🌐 Web    | WebDriver  | [![WebDriver Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml)                  |
+| 🌐 Web    | TestCafe   | [![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml)                     |
+| 📱 Mobile | Appium     | [![Appium Tests - Android](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium_Android.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium_Android.yml) |
 
 # CodeceptJS [![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua)
 

package/lib/helper/Appium.js

@@ -44,7 +44,7 @@ const vendorPrefix = {
  *
  * This helper should be configured in codecept.conf.ts or codecept.conf.js
  *
- * * `appiumV2`: set this to true if you want to run tests with AppiumV2. See more how to setup [here](https://codecept.io/mobile/#setting-up)
+ * * `appiumV2`: by default is true, set this to false if you want to run tests with AppiumV1. See more how to setup [here](https://codecept.io/mobile/#setting-up)
  * * `app`: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackage
  * * `host`: (default: 'localhost') Appium host
  * * `port`: (default: '4723') Appium port
@@ -124,7 +124,7 @@ const vendorPrefix = {
  * {
  * helpers: {
  *   Appium: {
- *         appiumV2: true,
+ *         appiumV2: true, // By default is true, set to false if you want to run against Appium v1
  *         host: "hub-cloud.browserstack.com",
  *         port: 4444,
  *         user: process.env.BROWSERSTACK_USER,
@@ -178,14 +178,12 @@ class Appium extends Webdriver {
     super(config)
 
     this.isRunning = false
-    if (config.appiumV2 === true) {
-      this.appiumV2 = true
-    }
+    this.appiumV2 = config.appiumV2 || true
     this.axios = axios.create()
 
     webdriverio = require('webdriverio')
     if (!config.appiumV2) {
-      console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Please migrating to Appium 2.x by adding appiumV2: true to your config.')
+      console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Appium 2.x is used by default.')
       console.log('More info: https://bit.ly/appium-v2-migration')
       console.log('This Appium 1.x support will be removed in next major release.')
     }

package/lib/helper/WebDriver.js

@@ -24,6 +24,7 @@ const { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTr
 
 const SHADOW = 'shadow'
 const webRoot = 'body'
+let browserLogs = []
 
 /**
  * ## Configuration
@@ -621,6 +622,10 @@ class WebDriver extends Helper {
     }
 
     this.browser.on('dialog', () => {})
+
+    await this.browser.sessionSubscribe({ events: ['log.entryAdded'] })
+    this.browser.on('log.entryAdded', logEvents)
+
     return this.browser
   }
 
@@ -658,6 +663,7 @@ class WebDriver extends Helper {
       if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err
     })
     await this.closeOtherTabs()
+    browserLogs = []
     return this.browser
   }
 
@@ -1522,11 +1528,7 @@ class WebDriver extends Helper {
    * {{> grabBrowserLogs }}
    */
   async grabBrowserLogs() {
-    if (this.browser.isW3C) {
-      this.debug('Logs not available in W3C specification')
-      return
-    }
-    return this.browser.getLogs('browser')
+    return browserLogs
   }
 
   /**
@@ -1788,18 +1790,25 @@ class WebDriver extends Helper {
 
         if (browser) {
           this.debug(`Screenshot of ${sessionName} session has been saved to ${outputFile}`)
-          return browser.saveScreenshot(outputFile)
+          await browser.saveScreenshot(outputFile)
         }
       }
     }
 
     if (!fullPage) {
       this.debug(`Screenshot has been saved to ${outputFile}`)
-      return this.browser.saveScreenshot(outputFile)
+      await this.browser.saveScreenshot(outputFile)
     }
 
     const originalWindowSize = await this.browser.getWindowSize()
 
+    // this case running on device, so we could not set the windowSize
+    if (this.browser.isMobile) {
+      this.debug(`Screenshot has been saved to ${outputFile}, size: ${originalWindowSize.width}x${originalWindowSize.height}`)
+      const buffer = await this.browser.saveScreenshot(outputFile)
+      return buffer
+    }
+
     let { width, height } = await this.browser
       .execute(function () {
         return {
@@ -3134,4 +3143,8 @@ function prepareLocateFn(context) {
   }
 }
 
+function logEvents(event) {
+  browserLogs.push(event.text) // add log message to the array
+}
+
 module.exports = WebDriver

package/lib/pause.js

@@ -84,12 +84,10 @@ function pauseSession(passedObject = {}) {
   })
   return new Promise(resolve => {
     finish = resolve
-    // eslint-disable-next-line
     return askForStep()
   })
 }
 
-/* eslint-disable */
 async function parseInput(cmd) {
   rl.pause()
   next = false
@@ -198,7 +196,6 @@ async function parseInput(cmd) {
   recorder.add('ask for next step', askForStep)
   nextStep()
 }
-/* eslint-enable */
 
 function askForStep() {
   return new Promise(resolve => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.6",
+  "version": "3.7.0-beta.7",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -50,10 +50,10 @@
     "test:unit": "mocha test/unit --recursive --timeout 10000",
     "test:runner": "mocha test/runner --recursive --timeout 10000",
     "test": "npm run test:unit && npm run test:runner",
-    "test:appium-quick": "mocha test/helper/AppiumV2_test.js --grep 'quick'",
-    "test:appium-other": "mocha test/helper/AppiumV2_test.js --grep 'second'",
-    "test:ios:appium-quick": "mocha test/helper/AppiumV2_ios_test.js --grep 'quick'",
-    "test:ios:appium-other": "mocha test/helper/AppiumV2_ios_test.js --grep 'second'",
+    "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
+    "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second'",
+    "test:ios:appium-quick": "mocha test/helper/Appium_ios_test.js --grep 'quick'",
+    "test:ios:appium-other": "mocha test/helper/Appium_ios_test.js --grep 'second'",
     "test-app:start": "php -S 127.0.0.1:8000 -t test/data/app",
     "test-app:stop": "kill -9 $(lsof -t -i:8000)",
     "test:unit:webbapi:playwright": "mocha test/helper/Playwright_test.js",
@@ -94,7 +94,7 @@
     "figures": "3.2.0",
     "fn-args": "4.0.0",
     "fs-extra": "11.2.0",
-    "glob": "^11.0.0",
+    "glob": ">=9.0.0",
     "fuse.js": "^7.0.0",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
@@ -113,7 +113,7 @@
     "promise-retry": "1.1.1",
     "resq": "1.11.0",
     "sprintf-js": "1.1.3",
-    "uuid": "11.0.4"
+    "uuid": "11.0.5"
   },
   "optionalDependencies": {
     "@codeceptjs/detox-helper": "1.1.5"
@@ -124,13 +124,13 @@
     "@codeceptjs/mock-request": "0.3.1",
     "@eslint/eslintrc": "3.2.0",
     "@eslint/js": "9.18.0",
-    "@faker-js/faker": "9.3.0",
+    "@faker-js/faker": "9.4.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
     "@types/chai": "4.3.19",
     "@types/inquirer": "9.0.7",
-    "@types/node": "22.10.5",
-    "@wdio/sauce-service": "9.5.1",
+    "@types/node": "22.10.7",
+    "@wdio/sauce-service": "9.5.7",
     "@wdio/selenium-standalone-service": "8.15.0",
     "@wdio/utils": "9.5.0",
     "@xmldom/xmldom": "0.9.6",
@@ -138,8 +138,8 @@
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "33.3.1",
-    "eslint": "^9.17.0",
+    "electron": "34.0.0",
+    "eslint": "^9.18.0",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-mocha": "10.5.0",
     "expect": "29.7.0",

package/typings/promiseBasedTypes.d.ts

@@ -1204,7 +1204,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1322,7 +1321,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -2001,7 +1999,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2132,7 +2129,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3212,7 +3208,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6595,7 +6590,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8408,7 +8402,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9803,7 +9796,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -1228,7 +1228,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1346,7 +1345,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -2028,7 +2026,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2159,7 +2156,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3305,7 +3301,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6839,7 +6834,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8788,7 +8782,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -10243,7 +10236,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -12346,7 +12338,7 @@ declare namespace CodeceptJS {
         }, newPlugins: {
             [key: string]: any;
         }): void;
-        static started(fn: ((...params: any[]) => any) | null): Promise<void>;
+        static started(fn: (...params: any[]) => any): Promise<void>;
         /**
          * Share data across worker threads
          * @param options - set {local: true} to not share among workers
@@ -12603,20 +12595,6 @@ declare namespace CodeceptJS {
     function pause(passedObject?: {
         [key: string]: any;
     }): void;
-    /**
-     * Creates a debug logger for a given namespace and optionally logs messages.
-     * @example
-     * // Log a message immediately
-     * debugLog('codeceptjs:pause', 'This is a pause debug message.');
-     * @example
-     * // Create a reusable logger
-     * const logger = debugLog('app:module');
-     * logger('This is a reusable log for app:module.');
-     * @param namespace - The namespace to use for the debug logger.
-     * @param args - Additional arguments to log immediately.
-     * @returns The debug logger instance for the given namespace.
-     */
-    function debugLog(namespace: string, ...args: any[]): (...params: any[]) => any;
     /**
      * Singleton object to record all test steps as promises and run them in chain.
      */
@@ -12693,24 +12671,49 @@ declare namespace CodeceptJS {
     function session(sessionName: CodeceptJS.LocatorOrString, config: ((...params: any[]) => any) | {
         [key: string]: any;
     }, fn?: (...params: any[]) => any): any;
+    /**
+     * StepConfig is a configuration object for a step.
+     * It is used to create a new step that is a combination of other steps.
+     */
+    class StepConfig {
+        config: any;
+        /**
+         * Set the options for the step.
+         * @param opts - The options for the step.
+         * @returns - The step configuration object.
+         */
+        opts(opts: any): StepConfig;
+        /**
+         * Set the timeout for the step.
+         * @param timeout - The timeout for the step.
+         * @returns - The step configuration object.
+         */
+        timeout(timeout: number): StepConfig;
+        /**
+         * Set the retry for the step.
+         * @param retry - The retry for the step.
+         * @returns - The step configuration object.
+         */
+        retry(retry: number): StepConfig;
+    }
     /**
      * Each command in test executed through `I.` object is wrapped in Step.
      * Step allows logging executed commands and triggers hook before and after step execution.
      */
     class Step {
-        constructor(helper: CodeceptJS.Helper, name: string);
-        actor: string;
-        helper: CodeceptJS.Helper;
+        constructor(name: string);
         name: string;
+        timeouts: Map<number, number>;
+        args: any[];
+        opts: Record<string, any>;
+        actor: string;
         helperMethod: string;
         status: string;
-        suffix: string;
         prefix: string;
         comment: string;
-        args: any[];
-        metaStep: MetaStep;
+        metaStep: any;
         stack: string;
-        getTimeout(): number | undefined;
+        timeout: any;
         /**
          * @param timeout - timeout in milliseconds or 0 if no timeout
          * @param order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
@@ -12719,7 +12722,6 @@ declare namespace CodeceptJS {
         setTimeout(timeout: number, order: number): void;
         setTrace(): void;
         setArguments(args: any[]): void;
-        run(...args: any[]): any;
         setStatus(status: string): void;
         humanize(): string;
         humanizeArgs(): string;
@@ -12728,11 +12730,6 @@ declare namespace CodeceptJS {
         toCliStyled(): string;
         toCode(): string;
         hasBDDAncestor(): boolean;
-        static MetaStep: typeof MetaStep;
-    }
-    class MetaStep extends Step {
-        isBDD(): boolean;
-        run(): any;
     }
     /**
      * global values for current session
@@ -12743,6 +12740,7 @@ declare namespace CodeceptJS {
         var dryRun: boolean;
         var onPause: boolean;
         var currentTest: CodeceptJS.Test | null;
+        var currentStep: any;
     }
     /**
      * Describe a "suite" with the given `title`
@@ -12769,6 +12767,10 @@ declare namespace CodeceptJS {
      * Can inject values and add custom configuration.
      */
     class FeatureConfig {
+        /**
+         * Set metadata for this suite
+         */
+        meta(key: string, value: string): this;
         /**
          * Retry this test for number of times
          */
@@ -12803,6 +12805,10 @@ declare namespace CodeceptJS {
          * Retry this test for x times
          */
         retry(retries: number): this;
+        /**
+         * Set metadata for this test
+         */
+        meta(key: string, value: string): this;
         /**
          * Set timeout for this test
          */
@@ -13435,22 +13441,12 @@ declare namespace CodeceptJS {
 }
 
 /**
- * timeouts set with order below zero only override timeouts of higher order if their value is smaller
- */
-declare var testOrSuite: any;
-
-/**
- * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
- */
-declare var stepTimeoutHard: any;
-
-/**
- * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+ * corresponding helper
  */
-declare var codeLimitTime: any;
+declare var helper: CodeceptJS.Helper;
 
 /**
- * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+ * name of method to be executed
  */
-declare var stepTimeoutSoft: any;
+declare var helperMethod: string;