@agoric/cache 0.2.5-pismo-dev-0d5327f.0 → 0.3.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.3.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.2.3...@agoric/cache@0.3.0) (2023-05-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* emit smallcaps-format data in all marshallers
+* remove storeName parameter
+
+### Features
+
+* emit smallcaps-format data in all marshallers ([1753df8](https://github.com/Agoric/agoric-sdk/commit/1753df83465785b5ee71b250770c9b012d750ffc)), closes [#6822](https://github.com/Agoric/agoric-sdk/issues/6822)
+
+
+### Miscellaneous Chores
+
+* remove storeName parameter ([452f9bc](https://github.com/Agoric/agoric-sdk/commit/452f9bc680d4f54bed5608eb0d7cf67d80d87ba0))
+
+
+
 ### [0.2.4](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.2.3...@agoric/cache@0.2.4) (2023-02-17)
 
 **Note:** Version bump only for package @agoric/cache

package/jsconfig.json

@@ -1,20 +1,6 @@
 // This file can contain .js-specific Typescript compiler config.
 {
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "esnext",
-
-    "noEmit": true,
-/*
-    // The following flags are for creating .d.ts files:
-    "noEmit": false,
-    "declaration": true,
-    "emitDeclarationOnly": true,
-*/
-    "downlevelIteration": true,
-    "strictNullChecks": true,
-    "moduleResolution": "node",
-  },
+  "extends": "../../tsconfig.json",
   "include": [
     "*.js",
     "public/**/*.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cache",
-  "version": "0.2.5-pismo-dev-0d5327f.0+0d5327f",
+  "version": "0.3.0",
   "description": "Agoric's simple cache interface",
   "type": "module",
   "main": "src/main.js",
@@ -12,24 +12,24 @@
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc --maxNodeModuleJsDepth 4 -p jsconfig.json",
+    "lint:types": "tsc -p jsconfig.json",
     "lint:eslint": "eslint --ext .js,.ts ."
   },
   "keywords": [],
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/notifier": "0.5.2-pismo-dev-0d5327f.0+0d5327f",
-    "@agoric/store": "0.8.6-pismo-dev-0d5327f.0+0d5327f",
-    "@agoric/vat-data": "0.4.6-pismo-dev-0d5327f.0+0d5327f",
-    "@agoric/vats": "0.13.3-pismo-dev-0d5327f.0+0d5327f",
-    "@endo/far": "^0.2.11",
-    "@endo/marshal": "^0.7.5"
+    "@agoric/internal": "^0.3.0",
+    "@agoric/notifier": "^0.6.0",
+    "@agoric/store": "^0.9.0",
+    "@agoric/vat-data": "^0.5.0",
+    "@endo/far": "^0.2.18",
+    "@endo/marshal": "^0.8.5"
   },
   "devDependencies": {
-    "@agoric/zoe": "0.25.6-pismo-dev-0d5327f.0+0d5327f",
-    "ava": "^4.3.1",
-    "c8": "^7.7.2"
+    "@agoric/zoe": "^0.26.0",
+    "ava": "^5.2.0",
+    "c8": "^7.13.0"
   },
   "publishConfig": {
     "access": "public"
@@ -43,5 +43,5 @@
     ],
     "timeout": "20m"
   },
-  "gitHead": "0d5327f87310cf523834853b0546d0e217f37009"
+  "gitHead": "ea8c1c64911b4c58fb43635b25e17e3d50d0cf2a"
 }

package/src/cache.js

@@ -1,10 +1,9 @@
-// @ts-check
+// @jessie-check
+
 import { E, Far } from '@endo/far';
 
 import { makeScalarStoreCoordinator } from './store.js';
 
-/** @template T @typedef {import('@endo/far').ERef<T>} ERef */
-
 /**
  * @typedef {{ [x: PropertyKey]: any } | string | symbol | bigint | null |
  * undefined | number | ((oldValue: any) => ERef<unknown>)} Update a `newValue`

package/src/main.js

@@ -1,3 +1,5 @@
+// @jessie-check
+
 // eslint-disable-next-line import/export
 export * from './types.js';
 export * from './store.js';

package/src/state.js

@@ -1,6 +1,10 @@
-// @ts-check
+// @jessie-check
 
-/** @typedef {import('./types').State} State */
+/**
+ * @typedef {object} State
+ * @property {bigint} generation
+ * @property {any} value
+ */
 
 /**
  * The ground state for a cache key value is `undefined`.  It is impossible to
@@ -26,7 +30,7 @@ export const makeState = (value, priorState = GROUND_STATE) =>
 /**
  * Wrap a state store to have a default value using the GROUND_STATE
  *
- * @param {MapStore<string, import('./types').State>} stateStore
+ * @param {MapStore<string, import('./state').State>} stateStore
  */
 export const withGroundState = stateStore => ({
   ...stateStore,

package/src/store.js

@@ -1,8 +1,8 @@
-// @ts-check
 import { E, Far } from '@endo/far';
 import { deeplyFulfilled, makeMarshal } from '@endo/marshal';
 import { matches, makeScalarMapStore } from '@agoric/store';
 import { makeScalarBigMapStore } from '@agoric/vat-data';
+import { untilTrue } from '@agoric/internal';
 import { withGroundState, makeState } from './state.js';
 
 import './types.js';
@@ -24,7 +24,9 @@ const makeKeyToString = (sanitize = obj => obj) => {
     return slot;
   };
 
-  const { serialize: keyToJsonable } = makeMarshal(valToSlot);
+  const { toCapData: keyToJsonable } = makeMarshal(valToSlot, undefined, {
+    serializeBodyFormat: 'smallcaps',
+  });
   const keyToString = async keyP => {
     const key = await sanitize(keyP);
     const obj = keyToJsonable(key);
@@ -40,9 +42,9 @@ const makeKeyToString = (sanitize = obj => obj) => {
  * @param {(obj: unknown) => unknown} sanitize Process keys and values with
  * this function before storing them
  * @param {{
- * get(key: string): import('./types').State;
- * set(key: string, value: import('./types').State): void;
- * init(key: string, value: import('./types').State): void;
+ * get(key: string): import('./state').State;
+ * set(key: string, value: import('./state').State): void;
+ * init(key: string, value: import('./state').State): void;
  * }} stateStore
  * @returns {Promise<unknown>} the value of the updated state
  */
@@ -56,8 +58,8 @@ const applyCacheTransaction = async (
   /**
    * Retrieve a potential updated state from the transaction.
    *
-   * @param {import('./types').State} basisState
-   * @returns {Promise<import('./types').State | null>} the updated state, or null if no longer applicable
+   * @param {import('./state').State} basisState
+   * @returns {Promise<import('./state').State | null>} the updated state, or null if no longer applicable
    */
   const getUpdatedState = async basisState => {
     const { value } = basisState;
@@ -77,8 +79,10 @@ const applyCacheTransaction = async (
 
   // Loop until our updated state is fresh wrt our current state.
   basisState = stateStore.get(keyStr);
-  while (updatedState && updatedState.generation <= basisState.generation) {
-    // eslint-disable-next-line no-await-in-loop
+  const untilUpdateSynced = untilTrue(
+    () => !updatedState || updatedState.generation > basisState.generation,
+  );
+  for await (const _ of untilUpdateSynced) {
     updatedState = await getUpdatedState(basisState);
     // AWAIT INTERLEAVING
     basisState = stateStore.get(keyStr);
@@ -104,14 +108,14 @@ const applyCacheTransaction = async (
 };
 
 /**
- * @param {MapStore<string, import('./types').State>} stateStore
+ * @param {MapStore<string, import('./state').State>} stateStore
  * @param {ERef<Marshaller>} marshaller
  * @returns {Promise<string>}
  */
 const stringifyStateStore = async (stateStore, marshaller) => {
   const obj = {};
   for (const [key, value] of stateStore.entries()) {
-    obj[key] = E(marshaller).serialize(value);
+    obj[key] = E(marshaller).toCapData(value);
   }
   return deeplyFulfilled(harden(obj)).then(fulfilledObj =>
     JSON.stringify(fulfilledObj),
@@ -122,7 +126,7 @@ const stringifyStateStore = async (stateStore, marshaller) => {
  * Make a cache coordinator backed by a MapStore.  This coordinator doesn't
  * currently enforce any cache eviction, but that would be a useful feature.
  *
- * @param {MapStore<string, import('./types').State>} [stateStore]
+ * @param {MapStore<string, import('./state').State>} [stateStore]
  * @param {(obj: unknown) => unknown} [sanitize] Process keys and values with
  * this function before storing them. Defaults to deeplyFulfilled.
  */
@@ -167,7 +171,7 @@ export const makeScalarStoreCoordinator = (
 /**
  * Don't write any marshalled value that's older than what's already pushed
  *
- * @param {MapStore<string, import('./types').State>} stateStore
+ * @param {MapStore<string, import('./state').State>} stateStore
  * @param {ERef<Marshaller>} marshaller
  * @param {ERef<StorageNode>} storageNode
  * @returns {<T>(storedValue: T) => Promise<T>}

package/src/types.js

@@ -1,4 +1,4 @@
-// @ts-check
+// @jessie-check
 
 // XXX package factoring debt
 import '@agoric/notifier/exported.js';
@@ -9,12 +9,6 @@ export {};
 
 /** @template T @typedef {import('@endo/far').ERef<T>} ERef */
 
-/**
- * @typedef {object} State
- * @property {bigint} generation
- * @property {any} value
- */
-
 /**
  * @typedef {object} Updater
  * @property {(oldValue: Passable) => unknown} update

package/test/test-mvp.js

@@ -1,4 +1,3 @@
-// @ts-check
 // Must be first to set up globals
 import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 import { M } from '@agoric/store';

package/test/test-storage.js

@@ -1,11 +1,10 @@
-// @ts-check
 // Must be first to set up globals
 // import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 // eslint-disable-next-line import/no-extraneous-dependencies -- XXX
 import '@agoric/swingset-vat/tools/prepare-test-env.js';
 
 import test from 'ava';
-import { makeChainStorageRoot } from '@agoric/vats/src/lib-chainStorage.js';
+import { makeChainStorageRoot } from '@agoric/internal/src/lib-chainStorage.js';
 
 import { Far, makeMarshal } from '@endo/marshal';
 import { M } from '@agoric/store';
@@ -20,6 +19,7 @@ const makeSimpleMarshaller = () => {
   };
   const toVal = slot => vals[slot];
   return makeMarshal(fromVal, toVal, {
+    serializeBodyFormat: 'smallcaps',
     marshalSaveError: err => {
       throw err;
     },
@@ -29,15 +29,13 @@ harden(makeSimpleMarshaller);
 
 const setup = () => {
   const storageNodeState = {};
-  const chainStorage = makeChainStorageRoot(
-    message => {
-      assert(message.key === 'cache');
-      assert(message.method === 'set');
-      storageNodeState.cache = message.value;
-    },
-    'swingset',
-    'cache',
-  );
+  const chainStorage = makeChainStorageRoot(message => {
+    assert(message.method === 'set');
+    assert(message.args.length === 1);
+    const [[path, value]] = message.args;
+    assert(path === 'cache');
+    storageNodeState.cache = value;
+  }, 'cache');
   const cache = makeCache(
     makeChainStorageCoordinator(chainStorage, makeSimpleMarshaller()),
   );
@@ -50,8 +48,8 @@ test('makeChainStorageCoordinator with non-remote values', async t => {
   t.is(await cache('brandName', 'barbosa'), 'barbosa');
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"brandName\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":"barbosa"}',
+    '{"body":"#\\"brandName\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":"barbosa"}',
       slots: [],
     },
   });
@@ -59,12 +57,12 @@ test('makeChainStorageCoordinator with non-remote values', async t => {
   // One-time initialization (of 'frotz')
   t.is(await cache('frotz', 'default'), 'default');
   const afterFirstFrotz = {
-    '{"body":"\\"brandName\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":"barbosa"}',
+    '{"body":"#\\"brandName\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":"barbosa"}',
       slots: [],
     },
-    '{"body":"\\"frotz\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":"default"}',
+    '{"body":"#\\"frotz\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":"default"}',
       slots: [],
     },
   };
@@ -86,8 +84,8 @@ test('makeChainStorageCoordinator with non-remote values', async t => {
   );
   t.deepEqual(JSON.parse(storageNodeState.cache), {
     ...afterFirstFrotz,
-    '{"body":"[\\"complex\\",\\"passable\\"]","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":{"arr":["hi","there"],"big":{"@qclass":"bigint","digits":"1"},"num":53,"str":"string"}}',
+    '{"body":"#[\\"complex\\",\\"passable\\"]","slots":[]}': {
+      body: '#{"generation":"+1","value":{"arr":["hi","there"],"big":"+1","num":53,"str":"string"}}',
       slots: [],
     },
   });
@@ -101,8 +99,8 @@ test('makeChainStorageCoordinator with remote values', async t => {
   t.is(await cache('brand', farThing), farThing);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"brand\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":{"@qclass":"slot","iface":"Alleged: farThing","index":0}}',
+    '{"body":"#\\"brand\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":"$0.Alleged: farThing"}',
       slots: [0],
     },
   });
@@ -117,8 +115,8 @@ test('makeChainStorageCoordinator with updater', async t => {
   t.is(await cache('counter', increment), 1);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"counter\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":1}',
+    '{"body":"#\\"counter\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":1}',
       slots: [],
     },
   });
@@ -127,8 +125,8 @@ test('makeChainStorageCoordinator with updater', async t => {
   t.is(await cache('counter', increment), 1);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"counter\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":1}',
+    '{"body":"#\\"counter\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":1}',
       slots: [],
     },
   });
@@ -137,8 +135,8 @@ test('makeChainStorageCoordinator with updater', async t => {
   t.is(await cache('counter', increment, M.any()), 2);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"counter\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"2"},"value":2}',
+    '{"body":"#\\"counter\\"","slots":[]}': {
+      body: '#{"generation":"+2","value":2}',
       slots: [],
     },
   });
@@ -158,8 +156,8 @@ test('makeChainStorageCoordinator with remote updater', async t => {
   t.is(await cache('counter', counterObj.increment), 1);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"counter\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":1}',
+    '{"body":"#\\"counter\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":1}',
       slots: [],
     },
   });
@@ -169,8 +167,8 @@ test('makeChainStorageCoordinator with remote updater', async t => {
   t.is(counter, 1);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"counter\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"1"},"value":1}',
+    '{"body":"#\\"counter\\"","slots":[]}': {
+      body: '#{"generation":"+1","value":1}',
       slots: [],
     },
   });
@@ -180,8 +178,8 @@ test('makeChainStorageCoordinator with remote updater', async t => {
   t.is(counter, 2);
   t.deepEqual(Object.keys(storageNodeState), ['cache']);
   t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"\\"counter\\"","slots":[]}': {
-      body: '{"generation":{"@qclass":"bigint","digits":"2"},"value":2}',
+    '{"body":"#\\"counter\\"","slots":[]}': {
+      body: '#{"generation":"+2","value":2}',
       slots: [],
     },
   });