refactor: refactor-only avoid symbol-named methods

Author: erights

packages/daemon/src/reader-ref.js

@@ -60,9 +60,6 @@ export const makeIteratorRef = iterable => {
       }
       return harden({ done: true, value: undefined });
     },
-    [Symbol.asyncIterator]() {
-      return this;
-    },
   });
 };
 

packages/daemon/src/ref-reader.js

@@ -11,17 +11,18 @@ import { E } from '@endo/far';
  * @param {import('@endo/far').ERef<AsyncIterator<TValue, TReturn, TNext>>} iteratorRef
  */
 export const makeRefIterator = iteratorRef => {
-  const iterator = {
+  const iterator = harden({
     /** @param {[] | [TNext]} args */
     next: async (...args) => E(iteratorRef).next(...args),
     /** @param {[] | [TReturn]} args */
     return: async (...args) => E(iteratorRef).return(...args),
     /** @param {any} error */
     throw: async error => E(iteratorRef).throw(error),
     [Symbol.asyncIterator]: () => iterator,
-  };
+  });
   return iterator;
 };
+harden(makeRefIterator);
 
 /**
  * @param {import('@endo/far').ERef<AsyncIterator<string>>} readerRef

packages/exo/package.json

@@ -43,6 +43,7 @@
   },
   "devDependencies": {
     "@endo/init": "workspace:^",
+    "@endo/marshal": "workspace:^",
     "@endo/ses-ava": "workspace:^",
     "ava": "^6.1.3",
     "babel-eslint": "^10.1.0",

packages/exo/src/exo-tools.js

@@ -1,6 +1,10 @@
-import { getMethodNames } from '@endo/eventual-send/utils.js';
-import { hasOwnPropertyOf, toThrowable } from '@endo/pass-style';
-import { E, Far } from '@endo/far';
+import { E } from '@endo/eventual-send';
+import {
+  getRemotableMethodNames,
+  hasOwnPropertyOf,
+  toThrowable,
+  Far,
+} from '@endo/pass-style';
 import {
   mustMatch,
   M,
@@ -17,8 +21,10 @@ import { q, Fail } from '@endo/errors';
 import { GET_INTERFACE_GUARD } from './get-interface.js';
 
 /**
- * @import {InterfaceGuard, Method, MethodGuard, MethodGuardPayload} from '@endo/patterns'
+ * @import {RemotableMethodName} from '@endo/pass-style';
+ * @import {InterfaceGuard, Method, MethodGuard, MethodGuardPayload, DefaultGuardType} from '@endo/patterns'
  * @import {ClassContext, ContextProvider, FacetName, KitContext, KitContextProvider, MatchConfig, Methods} from './types.js'
+ * @import {GetInterfaceGuard} from './get-interface.js';
  */
 
 const { apply, ownKeys } = Reflect;
@@ -344,7 +350,7 @@ const bindMethod = (
 };
 
 /**
- * @template {Record<PropertyKey, CallableFunction>} T
+ * @template {Record<RemotableMethodName, CallableFunction>} T
  * @param {string} tag
  * @param {ContextProvider} contextProvider
  * @param {T} behaviorMethods
@@ -359,7 +365,7 @@ export const defendPrototype = (
   interfaceGuard = undefined,
 ) => {
   const prototype = {};
-  const methodNames = getMethodNames(behaviorMethods).filter(
+  const methodNames = getRemotableMethodNames(behaviorMethods).filter(
     // By ignoring any method that seems to be a constructor, we can use a
     // class.prototype as a behaviorMethods.
     key => {
@@ -373,9 +379,9 @@ export const defendPrototype = (
       );
     },
   );
-  /** @type {Record<PropertyKey, MethodGuard> | undefined} */
+  /** @type {Record<RemotableMethodName, MethodGuard> | undefined} */
   let methodGuards;
-  /** @type {import('@endo/patterns').DefaultGuardType} */
+  /** @type {DefaultGuardType} */
   let defaultGuards;
   if (interfaceGuard) {
     const {
@@ -461,12 +467,7 @@ export const defendPrototype = (
     );
   }
 
-  return Far(
-    tag,
-    /** @type {T & import('./get-interface.js').GetInterfaceGuard<T>} */ (
-      prototype
-    ),
-  );
+  return Far(tag, /** @type {T & GetInterfaceGuard<T>} */ (prototype));
 };
 harden(defendPrototype);
 

packages/exo/src/get-interface.js

@@ -1,22 +1,24 @@
 // @ts-check
 
