codeceptjs 4.0.0-beta.4 → 4.0.0-beta.5

package/lib/output.js

@@ -1,5 +1,5 @@
-const colors = require('chalk');
-const figures = require('figures');
+const colors = require('chalk')
+const figures = require('figures')
 const { maskSensitiveData } = require('invisi-data')
 
 const styles = {
@@ -10,11 +10,12 @@ const styles = {
   debug: colors.cyan,
   log: colors.grey,
   bold: colors.bold,
-};
+  section: colors.white.dim.bold,
+}
 
-let outputLevel = 0;
-let outputProcess = '';
-let newline = true;
+let outputLevel = 0
+let outputProcess = ''
+let newline = true
 
 /**
  * @alias output
@@ -28,7 +29,7 @@ module.exports = {
   stepShift: 0,
 
   standWithUkraine() {
-    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`;
+    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`
   },
 
   /**
@@ -37,8 +38,8 @@ module.exports = {
    * @returns {number}
    */
   level(level) {
-    if (level !== undefined) outputLevel = level;
-    return outputLevel;
+    if (level !== undefined) outputLevel = level
+    return outputLevel
   },
 
   /**
@@ -48,9 +49,9 @@ module.exports = {
    * @returns {string}
    */
   process(process) {
-    if (process === null) return outputProcess = '';
-    if (process) outputProcess = String(process).length === 1 ? `[0${process}]` : `[${process}]`;
-    return outputProcess;
+    if (process === null) return (outputProcess = '')
+    if (process) outputProcess = String(process).length === 1 ? `[0${process}]` : `[${process}]`
+    return outputProcess
   },
 
   /**
@@ -60,7 +61,7 @@ module.exports = {
   debug(msg) {
     const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 2) {
-      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`));
+      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`))
     }
   },
 
@@ -71,7 +72,7 @@ module.exports = {
   log(msg) {
     const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 3) {
-      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)));
+      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
     }
   },
 
@@ -80,7 +81,7 @@ module.exports = {
    * @param {string} msg
    */
   error(msg) {
-    print(styles.error(msg));
+    print(styles.error(msg))
   },
 
   /**
@@ -88,7 +89,7 @@ module.exports = {
    * @param {string} msg
    */
   success(msg) {
-    print(styles.success(msg));
+    print(styles.success(msg))
   },
 
   /**
@@ -97,7 +98,7 @@ module.exports = {
    * @param {string} msg
    */
   plugin(pluginName, msg = '') {
-    this.debug(`<${pluginName}> ${msg}`);
+    this.debug(`<${pluginName}> ${msg}`)
   },
 
   /**
@@ -105,26 +106,26 @@ module.exports = {
    * @param {CodeceptJS.Step} step
    */
   step(step) {
-    if (outputLevel === 0) return;
-    if (!step) return;
+    if (outputLevel === 0) return
+    if (!step) return
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
       if (typeof step === 'object' && step.hasBDDAncestor()) {
-        return;
+        return
       }
     }
 
-    let stepLine = step.toString();
+    let stepLine = step.toCliStyled ? step.toCliStyled() : step.toString()
     if (step.metaStep && outputLevel >= 1) {
       // this.stepShift += 2;
-      stepLine = colors.green(truncate(stepLine, this.spaceShift));
+      stepLine = colors.dim(truncate(stepLine, this.spaceShift))
     }
     if (step.comment) {
-      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)));
+      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)))
     }
 
     const _stepLine = isMaskedData() ? maskSensitiveData(stepLine) : stepLine
-    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift));
+    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift))
   },
 
   /** @namespace */
