codeceptjs 3.6.10 → 3.7.0-beta.1

package/lib/pause.js

@@ -1,59 +1,70 @@
-const colors = require('chalk');
-const readline = require('readline');
-const ora = require('ora-classic');
-const debug = require('debug')('codeceptjs:pause');
-
-const container = require('./container');
-const history = require('./history');
-const store = require('./store');
-const aiAssistant = require('./ai');
-const recorder = require('./recorder');
-const event = require('./event');
-const output = require('./output');
-const { methodsOfObject } = require('./utils');
+const colors = require('chalk')
+const readline = require('readline')
+const ora = require('ora-classic')
+const debug = require('debug')('codeceptjs:pause')
+const Fuse = require('fuse.js')
+
+const container = require('./container')
+const history = require('./history')
+const store = require('./store')
+const aiAssistant = require('./ai')
+const recorder = require('./recorder')
+const event = require('./event')
+const output = require('./output')
+const { methodsOfObject } = require('./utils')
 
 // npm install colors
-let rl;
-let nextStep;
-let finish;
-let next;
-let registeredVariables = {};
+let rl
+let nextStep
+let finish
+let next
+let registeredVariables = {}
 /**
  * Pauses test execution and starts interactive shell
  * @param {Object<string, *>} [passedObject]
  */
 const pause = function (passedObject = {}) {
-  if (store.dryRun) return;
+  if (store.dryRun) return
 
-  next = false;
+  next = false
   // add listener to all next steps to provide next() functionality
   event.dispatcher.on(event.step.after, () => {
     recorder.add('Start next pause session', () => {
-      if (!next) return;
-      return pauseSession();
-    });
-  });
-  recorder.add('Start new session', () => pauseSession(passedObject));
-};
+      // test already finished, nothing to pause
+      if (!store.currentTest) return
+      if (!next) return
+      return pauseSession()
+    })
+  })
+
+  event.dispatcher.on(event.test.finished, () => {
+    finish()
+    recorder.session.restore('pause')
+    rl.close()
+    history.save()
+  })
+
+  recorder.add('Start new session', () => pauseSession(passedObject))
+}
 
 function pauseSession(passedObject = {}) {
-  registeredVariables = passedObject;
-  recorder.session.start('pause');
+  registeredVariables = passedObject
+  recorder.session.start('pause')
   if (!next) {
-    let vars = Object.keys(registeredVariables).join(', ');
-    if (vars) vars = `(vars: ${vars})`;
+    let vars = Object.keys(registeredVariables).join(', ')
+    if (vars) vars = `(vars: ${vars})`
 
-    output.print(colors.yellow(' Interactive shell started'));
-    output.print(colors.yellow(' Use JavaScript syntax to try steps in action'));
-    output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`));
-    output.print(colors.yellow(` - Press ${colors.bold('TAB')} twice to see all available commands`));
-    output.print(colors.yellow(` - Type ${colors.bold('exit')} + Enter to exit the interactive shell`));
-    output.print(colors.yellow(` - Prefix ${colors.bold('=>')} to run js commands ${colors.bold(vars)}`));
+    output.print(colors.yellow(' Interactive shell started'))
+    output.print(colors.yellow(' Use JavaScript syntax to try steps in action'))
+    output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`))
+    output.print(colors.yellow(` - Press ${colors.bold('TAB')} twice to see all available commands`))
+    output.print(colors.yellow(` - Type ${colors.bold('exit')} + Enter to exit the interactive shell`))
+    output.print(colors.yellow(` - Prefix ${colors.bold('=>')} to run js commands ${colors.bold(vars)}`))
 
     if (aiAssistant.isEnabled) {
-      output.print(colors.blue(` ${colors.bold('AI is enabled! (experimental)')} Write what you want and make AI run it`));
-      output.print(colors.blue(' Please note, only HTML fragments with interactive elements are sent to AI provider'));
-      output.print(colors.blue(' Ideas: ask it to fill forms for you or to click'));
+      output.print(colors.blue(` ${colors.bold('AI is enabled! (experimental)')} Write what you want and make AI run it`))
+      output.print(colors.blue(' Please note, only HTML fragments with interactive elements are sent to AI provider'))
+      output.print(colors.blue(' Ideas: ask it to fill forms for you or to click'))
     }
   }
 