+/**
+ * @import {RemotableMethodName} from '@endo/pass-style';
+ */
+
 /**
  * The name of the automatically added default meta-method for
  * obtaining an exo's interface, if it has one.
  *
  * Intended to be similar to `GET_METHOD_NAMES` from `@endo/pass-style`.
  *
- * TODO Name to be bikeshed. Perhaps even whether it is a
- * string or symbol to be bikeshed. See
- * https://github.com/endojs/endo/pull/1809#discussion_r1388052454
+ * See https://github.com/endojs/endo/pull/1809#discussion_r1388052454
  *
- * TODO Beware that an exo's interface can change across an upgrade,
+ * Beware that an exo's interface can change across an upgrade,
  * so remotes that cache it can become stale.
  */
 export const GET_INTERFACE_GUARD = '__getInterfaceGuard__';
 
 /**
- * @template {Record<PropertyKey, CallableFunction>} M
+ * @template {Record<RemotableMethodName, CallableFunction>} M
  * @typedef {{
  *   [GET_INTERFACE_GUARD]?: () =>
  *     import('@endo/patterns').InterfaceGuard<{

packages/exo/src/types.d.ts

@@ -1,5 +1,5 @@
 import type { RemotableBrand } from '@endo/eventual-send';
-import type { RemotableObject } from '@endo/pass-style';
+import type { RemotableObject, RemotableMethodName } from '@endo/pass-style';
 import type { InterfaceGuard, MethodGuard, Pattern } from '@endo/patterns';
 import type { GetInterfaceGuard } from './get-interface.js';
 
@@ -11,7 +11,7 @@ export type MatchConfig = {
   redactedIndices: number[];
 };
 export type FacetName = string;
-export type Methods = Record<PropertyKey, CallableFunction>;
+export type Methods = Record<RemotableMethodName, CallableFunction>;
 export type ClassContext<S = any, M extends Methods = any> = {
   state: S;
   self: M;

packages/exo/test/heap-classes.test.js

@@ -1,7 +1,6 @@
 // @ts-check
 import test from '@endo/ses-ava/prepare-endo.js';
 
-import { passableSymbolForName } from '@endo/pass-style';
 import { getInterfaceMethodKeys, M } from '@endo/patterns';
 import {
   GET_INTERFACE_GUARD,
@@ -81,25 +80,21 @@ test('test defineExoClass', t => {
   t.deepEqual(upCounter[GET_INTERFACE_GUARD]?.(), UpCounterI);
   t.deepEqual(getInterfaceMethodKeys(UpCounterI), ['incr']);
 
-  const symbolic = passableSymbolForName('symbolic');
   const FooI = M.interface('Foo', {
     m: M.call().returns(),
-    [symbolic]: M.call(M.boolean()).returns(),
+    m2: M.call(M.boolean()).returns(),
   });
-  t.deepEqual(getInterfaceMethodKeys(FooI), [
-    'm',
-    passableSymbolForName('symbolic'),
-  ]);
+  t.deepEqual(getInterfaceMethodKeys(FooI), ['m', 'm2']);
   const makeFoo = defineExoClass('Foo', FooI, () => ({}), {
     m() {},
-    [symbolic]() {},
+    m2() {},
   });
   const foo = makeFoo();
   t.deepEqual(foo[GET_INTERFACE_GUARD]?.(), FooI);
   // @ts-expect-error intentional for test
-  t.throws(() => foo[symbolic]('invalid arg'), {
+  t.throws(() => foo.m2('invalid arg'), {
     message:
-      'In "[Symbol(symbolic)]" method of (Foo): arg 0: string "invalid arg" - Must be a boolean',
+      'In "m2" method of (Foo): arg 0: string "invalid arg" - Must be a boolean',
   });
 });
 

packages/exo/test/non-enumerable-methods.test.js

@@ -1,7 +1,6 @@
 import test from '@endo/ses-ava/prepare-endo.js';
 
 import { objectMetaMap } from '@endo/common/object-meta-map.js';
-import { passableSymbolForName } from '@endo/pass-style';
 import { getInterfaceMethodKeys, M } from '@endo/patterns';
 import { defineExoClass } from '../src/exo-makers.js';
 import { GET_INTERFACE_GUARD } from '../src/get-interface.js';
@@ -50,28 +49,24 @@ test('test defineExoClass', t => {
   t.deepEqual(upCounter[GET_INTERFACE_GUARD](), UpCounterI);
   t.deepEqual(getInterfaceMethodKeys(UpCounterI), ['incr']);
 
-  const symbolic = passableSymbolForName('symbolic');
   const FooI = M.interface('Foo', {
     m: M.call().returns(),
-    [symbolic]: M.call(M.boolean()).returns(),
+    m2: M.call(M.boolean()).returns(),
   });
-  t.deepEqual(getInterfaceMethodKeys(FooI), [
-    'm',
-    passableSymbolForName('symbolic'),
-  ]);
+  t.deepEqual(getInterfaceMethodKeys(FooI), ['m', 'm2']);
   const makeFoo = defineExoClass(
     'Foo',
     FooI,
     () => ({}),
     denumerate({
       m() {},
-      [symbolic]() {},
+      m2() {},
     }),
   );
   const foo = makeFoo();
   t.deepEqual(foo[GET_INTERFACE_GUARD](), FooI);
-  t.throws(() => foo[symbolic]('invalid arg'), {
+  t.throws(() => foo.m2('invalid arg'), {
     message:
-      'In "[Symbol(symbolic)]" method of (Foo): arg 0: string "invalid arg" - Must be a boolean',
+      'In "m2" method of (Foo): arg 0: string "invalid arg" - Must be a boolean',
   });
 });

packages/marshal/src/dot-membrane.js

@@ -2,12 +2,21 @@
 /// <reference types="ses"/>
 
 import { E } from '@endo/eventual-send';
-import { isObject, getInterfaceOf, Far, passStyleOf } from '@endo/pass-style';
+import {
+  isObject,
+  getInterfaceOf,
+  Far,
+  passStyleOf,
+  getRemotableMethodNames,
+} from '@endo/pass-style';
 import { Fail } from '@endo/errors';
 import { makeMarshal } from './marshal.js';
 
+/**
+ * @import {RemotableMethodName} from '@endo/pass-style';
+ */
+
 const { fromEntries } = Object;
