@agoric/swing-store 0.9.2-dev-eb7e9eb.0 → 0.9.2-u11.0

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [0.9.2-u11.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.1...@agoric/swing-store@0.9.2-u11.0) (2023-08-24)
+
+
+### Features
+
+* **swingstore:** add repairMetadata() ([5b2d19d](https://github.com/Agoric/agoric-sdk/commit/5b2d19d1153a23c118afb14ca4ed80e175640f62)), closes [#8025](https://github.com/Agoric/agoric-sdk/issues/8025) [#8025](https://github.com/Agoric/agoric-sdk/issues/8025)
+
+
+### Bug Fixes
+
+* **swing-store:** add 'replay' artifactMode, make export more strict ([d46c8e2](https://github.com/Agoric/agoric-sdk/commit/d46c8e2d270999ccba552e0072cb5e0926922f28)), closes [#8105](https://github.com/Agoric/agoric-sdk/issues/8105)
+* rewrite importSwingStore to preserve metadata properly ([03e323a](https://github.com/Agoric/agoric-sdk/commit/03e323a55ffeb98dcc84a57050a5d3fc881899b8)), closes [#8025](https://github.com/Agoric/agoric-sdk/issues/8025)
+
+
+
 ### [0.9.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.0...@agoric/swing-store@0.9.1) (2023-06-02)
 
 **Note:** Version bump only for package @agoric/swing-store

package/{tsconfig.json → jsconfig.json}

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swing-store",
-  "version": "0.9.2-dev-eb7e9eb.0+eb7e9eb",
+  "version": "0.9.2-u11.0",
   "description": "Persistent storage for SwingSet",
   "type": "module",
   "main": "./src/index.js",
@@ -17,22 +17,22 @@
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc",
+    "lint:types": "tsc -p jsconfig.json",
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-eb7e9eb.0+eb7e9eb",
-    "@agoric/internal": "0.3.3-dev-eb7e9eb.0+eb7e9eb",
-    "@endo/base64": "^0.2.32",
-    "@endo/bundle-source": "^2.5.2",
-    "@endo/check-bundle": "^0.2.19",
-    "@endo/nat": "^4.1.28",
+    "@agoric/assert": "^0.6.0",
+    "@agoric/internal": "^0.3.3-u11.0",
+    "@endo/base64": "^0.2.31",
+    "@endo/bundle-source": "^2.5.1",
+    "@endo/check-bundle": "^0.2.18",
+    "@endo/nat": "^4.1.27",
     "better-sqlite3": "^8.2.0"
   },
   "devDependencies": {
-    "@endo/init": "^0.5.57",
+    "@endo/init": "^0.5.56",
     "@types/better-sqlite3": "^7.5.0",
-    "ava": "^5.3.0",
+    "ava": "^5.2.0",
     "c8": "^7.13.0",
     "tmp": "^0.2.1"
   },
@@ -45,5 +45,5 @@
     ],
     "timeout": "2m"
   },
-  "gitHead": "eb7e9ebe52e78052e5ded601b6658896d257cab4"
+  "gitHead": "92b6cd72484079b0349d8ccfa4510aeb820e8d67"
 }

package/src/bundleStore.js

@@ -328,6 +328,7 @@ export function makeBundleStore(db, ensureTxn, noteExport = () => {}) {
         endoZipBase64: encodeBase64(data),
       });
       // Assert that the bundle contents match the ID and hash
+      // eslint-disable-next-line @jessie.js/no-nested-await
       await checkBundle(bundle, computeSha512, bundleID);
       populateBundle(bundleID, serializeBundle(bundleID, bundle));
     } else {

package/src/snapStore.js

@@ -333,11 +333,11 @@ export function makeSnapStore(
     snapReader.pipe(hashStream);
     snapReader.pipe(output);
 
-    await null;
     try {
       yield* output;
     } finally {
       gzReader.destroy();
+      // eslint-disable-next-line @jessie.js/no-nested-await
       await finished(gzReader);
       const hash = hashStream.digest('hex');
       hash === snapshotID ||

package/src/swingStore.js

@@ -515,10 +515,6 @@ export function makeSwingStore(dirPath, forceReset, options = {}) {
     });
   }
 
-  function getDatabase() {
-    return db;
-  }
-
   const transcriptStorePublic = {
     initTranscript: transcriptStore.initTranscript,
     rolloverSpan: transcriptStore.rolloverSpan,
@@ -568,7 +564,6 @@ export function makeSwingStore(dirPath, forceReset, options = {}) {
   const debug = {
     serialize,
     dump,
-    getDatabase,
   };
 
   return harden({

package/test/test-exportImport.js

@@ -3,7 +3,9 @@
 import '@endo/init/debug.js';
 import { Buffer } from 'node:buffer';
 
+// eslint-disable-next-line import/no-extraneous-dependencies
 import test from 'ava';
+// eslint-disable-next-line import/no-extraneous-dependencies
 import tmp from 'tmp';
 import bundleSource from '@endo/bundle-source';
 
@@ -120,6 +122,7 @@ test('crank abort leaves no debris in export log', async t => {
         crankNum % 3 === 0,
       );
     }
+    // eslint-disable-next-line no-await-in-loop
     await ssOut.hostStorage.commit();
   }
 
@@ -215,8 +218,10 @@ async function testExportImport(
       actLikeAVatRunningACrank(vat, kernelStorage, crankNum);
     }
     if (block < 3) {
+      // eslint-disable-next-line no-await-in-loop
       await fakeAVatSnapshot(vats[block % 2], kernelStorage);
     }
+    // eslint-disable-next-line no-await-in-loop
     await ssOut.hostStorage.commit();
   }
 

package/test/test-import.js

@@ -14,15 +14,7 @@ import { decodeBase64 } from '@endo/base64';
 import { buffer } from '../src/util.js';
 import { importSwingStore, makeSwingStoreExporter } from '../src/index.js';
 
-import { tmpDir } from './util.js';
-import {
-  buildData,
-  bundle0,
-  bundle0ID,
-  makeExporter,
-  snapHash,
-  snapshotData,
-} from './exports.js';
+import { tmpDir, makeB0ID } from './util.js';
 
 const rank = {
   operational: 1,
@@ -31,6 +23,15 @@ const rank = {
   debug: 4,
 };
 
+const snapshotData = 'snapshot data';
+// this snapHash was computed manually
+const snapHash =
+  'e7dee7266896538616b630a5da40a90e007726a383e005a9c9c5dd0c2daf9329';
+
+/** @type {import('../src/bundleStore.js').Bundle} */
+const bundle0 = { moduleFormat: 'nestedEvaluate', source: '1+1' };
+const bundle0ID = makeB0ID(bundle0);
+
 function convert(orig) {
   const bundles = Object.fromEntries(
     Object.entries(orig.bundles).map(([bundleID, encBundle]) => {
@@ -43,6 +44,38 @@ function convert(orig) {
   return { ...orig, bundles };
 }
 
+/**
+ * @typedef { import('../src/exporter').KVPair } KVPair
+ */
+
+/**
+ * @param { Map<string, string | null> } exportData
+ * @param { Map<string, string> } artifacts
+ */
+export function makeExporter(exportData, artifacts) {
+  return {
+    async *getExportData() {
+      for (const [key, value] of exportData.entries()) {
+        /** @type { KVPair } */
+        const pair = [key, value];
+        yield pair;
+      }
+    },
+    async *getArtifactNames() {
+      for (const name of artifacts.keys()) {
+        yield name;
+      }
+    },
+    async *getArtifact(name) {
+      const data = artifacts.get(name);
+      assert(data, `missing artifact ${name}`);
+      yield Buffer.from(data);
+    },
+    // eslint-disable-next-line no-empty-function
+    async close() {},
+  };
+}
+
 test('import empty', async t => {
   const [dbDir, cleanup] = await tmpDir('testdb');
   t.teardown(cleanup);
@@ -58,6 +91,66 @@ test('import empty', async t => {
   });
 });
 
+export function buildData() {
+  // build an export manually
+  const exportData = new Map();
+  const artifacts = new Map();
+
+  // shadow kvStore
+  exportData.set('kv.key1', 'value1');
+
+  // now add artifacts and metadata in pairs
+
+  artifacts.set(`bundle.${bundle0ID}`, JSON.stringify(bundle0));
+  exportData.set(`bundle.${bundle0ID}`, bundle0ID);
+
+  const sbase = { vatID: 'v1', hash: snapHash, inUse: 0 };
+  const tbase = { vatID: 'v1', startPos: 0, isCurrent: 0, incarnation: 1 };
+  const addTS = (key, obj) =>
+    exportData.set(key, JSON.stringify({ ...tbase, ...obj }));
+  const t0hash =
+    '5bee0f44eca02f23eab03703e84ed2647d5d117fed99e1c30a3b424b7f082ab9';
+  const t2hash =
+    '57152efdd7fdf75c03371d2b4f1088d5bf3eae7fe643babce527ff81df38998c';
+  const t5hash =
+    '1947001e78e01bd1e773feb22b4ffc530447373b9de9274d5d5fbda3f23dbf2b';
+  const t8hash =
+    'e6b42c6a3fb94285a93162f25a9fc0145fd4c5bb144917dc572c50ae2d02ee69';
+
+  addTS(`transcript.v1.0`, { incarnation: 0, endPos: 2, hash: t0hash });
+  artifacts.set(`transcript.v1.0.2`, 'start-worker\nshutdown-worker\n');
+
+  addTS(`transcript.v1.2`, { startPos: 2, endPos: 5, hash: t2hash });
+  artifacts.set(
+    `transcript.v1.2.5`,
+    'start-worker\ndelivery1\nsave-snapshot\n',
+  );
+  exportData.set(`snapshot.v1.4`, JSON.stringify({ ...sbase, snapPos: 4 }));
+  artifacts.set(`snapshot.v1.4`, snapshotData);
+
+  addTS(`transcript.v1.5`, { startPos: 5, endPos: 8, hash: t5hash });
+  artifacts.set(
+    'transcript.v1.5.8',
+    'load-snapshot\ndelivery2\nsave-snapshot\n',
+  );
+  exportData.set(
+    `snapshot.v1.7`,
+    JSON.stringify({ ...sbase, snapPos: 7, inUse: 1 }),
+  );
+  artifacts.set(`snapshot.v1.7`, snapshotData);
+
+  artifacts.set('transcript.v1.8.10', 'load-snapshot\ndelivery3\n');
+  exportData.set(`snapshot.v1.current`, 'snapshot.v1.7');
+  addTS(`transcript.v1.current`, {
+    startPos: 8,
+    endPos: 10,
+    isCurrent: 1,
+    hash: t8hash,
+  });
+
+  return { exportData, artifacts, t0hash, t2hash, t5hash, t8hash };
+}
+
 const importTest = test.macro(async (t, mode) => {
   /** @typedef {import('../src/internal.js').ArtifactMode} ArtifactMode */
   const artifactMode = /** @type {ArtifactMode} */ (mode);

package/test/test-repair-metadata.js

@@ -8,7 +8,7 @@ import sqlite3 from 'better-sqlite3';
 
 import { importSwingStore } from '../src/index.js';
 
-import { makeExporter, buildData } from './exports.js';
+import { makeExporter, buildData } from './test-import.js';
 import { tmpDir } from './util.js';
 
 test('repair metadata', async t => {

package/test/test-snapstore.js

@@ -5,7 +5,9 @@ import { Buffer } from 'node:buffer';
 import zlib from 'zlib';
 import sqlite3 from 'better-sqlite3';
 
+// eslint-disable-next-line import/no-extraneous-dependencies
 import test from 'ava';
+// eslint-disable-next-line import/no-extraneous-dependencies
 import { makeMeasureSeconds } from '@agoric/internal';
 import { makeSnapStore } from '../src/snapStore.js';
 
@@ -101,6 +103,7 @@ test('snapStore prepare / commit delete is robust', async t => {
 
   const hashes = [];
   for (let i = 0; i < 5; i += 1) {
+    // eslint-disable-next-line no-await-in-loop
     const { hash } = await store.saveSnapshot(
       'fakeVatID2',
       i,
@@ -130,6 +133,7 @@ test('snapStore prepare / commit delete is robust', async t => {
   t.is(sqlCountSnapshots.get(), 0);
 
   for (let i = 0; i < 5; i += 1) {
+    // eslint-disable-next-line no-await-in-loop
     const { hash } = await store.saveSnapshot(
       'fakeVatID4',
       i,

package/test/exports.js

@@ -1,99 +0,0 @@
-import { Buffer } from 'buffer';
-import { makeB0ID } from './util.js';
-
-export const snapshotData = 'snapshot data';
-// this snapHash was computed manually
-export const snapHash =
-  'e7dee7266896538616b630a5da40a90e007726a383e005a9c9c5dd0c2daf9329';
-
-/** @type {import('../src/bundleStore.js').Bundle} */
-export const bundle0 = { moduleFormat: 'nestedEvaluate', source: '1+1' };
-export const bundle0ID = makeB0ID(bundle0);
-
-export function buildData() {
-  // build an export manually
-  const exportData = new Map();
-  const artifacts = new Map();
-
-  // shadow kvStore
-  exportData.set('kv.key1', 'value1');
-
-  // now add artifacts and metadata in pairs
-
-  artifacts.set(`bundle.${bundle0ID}`, JSON.stringify(bundle0));
-  exportData.set(`bundle.${bundle0ID}`, bundle0ID);
-
-  const sbase = { vatID: 'v1', hash: snapHash, inUse: 0 };
-  const tbase = { vatID: 'v1', startPos: 0, isCurrent: 0, incarnation: 1 };
-  const addTS = (key, obj) =>
-    exportData.set(key, JSON.stringify({ ...tbase, ...obj }));
-  const t0hash =
-    '5bee0f44eca02f23eab03703e84ed2647d5d117fed99e1c30a3b424b7f082ab9';
-  const t2hash =
-    '57152efdd7fdf75c03371d2b4f1088d5bf3eae7fe643babce527ff81df38998c';
-  const t5hash =
-    '1947001e78e01bd1e773feb22b4ffc530447373b9de9274d5d5fbda3f23dbf2b';
-  const t8hash =
-    'e6b42c6a3fb94285a93162f25a9fc0145fd4c5bb144917dc572c50ae2d02ee69';
-
-  addTS(`transcript.v1.0`, { incarnation: 0, endPos: 2, hash: t0hash });
-  artifacts.set(`transcript.v1.0.2`, 'start-worker\nshutdown-worker\n');
-
-  addTS(`transcript.v1.2`, { startPos: 2, endPos: 5, hash: t2hash });
-  artifacts.set(
-    `transcript.v1.2.5`,
-    'start-worker\ndelivery1\nsave-snapshot\n',
-  );
-  exportData.set(`snapshot.v1.4`, JSON.stringify({ ...sbase, snapPos: 4 }));
-  artifacts.set(`snapshot.v1.4`, snapshotData);
-
-  addTS(`transcript.v1.5`, { startPos: 5, endPos: 8, hash: t5hash });
-  artifacts.set(
-    'transcript.v1.5.8',
-    'load-snapshot\ndelivery2\nsave-snapshot\n',
-  );
-  exportData.set(
-    `snapshot.v1.7`,
-    JSON.stringify({ ...sbase, snapPos: 7, inUse: 1 }),
-  );
-  artifacts.set(`snapshot.v1.7`, snapshotData);
-
-  artifacts.set('transcript.v1.8.10', 'load-snapshot\ndelivery3\n');
-  exportData.set(`snapshot.v1.current`, 'snapshot.v1.7');
-  addTS(`transcript.v1.current`, {
-    startPos: 8,
-    endPos: 10,
-    isCurrent: 1,
-    hash: t8hash,
-  });
-
-  return { exportData, artifacts, t0hash, t2hash, t5hash, t8hash };
-}
-
-/**
- * @param { Map<string, string | null> } exportData
- * @param { Map<string, string> } artifacts
- */
-export function makeExporter(exportData, artifacts) {
-  return {
-    async *getExportData() {
-      for (const [key, value] of exportData.entries()) {
-        /** @type { import('../src/exporter.js').KVPair } */
-        const pair = [key, value];
-        yield pair;
-      }
-    },
-    async *getArtifactNames() {
-      for (const name of artifacts.keys()) {
-        yield name;
-      }
-    },
-    async *getArtifact(name) {
-      const data = artifacts.get(name);
-      assert(data, `missing artifact ${name}`);
-      yield Buffer.from(data);
-    },
-    // eslint-disable-next-line no-empty-function
-    async close() {},
-  };
-}