@fluidframework/id-compressor 2.0.0-dev-rc.1.0.0.224419

package/dist/sessions.cjs

@@ -0,0 +1,305 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lastFinalizedLocal = exports.lastAllocatedLocal = exports.lastFinalizedFinal = exports.lastAllocatedFinal = exports.getAlignedLocal = exports.getAlignedFinal = exports.clustersEqual = exports.Session = exports.Sessions = void 0;
+const sorted_btree_1 = __importDefault(require("sorted-btree"));
+const core_utils_1 = require("@fluidframework/core-utils");
+const utilities_1 = require("./utilities.cjs");
+/**
+ * A collection of all sessions known to the compressor (i.e. all finalized/acked allocated UUIDs and their corresponding local and final forms).
+ * This collection of all sessions comprises a distributed document's IDs.
+ */
+class Sessions {
+    constructor(sessions) {
+        // A range-queryable store of all sessions. A btree is used as it solves the predecessor problem for any given UUID, allowing
+        // us to quickly find the session that may have produced it.
+        this.uuidSpace = new sorted_btree_1.default(undefined, utilities_1.compareBigints);
+        // A fast lookup table from session ID to the session object, used to avoid accessing the slower btree
+        this.sessionCache = new Map();
+        if (sessions !== undefined) {
+            // bulk load path
+            for (const [numeric, session] of sessions) {
+                this.sessionCache.set((0, utilities_1.stableIdFromNumericUuid)(numeric), session);
+            }
+            this.uuidSpace = new sorted_btree_1.default(sessions, utilities_1.compareBigints);
+            if (this.sessionCache.size !== sessions.length ||
+                sessions.length !== this.uuidSpace.size) {
+                throw new Error("Cannot resume existing session.");
+            }
+        }
+    }
+    sessions() {
+        return this.sessionCache.values();
+    }
+    getOrCreate(sessionId) {
+        const existing = this.sessionCache.get(sessionId);
+        if (existing !== undefined) {
+            return existing;
+        }
+        const session = new Session(sessionId);
+        (0, core_utils_1.assert)(this.uuidSpace.set(session.sessionUuid, session), 0x760 /* Duplicate session in map. */);
+        this.sessionCache.set(sessionId, session);
+        return session;
+    }
+    get(sessionId) {
+        return this.sessionCache.get(sessionId);
+    }
+    getContainingCluster(query) {
+        const numericStable = (0, utilities_1.numericUuidFromStableId)(query);
+        const possibleMatch = this.uuidSpace.getPairOrNextLower(numericStable);
+        if (possibleMatch === undefined) {
+            return undefined;
+        }
+        const [_, session] = possibleMatch;
+        const numericDelta = (0, utilities_1.subtractNumericUuids)(numericStable, session.sessionUuid);
+        if (numericDelta > Number.MAX_SAFE_INTEGER) {
+            return undefined;
+        }
+        const alignedLocal = (0, utilities_1.localIdFromGenCount)(Number(numericDelta) + 1);
+        const containingCluster = session.getClusterByLocal(alignedLocal, true);
+        if (containingCluster === undefined) {
+            return undefined;
+        }
+        return [containingCluster, alignedLocal];
+    }
+    clusterCollides(cluster) {
+        const { session: owningSession, baseLocalId, capacity } = cluster;
+        const clusterBaseNumeric = (0, utilities_1.offsetNumericUuid)(owningSession.sessionUuid, (0, utilities_1.genCountFromLocalId)(baseLocalId) - 1);
+        const clusterMaxNumeric = (0, utilities_1.offsetNumericUuid)(clusterBaseNumeric, capacity - 1);
+        let closestMatch = this.uuidSpace.getPairOrNextLower(clusterMaxNumeric);
+        // Find the first session that is not the owner of this new cluster.
+        // Once we have that, check to see if its cluster chain overlaps with the new cluster.
+        // Consider the following diagram of UUID space:
+        // Cluster chain A:  |----------------------|
+        // Cluster chain B:       |----------|
+        // Cluster chain C:                       |-------|
+        // While it is true that when adding a cluster to chain C, we would find
+        // the next lower session (which is B) and erroneously determine we do not collide
+        // with any other session, but this situation is impossible to get into as B would
+        // have detected that it collided with A (or the other way around, depending on ordering).
+        while (closestMatch !== undefined && closestMatch[1] === owningSession) {
+            closestMatch = this.uuidSpace.nextLowerPair(closestMatch[0]);
+        }
+        if (closestMatch === undefined) {
+            return false;
+        }
+        const [_, session] = closestMatch;
+        (0, core_utils_1.assert)(session !== owningSession, 0x761 /* Failed to attempt to detect collisions. */);
+        const lastCluster = session.getLastCluster();
+        if (lastCluster === undefined) {
+            // If the closest session is empty (the local session), then it is guaranteed (probabilistically) that there are no
+            // non-empty sessions that have a cluster chain that starts prior to the empty session and collides with the cluster
+            // we are checking, so we can return false.
+            return false;
+        }
+        const lastAllocatedNumeric = (0, utilities_1.offsetNumericUuid)(session.sessionUuid, (0, utilities_1.genCountFromLocalId)(lastAllocatedLocal(lastCluster)) - 1);
+        return lastAllocatedNumeric >= clusterBaseNumeric;
+    }
+    equals(other, includeLocalState) {
+        const checkIsSubset = (sessionsA, sessionsB) => {
+            const first = sessionsA.sessions().next();
+            const firstSessionThis = first.done ? undefined : first.value;
+            for (const [stableId, session] of sessionsA.sessionCache.entries()) {
+                const otherSession = sessionsB.sessionCache.get(stableId);
+                if (otherSession === undefined) {
+                    if (!session.isEmpty() || includeLocalState) {
+                        return false;
+                    }
+                    (0, core_utils_1.assert)(session === firstSessionThis, 0x762 /* The only non-empty session must be the local session. */);
+                }
+                else if (!session.equals(otherSession)) {
+                    return false;
+                }
+            }
+            return true;
+        };
+        return checkIsSubset(this, other) && checkIsSubset(other, this);
+    }
+}
+exports.Sessions = Sessions;
+/**
+ * The IDs created by a specific session, stored as a cluster chain to allow for fast conversions.
+ */
+class Session {
+    constructor(sessionId) {
+        // All clusters created by this session, in creation order (thus sorted by base final and local ID).
+        this.clusterChain = [];
+        this.sessionUuid =
+            typeof sessionId === "string" ? (0, utilities_1.numericUuidFromStableId)(sessionId) : sessionId;
+    }
+    /**
+     * Adds a new empty cluster to the cluster chain of this session.
+     */
+    addNewCluster(baseFinalId, capacity, count) {
+        const lastCluster = this.getLastCluster();
+        const newCluster = {
+            session: this,
+            baseFinalId,
+            baseLocalId: (lastCluster === undefined
+                ? -1
+                : lastAllocatedLocal(lastCluster) - 1),
+            capacity,
+            count,
+        };
+        this.clusterChain.push(newCluster);
+        return newCluster;
+    }
+    isEmpty() {
+        return this.clusterChain.length === 0;
+    }
+    /**
+     * Returns the last cluster in this session's cluster chain, if any.
+     */
+    getLastCluster() {
+        return this.clusterChain[this.clusterChain.length - 1];
+    }
+    /**
+     * Converts the local ID from this session to a final ID, if possible.
+     * @param includeAllocated - true if the conversion should succeed even if the local ID aligns with a part of the cluster that is allocated but not finalized.
+     */
+    tryConvertToFinal(searchLocal, includeAllocated) {
+        const containingCluster = this.getClusterByLocal(searchLocal, includeAllocated);
+        if (containingCluster === undefined) {
+            return undefined;
+        }
+        return getAlignedFinal(containingCluster, searchLocal);
+    }
+    /**
+     * Returns the cluster containing the supplied local ID, if possible.
+     * @param includeAllocated - true if the conversion should succeed even if the local ID aligns with a part of the cluster that is allocated but not finalized.
+     */
+    getClusterByLocal(localId, includeAllocated) {
+        const lastValidLocal = includeAllocated
+            ? lastAllocatedLocal
+            : lastFinalizedLocal;
+        const matchedCluster = Session.binarySearch(localId, this.clusterChain, (local, cluster) => {
+            const lastLocal = lastValidLocal(cluster);
+            if (local < lastLocal) {
+                return 1;
+            }
+            else if (local > cluster.baseLocalId) {
+                return -1;
+            }
+            else {
+                return 0;
+            }
+        });
+        return matchedCluster;
+    }
+    /**
+     * Returns the cluster containing the supplied final ID, if possible.
+     */
+    getClusterByAllocatedFinal(final) {
+        return Session.getContainingCluster(final, this.clusterChain);
+    }
+    /**
+     * Returns the cluster from the supplied cluster chain containing the supplied final ID, if possible.
+     * `clusterChain` must be sorted by final/local base ID.
+     */
+    static getContainingCluster(finalId, clusterChain) {
+        return Session.binarySearch(finalId, clusterChain, (final, cluster) => {
+            const lastFinal = lastAllocatedFinal(cluster);
+            if (final < cluster.baseFinalId) {
+                return -1;
+            }
+            else if (final > lastFinal) {
+                return 1;
+            }
+            else {
+                return 0;
+            }
+        });
+    }
+    static binarySearch(search, arr, comparator) {
+        let left = 0;
+        let right = arr.length - 1;
+        while (left <= right) {
+            const mid = Math.floor((left + right) / 2);
+            const c = comparator(search, arr[mid]);
+            if (c === 0) {
+                return arr[mid]; // Found the target, return its index.
+            }
+            else if (c > 0) {
+                left = mid + 1; // Continue search on right half.
+            }
+            else {
+                right = mid - 1; // Continue search on left half.
+            }
+        }
+        return undefined; // If we reach here, target is not in array.
+    }
+    equals(other) {
+        for (let i = 0; i < this.clusterChain.length; i++) {
+            if (!clustersEqual(this.clusterChain[i], other.clusterChain[i])) {
+                return false;
+            }
+        }
+        return this.sessionUuid === other.sessionUuid;
+    }
+}
+exports.Session = Session;
+function clustersEqual(a, b) {
+    return (a.session.sessionUuid === b.session.sessionUuid &&
+        a.baseFinalId === b.baseFinalId &&
+        a.baseLocalId === b.baseLocalId &&
+        a.capacity === b.capacity &&
+        a.count === b.count);
+}
+exports.clustersEqual = clustersEqual;
+/**
+ * Returns the final ID that is aligned with the supplied local ID within a cluster.
+ * Includes allocated IDs.
+ */
+function getAlignedFinal(cluster, localWithin) {
+    const clusterOffset = (0, utilities_1.genCountFromLocalId)(localWithin) - (0, utilities_1.genCountFromLocalId)(cluster.baseLocalId);
+    if (clusterOffset < cluster.capacity) {
+        return (cluster.baseFinalId + clusterOffset);
+    }
+    return undefined;
+}
+exports.getAlignedFinal = getAlignedFinal;
+/**
+ * Returns the local ID that is aligned with the supplied final ID within a cluster.
+ * Fails if the supplied ID does not fall within the cluster bounds.
+ */
+function getAlignedLocal(cluster, finalWithin) {
+    (0, core_utils_1.assert)(finalWithin >= cluster.baseFinalId && finalWithin <= lastAllocatedFinal(cluster), 0x763 /* Supplied ID is not within the cluster. */);
+    const finalDelta = finalWithin - cluster.baseFinalId;
+    return (cluster.baseLocalId - finalDelta);
+}
+exports.getAlignedLocal = getAlignedLocal;
+/**
+ * Returns the last allocated final ID (i.e. any ID between base final and base final + capacity) within a cluster
+ */
+function lastAllocatedFinal(cluster) {
+    return (cluster.baseFinalId + (cluster.capacity - 1));
+}
+exports.lastAllocatedFinal = lastAllocatedFinal;
+/**
+ * Returns the last allocated final ID (i.e. any ID between base final and base final + count) within a cluster
+ */
+function lastFinalizedFinal(cluster) {
+    return (cluster.baseFinalId + (cluster.count - 1));
+}
+exports.lastFinalizedFinal = lastFinalizedFinal;
+/**
+ * Returns the last allocated local ID (i.e. any ID between base local and base local + capacity) within a cluster
+ */
+function lastAllocatedLocal(cluster) {
+    return (cluster.baseLocalId - (cluster.capacity - 1));
+}
+exports.lastAllocatedLocal = lastAllocatedLocal;
+/**
+ * Returns the last allocated local ID (i.e. any ID between base local and base local + count) within a cluster
+ */
+function lastFinalizedLocal(cluster) {
+    return (cluster.baseLocalId - (cluster.count - 1));
+}
+exports.lastFinalizedLocal = lastFinalizedLocal;
+//# sourceMappingURL=sessions.cjs.map

