@fireproof/core 0.5.9 → 0.5.11

package/dist/hooks/use-fireproof.js

@@ -0,0 +1,149 @@
+// @ts-ignore
+import { useEffect, useState, useCallback, createContext } from 'react';
+import { Fireproof, Index } from '@fireproof/core';
+/**
+@typedef {Object} FireproofCtxValue
+@property {Function} addSubscriber - A function to add a subscriber with a label and function.
+@property {Fireproof} database - An instance of the Fireproof class.
+@property {Function} useLiveQuery - A hook to return a query result
+@property {Function} useLiveDocument - A hook to return a live document
+@property {boolean} ready - A boolean indicating whether the database is ready.
+@param {string} label - A label for the subscriber.
+@param {Function} fn - A function to be added as a subscriber.
+@returns {void}
+*/
+export const FireproofCtx = createContext({
+    addSubscriber: () => { },
+    database: null,
+    ready: false
+});
+// const inboundSubscriberQueue = new Map()
+let startedSetup = false;
+let database;
+const initializeDatabase = name => {
+    if (database)
+        return;
+    database = Fireproof.storage(name);
+};
+/**
+@function useFireproof
+React hook to initialize a Fireproof database, automatically saving and loading the clock.
+You might need to import { nodePolyfills } from 'vite-plugin-node-polyfills' in your vite.config.ts
+@param {string} name - The path to the database file
+@param {function(database): void} [defineDatabaseFn] - Synchronous function that defines the database, run this before any async calls
+@param {function(database): Promise<void>} [setupDatabaseFn] - Asynchronous function that sets up the database, run this to load fixture data etc
+@returns {FireproofCtxValue} { useLiveQuery, useLiveDocument, database, ready }
+*/
+export function useFireproof(name = 'useFireproof', defineDatabaseFn = () => { }, setupDatabaseFn = async () => { }) {
+    const [ready, setReady] = useState(false);
+    initializeDatabase(name);
+    /**
+     * @deprecated - use database.subscribe instead
+     */
+    const addSubscriber = (label, fn) => {
+        // todo test that the label is not needed
+        return database.subscribe(fn);
+        // inboundSubscriberQueue.set(label, fn)
+    };
+    useEffect(() => {
+        const doSetup = async () => {
+            if (ready)
+                return;
+            if (startedSetup)
+                return;
+            startedSetup = true;
+            defineDatabaseFn(database); // define indexes before querying them
+            if (database.clock.length === 0) {
+                await setupDatabaseFn(database);
+            }
+            setReady(true);
+        };
+        doSetup();
+    }, [ready]);
+    function useLiveDocument(initialDoc) {
+        const id = initialDoc._id;
+        const [doc, setDoc] = useState(initialDoc);
+        const saveDoc = async (newDoc) => {
+            await database.put({ _id: id, ...newDoc });
+        };
+        const refreshDoc = useCallback(async () => {
+            // todo add option for mvcc checks
+            const got = await database.get(id).catch(() => initialDoc);
+            setDoc(got);
+        }, [id, initialDoc]);
+        useEffect(() => database.subscribe(change => {
+            if (change.find(c => c.key === id)) {
+                refreshDoc(); // todo use change.value
+            }
+        }), [id, refreshDoc]);
+        useEffect(() => {
+            refreshDoc();
+        }, []);
+        return [doc, saveDoc];
+    }
+    function useLiveQuery(mapFn, query = null, initialRows = []) {
+        const [rows, setRows] = useState({ rows: initialRows, proof: {} });
+        const [index, setIndex] = useState(null);
+        const refreshRows = useCallback(async () => {
+            if (!index)
+                return;
+            const got = await index.query(query || {});
+            setRows(got);
+        }, [index, JSON.stringify(query)]);
+        useEffect(() => {
+            // todo listen to index changes
+            return database.subscribe(() => {
+                refreshRows();
+            });
+        }, [refreshRows]);
+        useEffect(() => {
+            refreshRows();
+        }, [index]);
+        useEffect(() => {
+            const index = new Index(database, null, mapFn); // this should only be created once
+            setIndex(index);
+        }, [mapFn.toString()]);
+        return rows;
+    }
+    return {
+        addSubscriber,
+        useLiveQuery,
+        useLiveDocument,
+        database,
+        ready
+    };
+}
+// const husherMap = new Map()
+// const husher = (id, workFn, ms) => {
+//   if (!husherMap.has(id)) {
+//     const start = Date.now()
+//     husherMap.set(
+//       id,
+//       workFn().finally(() => setTimeout(() => husherMap.delete(id), ms - (Date.now() - start)))
+//     )
+//   }
+//   return husherMap.get(id)
+// }
+// const hushed =
+//   (id, workFn, ms) =>
+//     (...args) =>
+//       husher(id, () => workFn(...args), ms)
+// let storageSupported = false
+// try {
+//   storageSupported = window.localStorage && true
+// } catch (e) {}
+// export function localGet (key) {
+//   if (storageSupported) {
+//     return localStorage && localStorage.getItem(key)
+//   }
+// }
+// function localSet (key, value) {
+//   if (storageSupported) {
+//     return localStorage && localStorage.setItem(key, value)
+//   }
+// }
+// function localRemove(key) {
+//   if (storageSupported) {
+//     return localStorage && localStorage.removeItem(key)
+//   }
+// }

