@fluidframework/container-runtime 2.13.0 → 2.21.0

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.
@@ -78,10 +85,10 @@ enum SummaryState {
 }
 
 class Summary implements ISummary {
-	public static createLocal(clientId: string, clientSequenceNumber: number) {
+	public static createLocal(clientId: string, clientSequenceNumber: number): Summary {
 		return new Summary(clientId, clientSequenceNumber);
 	}
-	public static createFromOp(op: ISummaryOpMessage) {
+	public static createFromOp(op: ISummaryOpMessage): Summary {
 		// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)
 
 		const summary = new Summary(op.clientId as string, op.clientSequenceNumber);
@@ -97,10 +104,10 @@ class Summary implements ISummary {
 	private readonly defSummaryOp = new Deferred<void>();
 	private readonly defSummaryAck = new Deferred<void>();
 
-	public get summaryOp() {
+	public get summaryOp(): ISummaryOpMessage | undefined {
 		return this._summaryOp;
 	}
-	public get summaryAckNack() {
+	public get summaryAckNack(): ISummaryAckMessage | ISummaryNackMessage | undefined {
 		return this._summaryAckNack;
 	}
 
@@ -113,7 +120,7 @@ class Summary implements ISummary {
 		return this.state === SummaryState.Acked;
 	}
 
-	public broadcast(op: ISummaryOpMessage) {
+	public broadcast(op: ISummaryOpMessage): boolean {
 		assert(
 			this.state === SummaryState.Local,
 			0x175 /* "Can only broadcast if summarizer starts in local state" */,
@@ -124,7 +131,7 @@ class Summary implements ISummary {
 		return true;
 	}
 
-	public ackNack(op: ISummaryAckMessage | ISummaryNackMessage) {
+	public ackNack(op: ISummaryAckMessage | ISummaryNackMessage): boolean {
 		assert(
 			this.state === SummaryState.Broadcast,
 			0x176 /* "Can only ack/nack if summarizer is in broadcasting state" */,
@@ -167,7 +174,7 @@ class ClientSummaryWatcher implements IClientSummaryWatcher {
 	private readonly localSummaries = new Map<number, Summary>();
 	private _disposed = false;
 
-	public get disposed() {
+	public get disposed(): boolean {
 		return this._disposed;
 	}
 
@@ -193,8 +200,7 @@ class ClientSummaryWatcher implements IClientSummaryWatcher {
 	 * Waits until all of the pending summaries in the underlying SummaryCollection
 	 * are acked/nacked.
 	 */
-	// eslint-disable-next-line @typescript-eslint/promise-function-async
-	public waitFlushed() {
+	public async waitFlushed(): Promise<IAckedSummary | undefined> {
 		return this.summaryCollection.waitFlushed();
 	}
 
@@ -202,7 +208,7 @@ class ClientSummaryWatcher implements IClientSummaryWatcher {
 	 * Gets a watched summary or returns undefined if not watched.
 	 * @param clientSequenceNumber - client sequence number of sent summary op
 	 */
-	public tryGetSummary(clientSequenceNumber: number) {
+	public tryGetSummary(clientSequenceNumber: number): Summary | undefined {
 		return this.localSummaries.get(clientSequenceNumber);
 	}
 
@@ -210,11 +216,11 @@ class ClientSummaryWatcher implements IClientSummaryWatcher {
 	 * Starts watching a summary made by this client.
 	 * @param summary - summary to start watching
 	 */
-	public setSummary(summary: Summary) {
+	public setSummary(summary: Summary): void {
 		this.localSummaries.set(summary.clientSequenceNumber, summary);
 	}
 
-	public dispose() {
+	public dispose(): void {
 		this.summaryCollection.removeWatcher(this.clientId);
 		this._disposed = true;
 	}
@@ -270,27 +276,29 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		return super.emit(event, ...args);
 	}
 
-	public get opsSinceLastAck() {
+	public get opsSinceLastAck(): number {
 		return (
 			this.deltaManager.lastSequenceNumber -
 			(this.lastAck?.summaryAck.sequenceNumber ?? this.deltaManager.initialSequenceNumber)
 		);
 	}
 
-	public addOpListener(listener: () => void) {
+	public addOpListener(listener: () => void): void {
 		this.deltaManager.on("op", listener);
 	}
 
-	public removeOpListener(listener: () => void) {
+	public removeOpListener(listener: () => void): void {
 		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 });
 	}
 
 	/**
@@ -304,19 +312,19 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		return watcher;
 	}
 
-	public removeWatcher(clientId: string) {
+	public removeWatcher(clientId: string): void {
 		this.summaryWatchers.delete(clientId);
 	}
 
 	public setPendingAckTimerTimeoutCallback(
 		maxAckWaitTime: number,
 		timeoutCallback: () => void,
-	) {
+	): void {
 		this.maxAckWaitTime = maxAckWaitTime;
 		this.pendingAckTimerTimeoutCallback = timeoutCallback;
 	}
 
-	public unsetPendingAckTimerTimeoutCallback() {
+	public unsetPendingAckTimerTimeoutCallback(): void {
 		this.maxAckWaitTime = undefined;
 		this.pendingAckTimerTimeoutCallback = undefined;
 	}
@@ -352,7 +360,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		return this.lastAck;
 	}
 
-	private parseContent(op: ISequencedDocumentMessage) {
+	private parseContent(op: ISequencedDocumentMessage): void {
 		// This should become unconditional once (Loader LTS) reaches 2.4 or later
 		// There will be a long time of needing both cases, until LTS catches up to the change.
 		// That said, we may instead move to listen for "op" events from ContainerRuntime,
@@ -366,24 +374,26 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 	 * Handler for ops; only handles ops relating to summaries.
 	 * @param op - op message to handle
 	 */
-	private handleOp(opArg: ISequencedDocumentMessage) {
+	private handleOp(opArg: ISequencedDocumentMessage): void {
 		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
@@ -403,7 +413,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		}
 	}
 
-	private handleSummaryOp(op: ISummaryOpMessage) {
+	private handleSummaryOp(op: ISummaryOpMessage): void {
 		let summary: Summary | undefined;
 
 		// Check if summary already being watched, broadcast if so
@@ -429,7 +439,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		this.emit(MessageType.Summarize, op);
 	}
 
-	private handleSummaryAck(op: ISummaryAckMessage) {
+	private handleSummaryAck(op: ISummaryAckMessage): void {
 		const seq = op.contents.summaryProposal.summarySequenceNumber;
 		const summary = this.pendingSummaries.get(seq);
 		// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- optional chain is not logically equivalent
@@ -472,7 +482,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
 		}
 	}
 
-	private handleSummaryNack(op: ISummaryNackMessage) {
+	private handleSummaryNack(op: ISummaryNackMessage): void {
 		const seq = op.contents.summaryProposal.summarySequenceNumber;
 		const summary = this.pendingSummaries.get(seq);
 		if (summary) {

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";
 
 /**
@@ -70,7 +69,9 @@ export interface IFluidDataStoreAttributes1
  */
 export interface IFluidDataStoreAttributes2
 	extends OmitAttributesVersions<IFluidDataStoreAttributes1> {
-	/** Switch from snapshotFormatVersion to summaryFormatVersion */
+	/**
+	 * Switch from snapshotFormatVersion to summaryFormatVersion
+	 */
 	readonly snapshotFormatVersion?: undefined;
 	readonly summaryFormatVersion: 2;
 	/**
@@ -128,31 +129,49 @@ 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;
-	/** @deprecated - used by old (prior to 2.0 RC3) runtimes */
+	/**
+	 * @deprecated - used by old (prior to 2.0 RC3) runtimes
+	 */
 	readonly message?: ISummaryMetadataMessage;
-	/** The last message processed at the time of summary. Only primitive property types are added to the summary. */
+	/**
+	 * The last message processed at the time of summary. Only primitive property types are added to the summary.
+	 */
 	readonly lastMessage?: ISummaryMetadataMessage;
-	/** True if channels are not isolated in .channels subtrees, otherwise isolated. */
+	/**
+	 * True if channels are not isolated in .channels subtrees, otherwise isolated.
+	 */
 	readonly disableIsolatedChannels?: true;
-	/** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */
+	/**
+	 * The summary number for a container's summary. Incremented on summaries throughout its lifetime.
+	 */
 	readonly summaryNumber?: number;
-	/** GUID to identify a document in telemetry */
+	/**
+	 * GUID to identify a document in telemetry
+	 */
 	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 {
-	/** Runtime version of the container when it was first created */
+	/**
+	 * Runtime version of the container when it was first created
+	 */
 	createContainerRuntimeVersion?: string;
-	/** Timestamp of the container when it was first created */
+	/**
+	 * Timestamp of the container when it was first created
+	 */
 	createContainerTimestamp?: number;
 }
 
@@ -160,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,
@@ -211,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;
@@ -292,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,
@@ -43,10 +46,13 @@ export type raceTimerResult<T> =
 	| { result: IPromiseTimerResult["timerResult"] }
 	| { result: "cancelled" };
 
-/** Helper function to wait for a promise or PromiseTimer to elapse. */
+/**
+ * Wait for a promise or PromiseTimer to elapse.
+ */
 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>>[] = [
@@ -95,9 +101,13 @@ export type SummarizeReason =
 	 * stay connected long enough for summarizer client to catch up.
 	 */
 	| "lastSummary"
-	/** On-demand summary requested with specified reason. */
+	/**
+	 * On-demand summary requested with specified reason.
+	 */
 	| `onDemand;${string}`
-	/** Enqueue summarize attempt with specified reason. */
+	/**
+	 * Enqueue summarize attempt with specified reason.
+	 */
 	| `enqueue;${string}`;
 
 const summarizeErrors = {
@@ -130,7 +140,7 @@ const summarizeErrors = {
 export type SummarizeErrorCode = keyof typeof summarizeErrors;
 
 // Helper functions to report failures and return.
-export const getFailMessage = (errorCode: SummarizeErrorCode) =>
+export const getFailMessage = (errorCode: SummarizeErrorCode): string =>
 	`${errorCode}: ${summarizeErrors[errorCode]}`;
 
 export class SummarizeResultBuilder {
@@ -155,7 +165,7 @@ export class SummarizeResultBuilder {
 		error: IRetriableFailureError,
 		submitFailureResult?: SubmitSummaryFailureData,
 		nackSummaryResult?: INackSummaryResult,
-	) {
+	): void {
 		assert(
 			!this.receivedSummaryAckOrNack.isCompleted,
 			0x25e /* "no reason to call fail if all promises have been completed" */,
@@ -205,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">,
@@ -226,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> {
@@ -278,7 +294,7 @@ export class SummaryGenerator {
 			properties?: SummaryGeneratorTelemetry,
 			submitFailureResult?: SubmitSummaryFailureData,
 			nackSummaryResult?: INackSummaryResult,
-		) => {
+		): void => {
 			// Report any failure as an error unless it was due to cancellation (like "disconnected" error)
 			// If failure happened on upload, we may not yet realized that socket disconnected, so check
 			// offlineError too.
@@ -515,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,
@@ -533,8 +551,9 @@ export class SummaryGenerator {
 					handle: summaryData.handle,
 					uploadDuration: summaryData.uploadDuration,
 				};
+			}
 
-			case "submit":
+			case "submit": {
 				return {
 					...initialProps,
 					...summaryData.summaryStats,
@@ -547,15 +566,17 @@ export class SummaryGenerator {
 					nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps,
 					runtimeOpsSinceLastSummary: this.heuristicData.numRuntimeOps,
 				};
+			}
 
-			default:
+			default: {
 				assert(true, 0x397 /* Unexpected summary stage */);
+			}
 		}
 
 		return initialProps;
 	}
 
-	private summarizeTimerHandler(time: number, count: number) {
+	private summarizeTimerHandler(time: number, count: number): void {
 		this.logger.sendPerformanceEvent({
 			eventName: "SummarizeTimeout",
 			timeoutTime: time,
@@ -570,7 +591,7 @@ export class SummaryGenerator {
 		}
 	}
 
-	public dispose() {
+	public dispose(): void {
 		this.summarizeTimer.clear();
 	}
 }