@fluid-experimental/tree 1.2.6 → 1.2.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/tree",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "description": "Distributed tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -38,13 +38,13 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^1.2.6",
-    "@fluidframework/core-interfaces": "^1.2.6",
-    "@fluidframework/datastore-definitions": "^1.2.6",
+    "@fluidframework/container-definitions": "^1.2.7",
+    "@fluidframework/core-interfaces": "^1.2.7",
+    "@fluidframework/datastore-definitions": "^1.2.7",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^1.2.6",
-    "@fluidframework/shared-object-base": "^1.2.6",
-    "@fluidframework/telemetry-utils": "^1.2.6",
+    "@fluidframework/runtime-definitions": "^1.2.7",
+    "@fluidframework/shared-object-base": "^1.2.7",
+    "@fluidframework/telemetry-utils": "^1.2.7",
     "buffer": "^6.0.3",
     "denque": "^1.5.1",
     "lru-cache": "^6.0.0",
@@ -52,19 +52,19 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/stochastic-test-utils": "^1.2.6",
+    "@fluid-internal/stochastic-test-utils": "^1.2.7",
     "@fluid-tools/benchmark": "^0.40.0",
     "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/container-loader": "^1.2.6",
-    "@fluidframework/container-runtime": "^1.2.6",
+    "@fluidframework/container-loader": "^1.2.7",
+    "@fluidframework/container-runtime": "^1.2.7",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.2.6",
-    "@fluidframework/runtime-utils": "^1.2.6",
-    "@fluidframework/test-driver-definitions": "^1.2.6",
-    "@fluidframework/test-drivers": "^1.2.6",
-    "@fluidframework/test-runtime-utils": "^1.2.6",
-    "@fluidframework/test-utils": "^1.2.6",
-    "@fluidframework/undo-redo": "^1.2.6",
+    "@fluidframework/mocha-test-setup": "^1.2.7",
+    "@fluidframework/runtime-utils": "^1.2.7",
+    "@fluidframework/test-driver-definitions": "^1.2.7",
+    "@fluidframework/test-drivers": "^1.2.7",
+    "@fluidframework/test-runtime-utils": "^1.2.7",
+    "@fluidframework/test-utils": "^1.2.7",
+    "@fluidframework/undo-redo": "^1.2.7",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/lru-cache": "^5.1.0",

package/src/id-compressor/IdCompressor.ts

@@ -612,16 +612,37 @@ export class IdCompressor {
 						// Example with cluster size of 3:
 						// Ids generated so far:   -1  1  2 -4 -5  <-- note positive numbers are eager finals
 						//         Cluster:      [  0  1  2 ]
-						// ~ finalizing happens, causing expansion ~
-						//        Cluster:       [  0  1  2  3  4  5 ]
-						// corresponding locals:   -1       -4
-						//      lastFinalizedLocalId^              ^newLastFinalizedLocalId = -6
+						// ~ finalizing happens, causing expansion of 2 (overflow) + 3 (cluster capacity) ~
+						//        Cluster:       [  0  1  2  3  4  _  _  _ ]
+						// corresponding locals:   -1       -4 -5
+						//      lastFinalizedLocalId^           ^newLastFinalizedLocalId = -5
 						//                  overflow = 2:    ----
 						//                       localIdPivot^
 						//                    lastFinalizedFinal^
-						const lastFinalizedFinal = (currentBaseFinalId + currentCluster.count - 1) as FinalCompressedId;
-						const finalPivot = (lastFinalizedFinal - overflow + 1) as FinalCompressedId;
-						this.sessionIdNormalizer.addFinalIds(finalPivot, lastFinalizedFinal, currentCluster);
+						const newLastFinalizedFinal = (currentBaseFinalId +
+							currentCluster.count -
+							1) as FinalCompressedId;
+						assert(
+							session.lastFinalizedLocalId !== undefined,
+							'Cluster already exists for session but there is no finalized local ID'
+						);
+						const newLastFinalizedLocal = session.lastFinalizedLocalId - finalizeCount;
+						const lastLocal = -this.localIdCount;
+						// Calculate the last final in the cluster that aligns with an existing local. If there are more unfinalized locals
+						// than fit in the expanded cluster, this will be the last final in the cluster
+						const newLastFinal = (newLastFinalizedFinal +
+							Math.min(newLastFinalizedLocal - lastLocal, this.newClusterCapacity)) as FinalCompressedId;
+						assert(
+							newLastFinal >= newLastFinalizedFinal,
+							'The number of unfinalized locals should only be positive'
+						);
+						const finalPivot = (newLastFinalizedFinal - overflow + 1) as FinalCompressedId;
+						// Inform the normalizer of all IDs that we now know will end up being finalized into this cluster, including the ones
+						// that were given out as locals (non-eager) because they exceeded the bounds of the current cluster before it was expanded.
+						// It is safe to associate the unfinalized locals with their future final IDs even before the ranges for those locals are
+						// 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.addFinalIds(finalPivot, newLastFinal, currentCluster);
 						this.logger?.sendTelemetryEvent({
 							eventName: 'IdCompressor:ClusterExpansion',
 							sessionId: this.localSessionId,

package/src/id-compressor/SessionIdNormalizer.ts

@@ -113,8 +113,8 @@ export class SessionIdNormalizer<TRangeObject> {
 	}
 
 	/**
-	 * Returns the index of the supplied session-space ID in the total range of IDs created by the session, if the ID was created
-	 * by the session for this `SessionIdNormalizer`.
+	 * Returns the index of the local ID corresponding to the supplied final ID in the total range of IDs created by the session,
+	 * if the ID was created by the session for this `SessionIdNormalizer`.
 	 */
 	public getCreationIndex(finalId: FinalCompressedId): number | undefined {
 		const localRange = this.idRanges.getPairOrNextLowerByValue(finalId);