@agoric/cache 0.4.0 → 0.4.1-upgrade-23-dev-bd79330.0.bd79330

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cache",
-  "version": "0.4.0",
+  "version": "0.4.1-upgrade-23-dev-bd79330.0.bd79330",
   "description": "Agoric's simple cache interface",
   "type": "module",
   "main": "src/main.js",
@@ -13,24 +13,27 @@
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
     "lint:types": "yarn run -T tsc",
-    "lint:eslint": "yarn run -T eslint ."
+    "lint:eslint": "node ../../scripts/eslint-repo.mjs ."
   },
   "keywords": [],
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "0.4.0",
-    "@agoric/notifier": "0.7.0",
-    "@agoric/store": "0.10.0",
-    "@agoric/vat-data": "0.6.0",
+    "@agoric/internal": "0.4.1-upgrade-23-dev-bd79330.0.bd79330",
+    "@agoric/notifier": "0.7.1-upgrade-23-dev-bd79330.0.bd79330",
+    "@agoric/store": "0.10.1-upgrade-23-dev-bd79330.0.bd79330",
+    "@agoric/vat-data": "0.6.1-upgrade-23-dev-bd79330.0.bd79330",
     "@endo/far": "^1.1.14",
     "@endo/marshal": "^1.8.0"
   },
   "devDependencies": {
-    "@agoric/zoe": "0.27.0",
-    "ava": "^5.3.0",
+    "@agoric/zoe": "0.27.1-upgrade-23-dev-bd79330.0.bd79330",
+    "ava": "^6.4.1",
     "c8": "^10.1.3"
   },
+  "files": [
+    "src"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -49,5 +52,5 @@
   "typeCoverage": {
     "atLeast": 94.13
   },
-  "gitHead": "0922d0447ab8fae9d2d87415964403330b5ca313"
+  "gitHead": "bd79330f78dae2faf9cc3d8b10063567700da07b"
 }

package/src/cache.js

@@ -1,5 +1,3 @@
-// @jessie-check
-
 import { E, Far } from '@endo/far';
 
 import { makeScalarStoreCoordinator } from './store.js';
