codeceptjs 3.6.4-beta.2 → 3.6.5-beta.1

package/lib/plugin/wdio.js

@@ -1,17 +1,17 @@
-const debug = require('debug')('codeceptjs:plugin:wdio');
+const debug = require('debug')('codeceptjs:plugin:wdio')
 
-const container = require('../container');
-const mainConfig = require('../config');
-const recorder = require('../recorder');
-const event = require('../event');
-const output = require('../output');
+const container = require('../container')
+const mainConfig = require('../config')
+const recorder = require('../recorder')
+const event = require('../event')
+const output = require('../output')
 
 const defaultConfig = {
   services: [],
   capabilities: {},
-};
+}
 
-let restartsSession;
+let restartsSession
 
 /**
  * Webdriverio services runner.
@@ -83,162 +83,167 @@ let restartsSession;
  */
 module.exports = (config) => {
   // Keep initial configs to pass as options to wdio services
-  const wdioOptions = { ...config };
-  const webDriver = container.helpers('WebDriver');
+  const wdioOptions = { ...config }
+  const webDriver = container.helpers('WebDriver')
   if (webDriver) {
-    config = Object.assign(webDriver.options, config);
-    restartsSession = !!config.restart;
+    config = Object.assign(webDriver.options, config)
+    restartsSession = !!config.restart
   }
-  config = Object.assign(defaultConfig, config);
-  const seleniumInstallArgs = { ...config.seleniumInstallArgs };
-  const seleniumArgs = { ...config.seleniumArgs };
+  config = Object.assign(defaultConfig, config)
+  const seleniumInstallArgs = { ...config.seleniumInstallArgs }
+  const seleniumArgs = { ...config.seleniumArgs }
 
-  const services = [];
-  const launchers = [];
+  const services = []
+  const launchers = []
 
   for (const name of config.services) {
-    const Service = safeRequire(`@wdio/${name.toLowerCase()}-service`);
+    const Service = safeRequire(`@wdio/${name.toLowerCase()}-service`)
     if (Service) {
       if (Service.launcher && typeof Service.launcher === 'function') {
-        const Launcher = Service.launcher;
+        const Launcher = Service.launcher
 
         const options = {
-          logPath: global.output_dir, installArgs: seleniumInstallArgs, args: seleniumArgs, ...wdioOptions,
-        };
-        launchers.push(new Launcher(options, [config.capabilities], config));
+          logPath: global.output_dir,
+          installArgs: seleniumInstallArgs,
+          args: seleniumArgs,
+          ...wdioOptions,
+        }
+        launchers.push(new Launcher(options, [config.capabilities], config))
       }
       if (typeof Service === 'function') {
-        services.push(new Service(config, config.capabilities));
+        services.push(new Service(config, config.capabilities))
       }
-      continue;
+      continue
     }
 
-    throw new Error(`Couldn't initialize service ${name} from wdio plugin config.\nIt should be available either in '@wdio/${name.toLowerCase()}-service' package`);
+    throw new Error(
+      `Couldn't initialize service ${name} from wdio plugin config.\nIt should be available either in '@wdio/${name.toLowerCase()}-service' package`,
+    )
   }
 
-  debug(`services ${services}, launchers ${launchers}`);
+  debug(`services ${services}, launchers ${launchers}`)
 
