mocha 10.2.0 → 10.4.0

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://cldup.com/xFVFxOioAU.svg" alt="Mocha test framework"/>
+  <img src="https://cldup.com/xFVFxOioAU.svg" alt="Mocha test framework logo"/>
 </p>
 
 <p align="center">☕️ Simple, flexible, fun JavaScript test framework for Node.js & The Browser ☕️</p>
@@ -8,9 +8,9 @@
 <a href="https://github.com/mochajs/mocha/actions?query=workflow%3ATests+branch%3Amaster"><img src="https://github.com/mochajs/mocha/workflows/Tests/badge.svg?branch=master" alt="GitHub Actions Build Status"></a>
 <a href="https://coveralls.io/github/mochajs/mocha"><img src="https://coveralls.io/repos/github/mochajs/mocha/badge.svg" alt="Coverage Status"></a>
 <a href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmochajs%2Fmocha?ref=badge_shield"><img src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmochajs%2Fmocha.svg?type=shield" alt="FOSSA Status"></a>
-<a href="https://gitter.im/mochajs/mocha?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a>
-<a href="https://github.com/mochajs/mocha#sponsors"><img src="https://opencollective.com/mochajs/tiers/sponsors/badge.svg" alt="OpenCollective"></a>
-<a href="https://github.com/mochajs/mocha#backers"><img src="https://opencollective.com/mochajs/tiers/backers/badge.svg" alt="OpenCollective"></a>
+<a href="https://discord.gg/KeDn2uXhER"><img alt="Chat - Discord" src="https://img.shields.io/badge/chat-Discord-5765F2.svg" /></a>
+<a href="https://github.com/mochajs/mocha#sponsors"><img src="https://opencollective.com/mochajs/tiers/sponsors/badge.svg" alt="OpenCollective Sponsors"></a>
+<a href="https://github.com/mochajs/mocha#backers"><img src="https://opencollective.com/mochajs/tiers/backers/badge.svg" alt="OpenCollective Backers"></a>
 </p>
 
 <p align="center">
@@ -22,11 +22,12 @@
 
 ## Links
 
