@agoric/internal 0.2.2-dev-1d8923b.0 → 0.2.2-dev-b71d61c.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.2.2-dev-1d8923b.0+1d8923b",
+  "version": "0.2.2-dev-b71d61c.0+b71d61c",
   "description": "Externally unsupported utilities internal to agoric-sdk",
   "type": "module",
   "main": "src/index.js",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1d8923b97d65c6699ea4e3d91925379fca6be281"
+  "gitHead": "b71d61c60027c0400c288c5324b572cae20eb089"
 }

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./config.js";
 export * from "./debug.js";
 export * from "./utils.js";
+export * from "./method-tools.js";
 //# sourceMappingURL=index.d.ts.map

package/src/index.js

@@ -3,3 +3,4 @@
 export * from './config.js';
 export * from './debug.js';
 export * from './utils.js';
+export * from './method-tools.js';

package/src/method-tools.d.ts

@@ -0,0 +1,4 @@
+export function getMethodNames(val: any): (string | symbol)[];
+export function bindAllMethods(obj: Remotable): Remotable;
+export type Remotable = import('@endo/marshal/src/types').Remotable;
+//# sourceMappingURL=method-tools.d.ts.map

package/src/method-tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"method-tools.d.ts","sourceRoot":"","sources":["method-tools.js"],"names":[],"mappings":"AA0CO,oCAHI,GAAG,GACD,CAAC,MAAM,GAAC,MAAM,CAAC,EAAE,CAqB7B;AA+BM,oCAHI,SAAS,GACP,SAAS,CAiBnB;wBAhGW,OAAO,yBAAyB,EAAE,SAAS"}

package/src/method-tools.js

@@ -0,0 +1,109 @@
+// @ts-check
+import { isObject } from '@endo/marshal';
+
+/**
+ * @file method-tools use dynamic property lookup, which is not Jessie-compatible
+ */
+
+const { getPrototypeOf, create, fromEntries, getOwnPropertyDescriptors } =
+  Object;
+const { ownKeys, apply } = Reflect;
+
+/** @typedef {import('@endo/marshal/src/types').Remotable} Remotable */
+
+/**
+ * Prioritize symbols as earlier than strings.
+ *
+ * @param {string|symbol} a
+ * @param {string|symbol} b
+ * @returns {-1 | 0 | 1}
+ */
+const compareStringified = (a, b) => {
+  if (typeof a === typeof b) {
+    const left = String(a);
+    const right = String(b);
+    // eslint-disable-next-line no-nested-ternary
+    return left < right ? -1 : left > right ? 1 : 0;
+  }
+  if (typeof a === 'symbol') {
+    assert(typeof b === 'string');
+    return -1;
+  }
+  assert(typeof a === 'string');
+  assert(typeof b === 'symbol');
+  return 1;
+};
+
+/**
+ * TODO Consolidate with the `getMethodNames` in `@endo/eventual-send`
+ *
+ * @param {any} val
+ * @returns {(string|symbol)[]}
+ */
+export const getMethodNames = val => {
+  let layer = val;
+  const names = new Set(); // Set to deduplicate
+  while (layer !== null && layer !== Object.prototype) {
+    // be tolerant of non-objects
+    const descs = getOwnPropertyDescriptors(layer);
+    for (const name of ownKeys(descs)) {
+      // In case a method is overridden by a non-method,
+      // test `val[name]` rather than `layer[name]`
+      if (typeof val[name] === 'function') {
+        names.add(name);
+      }
+    }
+    if (!isObject(val)) {
+      break;
+    }
+    layer = getPrototypeOf(layer);
+  }
+  return harden([...names].sort(compareStringified));
+};
+harden(getMethodNames);
+
+/**
+ * TODO This function exists only to ease the
+ * https://github.com/Agoric/agoric-sdk/pull/5970 transition, from all methods
+ * being own properties to methods being inherited from a common prototype.
+ * This transition breaks two patterns used in prior code: autobinding,
+ * and enumerating methods by enumerating own properties. For both, the
+ * preferred repairs are
+ *    * autobinding: Replace, for example,
+ *      `foo(obj.method)` with `foo(arg => `obj.method(arg))`. IOW, stop relying
+ *      on expressions like `obj.method` to extract a method still bound to the
+ *      state of `obj` because, for virtual and durable objects,
+ *      they no longer will after #5970.
+ *    * method enumeration: Replace, for example
+ *      `Reflect.ownKeys(obj)` with `getMethodNames(obj)`.
+ *
+ * Once all problematic cases have been converted in this manner, this
+ * `bindAllMethods` hack can and TODO should be deleted. However, we currently
+ * have no reliable static way to track down and fix all autobinding sites.
+ * For those objects that have not yet been fully repaired by the above two
+ * techniques, `bindAllMethods` creates an object that acts much like the
+ * pre-#5970 objects, with all their methods as instance-bound own properties.
+ * It does this by making a new object inheriting from `obj` where the new
+ * object has bound own methods overridding all the methods it would have
+ * inherited from `obj`.
+ *
+ * @param {Remotable} obj
+ * @returns {Remotable}
+ */
+export const bindAllMethods = obj =>
+  harden(
+    create(
+      obj,
+      fromEntries(
+        getMethodNames(obj).map(name => [
+          name,
+          {
+            value: (/** @type {unknown[]} */ ...args) =>
+              apply(obj[name], obj, args),
+            enumerable: true,
+          },
+        ]),
+      ),
+    ),
+  );
+harden(bindAllMethods);

