@fluidframework/container-runtime 2.13.0 → 2.21.0

package/src/gc/gcSummaryDefinitions.ts

@@ -32,11 +32,17 @@ export interface IGarbageCollectionState {
  * The GC data that is read from a snapshot. It contains the Garbage CollectionState state and tombstone state.
  */
 export interface IGarbageCollectionSnapshotData {
-	/** The garbage collection state. It is a list of nodes in the container and their GC data. */
+	/**
+	 * The garbage collection state. It is a list of nodes in the container and their GC data.
+	 */
 	gcState: IGarbageCollectionState | undefined;
-	/** A list of nodes that have been tombstoned by GC. */
+	/**
+	 * A list of nodes that have been tombstoned by GC.
+	 */
 	tombstones: string[] | undefined;
-	/** A list of nodes that have been deleted by GC. */
+	/**
+	 * A list of nodes that have been deleted by GC.
+	 */
 	deletedNodes: string[] | undefined;
 }
 
@@ -45,10 +51,16 @@ export interface IGarbageCollectionSnapshotData {
  * Legacy GC details from when the GC details were written at the data store's summary tree.
  */
 export interface IGarbageCollectionSummaryDetailsLegacy {
-	/** A list of routes to Fluid objects that are used in this node. */
+	/**
+	 * A list of routes to Fluid objects that are used in this node.
+	 */
 	usedRoutes?: string[];
-	/** The GC data of this node. */
+	/**
+	 * The GC data of this node.
+	 */
 	gcData?: IGarbageCollectionData;
-	/** If this node is unreferenced, the time when it was marked as such. */
+	/**
+	 * If this node is unreferenced, the time when it was marked as such.
+	 */
 	unrefTimestamp?: number;
 }

package/src/gc/gcSummaryStateTracker.ts

@@ -16,6 +16,7 @@ import { SummaryTreeBuilder, mergeStats } from "@fluidframework/runtime-utils/in
 
 import { IRefreshSummaryResult } from "../summary/index.js";
 
+// eslint-disable-next-line import/no-deprecated
 import { IGCStats, IGarbageCollectorConfigs } from "./gcDefinitions.js";
 import { generateSortedGCState } from "./gcHelpers.js";
 import {
@@ -61,7 +62,9 @@ export class GCSummaryStateTracker {
 	/**
 	 * Called during GC initialization. Initialize the latest summary data from the base snapshot data.
 	 */
-	public initializeBaseState(baseSnapshotData: IGarbageCollectionSnapshotData | undefined) {
+	public initializeBaseState(
+		baseSnapshotData: IGarbageCollectionSnapshotData | undefined,
+	): void {
 		if (baseSnapshotData === undefined) {
 			return;
 		}
@@ -96,7 +99,7 @@ export class GCSummaryStateTracker {
 		// Serialize and write deleted nodes, if any. This is done irrespective of whether sweep is enabled or not so
 		// to identify deleted nodes' usage.
 		const serializedDeletedNodes =
-			deletedNodes.size > 0 ? JSON.stringify(Array.from(deletedNodes).sort()) : undefined;
+			deletedNodes.size > 0 ? JSON.stringify([...deletedNodes].sort()) : undefined;
 		// Serialize and write tombstones, if any.
 		const serializedTombstones =
 			tombstones.length > 0 ? JSON.stringify(tombstones.sort()) : undefined;
@@ -228,7 +231,8 @@ export class GCSummaryStateTracker {
 	/**
 	 * Called to update the state from a GC run's stats. Used to update the count of data stores whose state updated.
 	 */
-	public updateStateFromGCRunStats(stats: IGCStats) {
+	// eslint-disable-next-line import/no-deprecated
+	public updateStateFromGCRunStats(stats: IGCStats): void {
 		this.updatedDSCountSinceLastSummary += stats.updatedDataStoreCount;
 	}
 }

package/src/gc/gcTelemetry.ts

@@ -14,10 +14,13 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 
 import { RuntimeHeaderData } from "../containerRuntime.js";
+// eslint-disable-next-line import/no-deprecated
 import { ICreateContainerMetadata } from "../summary/index.js";
 
 import {
+	// eslint-disable-next-line import/no-deprecated
 	GCFeatureMatrix,
+	// eslint-disable-next-line import/no-deprecated
 	GCNodeType,
 	IGarbageCollectorConfigs,
 	UnreferencedState,
@@ -26,7 +29,9 @@ import { UnreferencedStateTracker } from "./gcUnreferencedStateTracker.js";
 
 type NodeUsageType = "Changed" | "Loaded" | "Revived" | "Realized";
 
-/** Properties that are common to IUnreferencedEventProps and INodeUsageProps */
+/**
+ * Properties that are common to IUnreferencedEventProps and INodeUsageProps
+ */
 interface ICommonProps {
 	usageType: NodeUsageType;
 	completedGCRuns: number;
@@ -36,39 +41,64 @@ interface ICommonProps {
 	additionalProps?: ITelemetryPropertiesExt;
 }
 
-/** The event that is logged when unreferenced node is used after a certain time. */
+/**
+ * The event that is logged when unreferenced node is used after a certain time.
+ */
+// eslint-disable-next-line import/no-deprecated
 interface IUnreferencedEventProps extends ICreateContainerMetadata, ICommonProps {
-	/** The id that GC uses to track the node. May or may not match id */
+	/**
+	 * The id that GC uses to track the node. May or may not match id
+	 */
 	trackedId: string;
 	state: UnreferencedState;
-	/** The full path (in GC Path format) to the node in question */
+	/**
+	 * The full path (in GC Path format) to the node in question
+	 */
 	id: Tagged<string>;
 	fromId?: Tagged<string>;
+	// eslint-disable-next-line import/no-deprecated
 	type: GCNodeType;
 	unrefTime: number;
 	age: number;
 	// Expanding GC feature matrix. Without doing this, the configs cannot be logged in telemetry directly.
 	gcConfigs: Omit<IGarbageCollectorConfigs, "persistedGcFeatureMatrix"> & {
+		// eslint-disable-next-line import/no-deprecated
 		[K in keyof GCFeatureMatrix]: GCFeatureMatrix[K];
 	};
 	timeout?: number;
 }
 
-/** Properties passed to nodeUsed function when a node is used. */
+/**
+ * Properties passed to nodeUsed function when a node is used.
+ */
 interface INodeUsageProps extends ICommonProps {
-	/** The full path (in GC Path format) to the node in question */
+	/**
+	 * The full path (in GC Path format) to the node in question
+	 */
 	id: string;
-	/** Latest timestamp received from the server, as a baseline for computing GC state/age */
+	/**
+	 * Latest timestamp received from the server, as a baseline for computing GC state/age
+	 */
 	currentReferenceTimestampMs: number;
-	/** The package path of the node. This may not be available if the node hasn't been loaded yet */
+	/**
+	 * The package path of the node. This may not be available if the node hasn't been loaded yet
+	 */
 	packagePath: readonly string[] | undefined;
-	/** In case of Revived - what node added the reference? */
+	/**
+	 * In case of Revived - what node added the reference?
+	 */
 	fromId?: string;
-	/** In case of Revived - was it revived due to autorecovery? */
+	/**
+	 * In case of Revived - was it revived due to autorecovery?
+	 */
 	autorecovery?: true;
-	/** URL (including query string) if this usage came from a request */
+	/**
+	 * URL (including query string) if this usage came from a request
+	 */
 	requestUrl?: string;
-	/** Original request headers if this usage came from a request or handle.get */
+	/**
+	 * Original request headers if this usage came from a request or handle.get
+	 */
 	requestHeaders?: string;
 }
 
@@ -99,7 +129,9 @@ export class GCTelemetryTracker {
 		private readonly mc: MonitoringContext,
 		private readonly configs: IGarbageCollectorConfigs,
 		private readonly isSummarizerClient: boolean,
+		// eslint-disable-next-line import/no-deprecated
 		private readonly createContainerMetadata: ICreateContainerMetadata,
+		// eslint-disable-next-line import/no-deprecated
 		private readonly getNodeType: (nodeId: string) => GCNodeType,
 		private readonly getNodeStateTracker: (
 			nodeId: string,
@@ -110,27 +142,34 @@ export class GCTelemetryTracker {
 	) {}
 
 	/**
-	 * Returns whether an event should be logged for a node that isn't active anymore. This does not apply to
-	 * tombstoned nodes for which an event is always logged. Some scenarios where we won't log:
+	 * Returns whether an event should be logged for a node that isn't active anymore.
+	 *
+	 * @remarks
+	 * This does not apply to tombstoned nodes for which an event is always logged. Some scenarios where we won't log:
+	 *
 	 * 1. When a DDS is changed. The corresponding data store's event will be logged instead.
+	 *
 	 * 2. An event is logged only once per container instance per event per node.
 	 */
 	private shouldLogNonActiveEvent(
+		// eslint-disable-next-line import/no-deprecated
 		nodeType: GCNodeType,
 		usageType: NodeUsageType,
 		nodeStateTracker: UnreferencedStateTracker,
 		uniqueEventId: string,
-	) {
+	): boolean {
 		if (nodeStateTracker.state === UnreferencedState.Active) {
 			return false;
 		}
 
+		// eslint-disable-next-line import/no-deprecated
 		if (nodeType === GCNodeType.Other) {
 			return false;
 		}
 
 		// For sub data store (DDS) nodes, if they are changed, its data store will also be changed,
 		// so skip logging to make the telemetry less noisy.
+		// eslint-disable-next-line import/no-deprecated
 		if (nodeType === GCNodeType.SubDataStore && usageType === "Changed") {
 			return false;
 		}
@@ -160,7 +199,7 @@ export class GCTelemetryTracker {
 			isTombstoned,
 			...otherNodeUsageProps
 		}: INodeUsageProps,
-	) {
+	): void {
 		// Note: For SubDataStore Load usage, trackedId will be the DataStore's id, not the full path in question.
 		// This is necessary because the SubDataStore path may be unrecognized by GC (if suited for a custom request handler)
 		const nodeStateTracker = this.getNodeStateTracker(trackedId);
@@ -168,17 +207,21 @@ export class GCTelemetryTracker {
 
 		const timeout = (() => {
 			switch (nodeStateTracker?.state) {
-				case UnreferencedState.Inactive:
+				case UnreferencedState.Inactive: {
 					return this.configs.inactiveTimeoutMs;
-				case UnreferencedState.TombstoneReady:
+				}
+				case UnreferencedState.TombstoneReady: {
 					return this.configs.tombstoneTimeoutMs;
-				case UnreferencedState.SweepReady:
+				}
+				case UnreferencedState.SweepReady: {
 					return (
 						this.configs.tombstoneTimeoutMs &&
 						this.configs.tombstoneTimeoutMs + this.configs.sweepGracePeriodMs
 					);
-				default:
+				}
+				default: {
 					return undefined;
+				}
 			}
 		})();
 		const { persistedGcFeatureMatrix, ...configs } = this.configs;
@@ -187,9 +230,9 @@ export class GCTelemetryTracker {
 			type: nodeType,
 			unrefTime: nodeStateTracker?.unreferencedTimestampMs ?? -1,
 			age:
-				nodeStateTracker !== undefined
-					? currentReferenceTimestampMs - nodeStateTracker.unreferencedTimestampMs
-					: -1,
+				nodeStateTracker === undefined
+					? -1
+					: currentReferenceTimestampMs - nodeStateTracker.unreferencedTimestampMs,
 			timeout,
 			isTombstoned,
 			...tagCodeArtifacts({ id: untaggedId, fromId: untaggedFromId }),
@@ -262,10 +305,11 @@ export class GCTelemetryTracker {
 	 */
 	private logTombstoneUsageTelemetry(
 		unrefEventProps: Omit<IUnreferencedEventProps, "state" | "usageType">,
+		// eslint-disable-next-line import/no-deprecated
 		nodeType: GCNodeType,
 		usageType: NodeUsageType,
 		packagePath?: readonly string[],
-	) {
+	): void {
 		// This will log the following events:
 		// GC_Tombstone_DataStore_Requested, GC_Tombstone_DataStore_Changed, GC_Tombstone_DataStore_Revived
 		// GC_Tombstone_SubDataStore_Requested, GC_Tombstone_SubDataStore_Changed, GC_Tombstone_SubDataStore_Revived
@@ -312,7 +356,7 @@ export class GCTelemetryTracker {
 		previousGCData: IGarbageCollectionData,
 		explicitReferences: Map<string, string[]>,
 		logger: ITelemetryLoggerExt,
-	) {
+	): void {
 		for (const [nodeId, currentOutboundRoutes] of Object.entries(currentGCData.gcNodes)) {
 			const previousRoutes = previousGCData.gcNodes[nodeId] ?? [];
 			const explicitRoutes = explicitReferences.get(nodeId) ?? [];
@@ -329,6 +373,7 @@ export class GCTelemetryTracker {
 			for (const route of currentOutboundRoutes) {
 				const nodeType = this.getNodeType(route);
 				if (
+					// eslint-disable-next-line import/no-deprecated
 					(nodeType === GCNodeType.DataStore || nodeType === GCNodeType.Blob) &&
 					!nodeId.startsWith(route) &&
 					!previousRoutes.includes(route) &&
@@ -356,7 +401,7 @@ export class GCTelemetryTracker {
 	 * Log events that are pending in pendingEventsQueue. This is called after GC runs in the summarizer client
 	 * so that the state of an unreferenced node is updated.
 	 */
-	public async logPendingEvents(logger: ITelemetryLoggerExt) {
+	public async logPendingEvents(logger: ITelemetryLoggerExt): Promise<void> {
 		// Events sent come only from the summarizer client. In between summaries, events are pushed to a queue and at
 		// summary time they are then logged.
 		// Events generated:
@@ -383,10 +428,8 @@ export class GCTelemetryTracker {
 			const active =
 				nodeStateTracker === undefined || nodeStateTracker.state === UnreferencedState.Active;
 			if ((usageType === "Revived") === active) {
-				const pkg = await this.getNodePackagePath(eventProps.id.value);
-				const fromPkg = eventProps.fromId
-					? await this.getNodePackagePath(eventProps.fromId.value)
-					: undefined;
+				const pkg = await this.getNodePackagePath(id.value);
+				const fromPkg = fromId ? await this.getNodePackagePath(fromId.value) : undefined;
 				const event = {
 					eventName: `${state}Object_${usageType}`,
 					id,

package/src/gc/gcUnreferencedStateTracker.ts

@@ -8,7 +8,9 @@ import { validatePrecondition } from "@fluidframework/telemetry-utils/internal";
 
 import { UnreferencedState } from "./gcDefinitions.js";
 
-/** A wrapper around common-utils Timer that requires the timeout when calling start/restart */
+/**
+ * A wrapper around common-utils Timer that requires the timeout when calling start/restart
+ */
 class TimerWithNoDefaultTimeout extends Timer {
 	constructor(private readonly callback: () => void) {
 		// The default timeout/handlers will never be used since start/restart pass overrides below
@@ -17,7 +19,7 @@ class TimerWithNoDefaultTimeout extends Timer {
 		});
 	}
 
-	start(timeoutMs: number) {
+	start(timeoutMs: number): void {
 		super.start(timeoutMs, this.callback);
 	}
 
@@ -26,9 +28,13 @@ class TimerWithNoDefaultTimeout extends Timer {
 	}
 }
 
-/** The collection of UnreferencedStateTrackers for all unreferenced nodes. Ensures stopTracking is called when deleting */
+/**
+ * The collection of UnreferencedStateTrackers for all unreferenced nodes. Ensures stopTracking is called when deleting
+ */
 export class UnreferencedStateTrackerMap extends Map<string, UnreferencedStateTracker> {
-	/** Delete the given key, and stop tracking if that node was actually unreferenced */
+	/**
+	 * Delete the given key, and stop tracking if that node was actually unreferenced
+	 */
 	delete(key: string): boolean {
 		// Stop tracking so as to clear out any running timers.
 		this.get(key)?.stopTracking();
@@ -47,22 +53,36 @@ export class UnreferencedStateTracker {
 		return this._state;
 	}
 
-	/** Timer to indicate when an unreferenced object is considered Inactive */
+	/**
+	 * Timer to indicate when an unreferenced object is considered Inactive
+	 */
 	private readonly inactiveTimer: TimerWithNoDefaultTimeout;
-	/** Timer to indicate when an unreferenced object is Tombstone-Ready */
+	/**
+	 * Timer to indicate when an unreferenced object is Tombstone-Ready
+	 */
 	private readonly tombstoneTimer: TimerWithNoDefaultTimeout;
-	/** Timer to indicate when an unreferenced object is Sweep-Ready */
+	/**
+	 * Timer to indicate when an unreferenced object is Sweep-Ready
+	 */
 	private readonly sweepTimer: TimerWithNoDefaultTimeout;
 
 	constructor(
 		public readonly unreferencedTimestampMs: number,
-		/** The time after which node transitions to Inactive state. */
+		/**
+		 * The time after which node transitions to Inactive state.
+		 */
 		private readonly inactiveTimeoutMs: number,
-		/** The current reference timestamp used to track how long this node has been unreferenced for. */
+		/**
+		 * The current reference timestamp used to track how long this node has been unreferenced for.
+		 */
 		currentReferenceTimestampMs: number,
-		/** The time after which node transitions to TombstoneReady state; undefined if session expiry is disabled. */
+		/**
+		 * The time after which node transitions to TombstoneReady state; undefined if session expiry is disabled.
+		 */
 		private readonly tombstoneTimeoutMs: number | undefined,
-		/** The delay from TombstoneReady to SweepReady (only applies if tombstoneTimeoutMs is defined) */
+		/**
+		 * The delay from TombstoneReady to SweepReady (only applies if tombstoneTimeoutMs is defined)
+		 */
 		private readonly sweepGracePeriodMs: number,
 	) {
 		validatePrecondition(
@@ -106,8 +126,10 @@ export class UnreferencedStateTracker {
 		this.updateTracking(currentReferenceTimestampMs);
 	}
 
-	/* Updates the unreferenced state based on the provided timestamp. */
-	public updateTracking(currentReferenceTimestampMs: number) {
+	/**
+	 * Updates the unreferenced state based on the provided timestamp.
+	 */
+	public updateTracking(currentReferenceTimestampMs: number): void {
 		const unreferencedDurationMs = currentReferenceTimestampMs - this.unreferencedTimestampMs;
 
 		// Below we will set the appropriate timer (or none). Any running timers are superceded by the new currentReferenceTimestampMs
@@ -151,14 +173,16 @@ export class UnreferencedStateTracker {
 		this.inactiveTimer.restart(this.inactiveTimeoutMs - unreferencedDurationMs);
 	}
 
-	private clearTimers() {
+	private clearTimers(): void {
 		this.inactiveTimer.clear();
 		this.tombstoneTimer.clear();
 		this.sweepTimer.clear();
 	}
 
-	/** Stop tracking this node. Reset the unreferenced timers and state, if any. */
-	public stopTracking() {
+	/**
+	 * Stop tracking this node. Reset the unreferenced timers and state, if any.
+	 */
+	public stopTracking(): void {
 		this.clearTimers();
 		this._state = UnreferencedState.Active;
 	}

package/src/gc/index.ts

@@ -4,6 +4,7 @@
  */
 
 export { GarbageCollector } from "./garbageCollection.js";
+export { computeTombstoneTimeout } from "./gcConfigs.js";
 export {
 	nextGCVersion,
 	defaultInactiveTimeoutMs,