node-bunyan-lite/test/safe-json-stringify-4.js

process.env.BUNYAN_TEST_NO_SAFE_JSON_STRINGIFY = '1';
var bunyan = require('../lib/bunyan');

var log = bunyan.createLogger({
    name: 'safe-json-stringify-4'
});

// And using `Object.defineProperty`.
var obj = {};
Object.defineProperty(obj, 'boom', {
    get: function () { throw new Error('defineProperty ouch!'); },
    enumerable: true // enumerable is false by default
});
// Twice to test the 'warnKey' usage.
for (var i = 0; i < 2; i++) {
    log.info({obj: obj}, 'using defineProperty');
}
Defend against throwing defined props in stringify If an object has a defined property, that is enumerable, and this property throws an error, it will make JSON stringify throw an error, and potentially bring down the program. The solution so far is to try-catch with the usual json stringifyer, that guards against circular references. If this throws an error we will attempt to guard against defined properties; and return [Throws] if a property throws an error when accesed. The following examples illustrate the problem: ```js var obj = {}; obj.__defineGetter__('foo', function() { throw new Error('ouch!'); }); JSON.stringify(obj.foo); // error thrown ``` And using `Object.defineProperty`: ```js var obj = {}; Object.defineProperty(obj, 'foo', { get: function() { throw new Error('ouch!'); } enumerable: true // enumerable is false by default }); JSON.stringify(obj.foo); // error thrown ``` The cases we have seen in production is third party modules that has enumerable getters that try to access properties on undefined objects. Fixes #182. 2015-01-19 07:16:35 +00:00			`process.env.BUNYAN_TEST_NO_SAFE_JSON_STRINGIFY = '1';`
			`var bunyan = require('../lib/bunyan');`

			`var log = bunyan.createLogger({`
			`name: 'safe-json-stringify-4'`
			`});`

			// And using `Object.defineProperty`.
			`var obj = {};`
			`Object.defineProperty(obj, 'boom', {`
test cases for #182, style tweaks, changelog, etc. 2015-01-19 07:27:28 +00:00			`get: function () { throw new Error('defineProperty ouch!'); },`
Defend against throwing defined props in stringify If an object has a defined property, that is enumerable, and this property throws an error, it will make JSON stringify throw an error, and potentially bring down the program. The solution so far is to try-catch with the usual json stringifyer, that guards against circular references. If this throws an error we will attempt to guard against defined properties; and return [Throws] if a property throws an error when accesed. The following examples illustrate the problem: ```js var obj = {}; obj.__defineGetter__('foo', function() { throw new Error('ouch!'); }); JSON.stringify(obj.foo); // error thrown ``` And using `Object.defineProperty`: ```js var obj = {}; Object.defineProperty(obj, 'foo', { get: function() { throw new Error('ouch!'); } enumerable: true // enumerable is false by default }); JSON.stringify(obj.foo); // error thrown ``` The cases we have seen in production is third party modules that has enumerable getters that try to access properties on undefined objects. Fixes #182. 2015-01-19 07:16:35 +00:00			`enumerable: true // enumerable is false by default`
			`});`
			`// Twice to test the 'warnKey' usage.`
			`for (var i = 0; i < 2; i++) {`
			`log.info({obj: obj}, 'using defineProperty');`
			`}`