@fluidframework/container-runtime 2.12.0 → 2.20.0

package/src/summary/summarizer.ts

@@ -55,14 +55,21 @@ export class SummarizingWarning
 		super(errorMessage);
 	}
 
-	static wrap(error: any, logged: boolean = false, logger: ITelemetryLoggerExt) {
-		const newErrorFn = (errMsg: string) => new SummarizingWarning(errMsg, logged);
+	static wrap(
+		error: unknown,
+		logged: boolean = false,
+		logger: ITelemetryLoggerExt,
+	): SummarizingWarning {
+		const newErrorFn = (errMsg: string): SummarizingWarning =>
+			new SummarizingWarning(errMsg, logged);
 		return wrapErrorAndLog<SummarizingWarning>(error, newErrorFn, logger);
 	}
 }
 
-export const createSummarizingWarning = (errorMessage: string, logged: boolean) =>
-	new SummarizingWarning(errorMessage, logged);
+export const createSummarizingWarning = (
+	errorMessage: string,
+	logged: boolean,
+): SummarizingWarning => new SummarizingWarning(errorMessage, logged);
 
 /**
  * Summarizer is responsible for coordinating when to generate and send summaries.
@@ -72,7 +79,7 @@ export const createSummarizingWarning = (errorMessage: string, logged: boolean)
  * @alpha
  */
 export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
