Skip to content
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
10 changes: 9 additions & 1 deletion cjs/deserialize.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const {
} = require('./types.js');

const { defineProperty } = Object;
const {hasOwnProperty} = Object.prototype;
const env = typeof self === 'object' ? self : globalThis;

const guard = (name, init) => {
Expand Down Expand Up @@ -74,12 +75,19 @@ const deserializer = ($, _) => {
}
case ERROR: {
const {name, message} = value;
return as(
const error = as(
typeof env[name] === 'function' ?
guard(name, message) :
new Error(message),
index
);
if (hasOwnProperty.call(value, 'cause'))
defineProperty(error, 'cause', {
value: unpair(value.cause),
configurable: true,
writable: true
});
return error;
}
case BIGINT:
return as(BigInt(value), index);
Expand Down
12 changes: 10 additions & 2 deletions cjs/serialize.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const {
const EMPTY = '';

const {toString} = {};
const {keys, is} = Object;
const {keys, is, getOwnPropertyDescriptor} = Object;

const typeOf = value => {
const type = typeof value;
Expand Down Expand Up @@ -149,7 +149,15 @@ const serializer = (strict, json, $, _) => {
}

const {message} = value;
return as([TYPE, {name: type, message}], value);
const error = {name: type, message};
const index = as([TYPE, error], value);
const descriptor = getOwnPropertyDescriptor(value, 'cause');
if (descriptor && 'value' in descriptor) {
const cause = descriptor.value;
if (strict || !shouldSkip(typeOf(cause)))
error.cause = pair(cause);
}
return index;
};

return pair;
Expand Down
10 changes: 9 additions & 1 deletion esm/deserialize.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
} from './types.js';

const { defineProperty } = Object;
const {hasOwnProperty} = Object.prototype;
const env = typeof self === 'object' ? self : globalThis;

const guard = (name, init) => {
Expand Down Expand Up @@ -76,12 +77,19 @@ const deserializer = ($, _) => {
}
case ERROR: {
const {name, message} = value;
return as(
const error = as(
typeof env[name] === 'function' ?
guard(name, message) :
new Error(message),
index
);
if (hasOwnProperty.call(value, 'cause'))
defineProperty(error, 'cause', {
value: unpair(value.cause),
configurable: true,
writable: true
});
return error;
}
case BIGINT:
return as(BigInt(value), index);
Expand Down
12 changes: 10 additions & 2 deletions esm/serialize.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
const EMPTY = '';

const {toString} = {};
const {keys, is} = Object;
const {keys, is, getOwnPropertyDescriptor} = Object;

const typeOf = value => {
const type = typeof value;
Expand Down Expand Up @@ -151,7 +151,15 @@ const serializer = (strict, json, $, _) => {
}

const {message} = value;
return as([TYPE, {name: type, message}], value);
const error = {name: type, message};
const index = as([TYPE, error], value);
const descriptor = getOwnPropertyDescriptor(value, 'cause');
if (descriptor && 'value' in descriptor) {
const cause = descriptor.value;
if (strict || !shouldSkip(typeOf(cause)))
error.cause = pair(cause);
}
return index;
};

return pair;
Expand Down
2 changes: 1 addition & 1 deletion structured-json.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

74 changes: 74 additions & 0 deletions test/error-cause.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
const assert = require('node:assert/strict');
const {serialize, deserialize, default: clone} = require('../cjs');
const {parse, stringify} = require('../cjs/json');

for (const roundTrip of [
value => deserialize(serialize(value)),
value => parse(stringify(value)),
value => clone(value, {lossy: false})
]) {
for (const Class of [Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError]) {
const original = new Class('outer', {cause: new TypeError('inner')});
const native = globalThis.structuredClone(original);
const actual = roundTrip(original);
assert.equal(actual.constructor, native.constructor);
assert.equal(actual.cause.constructor, native.cause.constructor);
assert.equal(actual.cause.message, native.cause.message);
assert.deepEqual(Object.getOwnPropertyDescriptor(actual, 'cause'), {
value: actual.cause, enumerable: false, configurable: true, writable: true
});
}

for (const cause of [undefined, null, false, 0, '', 'reason', 1n, {status: 500}]) {
const actual = roundTrip(new Error('outer', {cause}));
assert.equal(Object.hasOwn(actual, 'cause'), true);
assert.deepEqual(actual.cause, cause);
}

const shared = {status: 500};
const actual = roundTrip({error: new Error('outer', {cause: shared}), shared});
assert.equal(actual.error.cause, actual.shared);

const self = new Error('self');
self.cause = self;
const selfClone = roundTrip(self);
assert.equal(selfClone.cause, selfClone);

const first = new Error('first');
const second = new TypeError('second', {cause: first});
first.cause = second;
const cycle = roundTrip(first);
assert.equal(cycle.cause.cause, cycle);
assert.equal(cycle.cause.message, 'second');

const inherited = new Error('inherited');
Object.setPrototypeOf(inherited, Object.create(Error.prototype, {
cause: {value: 'inherited cause'}
}));
assert.equal(Object.hasOwn(roundTrip(inherited), 'cause'), false);

let reads = 0;
const getter = new Error('getter');
Object.defineProperty(getter, 'cause', {get() { reads++; return shared; }});
const nativeGetter = globalThis.structuredClone(getter);
const actualGetter = roundTrip(getter);
assert.equal(Object.hasOwn(actualGetter, 'cause'), Object.hasOwn(nativeGetter, 'cause'));
assert.equal(reads, 0);

const throwing = new Error('throwing getter');
Object.defineProperty(throwing, 'cause', {get() { throw new Error('must not run'); }});
assert.equal(Object.hasOwn(roundTrip(throwing), 'cause'), false);
assert.equal(Object.hasOwn(globalThis.structuredClone(throwing), 'cause'), false);
}

for (const cause of [() => {}, Symbol('reason')]) {
const error = new Error('outer', {cause});
assert.throws(() => serialize(error), TypeError);
assert.equal(Object.hasOwn(deserialize(serialize(error, {lossy: true})), 'cause'), false);
assert.equal(Object.hasOwn(parse(stringify(error)), 'cause'), false);
}

const legacy = [[7, {name: 'Error', message: 'legacy'}]];
assert.equal(deserialize(legacy).message, 'legacy');
assert.equal(Object.hasOwn(deserialize(legacy), 'cause'), false);
assert.deepEqual(serialize(new Error('legacy')), legacy);
2 changes: 2 additions & 0 deletions test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,5 @@ for (const Class of [Error, EvalError, RangeError, ReferenceError, SyntaxError,
}

require('./eval.js');

require('./error-cause.js');