@agoric/swing-store 0.9.2-dev-1b5e57f.0 → 0.9.2-dev-414e88b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swing-store",
-  "version": "0.9.2-dev-1b5e57f.0+1b5e57f",
+  "version": "0.9.2-dev-414e88b.0+414e88b",
   "description": "Persistent storage for SwingSet",
   "type": "module",
   "main": "./src/index.js",
@@ -21,8 +21,8 @@
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-1b5e57f.0+1b5e57f",
-    "@agoric/internal": "0.3.3-dev-1b5e57f.0+1b5e57f",
+    "@agoric/assert": "0.6.1-dev-414e88b.0+414e88b",
+    "@agoric/internal": "0.3.3-dev-414e88b.0+414e88b",
     "@endo/base64": "^0.2.34",
     "@endo/bundle-source": "^2.7.0",
     "@endo/check-bundle": "^0.2.21",
@@ -51,5 +51,5 @@
   "typeCoverage": {
     "atLeast": 75.52
   },
-  "gitHead": "1b5e57f17a043a43171621bbe3ef68131954f714"
+  "gitHead": "414e88b972e607d7e41cee57c0fc080f62e81f38"
 }

package/src/exporter.js

@@ -36,6 +36,11 @@ import { validateArtifactMode } from './internal.js';
  * the concurrent activity of other swingStore instances, the data representing
  * the commit point will stay consistent and available.
  *
+ * @property {(key: string) => string | undefined} getHostKV
+ *
+ * Retrieve a value from the "host" portion of the kvStore, just like
+ * hostStorage.hostKVStore.get() would do.
+ *
  * @property {() => AnyIterableIterator<KVPair>} getExportData
  *
  * Get a full copy of the first-stage export data (key-value pairs) from the
@@ -112,6 +117,33 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
     assertComplete(internal, artifactMode);
   }
 
+  const sqlKVGet = db.prepare(`
+    SELECT value
+    FROM kvStore
+    WHERE key = ?
+  `);
+  sqlKVGet.pluck(true);
+
+  /**
+   * Obtain the value stored for a given host key. This is for the
+   * benefit of clients who need to briefly query the DB to ensure
+   * they are exporting the right thing, and need to avoid modifying
+   * anything (or creating a read-write DB lock) in the process.
+   *
+   * @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, or the key is not in the host
+   * section
+   */
+  function getHostKV(key) {
+    typeof key === 'string' || Fail`key must be a string`;
+    getKeyType(key) === 'host' || Fail`getHostKV requires host keys`;
+    return sqlKVGet.get(key);
+  }
+
   const sqlGetAllKVData = db.prepare(`
     SELECT key, value
     FROM kvStore
@@ -173,6 +205,7 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
   }
 
   return harden({
+    getHostKV,
     getExportData,
     getArtifactNames,
     getArtifact,

package/test/exports.js

@@ -76,6 +76,9 @@ export function buildData() {
  */
 export function makeExporter(exportData, artifacts) {
   return {
+    getHostKV(_key) {
+      return undefined;
+    },
     async *getExportData() {
       for (const [key, value] of exportData.entries()) {
         /** @type { import('../src/exporter.js').KVPair } */

package/test/test-bundles.js

@@ -106,6 +106,9 @@ test('b0 import', async t => {
   const idA = makeB0ID(b0A);
   const nameA = `bundle.${idA}`;
   const exporter = {
+    getHostKV(_key) {
+      return undefined;
+    },
     async *getExportData() {
       yield /** @type {const} */ ([nameA, idA]);
     },
@@ -134,6 +137,9 @@ test('b0 bad import', async t => {
   const idA = makeB0ID(b0A);
   const nameA = `bundle.${idA}`;
   const exporter = {
+    getHostKV(_key) {
+      return undefined;
+    },
     async *getExportData() {
       yield /** @type {const} */ ([nameA, idA]);
     },

package/test/test-export.js

@@ -34,6 +34,8 @@ const exportTest = test.macro(async (t, mode) => {
   const ss1 = initSwingStore(dbDir, options);
   const ks = ss1.kernelStorage;
 
+  ss1.hostStorage.kvStore.set('host.h1', 'hostvalue1');
+
   // build a DB with four spans (one in an old incarnation, two
   // historical but current incarnation, only one inUse) and two
   // snapshots (only one inUSe)
@@ -86,6 +88,13 @@ const exportTest = test.macro(async (t, mode) => {
   }
   const exporter = makeSwingStoreExporter(dbDir, { artifactMode });
 
+  // hostKV
+  t.is(exporter.getHostKV('host.h1'), 'hostvalue1');
+  t.is(exporter.getHostKV('host.hmissing'), undefined);
+  t.throws(() => exporter.getHostKV('nonhost'), {
+    message: 'getHostKV requires host keys',
+  });
+
   // exportData
   {
     const exportData = new Map();