package/dist/sessions.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessions.cjs","sourceRoot":"","sources":["../src/sessions.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,gEAAiC;AACjC,2DAAoD;AAEpD,+CAQqB;AAGrB;;;GAGG;AACH,MAAa,QAAQ;IAOpB,YAAmB,QAAyD;QAN5E,6HAA6H;QAC7H,4DAA4D;QAC3C,cAAS,GAAG,IAAI,sBAAK,CAAuB,SAAS,EAAE,0BAAc,CAAC,CAAC;QACxF,sGAAsG;QACrF,iBAAY,GAAG,IAAI,GAAG,EAAsB,CAAC;QAG7D,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC3B,iBAAiB;YACjB,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,QAAQ,EAAE;gBAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAA,mCAAuB,EAAC,OAAO,CAAc,EAAE,OAAO,CAAC,CAAC;aAC9E;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAK,CAAC,QAAQ,EAAE,0BAAc,CAAC,CAAC;YACrD,IACC,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM;gBAC1C,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EACtC;gBACD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACnD;SACD;IACF,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAEM,WAAW,CAAC,SAAoB;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC3B,OAAO,QAAQ,CAAC;SAChB;QACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;QACvC,IAAA,mBAAM,EACL,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,EAChD,KAAK,CAAC,+BAA+B,CACrC,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC;IAChB,CAAC;IAEM,GAAG,CAAC,SAAoB;QAC9B,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAEM,oBAAoB,CAC1B,KAAe;QAEf,MAAM,aAAa,GAAG,IAAA,mCAAuB,EAAC,KAAK,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QACvE,IAAI,aAAa,KAAK,SAAS,EAAE;YAChC,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC;QACnC,MAAM,YAAY,GAAG,IAAA,gCAAoB,EAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC9E,IAAI,YAAY,GAAG,MAAM,CAAC,gBAAgB,EAAE;YAC3C,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,YAAY,GAAG,IAAA,+BAAmB,EAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACxE,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACpC,OAAO,SAAS,CAAC;SACjB;QACD,OAAO,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IAC1C,CAAC;IAEM,eAAe,CAAC,OAAkB;QACxC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAClE,MAAM,kBAAkB,GAAG,IAAA,6BAAiB,EAC3C,aAAa,CAAC,WAAW,EACzB,IAAA,+BAAmB,EAAC,WAAW,CAAC,GAAG,CAAC,CACpC,CAAC;QACF,MAAM,iBAAiB,GAAG,IAAA,6BAAiB,EAAC,kBAAkB,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;QAC9E,IAAI,YAAY,GACf,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QACtD,oEAAoE;QACpE,sFAAsF;QACtF,gDAAgD;QAChD,6CAA6C;QAC7C,sCAAsC;QACtC,mDAAmD;QACnD,wEAAwE;QACxE,kFAAkF;QAClF,kFAAkF;QAClF,0FAA0F;QAC1F,OAAO,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,aAAa,EAAE;YACvE,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;SAC7D;QACD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC/B,OAAO,KAAK,CAAC;SACb;QAED,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC;QAClC,IAAA,mBAAM,EAAC,OAAO,KAAK,aAAa,EAAE,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACvF,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAC7C,IAAI,WAAW,KAAK,SAAS,EAAE;YAC9B,mHAAmH;YACnH,oHAAoH;YACpH,2CAA2C;YAC3C,OAAO,KAAK,CAAC;SACb;QACD,MAAM,oBAAoB,GAAG,IAAA,6BAAiB,EAC7C,OAAO,CAAC,WAAW,EACnB,IAAA,+BAAmB,EAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CACxD,CAAC;QACF,OAAO,oBAAoB,IAAI,kBAAkB,CAAC;IACnD,CAAC;IAEM,MAAM,CAAC,KAAe,EAAE,iBAA0B;QACxD,MAAM,aAAa,GAAG,CAAC,SAAmB,EAAE,SAAmB,EAAE,EAAE;YAClE,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;YAC1C,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;YAC9D,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE;gBACnE,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC1D,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC/B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,iBAAiB,EAAE;wBAC5C,OAAO,KAAK,CAAC;qBACb;oBACD,IAAA,mBAAM,EACL,OAAO,KAAK,gBAAgB,EAC5B,KAAK,CAAC,2DAA2D,CACjE,CAAC;iBACF;qBAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;oBACzC,OAAO,KAAK,CAAC;iBACb;aACD;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QACF,OAAO,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;CACD;AAlID,4BAkIC;AAED;;GAEG;AACH,MAAa,OAAO;IAMnB,YAAmB,SAAkC;QALrD,oGAAoG;QACnF,iBAAY,GAAgB,EAAE,CAAC;QAK/C,IAAI,CAAC,WAAW;YACf,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,mCAAuB,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,aAAa,CACnB,WAA8B,EAC9B,QAAgB,EAChB,KAAa;QAEb,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAc;YAC7B,OAAO,EAAE,IAAI;YACb,WAAW;YACX,WAAW,EAAE,CAAC,WAAW,KAAK,SAAS;gBACtC,CAAC,CAAC,CAAC,CAAC;gBACJ,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAsB;YAC5D,QAAQ;YACR,KAAK;SACL,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,UAAU,CAAC;IACnB,CAAC;IAEM,OAAO;QACb,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,cAAc;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,iBAAiB,CACvB,WAA8B,EAC9B,gBAAyB;QAEzB,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAChF,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACpC,OAAO,SAAS,CAAC;SACjB;QACD,OAAO,eAAe,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,iBAAiB,CACvB,OAA0B,EAC1B,gBAAyB;QAEzB,MAAM,cAAc,GAA8C,gBAAgB;YACjF,CAAC,CAAC,kBAAkB;YACpB,CAAC,CAAC,kBAAkB,CAAC;QACtB,MAAM,cAAc,GAAG,OAAO,CAAC,YAAY,CAC1C,OAAO,EACP,IAAI,CAAC,YAAY,EACjB,CAAC,KAAK,EAAE,OAAO,EAAU,EAAE;YAC1B,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;YAC1C,IAAI,KAAK,GAAG,SAAS,EAAE;gBACtB,OAAO,CAAC,CAAC;aACT;iBAAM,IAAI,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE;gBACvC,OAAO,CAAC,CAAC,CAAC;aACV;iBAAM;gBACN,OAAO,CAAC,CAAC;aACT;QACF,CAAC,CACD,CAAC;QACF,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,0BAA0B,CAAC,KAAwB;QACzD,OAAO,OAAO,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,oBAAoB,CACjC,OAA0B,EAC1B,YAAkC;QAElC,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACrE,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC9C,IAAI,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE;gBAChC,OAAO,CAAC,CAAC,CAAC;aACV;iBAAM,IAAI,KAAK,GAAG,SAAS,EAAE;gBAC7B,OAAO,CAAC,CAAC;aACT;iBAAM;gBACN,OAAO,CAAC,CAAC;aACT;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAClB,MAAS,EACT,GAAiB,EACjB,UAAkC;QAElC,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,KAAK,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,OAAO,IAAI,IAAI,KAAK,EAAE;YACrB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,EAAE;gBACZ,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,sCAAsC;aACvD;iBAAM,IAAI,CAAC,GAAG,CAAC,EAAE;gBACjB,IAAI,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,iCAAiC;aACjD;iBAAM;gBACN,KAAK,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,gCAAgC;aACjD;SACD;QACD,OAAO,SAAS,CAAC,CAAC,4CAA4C;IAC/D,CAAC;IAEM,MAAM,CAAC,KAAc;QAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAClD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE;gBAChE,OAAO,KAAK,CAAC;aACb;SACD;QACD,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,CAAC;IAC/C,CAAC;CACD;AA/ID,0BA+IC;AAmCD,SAAgB,aAAa,CAAC,CAAY,EAAE,CAAY;IACvD,OAAO,CACN,CAAC,CAAC,OAAO,CAAC,WAAW,KAAK,CAAC,CAAC,OAAO,CAAC,WAAW;QAC/C,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW;QAC/B,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW;QAC/B,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;QACzB,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CACnB,CAAC;AACH,CAAC;AARD,sCAQC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAC9B,OAAkB,EAClB,WAA8B;IAE9B,MAAM,aAAa,GAClB,IAAA,+BAAmB,EAAC,WAAW,CAAC,GAAG,IAAA,+BAAmB,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7E,IAAI,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE;QACrC,OAAO,CAAE,OAAO,CAAC,WAAsB,GAAG,aAAa,CAAsB,CAAC;KAC9E;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAVD,0CAUC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAC9B,OAAkB,EAClB,WAA8B;IAE9B,IAAA,mBAAM,EACL,WAAW,IAAI,OAAO,CAAC,WAAW,IAAI,WAAW,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAChF,KAAK,CAAC,4CAA4C,CAClD,CAAC;IACF,MAAM,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACrD,OAAO,CAAC,OAAO,CAAC,WAAW,GAAG,UAAU,CAAsB,CAAC;AAChE,CAAC;AAVD,0CAUC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,OAAkB;IACpD,OAAO,CAAE,OAAO,CAAC,WAAsB,GAAG,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAsB,CAAC;AACxF,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,OAAkB;IACpD,OAAO,CAAE,OAAO,CAAC,WAAsB,GAAG,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAsB,CAAC;AACrF,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,OAAkB;IACpD,OAAO,CAAE,OAAO,CAAC,WAAsB,GAAG,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAsB,CAAC;AACxF,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,OAAkB;IACpD,OAAO,CAAE,OAAO,CAAC,WAAsB,GAAG,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAsB,CAAC;AACrF,CAAC;AAFD,gDAEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport BTree from \"sorted-btree\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { SessionId, StableId } from \"./types\";\nimport {\n\tcompareBigints,\n\tlocalIdFromGenCount,\n\tgenCountFromLocalId,\n\tnumericUuidFromStableId,\n\tstableIdFromNumericUuid,\n\tsubtractNumericUuids,\n\toffsetNumericUuid,\n} from \"./utilities\";\nimport { FinalCompressedId, LocalCompressedId, NumericUuid } from \"./identifiers\";\n\n/**\n * A collection of all sessions known to the compressor (i.e. all finalized/acked allocated UUIDs and their corresponding local and final forms).\n * This collection of all sessions comprises a distributed document's IDs.\n */\nexport class Sessions {\n\t// A range-queryable store of all sessions. A btree is used as it solves the predecessor problem for any given UUID, allowing\n\t// us to quickly find the session that may have produced it.\n\tprivate readonly uuidSpace = new BTree<NumericUuid, Session>(undefined, compareBigints);\n\t// A fast lookup table from session ID to the session object, used to avoid accessing the slower btree\n\tprivate readonly sessionCache = new Map<SessionId, Session>();\n\n\tpublic constructor(sessions?: [sessionBase: NumericUuid, session: Session][]) {\n\t\tif (sessions !== undefined) {\n\t\t\t// bulk load path\n\t\t\tfor (const [numeric, session] of sessions) {\n\t\t\t\tthis.sessionCache.set(stableIdFromNumericUuid(numeric) as SessionId, session);\n\t\t\t}\n\t\t\tthis.uuidSpace = new BTree(sessions, compareBigints);\n\t\t\tif (\n\t\t\t\tthis.sessionCache.size !== sessions.length ||\n\t\t\t\tsessions.length !== this.uuidSpace.size\n\t\t\t) {\n\t\t\t\tthrow new Error(\"Cannot resume existing session.\");\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic sessions(): IterableIterator<Session> {\n\t\treturn this.sessionCache.values();\n\t}\n\n\tpublic getOrCreate(sessionId: SessionId): Session {\n\t\tconst existing = this.sessionCache.get(sessionId);\n\t\tif (existing !== undefined) {\n\t\t\treturn existing;\n\t\t}\n\t\tconst session = new Session(sessionId);\n\t\tassert(\n\t\t\tthis.uuidSpace.set(session.sessionUuid, session),\n\t\t\t0x760 /* Duplicate session in map. */,\n\t\t);\n\t\tthis.sessionCache.set(sessionId, session);\n\t\treturn session;\n\t}\n\n\tpublic get(sessionId: SessionId): Session | undefined {\n\t\treturn this.sessionCache.get(sessionId);\n\t}\n\n\tpublic getContainingCluster(\n\t\tquery: StableId,\n\t): [cluster: IdCluster, alignedLocal: LocalCompressedId] | undefined {\n\t\tconst numericStable = numericUuidFromStableId(query);\n\t\tconst possibleMatch = this.uuidSpace.getPairOrNextLower(numericStable);\n\t\tif (possibleMatch === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst [_, session] = possibleMatch;\n\t\tconst numericDelta = subtractNumericUuids(numericStable, session.sessionUuid);\n\t\tif (numericDelta > Number.MAX_SAFE_INTEGER) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst alignedLocal = localIdFromGenCount(Number(numericDelta) + 1);\n\t\tconst containingCluster = session.getClusterByLocal(alignedLocal, true);\n\t\tif (containingCluster === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn [containingCluster, alignedLocal];\n\t}\n\n\tpublic clusterCollides(cluster: IdCluster): boolean {\n\t\tconst { session: owningSession, baseLocalId, capacity } = cluster;\n\t\tconst clusterBaseNumeric = offsetNumericUuid(\n\t\t\towningSession.sessionUuid,\n\t\t\tgenCountFromLocalId(baseLocalId) - 1,\n\t\t);\n\t\tconst clusterMaxNumeric = offsetNumericUuid(clusterBaseNumeric, capacity - 1);\n\t\tlet closestMatch: [NumericUuid, Session] | undefined =\n\t\t\tthis.uuidSpace.getPairOrNextLower(clusterMaxNumeric);\n\t\t// Find the first session that is not the owner of this new cluster.\n\t\t// Once we have that, check to see if its cluster chain overlaps with the new cluster.\n\t\t// Consider the following diagram of UUID space:\n\t\t// Cluster chain A:  |----------------------|\n\t\t// Cluster chain B:       |----------|\n\t\t// Cluster chain C:                       |-------|\n\t\t// While it is true that when adding a cluster to chain C, we would find\n\t\t// the next lower session (which is B) and erroneously determine we do not collide\n\t\t// with any other session, but this situation is impossible to get into as B would\n\t\t// have detected that it collided with A (or the other way around, depending on ordering).\n\t\twhile (closestMatch !== undefined && closestMatch[1] === owningSession) {\n\t\t\tclosestMatch = this.uuidSpace.nextLowerPair(closestMatch[0]);\n\t\t}\n\t\tif (closestMatch === undefined) {\n\t\t\treturn false;\n\t\t}\n\n\t\tconst [_, session] = closestMatch;\n\t\tassert(session !== owningSession, 0x761 /* Failed to attempt to detect collisions. */);\n\t\tconst lastCluster = session.getLastCluster();\n\t\tif (lastCluster === undefined) {\n\t\t\t// If the closest session is empty (the local session), then it is guaranteed (probabilistically) that there are no\n\t\t\t// non-empty sessions that have a cluster chain that starts prior to the empty session and collides with the cluster\n\t\t\t// we are checking, so we can return false.\n\t\t\treturn false;\n\t\t}\n\t\tconst lastAllocatedNumeric = offsetNumericUuid(\n\t\t\tsession.sessionUuid,\n\t\t\tgenCountFromLocalId(lastAllocatedLocal(lastCluster)) - 1,\n\t\t);\n\t\treturn lastAllocatedNumeric >= clusterBaseNumeric;\n\t}\n\n\tpublic equals(other: Sessions, includeLocalState: boolean): boolean {\n\t\tconst checkIsSubset = (sessionsA: Sessions, sessionsB: Sessions) => {\n\t\t\tconst first = sessionsA.sessions().next();\n\t\t\tconst firstSessionThis = first.done ? undefined : first.value;\n\t\t\tfor (const [stableId, session] of sessionsA.sessionCache.entries()) {\n\t\t\t\tconst otherSession = sessionsB.sessionCache.get(stableId);\n\t\t\t\tif (otherSession === undefined) {\n\t\t\t\t\tif (!session.isEmpty() || includeLocalState) {\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t}\n\t\t\t\t\tassert(\n\t\t\t\t\t\tsession === firstSessionThis,\n\t\t\t\t\t\t0x762 /* The only non-empty session must be the local session. */,\n\t\t\t\t\t);\n\t\t\t\t} else if (!session.equals(otherSession)) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\t\treturn checkIsSubset(this, other) && checkIsSubset(other, this);\n\t}\n}\n\n/**\n * The IDs created by a specific session, stored as a cluster chain to allow for fast conversions.\n */\nexport class Session {\n\t// All clusters created by this session, in creation order (thus sorted by base final and local ID).\n\tprivate readonly clusterChain: IdCluster[] = [];\n\t// The numeric form of the SessionId\n\tpublic readonly sessionUuid: NumericUuid;\n\n\tpublic constructor(sessionId: SessionId | NumericUuid) {\n\t\tthis.sessionUuid =\n\t\t\ttypeof sessionId === \"string\" ? numericUuidFromStableId(sessionId) : sessionId;\n\t}\n\n\t/**\n\t * Adds a new empty cluster to the cluster chain of this session.\n\t */\n\tpublic addNewCluster(\n\t\tbaseFinalId: FinalCompressedId,\n\t\tcapacity: number,\n\t\tcount: number,\n\t): IdCluster {\n\t\tconst lastCluster = this.getLastCluster();\n\t\tconst newCluster: IdCluster = {\n\t\t\tsession: this,\n\t\t\tbaseFinalId,\n\t\t\tbaseLocalId: (lastCluster === undefined\n\t\t\t\t? -1\n\t\t\t\t: lastAllocatedLocal(lastCluster) - 1) as LocalCompressedId,\n\t\t\tcapacity,\n\t\t\tcount,\n\t\t};\n\t\tthis.clusterChain.push(newCluster);\n\t\treturn newCluster;\n\t}\n\n\tpublic isEmpty(): boolean {\n\t\treturn this.clusterChain.length === 0;\n\t}\n\n\t/**\n\t * Returns the last cluster in this session's cluster chain, if any.\n\t */\n\tpublic getLastCluster(): IdCluster | undefined {\n\t\treturn this.clusterChain[this.clusterChain.length - 1];\n\t}\n\n\t/**\n\t * Converts the local ID from this session to a final ID, if possible.\n\t * @param includeAllocated - true if the conversion should succeed even if the local ID aligns with a part of the cluster that is allocated but not finalized.\n\t */\n\tpublic tryConvertToFinal(\n\t\tsearchLocal: LocalCompressedId,\n\t\tincludeAllocated: boolean,\n\t): FinalCompressedId | undefined {\n\t\tconst containingCluster = this.getClusterByLocal(searchLocal, includeAllocated);\n\t\tif (containingCluster === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn getAlignedFinal(containingCluster, searchLocal);\n\t}\n\n\t/**\n\t * Returns the cluster containing the supplied local ID, if possible.\n\t * @param includeAllocated - true if the conversion should succeed even if the local ID aligns with a part of the cluster that is allocated but not finalized.\n\t */\n\tpublic getClusterByLocal(\n\t\tlocalId: LocalCompressedId,\n\t\tincludeAllocated: boolean,\n\t): IdCluster | undefined {\n\t\tconst lastValidLocal: (cluster: IdCluster) => LocalCompressedId = includeAllocated\n\t\t\t? lastAllocatedLocal\n\t\t\t: lastFinalizedLocal;\n\t\tconst matchedCluster = Session.binarySearch(\n\t\t\tlocalId,\n\t\t\tthis.clusterChain,\n\t\t\t(local, cluster): number => {\n\t\t\t\tconst lastLocal = lastValidLocal(cluster);\n\t\t\t\tif (local < lastLocal) {\n\t\t\t\t\treturn 1;\n\t\t\t\t} else if (local > cluster.baseLocalId) {\n\t\t\t\t\treturn -1;\n\t\t\t\t} else {\n\t\t\t\t\treturn 0;\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\t\treturn matchedCluster;\n\t}\n\n\t/**\n\t * Returns the cluster containing the supplied final ID, if possible.\n\t */\n\tpublic getClusterByAllocatedFinal(final: FinalCompressedId): IdCluster | undefined {\n\t\treturn Session.getContainingCluster(final, this.clusterChain);\n\t}\n\n\t/**\n\t * Returns the cluster from the supplied cluster chain containing the supplied final ID, if possible.\n\t * `clusterChain` must be sorted by final/local base ID.\n\t */\n\tpublic static getContainingCluster(\n\t\tfinalId: FinalCompressedId,\n\t\tclusterChain: readonly IdCluster[],\n\t): IdCluster | undefined {\n\t\treturn Session.binarySearch(finalId, clusterChain, (final, cluster) => {\n\t\t\tconst lastFinal = lastAllocatedFinal(cluster);\n\t\t\tif (final < cluster.baseFinalId) {\n\t\t\t\treturn -1;\n\t\t\t} else if (final > lastFinal) {\n\t\t\t\treturn 1;\n\t\t\t} else {\n\t\t\t\treturn 0;\n\t\t\t}\n\t\t});\n\t}\n\n\tstatic binarySearch<S, T>(\n\t\tsearch: S,\n\t\tarr: readonly T[],\n\t\tcomparator: (a: S, b: T) => number,\n\t): T | undefined {\n\t\tlet left = 0;\n\t\tlet right = arr.length - 1;\n\t\twhile (left <= right) {\n\t\t\tconst mid = Math.floor((left + right) / 2);\n\t\t\tconst c = comparator(search, arr[mid]);\n\t\t\tif (c === 0) {\n\t\t\t\treturn arr[mid]; // Found the target, return its index.\n\t\t\t} else if (c > 0) {\n\t\t\t\tleft = mid + 1; // Continue search on right half.\n\t\t\t} else {\n\t\t\t\tright = mid - 1; // Continue search on left half.\n\t\t\t}\n\t\t}\n\t\treturn undefined; // If we reach here, target is not in array.\n\t}\n\n\tpublic equals(other: Session): boolean {\n\t\tfor (let i = 0; i < this.clusterChain.length; i++) {\n\t\t\tif (!clustersEqual(this.clusterChain[i], other.clusterChain[i])) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t\treturn this.sessionUuid === other.sessionUuid;\n\t}\n}\n\n/**\n * A cluster of final (sequenced via consensus), sequentially allocated compressed IDs.\n * A final ID in a cluster decompresses to a sequentially allocated UUID that is the result of adding its offset within\n * the cluster to base UUID for the session that created it.\n */\nexport interface IdCluster {\n\t/**\n\t * The session that created this cluster.\n\t */\n\treadonly session: Session;\n\n\t/**\n\t * The first final ID in the cluster.\n\t */\n\treadonly baseFinalId: FinalCompressedId;\n\n\t/**\n\t * The local ID aligned with `baseFinalId`.\n\t */\n\treadonly baseLocalId: LocalCompressedId;\n\n\t/**\n\t * The total number of final IDs reserved for allocation in the cluster.\n\t * Clusters are reserved in blocks as a performance optimization.\n\t */\n\tcapacity: number;\n\n\t/**\n\t * The number of final IDs currently allocated in the cluster.\n\t */\n\tcount: number;\n}\n\nexport function clustersEqual(a: IdCluster, b: IdCluster): boolean {\n\treturn (\n\t\ta.session.sessionUuid === b.session.sessionUuid &&\n\t\ta.baseFinalId === b.baseFinalId &&\n\t\ta.baseLocalId === b.baseLocalId &&\n\t\ta.capacity === b.capacity &&\n\t\ta.count === b.count\n\t);\n}\n\n/**\n * Returns the final ID that is aligned with the supplied local ID within a cluster.\n * Includes allocated IDs.\n */\nexport function getAlignedFinal(\n\tcluster: IdCluster,\n\tlocalWithin: LocalCompressedId,\n): FinalCompressedId | undefined {\n\tconst clusterOffset =\n\t\tgenCountFromLocalId(localWithin) - genCountFromLocalId(cluster.baseLocalId);\n\tif (clusterOffset < cluster.capacity) {\n\t\treturn ((cluster.baseFinalId as number) + clusterOffset) as FinalCompressedId;\n\t}\n\treturn undefined;\n}\n\n/**\n * Returns the local ID that is aligned with the supplied final ID within a cluster.\n * Fails if the supplied ID does not fall within the cluster bounds.\n */\nexport function getAlignedLocal(\n\tcluster: IdCluster,\n\tfinalWithin: FinalCompressedId,\n): LocalCompressedId {\n\tassert(\n\t\tfinalWithin >= cluster.baseFinalId && finalWithin <= lastAllocatedFinal(cluster),\n\t\t0x763 /* Supplied ID is not within the cluster. */,\n\t);\n\tconst finalDelta = finalWithin - cluster.baseFinalId;\n\treturn (cluster.baseLocalId - finalDelta) as LocalCompressedId;\n}\n\n/**\n * Returns the last allocated final ID (i.e. any ID between base final and base final + capacity) within a cluster\n */\nexport function lastAllocatedFinal(cluster: IdCluster): FinalCompressedId {\n\treturn ((cluster.baseFinalId as number) + (cluster.capacity - 1)) as FinalCompressedId;\n}\n\n/**\n * Returns the last allocated final ID (i.e. any ID between base final and base final + count) within a cluster\n */\nexport function lastFinalizedFinal(cluster: IdCluster): FinalCompressedId {\n\treturn ((cluster.baseFinalId as number) + (cluster.count - 1)) as FinalCompressedId;\n}\n\n/**\n * Returns the last allocated local ID (i.e. any ID between base local and base local + capacity) within a cluster\n */\nexport function lastAllocatedLocal(cluster: IdCluster): LocalCompressedId {\n\treturn ((cluster.baseLocalId as number) - (cluster.capacity - 1)) as LocalCompressedId;\n}\n\n/**\n * Returns the last allocated local ID (i.e. any ID between base local and base local + count) within a cluster\n */\nexport function lastFinalizedLocal(cluster: IdCluster): LocalCompressedId {\n\treturn ((cluster.baseLocalId as number) - (cluster.count - 1)) as LocalCompressedId;\n}\n"]}

