fix(ses,pass-style,marshal): fix #2428 permit disposal intrinsics

packages/common/NEWS.md

@@ -1,5 +1,9 @@
 User-visible changes in `@endo/common`:
 
+# Next release
+
+- TODO explain further generalization of `throwLabeled`
+
 # v1.1.0 (2024-02-22)
 
 - `throwLabeled` parameterized error construction

packages/errors/NEWS.md

@@ -1,5 +1,10 @@
 User-visible changes in `@endo/errors`:
 
+# Next release
+
+- TODO explain `SuppressedError` support
+
+
 # v1.1.0 (2024-02-22)
 
 - `AggegateError` support

packages/eslint-plugin/lib/configs/recommended.js

@@ -63,6 +63,8 @@ module.exports = {
     HandledPromise: 'readonly',
     // https://github.com/endojs/endo/issues/550
     AggregateError: 'readonly',
+    // https://github.com/tc39/proposal-explicit-resource-management
+    SuppressedError: 'readonly',
   },
   rules: {
     '@endo/assert-fail-as-throw': 'error',

packages/marshal/NEWS.md

@@ -1,5 +1,9 @@
 User-visible changes in `@endo/marshal`:
 
+# Next release
+
+TODO explain `SuppressedError` support
+
 # v1.5.1 (2024-07-30)
 
 - `deeplyFulfilled` moved from @endo/marshal to @endo/pass-style. @endo/marshal still reexports it, to avoid breaking old importers. But importers should be upgraded to import `deeplyFulfilled` directly from @endo/pass-style.

packages/marshal/src/marshal-justin.js

@@ -399,8 +399,10 @@ const decodeToJustin = (encoding, shouldIndent = false, slots = []) => {
             Fail`error cause not yet implemented in marshal-justin`;
           name !== `AggregateError` ||
             Fail`AggregateError not yet implemented in marshal-justin`;
+          // TODO SuppressedError
           errors === undefined ||
             Fail`error errors not yet implemented in marshal-justin`;
+          // TODO error,suppressed
           return out.next(`${name}(${quote(message)})`);
         }
 

packages/marshal/src/marshal.js

@@ -112,7 +112,7 @@ export const makeMarshal = (
       assert.typeof(message, 'string');
       const name = encodeRecur(`${err.name}`);
       assert.typeof(name, 'string');
-      // TODO Must encode `cause`, `errors`, but
+      // TODO Must encode `cause`,`errors`,`error`,`suppressed` but
       // only once all possible counterparty decoders are tolerant of
       // receiving them.
       if (errorTagging === 'on') {
@@ -262,8 +262,10 @@ export const makeMarshal = (
      *   errorId?: string,
      *   message: string,
      *   name: string,
-     *   cause: unknown,
-     *   errors: unknown,
+     *   cause?: unknown,
+     *   errors?: unknown,
+     *   error?: unknown,
+     *   suppressed?: unknown,
      * }} errData
      * @param {(e: unknown) => Passable} decodeRecur
      * @returns {Error}
@@ -275,6 +277,8 @@ export const makeMarshal = (
         name,
         cause = undefined,
         errors = undefined,
+        error = undefined,
+        suppressed = undefined,
         ...rest
       } = errData;
       // See https://github.com/endojs/endo/pull/2052
@@ -306,6 +310,12 @@ export const makeMarshal = (
       if (errors) {
         options.errors = decodeRecur(errors);
       }
+      if (error) {
+        options.error = decodeRecur(error);
+      }
+      if (suppressed) {
+        options.suppressed = decodeRecur(suppressed);
+      }
       const rawError = makeError(dMessage, errConstructor, options);
       // Note that this does not decodeRecur rest's property names.
       // This would be inconsistent with smallcaps' expected handling,

packages/marshal/src/types.js

@@ -38,6 +38,8 @@ export {};
  *                                      errorId?: string,
  *                                      cause?: Encoding,
  *                                      errors?: Encoding[],
+ *                                      error?: Encoding,
+ *                                      suppressed?: Encoding,
  *           } |
  *           EncodingClass<'slot'> & { index: number,
  *                                     iface?: string

packages/marshal/test/marshal-capdata.test.js

@@ -219,6 +219,8 @@ testIfAggregateError('unserialize errors w recognized extensions', t => {
   t.is(getPrototypeOf(unkErr.errors[0]), URIError.prototype);
 });
 
+// TODO SuppressedError
+
 test('passStyleOf null is "null"', t => {
   t.assert(passStyleOf(null), 'null');
 });

packages/marshal/test/marshal-smallcaps.test.js

@@ -226,6 +226,8 @@ test('smallcaps unserialize errors w recognized extensions', t => {
   t.is(getPrototypeOf(refErr.errors[0]), URIError.prototype);
 });
 
+// TODO SuppressedError
+
 test('smallcaps mal-formed @qclass', t => {
   const { unserialize } = makeTestMarshal();
   const uns = body => unserialize({ body, slots: [] });

packages/pass-style/NEWS.md

@@ -1,5 +1,9 @@
 User-visible changes in `@endo/pass-style`:
 
+# Next release
+
+TODO explain `SuppressedError` support
+
 # v1.4.1 (2024-07-30)
 
 - `deeplyFulfilled` moved from @endo/marshal to @endo/pass-style. @endo/marshal still reexports it, to avoid breaking old importers. But importers should be upgraded to import `deeplyFulfilled` directly from @endo/pass-style.

packages/pass-style/src/error.js

@@ -27,6 +27,8 @@ const errorConstructors = new Map(
     // To accommodate platforms prior to AggregateError, we comment out the
     // following line and instead conditionally add it to the map below.
     // ['AggregateError', AggregateError],
+    // Likewise https://github.com/tc39/proposal-explicit-resource-management
+    // ['SuppressedError', SuppressedError],
   ]),
 );
 
@@ -35,9 +37,15 @@ if (typeof AggregateError !== 'undefined') {
   errorConstructors.set('AggregateError', AggregateError);
 }
 
+if (typeof SuppressedError !== 'undefined') {
+  // Conditional, to accommodate platforms prior to SuppressedError
+  errorConstructors.set('SuppressedError', SuppressedError);
+}
+
 /**
  * Because the error constructor returned by this function might be
- * `AggregateError`, which has different construction parameters
+ * `AggregateError` or `SuppressedError`,
+ * each of which has different construction parameters
  * from the other error constructors, do not use it directly to try
  * to make an error instance. Rather, use `makeError` which encapsulates
  * this non-uniformity.
@@ -125,7 +133,9 @@ export const checkRecursivelyPassableErrorPropertyDesc = (
           )} own property must be a string: ${value}`)
       );
     }
-    case 'cause': {
+    case 'cause':
+    case 'error':
+    case 'suppressed': {
       // eslint-disable-next-line no-use-before-define
       return checkRecursivelyPassableError(value, passStyleOfRecur, check);
     }

packages/pass-style/src/passStyleOf.js

@@ -281,22 +281,39 @@ export const toPassableError = err => {
     return err;
   }
   const { name, message } = err;
-  const { cause: causeDesc, errors: errorsDesc } =
-    getOwnPropertyDescriptors(err);
+  const {
+    cause: causeDesc,
+    errors: errorsDesc,
+    error: errorDesc,
+    suppressed: suppressedDesc,
+  } = getOwnPropertyDescriptors(err);
   let cause;
   let errors;
+  let error;
+  let suppressed;
   if (causeDesc && isPassableErrorPropertyDesc('cause', causeDesc)) {
     cause = causeDesc.value;
   }
   if (errorsDesc && isPassableErrorPropertyDesc('errors', errorsDesc)) {
     errors = errorsDesc.value;
   }
+  if (errorDesc && isPassableErrorPropertyDesc('error', errorDesc)) {
+    error = errorDesc.value;
+  }
+  if (
+    suppressedDesc &&
+    isPassableErrorPropertyDesc('suppressed', suppressedDesc)
+  ) {
+    suppressed = suppressedDesc.value;
+  }
 
   const errConstructor = getErrorConstructor(`${name}`) || Error;
   const newError = makeError(`${message}`, errConstructor, {
     // @ts-ignore Assuming cause is Error | undefined
     cause,
     errors,
+    error,
+    suppressed,
   });
   // Still needed, because `makeError` only does a shallow freeze.
   harden(newError);

packages/pass-style/test/errors.test.js

@@ -32,6 +32,11 @@ test('style of extended errors', t => {
     const a4 = harden(AggregateError([e2, u3], 'a4', { cause: e1 }));
     t.is(passStyleOf(a4), 'error');
   }
+  if (typeof SuppressedError !== 'undefined') {
+    // Conditional, to accommodate platforms prior to SuppressedError
+    const a4 = harden(SuppressedError(e2, u3, 'a4'));
+    t.is(passStyleOf(a4), 'error');
+  }
 });
 
 test('toPassableError, toThrowable', t => {

packages/ses/NEWS.md

@@ -2,6 +2,8 @@ User-visible changes in `ses`:
 
 # Next release
 
+- TODO explain `SuppressedError` support
+
 - On platforms without
   [`Array.prototype.transfer`](https://github.com/tc39/proposal-resizablearraybuffer)
   but with a global `structuredClone`, the ses-shim's `lockdown` will now

packages/ses/src/commons.js

@@ -50,6 +50,7 @@ export const {
   SyntaxError,
   TypeError,
   AggregateError,
+  SuppressedError,
 } = globalThis;
 
 export const {

packages/ses/src/enablements.js

@@ -155,6 +155,12 @@ export const moderateEnablements = {
     name: true, // set by "node 14"?
   },
 
+  // https://github.com/tc39/proposal-explicit-resource-management
+  '%SuppressedErrorPrototype%': {
+    message: true, // to match TypeErrorPrototype.message
+    name: true, // set by some Node?
+  },
+
   '%PromisePrototype%': {
     constructor: true, // set by "core-js"
   },

packages/ses/src/error/assert.js

@@ -35,6 +35,7 @@ import {
   weakmapHas,
   weakmapSet,
   AggregateError,
+  SuppressedError,
   getOwnPropertyDescriptors,
   ownKeys,
   create,
@@ -268,12 +269,13 @@ const tagError = (err, optErrorName = err.name) => {
  *     such as `stack` on v8 (Chrome, Brave, Edge?)
  *   - `sanitizeError` will freeze the error, preventing any correct engine from
  *     adding or
- *     altering any of the error's own properties `sanitizeError` is done.
+ *     altering any of the error's own properties after `sanitizeError` is done.
  *
  * However, `sanitizeError` will not, for example, `harden`
  * (i.e., deeply freeze)
- * or ensure that the `cause` or `errors` property satisfy the `Passable`
- * constraints. The purpose of `sanitizeError` is only to protect against
+ * or ensure that the `cause`, `errors`, `error`, or `suppressed` properties
+ * satisfy the `Passable` constraints.
+ * The purpose of `sanitizeError` is only to protect against
  * mischief the host may have already added to the error as created,
  * not to ensure that the error is actually Passable. For that,
  * see `toPassableError` in `@endo/pass-style`.
@@ -285,8 +287,10 @@ export const sanitizeError = error => {
   const {
     name: _nameDesc,
     message: _messageDesc,
-    errors: _errorsDesc = undefined,
     cause: _causeDesc = undefined,
+    errors: _errorsDesc = undefined,
+    error: _errorDesc = undefined,
+    suppressed: _suppressedDesc = undefined,
     stack: _stackDesc = undefined,
     ...restDescs
   } = descs;
@@ -316,6 +320,8 @@ export const sanitizeError = error => {
 };
 
 /**
+ * TODO rewrite to be more general
+ *
  * @type {AssertionUtilities['error']}
  */
 const makeError = (
@@ -325,6 +331,8 @@ const makeError = (
     errorName = undefined,
     cause = undefined,
     errors = undefined,
+    error = undefined,
+    suppressed = undefined,
     sanitize = true,
   } = {},
 ) => {
@@ -339,37 +347,41 @@ const makeError = (
   }
   const messageString = getMessageString(hiddenDetails);
   const opts = cause && { cause };
-  let error;
+  let err;
   if (
     typeof AggregateError !== 'undefined' &&
     errConstructor === AggregateError
   ) {
-    error = AggregateError(errors || [], messageString, opts);
+    err = AggregateError(errors || [], messageString, opts);
+  } else if (
+    typeof SuppressedError !== 'undefined' &&
+    errConstructor === SuppressedError
+  ) {
+    err = SuppressedError(error, suppressed, messageString);
+    // TODO what about errors, cause?
   } else {
-    error = /** @type {ErrorConstructor} */ (errConstructor)(
-      messageString,
-      opts,
-    );
+    err = /** @type {ErrorConstructor} */ (errConstructor)(messageString, opts);
     if (errors !== undefined) {
       // Since we need to tolerate `errors` on an AggregateError, may as
       // well tolerate it on all errors.
-      defineProperty(error, 'errors', {
+      defineProperty(err, 'errors', {
         value: errors,
         writable: true,
         enumerable: false,
         configurable: true,
       });
     }
+    // TODO similarly tolerate error,suppressed ?
   }
-  weakmapSet(hiddenMessageLogArgs, error, getLogArgs(hiddenDetails));
+  weakmapSet(hiddenMessageLogArgs, err, getLogArgs(hiddenDetails));
   if (errorName !== undefined) {
-    tagError(error, errorName);
+    tagError(err, errorName);
   }
   if (sanitize) {
-    sanitizeError(error);
+    sanitizeError(err);
   }
   // The next line is a particularly fruitful place to put a breakpoint.
-  return error;
+  return err;
 };
 freeze(makeError);
 

packages/ses/src/error/console.js

@@ -207,6 +207,8 @@ const ErrorInfo = {
   MESSAGE: 'ERROR_MESSAGE:',
   CAUSE: 'cause:',
   ERRORS: 'errors:',
+  ERROR: 'error:',
+  SUPPRESSED: 'suppressed:',
 };
 freeze(ErrorInfo);
 
@@ -354,6 +356,7 @@ export const makeCausalConsole = (baseConsole, loggedErrorHandler) => {
       // @ts-expect-error AggregateError has an `errors` property.
       logErrorInfo(severity, error, ErrorInfo.ERRORS, error.errors, subErrors);
     }
+    // TODO SuppressedError
     for (const noteLogArgs of noteLogArgsArray) {
       logErrorInfo(severity, error, ErrorInfo.NOTE, noteLogArgs, subErrors);
     }

packages/ses/src/error/internal-types.js

@@ -74,6 +74,8 @@
  *   MESSAGE: 'ERROR_MESSAGE:',
  *   CAUSE: 'cause:',
  *   ERRORS: 'errors:',
+ *   ERROR: 'error:',
+ *   SUPPRESSED: 'suppressed:',
  * }} ErrorInfo
  */