keri-ts 0.11.0 → 2.0.0

package/esm/keri/npm/src/db/outboxing.js

@@ -1,371 +0,0 @@
-import { DatabaseNotOpenError, ValidationError } from "../core/errors.js";
-import { OutboxMessageRecord, OutboxTargetRecord, } from "../core/records.js";
-import { LMDBer } from "./core/lmdber.js";
-import { Komer } from "./koming.js";
-import { Suber } from "./subing.js";
-/**
- * No-op outboxer used when the Tufa-only retry sidecar is disabled.
- *
- * The rest of the runtime still talks to the same interface, but no retry
- * state is persisted or replayed.
- */
-export class DisabledOutboxer {
-    constructor() {
-        Object.defineProperty(this, "enabled", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-    }
-    pendingCount() {
-        return 0;
-    }
-    *iterPending() {
-        return;
-    }
-    queueMessage(_said, _raw, _message, _eids) { }
-    markDelivered(_said, _eid, _deliveredAt) { }
-    markFailed(_said, _eid, _attemptedAt, _error) { }
-    cancelTarget(_said, _eid, _cancelledAt, _error = "cancelled") { }
-    cancelMailbox(_eid, _cancelledAt) { }
-    *close(_clear = false) {
-        return true;
-    }
-}
-/** Raw-byte value family used for stored outbound message payloads. */
-class BytesSuber extends Suber {
-    _ser(val) {
-        return new Uint8Array(val);
-    }
-    _des(val) {
-        return val === null ? null : new Uint8Array(val);
-    }
-}
-/** Native metadata preflight before the existing record decoder; no general Komer policy change. */
-class OutboxKomer extends Komer {
-    getBounded(keys, maxBytes) {
-        return this._des(this.db.getValBounded(this.sdb, this._tokey(keys), maxBytes));
-    }
-}
-/**
- * Durable sender-side mailbox delivery retry storage.
- *
- * Storage model:
- * - `.msgs` stores the raw signed message by logical message SAID
- * - `.items` stores message metadata keyed by SAID
- * - `.tgts` stores per-mailbox-target delivery state keyed by `(said, eid)`
- */
-export class Outboxer extends LMDBer {
-    constructor(options = {}) {
-        const compat = options.compat ?? false;
-        super(options, {
-            tailDirPath: Outboxer.TailDirPath,
-            cleanTailDirPath: "keri/clean/obx",
-            altTailDirPath: compat ? Outboxer.CompatAltTailDirPath : Outboxer.AltTailDirPath,
-            altCleanTailDirPath: compat ? ".keri/clean/obx" : ".tufa/clean/obx",
-            tempPrefix: Outboxer.TempPrefix,
-            maxNamedDBs: Outboxer.MaxNamedDBs,
-        });
-        Object.defineProperty(this, "enabled", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        Object.defineProperty(this, "msgs", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "items", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "tgts", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-    }
-    *reopen(options = {}) {
-        const opened = yield* super.reopen(options);
-        if (!opened) {
-            return false;
-        }
-        this.msgs = new BytesSuber(this, { subkey: "msgs." });
-        this.items = new OutboxKomer(this, {
-            subkey: "items.",
-            recordClass: OutboxMessageRecord,
-        });
-        this.tgts = new OutboxKomer(this, {
-            subkey: "tgts.",
-            recordClass: OutboxTargetRecord,
-        });
-        return true;
-    }
-    /**
-     * Persist one logical outbound message and seed per-mailbox-target state.
-     *
-     * The message SAID identifies the logical message, while target rows track
-     * delivery independently per mailbox endpoint. Payload, metadata and target
-     * publication share one transaction, including failed replacement rollback.
-     */
-    queueMessage(said, raw, message, eids) {
-        this.commitMessageRows(() => {
-            this.msgs.pin(said, raw);
-            this.items.pin([said], message);
-            for (const eid of eids) {
-                this.tgts.pin([said, eid], {
-                    eid,
-                    status: "pending",
-                    attempts: 0,
-                    lastAttemptAt: null,
-                    deliveredAt: null,
-                    lastError: null,
-                });
-            }
-        });
-    }
-    /** Return the raw signed payload for one logical outbound message. */
-    getMessage(said) {
-        return this.msgs.get(said);
-    }
-    /** Return the metadata row for one logical outbound message. */
-    getRecord(said) {
-        return this.items.get([said]);
-    }
-    /** Return the per-target state row for one logical message and mailbox. */
-    getTarget(said, eid) {
-        return this.tgts.get([said, eid]);
-    }
-    /** Count mailbox-target rows that still need delivery work. */
-    pendingCount() {
-        let count = 0;
-        for (const [, target] of this.tgts.getTopItemIter()) {
-            if (target.status === "pending") {
-                count += 1;
-            }
-        }
-        return count;
-    }
-    /** Iterate each mailbox-target row that is still pending. */
-    *iterPending() {
-        for (const [keys, target] of this.tgts.getTopItemIter()) {
-            const said = keys[0];
-            const eid = keys[1];
-            if (!said || !eid || target.status !== "pending") {
-                continue;
-            }
-            const message = this.items.get([said]);
-            const raw = this.msgs.get(said);
-            if (!message || !raw) {
-                continue;
-            }
-            yield {
-                said,
-                message,
-                raw,
-                target,
-            };
-        }
-    }
-    /**
-     * Keys-only live scan avoids native value materialization by getRange. Each target,
-     * metadata and payload row uses the pinned bounded read before copying or decoding.
-     * Caller retains finite copy/metadata credit through iterator return and last use.
-     */
-    *iterPendingBounded(limits) {
-        for (const limit of [limits.maxMessageBytes, limits.maxMetadataBytes]) {
-            if (!Number.isSafeInteger(limit) || limit < 1)
-                throw new RangeError("Invalid outbox row ceiling");
-        }
-        for (const key of this.tgts.sdb.getKeys({ snapshot: false })) {
-            const [said, eid] = this.tgts._tokeys(key);
-            if (!said || !eid)
-                continue;
-            const target = this.tgts.getBounded(key, limits.maxMetadataBytes);
-            if (!target || target.status !== "pending")
-                continue;
-            const message = this.items.getBounded([said], limits.maxMetadataBytes);
-            const raw = this.msgs.getBounded(said, limits.maxMessageBytes);
-            if (message && raw)
-                yield { said, message, raw, target };
-        }
-    }
-    /**
-     * Mark one mailbox target delivered and prune the parent message when all
-     * targets are terminal. The target outcome and final pruning commit together.
-     */
-    markDelivered(said, eid, deliveredAt) {
-        this.commitMessageRows(() => {
-            this.pinTarget(said, eid, {
-                status: "delivered",
-                deliveredAt,
-                lastAttemptAt: deliveredAt,
-                lastError: null,
-            });
-            this.pruneIfComplete(said);
-        });
-    }
-    /**
-     * Record one failed attempt while keeping the target pending for future
-     * retry.
-     */
-    markFailed(said, eid, attemptedAt, error) {
-        const current = this.requireTarget(said, eid);
-        this.tgts.pin([said, eid], {
-            ...current.asDict(),
-            eid,
-            status: "pending",
-            attempts: (current.attempts ?? 0) + 1,
-            lastAttemptAt: attemptedAt,
-            lastError: error,
-        });
-    }
-    /**
-     * Cancel one mailbox target explicitly.
-     *
-     * Cancellation is terminal and participates in message pruning once no
-     * pending targets remain.
-     */
-    cancelTarget(said, eid, cancelledAt, error = "cancelled") {
-        this.commitMessageRows(() => {
-            this.pinTarget(said, eid, {
-                status: "cancelled",
-                lastAttemptAt: cancelledAt,
-                lastError: error,
-            });
-            this.pruneIfComplete(said);
-        });
-    }
-    /** Cancel every pending target that points at one removed mailbox AID. */
-    cancelMailbox(eid, cancelledAt) {
-        for (const [keys, target] of this.tgts.getTopItemIter()) {
-            const said = keys[0];
-            const targetEid = keys[1];
-            if (!said || targetEid !== eid || target.status !== "pending") {
-                continue;
-            }
-            this.cancelTarget(said, eid, cancelledAt, "mailbox removed");
-        }
-    }
-    /** Atomically remove payload, metadata and all target rows for one logical message. */
-    removeMessage(said) {
-        this.commitMessageRows(() => {
-            this.msgs.rem(said);
-            this.items.rem([said]);
-            this.tgts.trim([said], { topive: true });
-        });
-    }
-    /** Keep each logical message's row ownership in one synchronous LMDB transaction. */
-    commitMessageRows(update) {
-        const env = this.env;
-        if (!env)
-            throw new DatabaseNotOpenError("Outbox environment is not open");
-        env.transactionSync(update);
-    }
-    pinTarget(said, eid, patch) {
-        const current = this.requireTarget(said, eid);
-        this.tgts.pin([said, eid], {
-            ...current.asDict(),
-            ...patch,
-            eid,
-        });
-    }
-    pruneIfComplete(said) {
-        let pending = false;
-        for (const [, target] of this.tgts.getTopItemIter([said], { topive: true })) {
-            if (target.status === "pending") {
-                pending = true;
-                break;
-            }
-        }
-        if (!pending) {
-            this.removeMessage(said);
-        }
-    }
-    requireTarget(said, eid) {
-        const target = this.tgts.get([said, eid]);
-        if (!target) {
-            throw new DatabaseNotOpenError(`Missing outbox target state for ${said}:${eid}.`);
-        }
-        return target;
-    }
-}
-/** Default primary path for Tufa-owned outbox environments. */
-Object.defineProperty(Outboxer, "TailDirPath", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: "keri/obx"
-});
-/** Default alternate path for Tufa-owned outbox environments. */
-Object.defineProperty(Outboxer, "AltTailDirPath", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: ".tufa/obx"
-});
-/** Unused compat path kept only to mirror `LMDBer` configuration shape. */
-Object.defineProperty(Outboxer, "CompatAltTailDirPath", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: ".keri/obx"
-});
-Object.defineProperty(Outboxer, "TempPrefix", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: "keri_obx_"
-});
-Object.defineProperty(Outboxer, "MaxNamedDBs", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: 8
-});
-/**
- * Open the optional sender retry sidecar.
- *
- * Compatibility rule:
- * - compat mode is rejected because KERIpy stores do not model this additive
- *   domain
- * - `mustExist` is used by commands that require a previously initialized
- *   outbox sidecar instead of silently creating one
- */
-export function* createOutboxer(options = {}) {
-    const { mustExist = false, ...openOptions } = options;
-    if (openOptions.compat) {
-        throw new ValidationError("Outboxer is a tufa-only sidecar and is unavailable in compat mode.");
-    }
-    const outboxer = new Outboxer(openOptions);
-    let delivered = false;
-    try {
-        if (mustExist) {
-            const exists = yield* outboxer.reopen({
-                ...openOptions,
-                readonly: true,
-            });
-            if (!exists) {
-                throw new ValidationError("Outboxer is not enabled for this keystore. Re-run `tufa init --outboxer` to create it.");
-            }
-            yield* outboxer.close();
-        }
-        const opened = yield* outboxer.reopen(openOptions);
-        if (!opened) {
-            throw new DatabaseNotOpenError("Failed to open Outboxer");
-        }
-        delivered = true;
-        return outboxer;
-    }
-    finally {
-        if (!delivered)
-            yield* outboxer.close();
-    }
-}