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

console: using class #9068

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
153 changes: 71 additions & 82 deletions lib/console.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,100 +2,89 @@

const util = require('util');

function Console(stdout, stderr) {
if (!(this instanceof Console)) {
return new Console(stdout, stderr);
}
if (!stdout || typeof stdout.write !== 'function') {
throw new TypeError('Console expects a writable stream instance');
}
if (!stderr) {
stderr = stdout;
} else if (typeof stderr.write !== 'function') {
throw new TypeError('Console expects writable stream instances');
class Console {
constructor(stdout, stderr) {
if (!(this instanceof Console))
return new Console(stdout, stderr);
Copy link
Member

Choose a reason for hiding this comment

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

This part is not going to work, so you can leave it out from this PR.

Copy link
Author

Choose a reason for hiding this comment

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

You mean 7, 8 lines?


if (!stdout || typeof stdout.write !== 'function')
throw new TypeError('Console expects a writable stream instance');

if (!stderr)
stderr = stdout;
else if (typeof stderr.write !== 'function')
throw new TypeError('Console expects writable stream instances');

this._stdout = stdout;
this._stderr = stderr;
this._times = new Map();

const methods = [
'log', 'info', 'warn',
'error', 'dir', 'time',
'timeEnd', 'trace', 'assert'
];

methods.forEach((method) => {
this[method] = this[method].bind(this);
});
}

var prop = {
writable: true,
enumerable: false,
configurable: true
};
prop.value = stdout;
Object.defineProperty(this, '_stdout', prop);
prop.value = stderr;
Object.defineProperty(this, '_stderr', prop);
prop.value = new Map();
Object.defineProperty(this, '_times', prop);

// bind the prototype functions to this Console instance
var keys = Object.keys(Console.prototype);
for (var v = 0; v < keys.length; v++) {
var k = keys[v];
this[k] = this[k].bind(this);
// As of v8 5.0.71.32, the combination of rest param, template string
// and .apply(null, args) benchmarks consistently faster than using
// the spread operator when calling util.format.
log(...args) {
Copy link
Contributor

@mscdex mscdex Oct 12, 2016

Choose a reason for hiding this comment

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

I believe this is still slow, even with V8 5.4 currently in master.

Ditto for the other rest args uses.

this._stdout.write(`${util.format.apply(null, args)}\n`);
}
}


// As of v8 5.0.71.32, the combination of rest param, template string
// and .apply(null, args) benchmarks consistently faster than using
// the spread operator when calling util.format.
Console.prototype.log = function(...args) {
this._stdout.write(`${util.format.apply(null, args)}\n`);
};


Console.prototype.info = Console.prototype.log;


Console.prototype.warn = function(...args) {
this._stderr.write(`${util.format.apply(null, args)}\n`);
};


Console.prototype.error = Console.prototype.warn;

info(...args) {
this.log.apply(this, args);
}

Console.prototype.dir = function(object, options) {
options = Object.assign({customInspect: false}, options);
this._stdout.write(`${util.inspect(object, options)}\n`);
};
warn(...args) {
this._stderr.write(`${util.format.apply(null, args)}\n`);
}

error(...args) {
this.warn.apply(this, args);
}

Console.prototype.time = function(label) {
this._times.set(label, process.hrtime());
};
dir(object, options) {
options = Object.assign({customInspect: false}, options);
this._stdout.write(`${util.inspect(object, options)}\n`);
}

time(label) {
this._times.set(label, process.hrtime());
}

Console.prototype.timeEnd = function(label) {
const time = this._times.get(label);
if (!time) {
process.emitWarning(`No such label '${label}' for console.timeEnd()`);
return;
timeEnd(label) {
const time = this._times.get(label);
if (!time) {
process.emitWarning(`No such label '${label}' for console.timeEnd()`);
return;
}
const duration = process.hrtime(time);
const ms = duration[0] * 1000 + duration[1] / 1e6;
this.log('%s: %sms', label, ms.toFixed(3));
this._times.delete(label);
}
const duration = process.hrtime(time);
const ms = duration[0] * 1000 + duration[1] / 1e6;
this.log('%s: %sms', label, ms.toFixed(3));
this._times.delete(label);
};


Console.prototype.trace = function trace(...args) {
// TODO probably can to do this better with V8's debug object once that is
// exposed.
var err = new Error();
err.name = 'Trace';
err.message = util.format.apply(null, args);
Error.captureStackTrace(err, trace);
this.error(err.stack);
};


Console.prototype.assert = function(expression, ...args) {
if (!expression) {
require('assert').ok(false, util.format.apply(null, args));

trace(...args) {
// TODO probably can to do this better with V8's debug object once that is
// exposed.
var err = new Error();
err.name = 'Trace';
err.message = util.format.apply(null, args);
Error.captureStackTrace(err, this.trace);
this.error(err.stack);
}
};

assert(expression, ...args) {
if (!expression)
require('assert').ok(false, util.format.apply(null, args));
}
}

module.exports = new Console(process.stdout, process.stderr);
module.exports.Console = Console;
5 changes: 0 additions & 5 deletions test/parallel/test-console-instance.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,3 @@ out.write = function(d) {
};
[1, 2, 3].forEach(c.log);
assert.equal(3, called);

// Console() detects if it is called without `new` keyword
assert.doesNotThrow(function() {
Console(out, err);
});