package/dist/src/blockstore.js

@@ -0,0 +1,259 @@
+// @ts-nocheck
+import { parse } from 'multiformats/link';
+import { CID } from 'multiformats';
+import { Valet } from './valet';
+// const sleep = ms => new Promise(r => setTimeout(r, ms))
+const husherMap = new Map();
+const husher = (id, workFn) => {
+    if (!husherMap.has(id)) {
+        husherMap.set(id, workFn().finally(() => setTimeout(() => husherMap.delete(id), 100)));
+    }
+    return husherMap.get(id);
+};
+/**
+ * @typedef {{ get: (link: import('../src/link').AnyLink) => Promise<AnyBlock | undefined> }} BlockFetcher
+ */
+/**
+ * @typedef {Object} AnyBlock
+ * @property {import('./link').AnyLink} cid - The CID of the block
+ * @property {Uint8Array} bytes - The block's data
+ *
+ * @typedef {Object} Blockstore
+ * @property {function(import('./link').AnyLink): Promise<AnyBlock|undefined>} get - A function to retrieve a block by CID
+ * @property {function(import('./link').AnyLink, Uint8Array): Promise<void>} put - A function to store a block's data and CID
+ *
+ * A blockstore that caches writes to a transaction and only persists them when committed.
+*/
+export class TransactionBlockstore {
+    /** @type {Map<string, Uint8Array>} */
+    committedBlocks = new Map();
+    /** @type {Valet} */
+    valet = null;
+    instanceId = 'blkz.' + Math.random().toString(36).substring(2, 4);
+    inflightTransactions = new Set();
+    syncs = new Set();
+    constructor(name, encryptionKey) {
+        if (name) {
+            this.valet = new Valet(name, encryptionKey);
+        }
+        this.remoteBlockFunction = null;
+    }
+    /**
+     * Get a block from the store.
+     *
+     * @param {import('./link').AnyLink} cid
+     * @returns {Promise<AnyBlock | undefined>}
+     */
+    async get(cid) {
+        const key = cid.toString();
+        // it is safe to read from the in-flight transactions becauase they are immutable
+        const bytes = await Promise.any([this.transactionsGet(key), this.committedGet(key)]).catch(e => {
+            // console.log('networkGet', cid.toString(), e)
+            return this.networkGet(key);
+        });
+        if (!bytes)
+            throw new Error('Missing block: ' + key);
+        return { cid, bytes };
+    }
+    // this iterates over the in-flight transactions
+    // and returns the first matching block it finds
+    async transactionsGet(key) {
+        for (const transaction of this.inflightTransactions) {
+            const got = await transaction.get(key);
+            if (got && got.bytes)
+                return got.bytes;
+        }
+        throw new Error('Missing block: ' + key);
+    }
+    async committedGet(key) {
+        const old = this.committedBlocks.get(key);
+        // console.log('committedGet: ' + key + ' ' + this.instanceId, old.length)
+        if (old)
+            return old;
+        if (!this.valet)
+            throw new Error('Missing block: ' + key);
+        const got = await this.valet.getBlock(key);
+        this.committedBlocks.set(key, got);
+        return got;
+    }
+    async clearCommittedCache() {
+        this.committedBlocks.clear();
+    }
+    async networkGet(key) {
+        if (this.remoteBlockFunction) {
+            // todo why is this on valet?
+            const value = await husher(key, async () => await this.remoteBlockFunction(key));
+            if (value) {
+                // console.log('networkGot: ' + key, value.length)
+                doTransaction('networkGot: ' + key, this, async (innerBlockstore) => {
+                    await innerBlockstore.put(CID.parse(key), value);
+                });
+                return value;
+            }
+        }
+        else {
+            return false;
+        }
+    }
+    /**
+     * Add a block to the store. Usually bound to a transaction by a closure.
+     * It sets the lastCid property to the CID of the block that was put.
+     * This is used by the transaction as the head of the car when written to the valet.
+     * We don't have to worry about which transaction we are when we are here because
+     * we are the transactionBlockstore.
+     *
+     * @param {import('./link').AnyLink} cid
+     * @param {Uint8Array} bytes
+     */
+    put(cid, bytes) {
+        throw new Error('use a transaction to put');
+    }
+    /**
+     * Iterate over all blocks in the store.
+     *
+     * @yields {{cid: string, bytes: Uint8Array}}
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    async *entries() {
+        for (const transaction of this.inflightTransactions) {
+            for (const [str, bytes] of transaction) {
+                yield { cid: str, bytes };
+            }
+        }
+        for (const [str, bytes] of this.committedBlocks) {
+            yield { cid: str, bytes };
+        }
+        if (this.valet) {
+            for await (const { cid } of this.valet.cids()) {
+                yield { cid };
+            }
+        }
+    }
+    /**
+     * Begin a transaction. Ensures the uncommited blocks are empty at the begining.
+     * Returns the blocks to read and write during the transaction.
+     * @returns {InnerBlockstore}
+     * @memberof TransactionBlockstore
+     */
+    begin(label = '') {
+        const innerTransactionBlockstore = new InnerBlockstore(label, this);
+        this.inflightTransactions.add(innerTransactionBlockstore);
+        return innerTransactionBlockstore;
+    }
+    /**
+     * Commit the transaction. Writes the blocks to the store.
+     * @returns {Promise<void>}
+     * @memberof TransactionBlockstore
+     */
+    async commit(innerBlockstore, doSync = true) {
+        // console.log('commit', doSync, innerBlockstore.label)
+        await this.doCommit(innerBlockstore);
+        if (doSync) {
+            // const all =
+            await Promise.all([...this.syncs].map(async (sync) => sync.sendUpdate(innerBlockstore).catch(e => {
+                console.error('sync error', e);
+                this.syncs.delete(sync);
+            })));
+        }
+    }
+    // first get the transaction blockstore from the map of transaction blockstores
+    // then copy it to committedBlocks
+    // then write the transaction blockstore to a car
+    // then write the car to the valet
+    // then remove the transaction blockstore from the map of transaction blockstores
+    doCommit = async (innerBlockstore) => {
+        const cids = new Set();
+        for (const { cid, bytes } of innerBlockstore.entries()) {
+            const stringCid = cid.toString(); // unnecessary string conversion, can we fix upstream?
+            if (this.committedBlocks.has(stringCid)) {
+                // console.log('Duplicate block: ' + stringCid) // todo some of this can be avoided, cost is extra size on car files
+            }
+            else {
+                this.committedBlocks.set(stringCid, bytes);
+                cids.add(stringCid);
+            }
+        }
+        // console.log(innerBlockstore.label, 'committing', cids.size, 'blocks', [...cids].map(cid => cid.toString()), this.valet)
+        if (cids.size > 0 && this.valet) {
+            await this.valet.writeTransaction(innerBlockstore, cids);
+        }
+    };
+    /**
+     * Retire the transaction. Clears the uncommited blocks.
+     * @returns {void}
+     * @memberof TransactionBlockstore
+     */
+    retire(innerBlockstore) {
+        this.inflightTransactions.delete(innerBlockstore);
+    }
+}
+/**
+ * Runs a function on an inner blockstore, then persists the change to a car writer
+ * or other outer blockstore.
+ * @param {string} label
+ * @param {TransactionBlockstore} blockstore
+ * @param {(innerBlockstore: Blockstore) => Promise<any>} doFun
+ * @returns {Promise<any>}
+ * @memberof TransactionBlockstore
+ */
+export const doTransaction = async (label, blockstore, doFun, doSync = true) => {
+    // @ts-ignore
+    if (!blockstore.commit)
+        return await doFun(blockstore);
+    // @ts-ignore
+    const innerBlockstore = blockstore.begin(label);
+    try {
+        const result = await doFun(innerBlockstore);
+        // @ts-ignore
+        await blockstore.commit(innerBlockstore, doSync);
+        return result;
+    }
+    catch (e) {
+        console.error(`Transaction ${label} failed`, e, e.stack);
+        throw e;
+    }
+    finally {
+        // @ts-ignore
+        blockstore.retire(innerBlockstore);
+    }
+};
+export class InnerBlockstore {
+    /** @type {Map<string, Uint8Array>} */
+    blocks = new Map();
+    lastCid = null;
+    label = '';
+    parentBlockstore = null;
+    constructor(label, parentBlockstore) {
+        this.label = label;
+        this.parentBlockstore = parentBlockstore;
+    }
+    /**
+     * @param {import('./link').AnyLink} cid
+     * @returns {Promise<AnyBlock | undefined>}
+     */
+    async get(cid) {
+        const key = cid.toString();
+        let bytes = this.blocks.get(key);
+        if (bytes) {
+            return { cid, bytes };
+        }
+        bytes = await this.parentBlockstore.committedGet(key);
+        if (bytes) {
+            return { cid, bytes };
+        }
+    }
+    /**
+     * @param {import('./link').AnyLink} cid
+     * @param {Uint8Array} bytes
+     */
+    async put(cid, bytes) {
+        // console.log('put', cid)
+        this.blocks.set(cid.toString(), bytes);
+        this.lastCid = cid;
+    }
+    *entries() {
+        for (const [str, bytes] of this.blocks) {
+            yield { cid: parse(str), bytes };
+        }
+    }
+}