@fireproof/core 0.20.0-dev-preview-06 → 0.20.0-dev-preview-11

package/tests/fireproof/crdt.test.ts

@@ -1,10 +1,10 @@
-import { CRDT, defaultWriteQueueOpts, ensureSuperThis, DatabaseOpts, toStoreURIRuntime, rt } from "@fireproof/core";
+import { CRDT, defaultWriteQueueOpts, ensureSuperThis, LedgerOpts, toStoreURIRuntime, rt, CRDTImpl } from "@fireproof/core";
 import { bs } from "@fireproof/core";
 import { CRDTMeta, DocValue } from "@fireproof/core";
 import { Index, index } from "@fireproof/core";
 
 describe("Fresh crdt", function () {
-  let crdt: CRDT<{ hello: string } | { points: number }>;
+  let crdt: CRDT;
   const sthis = ensureSuperThis();
   afterEach(async function () {
     await crdt.close();
@@ -12,13 +12,13 @@ describe("Fresh crdt", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, "test-crdt-cold"),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
   });
   it("should have an empty head", async function () {
     const head = crdt.clock.head;
@@ -44,7 +44,7 @@ describe("CRDT with one record", function () {
     readonly hello: string;
     readonly nice: string;
   }
-  let crdt: CRDT<Partial<CRDTTestType>>;
+  let crdt: CRDT;
   let firstPut: CRDTMeta;
   const sthis = ensureSuperThis();
 
@@ -55,13 +55,13 @@ describe("CRDT with one record", function () {
 
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, `test@${sthis.nextId().str}`),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     firstPut = await crdt.bulk([{ id: "hello", value: { hello: "world" } }]);
   });
   it("should have a one-element head", async function () {
@@ -90,7 +90,7 @@ describe("CRDT with one record", function () {
     expect(got).toBeFalsy();
   });
   it("should offer changes", async function () {
-    const { result } = await crdt.changes([]);
+    const { result } = await crdt.changes<Partial<CRDTTestType>>([]);
     expect(result.length).toBe(1);
     expect(result[0].id).toBe("hello");
     expect(result[0].value?.hello).toBe("world");
@@ -101,7 +101,7 @@ describe("CRDT with a multi-write", function () {
   interface CRDTTestType {
     readonly points: number;
   }
-  let crdt: CRDT<CRDTTestType>;
+  let crdt: CRDT;
   let firstPut: CRDTMeta;
   const sthis = ensureSuperThis();
 
@@ -111,13 +111,13 @@ describe("CRDT with a multi-write", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, "test-crdt-cold"),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     firstPut = await crdt.bulk([
       { id: "ace", value: { points: 11 } },
       { id: "king", value: { points: 10 } },
@@ -145,7 +145,7 @@ describe("CRDT with a multi-write", function () {
     expect(got.doc.points).toBe(10);
   });
   it("should offer changes", async function () {
-    const { result } = await crdt.changes([]);
+    const { result } = await crdt.changes<CRDTTestType>([]);
     expect(result.length).toBe(2);
     expect(result[0].id).toBe("ace");
     expect(result[0].value?.points).toBe(11);
@@ -158,7 +158,7 @@ describe("CRDT with a multi-write", function () {
       { id: "jack", value: { points: 10 } },
     ]);
     expect(secondPut.head).toBeTruthy();
-    const { result: r2, head: h2 } = await crdt.changes();
+    const { result: r2, head: h2 } = await crdt.changes<CRDTTestType>();
     expect(r2.length).toBe(4);
     const { result: r3 } = await crdt.changes(firstPut.head);
     expect(r3.length).toBe(2);
@@ -171,8 +171,7 @@ interface CRDTTestType {
   readonly points: number;
 }
 describe("CRDT with two multi-writes", function () {
-  /** @type {CRDT} */
-  let crdt: CRDT<CRDTTestType>;
+  let crdt: CRDT;
   let firstPut: CRDTMeta;
   let secondPut: CRDTMeta;
   const sthis = ensureSuperThis();
@@ -182,13 +181,13 @@ describe("CRDT with two multi-writes", function () {
   });
   beforeEach(async () => {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, `test-multiple-writes@${sthis.nextId().str}`),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     firstPut = await crdt.bulk([
       { id: "ace", value: { points: 11 } },
       { id: "king", value: { points: 10 } },
@@ -217,7 +216,7 @@ describe("CRDT with two multi-writes", function () {
     }
   });
   it("should offer changes", async function () {
-    const { result } = await crdt.changes();
+    const { result } = await crdt.changes<CRDTTestType>();
     expect(result.length).toBe(4);
     expect(result[0].id).toBe("ace");
     expect(result[0].value?.points).toBe(11);
@@ -228,7 +227,7 @@ describe("CRDT with two multi-writes", function () {
 });
 
 describe("Compact a named CRDT with writes", function () {
-  let crdt: CRDT<CRDTTestType>;
+  let crdt: CRDT;
   const sthis = ensureSuperThis();
   afterEach(async function () {
     await crdt.close();
@@ -236,13 +235,13 @@ describe("Compact a named CRDT with writes", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, `named-crdt-compaction`),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     for (let i = 0; i < 10; i++) {
       const bulk = [
         { id: "ace", value: { points: 11 } },
@@ -289,7 +288,7 @@ describe("Compact a named CRDT with writes", function () {
 });
 
 describe("CRDT with an index", function () {
-  let crdt: CRDT<CRDTTestType>;
+  let crdt: CRDT;
   let idx: Index<number, CRDTTestType>;
   const sthis = ensureSuperThis();
   afterEach(async function () {
@@ -298,18 +297,18 @@ describe("CRDT with an index", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, "test-crdt-cold"),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT<CRDTTestType>(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     await crdt.bulk([
       { id: "ace", value: { points: 11 } },
       { id: "king", value: { points: 10 } },
     ]);
-    idx = await index<number, CRDTTestType>({ crdt: crdt }, "points");
+    idx = await index<number, CRDTTestType>(crdt, "points");
   });
   it("should query the data", async function () {
     const got = await idx.query({ range: [9, 12] });
@@ -318,7 +317,7 @@ describe("CRDT with an index", function () {
     expect(got.rows[0].key).toBe(10);
   });
   it("should register the index", async function () {
-    const rIdx = await index<number, CRDTTestType>({ crdt: crdt }, "points");
+    const rIdx = await index<number, CRDTTestType>(crdt, "points");
     expect(rIdx).toBeTruthy();
     expect(rIdx.name).toBe("points");
     const got = await rIdx.query({ range: [9, 12] });
@@ -327,7 +326,7 @@ describe("CRDT with an index", function () {
     expect(got.rows[0].key).toBe(10);
   });
   it("creating a different index with same name should not work", async function () {
-    const e = await index({ crdt: crdt }, "points", (doc) => doc._id)
+    const e = await index(crdt, "points", (doc) => doc._id)
       .query()
       .catch((err) => err);
     expect(e.message).toMatch(/cannot apply/);
@@ -335,12 +334,9 @@ describe("CRDT with an index", function () {
 });
 
 describe("Loader with a committed transaction", function () {
-  interface CRDTTestType {
-    readonly foo: string;
-  }
   let loader: bs.Loader;
   let blockstore: bs.EncryptedBlockstore;
-  let crdt: CRDT<CRDTTestType>;
+  let crdt: CRDT;
   let done: CRDTMeta;
   const dbname = "test-loader";
   const sthis = ensureSuperThis();
@@ -350,13 +346,13 @@ describe("Loader with a committed transaction", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, dbname),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     blockstore = crdt.blockstore as bs.EncryptedBlockstore;
     expect(blockstore.loader).toBeTruthy();
     loader = blockstore.loader as bs.Loader;
@@ -389,11 +385,8 @@ describe("Loader with a committed transaction", function () {
 });
 
 describe("Loader with two committed transactions", function () {
-  interface CRDTTestType {
-    readonly foo: string;
-  }
   let loader: bs.Loader;
-  let crdt: CRDT<CRDTTestType>;
+  let crdt: CRDT;
   let blockstore: bs.EncryptedBlockstore;
   let done1: CRDTMeta;
   let done2: CRDTMeta;
@@ -404,13 +397,13 @@ describe("Loader with two committed transactions", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, "test-loader"),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     blockstore = crdt.blockstore as bs.EncryptedBlockstore;
     expect(blockstore.loader).toBeTruthy();
     loader = blockstore.loader as bs.Loader;
@@ -445,12 +438,9 @@ describe("Loader with two committed transactions", function () {
 });
 
 describe("Loader with many committed transactions", function () {
-  interface Doc {
-    foo: string;
-  }
   let loader: bs.Loader;
   let blockstore: bs.EncryptedBlockstore;
-  let crdt: CRDT<Doc>;
+  let crdt: CRDT;
   let dones: CRDTMeta[];
   const count = 10;
   const sthis = ensureSuperThis();
@@ -460,13 +450,13 @@ describe("Loader with many committed transactions", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    const dbOpts: DatabaseOpts = {
+    const dbOpts: LedgerOpts = {
       writeQueue: defaultWriteQueueOpts({}),
       keyBag: rt.defaultKeyBagOpts(sthis),
       storeUrls: toStoreURIRuntime(sthis, "test-loader-many"),
       storeEnDe: bs.ensureStoreEnDeFile({}),
     };
-    crdt = new CRDT(sthis, dbOpts);
+    crdt = new CRDTImpl(sthis, dbOpts);
     blockstore = crdt.blockstore as bs.EncryptedBlockstore;
     expect(blockstore.loader).toBeTruthy();
     loader = blockstore.loader as bs.Loader;

package/tests/fireproof/database.test.ts

@@ -2,19 +2,19 @@ import { URI } from "@adviser/cement";
 import { buildBlobFiles, FileWithCid, mockSuperThis } from "../helpers.js";
 import {
   bs,
-  Database,
   DocResponse,
   DocFileMeta,
   DocWithId,
   DocFiles,
   toStoreURIRuntime,
   keyConfigOpts,
-  DatabaseFactory,
-  DatabaseShell,
   ensureSuperThis,
+  Database,
+  fireproof,
+  LedgerShell,
 } from "@fireproof/core";
 
-describe("basic Database", () => {
+describe("basic Ledger", () => {
   let db: Database;
   const sthis = mockSuperThis();
   afterEach(async () => {
@@ -23,7 +23,7 @@ describe("basic Database", () => {
   });
   beforeEach(async () => {
     await sthis.start();
-    db = DatabaseFactory(undefined, {
+    db = fireproof(undefined as unknown as string, {
       logger: sthis.logger,
     });
   });
@@ -49,11 +49,11 @@ describe("basic Database", () => {
   });
 });
 
-describe("basic Database with record", function () {
+describe("basic Ledger with record", function () {
   interface Doc {
     readonly value: string;
   }
-  let db: DatabaseShell;
+  let db: Database;
   const sthis = ensureSuperThis();
   afterEach(async () => {
     await db.close();
@@ -61,7 +61,7 @@ describe("basic Database with record", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    db = DatabaseFactory("factory-name") as DatabaseShell;
+    db = fireproof("factory-name");
     const ok = await db.put<Doc>({ _id: "hello", value: "world" });
     expect(ok.id).toBe("hello");
   });
@@ -93,17 +93,18 @@ describe("basic Database with record", function () {
     expect(rows[0].value._id).toBe("hello");
   });
   it("is not persisted", async function () {
-    const db2 = DatabaseFactory("factory-name") as DatabaseShell;
+    const db2 = fireproof("factory-name");
     const { rows } = await db2.changes([]);
     expect(rows.length).toBe(1);
-    expect(db2.ref).toBe(db.ref);
+    // assert((db.ledger.ref === db2.ledger.ref, "should be the same ledger");
+    expect((db.ledger as LedgerShell).ref).toBe((db2.ledger as LedgerShell).ref);
     const doc = await db2.get<Doc>("hello").catch((e) => e);
     expect(doc.value).toBe("world");
     await db2.close();
   });
 });
 
-describe("named Database with record", function () {
+describe("named Ledger with record", function () {
   interface Doc {
     readonly value: string;
   }
@@ -115,7 +116,7 @@ describe("named Database with record", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    db = DatabaseFactory("test-db-name");
+    db = fireproof("test-db-name");
     /** @type {Doc} */
     const doc = { _id: "hello", value: "world" };
     const ok = await db.put(doc);
@@ -151,7 +152,7 @@ describe("named Database with record", function () {
   it("should have a key", async function () {
     const { rows } = await db.changes([]);
     expect(rows.length).toBe(1);
-    const blocks = db.crdt.blockstore as bs.EncryptedBlockstore;
+    const blocks = db.ledger.crdt.blockstore as bs.EncryptedBlockstore;
     const loader = blocks.loader;
     expect(loader).toBeTruthy();
     await loader.ready();
@@ -217,13 +218,13 @@ describe("named Database with record", function () {
   });
 });
 
-// describe('basic Database parallel writes / public', function () {
-//   /** @type {Database} */
+// describe('basic Ledger parallel writes / public', function () {
+//   /** @type {Ledger} */
 //   let db
 //   const writes = []
 //   beforeEach(async function () {
 //     await resetDirectory(dataDir, 'test-parallel-writes')
-//     db = new Database('test-parallel-writes', { public: true })
+//     db = new Ledger('test-parallel-writes', { public: true })
 //     /** @type {Doc} */
 //     for (let i = 0; i < 10; i++) {
 //       const doc = { _id: `id-${i}`, hello: 'world' }
@@ -232,7 +233,7 @@ describe("named Database with record", function () {
 //     await Promise.all(writes)
 //   })
 
-describe("basic Database parallel writes / public ordered", () => {
+describe("basic Ledger parallel writes / public ordered", () => {
   let db: Database;
   const writes: Promise<DocResponse>[] = [];
   const sthis = mockSuperThis();
@@ -242,7 +243,7 @@ describe("basic Database parallel writes / public ordered", () => {
   });
   beforeEach(async () => {
     await sthis.start();
-    db = DatabaseFactory("test-parallel-writes-ordered", { writeQueue: { chunkSize: 1 } });
+    db = fireproof("test-parallel-writes-ordered", { writeQueue: { chunkSize: 1 } });
     for (let i = 0; i < 10; i++) {
       const doc = { _id: `id-${i}`, hello: "world" };
       writes.push(db.put(doc));
@@ -251,13 +252,13 @@ describe("basic Database parallel writes / public ordered", () => {
   });
 
   it("should have one head", () => {
-    const crdt = db.crdt;
+    const crdt = db.ledger.crdt;
     expect(crdt.clock.head.length).toBe(1);
   });
 
   it("has changes ordered", async function () {
     const { rows, clock } = await db.changes([]);
-    expect(clock[0]).toBe(db.crdt.clock.head[0]);
+    expect(clock[0]).toBe(db.ledger.crdt.clock.head[0]);
     expect(rows.length).toBe(10);
     for (let i = 0; i < 10; i++) {
       expect(rows[i].key).toBe("id-" + i);
@@ -266,7 +267,7 @@ describe("basic Database parallel writes / public ordered", () => {
   });
 });
 
-describe("basic Database parallel writes / public", () => {
+describe("basic Ledger parallel writes / public", () => {
   let db: Database;
   const writes: Promise<DocResponse>[] = [];
   const sthis = ensureSuperThis();
@@ -276,7 +277,7 @@ describe("basic Database parallel writes / public", () => {
   });
   beforeEach(async () => {
     await sthis.start();
-    db = DatabaseFactory("test-parallel-writes", { writeQueue: { chunkSize: 32 } });
+    db = fireproof("test-parallel-writes", { writeQueue: { chunkSize: 32 } });
     for (let i = 0; i < 10; i++) {
       const doc = { _id: `id-${i}`, hello: "world" };
       writes.push(db.put(doc));
@@ -284,7 +285,7 @@ describe("basic Database parallel writes / public", () => {
     await Promise.all(writes);
   });
   it("should resolve to one head", async () => {
-    const crdt = db.crdt;
+    const crdt = db.ledger.crdt;
     expect(crdt.clock.head.length).toBe(9);
     await db.put({ _id: "id-10", hello: "world" });
     expect(crdt.clock.head.length).toBe(1);
@@ -323,7 +324,7 @@ describe("basic Database parallel writes / public", () => {
   });
   it("has changes not ordered", async function () {
     const { rows, clock } = await db.changes([]);
-    expect(clock[0]).toBe(db.crdt.clock.head[0]);
+    expect(clock[0]).toBe(db.ledger.crdt.clock.head[0]);
     expect(rows.length).toBe(10);
     rows.sort((a, b) => a.key.localeCompare(b.key));
     // console.log(rows);
@@ -337,7 +338,7 @@ describe("basic Database parallel writes / public", () => {
     expect(rows.length).toBe(10);
     // expect(db.opts.public).toBeTruthy();
     // expect(db._crdt.opts.public).toBeTruthy();
-    const blocks = db.crdt.blockstore as bs.EncryptedBlockstore;
+    const blocks = db.ledger.crdt.blockstore as bs.EncryptedBlockstore;
     const loader = blocks.loader;
     expect(loader).toBeTruthy();
     await loader.ready();
@@ -346,7 +347,7 @@ describe("basic Database parallel writes / public", () => {
   });
 });
 
-describe("basic Database with subscription", function () {
+describe("basic Ledger with subscription", function () {
   let db: Database;
   let didRun: number;
   let unsubscribe: () => void;
@@ -359,7 +360,7 @@ describe("basic Database with subscription", function () {
   });
   beforeEach(async function () {
     await sthis.start();
-    db = DatabaseFactory("factory-name");
+    db = fireproof("factory-name");
     didRun = 0;
     waitForSub = new Promise((resolve) => {
       unsubscribe = db.subscribe((docs) => {
@@ -392,18 +393,17 @@ describe("basic Database with subscription", function () {
   });
 });
 
-describe("basic Database with no update subscription", function () {
+describe("basic Ledger with no update subscription", function () {
   let db: Database;
   let didRun: number;
   let unsubscribe: () => void;
-  const sthis = ensureSuperThis();
+  // const sthis = ensureSuperThis();
   afterEach(async () => {
     await db.close();
     await db.destroy();
   });
   beforeEach(async function () {
-    await sthis.start();
-    db = DatabaseFactory("factory-name");
+    db = fireproof("factory-name");
     didRun = 0;
     unsubscribe = db.subscribe(() => {
       didRun++;
@@ -428,7 +428,7 @@ describe("basic Database with no update subscription", function () {
   });
 });
 
-describe("database with files input", () => {
+describe("ledger with files input", () => {
   let db: Database;
   let imagefiles: FileWithCid[] = [];
   let result: DocResponse;
@@ -441,7 +441,7 @@ describe("database with files input", () => {
   beforeEach(async function () {
     await sthis.start();
     imagefiles = await buildBlobFiles();
-    db = DatabaseFactory("fireproof-with-images");
+    db = fireproof("fireproof-with-images");
     const doc = {
       _id: "images-main",
       type: "files",
@@ -532,6 +532,7 @@ describe("StoreURIRuntime", () => {
     await sthis.start();
     safeEnv = sthis.env.get("FP_STORAGE_URL");
     sthis.env.set("FP_STORAGE_URL", "my://bla/storage");
+    // console.log(">>>>>>>>>>", bs, bs.registerStoreProtocol)
     unreg = bs.registerStoreProtocol({
       protocol: "murks",
       isDefault: true,