@@ -132,10 +133,11 @@ module.exports = {
     /**
      * @param {Mocha.Suite} suite
      */
-    started: (suite) => {
-      if (!suite.title) return;
-      print(`${colors.bold(suite.title)} --`);
-      if (suite.comment) print(suite.comment);
+    started: suite => {
+      if (!suite.title) return
+      print(`${colors.bold(suite.title)} --`)
+      if (suite.file && outputLevel >= 1) print(colors.underline.grey(suite.file))
+      if (suite.comment) print(suite.comment)
     },
   },
 
@@ -145,25 +147,25 @@ module.exports = {
      * @param {Mocha.Test} test
      */
     started(test) {
-      print(`  ${colors.magenta.bold(test.title)}`);
+      print(`  ${colors.magenta.bold(test.title)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     passed(test) {
-      print(`  ${colors.green.bold(figures.tick)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`);
+      print(`  ${colors.green.bold(figures.tick)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     failed(test) {
-      print(`  ${colors.red.bold(figures.cross)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`);
+      print(`  ${colors.red.bold(figures.cross)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     skipped(test) {
-      print(`  ${colors.yellow.bold('S')} ${test.title}`);
+      print(`  ${colors.yellow.bold('S')} ${test.title}`)
     },
   },
 
@@ -173,21 +175,39 @@ module.exports = {
      * @param {Mocha.Test} test
      */
 
-    started(test) {},
+    started(test) {
+      if (outputLevel < 1) return
+      print(`  ${colors.dim.bold('Scenario()')}`)
+    },
 
     /**
      * @param {Mocha.Test} test
      */
     passed(test) {
-      print(`  ${colors.green.bold(`${figures.tick} OK`)} ${colors.grey(`in ${test.duration}ms`)}`);
-      print();
+      print(`  ${colors.green.bold(`${figures.tick} OK`)} ${colors.grey(`in ${test.duration}ms`)}`)
+      print()
     },
     /**
      * @param {Mocha.Test} test
      */
     failed(test) {
-      print(`  ${colors.red.bold(`${figures.cross} FAILED`)} ${colors.grey(`in ${test.duration}ms`)}`);
-      print();
+      print(`  ${colors.red.bold(`${figures.cross} FAILED`)} ${colors.grey(`in ${test.duration}ms`)}`)
+      print()
+    },
+  },
+
+  hook: {
+    started(hook) {
+      if (outputLevel < 1) return
+      print(`  ${colors.dim.bold(hook.toCode())}`)
+    },
+    passed(hook) {
+      if (outputLevel < 1) return
+      print()
+    },
+    failed(hook) {
+      if (outputLevel < 1) return
+      print(`  ${colors.red.bold(hook.toCode())}`)
     },
   },
 
@@ -199,9 +219,9 @@ module.exports = {
    */
   say(message, color = 'cyan') {
     if (colors[color] === undefined) {
-      color = 'cyan';
+      color = 'cyan'
     }
-    if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`);
+    if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`)
   },
 
   /**
@@ -211,52 +231,52 @@ module.exports = {
    * @param {number|string} duration
    */
   result(passed, failed, skipped, duration, failedHooks = 0) {
-    let style = colors.bgGreen;
-    let msg = ` ${passed || 0} passed`;
-    let status = style.bold('  OK ');
+    let style = colors.bgGreen
+    let msg = ` ${passed || 0} passed`
+    let status = style.bold('  OK ')
     if (failed) {
-      style = style.bgRed;
-      status = style.bold('  FAIL ');
-      msg += `, ${failed} failed`;
+      style = style.bgRed
+      status = style.bold('  FAIL ')
+      msg += `, ${failed} failed`
     }
 
     if (failedHooks > 0) {
-      style = style.bgRed;
-      status = style.bold('  FAIL ');
-      msg += `, ${failedHooks} failedHooks`;
+      style = style.bgRed
+      status = style.bold('  FAIL ')
+      msg += `, ${failedHooks} failedHooks`
     }
-    status += style.grey(' |');
+    status += style.grey(' |')
 
     if (skipped) {
-      if (!failed) style = style.bgYellow;
-      msg += `, ${skipped} skipped`;
+      if (!failed) style = style.bgYellow
+      msg += `, ${skipped} skipped`
     }
-    msg += '  ';
-    print(status + style(msg) + colors.grey(` // ${duration}`));
+    msg += '  '
+    print(status + style(msg) + colors.grey(` // ${duration}`))
   },
-};
+}
 
 function print(...msg) {
   if (outputProcess) {
-    msg.unshift(outputProcess);
+    msg.unshift(outputProcess)
   }
   if (!newline) {
-    console.log();
-    newline = true;
+    console.log()
+    newline = true
   }
 
-  console.log.apply(this, msg);
+  console.log.apply(this, msg)
 }
 
 function truncate(msg, gap = 0) {
   if (msg.indexOf('\n') > 0 || outputLevel >= 3) {
-    return msg; // don't cut multi line steps or on verbose log level
+    return msg // don't cut multi line steps or on verbose log level
   }
-  const width = (process.stdout.columns || 200) - gap - 4;
+  const width = (process.stdout.columns || 200) - gap - 4
   if (msg.length > width) {
-    msg = msg.substr(0, width - 1) + figures.ellipsis;
+    msg = msg.substr(0, width - 1) + figures.ellipsis
   }
-  return msg;
+  return msg
 }
 
 function isMaskedData() {

package/lib/pause.js

@@ -1,59 +1,69 @@
-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 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, searchWithFusejs } = 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 +74,166 @@ 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;
-    // eslint-disable-next-line
-    return askForStep();
-  }));
+    if (!next) console.log('Exiting interactive shell....')
+    store.onPause = false
+  })
+  return new Promise(resolve => {
+    finish = resolve
+    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)
+
+        lastError = err.message
+      })
 
-    const val = await executeCommand;
+    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));
+      try {
+        output.print(output.styles.debug(JSON.stringify(val, null, 2)))
+      } catch (err) {
+        output.print(output.styles.error(' ERROR '), 'Failed to stringify result:', err.message)
+        output.print(output.styles.error(' RAW VALUE '), String(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]
+  }
+
+  // Search using Fuse.js
+  const searchResults = searchWithFusejs(completions, line, {
+    threshold: 0.3,
+    distance: 100,
+    minMatchCharLength: 1,
+  })
+  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