@fluidframework/container-runtime 2.13.0 → 2.21.0

package/src/summary/summarizerNode/summarizerNode.ts

@@ -61,7 +61,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * The reference sequence number of the most recent acked summary.
 	 * Returns 0 if there is not yet an acked summary.
 	 */
-	public get referenceSequenceNumber() {
+	public get referenceSequenceNumber(): number {
 		return this._lastSummaryReferenceSequenceNumber ?? 0;
 	}
 
@@ -98,13 +98,19 @@ export class SummarizerNode implements IRootSummarizerNode {
 		baseLogger: ITelemetryBaseLogger,
 		private readonly summarizeInternalFn: SummarizeInternalFn,
 		config: ISummarizerNodeConfig,
-		/** Encoded handle or path to the node */
+		/**
+		 * Encoded handle or path to the node
+		 */
 		private readonly _summaryHandleId: EscapedPath,
 		private _changeSequenceNumber: number,
-		/** Summary reference sequence number, i.e. last sequence number seen when last successful summary was created */
+		/**
+		 * Summary reference sequence number, i.e. last sequence number seen when last successful summary was created
+		 */
 		private _lastSummaryReferenceSequenceNumber?: number,
 		protected wipSummaryLogger?: ITelemetryBaseLogger,
-		/** A unique id of this node to be logged when sending telemetry. */
+		/**
+		 * A unique id of this node to be logged when sending telemetry.
+		 */
 		protected telemetryNodeId?: string,
 	) {
 		this.canReuseHandle = config.canReuseHandle ?? true;
@@ -192,20 +198,23 @@ export class SummarizerNode implements IRootSummarizerNode {
 		this.wipSummarizeCalled = true;
 
 		// Try to reuse the tree if unchanged
-		if (this.canReuseHandle && !fullTree && !this.hasChanged()) {
-			if (this._lastSummaryReferenceSequenceNumber !== undefined) {
-				this.wipSkipRecursion = true;
-				const stats = mergeStats();
-				stats.handleNodeCount++;
-				return {
-					summary: {
-						type: SummaryType.Handle,
-						handle: this.summaryHandleId,
-						handleType: SummaryType.Tree,
-					},
-					stats,
-				};
-			}
+		if (
+			this.canReuseHandle &&
+			!fullTree &&
+			!this.hasChanged() &&
+			this._lastSummaryReferenceSequenceNumber !== undefined
+		) {
+			this.wipSkipRecursion = true;
+			const stats = mergeStats();
+			stats.handleNodeCount++;
+			return {
+				summary: {
+					type: SummaryType.Handle,
+					handle: this.summaryHandleId,
+					handleType: SummaryType.Tree,
+				},
+				stats,
+			};
 		}
 
 		let incrementalSummaryContext: IExperimentalIncrementalSummaryContext | undefined;
@@ -215,14 +224,14 @@ export class SummarizerNode implements IRootSummarizerNode {
 				0x5df /* Summarize should not be called when not tracking the summary */,
 			);
 			incrementalSummaryContext =
-				this._lastSummaryReferenceSequenceNumber !== undefined
-					? {
+				this._lastSummaryReferenceSequenceNumber === undefined
+					? undefined
+					: {
 							summarySequenceNumber: this.wipReferenceSequenceNumber,
 							latestSummarySequenceNumber: this._lastSummaryReferenceSequenceNumber,
 							// TODO: remove summaryPath.
 							summaryPath: this.summaryHandleId,
-						}
-					: undefined;
+						};
 		}
 
 		const result = await this.summarizeInternalFn(
@@ -317,7 +326,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * queue. We track this until we get an ack from the server for this summary.
 	 * @param proposalHandle - The handle of the summary that was uploaded to the server.
 	 */
-	public completeSummary(proposalHandle: string) {
+	public completeSummary(proposalHandle: string): void {
 		this.completeSummaryCore(proposalHandle, false /* parentSkipRecursion */);
 	}
 
@@ -329,22 +338,20 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * In that case, the children will not have work-in-progress state.
 	 * @param validate - true to validate that the in-progress summary is correct for all nodes.
 	 */
-	protected completeSummaryCore(proposalHandle: string, parentSkipRecursion: boolean) {
+	protected completeSummaryCore(proposalHandle: string, parentSkipRecursion: boolean): void {
 		assert(
 			this.wipReferenceSequenceNumber !== undefined,
 			0x1a4 /* "Not tracking a summary" */,
 		);
-		if (parentSkipRecursion) {
-			if (this._lastSummaryReferenceSequenceNumber === undefined) {
-				// This case the child is added after the latest non-failure summary.
-				// This node and all children should consider themselves as still not
-				// having a successful summary yet.
-				// We cannot "reuse" this node if unchanged since that summary, because
-				// handles will be unable to point to that node. It never made it to the
-				// tree itself, and only exists as an attach op in the _outstandingOps.
-				this.clearSummary();
-				return;
-			}
+		if (parentSkipRecursion && this._lastSummaryReferenceSequenceNumber === undefined) {
+			// This case the child is added after the latest non-failure summary.
+			// This node and all children should consider themselves as still not
+			// having a successful summary yet.
+			// We cannot "reuse" this node if unchanged since that summary, because
+			// handles will be unable to point to that node. It never made it to the
+			// tree itself, and only exists as an attach op in the _outstandingOps.
+			this.clearSummary();
+			return;
 		}
 
 		for (const child of this.children.values()) {
@@ -362,7 +369,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		this.clearSummary();
 	}
 
-	public clearSummary() {
+	public clearSummary(): void {
 		this.wipReferenceSequenceNumber = undefined;
 		this.wipSummarizeCalled = false;
 		this.wipSkipRecursion = false;
@@ -476,7 +483,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		}
 	}
 
-	public updateBaseSummaryState(snapshot: ISnapshotTree) {
+	public updateBaseSummaryState(snapshot: ISnapshotTree): void {
 		// Function deprecated. Empty declaration is kept around to compat failures.
 	}
 
@@ -502,9 +509,13 @@ export class SummarizerNode implements IRootSummarizerNode {
 	protected readonly canReuseHandle: boolean;
 
 	public createChild(
-		/** Summarize function */
+		/**
+		 * Summarize function
+		 */
 		summarizeInternalFn: SummarizeInternalFn,
-		/** Initial id or path part of this node */
+		/**
+		 * Initial id or path part of this node
+		 */
 		id: string,
 		/**
 		 * Information needed to create the node.
@@ -599,7 +610,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * @param id - Initial id or path part of this node
 	 *
 	 */
-	protected maybeUpdateChildState(child: SummarizerNode, id: string) {
+	protected maybeUpdateChildState(child: SummarizerNode, id: string): void {
 		// 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()) {
@@ -607,13 +618,13 @@ export class SummarizerNode implements IRootSummarizerNode {
 		}
 		// In case we have pending summaries on the parent, let's initialize it on the child.
 		if (child._lastSummaryReferenceSequenceNumber !== undefined) {
-			this.pendingSummaries.forEach((pendingSummaryInfo, proposedHandle) => {
+			for (const [proposedHandle, pendingSummaryInfo] of this.pendingSummaries.entries()) {
 				child.addPendingSummary(proposedHandle, pendingSummaryInfo);
-			});
+			}
 		}
 	}
 
-	protected addPendingSummary(key: string, pendingSummaryInfo: PendingSummaryInfo) {
+	protected addPendingSummary(key: string, pendingSummaryInfo: PendingSummaryInfo): void {
 		this.pendingSummaries.set(key, pendingSummaryInfo);
 	}
 

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -12,18 +12,28 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 
 export interface IRefreshSummaryResult {
-	/** Tells whether this summary is tracked by this client. */
+	/**
+	 * Tells whether this summary is tracked by this client.
+	 */
 	isSummaryTracked: boolean;
-	/** Tells whether this summary is newer than the latest one tracked by this client. */
+	/**
+	 * Tells whether this summary is newer than the latest one tracked by this client.
+	 */
 	isSummaryNewer: boolean;
 }
 
 export interface IStartSummaryResult {
-	/** The number of summarizerNodes at the start of the summary. */
+	/**
+	 * The number of summarizerNodes at the start of the summary.
+	 */
 	nodes: number;
-	/** The number of summarizerNodes in the wrong state. */
+	/**
+	 * The number of summarizerNodes in the wrong state.
+	 */
 	invalidNodes: number;
-	/** The invalid sequence numbers and their values. It should be in the format of validateSequenceNumber-nodeSequenceNumber */
+	/**
+	 * The invalid sequence numbers and their values. It should be in the format of validateSequenceNumber-nodeSequenceNumber
+	 */
 	mismatchNumbers: Set<string>;
 }
 
@@ -38,14 +48,20 @@ export type ValidateSummaryResult =
 	  }
 	| {
 			success: false;
-			/** The failure reason */
+			/**
+			 * The failure reason
+			 */
 			reason: string;
-			/** id of the node that failed during validation */
+			/**
+			 * id of the node that failed during validation
+			 */
 			id: {
 				tag: TelemetryDataTag.CodeArtifact;
 				value: string | undefined;
 			};
-			/** If the error can be retried, time to wait before retrying */
+			/**
+			 * If the error can be retried, time to wait before retrying
+			 */
 			retryAfterSeconds?: number;
 	  };
 
@@ -64,7 +80,9 @@ export interface ISummarizerNodeRootContract {
 	): Promise<IRefreshSummaryResult>;
 }
 
-/** Class to build paths for nodes in a tree with escaped special characters */
+/**
+ * Class to build paths for nodes in a tree with escaped special characters
+ */
 export class EscapedPath {
 	private constructor(public readonly path: string) {}
 
@@ -88,7 +106,9 @@ export class EscapedPath {
 	}
 }
 export interface PendingSummaryInfo {
-	/** The sequence number at which the summary was created. */
+	/**
+	 * The sequence number at which the summary was created.
+	 */
 	referenceSequenceNumber: number;
 }
 
@@ -96,19 +116,31 @@ export interface PendingSummaryInfo {
  * Represents the details needed to create a child summarizer node.
  */
 export interface ICreateChildDetails {
-	/** Sequence number of latest known change to the node */
+	/**
+	 * Sequence number of latest known change to the node
+	 */
 	changeSequenceNumber: number;
-	/** A unique id of this child to be logged when sending telemetry. */
+	/**
+	 * A unique id of this child to be logged when sending telemetry.
+	 */
 	telemetryNodeId: string;
-	/** Summary handle for child node */
+	/**
+	 * Summary handle for child node
+	 */
 	summaryHandleId: EscapedPath;
-	/** the reference sequence number of the last successful summary. */
+	/**
+	 * the reference sequence number of the last successful summary.
+	 */
 	lastSummaryReferenceSequenceNumber: number | undefined;
 }
 
 export interface ISubtreeInfo<T extends ISnapshotTree | SummaryObject> {
-	/** Tree to use to find children subtrees */
+	/**
+	 * Tree to use to find children subtrees
+	 */
 	childrenTree: T;
-	/** Additional path part where children are isolated */
+	/**
+	 * Additional path part where children are isolated
+	 */
 	childrenPathPart: string | undefined;
 }

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -51,7 +51,7 @@ interface PendingSummaryInfoWithGC extends PendingSummaryInfo {
  * - Manages the used routes of this node. These are used to identify if this node is referenced in the document
  * and to determine if the node's used state changed since last summary.
  *
- * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls
+ *- Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls
  * directly into summarizeInternal method.
  */
 export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {
@@ -95,12 +95,16 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		config: ISummarizerNodeConfigWithGC,
 		_summaryHandleId: EscapedPath,
 		changeSequenceNumber: number,
-		/** Summary reference sequence number, i.e. last sequence number seen when it was created */
+		/**
+		 * Summary reference sequence number, i.e. last sequence number seen when it was created
+		 */
 		lastSummaryReferenceSequenceNumber?: number,
 		wipSummaryLogger?: ITelemetryBaseLogger,
 		private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
 		getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,
-		/** A unique id of this node to be logged when sending telemetry. */
+		/**
+		 * A unique id of this node to be logged when sending telemetry.
+		 */
 		telemetryId?: string,
 	) {
 		super(
@@ -132,7 +136,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	 * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.
 	 * - gcData: The garbage collection data of this node that is required for running GC.
 	 */
-	private async loadBaseGCDetails() {
+	private async loadBaseGCDetails(): Promise<void> {
 		if (this.baseGCDetailsLoaded) {
 			return;
 		}
@@ -152,8 +156,8 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 			this.gcData = cloneGCData(baseGCDetails.gcData);
 		}
 		if (baseGCDetails.usedRoutes !== undefined) {
-			this.usedRoutes = Array.from(baseGCDetails.usedRoutes).sort();
-			this.referenceUsedRoutes = Array.from(baseGCDetails.usedRoutes).sort();
+			this.usedRoutes = [...baseGCDetails.usedRoutes].sort();
+			this.referenceUsedRoutes = [...baseGCDetails.usedRoutes].sort();
 		}
 	}
 
@@ -263,7 +267,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	 * @param parentSkipRecursion - true if the parent of this node skipped recursing the child nodes when summarizing.
 	 * In that case, the children will not have work-in-progress state.
 	 */
-	protected completeSummaryCore(proposalHandle: string, parentSkipRecursion: boolean) {
+	protected completeSummaryCore(proposalHandle: string, parentSkipRecursion: boolean): void {
 		let wipSerializedUsedRoutes: string | undefined;
 		// If GC is disabled, don't set wip used routes.
 		if (!this.gcDisabled) {
@@ -288,7 +292,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	/**
 	 * Clears the work-in-progress state.
 	 */
-	public clearSummary() {
+	public clearSummary(): void {
 		this.wipSerializedUsedRoutes = undefined;
 		this.wipChildNodesUsedRoutes = undefined;
 		super.clearSummary();
@@ -324,7 +328,9 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 					);
 					throw error;
 				}
-				this.referenceUsedRoutes = JSON.parse(summaryNodeWithGC.serializedUsedRoutes);
+				this.referenceUsedRoutes = JSON.parse(
+					summaryNodeWithGC.serializedUsedRoutes,
+				) as string[];
 			}
 		}
 
@@ -335,9 +341,13 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	 * Override the createChild method to return an instance of SummarizerNodeWithGC.
 	 */
 	public createChild(
-		/** Summarize function */
+		/**
+		 * Summarize function
+		 */
 		summarizeInternalFn: SummarizeInternalFn,
-		/** Initial id or path part of this node */
+		/**
+		 * Initial id or path part of this node
+		 */
 		id: string,
 		/**
 		 * Information needed to create the node.
@@ -355,7 +365,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		 * 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 getChildBaseGCDetailsFn = async () => {
+		const getChildBaseGCDetailsFn = async (): Promise<IGarbageCollectionDetailsBase> => {
 			const childNodesBaseGCDetails = await this.childNodesBaseGCDetailsP;
 			return childNodesBaseGCDetails.get(id) ?? {};
 		};
@@ -395,7 +405,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	 * @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) {
+	protected maybeUpdateChildState(child: SummarizerNodeWithGC, id: string): void {
 		super.maybeUpdateChildState(child, id);
 
 		// If GC has run on this node and summarization isn't complete, this.wipSerializedUsedRoutes will be defined.
@@ -417,7 +427,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 			const pendingSummaryWithGC = pendingSummary as PendingSummaryInfoWithGC;
 			if (pendingSummaryWithGC.serializedUsedRoutes !== undefined) {
 				const childNodeUsedRoutes = unpackChildNodesUsedRoutes(
-					JSON.parse(pendingSummaryWithGC.serializedUsedRoutes),
+					JSON.parse(pendingSummaryWithGC.serializedUsedRoutes) as string[],
 				);
 				const newSerializedRoutes = childNodeUsedRoutes.get(id) ?? [""];
 				const childPendingSummaryInfo = {
@@ -447,7 +457,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		return this.usedRoutes.includes("") || this.usedRoutes.includes("/");
 	}
 
-	public updateUsedRoutes(usedRoutes: string[]) {
+	public updateUsedRoutes(usedRoutes: string[]): void {
 		// Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()
 		// are in the same order.
 		this.usedRoutes = usedRoutes.sort();