package/dist/sessions.d.ts

@@ -0,0 +1,115 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { SessionId, StableId } from "./types";
+import { FinalCompressedId, LocalCompressedId, NumericUuid } from "./identifiers";
+/**
+ * A collection of all sessions known to the compressor (i.e. all finalized/acked allocated UUIDs and their corresponding local and final forms).
+ * This collection of all sessions comprises a distributed document's IDs.
+ */
+export declare class Sessions {
+    private readonly uuidSpace;
+    private readonly sessionCache;
+    constructor(sessions?: [sessionBase: NumericUuid, session: Session][]);
+    sessions(): IterableIterator<Session>;
+    getOrCreate(sessionId: SessionId): Session;
+    get(sessionId: SessionId): Session | undefined;
+    getContainingCluster(query: StableId): [cluster: IdCluster, alignedLocal: LocalCompressedId] | undefined;
+    clusterCollides(cluster: IdCluster): boolean;
+    equals(other: Sessions, includeLocalState: boolean): boolean;
+}
+/**
+ * The IDs created by a specific session, stored as a cluster chain to allow for fast conversions.
+ */
+export declare class Session {
+    private readonly clusterChain;
+    readonly sessionUuid: NumericUuid;
+    constructor(sessionId: SessionId | NumericUuid);
+    /**
+     * Adds a new empty cluster to the cluster chain of this session.
+     */
+    addNewCluster(baseFinalId: FinalCompressedId, capacity: number, count: number): IdCluster;
+    isEmpty(): boolean;
+    /**
+     * Returns the last cluster in this session's cluster chain, if any.
+     */
+    getLastCluster(): IdCluster | undefined;
+    /**
+     * Converts the local ID from this session to a final ID, if possible.
+     * @param includeAllocated - true if the conversion should succeed even if the local ID aligns with a part of the cluster that is allocated but not finalized.
+     */
+    tryConvertToFinal(searchLocal: LocalCompressedId, includeAllocated: boolean): FinalCompressedId | undefined;
+    /**
+     * Returns the cluster containing the supplied local ID, if possible.
+     * @param includeAllocated - true if the conversion should succeed even if the local ID aligns with a part of the cluster that is allocated but not finalized.
+     */
+    getClusterByLocal(localId: LocalCompressedId, includeAllocated: boolean): IdCluster | undefined;
+    /**
+     * Returns the cluster containing the supplied final ID, if possible.
+     */
+    getClusterByAllocatedFinal(final: FinalCompressedId): IdCluster | undefined;
+    /**
+     * Returns the cluster from the supplied cluster chain containing the supplied final ID, if possible.
+     * `clusterChain` must be sorted by final/local base ID.
+     */
+    static getContainingCluster(finalId: FinalCompressedId, clusterChain: readonly IdCluster[]): IdCluster | undefined;
+    static binarySearch<S, T>(search: S, arr: readonly T[], comparator: (a: S, b: T) => number): T | undefined;
+    equals(other: Session): boolean;
+}
+/**
+ * A cluster of final (sequenced via consensus), sequentially allocated compressed IDs.
+ * A final ID in a cluster decompresses to a sequentially allocated UUID that is the result of adding its offset within
+ * the cluster to base UUID for the session that created it.
+ */
+export interface IdCluster {
+    /**
+     * The session that created this cluster.
+     */
+    readonly session: Session;
+    /**
+     * The first final ID in the cluster.
+     */
+    readonly baseFinalId: FinalCompressedId;
+    /**
+     * The local ID aligned with `baseFinalId`.
+     */
+    readonly baseLocalId: LocalCompressedId;
+    /**
+     * The total number of final IDs reserved for allocation in the cluster.
+     * Clusters are reserved in blocks as a performance optimization.
+     */
+    capacity: number;
+    /**
+     * The number of final IDs currently allocated in the cluster.
+     */
+    count: number;
+}
+export declare function clustersEqual(a: IdCluster, b: IdCluster): boolean;
+/**
+ * Returns the final ID that is aligned with the supplied local ID within a cluster.
+ * Includes allocated IDs.
+ */
+export declare function getAlignedFinal(cluster: IdCluster, localWithin: LocalCompressedId): FinalCompressedId | undefined;
+/**
+ * Returns the local ID that is aligned with the supplied final ID within a cluster.
+ * Fails if the supplied ID does not fall within the cluster bounds.
+ */
+export declare function getAlignedLocal(cluster: IdCluster, finalWithin: FinalCompressedId): LocalCompressedId;
+/**
+ * Returns the last allocated final ID (i.e. any ID between base final and base final + capacity) within a cluster
+ */
+export declare function lastAllocatedFinal(cluster: IdCluster): FinalCompressedId;
+/**
+ * Returns the last allocated final ID (i.e. any ID between base final and base final + count) within a cluster
+ */
+export declare function lastFinalizedFinal(cluster: IdCluster): FinalCompressedId;
+/**
+ * Returns the last allocated local ID (i.e. any ID between base local and base local + capacity) within a cluster
+ */
+export declare function lastAllocatedLocal(cluster: IdCluster): LocalCompressedId;
+/**
+ * Returns the last allocated local ID (i.e. any ID between base local and base local + count) within a cluster
+ */
+export declare function lastFinalizedLocal(cluster: IdCluster): LocalCompressedId;
+//# sourceMappingURL=sessions.d.ts.map