@@ -64,154 +75,167 @@ function pauseSession(passedObject = {}) {
     completer,
     history: history.load(),
     historySize: 50, // Adjust the history size as needed
-  });
+  })
 
-  rl.on('line', parseInput);
+  store.onPause = true
+  rl.on('line', parseInput)
   rl.on('close', () => {
-    if (!next) console.log('Exiting interactive shell....');
-  });
-  return new Promise(((resolve) => {
-    finish = resolve;
+    if (!next) console.log('Exiting interactive shell....')
+    store.onPause = false
+  })
+  return new Promise(resolve => {
+    finish = resolve
     // eslint-disable-next-line
-    return askForStep();
-  }));
+    return askForStep()
+  })
 }
 
 /* eslint-disable */
 async function parseInput(cmd) {
-  rl.pause();
-  next = false;
-  recorder.session.start('pause');
-  if (cmd === '') next = true;
+  rl.pause()
+  next = false
+  recorder.session.start('pause')
+  if (cmd === '') next = true
   if (!cmd || cmd === 'resume' || cmd === 'exit') {
-    finish();
-    recorder.session.restore();
-    rl.close();
-    history.save();
-    return nextStep();
+    finish()
+    recorder.session.restore('pause')
+    rl.close()
+    history.save()
+    return nextStep()
   }
   for (const k of Object.keys(registeredVariables)) {
-    eval(`var ${k} = registeredVariables['${k}'];`);  
+    eval(`var ${k} = registeredVariables['${k}'];`)
   }
 
-  let executeCommand = Promise.resolve();
+  let executeCommand = Promise.resolve()
 
   const getCmd = () => {
     debug('Command:', cmd)
-    return cmd;
-  };
+    return cmd
+  }
 
