codeceptjs 3.7.6-beta.4 → 4.0.0-beta.10.esm-aria

package/lib/secret.js

@@ -1,20 +1,20 @@
-const { deepClone } = require('./utils');
+import { deepClone } from './utils.js'
 
-const maskedString = '*****';
+const maskedString = '*****'
 
 /** @param {string} secret */
 class Secret {
   constructor(secret) {
-    this._secret = secret;
+    this._secret = secret
   }
 
   /** @returns {string} */
   toString() {
-    return this._secret;
+    return this._secret
   }
 
   getMasked() {
-    return maskedString;
+    return maskedString
   }
 
   /**
@@ -23,11 +23,11 @@ class Secret {
    */
   static secret(secret) {
     if (typeof secret === 'object') {
-      const fields = Array.from(arguments);
-      fields.shift();
-      return secretObject(secret, fields);
+      const fields = Array.from(arguments)
+      fields.shift()
+      return secretObject(secret, fields)
     }
-    return new Secret(secret);
+    return new Secret(secret)
   }
 }
 
@@ -36,16 +36,17 @@ function secretObject(obj, fieldsToHide = []) {
     get(obj, prop) {
       if (prop === 'toString') {
         return function () {
-          const maskedObject = deepClone(obj);
-          fieldsToHide.forEach(f => (maskedObject[f] = maskedString));
-          return JSON.stringify(maskedObject);
-        };
+          const maskedObject = deepClone(obj)
+          fieldsToHide.forEach(f => (maskedObject[f] = maskedString))
+          return JSON.stringify(maskedObject)
+        }
       }
-      return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop];
+      return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop]
     },
-  };
+  }
 
-  return new Proxy(obj, handler);
+  return new Proxy(obj, handler)
 }
 
-module.exports = Secret;
+export default Secret
+export const secret = Secret.secret

package/lib/session.js

