refactor(exo): break GET_INTERFACE_GUARD loop

endojs · Oct 27, 2023 · 263254a · 263254a
1 parent aceca1a
commit 263254a
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 33 deletions.
diff --git a/packages/exo/index.js b/packages/exo/index.js
@@ -5,4 +5,4 @@ export {
   makeExo,
 } from './src/exo-makers.js';
 
-export { GET_INTERFACE_GUARD } from './src/exo-tools.js';
+export { GET_INTERFACE_GUARD } from './src/get-interface.js';
diff --git a/packages/exo/src/exo-makers.js b/packages/exo/src/exo-makers.js
@@ -3,14 +3,7 @@
 import { makeEnvironmentCaptor } from '@endo/env-options';
 import { objectMap } from '@endo/patterns';
 
-import {
-  GET_INTERFACE_GUARD,
-  defendPrototype,
-  defendPrototypeKit,
-} from './exo-tools.js';
-
-// Used in typing.
-GET_INTERFACE_GUARD;
+import { defendPrototype, defendPrototypeKit } from './exo-tools.js';
 
 const { create, seal, freeze, defineProperty, values } = Object;
 
@@ -102,14 +95,7 @@ export const initEmpty = () => emptyRecord;
 
 /**
  * @template {Methods} M
- * @typedef {{
- *   [GET_INTERFACE_GUARD]: () => InterfaceGuard<{ [K in keyof M]: MethodGuard }>
- * }} GetInterfaceGuard
- */
-
-/**
- * @template {Methods} M
- * @typedef {Farable<M & GetInterfaceGuard<M>>} Facet
+ * @typedef {Farable<M & import('./get-interface.js').GetInterfaceGuard<M>>} Facet
  */
 
 /**

diff --git a/packages/exo/src/exo-tools.js b/packages/exo/src/exo-tools.js
@@ -13,6 +13,8 @@ import {
   getCopyMapEntries,
 } from '@endo/patterns';
 
+import { GET_INTERFACE_GUARD } from './get-interface.js';
+
 /** @typedef {import('@endo/patterns').Method} Method */
 /** @typedef {import('@endo/patterns').MethodGuard} MethodGuard */
 /** @typedef {import('@endo/patterns').MethodGuardPayload} MethodGuardPayload */
@@ -348,24 +350,12 @@ const bindMethod = (
   return method;
 };
 
-/**
- * The name of the automatically added default meta-method for
- * obtaining an exo's interface, if it has one.
- *
- * TODO Name to be bikeshed. Perhaps even whether it is a
- * string or symbol to be bikeshed.
- *
- * TODO Beware that an exo's interface can change across an upgrade,
- * so remotes that cache it can become stale.
- */
-export const GET_INTERFACE_GUARD = Symbol.for('getInterfaceGuard');
-
 /**
  *
  * @template {Record<PropertyKey, CallableFunction>} T
  * @param {T} behaviorMethods
  * @param {InterfaceGuard<{ [M in keyof T]: MethodGuard }>} interfaceGuard
- * @returns {T & { [GET_INTERFACE_GUARD]: () => InterfaceGuard<{ [M in keyof T]: MethodGuard }> }}
+ * @returns {T & import('./get-interface.js').GetInterfaceGuard<T>}
  */
 const withGetInterfaceGuardMethod = (behaviorMethods, interfaceGuard) =>
   harden({
@@ -448,7 +438,7 @@ export const defendPrototype = (
 
   return Far(
     tag,
-    /** @type {T & { [GET_INTERFACE_GUARD]: () => InterfaceGuard<{ [M in keyof T]: MethodGuard }>}} */ (
+    /** @type {T & import('./get-interface.js').GetInterfaceGuard<T>} */ (
       prototype
     ),
   );

diff --git a/packages/exo/src/get-interface.js b/packages/exo/src/get-interface.js
@@ -0,0 +1,22 @@
+// @ts-check
+
+/**
+ * The name of the automatically added default meta-method for
+ * obtaining an exo's interface, if it has one.
+ *
+ * TODO Name to be bikeshed. Perhaps even whether it is a
+ * string or symbol to be bikeshed.
+ *
+ * TODO Beware that an exo's interface can change across an upgrade,
+ * so remotes that cache it can become stale.
+ */
+export const GET_INTERFACE_GUARD = Symbol.for('getInterfaceGuard');
+
+/**
+ * @template {Record<PropertyKey, CallableFunction>} M
+ * @typedef {{
+ *   [GET_INTERFACE_GUARD]: () => import('@endo/patterns').InterfaceGuard<{
+ *     [K in keyof M]: import('@endo/patterns').MethodGuard
+ *   }>
+ * }} GetInterfaceGuard
+ */
diff --git a/packages/exo/test/test-heap-classes.js b/packages/exo/test/test-heap-classes.js
@@ -5,11 +5,11 @@ import { test } from './prepare-test-env-ava.js';
 // eslint-disable-next-line import/order
 import { getInterfaceMethodKeys, M } from '@endo/patterns';
 import {
+  GET_INTERFACE_GUARD,
   defineExoClass,
   defineExoClassKit,
   makeExo,
-} from '../src/exo-makers.js';
-import { GET_INTERFACE_GUARD } from '../src/exo-tools.js';
+} from '../index.js';
 
 const NoExtraI = M.interface('NoExtra', {
   foo: M.call().returns(),