@noeos/verification-engine 0.0.0

package/dist/cjs/chains/duplicate-detector.js

@@ -0,0 +1,208 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDuplicateDetector = createDuplicateDetector;
+exports.observedLink = observedLink;
+const operation_result_js_1 = require("../domain/operation-result.js");
+const diagnostic_collector_js_1 = require("../validation/diagnostic-collector.js");
+const object_inspection_js_1 = require("../validation/object-inspection.js");
+function createDuplicateDetector(policy, limits) {
+    if (policy.kind === "none")
+        return new NoneDetector();
+    if (policy.kind === "external")
+        return new ExternalDetector(policy, limits);
+    return new MemoryDetector(policy, limits);
+}
+function observations(value) {
+    return Object.freeze([
+        Object.freeze({ kind: "record-id", key: value.recordId }),
+        Object.freeze({ kind: "content-digest", key: value.contentDigest }),
+        Object.freeze({ kind: "link-digest", key: value.linkDigest }),
+        Object.freeze({ kind: "fork", key: value.forkKey, value: value.linkDigest }),
+    ]);
+}
+function observedLink(evidence) {
+    return Object.freeze({
+        recordId: evidence.recordId,
+        contentDigest: evidence.contentDigest,
+        linkDigest: evidence.linkDigest,
+        forkKey: `${evidence.sequenceId}\u0000${String(evidence.position)}\u0000${previousKey(evidence)}`,
+    });
+}
+class NoneDetector {
+    inspect() {
+        return (0, operation_result_js_1.success)(Object.freeze([]));
+    }
+    commit() {
+        void 0;
+    }
+}
+class ExternalDetector {
+    policy;
+    limits;
+    pending;
+    constructor(policy, limits) {
+        this.policy = policy;
+        this.limits = limits;
+    }
+    inspect(value) {
+        try {
+            const result = this.policy.index.observe(observations(value));
+            if (!isOperationResult(result)) {
+                return (0, operation_result_js_1.failure)([
+                    (0, diagnostic_collector_js_1.createDiagnostic)("INTERNAL_INVARIANT_BROKEN", "chain", {
+                        causeCode: "DUPLICATE_INDEX_INVALID",
+                    }),
+                ]);
+            }
+            if (!result.ok)
+                return (0, operation_result_js_1.failure)(result.diagnostics);
+            if (!isDuplicateObservationList(result.value)) {
+                return (0, operation_result_js_1.failure)([
+                    (0, diagnostic_collector_js_1.createDiagnostic)("INTERNAL_INVARIANT_BROKEN", "chain", {
+                        causeCode: "DUPLICATE_INDEX_INVALID",
+                    }),
+                ]);
+            }
+            this.pending = value;
+            return (0, operation_result_js_1.success)(diagnosticsForDuplicates(result.value, this.limits));
+        }
+        catch {
+            return (0, operation_result_js_1.failure)([
+                (0, diagnostic_collector_js_1.createDiagnostic)("INTERNAL_INVARIANT_BROKEN", "chain", {
+                    causeCode: "DUPLICATE_INDEX_FAILED",
+                }),
+            ]);
+        }
+    }
+    commit(value) {
+        if (this.pending !== value)
+            throw new Error("external duplicate transaction mismatch");
+        this.pending = undefined;
+    }
+}
+class MemoryDetector {
+    policy;
+    limits;
+    recordIds = new Map();
+    contents = new Map();
+    links = new Map();
+    /** A window can retain more than one observation for a fork key. Keep
+     * multiplicities so evicting one entry cannot erase another retained fork. */
+    forks = new Map();
+    queue = [];
+    constructor(policy, limits) {
+        this.policy = policy;
+        this.limits = limits;
+    }
+    inspect(value) {
+        if (this.policy.kind === "full" && this.queue.length >= this.policy.maxRecords) {
+            return (0, operation_result_js_1.failure)([(0, diagnostic_collector_js_1.createDiagnostic)("RESOURCE_BUDGET_EXCEEDED", "chain")]);
+        }
+        const collector = new diagnostic_collector_js_1.DiagnosticCollector(this.limits);
+        if (this.recordIds.has(value.recordId))
+            collector.addCode("RECORD_ID_DUPLICATE", "chain");
+        if (this.contents.has(value.contentDigest))
+            collector.addCode("CONTENT_DUPLICATE", "chain");
+        if (this.links.has(value.linkDigest))
+            collector.addCode("LINK_DIGEST_DUPLICATE", "chain");
+        if (hasDifferentFork(this.forks.get(value.forkKey), value.linkDigest)) {
+            collector.addCode("CHAIN_FORK", "chain");
+        }
+        return (0, operation_result_js_1.success)(collector.finish());
+    }
+    commit(value) {
+        this.queue.push(value);
+        increment(this.recordIds, value.recordId);
+        increment(this.contents, value.contentDigest);
+        increment(this.links, value.linkDigest);
+        incrementNested(this.forks, value.forkKey, value.linkDigest);
+        if (this.policy.kind === "window" && this.queue.length > this.policy.size) {
+            const discarded = this.queue.shift();
+            if (discarded === undefined)
+                throw new Error("duplicate window invariant broken");
+            decrement(this.recordIds, discarded.recordId);
+            decrement(this.contents, discarded.contentDigest);
+            decrement(this.links, discarded.linkDigest);
+            decrementNested(this.forks, discarded.forkKey, discarded.linkDigest);
+        }
+    }
+}
+function diagnosticsForDuplicates(duplicates, limits) {
+    const collector = new diagnostic_collector_js_1.DiagnosticCollector(limits);
+    for (const duplicate of duplicates) {
+        if (duplicate.kind === "record-id")
+            collector.addCode("RECORD_ID_DUPLICATE", "chain");
+        if (duplicate.kind === "content-digest")
+            collector.addCode("CONTENT_DUPLICATE", "chain");
+        if (duplicate.kind === "link-digest")
+            collector.addCode("LINK_DIGEST_DUPLICATE", "chain");
+        if (duplicate.kind === "fork")
+            collector.addCode("CHAIN_FORK", "chain");
+    }
+    return collector.finish();
+}
+function previousKey(value) {
+    return value.previous.kind === "none" ? "none" : value.previous.value;
+}
+function increment(values, key) {
+    values.set(key, (values.get(key) ?? 0) + 1);
+}
+function decrement(values, key) {
+    const count = values.get(key);
+    if (count === undefined)
+        throw new Error("duplicate counter invariant broken");
+    if (count === 1)
+        values.delete(key);
+    else
+        values.set(key, count - 1);
+}
+function hasDifferentFork(values, digest) {
+    if (values === undefined)
+        return false;
+    for (const observedDigest of values.keys())
+        if (observedDigest !== digest)
+            return true;
+    return false;
+}
+function incrementNested(values, key, value) {
+    const nested = values.get(key) ?? new Map();
+    increment(nested, value);
+    values.set(key, nested);
+}
+function decrementNested(values, key, value) {
+    const nested = values.get(key);
+    if (nested === undefined)
+        throw new Error("duplicate fork invariant broken");
+    decrement(nested, value);
+    if (nested.size === 0)
+        values.delete(key);
+}
+function isOperationResult(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "ok" in value &&
+        (value.ok === true || value.ok === false) &&
+        "diagnostics" in value &&
+        Array.isArray(value.diagnostics));
+}
+function isDuplicateObservationList(value) {
+    return Array.isArray(value) && value.every(isDuplicateObservation);
+}
+function isDuplicateObservation(value) {
+    const entries = (0, object_inspection_js_1.inspectPlainObject)(value);
+    if (entries === undefined)
+        return false;
+    const fields = new Map(entries);
+    const kind = fields.get("kind");
+    const key = fields.get("key");
+    if (kind !== "record-id" &&
+        kind !== "content-digest" &&
+        kind !== "link-digest" &&
+        kind !== "fork")
+        return false;
+    if (typeof key !== "string")
+        return false;
+    const observedValue = fields.get("value");
+    return observedValue === undefined || typeof observedValue === "string";
+}