mocha loses the right title when done called multiple times

[osher]

I just finished trouble-shooting a wierd "done called multiple times" message.... phewee.. here's a tricky one:

I had a before-all hook that looked as following:

{ "lib/rest" : 
  { beforeAll:
    function(done) {
        this.slow("1.1s");
        rest = require('../lib/rest')(sockets, eventsHandler, done);
        setTimeout(done, 1000)
    }
  , 

Where evidently, the done is called both from ../lib/rest and the setTimeout.
Anyway, the ../lib/rest was not calling the callback for a long time, and evidently, making it call the callback as it should - was actually what broke the build.

(I'm using mocha-ui-exports, that's why it looks like that)

However, mocha could not direct me to the right place - probably because the setTimeout handler that was fired after 1s - was called in the midst of some other suite that followed - and mocha was pointing me to the suite and the test that during it's run the timer was fired...

looking there obviously brought nothing, and pending the tests that were reported as failing just moved the failure to another test that was not pended - and that's where I started suspecting that mocha reports the wrong place, and expanded my search.

After fixing the issue (removing the setTimeout from the beforeAll hook) - the suite passes.

[danielstjules]

Unfortunately, no portable solution exists for this right now. :( In node, you'd have to use domains, which are being deprecated (though an alternate solution doesn't yet exist) That's what I used for https://github.com/danielstjules/mocha.parallel#error-handling

AFAIK, nothing similar exists in the browser. https://github.com/bevry/domain-browser is more of a sham than a shim, since it exposes a similar API but doesn't handle async errors.

Sorry for inconvenience, I hope it wasn't too difficult to debug. In those situations, I usually hope the stacktrace points me in the right direction.

[osher]

Well. Doesn't make sense to me:
done function, wither it's called once or more, is passed to a test function from a closure - one that remembers how many times is was called.
How about adding information about the function a done callback is passed to?

[danielstjules]

Sorry about that, that's what I get for closing issues when tired :) I must have been thinking about exceptions being thrown async, rather than the callback. Could you provide a small example? Wasn't able to reproduce so far with 2.3.0:

$ cat test.js
describe('suite', function() {
  it('test1', function(done) {
    done();
    setTimeout(done, 50);
  });

  it('test2', function(done) {
    setTimeout(done, 100);
  });
});

$ mocha test.js


  suite
    ✓ test1
    1) test1
    ✓ test2 (102ms)


  2 passing (108ms)
  1 failing

  1) suite test1:
     Error: done() called multiple times

$ cat test.js
describe('suite', function() {
  before(function(done) {
    setTimeout(done, 30);
    setTimeout(done, 60);
  });

  it('test', function(done) {
    setTimeout(done, 100);
  });
});

$ mocha test.js


  suite
    1) test


  0 passing (67ms)
  1 failing

  1) suite test:
     Uncaught Error: done() called multiple times

[danielstjules]

With your reporter:

$ cat test.js
module.exports = { Example: {
    beforeAll: function(done) {
      this.slow(110);
      setTimeout(done, 50);
      setTimeout(done, 100);
    },
    'test 1': function(done) {
      setTimeout(done, 200);
    }
  }
}

$ mocha --ui mocha-ui-exports test.js


  Example
    1) test 1


  0 passing (116ms)
  1 failing

  1) Example test 1:
     Uncaught Error: done() called multiple times
      at Array.forEach (native)
      at node.js:951:3

I think I get it now. When invoked multiple times from a hook, it attributes it to the next test, rather than the hook. It works correctly when invoked multiple times from a spec.