-const { ownKeys } = Reflect;
 
 // TODO(erights): Add Converter type
 /** @param {any} [mirrorConverter] */
@@ -58,7 +67,7 @@ const makeConverter = (mirrorConverter = undefined) => {
         break;
       }
       case 'remotable': {
-        /** @param {PropertyKey} [optVerb] */
+        /** @param {RemotableMethodName} [optVerb] */
         const myMethodToYours =
           (optVerb = undefined) =>
           (...yourArgs) => {
@@ -91,7 +100,7 @@ const makeConverter = (mirrorConverter = undefined) => {
           // minds.
           yours = Far(iface, myMethodToYours());
         } else {
-          const myMethodNames = ownKeys(mine);
+          const myMethodNames = getRemotableMethodNames(mine);
           const yourMethods = myMethodNames.map(name => [
             name,
             myMethodToYours(name),

packages/marshal/src/marshal-stringify.js

@@ -53,7 +53,7 @@ harden(stringify);
 
 /**
  * @param {string} str
- * @returns {unknown}
+ * @returns {Passable}
  */
 const parse = str =>
   unserialize(

packages/pass-style/index.js

@@ -9,7 +9,7 @@ export {
 
 export { getErrorConstructor, isErrorLike } from './src/error.js';
 
-export { getInterfaceOf } from './src/remotable.js';
+export { getInterfaceOf, getRemotableMethodNames } from './src/remotable.js';
 
 export {
   assertPassableSymbol,

packages/pass-style/src/copyRecord.js

@@ -4,10 +4,10 @@
 
 import {
   assertChecker,
-  canBeMethod,
   getOwnDataDescriptor,
   CX,
 } from './passStyle-helpers.js';
+import { canBeMethod } from './remotable.js';
 
 const { ownKeys } = Reflect;
 const { getPrototypeOf, prototype: objectPrototype } = Object;

packages/pass-style/src/passStyle-helpers.js

@@ -1,7 +1,8 @@
 /// <reference types="ses"/>
 
-/** @import {Checker} from './types.js' */
-/** @import {PassStyle} from './types.js' */
+/**
+ * @import {Checker, PassStyle} from './types.js'
+ */
 
 import { X, q } from '@endo/errors';
 
@@ -48,23 +49,6 @@ harden(isTypedArray);
 
 export const PASS_STYLE = Symbol.for('passStyle');
 
-/**
- * For a function to be a valid method, it must not be passable.
- * Otherwise, we risk confusing pass-by-copy data carrying
- * far functions with attempts at far objects with methods.
- *
- * TODO HAZARD Because we check this on the way to hardening a remotable,
- * we cannot yet check that `func` is hardened. However, without
- * doing so, it's inheritance might change after the `PASS_STYLE`
- * check below.
- *
- * @param {any} func
- * @returns {boolean}
- */
-export const canBeMethod = func =>
-  typeof func === 'function' && !(PASS_STYLE in func);
-harden(canBeMethod);
-
 /**
  * Below we have a series of predicate functions and their (curried) assertion
  * functions. The semantics of the assertion function is just to assert that