-	public get ISummarizer() {
+	public get ISummarizer(): this {
 		return this;
 	}
 
@@ -84,12 +91,14 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 	private readonly stopDeferred = new Deferred<SummarizerStopReason>();
 
 	constructor(
-		/** Reference to runtime that created this object.
+		/**
+		 * Reference to runtime that created this object.
 		 * i.e. runtime with clientType === "summarizer"
 		 */
 		private readonly runtime: ISummarizerRuntime,
 		private readonly configurationGetter: () => ISummaryConfiguration,
-		/** Represents an object that can generate summary.
+		/**
+		 * Represents an object that can generate summary.
 		 * In practical terms, it's same runtime (this.runtime) with clientType === "summarizer".
 		 */
 		private readonly internalsProvider: ISummarizerInternalsProvider,
@@ -134,11 +143,11 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 	 * the run promise, and also close the container.
 	 * @param reason - reason code for stopping
 	 */
-	public stop(reason: SummarizerStopReason) {
+	public stop(reason: SummarizerStopReason): void {
 		this.stopDeferred.resolve(reason);
 	}
 
-	public close() {
+	public close(): void {
 		// This will result in "summarizerClientDisconnected" stop reason recorded in telemetry,
 		// unless stop() was called earlier
 		this.dispose();
@@ -259,7 +268,9 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 		this._heuristicData = new SummarizeHeuristicData(
 			this.runtime.deltaManager.lastSequenceNumber,
 			{
-				/** summary attempt baseline for heuristics */
+				/**
+				 * summary attempt baseline for heuristics
+				 */
 				refSequenceNumber: this.runtime.deltaManager.initialSequenceNumber,
 				summaryTime: Date.now(),
 			} as const,
@@ -289,7 +300,7 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 	 * properties.
 	 * Called by ContainerRuntime when it is disposed, as well as at the end the run().
 	 */
-	public dispose() {
+	public dispose(): void {
 		// Given that the call can come from own ContainerRuntime, ensure that we stop all the processes.
 		this.stop("summarizerClientDisconnected");
 
@@ -372,23 +383,25 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 		return this.runningSummarizer.enqueueSummarize(options);
 	}
 
-	public recordSummaryAttempt?(summaryRefSeqNum?: number) {
+	public recordSummaryAttempt?(summaryRefSeqNum?: number): void {
 		this._heuristicData?.recordAttempt(summaryRefSeqNum);
 	}
 
-	private readonly forwardedEvents = new Map<any, () => void>();
+	private readonly forwardedEvents = new Map<string, () => void>();
 
-	private setupForwardedEvents() {
+	private setupForwardedEvents(): void {
 		["summarize", "summarizeAllAttemptsFailed"].forEach((event) => {
-			const listener = (...args: any[]) => {
+			const listener = (...args: any[]): void => {
 				this.emit(event, ...args);
 			};
+			// TODO: better typing here
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
 			this.runningSummarizer?.on(event as any, listener);
 			this.forwardedEvents.set(event, listener);
 		});
 	}
 
-	private cleanupForwardedEvents() {
+	private cleanupForwardedEvents(): void {
 		this.forwardedEvents.forEach((listener, event) =>
 			this.runningSummarizer?.off(event, listener),
 		);

package/src/summary/summarizerClientElection.ts

@@ -51,10 +51,10 @@ export class SummarizerClientElection
 	 */
 	private lastReportedSeq = 0;
 
-	public get electedClientId() {
+	public get electedClientId(): string | undefined {
 		return this.clientElection.electedClient?.clientId;
 	}
-	public get electedParentId() {
+	public get electedParentId(): string | undefined {
 		return this.clientElection.electedParent?.clientId;
 	}
 

package/src/summary/summarizerHeuristics.ts

@@ -16,7 +16,9 @@ import {
 } from "./summarizerTypes.js";
 import { SummarizeReason } from "./summaryGenerator.js";
 
-/** Simple implementation of class for tracking summarize heuristic data. */
+/**
+ * Simple implementation of class for tracking summarize heuristic data.
+ */
 export class SummarizeHeuristicData implements ISummarizeHeuristicData {
 	protected _lastAttempt: ISummarizeAttempt;
 	public get lastAttempt(): ISummarizeAttempt {
@@ -57,19 +59,21 @@ export class SummarizeHeuristicData implements ISummarizeHeuristicData {
 
 	constructor(
 		public lastOpSequenceNumber: number,
-		/** Baseline attempt data used for comparisons with subsequent attempts/calculations. */
+		/**
+		 * Baseline attempt data used for comparisons with subsequent attempts/calculations.
+		 */
 		attemptBaseline: ISummarizeAttempt,
 	) {
 		this._lastAttempt = attemptBaseline;
 		this._lastSuccessfulSummary = { ...attemptBaseline };
 	}
 
-	public updateWithLastSummaryAckInfo(lastSummary: Readonly<ISummarizeAttempt>) {
+	public updateWithLastSummaryAckInfo(lastSummary: Readonly<ISummarizeAttempt>): void {
 		this._lastAttempt = lastSummary;
 		this._lastSuccessfulSummary = { ...lastSummary };
 	}
 
-	public recordAttempt(refSequenceNumber?: number) {
+	public recordAttempt(refSequenceNumber?: number): void {
 		this._lastAttempt = {
 			refSequenceNumber: refSequenceNumber ?? this.lastOpSequenceNumber,
 			summaryTime: Date.now(),
@@ -80,7 +84,7 @@ export class SummarizeHeuristicData implements ISummarizeHeuristicData {
 		this.totalOpsSizeBefore = this.totalOpsSize;
 	}
 
-	public markLastAttemptAsSuccessful() {
+	public markLastAttemptAsSuccessful(): void {
 		this._lastSuccessfulSummary = { ...this.lastAttempt };
 
 		this.numNonRuntimeOps -= this.numNonRuntimeOpsBefore;
@@ -147,11 +151,11 @@ export class SummarizeHeuristicRunner implements ISummarizeHeuristicRunner {
 		);
 	}
 
-	public start() {
+	public start(): void {
 		this.idleTimer?.start(this.idleTime);
 	}
 
-	public run() {
+	public run(): void {
 		for (const strategy of this.summarizeStrategies) {
 			if (strategy.shouldRunSummary(this.configuration, this.heuristicData)) {
 				return this.runSummarize(strategy.summarizeReason);
@@ -179,12 +183,14 @@ export class SummarizeHeuristicRunner implements ISummarizeHeuristicRunner {
 		return weightedOpsSinceLastAck >= minOpsForLastSummaryAttempt;
 	}
 
-	public dispose() {
+	public dispose(): void {
 		this.idleTimer?.clear();
 	}
 }
 
-/** Strategy used to run a summary when it's been a while since our last successful summary */
+/**
+ * Strategy used to run a summary when it's been a while since our last successful summary
+ */
 class MaxTimeSummaryHeuristicStrategy implements ISummaryHeuristicStrategy {
 	public readonly summarizeReason: Readonly<SummarizeReason> = "maxTime";
 
@@ -206,7 +212,9 @@ function getWeightedNumberOfOps(
 	return runtimeOpWeight * runtimeOpCount + nonRuntimeOpWeight * nonRuntimeOpCount;
 }
 
-/** Strategy used to do a weighted analysis on the ops we've processed since the last successful summary */
+/**
+ * Strategy used to do a weighted analysis on the ops we've processed since the last successful summary
+ */
 class WeightedOpsSummaryHeuristicStrategy implements ISummaryHeuristicStrategy {
 	public readonly summarizeReason: Readonly<SummarizeReason> = "maxOps";
 
@@ -224,6 +232,9 @@ class WeightedOpsSummaryHeuristicStrategy implements ISummaryHeuristicStrategy {
 	}
 }
 
-function getDefaultSummaryHeuristicStrategies() {
+function getDefaultSummaryHeuristicStrategies(): (
+	| MaxTimeSummaryHeuristicStrategy
+	| WeightedOpsSummaryHeuristicStrategy
+)[] {
 	return [new MaxTimeSummaryHeuristicStrategy(), new WeightedOpsSummaryHeuristicStrategy()];
 }

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;
@@ -317,7 +323,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,7 +335,7 @@ 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" */,
@@ -362,7 +368,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		this.clearSummary();
 	}
 
-	public clearSummary() {
+	public clearSummary(): void {
 		this.wipReferenceSequenceNumber = undefined;
 		this.wipSummarizeCalled = false;
 		this.wipSkipRecursion = false;
@@ -476,7 +482,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 +508,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 +609,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()) {
@@ -613,7 +623,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		}
 	}
 
-	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

@@ -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;
 		}
@@ -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.
@@ -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();