@@ -1,19 +1,13 @@
-const recorder = require('./recorder');
-const container = require('./container');
-const event = require('./event');
-const output = require('./output');
-const store = require('./store');
-const { isAsyncFunction } = require('./utils');
-
-const sessionColors = [
-  'cyan',
-  'blue',
-  'red',
-  'magenta',
-  'yellow',
-];
-
-const savedSessions = {};
+import recorder from './recorder.js'
+import container from './container.js'
+import event from './event.js'
+import output from './output.js'
+import store from './store.js'
+import { isAsyncFunction } from './utils.js'
+
+const sessionColors = ['cyan', 'blue', 'red', 'magenta', 'yellow']
+
+const savedSessions = {}
 
 /**
  * @param {CodeceptJS.LocatorOrString}  sessionName
@@ -24,109 +18,121 @@ const savedSessions = {};
 function session(sessionName, config, fn) {
   if (typeof config === 'function') {
     if (typeof fn === 'function') {
-      config = config();
+      config = config()
     } else {
       // no config but with function
-      fn = config;
-      config = {};
+      fn = config
+      config = {}
     }
   }
   // session helpers won't use beforeSuite and afterSuite hooks...
   // restart: false options are not allowed as well
   // but those helpers should be already started so inside listener/helpers.js the `_init` method should already be called
 
-  const helpers = container.helpers();
+  const helpers = container.helpers()
 
   if (!savedSessions[sessionName]) {
     for (const helper in helpers) {
-      if (!helpers[helper]._session) continue;
+      if (!helpers[helper]._session) continue
       savedSessions[sessionName] = {
         start: () => null,
         stop: () => null,
         loadVars: () => null,
         restoreVars: () => null,
         ...(store.dryRun ? {} : helpers[helper]._session()),
-      };
-      break;
+      }
+      break
     }
 
     const closeBrowsers = () => {
-      const session = savedSessions[sessionName];
-      if (!session) return;
-      session.stop(session.vars);
-      delete savedSessions[sessionName];
-    };
+      const session = savedSessions[sessionName]
+      if (!session) return
+      session.stop(session.vars)
+      delete savedSessions[sessionName]
+    }
 
     event.dispatcher.once(event.test.after, () => {
-      recorder.add('close session browsers', closeBrowsers);
-    });
+      recorder.add('close session browsers', closeBrowsers)
+    })
 
     if (!savedSessions[sessionName]) {
-      throw new Error('Configured helpers do not support starting sessions. Please use a helper with session support.');
+      throw new Error('Configured helpers do not support starting sessions. Please use a helper with session support.')
     }
 
     recorder.add('save vars', async () => {
-      savedSessions[sessionName].vars = await savedSessions[sessionName].start(sessionName, config);
-    });
+      savedSessions[sessionName].vars = await savedSessions[sessionName].start(sessionName, config)
+    })
   }
 
   // pick random color
-  const color = sessionColors[Object.keys(savedSessions).indexOf(sessionName) % sessionColors.length];
-
-  const addContextToStep = (step) => {
-    step.actor = `${output.colors[color](sessionName)}: I`;
-  };
-
-  if (!fn) return; // no current session steps
-
-  return recorder.add('register session wrapper', async () => {
-    const session = savedSessions[sessionName];
-    recorder.session.start(`session:${sessionName}`);
-    event.dispatcher.on(event.step.after, addContextToStep);
-    recorder.add('switch to browser', () => {
-      const session = savedSessions[sessionName];
-      return session.loadVars(session.vars);
-    });
-
-    const finalize = () => {
-      recorder.add('Finalize session', async () => {
-        output.stepShift = 0;
-        event.dispatcher.removeListener(event.step.after, addContextToStep);
-        await session.restoreVars();
-        recorder.session.restore(`session:${sessionName}`);
-      });
-    };
-
-    // Indicate when executing this function that we are in a session
-    if (isAsyncFunction(fn)) {
-      return fn.apply(null).then((res) => {
-        finalize();
-        return recorder.promise().then(() => res);
-      }).catch((e) => {
-        output.stepShift = 0;
-        session.restoreVars(sessionName);
-        event.dispatcher.removeListener(event.step.after, addContextToStep);
-        recorder.throw(e);
-        return recorder.promise();
-      });
-    }
+  const color = sessionColors[Object.keys(savedSessions).indexOf(sessionName) % sessionColors.length]
 
-    let res;
-    try {
-      res = fn.apply(null);
-    } catch (err) {
-      recorder.throw(err);
-    } finally {
-      recorder.catch((e) => {
-        session.restoreVars(sessionName);
-        output.stepShift = 0;
-        event.dispatcher.removeListener(event.step.after, addContextToStep);
-        throw e;
-      });
-    }
-    finalize();
-    return recorder.promise().then(() => res);
-  }, false, false);
+  const addContextToStep = step => {
+    step.actor = `${output.colors[color](sessionName)}: I`
+  }
+
+  if (!fn) return // no current session steps
+
+  return recorder.add(
+    'register session wrapper',
+    async () => {
+      const session = savedSessions[sessionName]
+      if (!session) {
+        throw new Error(`Session "${sessionName}" not found. It may have been closed already.`)
+      }
+      recorder.session.start(`session:${sessionName}`)
+      event.dispatcher.on(event.step.after, addContextToStep)
+      recorder.add('switch to browser', () => {
+        const session = savedSessions[sessionName]
+        return session.loadVars(session.vars)
+      })
+
+      const finalize = () => {
+        recorder.add('Finalize session', async () => {
+          output.stepShift = 0
+          event.dispatcher.removeListener(event.step.after, addContextToStep)
+          await session.restoreVars()
+          recorder.session.restore(`session:${sessionName}`)
+        })
+      }
+
+      // Indicate when executing this function that we are in a session
+      if (isAsyncFunction(fn)) {
+        return fn
+          .apply(null)
+          .then(async res => {
+            finalize()
+            await recorder.promise()
+            return res
+          })
+          .catch(e => {
+            output.stepShift = 0
+            session.restoreVars(sessionName)
+            event.dispatcher.removeListener(event.step.after, addContextToStep)
+            recorder.throw(e)
+            return recorder.promise()
+          })
+      }
+
+      let res
+      try {
+        res = fn.apply(null)
+      } catch (err) {
+        recorder.throw(err)
+      } finally {
+        recorder.catch(e => {
+          session.restoreVars(sessionName)
+          output.stepShift = 0
+          event.dispatcher.removeListener(event.step.after, addContextToStep)
+          throw e
+        })
+      }
+      finalize()
+      return recorder.promise().then(() => res)
+    },
+    false,
+    false,
+  )
 }
 
-module.exports = session;
+export default session

package/lib/step/base.js

@@ -1,8 +1,8 @@
-const color = require('chalk')
-const Secret = require('../secret')
-const { getCurrentTimeout } = require('../timeout')
-const { ucfirst, humanizeString, serializeError } = require('../utils')
-const recordStep = require('./record')
+import color from 'chalk'
+import Secret from '../secret.js'
+import { getCurrentTimeout } from '../timeout.js'
+import { ucfirst, humanizeString, serializeError } from '../utils.js'
+import recordStep from './record.js'
 
 const STACK_LINE = 5
 
@@ -225,7 +225,7 @@ class Step {
     processingStep = this
 
     while (processingStep.metaStep) {
-      if (processingStep.metaStep.actor?.match(/^(Given|When|Then|And)/)) {
+      if (processingStep.metaStep.actor?.match(/^(Given|When|Then|And|But)/)) {
         hasBDD = true
         break
       } else {
@@ -236,4 +236,4 @@ class Step {
   }
 }
 
-module.exports = Step
+export default Step

package/lib/step/comment.js

@@ -1,4 +1,4 @@
-const FuncStep = require('./func')
+import FuncStep from './func.js'
 
 class CommentStep extends FuncStep {
   constructor(name, comment) {
@@ -7,4 +7,4 @@ class CommentStep extends FuncStep {
   }
 }
 
-module.exports = CommentStep
+export default CommentStep

package/lib/step/config.js

@@ -47,4 +47,4 @@ class StepConfig {
   }
 }
 
-module.exports = StepConfig
+export default StepConfig

package/lib/step/func.js

@@ -1,5 +1,5 @@
-const BaseStep = require('./base')
-const store = require('../store')
+import BaseStep from './base.js'
+import store from '../store.js'
 
 /**
  * Function executed as a step
@@ -43,4 +43,4 @@ class FuncStep extends BaseStep {
   }
 }
 
-module.exports = FuncStep
+export default FuncStep

package/lib/step/helper.js

@@ -1,5 +1,5 @@
-const Step = require('./base')
-const store = require('../store')
+import Step from './base.js'
+import store from '../store.js'
 
 class HelperStep extends Step {
   constructor(helper, name) {
@@ -38,7 +38,7 @@ class HelperStep extends Step {
   }
 }
 
-module.exports = HelperStep
+export default HelperStep
 
 function dryRunResolver() {
   return {

package/lib/step/meta.js

@@ -1,6 +1,6 @@
-const Step = require('./base')
-const event = require('../event')
-const { humanizeString } = require('../utils')
+import Step from './base.js'
+import event from '../event.js'
+import { humanizeString } from '../utils.js'
 
 class MetaStep extends Step {
   constructor(actor, method) {
@@ -15,7 +15,7 @@ class MetaStep extends Step {
 
   /** @return {boolean} */
   isBDD() {
-    if (this.actor && this.actor.match && this.actor.match(/^(Given|When|Then|And)/)) {
+    if (this.actor && this.actor.match && this.actor.match(/^(Given|When|Then|And|But)/)) {
       return true
     }
     return false
@@ -96,4 +96,4 @@ class MetaStep extends Step {
   }
 }
 
-module.exports = MetaStep
+export default MetaStep

package/lib/step/record.js

@@ -1,10 +1,10 @@
-const event = require('../event')
-const recorder = require('../recorder')
-const StepConfig = require('./config')
-const { debug } = require('../output')
-const store = require('../store')
-const { TIMEOUT_ORDER } = require('../timeout')
-const retryStep = require('./retry')
+import event from '../event.js'
+import recorder from '../recorder.js'
+import StepConfig from './config.js'
+import output from '../output.js'
+import store from '../store.js'
+import { TIMEOUT_ORDER } from '../timeout.js'
+import retryStep from './retry.js'
 function recordStep(step, args) {
   step.status = 'queued'
 
@@ -15,12 +15,12 @@ function recordStep(step, args) {
     const { opts, timeout, retry } = stepConfig.getConfig()
 
     if (opts) {
-      debug(`Step ${step.name}: options applied ${JSON.stringify(opts)}`)
+      output.debug(`Step ${step.name}: options applied ${JSON.stringify(opts)}`)
       store.stepOptions = opts
       step.opts = opts
     }
     if (timeout) {
-      debug(`Step ${step.name} timeout ${timeout}s`)
+      output.debug(`Step ${step.name} timeout ${timeout}s`)
       step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime)
     }
     if (retry) retryStep(retry)
@@ -57,7 +57,7 @@ function recordStep(step, args) {
     event.emit(event.step.finished, step)
   })
 
-  recorder.catchWithoutStop(err => {
+  recorder.catch(err => {
     step.status = 'failed'
     step.endTime = +Date.now()
     event.emit(event.step.failed, step, err)
@@ -71,4 +71,4 @@ function recordStep(step, args) {
   return recorder.promise()
 }
 
-module.exports = recordStep
+export default recordStep

package/lib/step/retry.js

@@ -1,5 +1,5 @@
-const recorder = require('../recorder')
-const event = require('../event')
+import recorder from '../recorder.js'
+import event from '../event.js'
 
 function retryStep(opts) {
   if (opts === undefined) opts = 1
@@ -8,4 +8,4 @@ function retryStep(opts) {
   recorder.add(() => event.dispatcher.once(event.step.finished, () => recorder.retries.pop()))
 }
 
-module.exports = retryStep
+export default retryStep

package/lib/step/section.js

@@ -1,5 +1,5 @@
-const MetaStep = require('./meta')
-const event = require('../event')
+import MetaStep from './meta.js'
+import event from '../event.js'
 
 let currentSection
 
@@ -52,4 +52,4 @@ function getRootMetaStep(step) {
   return step
 }
 
-module.exports = Section
+export default Section

package/lib/step.js

@@ -3,24 +3,21 @@
  * Step is wrapper around a helper method.
  * It is used to create a new step that is a combination of other steps.
  */
-const BaseStep = require('./step/base')
-const StepConfig = require('./step/config')
-const Step = require('./step/helper')
+import BaseStep from './step/base.js'
+import StepConfig from './step/config.js'
+import Step from './step/helper.js'
 
 /**
  * MetaStep is a step that is used to wrap other steps.
  * It is used to create a new step that is a combination of other steps.
  * It is used to create a new step that is a combination of other steps.
  */
-const MetaStep = require('./step/meta')
+import MetaStep from './step/meta.js'
 
 /**
  * Step used to execute a single function
  */
-const FuncStep = require('./step/func')
+import FuncStep from './step/func.js'
 
-module.exports = Step
-module.exports.MetaStep = MetaStep
-module.exports.BaseStep = BaseStep
-module.exports.StepConfig = StepConfig
-module.exports.FuncStep = FuncStep
+export default Step
+export { MetaStep, BaseStep, StepConfig, FuncStep }

package/lib/steps.js

@@ -1,5 +1,5 @@
-const StepConfig = require('./step/config')
-const Section = require('./step/section')
+import StepConfig from './step/config.js'
+import SectionClass from './step/section.js'
 function stepOpts(opts = {}) {
   return new StepConfig(opts)
 }
@@ -14,11 +14,11 @@ function stepRetry(retry) {
 
 function section(name) {
   if (!name) return endSection()
-  return new Section(name).start()
+  return new SectionClass(name).start()
 }
 
 function endSection() {
-  return Section.current().end()
+  return SectionClass.current().end()
 }
 
 // Section function to be added here
@@ -47,4 +47,8 @@ const step = {
   Then: () => section('Then'),
 }
 
-module.exports = step
+export default step
+
+// Named exports for ESM compatibility
+export const Section = step.Section
+export const EndSection = step.EndSection

package/lib/store.js

@@ -43,4 +43,4 @@ const store = {
   currentSuite: null,
 }
 
-module.exports = store
+export default store

package/lib/template/heal.js

@@ -1,4 +1,4 @@
-const { heal, ai } = require('codeceptjs')
+import { heal, ai } from 'codeceptjs'
 
 heal.addRecipe('ai', {
   priority: 10,

package/lib/template/prompts/generatePageObject.js

@@ -0,0 +1,31 @@
+export default (html, extraPrompt = '', rootLocator = null) => [
+  {
+    role: 'user',
+    content: `As a test automation engineer I am creating a Page Object for a web application using CodeceptJS.
+      Here is an sample page object:
+
+const { I } = inject();
+
+export default {
+
+  // setting locators
+  element1: '#selector',
+  element2: '.selector',
+  element3: locate().withText('text'),
+
+  // setting methods
+  doSomethingOnPage(params) {
+    // ...
+  },
+}
+
+      I want to generate a Page Object for the page I provide.
+      Write JavaScript code in similar manner to list all locators on the page.
+      Use locators in order of preference: by text (use locate().withText()), label, CSS, XPath.
+      Avoid TailwindCSS, Bootstrap or React style formatting classes in locators.
+      Add methods to interact with page when needed.
+      ${extraPrompt}
+      ${rootLocator ? `All provided elements are inside '${rootLocator}'. Declare it as root variable and for every locator use locate(...).inside(root)` : ''}
+      Add only locators from this HTML: \n\n${html}`,
+  },
+]

package/lib/template/prompts/healStep.js

@@ -0,0 +1,13 @@
+export default (html, { step, error, prevSteps }) => {
+  return [
+    {
+      role: 'user',
+      content: `As a test automation engineer I am testing web application using CodeceptJS.
+      I want to heal a test that fails. Here is the list of executed steps: ${prevSteps.map(s => s.toString()).join(', ')}
+      Propose how to adjust ${step.toCode()} step to fix the test.
+      Use locators in order of preference: semantic locator by text, CSS, XPath. Use codeblocks marked with \`\`\`
+      Here is the error message: ${error.message}
+      Here is HTML code of a page where the failure has happened: \n\n${html}`,
+    },
+  ]
+}

package/lib/template/prompts/writeStep.js

@@ -0,0 +1,9 @@
+export default (html, input) => [
+  {
+    role: 'user',
+    content: `I am test engineer writing test in CodeceptJS
+      I have opened web page and I want to use CodeceptJS to ${input} on this page
+      Provide me valid CodeceptJS code to accomplish it
+      Use only locators from this HTML: \n\n${html}`,
+  },
+]

package/lib/test-server.js

@@ -1,6 +1,6 @@
-const express = require('express')
-const fs = require('fs')
-const path = require('path')
+import express from 'express'
+import fs from 'fs'
+import path from 'path'
 
 /**
  * Internal API test server to replace json-server dependency
@@ -13,6 +13,7 @@ class TestServer {
     this.port = config.port || 8010
     this.host = config.host || 'localhost'
     this.dbFile = config.dbFile || path.join(__dirname, '../test/data/rest/db.json')
+    this.readOnly = config.readOnly || false
     this.lastModified = null
     this.data = this.loadData()
 
@@ -49,6 +50,10 @@ class TestServer {
   }
 
   saveData() {
+    if (this.readOnly) {
+      console.log('[Save] Skipping save - running in read-only mode')
+      return
+    }
     try {
       fs.writeFileSync(this.dbFile, JSON.stringify(this.data, null, 2))
       console.log('[Save] Data saved to file')
@@ -297,10 +302,16 @@ class TestServer {
   }
 }
 
-module.exports = TestServer
+export default TestServer
+
+// CLI usage - Import meta for ESM
+import { fileURLToPath } from 'url'
+import { dirname } from 'path'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
 
-// CLI usage
-if (require.main === module) {
+if (import.meta.url === `file://${process.argv[1]}`) {
   const config = {
     port: process.env.PORT || 8010,
     host: process.env.HOST || '0.0.0.0',