@agoric/swing-store 0.9.2-dev-d6fae11.0.d6fae11 → 0.9.2-dev-64cee5a.0.64cee5a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swing-store",
-  "version": "0.9.2-dev-d6fae11.0.d6fae11",
+  "version": "0.9.2-dev-64cee5a.0.64cee5a",
   "description": "Persistent storage for SwingSet",
   "type": "module",
   "main": "./src/index.js",
@@ -21,7 +21,7 @@
     "lint:eslint": "yarn run -T eslint ."
   },
   "dependencies": {
-    "@agoric/internal": "0.3.3-dev-d6fae11.0.d6fae11",
+    "@agoric/internal": "0.3.3-dev-64cee5a.0.64cee5a",
     "@endo/base64": "^1.0.12",
     "@endo/bundle-source": "^4.1.2",
     "@endo/check-bundle": "^1.0.17",
@@ -56,5 +56,5 @@
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "d6fae11a6db28b1122089468183eccd4d47b83c9"
+  "gitHead": "64cee5ae5d1a3488a30ce042d6f3f561ac2a6e82"
 }

package/src/assertComplete.js

@@ -1,12 +1,17 @@
 /**
- * @param {Pick<import('./internal.js').SwingStoreInternal, 'bundleStore' | 'transcriptStore' | 'snapStore'>} internal
- * @param {Exclude<import('./internal.js').ArtifactMode, 'debug'>} checkMode
+ * @param {Pick<SwingStoreInternal, 'bundleStore' | 'transcriptStore' | 'snapStore'>} internal
+ * @param {Exclude<ArtifactMode, 'debug'>} checkMode
  * @returns {void}
  */
 export function assertComplete(internal, checkMode) {
   // every bundle must be populated
   internal.bundleStore.assertComplete(checkMode);
 
+  /**
+   * @import {SwingStoreInternal} from './internal.js';
+   * @import {ArtifactMode} from './internal.js';
+   */
+
   // every 'isCurrent' transcript span must have all items
   // TODO: every vat with any data must have a isCurrent transcript
   // span

package/src/exporter.js

@@ -11,6 +11,10 @@ import { makeTranscriptStore } from './transcriptStore.js';
 import { assertComplete } from './assertComplete.js';
 import { validateArtifactMode } from './internal.js';
 
+/**
+ * @import {ArtifactMode} from './internal.js';
+ */
+
 /**
  * @template T
  * @typedef  { Iterable<T> | AsyncIterable<T> } AnyIterable
@@ -79,7 +83,7 @@ import { validateArtifactMode } from './internal.js';
 
 /**
  * @typedef { object } ExportSwingStoreOptions
- * @property { import('./internal.js').ArtifactMode } [artifactMode]  What artifacts should/must the exporter provide?
+ * @property { ArtifactMode } [artifactMode]  What artifacts should/must the exporter provide?
  */
 
 /**

package/src/importer.js

@@ -5,9 +5,15 @@ import { buffer } from './util.js';
 import { validateArtifactMode } from './internal.js';
 import { assertComplete } from './assertComplete.js';
 
+/**
+ * @import {ArtifactMode} from './internal.js';
+ * @import {SwingStoreExporter} from './exporter.js';
+ * @import {SwingStore} from './swingStore.js';
+ */
+
 /**
  * @typedef { object } ImportSwingStoreOptions
- * @property { import('./internal.js').ArtifactMode } [artifactMode]  What artifacts should the importer use and require?
+ * @property { ArtifactMode } [artifactMode]  What artifacts should the importer use and require?
  */
 
 /**
@@ -17,10 +23,10 @@ import { assertComplete } from './assertComplete.js';
  * returned swingStore is not suitable for execution, and thus only contains
  * the host facet for committing the populated swingStore.
  *
- * @param {import('./exporter.js').SwingStoreExporter} exporter
+ * @param {SwingStoreExporter} exporter
  * @param {string | null} [dirPath]
  * @param {ImportSwingStoreOptions} [options]
- * @returns {Promise<Pick<import('./swingStore.js').SwingStore, 'hostStorage' | 'debug'>>}
+ * @returns {Promise<Pick<SwingStore, 'hostStorage' | 'debug'>>}
  */
 export async function importSwingStore(exporter, dirPath = null, options = {}) {
   if (dirPath && typeof dirPath !== 'string') {

package/src/internal.js

@@ -1,5 +1,9 @@
 import { Fail, q } from '@endo/errors';
 
+/**
+ * @import {KVStore} from './kvStore.js';
+ */
+
 /**
  * @import {SnapStoreInternal} from './snapStore.js';
  * @import {TranscriptStoreInternal} from './transcriptStore.js';
@@ -8,7 +12,7 @@ import { Fail, q } from '@endo/errors';
  * @typedef {{
  *    dirPath: string | null,
  *    db: ReturnType<import('better-sqlite3')>,
- *    kvStore: import('./kvStore.js').KVStore,
+ *    kvStore: KVStore,
  *    transcriptStore: TranscriptStoreInternal,
  *    snapStore: SnapStoreInternal,
  *    bundleStore: BundleStoreInternal,

package/src/repairMetadata.js

@@ -1,6 +1,12 @@
 import { Fail, q } from '@endo/errors';
 import { assertComplete } from './assertComplete.js';
 
+/**
+ * @import {SwingStoreInternal} from './internal.js';
+ * @import {SwingStoreExporter} from './exporter.js';
+ * @import {ArtifactMode} from './internal.js';
+ */
+
 /**
  * Given a pre-existing swingstore and a SwingStoreExporter, read in
  * all the metadata from the exporter and use it to regenerate any
@@ -24,8 +30,8 @@ import { assertComplete } from './assertComplete.js';
  * an open transaction. The caller is responsible for calling
  * `hostStorage.commit()` when they are ready.
  *
- * @param {import('./internal.js').SwingStoreInternal} internal
- * @param {import('./exporter.js').SwingStoreExporter} exporter
+ * @param {SwingStoreInternal} internal
+ * @param {SwingStoreExporter} exporter
  * @returns {Promise<void>}
  */
 export async function doRepairMetadata(internal, exporter) {
@@ -60,7 +66,7 @@ export async function doRepairMetadata(internal, exporter) {
   }
 
   // and do a completeness check
-  /** @type { import('./internal.js').ArtifactMode } */
+  /** @type { ArtifactMode } */
   const artifactMode = 'operational';
   assertComplete(internal, artifactMode);
   await exporter.close();

package/src/snapStore.js

@@ -10,6 +10,7 @@ import { buffer } from './util.js';
 /**
  * @import { AnyIterable, SwingStoreExporter } from './exporter.js';
  * @import { ArtifactMode } from './internal.js';
+ * @import {makeMeasureSeconds} from '@agoric/internal';
  */
 
 /**
@@ -68,7 +69,7 @@ import { buffer } from './util.js';
  * @callback SnapshotCallback
  * Called with the gzipped contents of a new heap snapshot.
  * @param {string} name  an export key, e.g. `snapshot.${vatID}.${deliveryCount}`
- * @param {Parameters<import('stream').Readable.from>[0]} compressedData
+ * @param {Parameters<typeof Readable.from>[0]} compressedData
  * @returns {Promise<void>}
  */
 
@@ -78,7 +79,7 @@ const finished = promisify(finishedCallback);
  * @param {*} db
  * @param {() => void} ensureTxn
  * @param {{
- *   measureSeconds: ReturnType<typeof import('@agoric/internal').makeMeasureSeconds>,
+ *   measureSeconds: ReturnType<typeof makeMeasureSeconds>,
  * }} io
  * @param {(key: string, value: string | undefined) => void} noteExport
  * @param {object} [options]

package/src/swingStore.js

@@ -27,6 +27,13 @@ const IN_MEMORY = ':memory:';
  * @typedef {(input: T) => T} Replacer
  */
 
+/**
+ * @import {SwingStoreExporter} from './exporter.js';
+ * @import {SwingStoreInternal} from './internal.js';
+ * @import {SnapshotCallback} from './snapStore.js';
+ * @import {TranscriptCallback} from './transcriptStore.js';
+ */
+
 /**
  * @import {KVStore} from './kvStore.js';
  *
@@ -59,7 +66,7 @@ const IN_MEMORY = ':memory:';
  *   commit: () => Promise<void>,  // commit changes made since the last commit
  *   close: () => Promise<void>,   // shutdown the store, abandoning any uncommitted changes
  *   diskUsage?: () => number, // optional stats method
- *   repairMetadata: (exporter: import('./exporter.js').SwingStoreExporter) => Promise<void>,
+ *   repairMetadata: (exporter: SwingStoreExporter) => Promise<void>,
  * }} SwingStoreHostStorage
  */
 
@@ -79,7 +86,7 @@ const IN_MEMORY = ':memory:';
  *  kernelStorage: SwingStoreKernelStorage,
  *  hostStorage: SwingStoreHostStorage,
  *  debug: SwingStoreDebugTools,
- *  internal: import('./internal.js').SwingStoreInternal,
+ *  internal: SwingStoreInternal,
  * }} SwingStore
  */
 
@@ -139,13 +146,13 @@ const IN_MEMORY = ':memory:';
  * @property {string} [traceFile]  Path at which to record KVStore set/delete activity
  * @property {boolean} [keepSnapshots]  Retain old heap snapshots
  * @property {boolean} [keepTranscripts]  Retain old transcript span items
- * @property {import('./snapStore.js').SnapshotCallback} [archiveSnapshot]  Called after creation of a new heap snapshot
- * @property {import('./transcriptStore.js').TranscriptCallback} [archiveTranscript]  Called after a formerly-current transcript span is finalized
+ * @property {SnapshotCallback} [archiveSnapshot]  Called after creation of a new heap snapshot
+ * @property {TranscriptCallback} [archiveTranscript]  Called after a formerly-current transcript span is finalized
  * @property {(pendingExports: Iterable<[key: string, value: string | null]>) => void} [exportCallback]
- * @property {Replacer<ReturnType<makeKVStore>>} [wrapKvStore]
- * @property {Replacer<ReturnType<makeTranscriptStore>>} [wrapTranscriptStore]
- * @property {Replacer<ReturnType<makeSnapStore>>} [wrapSnapStore]
- * @property {Replacer<ReturnType<makeBundleStore>>} [wrapBundleStore]
+ * @property {Replacer<ReturnType<typeof makeKVStore>>} [wrapKvStore]
+ * @property {Replacer<ReturnType<typeof makeTranscriptStore>>} [wrapTranscriptStore]
+ * @property {Replacer<ReturnType<typeof makeSnapStore>>} [wrapSnapStore]
+ * @property {Replacer<ReturnType<typeof makeBundleStore>>} [wrapBundleStore]
  */
 
 /**
@@ -515,7 +522,7 @@ export function makeSwingStore(path, forceReset, options = {}) {
     stopTrace();
   }
 
-  /** @type {import('./internal.js').SwingStoreInternal} */
+  /** @type {SwingStoreInternal} */
   const internal = harden({
     dirPath: asFile ? null : path,
     asFile,

package/src/transcriptStore.js

@@ -374,7 +374,7 @@ export function makeTranscriptStore(
    * transcript.${vatID}.current export record are responsibility of the caller.
    *
    * @param {string} vatID
-   * @param {ReturnType<getCurrentSpanBounds>} bounds
+   * @param {ReturnType<typeof getCurrentSpanBounds>} bounds
    * @returns {{deferredTask: Promise<void>}}
    */
   function closeSpan(vatID, bounds) {

package/src/util.js

@@ -1,12 +1,16 @@
 import path from 'path';
 import { Buffer } from 'buffer';
 
+/**
+ * @import {AnyIterable} from './exporter.js';
+ */
+
 /**
  * This is a polyfill for the `buffer` function from Node's
  * 'stream/consumers' package, which unfortunately only exists in newer versions
  * of Node.
  *
- * @param {import('./exporter.js').AnyIterable<Uint8Array>} inStream
+ * @param {AnyIterable<Uint8Array>} inStream
  */
 export const buffer = async inStream => {
   const chunks = [];

package/test/bundles.test.js

@@ -9,6 +9,10 @@ import { makeSwingStoreExporter } from '../src/exporter.js';
 import { importSwingStore } from '../src/importer.js';
 import { buffer } from '../src/util.js';
 
+/**
+ * @import {Bundle} from '../src/bundleStore.js';
+ */
+
 const tmpDir = makeTempDirFactory(tmp);
 
 function makeB0ID(bundle) {
@@ -19,7 +23,7 @@ test('b0 format', t => {
   const { kernelStorage } = initSwingStore();
   const { bundleStore } = kernelStorage;
 
-  /** @type {import('../src/bundleStore.js').Bundle} */
+  /** @type {Bundle} */
   const b0A = { moduleFormat: 'nestedEvaluate', source: '1+1' };
   const idA = makeB0ID(b0A);
   bundleStore.addBundle(idA, b0A);
@@ -32,7 +36,7 @@ test('b0 format', t => {
   });
   t.falsy(bundleStore.hasBundle(idBogus));
 
-  /** @type {import('../src/bundleStore.js').Bundle} */
+  /** @type {Bundle} */
   const b0B = { moduleFormat: 'getExport', source: '1+1' };
   const idB = makeB0ID(b0B);
   t.throws(() => bundleStore.addBundle(idB, b0B), {
@@ -73,7 +77,7 @@ test('b0 export', async t => {
   });
   const { bundleStore } = kernelStorage;
 
-  /** @type {import('../src/bundleStore.js').Bundle} */
+  /** @type {Bundle} */
   const b0A = { moduleFormat: 'nestedEvaluate', source: '1+1' };
   const idA = makeB0ID(b0A);
   bundleStore.addBundle(idA, b0A);

package/test/deletion.test.js

@@ -14,6 +14,10 @@ import { makeArchiveSnapshot, makeArchiveTranscript } from '../src/archiver.js';
 import { makeSwingStoreExporter } from '../src/exporter.js';
 import { importSwingStore } from '../src/importer.js';
 
+/**
+ * @import {ExecutionContext} from 'ava';
+ */
+
 const tmpDir = makeTempDirFactory(tmp);
 
 async function* getSnapshotStream() {
@@ -219,7 +223,7 @@ const setupTranscript = async (t, keepTranscripts) => {
 };
 
 /**
- * @param {import('ava').ExecutionContext} t
+ * @param {ExecutionContext} t
  * @param {{ keepTranscripts: boolean }} config
  */
 const execSlowTranscriptDeletion = async (t, { keepTranscripts }) => {

package/test/export.test.js

@@ -8,6 +8,11 @@ import { initSwingStore, makeSwingStoreExporter } from '../src/index.js';
 
 import { getSnapshotStream, makeB0ID } from './util.js';
 
+/**
+ * @import {ArtifactMode} from '../src/internal.js'
+ * @import {Bundle} from '../src/bundleStore.js';
+ */
+
 const tmpDir = makeTempDirFactory(tmp);
 
 const rank = {
@@ -23,7 +28,7 @@ const snapshotData = 'snapshot data';
 const snapHash =
   'e7dee7266896538616b630a5da40a90e007726a383e005a9c9c5dd0c2daf9329';
 
-/** @type {import('../src/bundleStore.js').Bundle} */
+/** @type {Bundle} */
 const bundle0 = { moduleFormat: 'nestedEvaluate', source: '1+1' };
 const bundle0ID = makeB0ID(bundle0);
 
@@ -86,7 +91,6 @@ const exportTest = test.macro(async (t, mode) => {
   // historical transcript spans, and no historical snapshots
 
   assert.typeof(mode, 'string');
-  /** @import {ArtifactMode} from '../src/internal.js' */
   let artifactMode = /** @type {ArtifactMode} */ (mode);
   if (mode === 'debug-on-pruned') {
     artifactMode = 'debug';

package/test/exports.js

@@ -1,12 +1,17 @@
 import { Buffer } from 'buffer';
 import { makeB0ID } from './util.js';
 
+/**
+ * @import {Bundle} from '../src/bundleStore.js';
+ * @import {KVPair} from '../src/exporter.js';
+ */
+
 export const snapshotData = 'snapshot data';
 // this snapHash was computed manually
 export const snapHash =
   'e7dee7266896538616b630a5da40a90e007726a383e005a9c9c5dd0c2daf9329';
 
-/** @type {import('../src/bundleStore.js').Bundle} */
+/** @type {Bundle} */
 export const bundle0 = { moduleFormat: 'nestedEvaluate', source: '1+1' };
 export const bundle0ID = makeB0ID(bundle0);
 
@@ -81,7 +86,7 @@ export function makeExporter(exportData, artifacts) {
     },
     async *getExportData() {
       for (const [key, value] of exportData.entries()) {
-        /** @type { import('../src/exporter.js').KVPair } */
+        /** @type { KVPair } */
         const pair = [key, value];
         yield pair;
       }