@fluidframework/runtime-utils 2.0.0-internal.3.3.1 → 2.0.0-internal.3.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.0.0-internal.3.3.1",
+  "version": "2.0.0-internal.3.4.0",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,35 +37,34 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
-    "@fluidframework/garbage-collector": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
-    "@fluidframework/protocol-base": "^0.1038.3000",
+    "@fluidframework/container-definitions": "^2.0.0-internal.3.4.0",
+    "@fluidframework/container-runtime-definitions": "^2.0.0-internal.3.4.0",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.3.4.0",
+    "@fluidframework/datastore-definitions": "^2.0.0-internal.3.4.0",
+    "@fluidframework/garbage-collector": "^2.0.0-internal.3.4.0",
+    "@fluidframework/protocol-base": "^0.1038.4000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0"
+    "@fluidframework/runtime-definitions": "^2.0.0-internal.3.4.0",
+    "@fluidframework/telemetry-utils": "^2.0.0-internal.3.4.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.12.0",
+    "@fluid-tools/build-cli": "^0.13.0",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.12.0",
+    "@fluidframework/build-tools": "^0.13.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.3.4.0",
     "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.3.2.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@microsoft/api-extractor": "^7.34.4",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.36",
-    "concurrently": "^6.2.0",
+    "@types/node": "^14.18.38",
+    "concurrently": "^7.6.0",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.2",
+    "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
+    "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
     "ts-node": "^7.0.1",
     "typescript": "~4.5.5"

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/runtime-utils";
-export const pkgVersion = "2.0.0-internal.3.3.1";
+export const pkgVersion = "2.0.0-internal.3.4.0";

package/src/summarizerNode/summarizerNode.ts

@@ -547,7 +547,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		// There may be additional state that has to be updated in this child. For example, if a summary is being
 		// tracked, the child's summary tracking state needs to be updated too. Same goes for pendingSummaries we might
 		// have outstanding on the parent in case we realize nodes in between Summary Op and Summary Ack.
-		this.maybeUpdateChildState(child);
+		this.maybeUpdateChildState(child, id);
 
 		this.children.set(id, child);
 		return child;
@@ -663,8 +663,10 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * Also, in case a child node gets realized in between Summary Op and Summary Ack, let's initialize the child's
 	 * pending summary as well.
 	 * @param child - The child node whose state is to be updated.
+	 * @param id - Initial id or path part of this node
+	 *
 	 */