-  let isCustomCommand = false;
-  let lastError = null;
-  let isAiCommand = false;
-  let $res;
+  let isCustomCommand = false
+  let lastError = null
+  let isAiCommand = false
+  let $res
   try {
-     
-    const locate = global.locate; // enable locate in this context
-     
-    const I = container.support('I');
+    const locate = global.locate // enable locate in this context
+
+    const I = container.support('I')
     if (cmd.trim().startsWith('=>')) {
-      isCustomCommand = true;
-      cmd = cmd.trim().substring(2, cmd.length);
+      isCustomCommand = true
+      cmd = cmd.trim().substring(2, cmd.length)
     } else if (aiAssistant.isEnabled && cmd.trim() && !cmd.match(/^\w+\(/) && cmd.includes(' ')) {
-      const currentOutputLevel = output.level();
-      output.level(0);
-      const res = I.grabSource();
-      isAiCommand = true;
+      const currentOutputLevel = output.level()
+      output.level(0)
+      const res = I.grabSource()
+      isAiCommand = true
       executeCommand = executeCommand.then(async () => {
         try {
-          const html = await res;
-          await aiAssistant.setHtmlContext(html);
+          const html = await res
+          await aiAssistant.setHtmlContext(html)
         } catch (err) {
-          output.print(output.styles.error(' ERROR '), 'Can\'t get HTML context', err.stack);
-          return;
+          output.print(output.styles.error(' ERROR '), "Can't get HTML context", err.stack)
+          return
         } finally {
-          output.level(currentOutputLevel);
+          output.level(currentOutputLevel)
         }
 
-        const spinner = ora("Processing AI request...").start();
-        cmd = await aiAssistant.writeSteps(cmd);
-        spinner.stop();
-        output.print('');
-        output.print(colors.blue(aiAssistant.getResponse()));
-        output.print('');
-        return cmd;
+        const spinner = ora('Processing AI request...').start()
+        cmd = await aiAssistant.writeSteps(cmd)
+        spinner.stop()
+        output.print('')
+        output.print(colors.blue(aiAssistant.getResponse()))
+        output.print('')
+        return cmd
       })
     } else {
-      cmd = `I.${cmd}`;
+      cmd = `I.${cmd}`
     }
-    executeCommand = executeCommand.then(async () => {
-      const cmd = getCmd();
-      if (!cmd) return;
-      return eval(cmd);  
-    }).catch((err) => {
-      debug(err);
-      if (isAiCommand) return;
-      if (!lastError) output.print(output.styles.error(' ERROR '), err.message);
-      debug(err.stack)
-
-      lastError = err.message;
-    })
+    executeCommand = executeCommand
+      .then(async () => {
+        const cmd = getCmd()
+        if (!cmd) return
+        return eval(cmd)
+      })
+      .catch(err => {
+        debug(err)
+        if (isAiCommand) return
+        if (!lastError) output.print(output.styles.error(' ERROR '), err.message)
+        debug(err.stack)
 
-    const val = await executeCommand;
+        lastError = err.message
+      })
+
+    const val = await executeCommand
 
     if (isCustomCommand) {
-      if (val !== undefined) console.log('Result', '$res=', val);  
-      $res = val;
+      if (val !== undefined) console.log('Result', '$res=', val)
+      $res = val
     }
 
     if (cmd?.startsWith('I.see') || cmd?.startsWith('I.dontSee')) {
-      output.print(output.styles.success('  OK  '), cmd);
+      output.print(output.styles.success('  OK  '), cmd)
     }
     if (cmd?.startsWith('I.grab')) {
-      output.print(output.styles.debug(val));
+      output.print(output.styles.debug(val))
     }
 
-    history.push(cmd); // add command to history when successful
+    history.push(cmd) // add command to history when successful
   } catch (err) {
-    if (!lastError) output.print(output.styles.error(' ERROR '), err.message);
-    lastError = err.message;
+    if (!lastError) output.print(output.styles.error(' ERROR '), err.message)
+    lastError = err.message
   }
-  recorder.session.catch((err) => {
-    const msg = err.cliMessage ? err.cliMessage() : err.message;
+  recorder.session.catch(err => {
+    const msg = err.cliMessage ? err.cliMessage() : err.message
 
     // pop latest command from history because it failed
-    history.pop();
-
-    if (isAiCommand) return;
-    if (!lastError) output.print(output.styles.error(' FAIL '), msg);
-    lastError = err.message;
-  });
-  recorder.add('ask for next step', askForStep);
-  nextStep();
+    history.pop()
+
+    if (isAiCommand) return
+    if (!lastError) output.print(output.styles.error(' FAIL '), msg)
+    lastError = err.message
+  })
+  recorder.add('ask for next step', askForStep)
+  nextStep()
 }
 /* eslint-enable */
 
 function askForStep() {
-  return new Promise(((resolve) => {
-    nextStep = resolve;
-    rl.setPrompt(' I.', 3);
-    rl.resume();
-    rl.prompt([false]);
-  }));
+  return new Promise(resolve => {
+    nextStep = resolve
+    rl.setPrompt(' I.', 3)
+    rl.resume()
+    rl.prompt([false])
+  })
 }
 
 function completer(line) {
-  const I = container.support('I');
-  const completions = methodsOfObject(I);
-  const hits = completions.filter((c) => {
-    if (c.indexOf(line) === 0) {
-      return c;
-    }
-    return null;
-  });
-  return [hits && hits.length ? hits : completions, line];
+  const I = container.support('I')
+  const completions = methodsOfObject(I)
+  // If no input, return all completions
+  if (!line) {
+    return [completions, line]
+  }
+
+  // Initialize Fuse with completions
+  const fuse = new Fuse(completions, {
+    threshold: 0.3,
+    distance: 100,
+    minMatchCharLength: 1,
+  })
+
+  // Search using Fuse.js
+  const searchResults = fuse.search(line)
+  const hits = searchResults.map(result => result.item)
+
+  return [hits, line]
 }
 
 function registerVariable(name, value) {
-  registeredVariables[name] = value;
+  registeredVariables[name] = value
 }
 