package/dist/sessions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../src/sessions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAU9C,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAElF;;;GAGG;AACH,qBAAa,QAAQ;IAGpB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8D;IAExF,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiC;gBAE3C,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;IAgBrE,QAAQ,IAAI,gBAAgB,CAAC,OAAO,CAAC;IAIrC,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAc1C,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS;IAI9C,oBAAoB,CAC1B,KAAK,EAAE,QAAQ,GACb,CAAC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,CAAC,GAAG,SAAS;IAmB7D,eAAe,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO;IA0C5C,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,GAAG,OAAO;CAsBnE;AAED;;GAEG;AACH,qBAAa,OAAO;IAEnB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmB;IAEhD,SAAgB,WAAW,EAAE,WAAW,CAAC;gBAEtB,SAAS,EAAE,SAAS,GAAG,WAAW;IAKrD;;OAEG;IACI,aAAa,CACnB,WAAW,EAAE,iBAAiB,EAC9B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACX,SAAS;IAeL,OAAO,IAAI,OAAO;IAIzB;;OAEG;IACI,cAAc,IAAI,SAAS,GAAG,SAAS;IAI9C;;;OAGG;IACI,iBAAiB,CACvB,WAAW,EAAE,iBAAiB,EAC9B,gBAAgB,EAAE,OAAO,GACvB,iBAAiB,GAAG,SAAS;IAQhC;;;OAGG;IACI,iBAAiB,CACvB,OAAO,EAAE,iBAAiB,EAC1B,gBAAgB,EAAE,OAAO,GACvB,SAAS,GAAG,SAAS;IAqBxB;;OAEG;IACI,0BAA0B,CAAC,KAAK,EAAE,iBAAiB,GAAG,SAAS,GAAG,SAAS;IAIlF;;;OAGG;WACW,oBAAoB,CACjC,OAAO,EAAE,iBAAiB,EAC1B,YAAY,EAAE,SAAS,SAAS,EAAE,GAChC,SAAS,GAAG,SAAS;IAaxB,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EACvB,MAAM,EAAE,CAAC,EACT,GAAG,EAAE,SAAS,CAAC,EAAE,EACjB,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,GAChC,CAAC,GAAG,SAAS;IAiBT,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;CAQtC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAExC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,CAQjE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC9B,OAAO,EAAE,SAAS,EAClB,WAAW,EAAE,iBAAiB,GAC5B,iBAAiB,GAAG,SAAS,CAO/B;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC9B,OAAO,EAAE,SAAS,EAClB,WAAW,EAAE,iBAAiB,GAC5B,iBAAiB,CAOnB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,SAAS,GAAG,iBAAiB,CAExE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,SAAS,GAAG,iBAAiB,CAExE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,SAAS,GAAG,iBAAiB,CAExE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,SAAS,GAAG,iBAAiB,CAExE"}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

