refactor(errors): support our assert conventions

packages/captp/package.json

@@ -52,6 +52,7 @@
     "c8": "^7.14.0"
   },
   "dependencies": {
+    "@endo/errors": "^1.0.2",
     "@endo/eventual-send": "^1.1.0",
     "@endo/marshal": "^1.1.0",
     "@endo/nat": "^5.0.2",

packages/captp/src/atomics.js

@@ -1,6 +1,6 @@
 /// <reference types="ses"/>
 
-const { details: X, Fail } = assert;
+import { X, Fail } from '@endo/errors';
 
 // This is a pathological minimum, but exercised by the unit test.
 export const MIN_DATA_BUFFER_LENGTH = 1;
@@ -154,7 +154,7 @@ export const makeAtomicsTrapGuest = transferBuffer => {
     //
     // TODO: It would be nice to use an error type, but captp is just too
     // noisy with spurious "Temporary logging of sent error" messages.
-    // it.throw(assert.error(X`Trap host has not finished`));
+    // it.throw(makeError(X`Trap host has not finished`));
     it.throw(null);
 
     // eslint-disable-next-line no-bitwise

packages/captp/src/captp.js

@@ -12,14 +12,13 @@ import { Remotable, Far, makeMarshal, QCLASS } from '@endo/marshal';
 import { E, HandledPromise } from '@endo/eventual-send';
 import { isPromise, makePromiseKit } from '@endo/promise-kit';
 
+import { X, Fail, annotateError } from '@endo/errors';
 import { makeTrap } from './trap.js';
 
 import { makeFinalizingMap } from './finalize.js';
 
 export { E };
 
-const { details: X, Fail } = assert;
-
 const WELL_KNOWN_SLOT_PROPERTIES = harden(['answerID', 'questionID', 'target']);
 
 /**
@@ -670,7 +669,7 @@ export const makeCapTP = (
           if (!e) {
             Fail`trapGuest expected trapHost AsyncIterator(${questionID}) to be done, but it wasn't`;
           }
-          assert.note(e, X`trapHost AsyncIterator(${questionID}) threw`);
+          annotateError(e, X`trapHost AsyncIterator(${questionID}) threw`);
           throw e;
         }
       };

packages/captp/test/traplib.js

@@ -2,12 +2,11 @@
 /// <reference types="ses"/>
 
 import { Far } from '@endo/marshal';
+import { X, Fail } from '@endo/errors';
 import { E, makeCapTP } from '../src/captp.js';
 
 import { makeAtomicsTrapGuest, makeAtomicsTrapHost } from '../src/atomics.js';
 
-const { details: X, Fail } = assert;
-
 export const createHostBootstrap = makeTrapHandler => {
   // Create a remotable that has a syncable return value.
   return Far('test traps', {

packages/captp/test/worker.js

@@ -4,10 +4,9 @@ import '@endo/init/pre-remoting.js';
 import '@endo/init/debug.js';
 
 import { parentPort } from 'worker_threads';
+import { Fail } from '@endo/errors';
 import { makeGuest, makeHost } from './traplib.js';
 
-const { Fail } = assert;
-
 let dispatch;
 parentPort.addListener('message', obj => {
   switch (obj.type) {

packages/check-bundle/lite.js

@@ -4,7 +4,7 @@
 import { decodeBase64 } from '@endo/base64/decode.js';
 import { parseArchive } from '@endo/compartment-mapper/import-archive.js';
 
-const { Fail, details: d, quote: q } = assert;
+import { Fail, X, q } from '@endo/errors';
 
 /**
  * Verifies that a bundle passes its own integrity checks or rejects the
@@ -25,7 +25,7 @@ export const checkBundle = async (
   assert.typeof(
     bundle,
     'object',
-    d`checkBundle cannot hash non-bundle, must be of type object, got ${q(
+    X`checkBundle cannot hash non-bundle, must be of type object, got ${q(
       bundle,
     )}`,
   );
@@ -56,20 +56,20 @@ export const checkBundle = async (
   assert.typeof(
     moduleFormat,
     'string',
-    d`checkBundle cannot hash non-bundle, moduleFormat must be a string, got ${typeof moduleFormat}`,
+    X`checkBundle cannot hash non-bundle, moduleFormat must be a string, got ${typeof moduleFormat}`,
   );
 
   if (moduleFormat === 'endoZipBase64') {
     const { endoZipBase64, endoZipBase64Sha512 } = bundle;
     assert.typeof(
       endoZipBase64,
       'string',
-      d`checkBundle cannot hash non-bundle, property 'endoZipBase64' must be a string, got ${typeof endoZipBase64}`,
+      X`checkBundle cannot hash non-bundle, property 'endoZipBase64' must be a string, got ${typeof endoZipBase64}`,
     );
     assert.typeof(
       endoZipBase64Sha512,
       'string',
-      d`checkBundle cannot bundle without the property 'endoZipBase64Sha512', which must be a string, got ${typeof endoZipBase64Sha512}`,
+      X`checkBundle cannot bundle without the property 'endoZipBase64Sha512', which must be a string, got ${typeof endoZipBase64Sha512}`,
     );
     const bytes = decodeBase64(endoZipBase64);
     const { sha512: parsedSha512 } = await parseArchive(bytes, bundleName, {

packages/check-bundle/package.json

@@ -40,7 +40,8 @@
   },
   "dependencies": {
     "@endo/base64": "^1.0.1",
-    "@endo/compartment-mapper": "^1.1.0"
+    "@endo/compartment-mapper": "^1.1.0",
+    "@endo/errors": "^1.0.2"
   },
   "devDependencies": {
     "@endo/bundle-source": "^3.0.2",

packages/common/from-unique-entries.js

@@ -1,8 +1,8 @@
+import { q, Fail } from '@endo/errors';
+
 const { fromEntries } = Object;
 const { ownKeys } = Reflect;
 
-const { quote: q, Fail } = assert;
-
 /**
  * Throws if multiple entries use the same property name. Otherwise acts
  * like `Object.fromEntries` but hardens the result.

packages/common/package.json

@@ -41,6 +41,7 @@
     "test:xs": "exit 0"
   },
   "dependencies": {
+    "@endo/errors": "^1.0.2",
     "@endo/eventual-send": "^1.1.0",
     "@endo/promise-kit": "^1.0.2"
   },

packages/common/test/test-apply-labeling-error.js

@@ -1,7 +1,8 @@
 import { test } from './prepare-test-env-ava.js';
-import { applyLabelingError } from '../apply-labeling-error.js';
 
-const { Fail } = assert;
+// eslint-disable-next-line import/order
+import { Fail } from '@endo/errors';
+import { applyLabelingError } from '../apply-labeling-error.js';
 
 test('test applyLabelingError', async t => {
   t.is(

packages/common/throw-labeled.js

@@ -1,4 +1,4 @@
-const { details: X } = assert;
+import { X, makeError, annotateError } from '@endo/errors';
 
 /**
  * Given an error `innerErr` and a `label`, throws a similar
@@ -14,11 +14,8 @@ export const throwLabeled = (innerErr, label, ErrorConstructor = undefined) => {
   if (typeof label === 'number') {
     label = `[${label}]`;
   }
-  const outerErr = assert.error(
-    `${label}: ${innerErr.message}`,
-    ErrorConstructor,
-  );
-  assert.note(outerErr, X`Caused by ${innerErr}`);
+  const outerErr = makeError(`${label}: ${innerErr.message}`, ErrorConstructor);
+  annotateError(outerErr, X`Caused by ${innerErr}`);
   throw outerErr;
 };
 harden(throwLabeled);

packages/daemon/package.json

@@ -40,6 +40,7 @@
   },
   "dependencies": {
     "@endo/captp": "^4.0.2",
+    "@endo/errors": "^1.0.2",
     "@endo/eventual-send": "^1.1.0",
     "@endo/far": "^1.0.2",
     "@endo/lockdown": "^1.0.2",

packages/daemon/src/daemon.js

@@ -17,10 +17,9 @@ import url from 'url';
 
 import { E, Far } from '@endo/far';
 import { makePromiseKit } from '@endo/promise-kit';
+import { q } from '@endo/errors';
 import { makeNodeNetstringCapTP } from './connection.js';
 
-const { quote: q } = assert;
-
 const { promise: cancelled, reject: cancel } = makePromiseKit();
 
 // TODO thread through command arguments.

packages/errors/index.js

@@ -71,4 +71,10 @@ export {
   quote,
   redacted,
   throwRedacted,
+  // conventional abbreviations and aliases
+  bare as b,
+  quote as q,
+  redacted as X,
+  throwRedacted as Fail,
+  note as annotateError,
 };

packages/eventual-send/src/E.js

@@ -53,7 +53,7 @@ const makeEProxyHandler = (recipient, HandledPromise) =>
               // Reject the async function call
               return HandledPromise.reject(
                 assert.error(
-                  X`Unexpected receiver for "${propertyKey}" method of E(${q(
+                  X`Unexpected receiver for "${q(propertyKey)}" method of E(${q(
                     recipient,
                   )})`,
                 ),

packages/exo/package.json

@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@endo/common": "^1.0.2",
+    "@endo/errors": "^1.0.2",
     "@endo/env-options": "^1.1.0",
     "@endo/eventual-send": "^1.1.0",
     "@endo/far": "^1.0.2",

packages/exo/src/exo-makers.js

@@ -2,9 +2,9 @@
 import { environmentOptionsListHas } from '@endo/env-options';
 import { objectMap } from '@endo/common/object-map.js';
 
+import { Fail, q } from '@endo/errors';
 import { defendPrototype, defendPrototypeKit } from './exo-tools.js';
 
-const { Fail, quote: q } = assert;
 const { create, seal, freeze, defineProperty, values } = Object;
 
 // Turn on to give each exo instance its own toStringTag value.

packages/exo/src/exo-tools.js

@@ -13,6 +13,7 @@ import {
 } from '@endo/patterns';
 import { listDifference } from '@endo/common/list-difference.js';
 import { objectMap } from '@endo/common/object-map.js';
+import { q, Fail } from '@endo/errors';
 import { GET_INTERFACE_GUARD } from './get-interface.js';
 
 /** @typedef {import('@endo/patterns').Method} Method */
@@ -23,7 +24,6 @@ import { GET_INTERFACE_GUARD } from './get-interface.js';
  * @typedef {import('@endo/patterns').InterfaceGuard<T>} InterfaceGuard
  */
 
-const { quote: q, Fail } = assert;
 const { apply, ownKeys } = Reflect;
 const { defineProperties, fromEntries } = Object;
 

packages/exo/test/test-exo-wobbly-point.js

@@ -14,10 +14,11 @@ import { test } from './prepare-test-env-ava.js';
 import { getMethodNames } from '@endo/eventual-send/utils.js';
 import { passStyleOf, Far, GET_METHOD_NAMES } from '@endo/pass-style';
 import { M } from '@endo/patterns';
-import { defineExoClass } from '../src/exo-makers.js';
+
+import { Fail, q } from '@endo/errors';
 import { GET_INTERFACE_GUARD } from '../src/get-interface.js';
+import { defineExoClass } from '../src/exo-makers.js';
 
-const { Fail, quote: q } = assert;
 const { apply } = Reflect;
 
 const ExoEmptyI = M.interface('ExoEmpty', {});

packages/exo/test/test-label-instances.js

@@ -4,14 +4,14 @@ import { test } from './prepare-test-env-ava-label-instances.js';
 // eslint-disable-next-line import/order
 import { passStyleOf } from '@endo/far';
 import { M } from '@endo/patterns';
+
+import { q } from '@endo/errors';
 import {
   defineExoClass,
   defineExoClassKit,
   makeExo,
 } from '../src/exo-makers.js';
 
-const { quote: q } = assert;
-
 const UpCounterI = M.interface('UpCounter', {
   incr: M.call().returns(M.number()),
 });

packages/far/package.json

@@ -32,6 +32,7 @@
   },
   "homepage": "https://github.com/endojs/endo#readme",
   "dependencies": {
+    "@endo/errors": "^1.0.2",
     "@endo/eventual-send": "^1.1.0",
     "@endo/pass-style": "^1.1.0"
   },

packages/far/test/test-marshal-far-obj.js

@@ -1,10 +1,11 @@
 // @ts-check
-
 import { test } from './prepare-test-env-ava.js';
 
+// eslint-disable-next-line import/order
+import { q } from '@endo/errors';
+
 import { Far, passStyleOf, getInterfaceOf } from '../src/index.js';
 
-const { quote: q } = assert;
 const { create, getPrototypeOf } = Object;
 
 // this only includes the tests that do not use liveSlots

packages/import-bundle/package.json

@@ -29,6 +29,7 @@
   "dependencies": {
     "@endo/base64": "^1.0.1",
     "@endo/compartment-mapper": "^1.1.0",
+    "@endo/errors": "^1.0.2",
     "@endo/where": "^1.0.1",
     "ses": "^1.1.0"
   },

packages/import-bundle/src/index.js

@@ -7,10 +7,9 @@
 
 import { parseArchive } from '@endo/compartment-mapper/import-archive.js';
 import { decodeBase64 } from '@endo/base64';
+import { Fail } from '@endo/errors';
 import { wrapInescapableCompartment } from './compartment-wrapper.js';
 
-const { Fail } = assert;
-
 // importBundle takes the output of bundle-source, and returns a namespace
 // object (with .default, and maybe other properties for named exports)
 

packages/lp32/package.json

@@ -49,6 +49,7 @@
     "test": "ava"
   },
   "dependencies": {
+    "@endo/errors": "^1.0.2",
     "@endo/init": "^1.0.2",
     "@endo/stream": "^1.0.2",
     "ses": "^1.1.0"

packages/lp32/reader.js

@@ -4,10 +4,9 @@
 // We use a DataView to give users choice over endianness.
 // But DataView does not default to host-byte-order like other typed arrays.
 
+import { Fail, q } from '@endo/errors';
 import { hostIsLittleEndian } from './src/host-endian.js';
 
-const { Fail, quote: q } = assert;
-
 /**
  * @param {Iterable<Uint8Array> | AsyncIterable<Uint8Array>} reader
  * @param {object} opts

packages/lp32/writer.js

@@ -1,10 +1,9 @@
 // @ts-check
 /// <reference types="ses"/>
 
+import { Fail, q } from '@endo/errors';
 import { hostIsLittleEndian } from './src/host-endian.js';
 
-const { Fail, quote: q } = assert;
-
 /**
  * @param {import('@endo/stream').Writer<Uint8Array, undefined>} output
  * @param {object} opts

packages/marshal/package.json

@@ -40,6 +40,7 @@
   },
   "homepage": "https://github.com/endojs/endo#readme",
   "dependencies": {
+    "@endo/errors": "^1.0.2",
     "@endo/eventual-send": "^1.1.0",
     "@endo/nat": "^5.0.2",
     "@endo/pass-style": "^1.1.0",

packages/marshal/src/deeplyFulfilled.js

@@ -7,7 +7,8 @@ import { getTag, isObject, makeTagged, passStyleOf } from '@endo/pass-style';
 /** @typedef {import('@endo/pass-style').Passable} Passable */
 /** @template T @typedef {import('@endo/eventual-send').ERef<T>} ERef */
 
-const { details: X, quote: q } = assert;
+import { X, q } from '@endo/errors';
+
 const { ownKeys } = Reflect;
 const { fromEntries } = Object;
 

packages/marshal/src/dot-membrane.js

@@ -3,11 +3,11 @@
 
 import { E } from '@endo/eventual-send';
 import { isObject, getInterfaceOf, Far, passStyleOf } from '@endo/pass-style';
+import { Fail } from '@endo/errors';
 import { makeMarshal } from './marshal.js';
 
 const { fromEntries } = Object;
 const { ownKeys } = Reflect;
-const { Fail } = assert;
 
 // TODO(erights): Add Converter type
 /** @param {any} [mirrorConverter] */

packages/marshal/src/encodePassable.js

@@ -18,7 +18,8 @@ import {
  */
 /** @typedef {import('./types.js').RankCover} RankCover */
 
-const { quote: q, Fail } = assert;
+import { q, Fail } from '@endo/errors';
+
 const { fromEntries, is } = Object;
 const { ownKeys } = Reflect;