@earendil-works/pi-durable 1.2.0 → 1.3.0

package/dist/storage/sqlite/storage.js

@@ -2,7 +2,8 @@ import { apply } from "@earendil-works/chord/delta";
 import { StorageRequestError } from "../../errors.js";
 import { idFromNumber, seqFromNumber } from "../../ids.js";
 import { nextCursor, scanStart } from "../scan.js";
-import { applySqliteMigrations } from "./migrations.js";
+import { applySqliteMigrationsForSchema } from "./migrations.js";
+import { createSqliteSchema } from "./schema.js";
 const parseJson = (value) => JSON.parse(value);
 const encodeJson = (value) => JSON.stringify(value);
 // Some SQLite bindings replace lone UTF-16 surrogates. JSON encoding keeps indexed identities lossless.
@@ -72,23 +73,26 @@ const writeId = (write) => {
 /** Portable SQLite implementation of the Pico storage contract. */
 export class SqliteStorage {
     db;
+    schema;
     nextId;
     closed = false;
     closing;
     admittedReads = 0;
     readsDrained;
-    constructor(db, nextId) {
+    constructor(db, schema, nextId) {
         this.db = db;
+        this.schema = schema;
         this.nextId = nextId;
     }
     /** Initialize storage over an owned SQLite database facade. */
-    static async open(db) {
+    static async open(db, options = {}) {
         try {
-            await applySqliteMigrations(db);
-            const metadata = await db.get("SELECT next_id, next_seq FROM durable_metadata WHERE singleton = 1");
+            const schema = createSqliteSchema(options.prefix);
+            await applySqliteMigrationsForSchema(db, schema);
+            const metadata = await db.get(`SELECT next_id, next_seq FROM ${schema.tables.durableMetadata} WHERE singleton = 1`);
             if (metadata === undefined)
                 throw new Error("Durable SQLite metadata is missing");
-            return new SqliteStorage(db, Number(metadata.next_id));
+            return new SqliteStorage(db, schema, Number(metadata.next_id));
         }
         catch (error) {
             try {
@@ -105,7 +109,7 @@ export class SqliteStorage {
         const documentActions = this.prepareDocumentActions(writes);
         const candidateNextId = this.candidateNextId(writes);
         const seq = await this.db.transaction(async (transaction) => {
-            const metadata = await transaction.get("SELECT next_id, next_seq FROM durable_metadata WHERE singleton = 1");
+            const metadata = await transaction.get(`SELECT next_id, next_seq FROM ${this.schema.tables.durableMetadata} WHERE singleton = 1`);
             if (metadata === undefined)
                 throw new Error("Durable SQLite metadata is missing");
             const committedSeq = seqFromNumber(metadata.next_seq);
@@ -114,7 +118,7 @@ export class SqliteStorage {
             for (const write of writes)
                 await this.applyTableWrite(transaction, write, committedSeq);
             await this.applyDocumentActions(transaction, documentActions, committedSeq);
-            await transaction.run("UPDATE durable_metadata SET next_id = ?, next_seq = ? WHERE singleton = 1", String(Math.max(Number(metadata.next_id), candidateNextId)), committedSeq + 1);
+            await transaction.run(`UPDATE ${this.schema.tables.durableMetadata} SET next_id = ?, next_seq = ? WHERE singleton = 1`, String(Math.max(Number(metadata.next_id), candidateNextId)), committedSeq + 1);
             return committedSeq;
         });
         this.nextId = Math.max(this.nextId, candidateNextId);
@@ -128,7 +132,7 @@ export class SqliteStorage {
     }
     async conversation(id, _context) {
         this.assertOpen();
-        const row = await this.db.get("SELECT record FROM conversations WHERE id = ?", id);
+        const row = await this.db.get(`SELECT record FROM ${this.schema.tables.conversations} WHERE id = ?`, id);
         return row === undefined ? undefined : parseJson(row.record);
     }
     async scanConversations(query, limit, cursor, _context) {
@@ -146,7 +150,7 @@ export class SqliteStorage {
             params.push(query.ownerTaskId);
         }
         params.push(limit + 1);
-        const rows = await this.db.all(`SELECT record FROM conversations WHERE ${clauses.join(" AND ")} ORDER BY id ${scan.direction} LIMIT ?`, ...params);
+        const rows = await this.db.all(`SELECT record FROM ${this.schema.tables.conversations} WHERE ${clauses.join(" AND ")} ORDER BY id ${scan.direction} LIMIT ?`, ...params);
         return page(rows.map((row) => parseJson(row.record)), limit, start.order);
     }
     entry(idOrConversationId, idOrContext, context) {
@@ -173,7 +177,7 @@ export class SqliteStorage {
             if (conversation === undefined)
                 throw new StorageRequestError(`Unknown conversation: ${conversationId}`);
         }
-        const row = await this.db.get("SELECT record, commit_seq FROM entries WHERE id = ?", id);
+        const row = await this.db.get(`SELECT record, commit_seq FROM ${this.schema.tables.entries} WHERE id = ?`, id);
         if (row === undefined)
             return undefined;
         const entry = parseJson(row.record);
@@ -197,8 +201,8 @@ export class SqliteStorage {
         let upper = atOrBeforeEntryId;
         while (true) {
             const row = upper === undefined
-                ? await this.db.get("SELECT record FROM entries WHERE conversation_id = ? AND head IS NOT NULL ORDER BY id DESC LIMIT 1", conversation.id)
-                : await this.db.get("SELECT record FROM entries WHERE conversation_id = ? AND head IS NOT NULL AND id <= ? ORDER BY id DESC LIMIT 1", conversation.id, upper);
+                ? await this.db.get(`SELECT record FROM ${this.schema.tables.entries} WHERE conversation_id = ? AND head IS NOT NULL ORDER BY id DESC LIMIT 1`, conversation.id)
+                : await this.db.get(`SELECT record FROM ${this.schema.tables.entries} WHERE conversation_id = ? AND head IS NOT NULL AND id <= ? ORDER BY id DESC LIMIT 1`, conversation.id, upper);
             if (row !== undefined)
                 return parseJson(row.record);
             if (conversation.parent === undefined)
@@ -230,7 +234,7 @@ export class SqliteStorage {
                 params.push(upper);
             }
             params.push(limit + 1 - values.length);
-            const rows = await this.db.all(`SELECT record FROM entries WHERE ${clauses.join(" AND ")} ORDER BY id DESC LIMIT ?`, ...params);
+            const rows = await this.db.all(`SELECT record FROM ${this.schema.tables.entries} WHERE ${clauses.join(" AND ")} ORDER BY id DESC LIMIT ?`, ...params);
             values.push(...rows.map((row) => parseJson(row.record)));
             if (values.length > limit || conversation.parent === undefined)
                 break;
@@ -273,7 +277,7 @@ export class SqliteStorage {
                 params.push(segment.upper);
             }
             params.push(limit + 1 - values.length);
-            const rows = await this.db.all(`SELECT record FROM entries WHERE ${clauses.join(" AND ")} ORDER BY id ASC LIMIT ?`, ...params);
+            const rows = await this.db.all(`SELECT record FROM ${this.schema.tables.entries} WHERE ${clauses.join(" AND ")} ORDER BY id ASC LIMIT ?`, ...params);
             values.push(...rows.map((row) => parseJson(row.record)));
             if (values.length > limit)
                 break;
@@ -282,7 +286,7 @@ export class SqliteStorage {
     }
     async task(id, _context) {
         this.assertOpen();
-        const row = await this.db.get("SELECT record FROM tasks WHERE id = ?", id);
+        const row = await this.db.get(`SELECT record FROM ${this.schema.tables.tasks} WHERE id = ?`, id);
         return row === undefined ? undefined : parseJson(row.record);
     }
     async scanTasks(query, limit, cursor, _context) {
@@ -312,12 +316,12 @@ export class SqliteStorage {
             params.push(query.background ? 1 : 0);
         }
         params.push(limit + 1);
-        const rows = await this.db.all(`SELECT record FROM tasks WHERE ${clauses.join(" AND ")} ORDER BY id ${scan.direction} LIMIT ?`, ...params);
+        const rows = await this.db.all(`SELECT record FROM ${this.schema.tables.tasks} WHERE ${clauses.join(" AND ")} ORDER BY id ${scan.direction} LIMIT ?`, ...params);
         return page(rows.map((row) => parseJson(row.record)), limit, start.order);
     }
     async submission(id, _context) {
         this.assertOpen();
-        const row = await this.db.get("SELECT record FROM submissions WHERE id = ?", id);
+        const row = await this.db.get(`SELECT record FROM ${this.schema.tables.submissions} WHERE id = ?`, id);
         return row === undefined ? undefined : parseJson(row.record);
     }
     async scanSubmissions(query, limit, cursor, _context) {
@@ -335,22 +339,22 @@ export class SqliteStorage {
             params.push(query.status);
         }
         params.push(limit + 1);
-        const rows = await this.db.all(`SELECT record FROM submissions WHERE ${clauses.join(" AND ")} ORDER BY id ${scan.direction} LIMIT ?`, ...params);
+        const rows = await this.db.all(`SELECT record FROM ${this.schema.tables.submissions} WHERE ${clauses.join(" AND ")} ORDER BY id ${scan.direction} LIMIT ?`, ...params);
         return page(rows.map((row) => parseJson(row.record)), limit, start.order);
     }
     async submissionByRequest(conversationId, requestId, _context) {
         this.assertOpen();
-        const row = await this.db.get("SELECT record FROM submissions WHERE conversation_id = ? AND request_id = ?", conversationId, encodeIndexedString(requestId));
+        const row = await this.db.get(`SELECT record FROM ${this.schema.tables.submissions} WHERE conversation_id = ? AND request_id = ?`, conversationId, encodeIndexedString(requestId));
         return row === undefined ? undefined : parseJson(row.record);
     }
     async findDocument(address, at, _context) {
         this.assertOpen();
         const parts = addressParts(address);
         const sql = at === "current"
-            ? `SELECT record FROM documents
+            ? `SELECT record FROM ${this.schema.tables.documents}
 					WHERE kind = ? AND scope_kind = ? AND owner_id = ? AND family = ? AND key_value = ?
 					AND retired_at IS NULL ORDER BY created_at DESC LIMIT 1`
-            : `SELECT record FROM documents
+            : `SELECT record FROM ${this.schema.tables.documents}
 					WHERE kind = ? AND scope_kind = ? AND owner_id = ? AND family = ? AND key_value = ?
 					AND created_at <= ? AND (retired_at IS NULL OR retired_at > ?)
 					ORDER BY created_at DESC LIMIT 1`;
@@ -382,7 +386,7 @@ export class SqliteStorage {
             params.push(query.at, query.at);
         }
         params.push(limit + 1);
-        const rows = await this.db.all(`SELECT record FROM documents WHERE ${clauses.join(" AND ")} ORDER BY id LIMIT ?`, ...params);
+        const rows = await this.db.all(`SELECT record FROM ${this.schema.tables.documents} WHERE ${clauses.join(" AND ")} ORDER BY id LIMIT ?`, ...params);
         return page(rows.map((row) => parseJson(row.record)), limit);
     }
     close(_context) {
@@ -416,11 +420,11 @@ export class SqliteStorage {
         }
     }
     async readConversation(id) {
-        const row = await this.db.get("SELECT record FROM conversations WHERE id = ?", id);
+        const row = await this.db.get(`SELECT record FROM ${this.schema.tables.conversations} WHERE id = ?`, id);
         return row === undefined ? undefined : parseJson(row.record);
     }
     async materializeDocument(executor, id, at) {
-        const row = await executor.get("SELECT record FROM documents WHERE id = ?", id);
+        const row = await executor.get(`SELECT record FROM ${this.schema.tables.documents} WHERE id = ?`, id);
         if (row === undefined)
             return undefined;
         const record = parseJson(row.record);
@@ -430,12 +434,12 @@ export class SqliteStorage {
         if (!isAliveAt(record, at))
             return undefined;
         const upper = at === "current" ? Number.MAX_SAFE_INTEGER : at;
-        const base = await executor.get(`SELECT seq, kind, version, content FROM document_revisions
+        const base = await executor.get(`SELECT seq, kind, version, content FROM ${this.schema.tables.documentRevisions}
 				WHERE document_id = ? AND kind = 'base' AND seq <= ? ORDER BY seq DESC LIMIT 1`, id, upper);
         if (base === undefined)
             throw new Error(`Document ${id} is missing a required base`);
         let value = parseJson(base.content);
-        const tail = await executor.all(`SELECT seq, kind, version, content FROM document_revisions
+        const tail = await executor.all(`SELECT seq, kind, version, content FROM ${this.schema.tables.documentRevisions}
 				WHERE document_id = ? AND seq > ? AND seq <= ? ORDER BY seq`, id, base.seq, upper);
         for (const revision of tail) {
             if (revision.kind !== "delta" || revision.version !== base.version) {
@@ -462,8 +466,7 @@ export class SqliteStorage {
             const document = write.type === "document.create" || write.type === "document.copy";
             const table = document ? "document" : write.type;
             const id = document ? write.record.id : write.value.id;
-            const existing = (await executor.get("SELECT record_type FROM record_ids WHERE id = ?", id))
-                ?.record_type;
+            const existing = (await executor.get(`SELECT record_type FROM ${this.schema.tables.recordIds} WHERE id = ?`, id))?.record_type;
             const earlier = claimed.get(id);
             if (table === "conversation" || table === "entry" || table === "document") {
                 if (existing !== undefined)
@@ -531,7 +534,7 @@ export class SqliteStorage {
             if (action.copy !== undefined && actions.has(action.copy.id)) {
                 throw new Error(`Document copy ${id} source is changed in the copy batch`);
             }
-            const row = await executor.get("SELECT record FROM documents WHERE id = ?", id);
+            const row = await executor.get(`SELECT record FROM ${this.schema.tables.documents} WHERE id = ?`, id);
             const existing = row === undefined ? undefined : parseJson(row.record);
             if (action.create === undefined && existing === undefined)
                 throw new Error(`Unknown document: ${id}`);
@@ -540,7 +543,7 @@ export class SqliteStorage {
             if (existing?.retiredAt !== undefined)
                 throw new Error(`Document ${id} is retired`);
             if (action.content?.kind === "delta") {
-                const previous = await executor.get("SELECT version FROM document_revisions WHERE document_id = ? ORDER BY seq DESC LIMIT 1", id);
+                const previous = await executor.get(`SELECT version FROM ${this.schema.tables.documentRevisions} WHERE document_id = ? ORDER BY seq DESC LIMIT 1`, id);
                 if (previous === undefined)
                     throw new Error(`Document ${id} delta has no base`);
                 if (previous.version !== action.content.version) {
@@ -565,7 +568,7 @@ export class SqliteStorage {
     }
     async currentDocumentId(executor, address) {
         const parts = addressParts(address);
-        const id = (await executor.get(`SELECT id FROM documents
+        const id = (await executor.get(`SELECT id FROM ${this.schema.tables.documents}
 				WHERE kind = ? AND scope_kind = ? AND owner_id = ? AND family = ? AND key_value = ? AND retired_at IS NULL
 				LIMIT 1`, parts.kind, parts.scopeKind, parts.ownerId, parts.family, parts.keyValue))?.id;
         return id === undefined ? undefined : idFromNumber(id);
@@ -574,15 +577,15 @@ export class SqliteStorage {
         switch (write.type) {
             case "conversation":
                 await this.claimId(executor, write.value.id, "conversation");
-                await executor.run("INSERT INTO conversations (id, owner_conversation_id, owner_task_id, record) VALUES (?, ?, ?, ?)", write.value.id, write.value.owner?.conversationId ?? null, write.value.owner?.taskId ?? null, encodeJson(write.value));
+                await executor.run(`INSERT INTO ${this.schema.tables.conversations} (id, owner_conversation_id, owner_task_id, record) VALUES (?, ?, ?, ?)`, write.value.id, write.value.owner?.conversationId ?? null, write.value.owner?.taskId ?? null, encodeJson(write.value));
                 break;
             case "entry":
                 await this.claimId(executor, write.value.id, "entry");
-                await executor.run("INSERT INTO entries (id, conversation_id, head, commit_seq, record) VALUES (?, ?, ?, ?, ?)", write.value.id, write.value.conversationId, write.value.head ?? null, seq, encodeJson(write.value));
+                await executor.run(`INSERT INTO ${this.schema.tables.entries} (id, conversation_id, head, commit_seq, record) VALUES (?, ?, ?, ?, ?)`, write.value.id, write.value.conversationId, write.value.head ?? null, seq, encodeJson(write.value));
                 break;
             case "task":
                 await this.claimId(executor, write.value.id, "task");
-                await executor.run(`INSERT INTO tasks (id, conversation_id, kind, status, abort_requested, background, record)
+                await executor.run(`INSERT INTO ${this.schema.tables.tasks} (id, conversation_id, kind, status, abort_requested, background, record)
 						VALUES (?, ?, ?, ?, ?, ?, ?)
 						ON CONFLICT(id) DO UPDATE SET conversation_id = excluded.conversation_id, kind = excluded.kind,
 						status = excluded.status, abort_requested = excluded.abort_requested,
@@ -590,7 +593,7 @@ export class SqliteStorage {
                 break;
             case "submission":
                 await this.claimId(executor, write.value.id, "submission");
-                await executor.run(`INSERT INTO submissions (id, conversation_id, request_id, status, record) VALUES (?, ?, ?, ?, ?)
+                await executor.run(`INSERT INTO ${this.schema.tables.submissions} (id, conversation_id, request_id, status, record) VALUES (?, ?, ?, ?, ?)
 						ON CONFLICT(id) DO UPDATE SET conversation_id = excluded.conversation_id,
 						request_id = excluded.request_id, status = excluded.status, record = excluded.record`, write.value.id, write.value.conversationId, write.value.requestId === undefined ? null : encodeIndexedString(write.value.requestId), write.value.status, encodeJson(write.value));
                 break;
@@ -602,7 +605,7 @@ export class SqliteStorage {
         }
     }
     async claimId(executor, id, table) {
-        await executor.run("INSERT OR IGNORE INTO record_ids (id, record_type) VALUES (?, ?)", id, table);
+        await executor.run(`INSERT OR IGNORE INTO ${this.schema.tables.recordIds} (id, record_type) VALUES (?, ?)`, id, table);
     }
     async applyDocumentActions(executor, actions, seq) {
         for (const [id, action] of actions) {
@@ -636,28 +639,28 @@ export class SqliteStorage {
                 };
                 const parts = addressParts(record);
                 await this.claimId(executor, id, "document");
-                await executor.run(`INSERT INTO documents
+                await executor.run(`INSERT INTO ${this.schema.tables.documents}
 						(id, kind, family, key_value, scope_kind, owner_id, created_at, retired_at, record)
 						VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`, id, parts.kind, parts.family, parts.keyValue, parts.scopeKind, parts.ownerId, seq, action.retire ? seq : null, encodeJson(record));
             }
             else {
-                const row = (await executor.get("SELECT record FROM documents WHERE id = ?", id));
+                const row = (await executor.get(`SELECT record FROM ${this.schema.tables.documents} WHERE id = ?`, id));
                 record = parseJson(row.record);
             }
             if (content !== undefined) {
                 if (content.kind === "base" && isCurrentOnly(record)) {
-                    await executor.run("DELETE FROM document_revisions WHERE document_id = ?", id);
+                    await executor.run(`DELETE FROM ${this.schema.tables.documentRevisions} WHERE document_id = ?`, id);
                 }
                 const encodedContent = content.kind === "base" ? encodeJson(content.value) : encodeJson(content.ops);
-                await executor.run("INSERT INTO document_revisions (document_id, seq, kind, version, content) VALUES (?, ?, ?, ?, ?)", id, seq, content.kind, content.version, encodedContent);
+                await executor.run(`INSERT INTO ${this.schema.tables.documentRevisions} (document_id, seq, kind, version, content) VALUES (?, ?, ?, ?, ?)`, id, seq, content.kind, content.version, encodedContent);
             }
             if (action.retire) {
                 if (action.create === undefined) {
                     record = { ...record, retiredAt: seq };
-                    await executor.run("UPDATE documents SET retired_at = ?, record = ? WHERE id = ?", seq, encodeJson(record), id);
+                    await executor.run(`UPDATE ${this.schema.tables.documents} SET retired_at = ?, record = ? WHERE id = ?`, seq, encodeJson(record), id);
                 }
                 if (isCurrentOnly(record)) {
-                    await executor.run("DELETE FROM document_revisions WHERE document_id = ?", id);
+                    await executor.run(`DELETE FROM ${this.schema.tables.documentRevisions} WHERE document_id = ?`, id);
                 }
             }
         }