package/dist/types/idCompressor.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=idCompressor.cjs.map

package/dist/types/idCompressor.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"idCompressor.cjs","sourceRoot":"","sources":["../../src/types/idCompressor.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from \"./identifiers\";\nimport {\n\tIdCreationRange,\n\tSerializedIdCompressorWithNoSession,\n\tSerializedIdCompressorWithOngoingSession,\n} from \"./persisted-types\";\n\n/**\n * @alpha\n */\nexport interface IIdCompressorCore {\n\t/**\n\t * Returns a range of IDs created by this session in a format for sending to the server for finalizing.\n\t * The range will include all IDs generated via calls to `generateCompressedId` since the last time this method was called.\n\t * @returns the range of IDs, which may be empty. This range must be sent to the server for ordering before\n\t * it is finalized. Ranges must be sent to the server in the order that they are taken via calls to this method.\n\t */\n\ttakeNextCreationRange(): IdCreationRange;\n\n\t/**\n\t * Finalizes the supplied range of IDs (which may be from either a remote or local session).\n\t * @param range - the range of session-local IDs to finalize.\n\t */\n\tfinalizeCreationRange(range: IdCreationRange): void;\n\n\t/**\n\t * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.\n\t * This includes finalized state as well as un-finalized state and is therefore suitable for use in offline scenarios.\n\t */\n\tserialize(withSession: true): SerializedIdCompressorWithOngoingSession;\n\n\t/**\n\t * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.\n\t * This only includes finalized state and is therefore suitable for use in summaries.\n\t */\n\tserialize(withSession: false): SerializedIdCompressorWithNoSession;\n}\n\n/**\n * A distributed UUID generator and compressor.\n *\n * Generates arbitrary non-colliding v4 UUIDs, called stable IDs, for multiple \"sessions\" (which can be distributed across the network),\n * providing each session with the ability to map these UUIDs to `numbers`.\n *\n * A session is a unique identifier that denotes a single compressor. New IDs are created through a single compressor API\n * which should then sent in ranges to the server for total ordering (and are subsequently relayed to other clients). When a new ID is\n * created it is said to be created by the compressor's \"local\" session.\n *\n * For each stable ID created, two numeric IDs are provided by the compressor:\n *\n * 1. A session-local ID, which is stable for the lifetime of the session (which could be longer than that of the compressor object, as it may\n * be serialized for offline usage). Available as soon as the stable ID is allocated. These IDs are session-unique and are thus only\n * safely usable within the scope of the compressor that created it.\n *\n * 2. A final ID, which is stable across serialization and deserialization of an IdCompressor. Available as soon as the range containing\n * the corresponding session-local ID is totally ordered (via consensus) with respect to other sessions' allocations.\n * Final IDs are known to and publicly usable by any compressor that has received them.\n *\n * Compressors will allocate UUIDs in non-random ways to reduce entropy allowing for optimized storage of the data needed\n * to map the UUIDs to the numbers.\n *\n * The following invariants are upheld by IdCompressor:\n *\n * 1. Session-local IDs will always decompress to the same UUIDs for the lifetime of the session.\n *\n * 2. Final IDs will always decompress to the same UUIDs.\n *\n * 3. After a server-processed range of session-local IDs (from any session) is received by a compressor, any of those session-local IDs may be\n * translated by the compressor into the corresponding final ID. For any given session-local ID, this translation will always yield the\n * same final ID.\n *\n * 4. A UUID will always compress into the same session-local ID for the lifetime of the session.\n *\n * Session-local IDs are sent across the wire in efficiently-represented ranges. These ranges are created by querying the compressor, and *must*\n * be ordered (i.e. sent to the server) in the order they are created in order to preserve the above invariants.\n *\n * Session-local IDs can be used immediately after creation, but will eventually (after being sequenced) have a corresponding final ID. This\n * could make reasoning about equality of those two forms difficult. For example, if a cache is keyed off of a\n * session-local ID but is later queried using the final ID (which is semantically equal, as it decompresses to the same UUID/string) it will\n * produce a cache miss. In order to make using collections of both remotely created and locally created IDs easy, regardless of whether the\n * session-local IDs have been finalized, the compressor defines two \"spaces\" of IDs:\n *\n * 1. Session space: in this space, all IDs are normalized to their \"most local form\". This means that all IDs created by the local session\n * will be in local form, regardless of if they have been finalized. Remotely created IDs, which could only have been received after\n * finalizing and will never have a local form for the compressor, will of course be final IDs. This space should be used with consumer APIs\n * and data structures, as the lifetime of the IDs is guaranteed to be the same as the compressor object. Care must be taken to not use\n * these IDs across compressor objects, as the local IDs are specific to the compressor that created them.\n *\n * 2. Op space: in this space, all IDs are normalized to their \"most final form\". This means that all IDs except session-local IDs that\n * have not yet been finalized will be in final ID form. This space is useful for serialization in ops (e.g. references), as other clients\n * that receive them need not do any work to normalize them to *their* session-space in the common case. Note that IDs in op space may move\n * out of Op space over time, namely, when a session-local ID in this space becomes finalized, and thereafter has a \"more final form\".\n * Consequentially, it may be useful to restrict parameters of a persisted type to this space (to optimize perf), but it is potentially\n * incorrect to use this type for a runtime variable. This is an asymmetry that does not affect session space, as local IDs are always as\n * \"local as possible\".\n *\n * These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops\n * should use op-space IDs.\n * @public\n */\nexport interface IIdCompressor {\n\tlocalSessionId: SessionId;\n\n\t/**\n\t * Generates a new compressed ID or returns an existing one.\n\t * This should ONLY be called to generate IDs for local operations.\n\t * @returns A new local ID in session space.\n\t */\n\tgenerateCompressedId(): SessionSpaceCompressedId;\n\t/**\n\t * Normalizes a session space ID into op space.\n\t * @param id - the local ID to normalize.\n\t * @returns the ID in op space.\n\t */\n\tnormalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;\n\t/**\n\t * Normalizes an ID into session space.\n\t * @param id - the ID to normalize. If it is a local ID, it is assumed to have been created by the session corresponding\n\t * to `sessionId`.\n\t * @param originSessionId - the session from which `id` originated\n\t * @returns the session-space ID corresponding to `id`, which might not have been a final ID if the client that created it had not yet\n\t * finalized it. This can occur when a client references an ID during the window of time in which it is waiting to receive the ordered\n\t * range that contained it from the server.\n\t */\n\tnormalizeToSessionSpace(\n\t\tid: OpSpaceCompressedId,\n\t\toriginSessionId: SessionId,\n\t): SessionSpaceCompressedId;\n\n\t/**\n\t * Decompresses a previously compressed ID into a UUID.\n\t * @param id - the compressed ID to be decompressed.\n\t * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.\n\t */\n\tdecompress(id: SessionSpaceCompressedId): StableId;\n\n\t/**\n\t * Recompresses a UUID.\n\t * @param uncompressed - the UUID to recompress.\n\t * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.\n\t */\n\trecompress(uncompressed: StableId): SessionSpaceCompressedId;\n\n\t/**\n\t * Attempts to recompresses a UUID.\n\t * @param uncompressed - the UUID to recompress,\n\t * @returns the `CompressedId` associated with `uncompressed` or undefined if it has not been previously compressed by this compressor.\n\t */\n\ttryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;\n}\n"]}