@peerbit/program 1.0.5 → 2.0.0

package/lib/esm/{node.d.ts → client.d.ts}

@@ -4,17 +4,9 @@ import { PubSub } from "@peerbit/pubsub-interface";
 import { Ed25519PublicKey, Identity, Keychain } from "@peerbit/crypto";
 import type { SimpleLevel } from "@peerbit/lazy-level";
 import { Multiaddr } from "@multiformats/multiaddr";
-import { Address } from "./address";
-export type WithArgs<Args> = {
-    args?: Args;
-};
-export type WithParent<T> = {
-    parent?: T;
-};
-export type CanOpen<Args> = {
-    open(args?: Args): Promise<void>;
-};
-export interface Client<T extends P, P> {
+import { Address } from "./address.js";
+import { CanOpen, Manageable, OpenOptions } from "./handler.js";
+export interface Client<T extends Manageable<any>> {
     peerId: Libp2pPeerId;
     identity: Identity<Ed25519PublicKey>;
     getMultiaddrs: () => Multiaddr[];
@@ -23,9 +15,9 @@ export interface Client<T extends P, P> {
         pubsub: PubSub;
         blocks: Blocks;
     };
-    memory?: SimpleLevel;
-    keychain?: Keychain;
+    memory: SimpleLevel;
+    keychain: Keychain;
     start(): Promise<void>;
     stop(): Promise<void>;
-    open<TExt extends T & CanOpen<Args>, Args = any>(program: TExt | Address, options?: WithArgs<Args> & WithParent<P>): Promise<TExt>;
+    open<S extends T & CanOpen<Args>, Args = any>(program: S | Address, options?: OpenOptions<Args, S>): Promise<S>;
 }

package/lib/esm/client.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=client.js.map

package/lib/esm/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":""}

package/lib/esm/handler.d.ts

@@ -0,0 +1,81 @@
+import { Blocks } from "@peerbit/blocks-interface";
+import { Address } from "./address.js";
+export declare const logger: import("pino").Logger<import("pino").LoggerOptions | import("pino").DestinationStream>;
+type ProgramMergeStrategy = "replace" | "reject" | "reuse";
+export type EventOptions = {
+    onBeforeOpen?: (program: Manageable<any>) => Promise<void> | void;
+    onOpen?: (program: Manageable<any>) => Promise<void> | void;
+    onDrop?: (program: Manageable<any>) => Promise<void> | void;
+    onClose?: (program: Manageable<any>) => Promise<void> | void;
+};
+export type OpenOptions<Args, T extends Manageable<Args>> = {
+    timeout?: number;
+    existing?: ProgramMergeStrategy;
+} & ProgramInitializationOptions<Args, T>;
+export type WithArgs<Args> = {
+    args?: Args;
+};
+export type WithParent<T> = {
+    parent?: T;
+};
+export type Closeable = {
+    closed: boolean;
+    close(): Promise<boolean>;
+};
+export type Addressable = {
+    address: Address;
+};
+export interface Saveable {
+    save(store: Blocks, options?: {
+        format?: string;
+        timeout?: number;
+    }): Promise<Address>;
+    delete(): Promise<void>;
+}
+export type CanEmit = {
+    emitEvent: (event: CustomEvent) => void;
+};
+export type CanOpen<Args> = {
+    beforeOpen: (client: any, options?: EventOptions) => Promise<void>;
+    open(args?: Args): Promise<void>;
+    afterOpen: () => Promise<void>;
+};
+export type Manageable<Args> = Closeable & Addressable & CanOpen<Args> & Saveable & CanEmit & {
+    children: Manageable<any>[];
+    parents: (Manageable<any> | undefined)[];
+};
+export type ProgramInitializationOptions<Args, T extends Manageable<Args>> = {} & WithArgs<Args> & WithParent<T> & EventOptions;
+export declare class Handler<T extends Manageable<any>> {
+    readonly properties: {
+        client: {
+            services: {
+                blocks: Blocks;
+            };
+            stop: () => Promise<void>;
+        };
+        load: (address: Address, blocks: Blocks, options?: {
+            timeout?: number;
+        }) => Promise<T | undefined>;
+        shouldMonitor: (thing: any) => boolean;
+    };
+    items: Map<string, Manageable<any>>;
+    private _openQueue;
+    constructor(properties: {
+        client: {
+            services: {
+                blocks: Blocks;
+            };
+            stop: () => Promise<void>;
+        };
+        load: (address: Address, blocks: Blocks, options?: {
+            timeout?: number;
+        }) => Promise<T | undefined>;
+        shouldMonitor: (thing: any) => boolean;
+    });
+    stop(): Promise<void>;
+    private _onProgamClose;
+    private _onProgramOpen;
+    private checkProcessExisting;
+    open<S extends T, Args = any>(storeOrAddress: S | Address | string, options?: OpenOptions<Args, S>): Promise<S>;
+}
+export {};

package/lib/esm/handler.js

@@ -0,0 +1,133 @@
+import PQueue from "p-queue";
+import { logger as loggerFn } from "@peerbit/logger";
+export const logger = loggerFn({ module: "program-handler" });
+export class Handler {
+    properties;
+    items;
+    _openQueue;
+    constructor(properties) {
+        this.properties = properties;
+        this._openQueue = new PQueue({ concurrency: 1 });
+        this.items = new Map();
+    }
+    async stop() {
+        this._openQueue.clear();
+        await this._openQueue.onIdle();
+        // Close all open databases
+        await Promise.all([...this.items.values()].map((program) => program.close()));
+        // Remove all databases from the state
+        this.items = new Map();
+    }
+    _onProgamClose(program) {
+        this.items.delete(program.address.toString());
+    }
+    async _onProgramOpen(program, mergeSrategy) {
+        const programAddress = program.address?.toString();
+        if (!programAddress) {
+            throw new Error("Missing program address");
+        }
+        if (this.items.has(programAddress)) {
+            // second condition only makes this throw error if we are to add a new instance with the same address
+            const existing = await this.checkProcessExisting(programAddress, program, mergeSrategy);
+            if (!existing) {
+                throw new Error("Unexpected");
+            }
+            this.items.set(programAddress, program);
+        }
+        else {
+            this.items.set(programAddress, program);
+        }
+    }
+    async checkProcessExisting(address, toOpen, mergeSrategy = "reject") {
+        const prev = this.items.get(address);
+        if (mergeSrategy === "reject") {
+            if (prev) {
+                throw new Error(`Program at ${address} is already open`);
+            }
+        }
+        else if (mergeSrategy === "replace") {
+            if (prev && prev !== toOpen) {
+                await prev.close(); // clouse previous
+            }
+        }
+        else if (mergeSrategy === "reuse") {
+            return prev;
+        }
+    }
+    async open(storeOrAddress, options = {}) {
+        const fn = async () => {
+            // TODO add locks for store lifecycle, e.g. what happens if we try to open and close a store at the same time?
+            let program = storeOrAddress;
+            if (typeof storeOrAddress === "string") {
+                try {
+                    if (this.items?.has(storeOrAddress.toString())) {
+                        const existing = await this.checkProcessExisting(storeOrAddress.toString(), program, options?.existing);
+                        if (existing) {
+                            return existing;
+                        }
+                    }
+                    else {
+                        program = (await this.properties.load(storeOrAddress, this.properties.client.services.blocks, options)); // TODO fix typings
+                        if (!this.properties.shouldMonitor(program)) {
+                            throw new Error(`Failed to open program because program is of type ${program?.constructor.name} `);
+                        }
+                    }
+                }
+                catch (error) {
+                    logger.error("Failed to load store with address: " + storeOrAddress.toString());
+                    throw error;
+                }
+            }
+            else if (!program.closed) {
+                const existing = this.items.get(program.address);
+                if (existing === program) {
+                    return program;
+                }
+                else if (existing) {
+                    const existing = await this.checkProcessExisting(program.address, program, options?.existing);
+                    if (existing) {
+                        return existing;
+                    }
+                }
+            }
+            logger.debug(`Open database '${program.constructor.name}`);
+            const address = await program.save(this.properties.client.services.blocks);
+            const existing = await this.checkProcessExisting(address, program, options?.existing);
+            if (existing) {
+                return existing;
+            }
+            await program.beforeOpen(this.properties.client, {
+                onBeforeOpen: async (p) => {
+                    if (this.properties.shouldMonitor(p) &&
+                        p.parents.length === 1 &&
+                        !p.parents[0]) {
+                        return this._onProgramOpen(p, options?.existing);
+                    }
+                },
+                onClose: (p) => {
+                    if (this.properties.shouldMonitor(p)) {
+                        return this._onProgamClose(p);
+                    }
+                },
+                onDrop: (p) => {
+                    if (this.properties.shouldMonitor(p)) {
+                        return this._onProgamClose(p);
+                    }
+                },
+                ...options,
+                // If the program opens more programs
+                // reset: options.reset,
+            });
+            await program.open(options.args);
+            await program.afterOpen();
+            return program;
+        };
+        // Prevent deadlocks when a program is opened by another program
+        // TODO make proper deduplciation behaviour
+        if (options?.parent) {
+            return fn();
+        }
+        return this._openQueue.add(fn); // TODO p-queue seem to return void type ;
+    }
+}
+//# sourceMappingURL=handler.js.map

package/lib/esm/handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../../src/handler.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,SAAS,CAAC;AAE7B,OAAO,EAAE,MAAM,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAyD9D,MAAM,OAAO,OAAO;IAKT;IAJV,KAAK,CAA+B;IAC5B,UAAU,CAAS;IAE3B,YACU,UAQR;QARQ,eAAU,GAAV,UAAU,CAQlB;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,IAAI;QACT,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE/B,2BAA2B;QAC3B,MAAM,OAAO,CAAC,GAAG,CAChB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAC1D,CAAC;QAEF,sCAAsC;QACtC,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;IACxB,CAAC;IAEO,cAAc,CAAC,OAAwB;QAC9C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,OAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,cAAc,CAC3B,OAAwB,EACxB,YAAmC;QAEnC,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC;QACnD,IAAI,CAAC,cAAc,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC3C;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE;YACnC,qGAAqG;YACrG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAC/C,cAAc,EACd,OAAO,EACP,YAAY,CACZ,CAAC;YACF,IAAI,CAAC,QAAQ,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;aAC9B;YACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;SACxC;aAAM;YACN,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;SACxC;IACF,CAAC;IAEO,KAAK,CAAC,oBAAoB,CACjC,OAAgB,EAChB,MAAuB,EACvB,eAAqC,QAAQ;QAE7C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,YAAY,KAAK,QAAQ,EAAE;YAC9B,IAAI,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,cAAc,OAAO,kBAAkB,CAAC,CAAC;aACzD;SACD;aAAM,IAAI,YAAY,KAAK,SAAS,EAAE;YACtC,IAAI,IAAI,IAAI,IAAI,KAAK,MAAM,EAAE;gBAC5B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,kBAAkB;aACtC;SACD;aAAM,IAAI,YAAY,KAAK,OAAO,EAAE;YACpC,OAAO,IAAS,CAAC;SACjB;IACF,CAAC;IAED,KAAK,CAAC,IAAI,CACT,cAAoC,EACpC,UAAgC,EAAE;QAElC,MAAM,EAAE,GAAG,KAAK,IAAgB,EAAE;YACjC,8GAA8G;YAC9G,IAAI,OAAO,GAAG,cAAmB,CAAC;YAClC,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;gBACvC,IAAI;oBACH,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,EAAE;wBAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAC/C,cAAc,CAAC,QAAQ,EAAE,EACzB,OAAO,EACP,OAAO,EAAE,QAAQ,CACjB,CAAC;wBACF,IAAI,QAAQ,EAAE;4BACb,OAAO,QAAa,CAAC;yBACrB;qBACD;yBAAM;wBACN,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACpC,cAAc,EACd,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EACtC,OAAO,CACP,CAAM,CAAC,CAAC,mBAAmB;wBAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;4BAC5C,MAAM,IAAI,KAAK,CACd,qDAAqD,OAAO,EAAE,WAAW,CAAC,IAAI,GAAG,CACjF,CAAC;yBACF;qBACD;iBACD;gBAAC,OAAO,KAAK,EAAE;oBACf,MAAM,CAAC,KAAK,CACX,qCAAqC,GAAG,cAAc,CAAC,QAAQ,EAAE,CACjE,CAAC;oBACF,MAAM,KAAK,CAAC;iBACZ;aACD;iBAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,QAAQ,KAAK,OAAO,EAAE;oBACzB,OAAO,OAAO,CAAC;iBACf;qBAAM,IAAI,QAAQ,EAAE;oBACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAC/C,OAAO,CAAC,OAAO,EACf,OAAO,EACP,OAAO,EAAE,QAAQ,CACjB,CAAC;oBAEF,IAAI,QAAQ,EAAE;wBACb,OAAO,QAAa,CAAC;qBACrB;iBACD;aACD;YAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CACjC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CACtC,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAC/C,OAAO,EACP,OAAO,EACP,OAAO,EAAE,QAAQ,CACjB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACb,OAAO,QAAa,CAAC;aACrB;YACD,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;gBAChD,YAAY,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;oBACzB,IACC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;wBAChC,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;wBACtB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EACZ;wBACD,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;qBACjD;gBACF,CAAC;gBACD,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;oBACd,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;wBACrC,OAAO,IAAI,CAAC,cAAc,CAAC,CAAoB,CAAC,CAAC;qBACjD;gBACF,CAAC;gBACD,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;oBACb,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;wBACrC,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;qBAC9B;gBACF,CAAC;gBACD,GAAG,OAAO;gBACV,qCAAqC;gBACrC,wBAAwB;aACxB,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAC1B,OAAO,OAAY,CAAC;QACrB,CAAC,CAAC;QAEF,gEAAgE;QAChE,2CAA2C;QAC3C,IAAI,OAAO,EAAE,MAAM,EAAE;YACpB,OAAO,EAAE,EAAE,CAAC;SACZ;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAa,CAAC,CAAC,0CAA0C;IACvF,CAAC;CACD"}

package/lib/esm/index.d.ts

@@ -1,101 +1,4 @@
-import { PublicSignKey } from "@peerbit/crypto";
-import { Constructor } from "@dao-xyz/borsh";
-import { EventEmitter } from "@libp2p/interfaces/events";
-import { Client } from "./node.js";
-import { Blocks } from "@peerbit/blocks-interface";
-import { PeerId as Libp2pPeerId } from "@libp2p/interface-peer-id";
-import { Address } from "./address.js";
-export type { Address };
-export interface Addressable {
-    address?: Address | undefined;
-}
-export interface Saveable {
-    save(store: Blocks, options?: {
-        format?: string;
-        timeout?: number;
-    }): Promise<Address>;
-    delete(): Promise<void>;
-}
-export type OpenProgram = (program: Program) => Promise<Program>;
-export interface NetworkEvents {
-    join: CustomEvent<PublicSignKey>;
-    leave: CustomEvent<PublicSignKey>;
-}
-export interface LifeCycleEvents {
-    drop: CustomEvent<Program>;
-    open: CustomEvent<Program>;
-    close: CustomEvent<Program>;
-}
-export interface ProgramEvents extends NetworkEvents, LifeCycleEvents {
-}
-type EventOptions = {
-    onBeforeOpen?: (program: AbstractProgram<any>) => Promise<void> | void;
-    onOpen?: (program: AbstractProgram<any>) => Promise<void> | void;
-    onDrop?: (program: AbstractProgram<any>) => Promise<void> | void;
-    onClose?: (program: AbstractProgram<any>) => Promise<void> | void;
-};
-export type ProgramInitializationOptions<Args> = {
-    args?: Args;
-    parent?: AbstractProgram;
-} & EventOptions;
-export type ProgramClient = Client<Program, AbstractProgram>;
-export declare abstract class AbstractProgram<Args = any, Events extends ProgramEvents = ProgramEvents> {
-    private _node;
-    private _allPrograms;
-    private _events;
-    private _closed;
-    parents: (AbstractProgram | undefined)[];
-    children: AbstractProgram[];
-    addParent(program: AbstractProgram | undefined): void;
-    get events(): EventEmitter<Events>;
-    get closed(): boolean;
-    set closed(closed: boolean);
-    get node(): ProgramClient;
-    set node(node: ProgramClient);
-    private _eventOptions;
-    beforeOpen(node: ProgramClient, options?: ProgramInitializationOptions<Args>): Promise<this>;
-    afterOpen(): Promise<this>;
-    abstract open(args?: Args): Promise<void>;
-    private _clear;
-    private _emitJoinNetworkEvents;
-    private _emitLeaveNetworkEvents;
-    private _subscriptionEventListener;
-    private _unsubscriptionEventListener;
-    private processEnd;
-    private end;
-    close(from?: AbstractProgram): Promise<boolean>;
-    drop(from?: AbstractProgram): Promise<boolean>;
-    emitEvent(event: CustomEvent, parents?: boolean): void;
-    /**
-     * Wait for another peer to be 'ready' to talk with you for this particular program
-     * @param other
-     */
-    waitFor(...other: (PublicSignKey | Libp2pPeerId)[]): Promise<void>;
-    getReady(): Promise<Set<string>>;
-    get allPrograms(): AbstractProgram[];
-    get programs(): AbstractProgram[];
-    clone(): this;
-    getTopics?(): string[];
-}
-export interface CanTrust {
-    isTrusted(keyHash: string): Promise<boolean> | boolean;
-}
-export declare abstract class Program<Args = any, Events extends ProgramEvents = ProgramEvents> extends AbstractProgram<Args, Events> implements Addressable, Saveable {
-    private _address?;
-    constructor();
-    get address(): Address;
-    set address(address: Address);
-    beforeOpen(node: ProgramClient, options?: ProgramInitializationOptions<Args>): Promise<this>;
-    static open<T extends Program<Args>, Args = any>(this: Constructor<T>, address: Address, node: ProgramClient, options?: ProgramInitializationOptions<Args>): Promise<T>;
-    save(store?: Blocks): Promise<Address>;
-    delete(): Promise<void>;
-    static load<P extends Program<any>>(address: Address, store: Blocks, options?: {
-        timeout?: number;
-    }): Promise<P | undefined>;
-    drop(from?: AbstractProgram): Promise<boolean>;
-}
-/**eve
- * Building block, but not something you use as a standalone
- */
-export declare abstract class ComposableProgram<Args = any, Events extends ProgramEvents = ProgramEvents> extends AbstractProgram<Args, Events> {
-}
+export { type ProgramInitializationOptions, type OpenOptions, } from "./handler.js";
+export * from "./client.js";
+export * from "./program.js";
+export * from "./address.js";