-	protected maybeUpdateChildState(child: SummarizerNode) {
+	protected maybeUpdateChildState(child: SummarizerNode, id: string) {
 		// If a summary is in progress, this child was created after the summary started. So, we need to update the
 		// child's summary state as well.
 		if (this.isSummaryInProgress()) {

package/src/summarizerNode/summarizerNodeWithGc.ts

@@ -10,6 +10,7 @@ import {
 	getGCDataFromSnapshot,
 	runGarbageCollection,
 	unpackChildNodesGCDetails,
+	unpackChildNodesUsedRoutes,
 } from "@fluidframework/garbage-collector";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 import {
@@ -24,6 +25,7 @@ import {
 	SummarizeInternalFn,
 	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
+import { LoggingError, TelemetryDataTag } from "@fluidframework/telemetry-utils";
 import { ReadAndParseBlob } from "../utils";
 import { SummarizerNode } from "./summarizerNode";
 import {
@@ -81,9 +83,14 @@ class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNode
 	// The base GC details of this node used to initialize the GC state.
 	private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;
 
-	// Keeps track of whether we have loaded the base details to ensure that we on;y do it once.
+	// Keeps track of whether we have loaded the base details to ensure that we only do it once.
 	private baseGCDetailsLoaded: boolean = false;
 
+	// The base GC details for the child nodes. This is passed to child nodes when creating them.
+	private readonly childNodesBaseGCDetailsP: LazyPromise<
+		Map<string, IGarbageCollectionDetailsBase>
+	>;
+
 	private gcData: IGarbageCollectionData | undefined;
 
 	// Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure
@@ -133,6 +140,11 @@ class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNode
 		this.baseGCDetailsP = new LazyPromise(async () => {
 			return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };
 		});
+
+		this.childNodesBaseGCDetailsP = new LazyPromise(async () => {
+			await this.loadBaseGCDetails();
+			return unpackChildNodesGCDetails({ gcData: this.gcData, usedRoutes: this.usedRoutes });
+		});
 	}
 
 	/**
@@ -297,9 +309,28 @@ class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNode
 	): void {
 		// If GC is disabled, skip setting referenced used routes since we are not tracking GC state.
 		if (!this.gcDisabled) {
-			const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;
-			if (summaryNode?.serializedUsedRoutes !== undefined) {
-				this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);
+			const summaryNode = this.pendingSummaries.get(proposalHandle);
+			if (summaryNode !== undefined) {
+				// If a pending summary exists, it must have used routes since GC is enabled.
+				const summaryNodeWithGC = summaryNode as SummaryNodeWithGC;
+				if (summaryNodeWithGC.serializedUsedRoutes === undefined) {
+					const error = new LoggingError("MissingGCStateInPendingSummary", {
+						proposalHandle,
+						referenceSequenceNumber,
+						id: {
+							tag: TelemetryDataTag.CodeArtifact,
+							value: this.telemetryNodeId,
+						},
+					});
+					this.logger.sendErrorEvent(
+						{
+							eventName: error.message,
+						},
+						error,
+					);
+					throw error;
+				}
+				this.referenceUsedRoutes = JSON.parse(summaryNodeWithGC.serializedUsedRoutes);
 			}
 		}
 
@@ -434,23 +465,16 @@ class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNode
 		getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,
 	): ISummarizerNodeWithGC {
 		assert(!this.children.has(id), 0x1b6 /* "Create SummarizerNode child already exists" */);
-
 		/**
 		 * Update the child node's base GC details from this node's current GC details instead of updating from the base
 		 * GC details of this node. This will handle scenarios where the GC details was updated during refresh from
 		 * snapshot and the child node wasn't created then. If a child is created after that, its GC details should be
 		 * the one from the downloaded snapshot and not the base GC details.
 		 */
-		const getChildBaseGCDetailsP = new LazyPromise<IGarbageCollectionDetailsBase>(async () => {
-			// Ensure that the base GC details is loaded because a child can be created before GC runs which is when
-			// base GC details is usually loaded.
-			await this.loadBaseGCDetails();
-			const childBaseGCDetails = unpackChildNodesGCDetails({
-				gcData: this.gcData,
-				usedRoutes: this.usedRoutes,
-			});
-			return childBaseGCDetails.get(id) ?? {};
-		});
+		const getChildBaseGCDetailsFn = async () => {
+			const childNodesBaseGCDetails = await this.childNodesBaseGCDetailsP;
+			return childNodesBaseGCDetails.get(id) ?? {};
+		};
 
 		const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);
 		const child = new SummarizerNodeWithGC(
@@ -466,18 +490,53 @@ class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNode
 			createDetails.initialSummary,
 			this.wipSummaryLogger,
 			getGCDataFn,
-			async () => getChildBaseGCDetailsP,
+			getChildBaseGCDetailsFn,
 			createDetails.telemetryNodeId,
 		);
 
 		// There may be additional state that has to be updated in this child. For example, if a summary is being
 		// tracked, the child's summary tracking state needs to be updated too.
-		this.maybeUpdateChildState(child);
+		this.maybeUpdateChildState(child, id);
 
 		this.children.set(id, child);
 		return child;
 	}
 
+	/**
+	 * Updates the state of the child if required. For example, if a summary is currently being  tracked, the child's
+	 * summary tracking state needs to be updated too.
+	 * Also, in case a child node gets realized in between Summary Op and Summary Ack, let's initialize the child's
+	 * pending summary as well. Finally, if the pendingSummaries entries have serializedRoutes, replicate them to the
+	 * pendingSummaries from the child nodes.
+	 * @param child - The child node whose state is to be updated.
+	 * @param id - Initial id or path part of this node
+	 */
+	protected maybeUpdateChildState(child: SummarizerNodeWithGC, id: string) {
+		super.maybeUpdateChildState(child, id);
+
+		// In case we have pending summaries on the parent, let's initialize it on the child.
+		if (child.latestSummary !== undefined) {
+			for (const [key, value] of this.pendingSummaries.entries()) {
+				const summaryNodeWithGC = value as SummaryNodeWithGC;
+				if (summaryNodeWithGC.serializedUsedRoutes !== undefined) {
+					const childNodeUsedRoutes = unpackChildNodesUsedRoutes(
+						JSON.parse(summaryNodeWithGC.serializedUsedRoutes),
+					);
+					const newSerializedRoutes = childNodeUsedRoutes.get(id) ?? [""];
+					const newLatestSummaryNode = new SummaryNodeWithGC(
+						JSON.stringify(newSerializedRoutes),
+						{
+							referenceSequenceNumber: value.referenceSequenceNumber,
+							basePath: value.basePath,
+							localPath: value.localPath,
+						},
+					);
+					child.addPendingSummary(key, newLatestSummaryNode);
+				}
+			}
+		}
+	}
+
 	/**
 	 * Deletes the child node with the given id.
 	 */