codeceptjs 4.0.0-beta.4 → 4.0.0-beta.6.esm-aria

package/lib/command/workers/runTests.js

@@ -1,291 +1,181 @@
-const tty = require('tty');
+import tty from 'tty'
 
 if (!tty.getWindowSize) {
   // this is really old method, long removed from Node, but Mocha
   // reporters fall back on it if they cannot use `process.stdout.getWindowSize`
   // we need to polyfill it.
-  tty.getWindowSize = () => [40, 80];
+  tty.getWindowSize = () => [40, 80]
 }
 
-const { parentPort, workerData } = require('worker_threads');
-const event = require('../../event');
-const container = require('../../container');
-const { getConfig } = require('../utils');
-const { tryOrDefault, deepMerge } = require('../../utils');
+import { parentPort, workerData } from 'worker_threads'
+import event from '../../event.js'
+import container from '../../container.js'
+import { getConfig } from '../utils.js'
+import { tryOrDefault, deepMerge } from '../../utils.js'
 
-let stdout = '';
+let stdout = ''
 
-const stderr = '';
+const stderr = ''
 
-// Requiring of Codecept need to be after tty.getWindowSize is available.
-const Codecept = require(process.env.CODECEPT_CLASS_PATH || '../../codecept');
+// Importing of Codecept need to be after tty.getWindowSize is available.
+import Codecept from '../../codecept.js'
 
-const {
-  options, tests, testRoot, workerIndex,
-} = workerData;
+const { options, tests, testRoot, workerIndex } = workerData
 
 // hide worker output
-if (!options.debug && !options.verbose) process.stdout.write = (string) => { stdout += string; return true; };
+if (!options.debug && !options.verbose)
+  process.stdout.write = string => {
+    stdout += string
+    return true
+  }
 
-const overrideConfigs = tryOrDefault(() => JSON.parse(options.override), {});
+const overrideConfigs = tryOrDefault(() => JSON.parse(options.override), {})
 
 // important deep merge so dynamic things e.g. functions on config are not overridden
-const config = deepMerge(getConfig(options.config || testRoot), overrideConfigs);
+const config = deepMerge(getConfig(options.config || testRoot), overrideConfigs)
 
 // Load test and run
