@fluidframework/container-runtime 2.20.0 → 2.21.0

package/src/summary/summarizerNode/summarizerNode.ts

@@ -198,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;
@@ -221,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(
@@ -340,17 +343,15 @@ export class SummarizerNode implements IRootSummarizerNode {
 			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()) {
@@ -617,9 +618,9 @@ 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);
-			});
+			}
 		}
 	}
 

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 {
@@ -156,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();
 		}
 	}
 
@@ -427,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 = {

package/src/summary/summarizerTypes.ts

@@ -41,6 +41,7 @@ import { SummarizeReason } from "./summaryGenerator.js";
  * @param T - cancellation reason type
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface ICancellationToken<T> {
 	/**
@@ -58,6 +59,7 @@ export interface ICancellationToken<T> {
  * Similar to AbortSignal, but using promise instead of events
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
@@ -65,6 +67,7 @@ export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>
  * Data required to update internal tracking state after receiving a Summary Ack.
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface IRefreshSummaryAckOptions {
 	/**
@@ -88,6 +91,7 @@ export interface IRefreshSummaryAckOptions {
 /**
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface ISummarizerInternalsProvider {
 	/**
@@ -112,6 +116,7 @@ export interface ISummarizingWarning extends ContainerWarning {
 /**
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface IConnectableRuntime {
 	readonly disposed: boolean;
@@ -123,6 +128,7 @@ export interface IConnectableRuntime {
 /**
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface ISummarizerRuntime extends IConnectableRuntime {
 	readonly baseLogger: ITelemetryBaseLogger;
@@ -158,6 +164,7 @@ export interface ISummarizeOptions {
 /**
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface ISubmitSummaryOptions extends ISummarizeOptions {
 	/**

package/src/summary/summaryCollection.ts

@@ -5,7 +5,11 @@
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IDeltaManager } from "@fluidframework/container-definitions/internal";
-import { IDisposable, IEvent } from "@fluidframework/core-interfaces";
+import {
+	IDisposable,
+	IEvent,
+	type ITelemetryBaseLogger,
+} from "@fluidframework/core-interfaces";
 import { assert, Deferred } from "@fluidframework/core-utils/internal";
 import {
 	IDocumentMessage,
@@ -15,7 +19,10 @@ import {
 	MessageType,
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+import {
+	createChildLogger,
+	ITelemetryLoggerExt,
+} from "@fluidframework/telemetry-utils/internal";
 
 /**
  * Interface for summary op messages with typed contents.
@@ -284,12 +291,14 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		this.deltaManager.off("op", listener);
 	}
 
+	private readonly logger: ITelemetryLoggerExt;
 	public constructor(
 		private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
-		private readonly logger: ITelemetryLoggerExt,
+		logger: ITelemetryBaseLogger,
 	) {
 		super();
 		this.deltaManager.on("op", (op) => this.handleOp(op));
+		this.logger = createChildLogger({ logger });
 	}
 
 	/**
@@ -369,20 +378,22 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		const op = { ...opArg };
 
 		switch (op.type) {
-			case MessageType.Summarize:
+			case MessageType.Summarize: {
 				this.parseContent(op);
 				return this.handleSummaryOp(op as ISummaryOpMessage);
+			}
 			case MessageType.SummaryAck:
-			case MessageType.SummaryNack:
+			case MessageType.SummaryNack: {
 				// Old files (prior to PR #10077) may not contain this info
-				if (op.data !== undefined) {
-					op.contents = JSON.parse(op.data);
-				} else {
+				if (op.data === undefined) {
 					this.parseContent(op);
+				} else {
+					op.contents = JSON.parse(op.data);
 				}
 				return op.type === MessageType.SummaryAck
 					? this.handleSummaryAck(op as ISummaryAckMessage)
 					: this.handleSummaryNack(op as ISummaryNackMessage);
+			}
 			default: {
 				// If the difference between timestamp of current op and last summary op is greater than
 				// the maxAckWaitTime, then we need to inform summarizer to not wait and summarize

package/src/summary/summaryFormat.ts

@@ -10,10 +10,7 @@ import {
 	ISnapshotTree,
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
-import {
-	blobHeadersBlobName as blobNameForBlobHeaders,
-	readAndParse,
-} from "@fluidframework/driver-utils/internal";
+import { readAndParse } from "@fluidframework/driver-utils/internal";
 import {
 	ISummaryTreeWithStats,
 	channelsTreeName,
@@ -21,8 +18,10 @@ import {
 } from "@fluidframework/runtime-definitions/internal";
 
 import { blobsTreeName } from "../blobManager/index.js";
+// eslint-disable-next-line import/no-deprecated
 import { IGCMetadata } from "../gc/index.js";
 
+// eslint-disable-next-line import/no-deprecated
 import { IDocumentSchema } from "./documentSchema.js";
 
 /**
@@ -130,7 +129,9 @@ export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): b
 /**
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
+// eslint-disable-next-line import/no-deprecated
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
 	readonly summaryFormatVersion: 1;
 	/**
@@ -154,12 +155,14 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
 	 */
 	readonly telemetryDocumentId?: string;
 
+	// eslint-disable-next-line import/no-deprecated
 	readonly documentSchema?: IDocumentSchema;
 }
 
 /**
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface ICreateContainerMetadata {
 	/**
@@ -176,6 +179,7 @@ export interface ICreateContainerMetadata {
  * The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary.
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export type ISummaryMetadataMessage = Pick<
 	ISequencedDocumentMessage,
@@ -227,7 +231,6 @@ export const chunksBlobName = ".chunks";
 export const recentBatchInfoBlobName = ".recentBatchInfo";
 export const electedSummarizerBlobName = ".electedSummarizer";
 export const idCompressorBlobName = ".idCompressor";
-export const blobHeadersBlobName = blobNameForBlobHeaders;
 
 export function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {
 	return !!metadata && !metadata.disableIsolatedChannels;
@@ -308,3 +311,5 @@ export async function getFluidDataStoreAttributes(
 	assert(formatVersion > 0, 0x1d5 /* Invalid snapshot format version */);
 	return attributes;
 }