-  recorder.startUnlessRunning();
+  recorder.startUnlessRunning()
 
   for (const launcher of launchers) {
-    registerLauncher(launcher);
+    registerLauncher(launcher)
   }
 
   for (const service of services) {
-    registerService(service);
+    registerService(service)
   }
 
   function registerService(service) {
-    const name = service.constructor.name;
+    const name = service.constructor.name
     if (service.beforeSession) {
       event.dispatcher.on(event.all.before, () => {
         recorder.add(`service ${name} all.before`, async () => {
-          await service.beforeSession(config, config.capabilities);
-        });
-      });
+          await service.beforeSession(config, config.capabilities)
+        })
+      })
     }
 
     if (service.afterSession) {
       event.dispatcher.on(event.all.result, (result) => {
         recorder.add(`service ${name} all.after`, async () => {
-          await service.afterSession(result);
-        });
-      });
+          await service.afterSession(result)
+        })
+      })
     }
 
     if (service.beforeSuite) {
       event.dispatcher.on(event.suite.before, (suite) => {
-        debug(`suite started: ${suite.title}`);
-        recorder.add(`service ${name} suite.before`, () => service.beforeSuite(suite));
-      });
+        debug(`suite started: ${suite.title}`)
+        recorder.add(`service ${name} suite.before`, () => service.beforeSuite(suite))
+      })
     }
 
     if (service.afterSuite) {
       event.dispatcher.on(event.suite.after, (suite) => {
-        debug(`suite finished: ${suite.title}`);
-        recorder.add(`service ${name} suite.after`, () => service.afterSuite(suite));
-      });
+        debug(`suite finished: ${suite.title}`)
+        recorder.add(`service ${name} suite.after`, () => service.afterSuite(suite))
+      })
     }
 
     if (service.beforeTest) {
       event.dispatcher.on(event.test.started, async (test) => {
         if (test.parent) {
-          test.parent.toString = () => test.parent.title;
+          test.parent.toString = () => test.parent.title
         }
         // test.parent = test.parent ? test.parent.title : null;
-        debug(`test started: ${test.title}`);
+        debug(`test started: ${test.title}`)
         if (webDriver) {
-          global.browser = webDriver.browser;
-          global.browser.config = Object.assign(mainConfig.get('test', 1), global.browser.config);
+          global.browser = webDriver.browser
+          global.browser.config = Object.assign(mainConfig.get('test', 1), global.browser.config)
         }
-        await service.beforeTest(test);
-      });
+        await service.beforeTest(test)
+      })
     }
 
     if (service.afterTest) {
       event.dispatcher.on(event.test.finished, async (test) => {
-        debug(`test finished: ${test.title}`);
-        await service.afterTest(test);
-      });
+        debug(`test finished: ${test.title}`)
+        await service.afterTest(test)
+      })
     }
 
     if (restartsSession && service.before) {
-      event.dispatcher.on(event.test.started, () => service.before());
+      event.dispatcher.on(event.test.started, () => service.before())
     }
 
     if (restartsSession && service.after) {
-      event.dispatcher.on(event.test.finished, () => service.after());
+      event.dispatcher.on(event.test.finished, () => service.after())
     }
 
     if (!restartsSession && service.before) {
-      let initializedBrowser = false;
+      let initializedBrowser = false
       event.dispatcher.on(event.test.started, async () => {
         if (!initializedBrowser) {
-          await service.before();
-          initializedBrowser = true;
+          await service.before()
+          initializedBrowser = true
         }
-      });
+      })
     }
 
     if (!restartsSession && service.after) {
-      event.dispatcher.on(event.all.result, result => service.after(result));
+      event.dispatcher.on(event.all.result, (result) => service.after(result))
     }
   }
 
   function registerLauncher(launcher) {
-    const name = launcher.constructor.name;
+    const name = launcher.constructor.name
     if (launcher.onPrepare) {
       event.dispatcher.on(event.all.before, () => {
         recorder.add(`launcher ${name} start`, async () => {
           // browserstack-service expects capabilities as array
           if (launcher.constructor.name === 'BrowserstackLauncherService') {
-            await launcher.onPrepare(config, [config.capabilities]);
+            await launcher.onPrepare(config, [config.capabilities])
           } else {
-            await launcher.onPrepare(config, config.capabilities);
+            await launcher.onPrepare(config, config.capabilities)
           }
-          output.debug(`Started ${name}`);
-        });
-      });
+          output.debug(`Started ${name}`)
+        })
+      })
     }
 
     if (launcher.onComplete) {
       event.dispatcher.on(event.all.after, () => {
         recorder.add(`launcher ${name} start`, async () => {
-          await launcher.onComplete(process.exitCode, config, config.capabilities);
-          output.debug(`Stopped ${name}`);
-        });
-      });
+          await launcher.onComplete(process.exitCode, config, config.capabilities)
+          output.debug(`Stopped ${name}`)
+        })
+      })
     }
   }
