0.4.0 'gulp test' hangs because mongoose connections are staying open

[reblace]

The mongoose connection opened as part of the 'test' task in the gulp build is never closed. This causes gulp to hang at the completion of the tests.

[ilanbiala]

Does the referenced commit and changes made in gulpfile.js and config/lib/mongoose.js fix the issue?.

[reblace]

Your commit only references the gulpfile.

As a modification to your commit, I think you want to pass a callback into the disconnect method on the mongoose connection so you can call the gulp done method when the disconnect is complete. Eg:

mongoose.disconnect(function(err) {
done(err);
});

Then, you can have the config/lib/mongoose.js file do something like this:

module.exports.disconnect = function(cb) {
db.disconnect(function(err) {
cb(err);
});
};

But otherwise, yes this is the same thing I did to fix the issue.

[ilanbiala]

Fixed gulp tracking in the latest commit. Mongoose lib disconnect method was already there before.

[reblace]

You can't do this:

mongoose.connect(done);

because gulp interprets any parameter to the callback as an error. So, in this case, the build immedaitely fails on the openMongoose task when the mongoose.connect callback function passes the db as a parameter.

So, you need to do this instead on the openMongoose task:

mongoose.connect(function(db) {
done();
});

[ilanbiala]

The build passes.

[reblace]

[email protected] test /home/travis/build/meanjs/mean
grunt test

It isn't running the gulp build.

[ilanbiala]

Out of curiosity, what error does Gulp throw because of that?

[reblace]

Gulp fails because the task is reporting an error:

[22:53:28] 'openMongoose' errored after 247 ms
[22:53:28] Error: [object Object]
at formatError (/usr/local/lib/node_modules/gulp/bin/gulp.js:161:10)
at Gulp. (/usr/local/lib/node_modules/gulp/bin/gulp.js:187:15)
at Gulp.emit (events.js:129:20)

The '[object Object]' being referenced in the error is the db object returned by the mongoose connect function. Gulp's docs specify that calling the callback function with any parameter is interpreted as an error.

gulp.task('one', function(cb) {
// do stuff -- async or otherwise
cb(err); // if err is not null and not undefined, the run will stop, and note that it failed
});

Since you are effectively telling gulp that task has failed, it doesn't even both to run the tests. Since the Mongoose db connection is still open at that point, it still hangs.

You can check out the branch and do "gulp test" to reproduce.

[ilanbiala]

Fixed in the latest commit.

[reblace]

Fixed.

[reblace]

Just discovered that this issue isn't entirely fixed. The remaining issue is that when the tests fail, the 'closeMongoose' task isn't called, so the build still hangs.

One solution is to suppress errors on both the mocha and karma build tasks... eg:

// Mocha tests task
gulp.task('mocha', function () {
    return gulp.src(testAssets.tests.server)
        .pipe(plugins.mocha({
            reporter: 'spec'
        }))
        .on('error', function (err) {
            // Make sure failed tests don't cause gulp to exit, otherwise Mongoose won't cleanup
            this.emit('end');
        });
});

// Karma test runner task
gulp.task('karma', function (done) {
    return gulp.src([])
        .pipe(plugins.karma({
            configFile: 'karma.conf.js',
            action: 'run',
            singleRun: true
        }))
        .on('error', function (err) {
            // Make sure failed tests cause gulp to exit non-zero
            this.emit('end');
        });
});

If you do that, then the gulp tasks will run to completion and the 'closeMongoose' task will run.

But, the issue with this approach is I don't think a CI server will know that the tests failed when they do.

Other possible solutions include making the tests themselves create and close the mongoose connections in the pre/post hooks. Or, to add some code that manually invokes the closeMongoose task in the event of an error and then fails out of the build.

[ilanbiala]

I think a big issue is using runSequence because that doesn't seem to handle error propagation properly. Can you please format your code with syntax highlighting and proper indentation using markdown?

[reblace]

Submitted a pull request for fixing this: #453

I changed the gulpfile so the mocha task calls mongoose.disconnect regardless of if the mocha tests pass or fail and passes the error back to the done callback if it exists. I should note, I've tested with both passing and failing mocha tests and karma tests.

[ilanbiala]

Just merged #453 in, so this should be fixed.