Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support skipping logger creation if it is provided #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const gulp = require('gulp');
process.env.NODE_ENV = process.env.NODE_ENV || 'development';

require('godaddy-test-tools')(gulp, {
lint: { files: ['*.js', 'lib/**/*.js', 'test/*.js'] },
lint: { files: ['*.js', 'lib/**/*.js', 'test/**/*.js'] },
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not super familiar with gulp, but depending on platform and how this gets used you may need to include both test/*.js and test/**/*.js.

istanbulReports: { dir: 'build' },
unitTestFiles: 'test/*.test.js'
unitTestFiles: 'test/**/*.test.js'
});
5 changes: 5 additions & 0 deletions lib/preboot/logger.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ var debug = require('diagnostics')('slay:preboot:logger');
* a winston Logger for this app instance.
*/
module.exports = function (app, options, callback) {
if (app.log) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This capability checking is not quite enough as there are a few calls to app.log.info in the other preboots.

debug('executed, app.log exists, skipping hookable "logger"');
return callback();
}

debug('executed, perform hookable "logger"');

app.hookable('logger', function (ext, done) {
Expand Down
66 changes: 66 additions & 0 deletions test/preboot/logger.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
'use strict';

const assert = require('chai').assert;
const winston = require('winston');
const logger = require('../../lib/preboot/logger');

describe('Logger test suite (unit tests)', function () {

describe('Initialization of module', function () {
it('Is defined', function () {
assert(logger);
assert.typeOf(logger, 'function');
});
});

describe('Preboot', function () {
it('should call hookable', function (done) {
const prebootCallback = () => { };
const app = {
hookable: (event, fn, callback) => {
assert.equal(event, 'logger');
assert.equal(callback, prebootCallback);
done();
}
};
logger(app, null, prebootCallback);
});

it('should produce logger', function (done) {
const app = {
hookable: (event, fn, callback) => {
fn(null, () => {
callback();
});
},
after: (event, callback) => {
assert.equal(event, 'start');
assert.typeOf(callback, 'function');
}
};
const options = {
log: {
transports: [new winston.transports.Console()]
}
};
logger(app, options, () => {
assert(app.log);
assert.typeOf(app.log.error, 'function');
assert.typeOf(app.log.warn, 'function');
assert.typeOf(app.log.info, 'function');
done();
});
});

it('should not produce logger when app.log exists', function (done) {
const log = { };
const app = {
log
};
logger(app, null, () => {
assert.equal(app.log, log);
done();
});
});
});
});