@agoric/swing-store 0.9.2-dev-aa5ce6f.0.aa5ce6f → 0.9.2-dev-188b567.0.188b567

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swing-store",
-  "version": "0.9.2-dev-aa5ce6f.0.aa5ce6f",
+  "version": "0.9.2-dev-188b567.0.188b567",
   "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-aa5ce6f.0.aa5ce6f",
+    "@agoric/internal": "0.3.3-dev-188b567.0.188b567",
     "@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": "aa5ce6f32f2313febcf394018e5de46b81d7dbbc"
+  "gitHead": "188b5670f73288a24d3eda799a8c0a3f1b8036f0"
 }

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';
@@ -133,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);
   }
@@ -151,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/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,13 +1,10 @@
 import { Fail, q } from '@endo/errors';
 
-/**
- * @import {KVStore} from './kvStore.js';
- */
-
 /**
  * @import {SnapStoreInternal} from './snapStore.js';
  * @import {TranscriptStoreInternal} from './transcriptStore.js';
  * @import {BundleStoreInternal} from './bundleStore.js';
+ * @import { KVStore } from '@agoric/internal/src/kv-store.js';
  *
  * @typedef {{
  *    dirPath: string | null,

package/src/swingStore.js

@@ -8,10 +8,10 @@ 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';
@@ -35,7 +35,7 @@ const IN_MEMORY = ':memory:';
  */
 
 /**
- * @import {KVStore} from './kvStore.js';
+ * @import {KVStore} from '@agoric/internal/src/kv-store.js';
  *
  * @import {SnapStore} from './snapStore.js';
  * @import {SnapshotResult} from './snapStore.js';
@@ -358,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') {
@@ -372,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') {
@@ -388,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);
     },

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,5 +1,6 @@
-import path from 'path';
 import { Buffer } from 'buffer';
+import path from 'path';
+import { Fail } from '@endo/errors';
 
 /**
  * @import {AnyIterable} from './exporter.js';
@@ -24,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/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;
-}