+
+export { blobHeadersBlobName } from "@fluidframework/driver-utils/internal";

package/src/summary/summaryGenerator.ts

@@ -25,10 +25,13 @@ import {
 	IAckSummaryResult,
 	IBroadcastSummaryResult,
 	INackSummaryResult,
+	// eslint-disable-next-line import/no-deprecated
 	IRefreshSummaryAckOptions,
+	// eslint-disable-next-line import/no-deprecated
 	ISubmitSummaryOptions,
 	ISummarizeHeuristicData,
 	ISummarizeResults,
+	// eslint-disable-next-line import/no-deprecated
 	ISummaryCancellationToken,
 	SubmitSummaryFailureData,
 	SubmitSummaryResult,
@@ -49,6 +52,7 @@ export type raceTimerResult<T> =
 export async function raceTimer<T>(
 	promise: Promise<T>,
 	timer: Promise<IPromiseTimerResult>,
+	// eslint-disable-next-line import/no-deprecated
 	cancellationToken?: ISummaryCancellationToken,
 ): Promise<raceTimerResult<T>> {
 	const promises: Promise<raceTimerResult<T>>[] = [
@@ -211,10 +215,12 @@ export class SummaryGenerator {
 		private readonly pendingAckTimer: IPromiseTimer,
 		private readonly heuristicData: ISummarizeHeuristicData,
 		private readonly submitSummaryCallback: (
+			// eslint-disable-next-line import/no-deprecated
 			options: ISubmitSummaryOptions,
 		) => Promise<SubmitSummaryResult>,
 		private readonly successfulSummaryCallback: () => void,
 		private readonly refreshLatestSummaryCallback: (
+			// eslint-disable-next-line import/no-deprecated
 			options: IRefreshSummaryAckOptions,
 		) => Promise<void>,
 		private readonly summaryWatcher: Pick<IClientSummaryWatcher, "watchSummary">,
@@ -232,19 +238,23 @@ export class SummaryGenerator {
 	 * @param resultsBuilder - optional, result builder to use to build pass or fail result.
 	 */
 	public summarize(
+		// eslint-disable-next-line import/no-deprecated
 		summaryOptions: ISubmitSummaryOptions,
 		resultsBuilder = new SummarizeResultBuilder(),
 	): ISummarizeResults {
-		this.summarizeCore(summaryOptions, resultsBuilder).catch((error) => {
-			const message = "UnexpectedSummarizeError";
-			summaryOptions.summaryLogger.sendErrorEvent({ eventName: message }, error);
-			resultsBuilder.fail(message, error);
-		});
+		this.summarizeCore(summaryOptions, resultsBuilder).catch(
+			(error: IRetriableFailureError) => {
+				const message = "UnexpectedSummarizeError";
+				summaryOptions.summaryLogger.sendErrorEvent({ eventName: message }, error);
+				resultsBuilder.fail(message, error);
+			},
+		);
 
 		return resultsBuilder.build();
 	}
 
 	private async summarizeCore(
+		// eslint-disable-next-line import/no-deprecated
 		submitSummaryOptions: ISubmitSummaryOptions,
 		resultsBuilder: SummarizeResultBuilder,
 	): Promise<void> {
@@ -521,17 +531,19 @@ export class SummaryGenerator {
 		initialProps: SummaryGeneratorTelemetry,
 	): SummaryGeneratorTelemetry {
 		switch (summaryData.stage) {
-			case "base":
+			case "base": {
 				return initialProps;
+			}
 
-			case "generate":
+			case "generate": {
 				return {
 					...initialProps,
 					...summaryData.summaryStats,
 					generateDuration: summaryData.generateDuration,
 				};
+			}
 
-			case "upload":
+			case "upload": {
 				return {
 					...initialProps,
 					...summaryData.summaryStats,
@@ -539,8 +551,9 @@ export class SummaryGenerator {
 					handle: summaryData.handle,
 					uploadDuration: summaryData.uploadDuration,
 				};
+			}
 
-			case "submit":
+			case "submit": {
 				return {
 					...initialProps,
 					...summaryData.summaryStats,
@@ -553,9 +566,11 @@ export class SummaryGenerator {
 					nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps,
 					runtimeOpsSinceLastSummary: this.heuristicData.numRuntimeOps,
 				};
+			}
 
-			default:
+			default: {
 				assert(true, 0x397 /* Unexpected summary stage */);
+			}
 		}
 
 		return initialProps;

package/src/summary/summaryManager.ts

@@ -24,6 +24,7 @@ import {
 
 import { IThrottler } from "../throttler.js";
 
+// eslint-disable-next-line import/no-deprecated
 import { Summarizer } from "./summarizer.js";
 import { ISummarizerClientElection } from "./summarizerClientElection.js";
 import {
@@ -284,6 +285,7 @@ export class SummaryManager
 					// which would happen when we have a high enough number of unsummarized ops.
 					if (
 						startWithInitialDelay ||
+						// eslint-disable-next-line import/no-deprecated
 						!Summarizer.stopReasonCanRunLastSummary(shouldSummarizeState.stopReason)
 					) {
 						this.state = SummaryManagerState.Starting;
@@ -406,7 +408,7 @@ export class SummaryManager
 		}
 
 		if (delayMs > 0) {
-			let timer;
+			let timer: number | undefined;
 			let resolveOpPromiseFn: (value: void | PromiseLike<void>) => void;
 			// Create a listener that will break the delay if we've exceeded the initial delay ops count.
 			const opsListenerFn = (): void => {
@@ -432,7 +434,7 @@ export class SummaryManager
 
 	public summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults {
 		if (this.summarizer === undefined) {
-			throw Error("No running summarizer client");
+			throw new Error("No running summarizer client");
 			// TODO: could spawn a summarizer client temporarily.
 		}
 		return this.summarizer.summarizeOnDemand(options);
@@ -440,7 +442,7 @@ export class SummaryManager
 
 	public enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult {
 		if (this.summarizer === undefined) {
-			throw Error("No running summarizer client");
+			throw new Error("No running summarizer client");
 			// TODO: could spawn a summarizer client temporarily.
 		}
 		return this.summarizer.enqueueSummarize(options);
@@ -457,28 +459,28 @@ export class SummaryManager
 	private readonly forwardedEvents = new Map<string, () => void>();
 
 	private setupForwardedEvents(): void {
-		[
+		for (const event of [
 			"summarize",
 			"summarizeAllAttemptsFailed",
 			"summarizerStop",
 			"summarizerStart",
 			"summarizerStartupFailed",
-		].forEach((event) => {
-			const listener = (...args: any[]): void => {
+		]) {
+			const listener = (...args: unknown[]): void => {
 				this.emit(event, ...args);
 			};
 			// TODO: better typing here
-			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
 			this.summarizer?.on(event as any, listener);
 			this.forwardedEvents.set(event, listener);
-		});
+		}
 	}
 
 	private cleanupForwardedEvents(): void {
-		this.forwardedEvents.forEach((listener, event) =>
-			// eslint-disable-next-line @typescript-eslint/no-explicit-any
-			this.summarizer?.off(event as any, listener),
-		);
+		for (const [event, listener] of this.forwardedEvents.entries()) {
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
+			this.summarizer?.off(event as any, listener);
+		}
 		this.forwardedEvents.clear();
 	}
 }