-- **[Documentation](https://mochajs.org/)**
+- **[Documentation](https://mochajs.org)**
 - **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)**
 - [Code of Conduct](https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md)
 - [Contributing](https://github.com/mochajs/mocha/blob/master/.github/CONTRIBUTING.md)
-- [Gitter Chatroom](https://gitter.im/mochajs/mocha) (ask questions here!)
+- [Development](https://github.com/mochajs/mocha/blob/master/.github/DEVELOPMENT.md)
+- [Discord](https://discord.gg/KeDn2uXhER) (ask questions here!)
 - [Issue Tracker](https://github.com/mochajs/mocha/issues)
 
 ## Backers
@@ -37,7 +38,10 @@
 
 ## Sponsors
 
-Does your company use Mocha? Ask your manager or marketing team if your company would be interested in supporting our project. Support will allow the maintainers to dedicate more time for maintenance and new features for everyone. Also, your company's logo will show [on GitHub](https://github.com/mochajs/mocha#readme) and on [our site](https://mochajs.org#sponsors) - who doesn't want a little extra exposure? [Here's the info](https://opencollective.com/mochajs).
+Does your company use Mocha? Ask your manager or marketing team if your company would be interested in supporting our project.
+Support will allow the maintainers to dedicate more time for maintenance and new features for everyone.
+Also, your company's logo will show [on GitHub](https://github.com/mochajs/mocha#readme) and on [our site](https://mochajs.org#sponsors) - who doesn't want a little extra exposure?
+[Here's the info](https://opencollective.com/mochajs).
 
 [![MochaJS Sponsor](https://opencollective.com/mochajs/tiers/sponsors/0/avatar)](https://opencollective.com/mochajs/tiers/sponsors/0/website)
 [![MochaJS Sponsor](https://opencollective.com/mochajs/tiers/sponsors/1/avatar)](https://opencollective.com/mochajs/tiers/sponsors/1/website)
@@ -53,11 +57,11 @@ You might want to know that:
 
 You might want to help:
 
-- New to contributing to Mocha? Check out this list of [good first issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)
-- Mocha could use a hand with [these issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+- New to contributing to Mocha? Check out this list of [good first issues](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+- Mocha could use a hand with [these issues](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
 - The [maintainer's handbook](https://github.com/mochajs/mocha/blob/master/MAINTAINERS.md) explains how things get done
 
-Finally, come [chat with the maintainers](https://gitter.im/mochajs/contributors) on Gitter if you want to help with:
+Finally, come [chat with the maintainers on Discord](https://discord.gg/KeDn2uXhER) if you want to help with:
 
 - Triaging issues, answering questions
 - Review, merging, and closing pull requests

package/lib/cli/cli.js

@@ -23,7 +23,7 @@ const {
 const lookupFiles = require('./lookup-files');
 const commands = require('./commands');
 const ansi = require('ansi-colors');
-const {repository, homepage, version, gitter} = require('../../package.json');
+const {repository, homepage, version, discord} = require('../../package.json');
 const {cwd} = require('../utils');
 
 /**
@@ -68,7 +68,7 @@ exports.main = (argv = process.argv.slice(2), mochaArgs) => {
     .wrap(process.stdout.columns ? Math.min(process.stdout.columns, 80) : 80)
     .epilog(
       `Mocha Resources
-    Chat: ${ansi.magenta(gitter)}
+    Chat: ${ansi.magenta(discord)}
   GitHub: ${ansi.blue(repository.url)}
     Docs: ${ansi.yellow(homepage)}
       `

package/lib/cli/collect-files.js

@@ -35,7 +35,10 @@ module.exports = ({
     try {
       const moreSpecFiles = castArray(lookupFiles(arg, extension, recursive))
         .filter(filename =>
-          ignore.every(pattern => !minimatch(filename, pattern))
+          ignore.every(
+            pattern =>
+              !minimatch(filename, pattern, {windowsPathsNoEscape: true})
+          )
         )
         .map(filename => path.resolve(filename));
       return [...specFiles, ...moreSpecFiles];

package/lib/cli/lookup-files.js

@@ -75,7 +75,7 @@ module.exports = function lookupFiles(
 
   if (!fs.existsSync(filepath)) {
     let pattern;
-    if (glob.hasMagic(filepath)) {
+    if (glob.hasMagic(filepath, {windowsPathsNoEscape: true})) {
       // Handle glob as is without extensions
       pattern = filepath;
     } else {
@@ -86,7 +86,12 @@ module.exports = function lookupFiles(
       pattern = `${filepath}+(${strExtensions})`;
       debug('looking for files using glob pattern: %s', pattern);
     }
-    files.push(...glob.sync(pattern, {nodir: true}));
+    files.push(
+      ...glob.sync(pattern, {
+        nodir: true,
+        windowsPathsNoEscape: true
+      })
+    );
     if (!files.length) {
       throw createNoFilesMatchPatternError(
         `Cannot find any files matching pattern "${filepath}"`,

package/lib/cli/run.js

@@ -369,7 +369,7 @@ exports.handler = async function (argv) {
   try {
     await runMocha(mocha, argv);
   } catch (err) {
-    console.error('\n' + (err.stack || `Error: ${err.message || err}`));
+    console.error('\n Exception during run:', err);
     process.exit(1);
   }
 };

package/lib/reporters/base.js

@@ -221,6 +221,56 @@ var generateDiff = (exports.generateDiff = function (actual, expected) {
   }
 });
 
+/**
+ * Traverses err.cause and returns all stack traces
+ *
+ * @private
+ * @param {Error} err
+ * @param {Set<Error>} [seen]
+ * @return {FullErrorStack}
+ */
+var getFullErrorStack = function (err, seen) {
+  if (seen && seen.has(err)) {
+    return { message: '', msg: '<circular>', stack: '' };
+  }
+
+  var message;
+
+  if (typeof err.inspect === 'function') {
+    message = err.inspect() + '';
+  } else if (err.message && typeof err.message.toString === 'function') {
+    message = err.message + '';
+  } else {
+    message = '';
+  }
+
+  var msg;
+  var stack = err.stack || message;
+  var index = message ? stack.indexOf(message) : -1;
+
+  if (index === -1) {
+    msg = message;
+  } else {
+    index += message.length;
+    msg = stack.slice(0, index);
+    // remove msg from stack
+    stack = stack.slice(index + 1);
+
+    if (err.cause) {
+      seen = seen || new Set();
+      seen.add(err);
+      const causeStack = getFullErrorStack(err.cause, seen)
+      stack += '\n   Caused by: ' + causeStack.msg + (causeStack.stack ? '\n' + causeStack.stack : '');
+    }
+  }
+
+  return {
+    message,
+    msg,
+    stack
+  };
+};
+
 /**
  * Outputs the given `failures` as a list.
  *
@@ -241,7 +291,6 @@ exports.list = function (failures) {
       color('error stack', '\n%s\n');
 
     // msg
-    var msg;
     var err;
     if (test.err && test.err.multiple) {
       if (multipleTest !== test) {
@@ -252,25 +301,8 @@ exports.list = function (failures) {
     } else {
       err = test.err;
     }
-    var message;
-    if (typeof err.inspect === 'function') {
-      message = err.inspect() + '';
-    } else if (err.message && typeof err.message.toString === 'function') {
-      message = err.message + '';
-    } else {
-      message = '';
-    }
-    var stack = err.stack || message;
-    var index = message ? stack.indexOf(message) : -1;
 
-    if (index === -1) {
-      msg = message;
-    } else {
-      index += message.length;
-      msg = stack.slice(0, index);
-      // remove msg from stack
-      stack = stack.slice(index + 1);
-    }
+    var { message, msg, stack } = getFullErrorStack(err);
 
     // uncaught
     if (err.uncaught) {
@@ -548,3 +580,12 @@ function sameType(a, b) {
 Base.consoleLog = consoleLog;
 
 Base.abstract = true;
+
+/**
+ * An object with all stack traces recursively mounted from each err.cause
+ * @memberof module:lib/reporters/base
+ * @typedef {Object} FullErrorStack
+ * @property {string} message
+ * @property {string} msg
+ * @property {string} stack
+ */

package/lib/reporters/nyan.js

@@ -66,7 +66,7 @@ function NyanCat(runner, options) {
   runner.once(EVENT_RUN_END, function () {
     Base.cursor.show();
     for (var i = 0; i < self.numberOfLines; i++) {
-      write('\n');
+      process.stdout.write('\n');
     }
     self.epilogue();
   });
@@ -102,15 +102,15 @@ NyanCat.prototype.drawScoreboard = function () {
   var stats = this.stats;
 
   function draw(type, n) {
-    write(' ');
-    write(Base.color(type, n));
-    write('\n');
+    process.stdout.write(' ');
+    process.stdout.write(Base.color(type, n));
+    process.stdout.write('\n');
   }
 
   draw('green', stats.passes);
   draw('fail', stats.failures);
   draw('pending', stats.pending);
-  write('\n');
+  process.stdout.write('\n');
 
   this.cursorUp(this.numberOfLines);
 };
@@ -144,9 +144,9 @@ NyanCat.prototype.drawRainbow = function () {
   var self = this;
 
   this.trajectories.forEach(function (line) {
-    write('\u001b[' + self.scoreboardWidth + 'C');
-    write(line.join(''));
-    write('\n');
+    process.stdout.write('\u001b[' + self.scoreboardWidth + 'C');
+    process.stdout.write(line.join(''));
+    process.stdout.write('\n');
   });
 
   this.cursorUp(this.numberOfLines);
@@ -163,25 +163,25 @@ NyanCat.prototype.drawNyanCat = function () {
   var dist = '\u001b[' + startWidth + 'C';
   var padding = '';
 
-  write(dist);
-  write('_,------,');
-  write('\n');
+  process.stdout.write(dist);
+  process.stdout.write('_,------,');
+  process.stdout.write('\n');
 
-  write(dist);
+  process.stdout.write(dist);
   padding = self.tick ? '  ' : '   ';
-  write('_|' + padding + '/\\_/\\ ');
-  write('\n');
+  process.stdout.write('_|' + padding + '/\\_/\\ ');
+  process.stdout.write('\n');
 
-  write(dist);
+  process.stdout.write(dist);
   padding = self.tick ? '_' : '__';
   var tail = self.tick ? '~' : '^';
-  write(tail + '|' + padding + this.face() + ' ');
-  write('\n');
+  process.stdout.write(tail + '|' + padding + this.face() + ' ');
+  process.stdout.write('\n');
 
-  write(dist);
+  process.stdout.write(dist);
   padding = self.tick ? ' ' : '  ';
-  write(padding + '""  "" ');
-  write('\n');
+  process.stdout.write(padding + '""  "" ');
+  process.stdout.write('\n');
 
   this.cursorUp(this.numberOfLines);
 };
@@ -213,7 +213,7 @@ NyanCat.prototype.face = function () {
  */
 
 NyanCat.prototype.cursorUp = function (n) {
-  write('\u001b[' + n + 'A');
+  process.stdout.write('\u001b[' + n + 'A');
 };
 
 /**
@@ -224,7 +224,7 @@ NyanCat.prototype.cursorUp = function (n) {
  */
 
 NyanCat.prototype.cursorDown = function (n) {
-  write('\u001b[' + n + 'B');
+  process.stdout.write('\u001b[' + n + 'B');
 };
 
 /**
@@ -264,13 +264,4 @@ NyanCat.prototype.rainbowify = function (str) {
   return '\u001b[38;5;' + color + 'm' + str + '\u001b[0m';
 };
 
-/**
- * Stdout helper.
- *
- * @param {string} string A message to write to stdout.
- */
-function write(string) {
-  process.stdout.write(string);
-}
-
 NyanCat.description = '"nyan cat"';

package/lib/reporters/xunit.js

@@ -158,6 +158,7 @@ XUnit.prototype.test = function (test) {
   var attrs = {
     classname: test.parent.fullTitle(),
     name: test.title,
+    file: test.file,
     time: test.duration / 1000 || 0
   };
 

package/lib/runnable.js

@@ -211,7 +211,7 @@ Runnable.prototype.fullTitle = function () {
  *
  * @memberof Mocha.Runnable
  * @public
- * @return {string}
+ * @return {string[]}
  */
 Runnable.prototype.titlePath = function () {
   return this.parent.titlePath().concat([this.title]);

package/lib/runner.js

@@ -443,11 +443,22 @@ Runner.prototype.fail = function (test, err, force) {
     err = thrown2Error(err);
   }
 
-  try {
-    err.stack =
-      this.fullStackTrace || !err.stack ? err.stack : stackFilter(err.stack);
-  } catch (ignore) {
-    // some environments do not take kindly to monkeying with the stack
+  // Filter the stack traces
+  if (!this.fullStackTrace) {
+    const alreadyFiltered = new Set();
+    let currentErr = err;
+
+    while (currentErr && currentErr.stack && !alreadyFiltered.has(currentErr)) {
+      alreadyFiltered.add(currentErr);
+
+      try {
+        currentErr.stack = stackFilter(currentErr.stack);
+      } catch (ignore) {
+        // some environments do not take kindly to monkeying with the stack
+      }
+
+      currentErr = currentErr.cause;
+    }
   }
 
   this.emit(constants.EVENT_TEST_FAIL, test, err);

package/lib/suite.js

@@ -387,7 +387,7 @@ Suite.prototype.fullTitle = function () {
  *
  * @memberof Suite
  * @public
- * @return {string}
+ * @return {string[]}
  */
 Suite.prototype.titlePath = function () {
   var result = [];

package/lib/utils.js

@@ -8,8 +8,6 @@
 /**
  * Module dependencies.
  */
-
-const {nanoid} = require('nanoid/non-secure');
 var path = require('path');
 var util = require('util');
 var he = require('he');
@@ -615,11 +613,22 @@ exports.constants = exports.defineConstants({
   MOCHA_ID_PROP_NAME
 });
 
+const uniqueIDBase =
+  'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_';
+
 /**
  * Creates a new unique identifier
+ * Does not create cryptographically safe ids.
+ * Trivial copy of nanoid/non-secure
  * @returns {string} Unique identifier
  */
-exports.uniqueID = () => nanoid();
+exports.uniqueID = () => {
+  let id = '';
+  for (let i = 0; i < 21; i++) {
+    id += uniqueIDBase[(Math.random() * 64) | 0];
+  }
+  return id;
+};
 
 exports.assignNewMochaID = obj => {
   const id = exports.uniqueID();