-const codecept = new Codecept(config, options);
-codecept.init(testRoot);
-codecept.loadTests();
-const mocha = container.mocha();
-filterTests();
-
-(async function () {
-  if (mocha.suite.total()) {
-    await runTests();
-  }
-}());
-
-async function runTests() {
-  try {
-    await codecept.bootstrap();
-  } catch (err) {
-    throw new Error(`Error while running bootstrap file :${err}`);
-  }
-  listenToParentThread();
-  initializeListeners();
-  disablePause();
-  try {
-    await codecept.run();
-  } finally {
-    await codecept.teardown();
-  }
-}
-
-function filterTests() {
-  const files = codecept.testFiles;
-  mocha.files = files;
-  mocha.loadFiles();
-
-  for (const suite of mocha.suite.suites) {
-    suite.tests = suite.tests.filter(test => tests.indexOf(test.uid) >= 0);
-  }
-}
-
-function initializeListeners() {
-  function simplifyError(error) {
-    if (error) {
-      const {
-        stack,
-        uncaught,
-        message,
-        actual,
-        expected,
-      } = error;
-
-      return {
-        stack,
-        uncaught,
-        message,
-        actual,
-        expected,
-      };
+;(async function () {
+  const codecept = new Codecept(config, options)
+  await codecept.init(testRoot)
+  codecept.loadTests()
+  const mocha = container.mocha()
+
+  function filterTests() {
+    const files = codecept.testFiles
+    mocha.files = files
+    mocha.loadFiles()
+
+    for (const suite of mocha.suite.suites) {
+      suite.tests = suite.tests.filter(test => tests.indexOf(test.uid) >= 0)
     }
-
-    return null;
   }
-  function simplifyTest(test, err = null) {
-    test = { ...test };
 
-    if (test.start && !test.duration) {
-      const end = new Date();
-      test.duration = end - test.start;
-    }
-
-    if (test.err) {
-      err = simplifyError(test.err);
-      test.status = 'failed';
-    } else if (err) {
-      err = simplifyError(err);
-      test.status = 'failed';
-    }
-    const parent = {};
-    if (test.parent) {
-      parent.title = test.parent.title;
+  async function runTests() {
+    try {
+      await codecept.bootstrap()
+    } catch (err) {
+      throw new Error(`Error while running bootstrap file :${err}`)
     }
-
-    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 || [],
-      uid: test.uid,
-      workerIndex,
-      retries: test._retries,
-      title: test.title,
-      status: test.status,
-      duration: test.duration || 0,
-      err,
-      parent,
-      steps: test.steps && test.steps.length > 0 ? simplifyStepsInTestObject(test.steps, err) : [],
-    };
-  }
-
-  function simplifyStepsInTestObject(steps, err) {
-    steps = [...steps];
-    const _steps = [];
-
-    for (step of steps) {
-      const _args = [];
-
-      if (step.args) {
-        for (const arg of step.args) {
-          // check if arg is a JOI object
-          if (arg && arg.$_root) {
-            _args.push(JSON.stringify(arg).slice(0, 300));
-          // check if arg is a function
-          } else if (arg && typeof arg === 'function') {
-            _args.push(arg.name);
-          } else {
-            _args.push(arg);
-          }
-        }
-      }
-
-      _steps.push({
-        actor: step.actor,
-        name: step.name,
-        status: step.status,
-        args: JSON.stringify(_args),
-        startedAt: step.startedAt,
-        startTime: step.startTime,
-        endTime: step.endTime,
-        finishedAt: step.finishedAt,
-        duration: step.duration,
-        err,
-      });
+    listenToParentThread()
+    initializeListeners()
+    disablePause()
+    try {
+      await codecept.run()
+    } finally {
+      await codecept.teardown()
     }
-
-    return _steps;
   }
 
-  function simplifyStep(step, err = null) {
-    step = { ...step };
-
-    if (step.startTime && !step.duration) {
-      const end = new Date();
-      step.duration = end - step.startTime;
-    }
-
-    if (step.err) {
-      err = simplifyError(step.err);
-      step.status = 'failed';
-    } else if (err) {
-      err = simplifyError(err);
-      step.status = 'failed';
-    }
-
-    const parent = {};
-    if (step.metaStep) {
-      parent.title = step.metaStep.actor;
-    }
+  filterTests()
 
-    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,
-      title: step.name,
-      status: step.status,
-      duration: step.duration || 0,
-      err,
-      parent,
-      test: simplifyTest(step.test),
-    };
+  // run tests
+  if (mocha.suite.total()) {
+    await runTests()
   }
+})()
 
-  collectStats();
+function initializeListeners() {
   // suite
-  event.dispatcher.on(event.suite.before, suite => sendToParentThread({ event: event.suite.before, workerIndex, data: simplifyTest(suite) }));
-  event.dispatcher.on(event.suite.after, suite => sendToParentThread({ event: event.suite.after, workerIndex, data: simplifyTest(suite) }));
+  event.dispatcher.on(event.suite.before, suite => safelySendToParent({ event: event.suite.before, workerIndex, data: suite.simplify() }))
+  event.dispatcher.on(event.suite.after, suite => safelySendToParent({ event: event.suite.after, workerIndex, data: suite.simplify() }))
 
   // calculate duration
-  event.dispatcher.on(event.test.started, test => test.start = new Date());
+  event.dispatcher.on(event.test.started, test => (test.start = new Date()))
 
   // tests
-  event.dispatcher.on(event.test.before, test => sendToParentThread({ event: event.test.before, workerIndex, data: simplifyTest(test) }));
-  event.dispatcher.on(event.test.after, test => sendToParentThread({ event: event.test.after, workerIndex, data: simplifyTest(test) }));
+  event.dispatcher.on(event.test.before, test => safelySendToParent({ event: event.test.before, workerIndex, data: test.simplify() }))
+  event.dispatcher.on(event.test.after, test => safelySendToParent({ event: event.test.after, workerIndex, data: test.simplify() }))
   // we should force-send correct errors to prevent race condition
-  event.dispatcher.on(event.test.finished, (test, err) => sendToParentThread({ event: event.test.finished, workerIndex, data: simplifyTest(test, err) }));
-  event.dispatcher.on(event.test.failed, (test, err) => sendToParentThread({ event: event.test.failed, workerIndex, data: simplifyTest(test, err) }));
-  event.dispatcher.on(event.test.passed, (test, err) => sendToParentThread({ event: event.test.passed, workerIndex, data: simplifyTest(test, err) }));
-  event.dispatcher.on(event.test.started, test => sendToParentThread({ event: event.test.started, workerIndex, data: simplifyTest(test) }));
-  event.dispatcher.on(event.test.skipped, test => sendToParentThread({ event: event.test.skipped, workerIndex, data: simplifyTest(test) }));
+  event.dispatcher.on(event.test.finished, (test, err) => {
+    const simplifiedData = test.simplify()
+    const serializableErr = serializeError(err)
+    safelySendToParent({ event: event.test.finished, workerIndex, data: { ...simplifiedData, err: serializableErr } })
+  })
+  event.dispatcher.on(event.test.failed, (test, err) => {
+    const simplifiedData = test.simplify()
+    const serializableErr = serializeError(err)
+    safelySendToParent({ event: event.test.failed, workerIndex, data: { ...simplifiedData, err: serializableErr } })
+  })
+  event.dispatcher.on(event.test.passed, (test, err) => safelySendToParent({ event: event.test.passed, workerIndex, data: { ...test.simplify(), err } }))
+  event.dispatcher.on(event.test.started, test => safelySendToParent({ event: event.test.started, workerIndex, data: test.simplify() }))
+  event.dispatcher.on(event.test.skipped, test => safelySendToParent({ event: event.test.skipped, workerIndex, data: test.simplify() }))
 
   // steps
-  event.dispatcher.on(event.step.finished, step => sendToParentThread({ event: event.step.finished, workerIndex, data: simplifyStep(step) }));
-  event.dispatcher.on(event.step.started, step => sendToParentThread({ event: event.step.started, workerIndex, data: simplifyStep(step) }));
-  event.dispatcher.on(event.step.passed, step => sendToParentThread({ event: event.step.passed, workerIndex, data: simplifyStep(step) }));
-  event.dispatcher.on(event.step.failed, step => sendToParentThread({ event: event.step.failed, workerIndex, data: simplifyStep(step) }));
-
-  event.dispatcher.on(event.hook.failed, (test, err) => sendToParentThread({ event: event.hook.failed, workerIndex, data: simplifyTest(test, err) }));
-  event.dispatcher.on(event.hook.passed, (test, err) => sendToParentThread({ event: event.hook.passed, workerIndex, data: simplifyTest(test, err) }));
-  event.dispatcher.on(event.all.failures, (data) => sendToParentThread({ event: event.all.failures, workerIndex, data }));
-
+  event.dispatcher.on(event.step.finished, step => safelySendToParent({ event: event.step.finished, workerIndex, data: step.simplify() }))
+  event.dispatcher.on(event.step.started, step => safelySendToParent({ event: event.step.started, workerIndex, data: step.simplify() }))
+  event.dispatcher.on(event.step.passed, step => safelySendToParent({ event: event.step.passed, workerIndex, data: step.simplify() }))
+  event.dispatcher.on(event.step.failed, step => safelySendToParent({ event: event.step.failed, workerIndex, data: step.simplify() }))
+
+  event.dispatcher.on(event.hook.failed, (hook, err) => {
+    const serializableErr = serializeError(err)
+    safelySendToParent({ event: event.hook.failed, workerIndex, data: { ...hook.simplify(), err: serializableErr } })
+  })
+  event.dispatcher.on(event.hook.passed, hook => safelySendToParent({ event: event.hook.passed, workerIndex, data: hook.simplify() }))
+  event.dispatcher.on(event.hook.finished, hook => safelySendToParent({ event: event.hook.finished, workerIndex, data: hook.simplify() }))
+
+  event.dispatcher.once(event.all.after, () => safelySendToParent({ event: event.all.after, workerIndex, data: container.result().simplify() }))
   // all
-  event.dispatcher.once(event.all.result, () => parentPort.close());
+  event.dispatcher.once(event.all.result, () => {
+    safelySendToParent({ event: event.all.result, workerIndex, data: container.result().simplify() })
+    parentPort?.close()
+  })
 }
 
 function disablePause() {
-  global.pause = () => {};
+  global.pause = () => {}
 }
 
-function collectStats() {
-  const stats = {
-    passes: 0,
-    failures: 0,
-    skipped: 0,
-    tests: 0,
-    pending: 0,
-  };
-  event.dispatcher.on(event.test.skipped, () => {
-    stats.skipped++;
-  });
-  event.dispatcher.on(event.test.passed, () => {
-    stats.passes++;
-  });
-  event.dispatcher.on(event.test.failed, (test) => {
-    if (test.ctx._runnable.title.includes('hook: AfterSuite')) {
-      stats.failedHooks += 1;
+function serializeError(err) {
+  if (!err) return null
+  try {
+    return {
+      message: err.message,
+      stack: err.stack,
+      name: err.name,
+      actual: err.actual,
+      expected: err.expected,
     }
-    stats.failures++;
-  });
-  event.dispatcher.on(event.test.skipped, () => {
-    stats.pending++;
-  });
-  event.dispatcher.on(event.test.finished, () => {
-    stats.tests++;
-  });
-  event.dispatcher.once(event.all.after, () => {
-    sendToParentThread({ event: event.all.after, data: stats });
-  });
+  } catch {
+    return { message: 'Error could not be serialized', name: 'Error' }
+  }
+}
+
+function safelySendToParent(data) {
+  try {
+    parentPort?.postMessage(data)
+  } catch (cloneError) {
+    // Fallback for non-serializable data
+    const fallbackData = { ...data }
+
+    // Try to serialize error objects if present
+    if (fallbackData.data && fallbackData.data.err) {
+      fallbackData.data.err = serializeError(fallbackData.data.err)
+    }
+
+    // If still fails, send minimal data
+    try {
+      parentPort?.postMessage(fallbackData)
+    } catch (finalError) {
+      parentPort?.postMessage({
+        event: data.event,
+        workerIndex,
+        data: {
+          title: fallbackData.data?.title || 'Unknown',
+          state: fallbackData.data?.state || 'error',
+          err: { message: 'Data could not be serialized' },
+        },
+      })
+    }
+  }
 }
 
 function sendToParentThread(data) {
-  parentPort.postMessage(data);
+  parentPort?.postMessage(data)
 }
 
 function listenToParentThread() {
-  parentPort.on('message', (eventData) => {
-    container.append({ support: eventData.data });
-  });
+  parentPort?.on('message', eventData => {
+    container.append({ support: eventData.data })
+  })
 }

package/lib/config.js

@@ -1,11 +1,7 @@
-const fs = require('fs');
-const path = require('path');
-const {
-  fileExists,
-  isFile,
-  deepMerge,
-  deepClone,
-} = require('./utils');
+import fs from 'fs'
+import path from 'path'
+import { createRequire } from 'module'
+import { fileExists, isFile, deepMerge, deepClone } from './utils.js'
 
 const defaultConfig = {
   output: './_output',
@@ -33,18 +29,12 @@ const defaultConfig = {
       timeout: 0,
     },
   ],
-};
+}
 
-let hooks = [];
-let config = {};
+let hooks = []
+let config = {}
 
-const configFileNames = [
-  'codecept.config.js',
-  'codecept.conf.js',
-  'codecept.js',
-  'codecept.config.ts',
-  'codecept.conf.ts',
-];
+const configFileNames = ['codecept.config.js', 'codecept.conf.js', 'codecept.js', 'codecept.config.ts', 'codecept.conf.ts']
 
 /**
  * Current configuration
@@ -57,9 +47,9 @@ class Config {
    * @return {Object<string, *>}
    */
   static create(newConfig) {
-    config = deepMerge(deepClone(defaultConfig), newConfig);
-    hooks.forEach(f => f(config));
-    return config;
+    config = deepMerge(deepClone(defaultConfig), newConfig)
+    hooks.forEach(f => f(config))
+    return config
   }
 
   /**
@@ -75,34 +65,34 @@ class Config {
    * @param {string} configFile
    * @return {*}
    */
-  static load(configFile) {
-    configFile = path.resolve(configFile || '.');
+  static async load(configFile) {
+    configFile = path.resolve(configFile || '.')
 
     if (!fileExists(configFile)) {
-      configFile = configFile.replace('.js', '.ts');
+      configFile = configFile.replace('.js', '.ts')
 
       if (!fileExists(configFile)) {
-        throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`);
+        throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`)
       }
     }
 
     // is config file
     if (isFile(configFile)) {
-      return loadConfigFile(configFile);
+      return await loadConfigFile(configFile)
     }
 
     for (const name of configFileNames) {
       // is path to directory
-      const jsConfig = path.join(configFile, name);
+      const jsConfig = path.join(configFile, name)
 
       if (isFile(jsConfig)) {
-        return loadConfigFile(jsConfig);
+        return await loadConfigFile(jsConfig)
       }
     }
 
-    const configPaths = configFileNames.map(name => path.join(configFile, name)).join(' or ');
+    const configPaths = configFileNames.map(name => path.join(configFile, name)).join(' or ')
 
-    throw new Error(`Can not load config from ${configPaths}\nCodeceptJS is not initialized in this dir. Execute 'codeceptjs init' to start`);
+    throw new Error(`Can not load config from ${configPaths}\nCodeceptJS is not initialized in this dir. Execute 'codeceptjs init' to start`)
   }
 
   /**
@@ -113,13 +103,13 @@ class Config {
    */
   static get(key, val) {
     if (key) {
-      return config[key] || val;
+      return config[key] || val
     }
-    return config;
+    return config
   }
 
   static addHook(fn) {
-    hooks.push(fn);
+    hooks.push(fn)
   }
 
   /**
@@ -129,7 +119,7 @@ class Config {
    * @return {Object<string, *>}
    */
   static append(additionalConfig) {
-    return config = deepMerge(config, additionalConfig);
+    return (config = deepMerge(config, additionalConfig))
   }
 
   /**
@@ -137,33 +127,105 @@ class Config {
    * @return {Object<string, *>}
    */
   static reset() {
-    hooks = [];
-    return config = { ...defaultConfig };
+    hooks = []
+    return (config = { ...defaultConfig })
   }
 }
 
-module.exports = Config;
+export default Config
 
-function loadConfigFile(configFile) {
-  const extensionName = path.extname(configFile);
+async function loadConfigFile(configFile) {
+  const require = createRequire(import.meta.url)
+  const extensionName = path.extname(configFile)
 
-  if (extensionName === '.ts') {
+  // .conf.js config file
+  if (extensionName === '.js' || extensionName === '.ts' || extensionName === '.cjs') {
+    let configModule
     try {
-      require('ts-node/register');
-    } catch (err) {
-      console.log('ts-node package is required to parse codecept.conf.ts config correctly');
+      // For .ts files, try to compile and load as JavaScript
+      if (extensionName === '.ts') {
+        try {
+          // Try to load ts-node and compile the file
+          const { transpile } = require('typescript')
+          const tsContent = fs.readFileSync(configFile, 'utf8')
+
+          // Transpile TypeScript to JavaScript with ES module output
+          const jsContent = transpile(tsContent, {
+            module: 99, // ModuleKind.ESNext
+            target: 99, // ScriptTarget.ESNext
+            esModuleInterop: true,
+            allowSyntheticDefaultImports: true,
+          })
+
+          // Create a temporary JS file with .mjs extension to force ES module treatment
+          const tempJsFile = configFile.replace('.ts', '.temp.mjs')
+          fs.writeFileSync(tempJsFile, jsContent)
+
+          try {
+            configModule = await import(tempJsFile)
+            // Clean up temp file
+            fs.unlinkSync(tempJsFile)
+          } catch (err) {
+            // Clean up temp file even on error
+            if (fs.existsSync(tempJsFile)) {
+              fs.unlinkSync(tempJsFile)
+            }
+            throw err
+          }
+        } catch (tsError) {
+          // If TypeScript compilation fails, fallback to ts-node
+          try {
+            require('ts-node/register')
+            configModule = require(configFile)
+          } catch (tsNodeError) {
+            throw new Error(`Failed to load TypeScript config: ${tsError.message}`)
+          }
+        }
+      } else {
+        // Try ESM import first for JS files
+        configModule = await import(configFile)
+      }
+    } catch (importError) {
+      try {
+        // Fall back to CommonJS require for .js/.cjs files
+        if (extensionName !== '.ts') {
+          configModule = require(configFile)
+        } else {
+          throw importError
+        }
+      } catch (requireError) {
+        throw new Error(`Failed to load config file ${configFile}: ${importError.message}`)
+      }
     }
-  }
 
-  // .conf.js config file
-  if (extensionName === '.js' || extensionName === '.ts' || extensionName === '.cjs') {
-    return Config.create(require(configFile).config);
+    const rawConfig = configModule.config || configModule.default?.config || configModule
+
+    // Process helpers to extract imported classes
+    if (rawConfig.helpers) {
+      const processedHelpers = {}
+      for (const [helperName, helperConfig] of Object.entries(rawConfig.helpers)) {
+        // Check if the helper name itself is a class (ESM import)
+        if (typeof helperName === 'function' && helperName.prototype) {
+          // This is an imported class, use its constructor name
+          const className = helperName.name
+          processedHelpers[className] = {
+            ...helperConfig,
+            _helperClass: helperName,
+          }
+        } else {
+          processedHelpers[helperName] = helperConfig
+        }
+      }
+      rawConfig.helpers = processedHelpers
+    }
+
+    return Config.create(rawConfig)
   }
 
   // json config provided
   if (extensionName === '.json') {
-    return Config.create(JSON.parse(fs.readFileSync(configFile, 'utf8')));
+    return Config.create(JSON.parse(fs.readFileSync(configFile, 'utf8')))
   }
 
-  throw new Error(`Config file ${configFile} can't be loaded`);
+  throw new Error(`Config file ${configFile} can't be loaded`)
 }