@agoric/swing-store 0.10.0 → 0.10.1-upgrade-23-dev-bd79330.0.bd79330

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swing-store",
-  "version": "0.10.0",
+  "version": "0.10.1-upgrade-23-dev-bd79330.0.bd79330",
   "description": "Persistent storage for SwingSet",
   "type": "module",
   "main": "./src/index.js",
@@ -18,10 +18,10 @@
     "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 ."
   },
   "dependencies": {
-    "@agoric/internal": "0.4.0",
+    "@agoric/internal": "0.4.1-upgrade-23-dev-bd79330.0.bd79330",
     "@endo/base64": "^1.0.12",
     "@endo/bundle-source": "^4.1.2",
     "@endo/check-bundle": "^1.0.17",
@@ -34,7 +34,7 @@
     "@endo/promise-kit": "^1.1.13",
     "@endo/stream": "^1.2.13",
     "@types/better-sqlite3": "^7.6.13",
-    "ava": "^5.3.0",
+    "ava": "^6.4.1",
     "c8": "^10.1.3",
     "tmp": "^0.2.1"
   },
@@ -51,10 +51,10 @@
     "timeout": "2m"
   },
   "typeCoverage": {
-    "atLeast": 80.49
+    "atLeast": 80.67
   },
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "0922d0447ab8fae9d2d87415964403330b5ca313"
+  "gitHead": "bd79330f78dae2faf9cc3d8b10063567700da07b"
 }

package/src/archiver.js