@@ -7,6 +5,8 @@ import { makeScalarStoreCoordinator } from './store.js';
 /**
  * @import {Passable, RemotableObject} from '@endo/pass-style';
  * @import {Key, Pattern} from '@endo/patterns';
+ * @import {Coordinator} from './types.js';
+ * @import {ERef} from '@endo/far';
  */
 
 /**
@@ -17,7 +17,7 @@ import { makeScalarStoreCoordinator } from './store.js';
  */
 
 /**
- * @param {ERef<import('./types.js').Coordinator>} [coordinator]
+ * @param {ERef<Coordinator>} [coordinator]
  */
 export const makeCache = (coordinator = makeScalarStoreCoordinator()) => {
   /**

package/src/main.js

@@ -1,6 +1,3 @@
-// @jessie-check
-/// <reference types="@agoric/internal/exported" />
-
 // eslint-disable-next-line import/export
 export * from './types.js';
 export * from './store.js';

package/src/state.js

@@ -1,4 +1,7 @@
-// @jessie-check
+/**
+ * @import {State} from './state.js';
+ * @import {MapStore} from '@agoric/store';
+ */
 
 /**
  * @typedef {object} State
@@ -30,7 +33,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('./state.js').State>} stateStore
+ * @param {MapStore<string, State>} stateStore
  */
 export const withGroundState = stateStore => ({
   ...stateStore,

package/src/store.js

@@ -6,8 +6,14 @@ import { untilTrue } from '@agoric/internal';
 import { withGroundState, makeState } from './state.js';
 
 /**
+ * @import {ERemote} from '@agoric/internal'
+ * @import {EMarshaller} from '@agoric/internal/src/marshal/wrap-marshaller.js';
  * @import {Passable, RemotableObject} from '@endo/pass-style';
  * @import {Key, Pattern} from '@endo/patterns';
+ * @import {State} from './state.js';
+ * @import {Coordinator} from './types.js';
+ * @import {StorageNode} from '@agoric/internal/src/lib-chainStorage.js';
+ * @import {MapStore} from '@agoric/store';
  */
 
 /**
@@ -45,9 +51,9 @@ const makeKeyToString = (sanitize = obj => obj) => {
  * @param {(obj: Passable) => Passable} sanitize Process keys and values with
  * this function before storing them
  * @param {{
- * get(key: string): import('./state.js').State;
- * set(key: string, value: import('./state.js').State): void;
- * init(key: string, value: import('./state.js').State): void;
+ * get(key: string): State;
+ * set(key: string, value: State): void;
+ * init(key: string, value: State): void;
  * }} stateStore
  * @returns {Promise<Passable>} the value of the updated state
  */
@@ -61,8 +67,8 @@ const applyCacheTransaction = async (
   /**
    * Retrieve a potential updated state from the transaction.
    *
-   * @param {import('./state.js').State} basisState
-   * @returns {Promise<import('./state.js').State | null>} the updated state, or null if no longer applicable
+   * @param {State} basisState
+   * @returns {Promise<State | null>} the updated state, or null if no longer applicable
    */
   const getUpdatedState = async basisState => {
     const { value } = basisState;
@@ -111,8 +117,8 @@ const applyCacheTransaction = async (
 };
 
 /**
- * @param {MapStore<string, import('./state.js').State>} stateStore
- * @param {ERef<Marshaller>} marshaller
+ * @param {MapStore<string, State>} stateStore
+ * @param {ERemote<EMarshaller>} marshaller
  * @returns {Promise<string>}
  */
 const stringifyStateStore = async (stateStore, marshaller) => {
@@ -130,7 +136,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('./state.js').State>} [stateStore]
+ * @param {MapStore<string, State>} [stateStore]
  * @param {(obj: Passable) => Passable} [sanitize] Process keys and values with
  * this function before storing them. Defaults to deeplyFulfilled.
  */
@@ -142,7 +148,7 @@ export const makeScalarStoreCoordinator = (
 
   const defaultStateStore = withGroundState(stateStore);
 
-  /** @type {import('./types.js').Coordinator} */
+  /** @type {Coordinator} */
   const coord = Far('store cache coordinator', {
     getRecentValue: async key => {
       const keyStr = await serializePassable(key);
@@ -175,9 +181,9 @@ export const makeScalarStoreCoordinator = (
 /**
  * Don't write any marshalled value that's older than what's already pushed
  *
- * @param {MapStore<string, import('./state.js').State>} stateStore
- * @param {ERef<Marshaller>} marshaller
- * @param {ERef<StorageNode>} storageNode
+ * @param {MapStore<string, State>} stateStore
+ * @param {ERemote<EMarshaller>} marshaller
+ * @param {ERemote<StorageNode>} storageNode
  * @returns {<T>(storedValue: T) => Promise<T>}
  */
 const makeLastWinsUpdater = (stateStore, marshaller, storageNode) => {
@@ -205,8 +211,8 @@ const makeLastWinsUpdater = (stateStore, marshaller, storageNode) => {
  * 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 {ERef<StorageNode>} storageNode
- * @param {ERef<Marshaller>} marshaller
+ * @param {ERemote<StorageNode>} storageNode
+ * @param {ERemote<EMarshaller>} marshaller
  */
 export const makeChainStorageCoordinator = (storageNode, marshaller) => {
   const stateStore = makeScalarBigMapStore('stateKey');
@@ -222,7 +228,7 @@ export const makeChainStorageCoordinator = (storageNode, marshaller) => {
     storageNode,
   );
 
-  /** @type {import('./types.js').Coordinator} */
+  /** @type {Coordinator} */
   const coord = Far('store cache coordinator', {
     getRecentValue: async key => {
       const keyStr = await serializePassable(key);

package/src/types.js

@@ -1,7 +1,3 @@
-// @jessie-check
-
-/// <reference types="@agoric/store/exported.js" />
-
 // XXX package factoring debt
 
 // Ensure this is a module.

package/CHANGELOG.md

@@ -1,69 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.4.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.4.0-u22.2...@agoric/cache@0.4.0) (2026-04-02)
-
-**Note:** Version bump only for package @agoric/cache
-
-## [0.4.0-u22.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.4.0-u22.1...@agoric/cache@0.4.0-u22.2) (2025-09-09)
-
-**Note:** Version bump only for package @agoric/cache
-
-## [0.4.0-u22.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.4.0-u22.0...@agoric/cache@0.4.0-u22.1) (2025-09-09)
-
-**Note:** Version bump only for package @agoric/cache
-
-## [0.4.0-u22.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.3.2...@agoric/cache@0.4.0-u22.0) (2025-09-08)
-
-### Features
-
-* **types:** ambient exports from agoric/internal ([71d18c4](https://github.com/Agoric/agoric-sdk/commit/71d18c4221f63f1c0e7c45562b5a0a86a0b4b5c0))
-
-### [0.3.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.3.1...@agoric/cache@0.3.2) (2023-06-02)
-
-**Note:** Version bump only for package @agoric/cache
-
-### [0.3.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.3.0...@agoric/cache@0.3.1) (2023-05-24)
-
-**Note:** Version bump only for package @agoric/cache
-
-## [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
-
-### [0.2.3](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.2.2...@agoric/cache@0.2.3) (2022-10-18)
-
-**Note:** Version bump only for package @agoric/cache
-
-### [0.2.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.2.1...@agoric/cache@0.2.2) (2022-10-08)
-
-**Note:** Version bump only for package @agoric/cache
-
-### [0.2.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.2.0...@agoric/cache@0.2.1) (2022-10-05)
-
-**Note:** Version bump only for package @agoric/cache
-
-## 0.2.0 (2022-09-20)
-
-### Features
-
-* **cache:** makeChainStorageCoordinator ([a9b8f3e](https://github.com/Agoric/agoric-sdk/commit/a9b8f3ebe4ff3e25c857426781ae5c403198f234))
-* **cache:** new `@agoric/cache` implementation ([0626796](https://github.com/Agoric/agoric-sdk/commit/06267961d3de36b1ddd04d9a6345775846056755))
-* **cache:** send the updater to the coordinator, not client loop ([23b94b1](https://github.com/Agoric/agoric-sdk/commit/23b94b1ebd176a7f7ae90ca64d2252ed348e8836))

package/test/mvp.test.js

@@ -1,40 +0,0 @@
-// Must be first to set up globals
-import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
-import { M } from '@agoric/store';
-import { makeScalarBigMapStore } from '@agoric/vat-data';
-
-import { makeCache } from '../src/cache.js';
-import { makeScalarStoreCoordinator } from '../src/store.js';
-
-// Taken from the README.
-test('mvp happy path', async t => {
-  const store = makeScalarBigMapStore('cache');
-  const coordinator = makeScalarStoreCoordinator(store);
-  const cache = makeCache(coordinator);
-
-  // Direct value manipulation.
-  t.is(await cache('baz'), undefined);
-  t.is(await cache('baz', 'barbosa'), 'barbosa');
-
-  // Match-and-set.
-  t.is(await cache('baz', 'babaloo', undefined), 'barbosa');
-  t.is(await cache('baz', 'babaloo', 'barbosa'), 'babaloo');
-
-  // One-time initialization.
-  t.is(await cache('frotz', 'default'), 'default');
-  t.is(await cache('frotz', 'ignored'), 'default');
-
-  // Update function for the `'foo'` entry, using its old value (initially `undefined`).
-  t.is(await cache('foo'), undefined);
-  const updater = (oldValue = 'bar') => `${oldValue}1`;
-  t.is(await cache('foo', updater, M.any()), 'bar1');
-  t.is(await cache('foo', updater, M.any()), 'bar11');
-  t.is(await cache('foo'), 'bar11');
-
-  // You can also specify a guard pattern for the value to update.  If it
-  // doesn't match the latest value, then the cache isn't updated.
-  t.is(await cache('foo', updater, 'nomatch'), 'bar11');
-  t.is(await cache('foo', updater, 'bar11'), 'bar111');
-  t.is(await cache('foo', updater, 'bar11'), 'bar111');
-  t.is(await cache('foo'), 'bar111');
-});

package/test/storage.test.js

@@ -1,187 +0,0 @@
-// Must be first to set up globals
-import '@agoric/zoe/tools/prepare-test-env.js';
-
-import test from 'ava';
-import { makeChainStorageRoot } from '@agoric/internal/src/lib-chainStorage.js';
-
-import { Far, makeMarshal } from '@endo/marshal';
-import { M } from '@agoric/store';
-import { makeCache } from '../src/cache.js';
-import { makeChainStorageCoordinator } from '../src/store.js';
-
-const makeSimpleMarshaller = () => {
-  const vals = [];
-  const fromVal = val => {
-    vals.push(val);
-    return vals.length - 1;
-  };
-  const toVal = slot => vals[slot];
-  return makeMarshal(fromVal, toVal, {
-    serializeBodyFormat: 'smallcaps',
-    marshalSaveError: err => {
-      throw err;
-    },
-  });
-};
-harden(makeSimpleMarshaller);
-
-const setup = () => {
-  const storageNodeState = {};
-  const chainStorage = makeChainStorageRoot(
-    Far('ToStorage', 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()),
-  );
-  return { cache, storageNodeState };
-};
-
-test('makeChainStorageCoordinator with non-remote values', async t => {
-  const { cache, storageNodeState } = setup();
-
-  t.is(await cache('brandName', 'barbosa'), 'barbosa');
-  t.deepEqual(Object.keys(storageNodeState), ['cache']);
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"#\\"brandName\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":"barbosa"}',
-      slots: [],
-    },
-  });
-
-  // One-time initialization (of 'frotz')
-  t.is(await cache('frotz', 'default'), 'default');
-  const afterFirstFrotz = {
-    '{"body":"#\\"brandName\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":"barbosa"}',
-      slots: [],
-    },
-    '{"body":"#\\"frotz\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":"default"}',
-      slots: [],
-    },
-  };
-  t.deepEqual(JSON.parse(storageNodeState.cache), afterFirstFrotz);
-  // no change
-  t.is(await cache('frotz', 'ignored'), 'default');
-  t.deepEqual(JSON.parse(storageNodeState.cache), afterFirstFrotz);
-
-  // cache more complex Passable
-  const complexPassable = {
-    str: 'string',
-    big: 1n,
-    num: 53,
-    arr: ['hi', 'there'],
-  };
-  t.deepEqual(
-    await cache(['complex', 'passable'], complexPassable),
-    complexPassable,
-  );
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    ...afterFirstFrotz,
-    '{"body":"#[\\"complex\\",\\"passable\\"]","slots":[]}': {
-      body: '#{"generation":"+1","value":{"arr":["hi","there"],"big":"+1","num":53,"str":"string"}}',
-      slots: [],
-    },
-  });
-});
-
-test('makeChainStorageCoordinator with remote values', async t => {
-  const { cache, storageNodeState } = setup();
-
-  const farThing = Far('farThing', { getAllegedName: () => 'dollaz' });
-
-  t.is(await cache('brand', farThing), farThing);
-  t.deepEqual(Object.keys(storageNodeState), ['cache']);
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"#\\"brand\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":"$0.Alleged: farThing"}',
-      slots: [0],
-    },
-  });
-});
-
-test('makeChainStorageCoordinator with updater', async t => {
-  const { cache, storageNodeState } = setup();
-
-  const increment = (counter = 0) => Promise.resolve(counter + 1);
-
-  // Initial
-  t.is(await cache('counter', increment), 1);
-  t.deepEqual(Object.keys(storageNodeState), ['cache']);
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"#\\"counter\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":1}',
-      slots: [],
-    },
-  });
-
-  // Again without a pattern
-  t.is(await cache('counter', increment), 1);
-  t.deepEqual(Object.keys(storageNodeState), ['cache']);
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"#\\"counter\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":1}',
-      slots: [],
-    },
-  });
-
-  // Again with a matching pattern
-  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":"+2","value":2}',
-      slots: [],
-    },
-  });
-});
-
-test('makeChainStorageCoordinator with remote updater', async t => {
-  const { cache, storageNodeState } = setup();
-
-  let counter = 0;
-  const counterObj = Far('counterObj', {
-    increment: () => {
-      return (counter += 1);
-    },
-  });
-
-  // Initial
-  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":"+1","value":1}',
-      slots: [],
-    },
-  });
-
-  // Again without a pattern, doesn't increment
-  t.is(await cache('counter', counterObj.increment), 1);
-  t.is(counter, 1);
-  t.deepEqual(Object.keys(storageNodeState), ['cache']);
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"#\\"counter\\"","slots":[]}': {
-      body: '#{"generation":"+1","value":1}',
-      slots: [],
-    },
-  });
-
-  // Again with a matching pattern
-  t.is(await cache('counter', counterObj.increment, M.any()), 2);
-  t.is(counter, 2);
-  t.deepEqual(Object.keys(storageNodeState), ['cache']);
-  t.deepEqual(JSON.parse(storageNodeState.cache), {
-    '{"body":"#\\"counter\\"","slots":[]}': {
-      body: '#{"generation":"+2","value":2}',
-      slots: [],
-    },
-  });
-});

package/tsconfig.json

@@ -1,11 +0,0 @@
-// This file can contain .js-specific Typescript compiler config.
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {},
-  "include": [
-    "*.js",
-    "public/**/*.js",
-    "src/**/*.js",
-    "test/**/*.js",
-  ],
-}