@fluidframework/container-runtime 2.0.0-internal.5.3.2 → 2.0.0-internal.6.0.0

package/lib/id-compressor/idCompressor.js

@@ -2,8 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable @typescript-eslint/restrict-plus-operands */
 import { assert } from "@fluidframework/common-utils";
 import BTree from "sorted-btree";
+import { createChildLogger } from "@fluidframework/telemetry-utils";
 import { hasAtLeastLength, compareFiniteNumbers, compareFiniteNumbersReversed, compareMaps, compareStrings, fail, setPropertyIfDefined, } from "./utils";
 import { assertIsStableId, isStableId } from "./uuidUtilities";
 import { AppendOnlySortedMap } from "./appendOnlySortedMap";
@@ -44,7 +46,6 @@ export class IdCompressor {
      */
     constructor(localSessionId, logger) {
         this.localSessionId = localSessionId;
-        this.logger = logger;
         /**
          * Trivially reach consensus on default cluster size and reserved IDs.
          * These initial values must *NOT* change without careful consideration to compatibility.
@@ -99,6 +100,7 @@ export class IdCompressor {
          */
         this.finalIdToCluster = new AppendOnlySortedMap(compareFiniteNumbers);
         this.localSession = this.createSession(localSessionId);
+        this.logger = createChildLogger({ logger });
     }
     /**
      * The size of each newly created ID cluster.
@@ -143,9 +145,8 @@ export class IdCompressor {
      * it is finalized. Ranges must be sent to the server in the order that they are taken via calls to this method.
      */
     takeNextCreationRange() {
-        var _a;
         const lastLocalInRange = -this.localIdCount;
-        const lastTakenNormalized = (_a = this.lastTakenLocalId) !== null && _a !== void 0 ? _a : 0;
+        const lastTakenNormalized = this.lastTakenLocalId ?? 0;
         assert(lastLocalInRange <= lastTakenNormalized, 0x485 /* Inconsistent local ID state */);
         let ids;
         if (lastLocalInRange !== lastTakenNormalized) {
@@ -188,21 +189,20 @@ export class IdCompressor {
      * @param range - the range of session-local IDs to finalize.
      */
     finalizeCreationRange(range) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         const { sessionId } = range;
         const isLocal = sessionId === this.localSessionId;
-        const session = (_a = this.sessions.get(sessionId)) !== null && _a !== void 0 ? _a : this.createSession(sessionId);
+        const session = this.sessions.get(sessionId) ?? this.createSession(sessionId);
         const ids = getIds(range);
         if (ids === undefined) {
             return;
         }
         const { currentClusterDetails } = session;
-        const { cluster: currentCluster, clusterBase: currentBaseFinalId } = currentClusterDetails !== null && currentClusterDetails !== void 0 ? currentClusterDetails : {
+        const { cluster: currentCluster, clusterBase: currentBaseFinalId } = currentClusterDetails ?? {
             cluster: undefined,
             clusterBase: undefined,
         };
         const currentClusterExists = currentCluster !== undefined && currentBaseFinalId !== undefined;
-        const normalizedLastFinalizedLocal = (_b = session.lastFinalizedLocalId) !== null && _b !== void 0 ? _b : 0;
+        const normalizedLastFinalizedLocal = session.lastFinalizedLocalId ?? 0;
         const { first: newFirstFinalizedLocal, last: newLastFinalizedLocal } = ids;
         assert(newFirstFinalizedLocal === normalizedLastFinalizedLocal - 1, 0x489 /* Ranges finalized out of order. */);
         // The total number of session-local IDs to finalize
@@ -214,7 +214,8 @@ export class IdCompressor {
         let newBaseUuid;
         if (currentClusterExists) {
             if (isLocal) {
-                const lastKnownFinal = (_c = this.sessionIdNormalizer.getLastFinalId()) !== null && _c !== void 0 ? _c : fail("Cluster exists but normalizer does not have an entry for it.");
+                const lastKnownFinal = this.sessionIdNormalizer.getLastFinalId() ??
+                    fail("Cluster exists but normalizer does not have an entry for it.");
                 const lastAlignedFinalInCluster = (currentBaseFinalId +
                     Math.min(currentCluster.count + finalizeCount, currentCluster.capacity) -
                     1);
@@ -265,7 +266,7 @@ export class IdCompressor {
                         // actually finalized, because total order broadcast guarantees that any usage of those final IDs will be observed after
                         // the finalization of the ranges.
                         this.sessionIdNormalizer.registerFinalIdBlock(finalPivot, expansionAmount, currentCluster);
-                        (_d = this.logger) === null || _d === void 0 ? void 0 : _d.sendTelemetryEvent({
+                        this.logger?.sendTelemetryEvent({
                             eventName: "RuntimeIdCompressor:ClusterExpansion",
                             sessionId: this.localSessionId,
                             previousCapacity,
@@ -281,7 +282,7 @@ export class IdCompressor {
                 newBaseUuid = incrementUuid(currentCluster.baseUuid, currentCluster.capacity);
                 currentCluster.count += remainingCapacity;
                 remainingCount -= remainingCapacity;
-                (_e = this.logger) === null || _e === void 0 ? void 0 : _e.sendTelemetryEvent({
+                this.logger?.sendTelemetryEvent({
                     eventName: "RuntimeIdCompressor:OverfilledCluster",
                     sessionId: this.localSessionId,
                 });
@@ -291,7 +292,7 @@ export class IdCompressor {
             // Session has never made a cluster, form a new one with the session UUID as the baseUuid
             newBaseUuid = session.sessionUuid;
             if (isLocal) {
-                (_f = this.logger) === null || _f === void 0 ? void 0 : _f.sendTelemetryEvent({
+                this.logger?.sendTelemetryEvent({
                     eventName: "RuntimeIdCompressor:FirstCluster",
                     sessionId: this.localSessionId,
                 });
@@ -326,7 +327,7 @@ export class IdCompressor {
             const usedCapacity = finalizeCount - remainingCount;
             localIdPivot = (newFirstFinalizedLocal - usedCapacity);
             if (isLocal) {
-                (_g = this.logger) === null || _g === void 0 ? void 0 : _g.sendTelemetryEvent({
+                this.logger?.sendTelemetryEvent({
                     eventName: "RuntimeIdCompressor:NewCluster",
                     sessionId: this.localSessionId,
                     clusterCapacity: newCapacity,
@@ -372,7 +373,7 @@ export class IdCompressor {
                         (normalizedLastFinalizedLocal - overriddenLocal) -
                         1);
                 }
-                (_h = cluster.overrides) !== null && _h !== void 0 ? _h : (cluster.overrides = new Map());
+                cluster.overrides ?? (cluster.overrides = new Map());
                 const inversionKey = IdCompressor.createInversionKey(override);
                 const existingIds = this.getExistingIdsForNewOverride(inversionKey, true);
                 let overrideForCluster;
@@ -440,11 +441,11 @@ export class IdCompressor {
             }
         }
         if (isLocal) {
-            (_j = this.logger) === null || _j === void 0 ? void 0 : _j.sendTelemetryEvent({
+            this.logger?.sendTelemetryEvent({
                 eventName: "RuntimeIdCompressor:IdCompressorStatus",
-                eagerFinalIdCount: eagerFinalIdCount - ((_k = overrides === null || overrides === void 0 ? void 0 : overrides.length) !== null && _k !== void 0 ? _k : 0),
-                localIdCount: remainingCount + ((_l = overrides === null || overrides === void 0 ? void 0 : overrides.length) !== null && _l !== void 0 ? _l : 0),
-                overridesCount: (_m = overrides === null || overrides === void 0 ? void 0 : overrides.length) !== null && _m !== void 0 ? _m : 0,
+                eagerFinalIdCount: eagerFinalIdCount - (overrides?.length ?? 0),
+                localIdCount: remainingCount + (overrides?.length ?? 0),
+                overridesCount: overrides?.length ?? 0,
                 sessionId: this.localSessionId,
             });
         }
@@ -489,7 +490,6 @@ export class IdCompressor {
      * Returns an existing ID associated with an override, or undefined if none exists.
      */
     getExistingIdsForNewOverride(inversionKey, isFinalOverride) {
-        var _a;
         const closestMatch = this.clustersAndOverridesInversion.getPairOrNextLower(inversionKey, reusedArray);
         let numericOverride;
         let stableOverride;
@@ -527,7 +527,9 @@ export class IdCompressor {
                 }
             }
         }
-        const override = (_a = numericOverride !== null && numericOverride !== void 0 ? numericOverride : stableOverride) !== null && _a !== void 0 ? _a : (IdCompressor.isStableInversionKey(inversionKey) ? inversionKey : undefined);
+        const override = numericOverride ??
+            stableOverride ??
+            (IdCompressor.isStableInversionKey(inversionKey) ? inversionKey : undefined);
         if (override !== undefined) {
             const sessionSpaceId = this.getCompressedIdForStableId(override);
             if (sessionSpaceId !== undefined) {
@@ -555,8 +557,7 @@ export class IdCompressor {
      * Helper for retrieving an override.
      */
     static tryGetOverride(cluster, finalId) {
-        var _a;
-        const override = (_a = cluster.overrides) === null || _a === void 0 ? void 0 : _a.get(finalId);
+        const override = cluster.overrides?.get(finalId);
         if (override === undefined) {
             return undefined;
         }
@@ -601,15 +602,15 @@ export class IdCompressor {
             const registeredLocal = sessionIdNormalizer.addLocalId();
             assert(registeredLocal === newLocalId, 0x496 /* Session ID Normalizer produced unexpected local ID */);
             if (eagerFinalId !== undefined) {
-                sessionIdNormalizer.addFinalIds(eagerFinalId, eagerFinalId, cluster !== null && cluster !== void 0 ? cluster : fail("No cluster when generating compressed ID"));
+                sessionIdNormalizer.addFinalIds(eagerFinalId, eagerFinalId, cluster ?? fail("No cluster when generating compressed ID"));
             }
-            this.localOverrides.append(newLocalId, override !== null && override !== void 0 ? override : fail("Override must be defined"));
+            this.localOverrides.append(newLocalId, override ?? fail("Override must be defined"));
             // Since the local ID was just created, it is in both session and op space
             const compressionMapping = newLocalId;
             this.clustersAndOverridesInversion.set(overrideInversionKey, compressionMapping);
         }
         else if (eagerFinalId !== undefined) {
-            sessionIdNormalizer.addFinalIds(eagerFinalId, eagerFinalId, cluster !== null && cluster !== void 0 ? cluster : fail("No cluster when generating compressed ID"));
+            sessionIdNormalizer.addFinalIds(eagerFinalId, eagerFinalId, cluster ?? fail("No cluster when generating compressed ID"));
             return eagerFinalId;
         }
         else {
@@ -624,8 +625,7 @@ export class IdCompressor {
      * @returns the UUID or override string associated with the compressed ID. Fails if the ID was not generated by this compressor.
      */
     decompress(id) {
-        var _a;
-        return (_a = this.tryDecompress(id)) !== null && _a !== void 0 ? _a : fail("Compressed ID was not generated by this compressor");
+        return this.tryDecompress(id) ?? fail("Compressed ID was not generated by this compressor");
     }
     /**
      * Attempts to decompress a previously compressed ID into a UUID or override string.
@@ -633,7 +633,6 @@ export class IdCompressor {
      * @returns the UUID or override string associated with the compressed ID, or undefined if the ID was not generated by this compressor.
      */
     tryDecompress(id) {
-        var _a;
         if (isFinalId(id)) {
             const possibleCluster = this.getClusterForFinalId(id);
             if (possibleCluster === undefined) {
@@ -665,7 +664,7 @@ export class IdCompressor {
             // If this is a local ID with an override, then it must have been allocated on this machine and will be contained in
             // `localOverrides`s. Otherwise, it is a sequential allocation from the session UUID and can simply be negated and
             // added to that UUID to obtain the stable ID associated with it.
-            const localOverride = (_a = this.localOverrides) === null || _a === void 0 ? void 0 : _a.get(id);
+            const localOverride = this.localOverrides?.get(id);
             return localOverride !== undefined
                 ? localOverride
                 : stableIdFromNumericUuid(this.localSession.sessionUuid, idOffset - 1);
@@ -677,8 +676,7 @@ export class IdCompressor {
      * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.
      */
     recompress(uncompressed) {
-        var _a;
-        return (_a = this.tryRecompress(uncompressed)) !== null && _a !== void 0 ? _a : fail("No such string has ever been compressed");
+        return this.tryRecompress(uncompressed) ?? fail("No such string has ever been compressed");
     }
     /**
      * Attempts to recompresses a decompressed ID, which could be a UUID or an override string.
@@ -693,7 +691,6 @@ export class IdCompressor {
      * performance optimization.
      */
     recompressInternal(uncompressed, uncompressedUuidNumeric) {
-        var _a, _b;
         let numericUuid = uncompressedUuidNumeric;
         const inversionKey = IdCompressor.createInversionKey(uncompressed);
         const isStable = IdCompressor.isStableInversionKey(inversionKey);
@@ -704,7 +701,8 @@ export class IdCompressor {
                 if (key === inversionKey) {
                     return IdCompressor.isUnfinalizedOverride(compressionMapping)
                         ? compressionMapping
-                        : (_a = compressionMapping.associatedLocalId) !== null && _a !== void 0 ? _a : compressionMapping.originalOverridingFinal;
+                        : compressionMapping.associatedLocalId ??
+                            compressionMapping.originalOverridingFinal;
                 }
             }
             else {
@@ -712,11 +710,11 @@ export class IdCompressor {
                     return undefined;
                 }
                 const { clusterBase: closestBaseFinalId, cluster: closestCluster } = compressionMapping;
-                numericUuid !== null && numericUuid !== void 0 ? numericUuid : (numericUuid = numericUuidFromStableId(inversionKey));
+                numericUuid ?? (numericUuid = numericUuidFromStableId(inversionKey));
                 const uuidOffset = getPositiveDelta(numericUuid, closestCluster.baseUuid, closestCluster.count - 1);
                 if (uuidOffset !== undefined) {
                     let targetFinalId = (closestBaseFinalId + uuidOffset);
-                    const override = (_b = closestCluster.overrides) === null || _b === void 0 ? void 0 : _b.get(targetFinalId);
+                    const override = closestCluster.overrides?.get(targetFinalId);
                     if (typeof override === "object") {
                         if (override.associatedLocalId !== undefined) {
                             return override.associatedLocalId;
@@ -731,7 +729,7 @@ export class IdCompressor {
         }
         if (isStable) {
             // May have already computed the numeric UUID, so avoid recomputing if possible
-            const sessionSpaceId = this.getCompressedIdForStableId(numericUuid !== null && numericUuid !== void 0 ? numericUuid : inversionKey);
+            const sessionSpaceId = this.getCompressedIdForStableId(numericUuid ?? inversionKey);
             if (sessionSpaceId !== undefined) {
                 return sessionSpaceId;
             }
@@ -744,7 +742,6 @@ export class IdCompressor {
      * @returns the ID in op space.
      */
     normalizeToOpSpace(id) {
-        var _a, _b, _c;
         if (isFinalId(id)) {
             return id;
         }
@@ -763,7 +760,8 @@ export class IdCompressor {
             const override = this.localOverrides.get(id);
             if (override !== undefined) {
                 const inversionKey = IdCompressor.createInversionKey(override);
-                const compressionMapping = (_a = this.clustersAndOverridesInversion.get(inversionKey)) !== null && _a !== void 0 ? _a : fail("Bimap is malformed.");
+                const compressionMapping = this.clustersAndOverridesInversion.get(inversionKey) ??
+                    fail("Bimap is malformed.");
                 return !IdCompressor.isClusterInfo(compressionMapping) &&
                     !IdCompressor.isUnfinalizedOverride(compressionMapping) &&
                     compressionMapping.associatedLocalId === id
@@ -771,9 +769,10 @@ export class IdCompressor {
                     : id;
             }
             const possibleFinal = this.sessionIdNormalizer.getFinalId(id);
-            return (_b = possibleFinal === null || possibleFinal === void 0 ? void 0 : possibleFinal[0]) !== null && _b !== void 0 ? _b : id;
+            return possibleFinal?.[0] ?? id;
         }
-        const [correspondingFinal, cluster] = (_c = this.sessionIdNormalizer.getFinalId(id)) !== null && _c !== void 0 ? _c : fail("Locally created cluster should be added to the map when allocated");
+        const [correspondingFinal, cluster] = this.sessionIdNormalizer.getFinalId(id) ??
+            fail("Locally created cluster should be added to the map when allocated");
         if (cluster.overrides) {
             const override = cluster.overrides.get(correspondingFinal);
             if (typeof override === "object" && override.originalOverridingFinal !== undefined) {
@@ -784,7 +783,6 @@ export class IdCompressor {
         return correspondingFinal;
     }
     normalizeToSessionSpace(id, sessionIdIfLocal) {
-        var _a, _b, _c, _d;
         if (isLocalId(id)) {
             if (sessionIdIfLocal === undefined || sessionIdIfLocal === this.localSessionId) {
                 const localIndex = -id;
@@ -794,10 +792,12 @@ export class IdCompressor {
                 return id;
             }
             else {
-                const session = (_a = this.sessions.get(sessionIdIfLocal)) !== null && _a !== void 0 ? _a : fail("No IDs have ever been finalized by the supplied session.");
+                const session = this.sessions.get(sessionIdIfLocal) ??
+                    fail("No IDs have ever been finalized by the supplied session.");
                 const localCount = -id;
                 const numericUuid = incrementUuid(session.sessionUuid, localCount - 1);
-                return ((_b = this.compressNumericUuid(numericUuid)) !== null && _b !== void 0 ? _b : fail("ID is not known to this compressor."));
+                return (this.compressNumericUuid(numericUuid) ??
+                    fail("ID is not known to this compressor."));
             }
         }
         const normalizedId = this.sessionIdNormalizer.getSessionSpaceId(id);
@@ -806,8 +806,9 @@ export class IdCompressor {
         }
         // Check for a unified override finalized first by another session but to which the local session
         // still has an associated local ID.
-        const [_, cluster] = (_c = this.getClusterForFinalId(id)) !== null && _c !== void 0 ? _c : fail("Supplied final ID was not finalized by this compressor.");
-        const override = (_d = cluster.overrides) === null || _d === void 0 ? void 0 : _d.get(id);
+        const [_, cluster] = this.getClusterForFinalId(id) ??
+            fail("Supplied final ID was not finalized by this compressor.");
+        const override = cluster.overrides?.get(id);
         if (typeof override === "object" && override.associatedLocalId !== undefined) {
             return override.associatedLocalId;
         }
@@ -976,7 +977,6 @@ export class IdCompressor {
         return true;
     }
     static idClustersEqual(a, b, checkSessionData = true, compareLocalState = true) {
-        var _a, _b;
         const areEqual = numericUuidEquals(a.baseUuid, b.baseUuid) &&
             a.capacity === b.capacity &&
             a.count === b.count &&
@@ -984,7 +984,7 @@ export class IdCompressor {
                 IdCompressor.sessionDataEqual(a.session, b.session, false, compareLocalState)) &&
             (a.overrides === undefined) === (b.overrides === undefined) &&
             (a.overrides === undefined ||
-                compareMaps((_a = a.overrides) !== null && _a !== void 0 ? _a : fail("Overrides must be defined"), (_b = b.overrides) !== null && _b !== void 0 ? _b : fail("Overrides must be defined"), (overrideA, overrideB) => {
+                compareMaps(a.overrides ?? fail("Overrides must be defined"), b.overrides ?? fail("Overrides must be defined"), (overrideA, overrideB) => {
                     if (compareLocalState) {
                         if (typeof overrideA === "string" || typeof overrideB === "string") {
                             return overrideA === overrideB;
@@ -1008,7 +1008,6 @@ export class IdCompressor {
         return areEqual;
     }
     serialize(withSession) {
-        var _a, _b;
         const serializedSessions = [];
         const sessionIdToSessionIndex = new Map();
         for (const [sessionId, session] of this.sessions) {
@@ -1026,7 +1025,8 @@ export class IdCompressor {
         for (const [baseFinalId, cluster] of this.finalIdToCluster.entries()) {
             const sessionId = stableIdFromNumericUuid(cluster.session.sessionUuid);
             if (sessionId !== reservedSessionId) {
-                const sessionIndex = (_a = sessionIdToSessionIndex.get(sessionId)) !== null && _a !== void 0 ? _a : fail("Session object contains wrong session numeric UUID");
+                const sessionIndex = sessionIdToSessionIndex.get(sessionId) ??
+                    fail("Session object contains wrong session numeric UUID");
                 const serializedCluster = [
                     sessionIndex,
                     cluster.capacity,
@@ -1078,7 +1078,7 @@ export class IdCompressor {
             }
             return serializedWithSession;
         }
-        (_b = this.logger) === null || _b === void 0 ? void 0 : _b.sendTelemetryEvent({
+        this.logger?.sendTelemetryEvent({
             eventName: "RuntimeIdCompressor:SerializedIdCompressorSize",
             size: JSON.stringify(serializedIdCompressor).length,
             clusterCount: serializedIdCompressor.clusters.length,
@@ -1139,7 +1139,7 @@ export class IdCompressor {
                 baseUuid: incrementUuid(sessionUuid, currentIdCount),
                 session,
             };
-            const lastFinalizedNormalized = lastFinalizedLocalId !== null && lastFinalizedLocalId !== void 0 ? lastFinalizedLocalId : 0;
+            const lastFinalizedNormalized = lastFinalizedLocalId ?? 0;
             const clusterBase = compressor.nextClusterBaseFinalId;
             session.lastFinalizedLocalId = (lastFinalizedNormalized - count);
             session.currentClusterDetails = { clusterBase, cluster };
@@ -1193,8 +1193,8 @@ export class IdCompressor {
         }
         if (serializedLocalState !== undefined) {
             compressor.sessionIdNormalizer = SessionIdNormalizer.deserialize(serializedLocalState.sessionNormalizer, (finalId) => {
-                var _a;
-                const [_, cluster] = (_a = compressor.finalIdToCluster.getPairOrNextLower(finalId)) !== null && _a !== void 0 ? _a : fail("Final in serialized normalizer was never created.");
+                const [_, cluster] = compressor.finalIdToCluster.getPairOrNextLower(finalId) ??
+                    fail("Final in serialized normalizer was never created.");
                 return cluster;
             });
         }