package/src/utils.d.ts

@@ -3,8 +3,6 @@ export function objectMap<O extends Record<string, any>, R>(original: O, mapFn:
 export function listDifference(leftNames: Array<string | symbol>, rightNames: Array<string | symbol>): (string | symbol)[];
 export function throwLabeled(innerErr: Error, label: string | number, ErrorConstructor?: ErrorConstructor | undefined): never;
 export function applyLabelingError<A, R>(func: (...args: A[]) => R, args: A[], label?: string | number | undefined): R;
-export function getMethodNames(val: any): (string | symbol)[];
-export function bindAllMethods(obj: Remotable): Remotable;
 /**
  * @template T
  * @typedef {{[KeyType in keyof T]: T[KeyType]} & {}} Simplify
@@ -34,7 +32,7 @@ export function makeMeasureSeconds(currentTimeMillisec: typeof import('perf_hook
     duration: number;
 }>;
 export function makeAggregateError(errors: Error[], message?: string | undefined): Error;
-export function PromiseAllOrErrors<T>(values: readonly (T | PromiseLike<T>)[]): Promise<T[]>;
+export function PromiseAllOrErrors<T>(items: readonly (T | PromiseLike<T>)[]): Promise<T[]>;
 /**
  * @type {<T>(
  *   trier: () => Promise<T>,
@@ -45,7 +43,14 @@ export function assertAllDefined<T extends Record<string, unknown>>(obj: T): ass
 export const forever: AsyncIterable<undefined>;
 export function whileTrue<T>(produce: () => T): AsyncIterable<Awaited<T>>;
 export function untilTrue<T>(produce: () => T): AsyncIterable<Awaited<T>>;
-export type Remotable = import('@endo/marshal/src/types').Remotable;
+/** @type { <X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
+export const zip: <X, Y>(xs: X[], ys: Y[]) => [X, Y][];
+/** @type { <T extends Record<string, ERef<any>>>(obj: T) => Promise<{ [K in keyof T]: Awaited<T[K]>}> } */
+export const allValues: <T extends Record<string, any>>(obj: T) => Promise<{ [K in keyof T]: Awaited<T[K]>; }>;
+/**
+ * <T>
+ */
+export type ERef<T> = import('@endo/eventual-send').ERef<T>;
 /**
  * flatten the type output to improve type hints shown in editors
  * https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts

package/src/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AA4BO,0EAcN;AA0CM,gJAIN;AAQM,0CAHI,MAAM,MAAM,GAAG,MAAM,CAAC,cACtB,MAAM,MAAM,GAAG,MAAM,CAAC,uBAKhC;AASM,uCALI,KAAK,SACL,MAAM,GAAC,MAAM,oDAEX,KAAK,CAYjB;AAUM,uHAsBN;AAgCM,oCAHI,GAAG,GACD,CAAC,MAAM,GAAC,MAAM,CAAC,EAAE,CAqB7B;AA+BM,oCAHI,SAAS,GACP,SAAS,CAiBnB;AAGH;;;;;GAKG;AAEH;;GAEG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;GAKG;AACH,sHAGE;AAUK,wDAHI,cAAc,YAAY,EAAE,WAAW,CAAC,GAAG;;cACmB,MAAM;GAW9E;AAMM,2CAHI,KAAK,EAAE,uCAcjB;AAOM,6FAeN;AAED;;;;;GAKG,CAAC,mFAFoB,OAAO,KAAK,QAAQ,IAAI,CAAC,gBAY7C;AAiBG,0GAUN;AAQD,+CAAoD;AAU7C,0EAUH;AAUG,0EAaH;wBA3aU,OAAO,yBAAyB,EAAE,SAAS;;;;;;iCA4PlC,GAAG,EAAE,KAAK,GAAG;;+BAUvB,CAAC,SAAS,YAAY,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAuBO,0EAcN;AA0CM,gJAIN;AAQM,0CAHI,MAAM,MAAM,GAAG,MAAM,CAAC,cACtB,MAAM,MAAM,GAAG,MAAM,CAAC,uBAKhC;AASM,uCALI,KAAK,SACL,MAAM,GAAC,MAAM,oDAEX,KAAK,CAYjB;AAUM,uHAsBN;AAGD;;;;;GAKG;AAEH;;GAEG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;GAKG;AACH,sHAGE;AAUK,wDAHI,cAAc,YAAY,EAAE,WAAW,CAAC,GAAG;;cACmB,MAAM;GAW9E;AAMM,2CAHI,KAAK,EAAE,uCAcjB;AAOM,4FAeN;AAED;;;;;GAKG,CAAC,mFAFoB,OAAO,KAAK,QAAQ,IAAI,CAAC,gBAY7C;AAiBG,0GAUN;AAQD,+CAAoD;AAU7C,0EAUH;AAUG,0EAaH;AAEJ,oDAAoD;AACpD,uDAAqE;AAErE,2GAA2G;AAC3G,+GAIE;;;;sBAzUwB,OAAO,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;;;;;;iCAgJxC,GAAG,EAAE,KAAK,GAAG;;+BAUvB,CAAC,SAAS,YAAY,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC"}

package/src/utils.js

@@ -1,22 +1,17 @@
 // @ts-check
+// @jessie-check
 import { E } from '@endo/eventual-send';
 import { deeplyFulfilled, isObject } from '@endo/marshal';
 import { isPromise } from '@endo/promise-kit';
-import { asyncGenerate } from 'jessie.js';
+import { asyncGenerate, makeSet } from 'jessie.js';
 
-/** @typedef {import('@endo/marshal/src/types').Remotable} Remotable */
-
-const {
-  getPrototypeOf,
-  create,
-  entries,
-  fromEntries,
-  getOwnPropertyDescriptors,
-} = Object;
-const { ownKeys, apply } = Reflect;
+const { entries, fromEntries, keys, values } = Object;
+const { ownKeys } = Reflect;
 
 const { details: X, quote: q, Fail } = assert;
 
+/** @template T @typedef {import('@endo/eventual-send').ERef<T>} ERef<T> */
+
 /**
  * Throws if multiple entries use the same property name. Otherwise acts
  * like `Object.fromEntries` but hardens the result.
@@ -32,7 +27,7 @@ export const fromUniqueEntries = allEntries => {
   if (ownKeys(result).length === entriesArray.length) {
     return result;
   }
-  const names = new Set();
+  const names = makeSet();
   for (const [name, _] of entriesArray) {
     if (names.has(name)) {
       Fail`collision on property name ${q(name)}: ${entriesArray}`;
@@ -95,7 +90,7 @@ harden(objectMap);
  * @param {Array<string | symbol>} rightNames
  */
 export const listDifference = (leftNames, rightNames) => {
-  const rightSet = new Set(rightNames);
+  const rightSet = makeSet(rightNames);
   return leftNames.filter(name => !rightSet.has(name));
 };
 harden(listDifference);
@@ -151,103 +146,6 @@ export const applyLabelingError = (func, args, label = undefined) => {
 };
 harden(applyLabelingError);
 
-/**
- * Prioritize symbols as earlier than strings.
- *
- * @param {string|symbol} a
- * @param {string|symbol} b
- * @returns {-1 | 0 | 1}
- */
-const compareStringified = (a, b) => {
-  if (typeof a === typeof b) {
-    const left = String(a);
-    const right = String(b);
-    // eslint-disable-next-line no-nested-ternary
-    return left < right ? -1 : left > right ? 1 : 0;
-  }
-  if (typeof a === 'symbol') {
-    assert(typeof b === 'string');
-    return -1;
-  }
-  assert(typeof a === 'string');
-  assert(typeof b === 'symbol');
-  return 1;
-};
-
-/**
- * TODO Consolidate with the `getMethodNames` in `@endo/eventual-send`
- *
- * @param {any} val
- * @returns {(string|symbol)[]}
- */
-export const getMethodNames = val => {
-  let layer = val;
-  const names = new Set(); // Set to deduplicate
-  while (layer !== null && layer !== Object.prototype) {
-    // be tolerant of non-objects
-    const descs = getOwnPropertyDescriptors(layer);
-    for (const name of ownKeys(descs)) {
-      // In case a method is overridden by a non-method,
-      // test `val[name]` rather than `layer[name]`
-      if (typeof val[name] === 'function') {
-        names.add(name);
-      }
-    }
-    if (!isObject(val)) {
-      break;
-    }
-    layer = getPrototypeOf(layer);
-  }
-  return harden([...names].sort(compareStringified));
-};
-harden(getMethodNames);
-
-/**
- * TODO This function exists only to ease the
- * https://github.com/Agoric/agoric-sdk/pull/5970 transition, from all methods
- * being own properties to methods being inherited from a common prototype.
- * This transition breaks two patterns used in prior code: autobinding,
- * and enumerating methods by enumerating own properties. For both, the
- * preferred repairs are
- *    * autobinding: Replace, for example,
- *      `foo(obj.method)` with `foo(arg => `obj.method(arg))`. IOW, stop relying
- *      on expressions like `obj.method` to extract a method still bound to the
- *      state of `obj` because, for virtual and durable objects,
- *      they no longer will after #5970.
- *    * method enumeration: Replace, for example
- *      `Reflect.ownKeys(obj)` with `getMethodNames(obj)`.
- *
- * Once all problematic cases have been converted in this manner, this
- * `bindAllMethods` hack can and TODO should be deleted. However, we currently
- * have no reliable static way to track down and fix all autobinding sites.
- * For those objects that have not yet been fully repaired by the above two
- * techniques, `bindAllMethods` creates an object that acts much like the
- * pre-#5970 objects, with all their methods as instance-bound own properties.
- * It does this by making a new object inheriting from `obj` where the new
- * object has bound own methods overridding all the methods it would have
- * inherited from `obj`.
- *
- * @param {Remotable} obj
- * @returns {Remotable}
- */
-export const bindAllMethods = obj =>
-  harden(
-    create(
-      obj,
-      fromEntries(
-        getMethodNames(obj).map(name => [
-          name,
-          {
-            value: (/** @type {unknown[]} */ ...args) =>
-              apply(obj[name], obj, args),
-            enumerable: true,
-          },
-        ]),
-      ),
-    ),
-  );
-harden(bindAllMethods);
-
 /**
  * @template T
  * @typedef {{[KeyType in keyof T]: T[KeyType]} & {}} Simplify
@@ -304,7 +202,7 @@ export const makeMeasureSeconds = currentTimeMillisec => {
  * @param {string} [message]
  */
 export const makeAggregateError = (errors, message) => {
-  const err = new Error(message);
+  const err = Error(message);
   Object.defineProperties(err, {
     name: {
       value: 'AggregateError',
@@ -318,11 +216,11 @@ export const makeAggregateError = (errors, message) => {
 
 /**
  * @template T
- * @param {readonly (T | PromiseLike<T>)[]} values
+ * @param {readonly (T | PromiseLike<T>)[]} items
  * @returns {Promise<T[]>}
  */
-export const PromiseAllOrErrors = async values => {
-  return Promise.allSettled(values).then(results => {
+export const PromiseAllOrErrors = async items => {
+  return Promise.allSettled(items).then(results => {
     const errors = /** @type {PromiseRejectedResult[]} */ (
       results.filter(({ status }) => status === 'rejected')
     ).map(result => result.reason);
@@ -432,3 +330,13 @@ export const untilTrue = produce =>
       value,
     });
   });
+
+/** @type { <X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
+export const zip = (xs, ys) => harden(xs.map((x, i) => [x, ys[+i]]));
+
+/** @type { <T extends Record<string, ERef<any>>>(obj: T) => Promise<{ [K in keyof T]: Awaited<T[K]>}> } */
+export const allValues = async obj => {
+  const resolved = await Promise.all(values(obj));
+  // @ts-expect-error cast
+  return harden(fromEntries(zip(keys(obj), resolved)));
+};