@fluidframework/container-runtime 2.4.0-294316 → 2.4.0-297385

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -64,104 +64,46 @@ export interface ISummarizerNodeRootContract {
 	): Promise<IRefreshSummaryResult>;
 }
 
-/** Path 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) {}
+
+	/**
+	 * Creates and returns a new instance of this class.
+	 * @param path - Id or path part of a node
+	 */
 	public static create(path: string): EscapedPath {
 		return new EscapedPath(encodeURIComponent(path));
 	}
-	public static createAndConcat(pathParts: string[]): EscapedPath {
-		let ret = EscapedPath.create(pathParts[0] ?? "");
-		for (let i = 1; i < pathParts.length; i++) {
-			ret = ret.concat(EscapedPath.create(pathParts[i]));
-		}
-		return ret;
-	}
 	public toString(): string {
 		return this.path;
 	}
-	public concat(path: EscapedPath): EscapedPath {
-		return new EscapedPath(`${this.path}/${path.path}`);
-	}
-}
-
-/** Information about a summary relevant to a specific node in the tree */
-export class SummaryNode {
-	/** Creates an instance that is valid for the root with specific basePath and localPath */
-	public static createForRoot(referenceSequenceNumber: number): SummaryNode {
-		return new SummaryNode({
-			referenceSequenceNumber,
-			basePath: undefined,
-			localPath: EscapedPath.create(""), // root hard-coded to ""
-		});
-	}
-
-	/** Summary reference sequence number, i.e. last sequence number seen when it was created */
-	public get referenceSequenceNumber(): number {
-		return this.summary.referenceSequenceNumber;
-	}
-	/** Full path to parent node, or undefined if this is the root */
-	public get basePath(): EscapedPath | undefined {
-		return this.summary.basePath;
-	}
-	/** Relative path to this node from its parent node */
-	public get localPath(): EscapedPath {
-		return this.summary.localPath;
-	}
-	/** Relative path from this node to its node innermost base summary */
-	public get additionalPath(): EscapedPath | undefined {
-		return this.summary.additionalPath;
-	}
-	public set additionalPath(additionalPath: EscapedPath | undefined) {
-		this.summary.additionalPath = additionalPath;
-	}
-	constructor(
-		private readonly summary: {
-			readonly referenceSequenceNumber: number;
-			readonly basePath: EscapedPath | undefined;
-			readonly localPath: EscapedPath;
-			additionalPath?: EscapedPath;
-		},
-	) {}
-
-	/** Gets the full path to this node, to be used when sending a handle */
-	public get fullPath(): EscapedPath {
-		return this.basePath?.concat(this.localPath) ?? this.localPath;
-	}
-
-	/**
-	 * Gets the full path to this node's innermost base summary.
-	 * The children nodes can use this as their basePath to determine their path.
-	 */
-	public get fullPathForChildren(): EscapedPath {
-		return this.additionalPath !== undefined
-			? this.fullPath.concat(this.additionalPath)
-			: this.fullPath;
-	}
-
 	/**
-	 * Creates a new node within the same summary for a child of this node.
-	 * @param id - id of the child node
+	 * Creates and returns a new instance of this class for child of the current node.
 	 */
-	public createForChild(id: string): SummaryNode {
-		return new SummaryNode({
-			referenceSequenceNumber: this.referenceSequenceNumber,
-			basePath: this.fullPathForChildren,
-			localPath: EscapedPath.create(id),
-		});
+	public createChildPath(childNodePath: EscapedPath): EscapedPath {
+		return new EscapedPath(
+			`${this.path}/${encodeURIComponent(channelsTreeName)}/${childNodePath.path}`,
+		);
 	}
 }
+export interface PendingSummaryInfo {
+	/** The sequence number at which the summary was created. */
+	referenceSequenceNumber: number;
+}
 
 /**
  * Represents the details needed to create a child summarizer node.
  */
 export interface ICreateChildDetails {
-	/** Latest summary from server node data */
-	latestSummary: SummaryNode | undefined;
 	/** Sequence number of latest known change to the node */
 	changeSequenceNumber: number;
 	/** A unique id of this child to be logged when sending telemetry. */
 	telemetryNodeId: string;
+	/** Summary handle for child node */
+	summaryHandleId: EscapedPath;
+	/** the reference sequence number of the last successful summary. */
+	lastSummaryReferenceSequenceNumber: number | undefined;
 }
 
 export interface ISubtreeInfo<T extends ISnapshotTree | SummaryObject> {
@@ -170,25 +112,3 @@ export interface ISubtreeInfo<T extends ISnapshotTree | SummaryObject> {
 	/** Additional path part where children are isolated */
 	childrenPathPart: string | undefined;
 }
-
-/**
- * Checks if the summary contains .channels subtree where the children subtrees
- * would be located if exists.
- * @param baseSummary - summary to check
- */
-export function parseSummaryForSubtrees(
-	baseSummary: ISnapshotTree,
-): ISubtreeInfo<ISnapshotTree> {
-	// New versions of snapshots have child nodes isolated in .channels subtree
-	const channelsSubtree = baseSummary.trees[channelsTreeName];
-	if (channelsSubtree !== undefined) {
-		return {
-			childrenTree: channelsSubtree,
-			childrenPathPart: channelsTreeName,
-		};
-	}
-	return {
-		childrenTree: baseSummary,
-		childrenPathPart: undefined,
-	};
-}

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -28,7 +28,7 @@ import {
 	ICreateChildDetails,
 	IStartSummaryResult,
 	ISummarizerNodeRootContract,
-	SummaryNode,
+	PendingSummaryInfo,
 	ValidateSummaryResult,
 } from "./summarizerNodeUtils.js";
 
@@ -36,19 +36,9 @@ export interface IRootSummarizerNodeWithGC
 	extends ISummarizerNodeWithGC,
 		ISummarizerNodeRootContract {}
 
-// Extend SummaryNode to add used routes tracking to it.
-class SummaryNodeWithGC extends SummaryNode {
-	constructor(
-		public readonly serializedUsedRoutes: string | undefined,
-		summary: {
-			readonly referenceSequenceNumber: number;
-			readonly basePath: EscapedPath | undefined;
-			readonly localPath: EscapedPath;
-			additionalPath?: EscapedPath;
-		},
-	) {
-		super(summary);
-	}
+// Extend PendingSummaryInfo to add used routes tracking it.
+interface PendingSummaryInfoWithGC extends PendingSummaryInfo {
+	serializedUsedRoutes: string | undefined;
 }
 
 /**
@@ -103,9 +93,10 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		logger: ITelemetryBaseLogger,
 		summarizeInternalFn: SummarizeInternalFn,
 		config: ISummarizerNodeConfigWithGC,
+		_summaryHandleId: EscapedPath,
 		changeSequenceNumber: number,
-		/** Undefined means created without summary */
-		latestSummary?: SummaryNode,
+		/** 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>,
@@ -116,8 +107,9 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 			logger,
 			summarizeInternalFn,
 			config,
+			_summaryHandleId,
 			changeSequenceNumber,
-			latestSummary,
+			lastSummaryReferenceSequenceNumber,
 			wipSummaryLogger,
 			telemetryId,
 		);
@@ -268,29 +260,27 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	 * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending
 	 * summary 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.
-	 * @param parentPath - The path of the parent node which is used to build the path of this node.
 	 * @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,
-		parentPath: EscapedPath | undefined,
-		parentSkipRecursion: boolean,
-	) {
+	protected completeSummaryCore(proposalHandle: string, parentSkipRecursion: boolean) {
 		let wipSerializedUsedRoutes: string | undefined;
 		// If GC is disabled, don't set wip used routes.
 		if (!this.gcDisabled) {
 			wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;
 		}
 
-		super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);
+		super.completeSummaryCore(proposalHandle, parentSkipRecursion);
 
 		// If GC is disabled, skip setting pending summary with GC state.
 		if (!this.gcDisabled) {
-			const summaryNode = this.pendingSummaries.get(proposalHandle);
-			if (summaryNode !== undefined) {
-				const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes, summaryNode);
-				this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);
+			const pendingSummaryInfo = this.pendingSummaries.get(proposalHandle);
+			if (pendingSummaryInfo !== undefined) {
+				const pendingSummaryInfoWithGC = {
+					serializedUsedRoutes: wipSerializedUsedRoutes,
+					...pendingSummaryInfo,
+				};
+				this.pendingSummaries.set(proposalHandle, pendingSummaryInfoWithGC);
 			}
 		}
 	}
@@ -314,10 +304,10 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 	): 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);
-			if (summaryNode !== undefined) {
+			const pendingSummaryInfo = this.pendingSummaries.get(proposalHandle);
+			if (pendingSummaryInfo !== undefined) {
 				// If a pending summary exists, it must have used routes since GC is enabled.
-				const summaryNodeWithGC = summaryNode as SummaryNodeWithGC;
+				const summaryNodeWithGC = pendingSummaryInfo as PendingSummaryInfoWithGC;
 				if (summaryNodeWithGC.serializedUsedRoutes === undefined) {
 					const error = new LoggingError("MissingGCStateInPendingSummary", {
 						proposalHandle,
@@ -379,8 +369,9 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 				// Propagate our gcDisabled state to the child if its not explicity specified in child's config.
 				gcDisabled: config.gcDisabled ?? this.gcDisabled,
 			},
+			createDetails.summaryHandleId,
 			createDetails.changeSequenceNumber,
-			createDetails.latestSummary,
+			createDetails.lastSummaryReferenceSequenceNumber,
 			this.wipSummaryLogger,
 			getGCDataFn,
 			getChildBaseGCDetailsFn,
@@ -422,24 +413,18 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		}
 
 		// 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: child.latestSummary.basePath,
-							localPath: child.latestSummary.localPath,
-						},
-					);
-					child.addPendingSummary(key, newLatestSummaryNode);
-				}
+		for (const [key, pendingSummary] of this.pendingSummaries.entries()) {
+			const pendingSummaryWithGC = pendingSummary as PendingSummaryInfoWithGC;
+			if (pendingSummaryWithGC.serializedUsedRoutes !== undefined) {
+				const childNodeUsedRoutes = unpackChildNodesUsedRoutes(
+					JSON.parse(pendingSummaryWithGC.serializedUsedRoutes),
+				);
+				const newSerializedRoutes = childNodeUsedRoutes.get(id) ?? [""];
+				const childPendingSummaryInfo = {
+					...pendingSummaryWithGC,
+					serializedUsedRoutes: JSON.stringify(newSerializedRoutes),
+				};
+				child.addPendingSummary(key, childPendingSummaryInfo);
 			}
 		}
 	}
@@ -530,10 +515,9 @@ export const createRootSummarizerNodeWithGC = (
 		logger,
 		summarizeInternalFn,
 		config,
+		EscapedPath.create("") /* summaryHandleId */,
 		changeSequenceNumber,
-		referenceSequenceNumber === undefined
-			? undefined
-			: SummaryNode.createForRoot(referenceSequenceNumber),
+		referenceSequenceNumber,
 		undefined /* wipSummaryLogger */,
 		getGCDataFn,
 		getBaseGCDetailsFn,