fix: prepare for symbol flip

Author: erights

package.json

@@ -42,7 +42,40 @@
   "resolutions": {
     "**/protobufjs": "^7.2.6",
     "**/@types/estree": "^1.0.0",
-    "@endo/eslint-plugin/typescript-eslint": "^8.31.0"
+    "@endo/eslint-plugin/typescript-eslint": "^8.31.0",
+    "**/@endo/base64": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/base64/endo-base64-v1.0.9-e26aa4bbfc1648962912233c4662b3d766048751.tgz",
+    "**/@endo/bundle-source": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/bundle-source/endo-bundle-source-v4.0.0-04e6a272c4acdc1d68899f2d2efae2233bd81a58.tgz",
+    "**/@endo/captp": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/captp/endo-captp-v4.4.5-a2788c80dd253c4ef480abc4e2d87883182f1daf.tgz",
+    "**/@endo/check-bundle": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/check-bundle/endo-check-bundle-v1.0.14-f89647f5f5b3906df7218872561f37ff1f8eec94.tgz",
+    "**/@endo/cjs-module-analyzer": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/cjs-module-analyzer/endo-cjs-module-analyzer-v1.0.9-2de795e14e7aa39b54f00adf6f8e93d2d1196af3.tgz",
+    "**/@endo/common": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/common/endo-common-v1.2.10-c5fe99fac1129e51d2beacfc7e410ed06490391d.tgz",
+    "**/@endo/compartment-mapper": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/compartment-mapper/endo-compartment-mapper-v1.6.0-3a3b2e29adb50ba4dd6f69fec516728aa3cc197b.tgz",
+    "**/@endo/env-options": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/env-options/endo-env-options-v1.1.8-e7695ab0eb7c84d86f908afacea2389ee6f3741d.tgz",
+    "**/@endo/errors": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/errors/endo-errors-v1.2.10-927ed2c44e387eac3bf92d24a52038de532193b9.tgz",
+    "**/@endo/eslint-plugin": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/eslint-plugin/endo-eslint-plugin-v2.3.0-9fe4cae97ff010fe808ca3099839fa6bc1646160.tgz",
+    "**/@endo/evasive-transform": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/evasive-transform/endo-evasive-transform-v1.4.0-fa6c29d607bcd379ea44e6f49338e09f2913ae68.tgz",
+    "**/@endo/eventual-send": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/eventual-send/endo-eventual-send-v1.3.1-7fdb18153424f8c43c657ec6a33e020ed43d9cff.tgz",
+    "**/@endo/exo": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/exo/endo-exo-v1.5.9-314be6a2fc87079ad91dc457a54ef65efeb6b54b.tgz",
+    "**/@endo/far": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/far/endo-far-v1.1.11-bb7624c90eaade01314814d4be5c4a1dae551cca.tgz",
+    "**/@endo/import-bundle": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/import-bundle/endo-import-bundle-v1.4.0-e829fe16445bcc2614ebe3a2de32519545e58272.tgz",
+    "**/@endo/init": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/init/endo-init-v1.1.9-4f74fe4fddf0cf7007251e0ead7f019b93914e69.tgz",
+    "**/@endo/lockdown": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/lockdown/endo-lockdown-v1.0.15-9f8e9b1f6104ed87702e06113a14804edba391f4.tgz",
+    "**/@endo/lp32": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/lp32/endo-lp32-v1.1.10-0513b5e165b46d8ef329f9f333af191c35d5d25b.tgz",
+    "**/@endo/marshal": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/marshal/endo-marshal-v1.6.4-86590e81928f519b8d9939fec1a339c8d3f743b4.tgz",
+    "**/@endo/memoize": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/memoize/endo-memoize-v1.1.10-18d8de7c84d08c473f42a9ae6c5a7ff94470ec38.tgz",
+    "**/@endo/module-source": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/module-source/endo-module-source-v1.3.0-9f0803bc8fe4f6de3c07c0eab12d2b7b13aa2d74.tgz",
+    "**/@endo/nat": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/nat/endo-nat-v5.1.0-d9c2518739677e6f1f2db13f717b7264d18f36e1.tgz",
+    "**/@endo/netstring": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/netstring/endo-netstring-v1.0.15-f52cbf2e63199310bd49c68911f8bde3baa293ee.tgz",
+    "**/@endo/pass-style": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/pass-style/endo-pass-style-v1.5.0-bc9eba020fc1539dd9435f0933975c741c8511f4.tgz",
+    "**/@endo/patterns": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/patterns/endo-patterns-v1.5.0-ad8ad75d073ba816fda9620840a4c4932c08b829.tgz",
+    "**/@endo/promise-kit": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/promise-kit/endo-promise-kit-v1.1.10-98a2d71c1ebb7f90407017879bede33113a21889.tgz",
+    "**/@endo/ses-ava": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/ses-ava/endo-ses-ava-v1.2.10-8657afed4d81715d9d748aeec8ede44b1f840a2c.tgz",
+    "**/@endo/stream": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/stream/endo-stream-v1.2.10-d5ab40529af8dae283ce0237db7f003eb7d7db2f.tgz",
+    "**/@endo/stream-node": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/stream-node/endo-stream-node-v1.1.10-596f83c10d7b973fc39859e9005feb061f4ad6b3.tgz",
+    "**/@endo/trampoline": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/trampoline/endo-trampoline-v1.0.3-5c71361c31df46075baec608a4bfd148fb4b456f.tgz",
+    "**/@endo/where": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/where/endo-where-v1.0.9-ce045881698fb212c011438382d30996ca585bd8.tgz",
+    "**/@endo/zip": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/zip/endo-zip-v1.0.9-302a93648d33179d9f93999878badb36db2ac763.tgz",
+    "**/ses": "file:/Users/markmiller/src/ongithub/endojs/endo/packages/ses/ses-v1.12.0-a7972133af5cced0a4d5d72725043e8d52aacd6c.tgz"
   },
   "engines": {
     "node": "^18.12 || ^20.9"

packages/SwingSet/test/promises.test.js

@@ -1,7 +1,9 @@
 // @ts-nocheck
+// eslint-disable-next-line import/order
 import { test } from '../tools/prepare-test-env-ava.js';
 
-// eslint-disable-next-line import/order
+import { passableSymbolForName } from '@agoric/internal';
+import { testFullOrderEQ } from '@agoric/internal/tools/ava-full-order-eq.js';
 import { kser, kslot, kunser } from '@agoric/kmarshal';
 import {
   buildVatController,
@@ -259,7 +261,7 @@ test('local promises are rejected by vat upgrade', async t => {
     return awaitRun(kpid);
   };
 
-  const S = Symbol.for('passable');
+  const S = passableSymbolForName('passable');
   const watcher = await messageToVat('bootstrap', 'createVat', {
     name: 'watcher',
     bundleCapName: 'watcher',
@@ -268,7 +270,7 @@ test('local promises are rejected by vat upgrade', async t => {
   await messageToObject(watcher, 'watchLocalPromise', 'fulfilled', S);
   await messageToObject(watcher, 'watchLocalPromise', 'rejected', undefined, S);
   const v1Settlements = await messageToObject(watcher, 'getSettlements');
-  t.deepEqual(v1Settlements, {
+  testFullOrderEQ(t, v1Settlements, {
     fulfilled: { status: 'fulfilled', value: S },
     rejected: { status: 'rejected', reason: S },
   });
@@ -277,7 +279,7 @@ test('local promises are rejected by vat upgrade', async t => {
     bundleCapName: 'watcher',
   });
   const v2Settlements = await messageToObject(watcher, 'getSettlements');
-  t.deepEqual(v2Settlements, {
+  testFullOrderEQ(t, v2Settlements, {
     fulfilled: { status: 'fulfilled', value: S },
     rejected: { status: 'rejected', reason: S },
     orphaned: {

packages/cosmic-swingset/src/helpers/bufferedStorage.js

@@ -1,4 +1,5 @@
 import { assert, Fail } from '@endo/errors';
+import { unpassableSymbolForName } from '@agoric/internal';
 
 // XXX Do these "StorageAPI" functions belong in their own package?
 
@@ -302,8 +303,8 @@ export function makeBufferedStorage(kvStore, listeners = {}) {
 export const makeReadCachingStorage = kvStore => {
   // In addition to the wrapping write buffer, keep a simple cache of
   // read values for has and get.
-  const deleted = Symbol('deleted');
-  const undef = Symbol('undefined');
+  const deleted = unpassableSymbolForName('deleted');
+  const undef = unpassableSymbolForName('undefined');
   /** @typedef {(typeof deleted) | (typeof undef)} ReadCacheSentinel */
   /** @type {Map<string, T | ReadCacheSentinel>} */
   let cache;
@@ -312,50 +313,51 @@ export const makeReadCachingStorage = kvStore => {
   }
   resetCache();
 
-  /** @type {KVStore<T>} */
-  const storage = harden({
-    has(key) {
-      const value = cache.get(key);
-      if (value !== undefined) {
-        return value !== deleted;
-      } else {
-        const ret = kvStore.has(key);
-        if (!ret) {
-          cache.set(key, deleted);
+  const storage = /** @type {KVStore<T>} */ (
+    harden({
+      has(key) {
+        const value = cache.get(key);
+        if (value !== undefined) {
+          return value !== deleted;
+        } else {
+          const ret = kvStore.has(key);
+          if (!ret) {
+            cache.set(key, deleted);
+          }
+          return ret;
+        }
+      },
+      get(key) {
+        let value = cache.get(key);
+        if (value !== undefined) {
+          return value === deleted || value === undef ? undefined : value;
         }
-        return ret;
-      }
-    },
-    get(key) {
-      let value = cache.get(key);
-      if (value !== undefined) {
-        return value === deleted || value === undef ? undefined : value;
-      }
 
-      // Fetch the value and cache it until the next commit or abort.
-      value = kvStore.get(key);
-      cache.set(key, value === undefined ? undef : value);
-      return value;
-    },
-    set(key, value) {
-      // Set the value and cache it until the next commit or abort (which is
-      // expected immediately, since the buffered wrapper only calls set
-      // *during* a commit).
-      // `undefined` is a valid value technically different than deletion,
-      // depending on how the underlying store does its serialization
-      cache.set(key, value === undefined ? undef : value);
-      kvStore.set(key, value);
-    },
-    delete(key) {
-      // Delete the value and cache the deletion until next commit or abort.
-      // Deletion results in `undefined` on `get`, but `false` on `has`
-      cache.set(key, deleted);
-      kvStore.delete(key);
-    },
-    getNextKey(_previousKey) {
-      throw Error('not implemented');
-    },
-  });
+        // Fetch the value and cache it until the next commit or abort.
+        value = kvStore.get(key);
+        cache.set(key, value === undefined ? undef : value);
+        return value;
+      },
+      set(key, value) {
+        // Set the value and cache it until the next commit or abort (which is
+        // expected immediately, since the buffered wrapper only calls set
+        // *during* a commit).
+        // `undefined` is a valid value technically different than deletion,
+        // depending on how the underlying store does its serialization
+        cache.set(key, value === undefined ? undef : value);
+        kvStore.set(key, value);
+      },
+      delete(key) {
+        // Delete the value and cache the deletion until next commit or abort.
+        // Deletion results in `undefined` on `get`, but `false` on `has`
+        cache.set(key, deleted);
+        kvStore.delete(key);
+      },
+      getNextKey(_previousKey) {
+        throw Error('not implemented');
+      },
+    })
+  );
   const {
     kvStore: buffered,
     commit,

packages/cosmic-swingset/test/export-storage.test.ts

@@ -1,11 +1,13 @@
 import type { TestFn } from 'ava';
 import anyTest from 'ava';
+
+import { unpassableSymbolForName } from '@agoric/internal';
 import { exportStorage } from '../src/export-storage.js';
 
 const test = anyTest as TestFn;
 
 // Export this binding when used by other modules.
-const TestDataKey = Symbol('TestDataKey');
+const TestDataKey = unpassableSymbolForName('TestDataKey');
 
 // Create a local alias, then
 //  - regex replace '\._\b' with '[_]'

packages/import-manager/package.json

@@ -29,6 +29,9 @@
     "url": "https://github.com/Agoric/agoric-sdk/issues"
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
+  "dependencies": {
+    "@agoric/internal": "^0.3.2"
+  },
   "devDependencies": {
     "@agoric/swingset-vat": "^0.32.2",
     "ava": "^5.3.0",

packages/import-manager/test/unitTests/badImports.js

@@ -1,12 +1,13 @@
 // Copyright (C) 2019 Agoric, under Apache License 2.0
 
+import { unpassableSymbolForName } from '@agoric/internal';
 import { importManager } from '../../src/importManager.js';
 import { listIsEmpty, numIsEmpty } from './valueOps.js';
 
 function makeBadImportManager() {
   const mgr = importManager();
   const obj = { numIsEmpty };
-  const fooSym = Symbol('foo');
+  const fooSym = unpassableSymbolForName('foo');
   obj[fooSym] = listIsEmpty;
   return mgr.addExports(obj);
 }

packages/inter-protocol/test/vaultFactory/driver.js

@@ -1,5 +1,11 @@
 import { AmountMath, makeIssuerKit } from '@agoric/ertp';
-import { allValues, makeTracer, NonNullish, objectMap } from '@agoric/internal';
+import {
+  allValues,
+  makeTracer,
+  NonNullish,
+  objectMap,
+  unpassableSymbolForName,
+} from '@agoric/internal';
 import { makeNotifierFromSubscriber } from '@agoric/notifier';
 import { unsafeMakeBundleCache } from '@agoric/swingset-vat/tools/bundleTool.js';
 import {
@@ -38,7 +44,11 @@ import {
 
 const trace = makeTracer('VFDriver');
 
-export const AT_NEXT = Symbol('AT_NEXT');
+// TODO What does it mean to type something to the typeof itself?
+// That was the inferred type when the right hand side was `Symbol('AT_NEXT')`
+export const AT_NEXT = /** @type {typeof AT_NEXT} */ (
+  unpassableSymbolForName('AT_NEXT')
+);
 
 export const BASIS_POINTS = 10000n;
 

packages/internal/src/ses-utils.js

@@ -9,6 +9,7 @@ import { objectMap } from '@endo/common/object-map.js';
 import { objectMetaMap } from '@endo/common/object-meta-map.js';
 import { fromUniqueEntries } from '@endo/common/from-unique-entries.js';
 import { q, Fail, makeError, annotateError, X } from '@endo/errors';
+import { passableSymbolForName as psfn } from '@endo/pass-style';
 import { deeplyFulfilled, isObject } from '@endo/marshal';
 import { makePromiseKit } from '@endo/promise-kit';
 import { makeQueue } from '@endo/stream';
@@ -420,3 +421,29 @@ export const synchronizedTee = (sourceStream, readerCount) => {
   void pullNext();
   return readers;
 };
+
+/**
+ * An adapter to help transition to flip which symbols are passable. In the endo
+ * release that's current as of this writing, the real `passableSymbolForName`
+ * returns `symbol|undefined`.
+ *
+ * @param {string} name
+ * @returns {symbol}
+ */
+export const passableSymbolForName = name => /** @type {symbol} */ (psfn(name));
+
+const areRegisteredSymbolsPassable =
+  // TODO Symbol should not be a restricted global for @agoric/internal
+  // eslint-disable-next-line no-restricted-globals
+  Symbol.keyFor(passableSymbolForName('x')) === 'x';
+
+/**
+ * An adapter to help transition to flip which symbols are passable.
+ *
+ * @param {string} name
+ * @returns {symbol}
+ */
+export const unpassableSymbolForName = name =>
+  // TODO Symbol should not be a restricted global for @agoric/internal
+  // eslint-disable-next-line no-restricted-globals
+  areRegisteredSymbolsPassable ? Symbol(name) : Symbol.for(name);

packages/internal/test/callback.test.js

@@ -4,6 +4,10 @@ import test from 'ava';
 import { Far } from '@endo/far';
 import { makeHeapZone } from '@agoric/base-zone/heap.js';
 import * as cb from '../src/callback.js';
+import {
+  passableSymbolForName,
+  unpassableSymbolForName,
+} from '../src/ses-utils.js';
 
 /** @import {Callback, SyncCallback} from '../src/types.js' */
 
@@ -50,7 +54,11 @@ test('near function callbacks', t => {
 });
 
 test('near method callbacks', t => {
-  const m2 = Symbol.for('m2');
+  const m2 = passableSymbolForName('m2');
+  // TODO This currently has a symbol-named method. If it passes, it is only
+  // because `o` was not made remotable. Should this test case me deleted,
+  // or should `m2` and its uses be deleted, or should `m2` be converted to
+  // `'m2'`?
   const o = {
     /**
      * @param {number} a
@@ -121,7 +129,6 @@ test('near method callbacks', t => {
 });
 
 test('far method callbacks', async t => {
-  const m2 = Symbol.for('m2');
   const o = Far('MyObject', {
     /**
      * @param {number} a
@@ -139,7 +146,7 @@ test('far method callbacks', async t => {
      * @param {string} c
      * @returns {Promise<string>}
      */
-    [m2]: async (a, b, c) => {
+    m2: async (a, b, c) => {
       return `${a + b}${c}`;
     },
   });
@@ -153,8 +160,8 @@ test('far method callbacks', async t => {
   t.is(await p2r, '19go');
 
   /** @type {Callback<(c: string) => Promise<string>>} */
-  const cbp3 = cb.makeMethodCallback(Promise.resolve(o), m2, 9, 10);
-  t.like(cbp3, { methodName: m2, bound: [9, 10] });
+  const cbp3 = cb.makeMethodCallback(Promise.resolve(o), 'm2', 9, 10);
+  t.like(cbp3, { methodName: 'm2', bound: [9, 10] });
   t.assert(cbp3.target instanceof Promise);
   const p3r = cb.callE(cbp3, 'go');
   t.assert(p3r instanceof Promise);
@@ -236,7 +243,13 @@ test('isCallback', t => {
     'manual method',
   );
   t.true(
-    cb.isCallback({ target: {}, methodName: Symbol.for('foo'), bound: [] }),
+    cb.isCallback({
+      target: {},
+      // TODO if this passes with a symbol-named method, it is because
+      // some relevant object was not made into a remotable.
+      methodName: passableSymbolForName('foo'),
+      bound: [],
+    }),
     'manual symbol-keyed method',
   );
 
@@ -249,7 +262,11 @@ test('isCallback', t => {
     'non-object target',
   );
   t.false(
-    cb.isCallback({ target: {}, methodName: Symbol('foo'), bound: [] }),
+    cb.isCallback({
+      target: {},
+      methodName: unpassableSymbolForName('foo'),
+      bound: [],
+    }),
     'unique symbol method name',
   );
   t.false(cb.isCallback({ target: {}, bound: {} }), 'non-array bound args');

packages/internal/test/snapshots/exports.test.js.md

@@ -52,11 +52,13 @@ Generated by [AVA](https://avajs.dev).
       'objectMap',
       'objectMapMutable',
       'objectMetaMap',
+      'passableSymbolForName',
       'provideLazyMap',
       'pureDataMarshaller',
       'synchronizedTee',
       'typedEntries',
       'typedMap',
+      'unpassableSymbolForName',
       'unprefixedProperties',
       'untilTrue',
       'whileTrue',