-};
+}
 
 function safeRequire(name) {
   try {
-    return require(name);
+    return require(name)
   } catch (e) {
     if (!e.message.match(`Cannot find module '${name}'`)) {
-      throw new Error(`Couldn't initialise "${name}".\n${e.stack}`);
+      throw new Error(`Couldn't initialise "${name}".\n${e.stack}`)
     }
-    return null;
+    return null
   }
 }

package/lib/template/heal.js

@@ -1,4 +1,4 @@
-const { heal, ai } = require('codeceptjs');
+const { heal, ai } = require('codeceptjs')
 
 heal.addRecipe('ai', {
   priority: 10,
@@ -16,24 +16,21 @@ heal.addRecipe('ai', {
     'doubleClick',
   ],
   fn: async (args) => {
-    return ai.healFailedStep(args);
+    return ai.healFailedStep(args)
   },
-});
+})
 
 heal.addRecipe('clickAndType', {
   priority: 1,
-  steps: [
-    'fillField',
-    'appendField',
-  ],
+  steps: ['fillField', 'appendField'],
   fn: async ({ step }) => {
-    const locator = step.args[0];
-    const text = step.args[1];
+    const locator = step.args[0]
+    const text = step.args[1]
 
     return ({ I }) => {
-      I.click(locator);
-      I.wait(1); // to open modal or something
-      I.type(text);
-    };
+      I.click(locator)
+      I.wait(1) // to open modal or something
+      I.type(text)
+    }
   },
-});
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.4-beta.2",
+  "version": "3.6.5-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -39,6 +39,7 @@
     "json-server:graphql": "node test/data/graphql/index.js",
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
     "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.js --fix",
+    "prettier": "prettier --config prettier.config.js --write bin/**/*.js lib/**/*.js test/**/*.js translations/**/*.js runok.js",
     "docs": "./runok.js docs",
     "test:unit": "mocha test/unit --recursive --timeout 10000",
     "test:runner": "mocha test/runner --recursive --timeout 10000",
@@ -72,14 +73,14 @@
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "17",
     "@cucumber/gherkin": "26",
-    "@cucumber/messages": "24.1.0",
+    "@cucumber/messages": "25.0.1",
     "@xmldom/xmldom": "0.8.10",
     "acorn": "8.11.3",
     "arrify": "2.0.1",
     "axios": "1.7.2",
     "chai": "5.1.1",
     "chai-deep-match": "1.2.1",
-    "chai-exclude": "2.1.0",
+    "chai-exclude": "2.1.1",
     "chai-json-schema": "1.5.1",
     "chai-json-schema-ajv": "5.2.4",
     "chai-match-pattern": "1.3.0",
@@ -149,6 +150,7 @@
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
     "playwright": "1.44.1",
+    "prettier": "^3.3.2",
     "puppeteer": "22.10.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",

package/translations/de-DE.js

@@ -71,4 +71,4 @@ module.exports = {
     sendPostRequest: 'mache_einen_post_request',
     switchTo: 'wechlse_in_iframe',
   },
-};
+}

package/translations/fr-FR.js

@@ -73,4 +73,4 @@ module.exports = {
     sendDeleteRequest: 'envoieLaRequêteDelete',
     sendPostRequest: 'envoieLaRequêtePost',
   },
-};
+}

package/translations/index.js

@@ -1,9 +1,9 @@
-exports['de-DE'] = require('./de-DE');
-exports['it-IT'] = require('./it-IT');
-exports['fr-FR'] = require('./fr-FR');
-exports['ja-JP'] = require('./ja-JP');
-exports['pl-PL'] = require('./pl-PL');
-exports['pt-BR'] = require('./pt-BR');
-exports['ru-RU'] = require('./ru-RU');
-exports['zh-CN'] = require('./zh-CN');
-exports['zh-TW'] = require('./zh-TW');
+exports['de-DE'] = require('./de-DE')
+exports['it-IT'] = require('./it-IT')
+exports['fr-FR'] = require('./fr-FR')
+exports['ja-JP'] = require('./ja-JP')
+exports['pl-PL'] = require('./pl-PL')
+exports['pt-BR'] = require('./pt-BR')
+exports['ru-RU'] = require('./ru-RU')
+exports['zh-CN'] = require('./zh-CN')
+exports['zh-TW'] = require('./zh-TW')