@@ -42,7 +42,7 @@ export const makeArchiveSnapshot = (dirPath, powers) => {
       const writer = fs.createWriteStream('', { fd, flush: true });
       const reader = Readable.from(gzData);
       const destroyReader = promisify(reader.destroy.bind(reader));
-      addCleanup(() => destroyReader(null));
+      addCleanup(() => destroyReader(undefined));
       reader.pipe(writer);
       await streamFinished(writer);
       fs.renameSync(tmpName, destPath);

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/bundleStore.js

@@ -1,7 +1,7 @@
 // @ts-check
-import { createHash } from 'crypto';
-import { Readable } from 'stream';
-import { Buffer } from 'buffer';
+import { createHash } from 'node:crypto';
+import { Readable } from 'node:stream';
+import { Buffer } from 'node:buffer';
 import { Fail, q } from '@endo/errors';
 import { encodeBase64, decodeBase64 } from '@endo/base64';
 import { checkBundle } from '@endo/check-bundle/lite.js';
@@ -15,8 +15,8 @@ import { createSHA256 } from './hasher.js';
  * @typedef { EndoZipBase64Bundle | GetExportBundle | NestedEvaluateBundle } Bundle
  */
 /**
- * @typedef { import('./exporter.js').SwingStoreExporter } SwingStoreExporter
- * @typedef { import('./internal.js').ArtifactMode } ArtifactMode
+ * @import {SwingStoreExporter} from './exporter.js';
+ * @import {ArtifactMode} from './internal.js';
  *
  * @typedef {{
  *   addBundle: (bundleID: string, bundle: Bundle) => void;

package/src/exporter.js

@@ -2,8 +2,7 @@ import sqlite3 from 'better-sqlite3';
 
 import { Fail, q } from '@endo/errors';
 
-import { dbFileInDirectory } from './util.js';
-import { getKeyType } from './kvStore.js';
+import { dbFileInDirectory, getKVStoreKeyType } from './util.js';
 import { makeBundleStore } from './bundleStore.js';
 import { makeSnapStore } from './snapStore.js';
 import { makeSnapStoreIO } from './snapStoreIO.js';
@@ -11,6 +10,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 +82,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?
  */
 
 /**
@@ -129,7 +132,7 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
    * section
    */
   function getHostKV(key) {
-    getKeyType(key) === 'host' || Fail`getHostKV requires host keys`;
+    getKVStoreKeyType(key) === 'host' || Fail`getHostKV requires host keys`;
     // @ts-expect-error unknown
     return sqlKVGet.get(key);
   }
@@ -147,7 +150,7 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
    */
   async function* getExportData() {
     for (const { key, value } of sqlGetAllKVData.iterate()) {
-      if (getKeyType(key) === 'consensus') {
+      if (getKVStoreKeyType(key) === 'consensus') {
         yield [`kv.${key}`, value];
       }
     }

package/src/hasher.js

@@ -1,6 +1,6 @@
 import { Fail } from '@endo/errors';
 
-import { createHash } from 'crypto';
+import { createHash } from 'node:crypto';
 
 /**
  * @typedef {{

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/index.js

@@ -5,7 +5,8 @@ export { importSwingStore } from './importer.js';
 export { makeArchiveSnapshot, makeArchiveTranscript } from './archiver.js';
 
 // for the benefit of tools like SwingSet/misc-tools/replay-transcript.js
-export { makeKVStore, getKeyType } from './kvStore.js';
+export { makeKVStore } from '@agoric/internal/src/kv-store.js';
+export { getKVStoreKeyType, getKVStoreKeyType as getKeyType } from './util.js';
 export { makeTranscriptStore } from './transcriptStore.js';
 export { makeSnapStore } from './snapStore.js';
 export { makeSnapStoreIO } from './snapStoreIO.js';

package/src/internal.js

@@ -1,14 +1,18 @@
 import { Fail, q } from '@endo/errors';
 
 /**
- * @typedef { import('./snapStore.js').SnapStoreInternal } SnapStoreInternal
- * @typedef { import('./transcriptStore.js').TranscriptStoreInternal } TranscriptStoreInternal
- * @typedef { import('./bundleStore.js').BundleStoreInternal } BundleStoreInternal
- *
+ * @import {SnapStoreInternal} from './snapStore.js';
+ * @import {TranscriptStoreInternal} from './transcriptStore.js';
+ * @import {BundleStoreInternal} from './bundleStore.js';
+ * @import {KVStore} from '@agoric/internal/src/kv-store.js';
+ * @import {Database} from 'better-sqlite3';
+ */
+
+/**
  * @typedef {{
  *    dirPath: string | null,
- *    db: ReturnType<import('better-sqlite3')>,
- *    kvStore: import('./kvStore.js').KVStore,
+ *    db: Database,
+ *    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

@@ -1,8 +1,12 @@
 // @ts-check
-import { createHash } from 'crypto';
-import { finished as finishedCallback, PassThrough, Readable } from 'stream';
-import { promisify } from 'util';
-import { createGzip, createGunzip } from 'zlib';
+import { createHash } from 'node:crypto';
+import {
+  finished as finishedCallback,
+  PassThrough,
+  Readable,
+} from 'node:stream';
+import { promisify } from 'node:util';
+import { createGzip, createGunzip } from 'node:zlib';
 import { Fail, q } from '@endo/errors';
 import { withDeferredCleanup } from '@agoric/internal';
 import { buffer } from './util.js';
@@ -10,6 +14,7 @@ import { buffer } from './util.js';
 /**
  * @import { AnyIterable, SwingStoreExporter } from './exporter.js';
  * @import { ArtifactMode } from './internal.js';
+ * @import {makeMeasureSeconds} from '@agoric/internal';
  */
 
 /**
@@ -68,7 +73,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 +83,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]
@@ -227,7 +232,7 @@ export function makeSnapStore(
         await measureSeconds(async () => {
           const snapReader = Readable.from(snapshotStream);
           const destroyReader = promisify(snapReader.destroy.bind(snapReader));
-          addCleanup(() => destroyReader(null));
+          addCleanup(() => destroyReader(undefined));
           snapReader.on('data', chunk => {
             uncompressedSize += chunk.length;
           });

package/src/snapStoreIO.js

@@ -1,4 +1,4 @@
-import { performance } from 'perf_hooks';
+import { performance } from 'node:perf_hooks';
 import { makeMeasureSeconds } from '@agoric/internal';
 
 export function makeSnapStoreIO() {

package/src/swingStore.js

@@ -1,17 +1,17 @@
 // @ts-check
 /* eslint-env node */
-import * as fs from 'fs';
-import * as pathlib from 'path';
+import * as fs from 'node:fs';
+import * as pathlib from 'node:path';
 
 import sqlite3 from 'better-sqlite3';
 
 import { Fail, q } from '@endo/errors';
 
 import { attenuate } from '@agoric/internal';
+import { makeKVStore } from '@agoric/internal/src/kv-store.js';
 import { TRUE } from '@agoric/internal/src/js-utils.js';
 
-import { dbFileInDirectory } from './util.js';
-import { makeKVStore, getKeyType } from './kvStore.js';
+import { dbFileInDirectory, getKVStoreKeyType } from './util.js';
 import { makeTranscriptStore } from './transcriptStore.js';
 import { makeSnapStore } from './snapStore.js';
 import { makeBundleStore } from './bundleStore.js';
@@ -28,18 +28,25 @@ const IN_MEMORY = ':memory:';
  */
 
 /**
- * @typedef { import('./kvStore.js').KVStore } KVStore
+ * @import {SwingStoreExporter} from './exporter.js';
+ * @import {SwingStoreInternal} from './internal.js';
+ * @import {SnapshotCallback} from './snapStore.js';
+ * @import {TranscriptCallback} from './transcriptStore.js';
+ */
+
+/**
+ * @import {KVStore} from '@agoric/internal/src/kv-store.js';
  *
- * @typedef { import('./snapStore.js').SnapStore } SnapStore
- * @typedef { import('./snapStore.js').SnapshotResult } SnapshotResult
+ * @import {SnapStore} from './snapStore.js';
+ * @import {SnapshotResult} from './snapStore.js';
  *
- * @typedef { import('./transcriptStore.js').TranscriptStore } TranscriptStore
- * @typedef { import('./transcriptStore.js').TranscriptStoreDebug } TranscriptStoreDebug
+ * @import {TranscriptStore} from './transcriptStore.js';
+ * @import {TranscriptStoreDebug} from './transcriptStore.js';
  *
- * @typedef { import('./bundleStore.js').BundleStore } BundleStore
- * @typedef { import('./bundleStore.js').BundleStoreDebug } BundleStoreDebug
+ * @import {BundleStore} from './bundleStore.js';
+ * @import {BundleStoreDebug} from './bundleStore.js';
  *
- * @typedef { import('./exporter.js').KVPair } KVPair
+ * @import {KVPair} from './exporter.js';
  *
  * @typedef {{
  *   kvStore: KVStore, // a key-value API object to load and store data on behalf of the kernel
@@ -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]
  */
 
 /**
@@ -351,7 +358,7 @@ export function makeSwingStore(path, forceReset, options = {}) {
   const kernelKVStore = {
     ...kvStore,
     set(key, value) {
-      const keyType = getKeyType(key);
+      const keyType = getKVStoreKeyType(key);
       keyType !== 'host' || Fail`kernelKVStore refuses host keys`;
       kvStore.set(key, value);
       if (keyType === 'consensus') {
@@ -365,7 +372,7 @@ export function makeSwingStore(path, forceReset, options = {}) {
       }
     },
     delete(key) {
-      const keyType = getKeyType(key);
+      const keyType = getKVStoreKeyType(key);
       keyType !== 'host' || Fail`kernelKVStore refuses host keys`;
       kvStore.delete(key);
       if (keyType === 'consensus') {
@@ -381,12 +388,12 @@ export function makeSwingStore(path, forceReset, options = {}) {
   const hostKVStore = {
     ...kvStore,
     set(key, value) {
-      const keyType = getKeyType(key);
+      const keyType = getKVStoreKeyType(key);
       keyType === 'host' || Fail`hostKVStore requires host keys`;
       kvStore.set(key, value);
     },
     delete(key) {
-      const keyType = getKeyType(key);
+      const keyType = getKVStoreKeyType(key);
       keyType === 'host' || Fail`hostKVStore requires host keys`;
       kvStore.delete(key);
     },
@@ -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

@@ -1,6 +1,6 @@
 // @ts-check
-import { Readable } from 'stream';
-import { Buffer } from 'buffer';
+import { Readable } from 'node:stream';
+import { Buffer } from 'node:buffer';
 import { Fail, q } from '@endo/errors';
 import BufferLineTransform from '@agoric/internal/src/node/buffer-line-transform.js';
 import { createSHA256 } from './hasher.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/types-index.d.ts

@@ -3,7 +3,7 @@ export type {
   SwingStoreKernelStorage,
   SwingStoreHostStorage,
 } from './swingStore.js';
-export type { KVStore } from './kvStore.js';
+export type { KVStore } from '@agoric/internal/src/kv-store.js';
 export type { BundleStore } from './bundleStore.js';
 export type {
   SnapStore,

package/src/util.js

@@ -1,12 +1,17 @@
-import path from 'path';
-import { Buffer } from 'buffer';
+import { Buffer } from 'node:buffer';
+import path from 'node:path';
+import { Fail } from '@endo/errors';
+
+/**
+ * @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 = [];
@@ -20,3 +25,16 @@ export function dbFileInDirectory(dirPath) {
   const filePath = path.resolve(dirPath, 'swingstore.sqlite');
   return filePath;
 }
+
+/**
+ * @param {string} key
+ */
+export function getKVStoreKeyType(key) {
+  typeof key === 'string' || Fail`key must be a string`;
+  if (key.startsWith('local.')) {
+    return 'local';
+  } else if (key.startsWith('host.')) {
+    return 'host';
+  }
+  return 'consensus';
+}

package/test/bundles.test.js

@@ -1,6 +1,6 @@
 // @ts-check
 import test from 'ava';
-import { Buffer } from 'buffer';
+import { Buffer } from 'node:buffer';
 import tmp from 'tmp';
 import { makeTempDirFactory } from '@agoric/internal/src/tmpDir.js';
 import { createSHA256 } from '../src/hasher.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 { Buffer } from 'node: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;
       }

package/test/import.test.js

@@ -1,9 +1,9 @@
 // @ts-check
 
-import path from 'path';
-import { createGunzip } from 'zlib';
-import { Readable } from 'stream';
-import { Buffer } from 'buffer';
+import path from 'node:path';
+import { createGunzip } from 'node:zlib';
+import { Readable } from 'node:stream';
+import { Buffer } from 'node:buffer';
 
 import sqlite3 from 'better-sqlite3';
 import test from 'ava';

package/test/repair-metadata.test.js

@@ -1,6 +1,6 @@
 // @ts-check
 
-import path from 'path';
+import path from 'node:path';
 import test from 'ava';
 import sqlite3 from 'better-sqlite3';
 import tmp from 'tmp';

package/tsconfig.json

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

package/src/kvStore.js

@@ -1,173 +0,0 @@
-// @ts-check
-import { Fail } from '@endo/errors';
-
-/**
- * @typedef {{
- *   has: (key: string) => boolean,
- *   get: (key: string) => string | undefined,
- *   getNextKey: (previousKey: string) => string | undefined,
- *   set: (key: string, value: string, bypassHash?: boolean ) => void,
- *   delete: (key: string) => void,
- * }} KVStore
- */
-
-/**
- * @param {string} key
- */
-export function getKeyType(key) {
-  typeof key === 'string' || Fail`key must be a string`;
-  if (key.startsWith('local.')) {
-    return 'local';
-  } else if (key.startsWith('host.')) {
-    return 'host';
-  }
-  return 'consensus';
-}
-
-/**
- * @param {object} db  The SQLite database connection.
- * @param {() => void} ensureTxn  Called before mutating methods to establish a DB transaction
- * @param {(...args: string[]) => void} trace  Called after set/delete to record a debug log
- * @returns { KVStore }
- */
-
-export function makeKVStore(db, ensureTxn, trace) {
-  db.exec(`
-    CREATE TABLE IF NOT EXISTS kvStore (
-      key TEXT,
-      value TEXT,
-      PRIMARY KEY (key)
-    )
-  `);
-
-  const sqlKVGet = db.prepare(`
-    SELECT value
-    FROM kvStore
-    WHERE key = ?
-  `);
-  sqlKVGet.pluck(true);
-
-  /**
-   * Obtain the value stored for a given key.
-   *
-   * @param {string} key  The key whose value is sought.
-   *
-   * @returns {string | undefined} the (string) value for the given key, or
-   *    undefined if there is no such value.
-   *
-   * @throws if key is not a string.
-   */
-  function get(key) {
-    typeof key === 'string' || Fail`key must be a string`;
-    return sqlKVGet.get(key);
-  }
-
-  const sqlKVGetNextKey = db.prepare(`
-    SELECT key
-    FROM kvStore
-    WHERE key > ?
-    LIMIT 1
-  `);
-  sqlKVGetNextKey.pluck(true);
-
-  /**
-   * getNextKey enables callers to iterate over all keys within a
-   * given range. To build an iterator of all keys from start
-   * (inclusive) to end (exclusive), do:
-   *
-   * function* iterate(start, end) {
-   *   if (kvStore.has(start)) {
-   *     yield start;
-   *   }
-   *   let prev = start;
-   *   while (true) {
-   *     let next = kvStore.getNextKey(prev);
-   *     if (!next || next >= end) {
-   *       break;
-   *     }
-   *     yield next;
-   *     prev = next;
-   *   }
-   * }
-   *
-   * @param {string} previousKey  The key returned will always be later than this one.
-   *
-   * @returns {string | undefined} a key string, or undefined if we reach the end of the store
-   *
-   * @throws if previousKey is not a string
-   */
-
-  function getNextKey(previousKey) {
-    typeof previousKey === 'string' || Fail`previousKey must be a string`;
-    return sqlKVGetNextKey.get(previousKey);
-  }
-
-  /**
-   * Test if the state contains a value for a given key.
-   *
-   * @param {string} key  The key that is of interest.
-   *
-   * @returns {boolean} true if a value is stored for the key, false if not.
-   *
-   * @throws if key is not a string.
-   */
-  function has(key) {
-    typeof key === 'string' || Fail`key must be a string`;
-    return get(key) !== undefined;
-  }
-
-  const sqlKVSet = db.prepare(`
-    INSERT INTO kvStore (key, value)
-    VALUES (?, ?)
-    ON CONFLICT DO UPDATE SET value = excluded.value
-  `);
-
-  /**
-   * Store a value for a given key.  The value will replace any prior value if
-   * there was one.
-   *
-   * @param {string} key  The key whose value is being set.
-   * @param {string} value  The value to set the key to.
-   *
-   * @throws if either parameter is not a string.
-   */
-  function set(key, value) {
-    typeof key === 'string' || Fail`key must be a string`;
-    typeof value === 'string' || Fail`value must be a string`;
-    // synchronous read after write within a transaction is safe
-    // The transaction's overall success will be awaited during commit
-    ensureTxn();
-    sqlKVSet.run(key, value);
-    trace('set', key, value);
-  }
-
-  const sqlKVDel = db.prepare(`
-    DELETE FROM kvStore
-    WHERE key = ?
-  `);
-
-  /**
-   * Remove any stored value for a given key.  It is permissible for there to
-   * be no existing stored value for the key.
-   *
-   * @param {string} key  The key whose value is to be deleted
-   *
-   * @throws if key is not a string.
-   */
-  function del(key) {
-    typeof key === 'string' || Fail`key must be a string`;
-    ensureTxn();
-    sqlKVDel.run(key);
-    trace('del', key);
-  }
-
-  const kvStore = {
-    has,
-    get,
-    getNextKey,
-    set,
-    delete: del,
-  };
-
-  return kvStore;
-}