Skip to content

Commit

Permalink
test(ses): test Endo 2355 linenumber workaround
Browse files Browse the repository at this point in the history
  • Loading branch information
erights committed Jul 14, 2024
1 parent 66bf702 commit b22f8ae
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 0 deletions.
28 changes: 28 additions & 0 deletions packages/boot/test/bootstrapTests/stack-linenumbers.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';

/*
lots of vertical space
*/

test('foo', t => {
t.log('look at linenumbers', Error('what me worry'));
t.pass();
});
107 changes: 107 additions & 0 deletions patches/ses+1.5.0.patch
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
diff --git a/node_modules/ses/src/error/tame-error-constructor.js b/node_modules/ses/src/error/tame-error-constructor.js
index 2788c42..fee98e9 100644
--- a/node_modules/ses/src/error/tame-error-constructor.js
+++ b/node_modules/ses/src/error/tame-error-constructor.js
@@ -1,3 +1,4 @@
+import { getEnvironmentOption } from '@endo/env-options';
import {
FERAL_ERROR,
TypeError,
@@ -7,6 +8,7 @@ import {
setPrototypeOf,
getOwnPropertyDescriptor,
defineProperty,
+ getOwnPropertyDescriptors,
} from '../commons.js';
import { NativeErrors } from '../permits.js';
import { tameV8ErrorConstructor } from './tame-v8-error-constructor.js';
@@ -29,6 +31,7 @@ const tamedMethods = {
return '';
},
};
+let initialGetStackString = tamedMethods.getStackString;

export default function tameErrorConstructor(
errorTaming = 'safe',
@@ -42,9 +45,25 @@ export default function tameErrorConstructor(
}
const ErrorPrototype = FERAL_ERROR.prototype;

- const platform =
- typeof FERAL_ERROR.captureStackTrace === 'function' ? 'v8' : 'unknown';
const { captureStackTrace: originalCaptureStackTrace } = FERAL_ERROR;
+ let platform =
+ typeof originalCaptureStackTrace === 'function' ? 'v8' : 'unknown';
+
+ const SUPPRESS_NODE_ERROR_TAMING = 'SUPPRESS_NODE_ERROR_TAMING';
+
+ if (
+ errorTaming === 'unsafe' &&
+ platform === 'v8' &&
+ getEnvironmentOption(SUPPRESS_NODE_ERROR_TAMING, 'disabled', [
+ 'enabled',
+ ]) === 'enabled'
+ ) {
+ // This case is a kludge to work around
+ // https://github.com/endojs/endo/issues/1798
+ // https://github.com/endojs/endo/issues/2348
+ // https://github.com/Agoric/agoric-sdk/issues/8662
+ platform = SUPPRESS_NODE_ERROR_TAMING;
+ }

const makeErrorConstructor = (_ = {}) => {
// eslint-disable-next-line no-shadow
@@ -122,6 +141,45 @@ export default function tameErrorConstructor(
},
});

+ if (platform === SUPPRESS_NODE_ERROR_TAMING) {
+ // This case is a kludge to work around
+ // https://github.com/endojs/endo/issues/1798
+ // https://github.com/endojs/endo/issues/2348
+ // https://github.com/Agoric/agoric-sdk/issues/8662
+
+ defineProperties(InitialError, {
+ prepareStackTrace: {
+ get() {
+ return FERAL_ERROR.prepareStackTrace;
+ },
+ set(newPrepareStackTrace) {
+ FERAL_ERROR.prepareStackTrace = newPrepareStackTrace;
+ },
+ enumerable: false,
+ configurable: true,
+ },
+ captureStackTrace: {
+ value: FERAL_ERROR.captureStackTrace,
+ writable: true,
+ enumerable: false,
+ configurable: true,
+ },
+ });
+
+ const descs = getOwnPropertyDescriptors(InitialError);
+ defineProperties(SharedError, {
+ stackTraceLimit: descs.stackTraceLimit,
+ prepareStackTrace: descs.prepareStackTrace,
+ captureStackTrace: descs.captureStackTrace,
+ })
+
+ return {
+ '%InitialGetStackString%': initialGetStackString,
+ '%InitialError%': InitialError,
+ '%SharedError%': SharedError,
+ };
+ }
+
// The default SharedError much be completely powerless even on v8,
// so the lenient `stackTraceLimit` accessor does nothing on all
// platforms.
@@ -171,7 +229,6 @@ export default function tameErrorConstructor(
});
}

- let initialGetStackString = tamedMethods.getStackString;
if (platform === 'v8') {
initialGetStackString = tameV8ErrorConstructor(
FERAL_ERROR,

0 comments on commit b22f8ae

Please sign in to comment.