package/translations/it-IT.js

@@ -61,4 +61,4 @@ module.exports = {
     resizeWindow: 'ridimesiono_la_finestra',
     wait: 'aspetto',
   },
-};
+}

package/translations/ja-JP.js

@@ -57,4 +57,4 @@ module.exports = {
     resizeWindow: 'ウィンドウをリサイズする',
     wait: '待つ',
   },
-};
+}

package/translations/pl-PL.js

@@ -62,4 +62,4 @@ module.exports = {
     moveCursorTo: 'przesuwam_kursor_do',
     scrollTo: 'skroluję_do',
   },
-};
+}

package/translations/pt-BR.js

@@ -62,4 +62,4 @@ module.exports = {
     resizeWindow: 'redimensionaJanela',
     wait: 'aguardo',
   },
-};
+}

package/translations/ru-RU.js

@@ -55,4 +55,4 @@ module.exports = {
     resizeWindow: 'растягиваю_окно',
     wait: 'жду',
   },
-};
+}

package/translations/zh-CN.js

@@ -57,4 +57,4 @@ module.exports = {
     resizeWindow: '调整窗口尺寸',
     wait: '等',
   },
-};
+}

package/translations/zh-TW.js

@@ -57,4 +57,4 @@ module.exports = {
     resizeWindow: '調整窗口尺寸',
     wait: '等',
   },
-};
+}

package/typings/index.d.ts

@@ -44,6 +44,44 @@ declare namespace CodeceptJS {
     Scenario: number;
   };
 
+  type AiPrompt = {
+    role: string;
+    content: string;
+  }
+
+  type AiConfig = {
+    /** request function to send prompts to AI provider */
+    request: (messages: any) => Promise<string>,
+
+    /** custom prompts */
+    prompts?: {
+      /** Returns prompt to write CodeceptJS steps inside pause mode  */
+      writeStep?: (html: string, input: string) => Array<AiPrompt>;
+      /** Returns prompt to heal step when test fails on CI if healing is on  */
+      healStep?: (html: string, object) => Array<AiPrompt>;
+      /** Returns prompt to generate page object inside pause mode  */
+      generatePageObject?: (html: string, extraPrompt?: string, rootLocator?: string) => Array<AiPrompt>;
+    },
+
+    /** max tokens to use */
+    maxTokens?: number,
+
+
+    /** configuration for processing HTML for GPT */
+    html?: {
+      /** max size of HTML to be sent to OpenAI to avoid token limit */
+      maxLength?: number,
+      /** should HTML be changed by removing non-interactive elements */
+      simplify?: boolean,
+      /** should HTML be minified before sending */
+      minify?: boolean,
+      interactiveElements?: Array<string>,
+      textElements?: Array<string>,
+      allowedAttrs?: Array<string>,
+      allowedRoles?: Array<string>,
+    }
+  }
+
   type MainConfig = {
     /** Pattern to locate CodeceptJS tests.
      * Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names.
@@ -165,6 +203,9 @@ declare namespace CodeceptJS {
        */
       JSONResponse?: any;
 
+      /** Enable AI features for development purposes */
+      AI?: any;
+
       [key: string]: any;
     },
     /**
@@ -353,25 +394,7 @@ declare namespace CodeceptJS {
     /**
      * [AI](https://codecept.io/ai/) features configuration.
      */
-    ai?: {
-      /** OpenAI model to use */
-      model?: string,
-      /** temperature, measure of randomness. Lower is better. */
-      temperature?: number,
-      /** configuration for processing HTML for GPT */
-      html?: {
-        /** max size of HTML to be sent to OpenAI to avoid token limit */
-        maxLength?: number,
-        /** should HTML be changed by removing non-interactive elements */
-        simplify?: boolean,
-        /** should HTML be minified before sending */
-        minify?: boolean,
-        interactiveElements?: Array<string>,
-        textElements?: Array<string>,
-        allowedAttrs?: Array<string>,
-        allowedRoles?: Array<string>,
-      }
-    },
+    ai?: AiConfig,
 
     /**
      * Enable full promise-based helper methods for [TypeScript](https://codecept.io/typescript/) project.