-module.exports = pause;
+module.exports = pause
 
-module.exports.registerVariable = registerVariable;
+module.exports.registerVariable = registerVariable

package/lib/plugin/autoDelay.js

@@ -66,25 +66,25 @@ module.exports = function (config) {
 
   if (!helper) return // no helpers for auto-delay
 
-  event.dispatcher.on(event.step.before, (step) => {
+  event.dispatcher.on(event.step.before, step => {
     if (config.methods.indexOf(step.helperMethod) < 0) return // skip non-actions
 
     recorder.add('auto-delay', async () => {
       if (store.debugMode) return // no need to delay in debug
       log(`Delaying for ${config.delayBefore}ms`)
-      return new Promise((resolve) => {
+      return new Promise(resolve => {
         setTimeout(resolve, config.delayBefore)
       })
     })
   })
 
-  event.dispatcher.on(event.step.after, (step) => {
+  event.dispatcher.on(event.step.after, step => {
     if (config.methods.indexOf(step.helperMethod) < 0) return // skip non-actions
 
     recorder.add('auto-delay', async () => {
       if (store.debugMode) return // no need to delay in debug
       log(`Delaying for ${config.delayAfter}ms`)
-      return new Promise((resolve) => {
+      return new Promise(resolve => {
         setTimeout(resolve, config.delayAfter)
       })
     })

package/lib/plugin/autoLogin.js

@@ -8,7 +8,7 @@ const { debug } = require('../output')
 const isAsyncFunction = require('../utils').isAsyncFunction
 
 const defaultUser = {
-  fetch: (I) => I.grabCookie(),
+  fetch: I => I.grabCookie(),
   check: () => {},
   restore: (I, cookies) => {
     I.amOnPage('/') // open a page
@@ -253,7 +253,7 @@ const defaultConfig = {
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config)
   Object.keys(config.users).map(
-    (u) =>
+    u =>
       (config.users[u] = {
         ...defaultUser,
         ...config.users[u],
@@ -275,12 +275,11 @@ module.exports = function (config) {
     }
   }
 
-  const loginFunction = async (name) => {
+  const loginFunction = async name => {
     const userSession = config.users[name]
     const I = container.support('I')
     const cookies = store[`${name}_session`]
-    const shouldAwait =
-      isAsyncFunction(userSession.login) || isAsyncFunction(userSession.restore) || isAsyncFunction(userSession.check)
+    const shouldAwait = isAsyncFunction(userSession.login) || isAsyncFunction(userSession.restore) || isAsyncFunction(userSession.check)
 
     const loginAndSave = async () => {
       if (shouldAwait) {
@@ -311,7 +310,7 @@ module.exports = function (config) {
       userSession.restore(I, cookies)
       userSession.check(I, cookies)
     }
-    recorder.session.catch((err) => {
+    recorder.session.catch(err => {
       debug(`Failed auto login for ${name} due to ${err}`)
       debug('Logging in again')
       recorder.session.start('auto login')
@@ -320,7 +319,7 @@ module.exports = function (config) {
           recorder.add(() => recorder.session.restore('auto login'))
           recorder.catch(() => debug('continue'))
         })
-        .catch((err) => {
+        .catch(err => {
           recorder.session.restore('auto login')
           recorder.session.restore('check login')
           recorder.throw(err)

package/lib/plugin/commentStep.js

@@ -104,7 +104,7 @@ module.exports = function (config) {
     currentCommentStep = null
   })
 
-  event.dispatcher.on(event.step.started, (step) => {
+  event.dispatcher.on(event.step.started, step => {
     if (currentCommentStep) {
       const metaStep = getRootMetaStep(step)
 

package/lib/plugin/coverage.js

@@ -15,7 +15,7 @@ const supportedHelpers = ['Puppeteer', 'Playwright', 'WebDriver']
 
 const v8CoverageHelpers = {
   Playwright: {
-    startCoverage: async (page) => {
+    startCoverage: async page => {
       await Promise.all([
         page.coverage.startJSCoverage({
           resetOnNavigation: false,
@@ -26,16 +26,13 @@ const v8CoverageHelpers = {
       ])
     },
     takeCoverage: async (page, coverageReport) => {
-      const [jsCoverage, cssCoverage] = await Promise.all([
-        page.coverage.stopJSCoverage(),
-        page.coverage.stopCSSCoverage(),
-      ])
+      const [jsCoverage, cssCoverage] = await Promise.all([page.coverage.stopJSCoverage(), page.coverage.stopCSSCoverage()])
       const coverageList = [...jsCoverage, ...cssCoverage]
       await coverageReport.add(coverageList)
     },
   },
   Puppeteer: {
-    startCoverage: async (page) => {
+    startCoverage: async page => {
       await Promise.all([
         page.coverage.startJSCoverage({
           resetOnNavigation: false,
@@ -47,13 +44,10 @@ const v8CoverageHelpers = {
       ])
     },
     takeCoverage: async (page, coverageReport) => {
-      const [jsCoverage, cssCoverage] = await Promise.all([
-        page.coverage.stopJSCoverage(),
-        page.coverage.stopCSSCoverage(),
-      ])
+      const [jsCoverage, cssCoverage] = await Promise.all([page.coverage.stopJSCoverage(), page.coverage.stopCSSCoverage()])
       // to raw V8 script coverage
       const coverageList = [
-        ...jsCoverage.map((it) => {
+        ...jsCoverage.map(it => {
           return {
             source: it.text,
             ...it.rawScriptCoverage,
@@ -65,7 +59,7 @@ const v8CoverageHelpers = {
     },
   },
   WebDriver: {
-    startCoverage: async (page) => {
+    startCoverage: async page => {
       await Promise.all([
         page.coverage.startJSCoverage({
           resetOnNavigation: false,
@@ -77,13 +71,10 @@ const v8CoverageHelpers = {
       ])
     },
     takeCoverage: async (page, coverageReport) => {
-      const [jsCoverage, cssCoverage] = await Promise.all([
-        page.coverage.stopJSCoverage(),
-        page.coverage.stopCSSCoverage(),
-      ])
+      const [jsCoverage, cssCoverage] = await Promise.all([page.coverage.stopJSCoverage(), page.coverage.stopCSSCoverage()])
       // to raw V8 script coverage
       const coverageList = [
-        ...jsCoverage.map((it) => {
+        ...jsCoverage.map(it => {
           return {
             source: it.text,
             ...it.rawScriptCoverage,
@@ -131,7 +122,7 @@ module.exports = function (config) {
   let coverageRunning = false
 
   const v8Names = Object.keys(v8CoverageHelpers)
-  const helperName = Object.keys(helpers).find((it) => v8Names.includes(it))
+  const helperName = Object.keys(helpers).find(it => v8Names.includes(it))
   if (!helperName) {
     console.error(`Coverage is only supported in ${supportedHelpers.join(' or ')}`)
     // no helpers for screenshot
@@ -180,7 +171,7 @@ module.exports = function (config) {
   })
 
   // Save coverage data after every test run
-  event.dispatcher.on(event.test.after, (test) => {
+  event.dispatcher.on(event.test.after, test => {
     recorder.add(
       'take coverage',
       async () => {

package/lib/plugin/customLocator.js

@@ -111,7 +111,7 @@ const defaultConfig = {
  * I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up]
  * ```
  */
-module.exports = (config) => {
+module.exports = config => {
   config = { ...defaultConfig, ...config }
 
   Locator.addFilter((value, locatorObj) => {
@@ -125,7 +125,7 @@ module.exports = (config) => {
     if (config.strategy.toLowerCase() === 'xpath') {
       locatorObj.value = `.//*[${[]
         .concat(config.attribute)
-        .map((attr) => `@${attr}=${xpathLocator.literal(val)}`)
+        .map(attr => `@${attr}=${xpathLocator.literal(val)}`)
         .join(' or ')}]`
       locatorObj.type = 'xpath'
     }
@@ -133,7 +133,7 @@ module.exports = (config) => {
     if (config.strategy.toLowerCase() === 'css') {
       locatorObj.value = []
         .concat(config.attribute)
-        .map((attr) => `[${attr}=${val}]`)
+        .map(attr => `[${attr}=${val}]`)
         .join(',')
       locatorObj.type = 'css'
     }

package/lib/plugin/debugErrors.js

@@ -43,7 +43,7 @@ module.exports = function (config = {}) {
 
   if (!helper) return // no helpers for screenshot
 
-  event.dispatcher.on(event.test.failed, (test) => {
+  event.dispatcher.on(event.test.failed, test => {
     recorder.add('HTML snapshot failed test', async () => {
       try {
         const currentOutputLevel = output.level()
@@ -56,7 +56,7 @@ module.exports = function (config = {}) {
         const errors = scanForErrorMessages(html, config.errorClasses)
         if (errors.length) {
           output.debug('Detected errors in HTML code')
-          errors.forEach((error) => output.debug(error))
+          errors.forEach(error => output.debug(error))
           test.artifacts.errors = errors
         }
       } catch (err) {

package/lib/plugin/eachElement.js

@@ -72,7 +72,7 @@ function eachElement(purpose, locator, fn) {
   if (store.dryRun) return
   const helpers = Object.values(container.helpers())
 
-  const helper = helpers.filter((h) => !!h._locate)[0]
+  const helper = helpers.filter(h => !!h._locate)[0]
 
   if (!helper) {
     throw new Error('No helper enabled with _locate method with returns a list of elements.')

package/lib/plugin/fakerTransform.js

@@ -40,7 +40,7 @@ const transform = require('../transform')
  *
  */
 module.exports = function (config) {
-  transform.addTransformerBeforeAll('gherkin.examples', (value) => {
+  transform.addTransformerBeforeAll('gherkin.examples', value => {
     if (typeof value === 'string' && value.length > 0) {
       return faker.helpers.fake(value)
     }

package/lib/plugin/heal.js

@@ -31,10 +31,7 @@ const defaultConfig = {
 module.exports = function (config = {}) {
   if (store.debugMode && !process.env.DEBUG) {
     event.dispatcher.on(event.test.failed, () => {
-      output.plugin(
-        'heal',
-        'Healing is disabled in --debug mode, use DEBUG="codeceptjs:heal" to enable it in debug mode',
-      )
+      output.plugin('heal', 'Healing is disabled in --debug mode, use DEBUG="codeceptjs:heal" to enable it in debug mode')
     })
     return
   }
@@ -48,21 +45,21 @@ module.exports = function (config = {}) {
 
   config = Object.assign(defaultConfig, config)
 
-  event.dispatcher.on(event.test.before, (test) => {
+  event.dispatcher.on(event.test.before, test => {
     currentTest = test
     healedSteps = 0
     caughtError = null
   })
 
-  event.dispatcher.on(event.step.started, (step) => (currentStep = step))
+  event.dispatcher.on(event.step.started, step => (currentStep = step))
 
-  event.dispatcher.on(event.step.after, (step) => {
+  event.dispatcher.on(event.step.after, step => {
     if (isHealing) return
     if (healTries >= config.healLimit) return // out of limit
 
     if (!heal.hasCorrespondingRecipes(step)) return
 
-    recorder.catchWithoutStop(async (err) => {
+    recorder.catchWithoutStop(async err => {
       isHealing = true
       if (caughtError === err) throw err // avoid double handling
       caughtError = err
@@ -99,7 +96,7 @@ module.exports = function (config = {}) {
 
     print(`${colors.bold(heal.fixes.length)} ${heal.fixes.length === 1 ? 'step was' : 'steps were'} healed`)
 
-    const suggestions = heal.fixes.filter((fix) => fix.recipe && heal.recipes[fix.recipe].suggest)
+    const suggestions = heal.fixes.filter(fix => fix.recipe && heal.recipes[fix.recipe].suggest)
 
     if (!suggestions.length) return