@fluidframework/container-runtime 2.0.0-internal.4.3.0 → 2.0.0-internal.4.4.0

package/src/gc/gcDefinitions.ts

@@ -204,6 +204,8 @@ export interface IGarbageCollector {
 	readonly shouldRunGC: boolean;
 	/** Tells whether the GC state in summary needs to be reset in the next summary. */
 	readonly summaryStateNeedsReset: boolean;
+	/** The count of data stores whose GC state updated since the last summary. */
+	readonly updatedDSCountSinceLastSummary: number;
 	/** Initialize the state from the base snapshot after its creation. */
 	initializeBaseState(): Promise<void>;
 	/** Run garbage collection and update the reference / used state of the system. */

package/src/gc/gcHelpers.ts

@@ -12,6 +12,7 @@ import {
 	IGarbageCollectionData,
 	IGarbageCollectionDetailsBase,
 } from "@fluidframework/runtime-definitions";
+import { TelemetryDataTag } from "@fluidframework/telemetry-utils";
 import { GCFeatureMatrix, GCVersion, IGCMetadata } from "./gcDefinitions";
 import {
 	IGarbageCollectionNodeData,
@@ -151,12 +152,19 @@ export function concatGarbageCollectionStates(
 /**
  * Helper function that clones the GC data.
  * @param gcData - The GC data to clone.
+ * @param filter - Optional function to filter out node ids not to be included in the cloned GC data. Returns
+ * true to filter out nodes.
  * @returns a clone of the given GC data.
  */
-export function cloneGCData(gcData: IGarbageCollectionData): IGarbageCollectionData {
+export function cloneGCData(
+	gcData: IGarbageCollectionData,
+	filter?: (id: string) => boolean,
+): IGarbageCollectionData {
 	const clonedGCNodes: { [id: string]: string[] } = {};
 	for (const [id, outboundRoutes] of Object.entries(gcData.gcNodes)) {
-		clonedGCNodes[id] = Array.from(outboundRoutes);
+		if (filter?.(id) !== true) {
+			clonedGCNodes[id] = Array.from(outboundRoutes);
+		}
 	}
 	return {
 		gcNodes: clonedGCNodes,
@@ -296,3 +304,13 @@ export function unpackChildNodesGCDetails(gcDetails: IGarbageCollectionDetailsBa
 export function trimLeadingAndTrailingSlashes(str: string) {
 	return str.replace(/^\/+|\/+$/g, "");
 }
+
+/**
+ * Tags the passed value as a CodeArtifact and returns the tagged value.
+ */
+export function tagAsCodeArtifact(value: string) {
+	return {
+		value,
+		tag: TelemetryDataTag.CodeArtifact,
+	};
+}

package/src/gc/gcSummaryStateTracker.ts

@@ -14,7 +14,7 @@ import {
 } from "@fluidframework/runtime-definitions";
 import { mergeStats, ReadAndParseBlob, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import { IContainerRuntimeMetadata, metadataBlobName, RefreshSummaryResult } from "../summary";
-import { GCVersion } from "./gcDefinitions";
+import { GCVersion, IGCStats } from "./gcDefinitions";
 import { getGCDataFromSnapshot, generateSortedGCState, getGCVersion } from "./gcHelpers";
 import { IGarbageCollectionSnapshotData, IGarbageCollectionState } from "./gcSummaryDefinitions";
 import { IGarbageCollectorConfigs } from ".";
@@ -37,8 +37,6 @@ export interface IGCSummaryTrackingData {
  * On summarize, it decides whether to write new state or re-use previous summary's state.
  */
 export class GCSummaryStateTracker {
-	// The current version of GC running.
-	public readonly currentGCVersion: GCVersion = this.configs.gcVersionInEffect;
 	// This is the version of GC data in the latest summary being tracked.
 	private latestSummaryGCVersion: GCVersion;
 
@@ -50,6 +48,10 @@ export class GCSummaryStateTracker {
 	// Tracks whether there was GC was run in latest summary being tracked.
 	private wasGCRunInLatestSummary: boolean;
 
+	// Tracks the count of data stores whose state updated since the last summary, i.e., they went from referenced
+	// to unreferenced or vice-versa.
+	public updatedDSCountSinceLastSummary: number = 0;
+
 	constructor(
 		// Tells whether GC should run or not.
 		private readonly configs: Pick<
@@ -62,7 +64,8 @@ export class GCSummaryStateTracker {
 		this.wasGCRunInLatestSummary = wasGCRunInBaseSnapshot;
 		// For existing document, the latest summary is the one that we loaded from. So, use its GC version as the
 		// latest tracked GC version. For new documents, we will be writing the first summary with the current version.
-		this.latestSummaryGCVersion = this.configs.gcVersionInBaseSnapshot ?? this.currentGCVersion;
+		this.latestSummaryGCVersion =
+			this.configs.gcVersionInBaseSnapshot ?? this.configs.gcVersionInEffect;
 	}
 
 	/**
@@ -101,7 +104,8 @@ export class GCSummaryStateTracker {
 	public get doesSummaryStateNeedReset(): boolean {
 		return (
 			this.doesGCStateNeedReset ||
-			(this.configs.shouldRunGC && this.latestSummaryGCVersion !== this.currentGCVersion)
+			(this.configs.shouldRunGC &&
+				this.latestSummaryGCVersion !== this.configs.gcVersionInEffect)
 		);
 	}
 
@@ -283,9 +287,10 @@ export class GCSummaryStateTracker {
 		// If the summary was tracked by this client, it was the one that generated the summary in the first place.
 		// Update latest state from pending.
 		if (result.wasSummaryTracked) {
-			this.latestSummaryGCVersion = this.currentGCVersion;
+			this.latestSummaryGCVersion = this.configs.gcVersionInEffect;
 			this.latestSummaryData = this.pendingSummaryData;
 			this.pendingSummaryData = undefined;
+			this.updatedDSCountSinceLastSummary = 0;
 			return undefined;
 		}
 
@@ -311,7 +316,7 @@ export class GCSummaryStateTracker {
 		// in the snapshot cannot be interpreted correctly. Set everything to undefined except for deletedNodes
 		// because irrespective of GC versions, these nodes have been deleted and cannot be brought back. The
 		// deletedNodes info is needed to identify when these nodes are used.
-		if (getGCVersion(metadata) !== this.currentGCVersion) {
+		if (getGCVersion(metadata) !== this.configs.gcVersionInEffect) {
 			snapshotData = {
 				gcState: undefined,
 				tombstones: undefined,
@@ -326,4 +331,11 @@ export class GCSummaryStateTracker {
 		};
 		return snapshotData;
 	}
+
+	/**
+	 * 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) {
+		this.updatedDSCountSinceLastSummary += stats.updatedDataStoreCount;
+	}
 }

package/src/gc/gcTelemetry.ts

@@ -6,11 +6,7 @@
 import { ITelemetryGenericEvent, ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
 import { packagePathToTelemetryProperty } from "@fluidframework/runtime-utils";
-import {
-	generateStack,
-	MonitoringContext,
-	TelemetryDataTag,
-} from "@fluidframework/telemetry-utils";
+import { generateStack, MonitoringContext } from "@fluidframework/telemetry-utils";
 import { ICreateContainerMetadata } from "../summary";
 import {
 	disableSweepLogKey,
@@ -23,6 +19,7 @@ import {
 	runSweepKey,
 } from "./gcDefinitions";
 import { UnreferencedStateTracker } from "./gcUnreferencedStateTracker";
+import { tagAsCodeArtifact } from "./gcHelpers";
 
 type NodeUsageType = "Changed" | "Loaded" | "Revived";
 
@@ -32,25 +29,32 @@ interface ICommonProps {
 	completedGCRuns: number;
 	isTombstoned: boolean;
 	lastSummaryTime?: number;
-	fromId?: string;
 	viaHandle?: boolean;
 }
 
 /** The event that is logged when unreferenced node is used after a certain time. */
 interface IUnreferencedEventProps extends ICreateContainerMetadata, ICommonProps {
 	state: UnreferencedState;
-	id: string;
+	id: {
+		value: string;
+		tag: string;
+	};
 	type: GCNodeType;
 	unrefTime: number;
 	age: number;
 	timeout?: number;
+	fromId?: {
+		value: string;
+		tag: string;
+	};
 }
 
 /** Properties passed to nodeUsed function when a node is used. */
 interface INodeUsageProps extends ICommonProps {
-	nodeId: string;
+	id: string;
 	currentReferenceTimestampMs: number | undefined;
 	packagePath: readonly string[] | undefined;
+	fromId?: string;
 }
 
 /**
@@ -125,18 +129,18 @@ export class GCTelemetryTracker {
 		// If there is no reference timestamp to work with, no ops have been processed after creation. If so, skip
 		// logging as nothing interesting would have happened worth logging.
 		// If the node is not unreferenced, skip logging.
-		const nodeStateTracker = this.getNodeStateTracker(nodeUsageProps.nodeId);
+		const nodeStateTracker = this.getNodeStateTracker(nodeUsageProps.id);
 		if (!nodeStateTracker || nodeUsageProps.currentReferenceTimestampMs === undefined) {
 			return;
 		}
 
 		// We log these events once per event per node. A unique id is generated by joining node state (inactive / sweep ready),
 		// node's id and usage (loaded / changed / revived).
-		const uniqueEventId = `${nodeStateTracker.state}-${nodeUsageProps.nodeId}-${nodeUsageProps.usageType}`;
-		const nodeType = this.getNodeType(nodeUsageProps.nodeId);
+		const uniqueEventId = `${nodeStateTracker.state}-${nodeUsageProps.id}-${nodeUsageProps.usageType}`;
+		const nodeType = this.getNodeType(nodeUsageProps.id);
 		if (
 			!this.shouldLogNonActiveEvent(
-				nodeUsageProps.nodeId,
+				nodeUsageProps.id,
 				nodeType,
 				nodeUsageProps.usageType,
 				nodeStateTracker,
@@ -150,10 +154,10 @@ export class GCTelemetryTracker {
 		this.loggedUnreferencedEvents.add(uniqueEventId);
 
 		const state = nodeStateTracker.state;
-		const { usageType, currentReferenceTimestampMs, packagePath, ...propsToLog } =
+		const { usageType, currentReferenceTimestampMs, packagePath, id, fromId, ...propsToLog } =
 			nodeUsageProps;
 		const eventProps: Omit<IUnreferencedEventProps, "state" | "usageType"> = {
-			id: nodeUsageProps.nodeId,
+			id: tagAsCodeArtifact(id),
 			type: nodeType,
 			unrefTime: nodeStateTracker.unreferencedTimestampMs,
 			age:
@@ -163,6 +167,7 @@ export class GCTelemetryTracker {
 				state === UnreferencedState.Inactive
 					? this.configs.inactiveTimeoutMs
 					: this.configs.sweepTimeoutMs,
+			fromId: fromId ? tagAsCodeArtifact(fromId) : undefined,
 			...propsToLog,
 			...this.createContainerMetadata,
 		};
@@ -175,7 +180,7 @@ export class GCTelemetryTracker {
 				{
 					eventName: `GC_Tombstone_${nodeType}_Revived`,
 					category: "generic",
-					url: nodeUsageProps.nodeId,
+					url: tagAsCodeArtifact(id),
 					gcTombstoneEnforcementAllowed: this.gcTombstoneEnforcementAllowed,
 				},
 				undefined /* packagePath */,
@@ -199,11 +204,16 @@ export class GCTelemetryTracker {
 			// Events generated:
 			// InactiveObject_Loaded, SweepReadyObject_Loaded
 			if (nodeUsageProps.usageType === "Loaded") {
+				const { id: taggedId, fromId: taggedFromId, ...otherProps } = eventProps;
 				const event = {
 					eventName: `${state}Object_${nodeUsageProps.usageType}`,
 					pkg: packagePathToTelemetryProperty(nodeUsageProps.packagePath),
 					stack: generateStack(),
-					...eventProps,
+					id: taggedId,
+					fromId: taggedFromId,
+					details: JSON.stringify({
+						...otherProps,
+					}),
 				};
 
 				// Do not log the inactive object x events as error events as they are not the best signal for
@@ -263,8 +273,8 @@ export class GCTelemetryTracker {
 			if (missingExplicitRoutes.length > 0) {
 				logger.sendErrorEvent({
 					eventName: "gcUnknownOutboundReferences",
-					gcNodeId: nodeId,
-					gcRoutes: JSON.stringify(missingExplicitRoutes),
+					id: tagAsCodeArtifact(nodeId),
+					routes: tagAsCodeArtifact(JSON.stringify(missingExplicitRoutes)),
 				});
 			}
 		}
@@ -281,31 +291,31 @@ export class GCTelemetryTracker {
 		// InactiveObject_Loaded, InactiveObject_Changed, InactiveObject_Revived
 		// SweepReadyObject_Loaded, SweepReadyObject_Changed, SweepReadyObject_Revived
 		for (const eventProps of this.pendingEventsQueue) {
-			const { usageType, state, ...propsToLog } = eventProps;
+			const { usageType, state, id, fromId, ...propsToLog } = eventProps;
 			/**
 			 * Revived event is logged only if the node is active. If the node is not active, the reference to it was
 			 * from another unreferenced node and this scenario is not interesting to log.
 			 * Loaded and Changed events are logged only if the node is not active. If the node is active, it was
 			 * revived and a Revived event will be logged for it.
 			 */
-			const nodeStateTracker = this.getNodeStateTracker(eventProps.id);
+			const nodeStateTracker = this.getNodeStateTracker(eventProps.id.value);
 			const active =
 				nodeStateTracker === undefined ||
 				nodeStateTracker.state === UnreferencedState.Active;
 			if ((usageType === "Revived") === active) {
-				const pkg = await this.getNodePackagePath(eventProps.id);
+				const pkg = await this.getNodePackagePath(eventProps.id.value);
 				const fromPkg = eventProps.fromId
-					? await this.getNodePackagePath(eventProps.fromId)
+					? await this.getNodePackagePath(eventProps.fromId.value)
 					: undefined;
 				const event = {
-					...propsToLog,
 					eventName: `${state}Object_${usageType}`,
-					pkg: pkg
-						? { value: pkg.join("/"), tag: TelemetryDataTag.CodeArtifact }
-						: undefined,
-					fromPkg: fromPkg
-						? { value: fromPkg.join("/"), tag: TelemetryDataTag.CodeArtifact }
-						: undefined,
+					details: JSON.stringify({
+						...propsToLog,
+					}),
+					id,
+					fromId,
+					pkg: pkg ? tagAsCodeArtifact(pkg.join("/")) : undefined,
+					fromPkg: fromPkg ? tagAsCodeArtifact(fromPkg.join("/")) : undefined,
 				};
 
 				if (state === UnreferencedState.Inactive) {
@@ -336,6 +346,7 @@ export class GCTelemetryTracker {
 			return;
 		}
 
+		const deletedNodeIds: string[] = [];
 		for (const [nodeId, nodeStateTracker] of unreferencedNodesState) {
 			if (nodeStateTracker.state !== UnreferencedState.SweepReady) {
 				return;
@@ -352,15 +363,19 @@ export class GCTelemetryTracker {
 				return;
 			}
 			this.loggedUnreferencedEvents.add(uniqueEventId);
+			deletedNodeIds.push(nodeId);
+		}
+
+		if (deletedNodeIds.length > 0) {
 			logger.sendTelemetryEvent({
-				eventName: "GCObjectDeleted",
-				id: nodeId,
-				type: nodeType,
-				age: currentReferenceTimestampMs - nodeStateTracker.unreferencedTimestampMs,
-				timeout: this.configs.sweepTimeoutMs,
-				completedGCRuns,
-				lastSummaryTime,
-				...this.createContainerMetadata,
+				eventName: "GC_SweepReadyObjects_Delete",
+				details: JSON.stringify({
+					timeout: this.configs.sweepTimeoutMs,
+					completedGCRuns,
+					lastSummaryTime,
+					...this.createContainerMetadata,
+				}),
+				id: tagAsCodeArtifact(JSON.stringify(deletedNodeIds)),
 			});
 		}
 	}

package/src/gc/index.ts

@@ -43,6 +43,7 @@ export {
 	shouldAllowGcSweep,
 	trimLeadingAndTrailingSlashes,
 	unpackChildNodesGCDetails,
+	tagAsCodeArtifact,
 } from "./gcHelpers";
 export { runGarbageCollection } from "./gcReferenceGraphAlgorithm";
 export {
@@ -56,10 +57,5 @@ export {
 	GCSummaryStateTracker,
 	IGCSummaryTrackingData,
 } from "./gcSummaryStateTracker";
-export {
-	skipClosureForXDaysKey,
-	closuresMapLocalStorageKey,
-	SweepReadyUsageDetectionHandler,
-} from "./gcSweepReadyUsageDetection";
 export { GCTelemetryTracker, sendGCUnexpectedUsageEvent } from "./gcTelemetry";
 export { UnreferencedStateTracker } from "./gcUnreferencedStateTracker";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.0.0-internal.4.3.0";
+export const pkgVersion = "2.0.0-internal.4.4.0";

package/src/scheduleManager.ts

@@ -147,14 +147,14 @@ class ScheduleManagerCore {
 		// We are intentionally directly listening to the "op" to inspect system ops as well.
 		// If we do not observe system ops, we are likely to hit 0x296 assert when system ops
 		// precedes start of incomplete batch.
-		this.deltaManager.on("op", (message) => this.afterOpProcessing(message.sequenceNumber));
+		this.deltaManager.on("op", (message) => this.afterOpProcessing(message));
 	}
 
 	/**
 	 * The only public function in this class - called when we processed an op,
 	 * to make decision if op processing should be paused or not after that.
 	 */
-	public afterOpProcessing(sequenceNumber: number) {
+	public afterOpProcessing(message: ISequencedDocumentMessage) {
 		assert(
 			!this.localPaused,
 			0x294 /* "can't have op processing paused if we are processing an op" */,
@@ -177,12 +177,24 @@ class ScheduleManagerCore {
 
 		// do we have incomplete batch to worry about?
 		if (this.pauseSequenceNumber !== undefined) {
-			assert(
-				sequenceNumber < this.pauseSequenceNumber,
-				0x296 /* "we should never start processing incomplete batch!" */,
-			);
+			if (message.sequenceNumber >= this.pauseSequenceNumber) {
+				throw DataProcessingError.create(
+					// Former assert 0x296
+					"Incomplete batch",
+					"ScheduleManager",
+					message,
+					{
+						type: message.type,
+						contentType: typeof message.contents,
+						batch: message.metadata?.batch,
+						compression: message.compression,
+						pauseSeqNum: this.pauseSequenceNumber,
+					},
+				);
+			}
+
 			// If the next op is the start of incomplete batch, then we can't process it until it's fully in - pause!
-			if (sequenceNumber + 1 === this.pauseSequenceNumber) {
+			if (message.sequenceNumber + 1 === this.pauseSequenceNumber) {
 				this.pauseQueue();
 			}
 		}

package/dist/gc/gcSweepReadyUsageDetection.d.ts

@@ -1,53 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryProperties } from "@fluidframework/common-definitions";
-import { ICriticalContainerError } from "@fluidframework/container-definitions";
-import { IFluidErrorBase, LoggingError, MonitoringContext } from "@fluidframework/telemetry-utils";
-/**
- * Feature Gate Key -
- * How many days between closing the container from this error (avoids locking user out of their file altogether)
- */
-export declare const skipClosureForXDaysKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays";
-/**
- * LocalStorage key (NOT via feature gate / monitoring context)
- * A map from docId to info about the last time we closed due to this error
- */
-export declare const closuresMapLocalStorageKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures";
-/**
- * Error class raised when a SweepReady object is used, indicating a bug in how
- * references are managed in the container by the application, or a bug in how
- * GC tracks those references.
- *
- * There's a chance for false positives when this error is raised by an Interactive Container,
- * since only the Summarizer has the latest truth about unreferenced node tracking
- */
-export declare class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {
-    /** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */
-    errorType: string;
-}
-/**
- * This class encapsulates the logic around what to do when a SweepReady object is used.
- * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:
- * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation
- * (via sweepReadyUsageDetectionSetting above)
- * - Throttling the frequency of these crashes via a "Skip Closure Period" per container per device
- * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)
- */
-export declare class SweepReadyUsageDetectionHandler {
-    private readonly uniqueContainerKey;
-    private readonly mc;
-    private readonly closeFn;
-    private readonly localStorage;
-    constructor(uniqueContainerKey: string, mc: MonitoringContext, closeFn: (error?: ICriticalContainerError) => void, localStorageOverride?: Pick<Storage, "getItem" | "setItem">);
-    /**
-     * If SweepReady Usage Detection is enabled, close the interactive container.
-     * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.
-     *
-     * Once Sweep is fully implemented, this will be removed since the objects will be gone
-     * and errors will arise elsewhere in the runtime
-     */
-    usageDetectedInInteractiveClient(errorProps: ITelemetryProperties): void;
-}
-//# sourceMappingURL=gcSweepReadyUsageDetection.d.ts.map

package/dist/gc/gcSweepReadyUsageDetection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"gcSweepReadyUsageDetection.d.ts","sourceRoot":"","sources":["../../src/gc/gcSweepReadyUsageDetection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAEN,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,MAAM,iCAAiC,CAAC;AAGzC;;;GAGG;AACH,eAAO,MAAM,sBAAsB,iFAC4C,CAAC;AAEhF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,sEAC6B,CAAC;AAqBrE;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,YAAa,YAAW,eAAe;IAChF,oHAAoH;IAC7G,SAAS,EAAE,MAAM,CAAiD;CACzE;AAED;;;;;;;GAOG;AACH,qBAAa,+BAA+B;IAI1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO;IALzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuC;gBAGlD,kBAAkB,EAAE,MAAM,EAC1B,EAAE,EAAE,iBAAiB,EACrB,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,EACnE,oBAAoB,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAc5D;;;;;;OAMG;IACI,gCAAgC,CAAC,UAAU,EAAE,oBAAoB;CA+CxE"}

package/dist/gc/gcSweepReadyUsageDetection.js

@@ -1,130 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SweepReadyUsageDetectionHandler = exports.SweepReadyUsageError = exports.closuresMapLocalStorageKey = exports.skipClosureForXDaysKey = void 0;
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
-const gcDefinitions_1 = require("./gcDefinitions");
-/**
- * Feature Gate Key -
- * How many days between closing the container from this error (avoids locking user out of their file altogether)
- */
-exports.skipClosureForXDaysKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays";
-/**
- * LocalStorage key (NOT via feature gate / monitoring context)
- * A map from docId to info about the last time we closed due to this error
- */
-exports.closuresMapLocalStorageKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures";
-/**
- * Feature gate key to enable closing the container if SweepReady objects are used.
- * Value should contain keywords "interactiveClient" and/or "summarizer" to enable detection in each container type
- */
-const sweepReadyUsageDetectionSetting = {
-    read(config) {
-        const sweepReadyUsageDetectionKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection";
-        const value = config.getString(sweepReadyUsageDetectionKey);
-        if (value === undefined) {
-            return { interactiveClient: false, summarizer: false };
-        }
-        return {
-            interactiveClient: value.includes("interactiveClient"),
-            summarizer: value.includes("summarizer"),
-        };
-    },
-};
-/**
- * Error class raised when a SweepReady object is used, indicating a bug in how
- * references are managed in the container by the application, or a bug in how
- * GC tracks those references.
- *
- * There's a chance for false positives when this error is raised by an Interactive Container,
- * since only the Summarizer has the latest truth about unreferenced node tracking
- */
-class SweepReadyUsageError extends telemetry_utils_1.LoggingError {
-    constructor() {
-        super(...arguments);
-        /** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */
-        this.errorType = "unreferencedObjectUsedAfterGarbageCollected";
-    }
-}
-exports.SweepReadyUsageError = SweepReadyUsageError;
-/**
- * This class encapsulates the logic around what to do when a SweepReady object is used.
- * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:
- * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation
- * (via sweepReadyUsageDetectionSetting above)
- * - Throttling the frequency of these crashes via a "Skip Closure Period" per container per device
- * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)
- */
-class SweepReadyUsageDetectionHandler {
-    constructor(uniqueContainerKey, mc, closeFn, localStorageOverride) {
-        var _a;
-        this.uniqueContainerKey = uniqueContainerKey;
-        this.mc = mc;
-        this.closeFn = closeFn;
-        const noopStorage = { getItem: () => null, setItem: () => { } };
-        // localStorage is not defined in Node environment, so fall back to noopStorage if needed.
-        this.localStorage = (_a = localStorageOverride !== null && localStorageOverride !== void 0 ? localStorageOverride : globalThis.localStorage) !== null && _a !== void 0 ? _a : noopStorage;
-        if (this.localStorage === noopStorage) {
-            // This means the Skip Closure Period logic will not work.
-            this.mc.logger.sendTelemetryEvent({
-                eventName: "SweepReadyUsageDetectionHandlerNoopStorage",
-            });
-        }
-    }
-    /**
-     * If SweepReady Usage Detection is enabled, close the interactive container.
-     * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.
-     *
-     * Once Sweep is fully implemented, this will be removed since the objects will be gone
-     * and errors will arise elsewhere in the runtime
-     */
-    usageDetectedInInteractiveClient(errorProps) {
-        var _a;
-        if (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {
-            return;
-        }
-        // Default stance is we close every time - this reflects the severity of SweepReady Object Usage.
-        // However, we may choose to "throttle" the closures by setting the SkipClosureForXDays setting,
-        // which will only allow the container to close once during that period, to avoid locking users out.
-        let shouldClose = true;
-        let pastClosuresMap = {};
-        let lastCloseTime;
-        const skipClosureForXDays = this.mc.config.getNumber(exports.skipClosureForXDaysKey);
-        if (skipClosureForXDays !== undefined) {
-            // Read pastClosuresMap from localStorage then extract the lastCloseTime from the map
-            try {
-                const rawValue = this.localStorage.getItem(exports.closuresMapLocalStorageKey);
-                const parsedValue = rawValue === null ? {} : JSON.parse(rawValue);
-                if (typeof parsedValue === "object") {
-                    pastClosuresMap = parsedValue;
-                }
-            }
-            catch (e) { }
-            lastCloseTime = (_a = pastClosuresMap[this.uniqueContainerKey]) === null || _a === void 0 ? void 0 : _a.lastCloseTime;
-            // Don't close if we did already within the Skip Closure Period
-            if (lastCloseTime !== undefined &&
-                Date.now() < lastCloseTime + skipClosureForXDays * gcDefinitions_1.oneDayMs) {
-                shouldClose = false;
-            }
-        }
-        const error = new SweepReadyUsageError("SweepReady object used in Non-Summarizer Client", {
-            errorDetails: JSON.stringify(Object.assign(Object.assign({}, errorProps), { lastCloseTime, skipClosureForXDays })),
-        });
-        if (shouldClose) {
-            // Update closures map in localStorage before closing
-            // Note there is a race condition between different tabs updating localStorage and overwriting
-            // each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck
-            pastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };
-            this.localStorage.setItem(exports.closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));
-            this.closeFn(error);
-        }
-        else {
-            this.mc.logger.sendErrorEvent({ eventName: "SweepReadyObject_UsageAllowed" }, error);
-        }
-    }
-}
-exports.SweepReadyUsageDetectionHandler = SweepReadyUsageDetectionHandler;
-//# sourceMappingURL=gcSweepReadyUsageDetection.js.map

package/dist/gc/gcSweepReadyUsageDetection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"gcSweepReadyUsageDetection.js","sourceRoot":"","sources":["../../src/gc/gcSweepReadyUsageDetection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,qEAKyC;AACzC,mDAA2C;AAE3C;;;GAGG;AACU,QAAA,sBAAsB,GAClC,8EAA8E,CAAC;AAEhF;;;GAGG;AACU,QAAA,0BAA0B,GACtC,mEAAmE,CAAC;AAErE;;;GAGG;AACH,MAAM,+BAA+B,GAAG;IACvC,IAAI,CAAC,MAAuB;QAC3B,MAAM,2BAA2B,GAChC,0DAA0D,CAAC;QAC5D,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC5D,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;SACvD;QACD,OAAO;YACN,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YACtD,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;SACxC,CAAC;IACH,CAAC;CACD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAa,oBAAqB,SAAQ,8BAAY;IAAtD;;QACC,oHAAoH;QAC7G,cAAS,GAAW,6CAA6C,CAAC;IAC1E,CAAC;CAAA;AAHD,oDAGC;AAED;;;;;;;GAOG;AACH,MAAa,+BAA+B;IAG3C,YACkB,kBAA0B,EAC1B,EAAqB,EACrB,OAAkD,EACnE,oBAA2D;;QAH1C,uBAAkB,GAAlB,kBAAkB,CAAQ;QAC1B,OAAE,GAAF,EAAE,CAAmB;QACrB,YAAO,GAAP,OAAO,CAA2C;QAGnE,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC;QAC/D,0FAA0F;QAC1F,IAAI,CAAC,YAAY,GAAG,MAAA,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,UAAU,CAAC,YAAY,mCAAI,WAAW,CAAC;QAEnF,IAAI,IAAI,CAAC,YAAY,KAAK,WAAW,EAAE;YACtC,0DAA0D;YAC1D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACjC,SAAS,EAAE,4CAA4C;aACvD,CAAC,CAAC;SACH;IACF,CAAC;IAED;;;;;;OAMG;IACI,gCAAgC,CAAC,UAAgC;;QACvE,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE;YAC5E,OAAO;SACP;QAED,iGAAiG;QACjG,gGAAgG;QAChG,oGAAoG;QACpG,IAAI,WAAW,GAAY,IAAI,CAAC;QAChC,IAAI,eAAe,GAA0D,EAAE,CAAC;QAChF,IAAI,aAAiC,CAAC;QACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,8BAAsB,CAAC,CAAC;QAC7E,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACtC,qFAAqF;YACrF,IAAI;gBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,kCAA0B,CAAC,CAAC;gBACvE,MAAM,WAAW,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAClE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;oBACpC,eAAe,GAAG,WAAW,CAAC;iBAC9B;aACD;YAAC,OAAO,CAAC,EAAE,GAAE;YACd,aAAa,GAAG,MAAA,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,0CAAE,aAAa,CAAC;YAExE,+DAA+D;YAC/D,IACC,aAAa,KAAK,SAAS;gBAC3B,IAAI,CAAC,GAAG,EAAE,GAAG,aAAa,GAAG,mBAAmB,GAAG,wBAAQ,EAC1D;gBACD,WAAW,GAAG,KAAK,CAAC;aACpB;SACD;QAED,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAAC,iDAAiD,EAAE;YACzF,YAAY,EAAE,IAAI,CAAC,SAAS,iCAAM,UAAU,KAAE,aAAa,EAAE,mBAAmB,IAAG;SACnF,CAAC,CAAC;QACH,IAAI,WAAW,EAAE;YAChB,qDAAqD;YACrD,8FAA8F;YAC9F,mGAAmG;YACnG,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,kCAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;YAEvF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACpB;aAAM;YACN,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,+BAA+B,EAAE,EAAE,KAAK,CAAC,CAAC;SACrF;IACF,CAAC;CACD;AA3ED,0EA2EC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n\tIConfigProvider,\n\tIFluidErrorBase,\n\tLoggingError,\n\tMonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport { oneDayMs } from \"./gcDefinitions\";\n\n/**\n * Feature Gate Key -\n * How many days between closing the container from this error (avoids locking user out of their file altogether)\n */\nexport const skipClosureForXDaysKey =\n\t\"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays\";\n\n/**\n * LocalStorage key (NOT via feature gate / monitoring context)\n * A map from docId to info about the last time we closed due to this error\n */\nexport const closuresMapLocalStorageKey =\n\t\"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures\";\n\n/**\n * Feature gate key to enable closing the container if SweepReady objects are used.\n * Value should contain keywords \"interactiveClient\" and/or \"summarizer\" to enable detection in each container type\n */\nconst sweepReadyUsageDetectionSetting = {\n\tread(config: IConfigProvider) {\n\t\tconst sweepReadyUsageDetectionKey =\n\t\t\t\"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection\";\n\t\tconst value = config.getString(sweepReadyUsageDetectionKey);\n\t\tif (value === undefined) {\n\t\t\treturn { interactiveClient: false, summarizer: false };\n\t\t}\n\t\treturn {\n\t\t\tinteractiveClient: value.includes(\"interactiveClient\"),\n\t\t\tsummarizer: value.includes(\"summarizer\"),\n\t\t};\n\t},\n};\n\n/**\n * Error class raised when a SweepReady object is used, indicating a bug in how\n * references are managed in the container by the application, or a bug in how\n * GC tracks those references.\n *\n * There's a chance for false positives when this error is raised by an Interactive Container,\n * since only the Summarizer has the latest truth about unreferenced node tracking\n */\nexport class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {\n\t/** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */\n\tpublic errorType: string = \"unreferencedObjectUsedAfterGarbageCollected\";\n}\n\n/**\n * This class encapsulates the logic around what to do when a SweepReady object is used.\n * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:\n * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation\n * (via sweepReadyUsageDetectionSetting above)\n * - Throttling the frequency of these crashes via a \"Skip Closure Period\" per container per device\n * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)\n */\nexport class SweepReadyUsageDetectionHandler {\n\tprivate readonly localStorage: Pick<Storage, \"getItem\" | \"setItem\">;\n\n\tconstructor(\n\t\tprivate readonly uniqueContainerKey: string,\n\t\tprivate readonly mc: MonitoringContext,\n\t\tprivate readonly closeFn: (error?: ICriticalContainerError) => void,\n\t\tlocalStorageOverride?: Pick<Storage, \"getItem\" | \"setItem\">,\n\t) {\n\t\tconst noopStorage = { getItem: () => null, setItem: () => {} };\n\t\t// localStorage is not defined in Node environment, so fall back to noopStorage if needed.\n\t\tthis.localStorage = localStorageOverride ?? globalThis.localStorage ?? noopStorage;\n\n\t\tif (this.localStorage === noopStorage) {\n\t\t\t// This means the Skip Closure Period logic will not work.\n\t\t\tthis.mc.logger.sendTelemetryEvent({\n\t\t\t\teventName: \"SweepReadyUsageDetectionHandlerNoopStorage\",\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * If SweepReady Usage Detection is enabled, close the interactive container.\n\t * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.\n\t *\n\t * Once Sweep is fully implemented, this will be removed since the objects will be gone\n\t * and errors will arise elsewhere in the runtime\n\t */\n\tpublic usageDetectedInInteractiveClient(errorProps: ITelemetryProperties) {\n\t\tif (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Default stance is we close every time - this reflects the severity of SweepReady Object Usage.\n\t\t// However, we may choose to \"throttle\" the closures by setting the SkipClosureForXDays setting,\n\t\t// which will only allow the container to close once during that period, to avoid locking users out.\n\t\tlet shouldClose: boolean = true;\n\t\tlet pastClosuresMap: Record<string, { lastCloseTime: number } | undefined> = {};\n\t\tlet lastCloseTime: number | undefined;\n\t\tconst skipClosureForXDays = this.mc.config.getNumber(skipClosureForXDaysKey);\n\t\tif (skipClosureForXDays !== undefined) {\n\t\t\t// Read pastClosuresMap from localStorage then extract the lastCloseTime from the map\n\t\t\ttry {\n\t\t\t\tconst rawValue = this.localStorage.getItem(closuresMapLocalStorageKey);\n\t\t\t\tconst parsedValue = rawValue === null ? {} : JSON.parse(rawValue);\n\t\t\t\tif (typeof parsedValue === \"object\") {\n\t\t\t\t\tpastClosuresMap = parsedValue;\n\t\t\t\t}\n\t\t\t} catch (e) {}\n\t\t\tlastCloseTime = pastClosuresMap[this.uniqueContainerKey]?.lastCloseTime;\n\n\t\t\t// Don't close if we did already within the Skip Closure Period\n\t\t\tif (\n\t\t\t\tlastCloseTime !== undefined &&\n\t\t\t\tDate.now() < lastCloseTime + skipClosureForXDays * oneDayMs\n\t\t\t) {\n\t\t\t\tshouldClose = false;\n\t\t\t}\n\t\t}\n\n\t\tconst error = new SweepReadyUsageError(\"SweepReady object used in Non-Summarizer Client\", {\n\t\t\terrorDetails: JSON.stringify({ ...errorProps, lastCloseTime, skipClosureForXDays }),\n\t\t});\n\t\tif (shouldClose) {\n\t\t\t// Update closures map in localStorage before closing\n\t\t\t// Note there is a race condition between different tabs updating localStorage and overwriting\n\t\t\t// each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck\n\t\t\tpastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };\n\t\t\tthis.localStorage.setItem(closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));\n\n\t\t\tthis.closeFn(error);\n\t\t} else {\n\t\t\tthis.mc.logger.sendErrorEvent({ eventName: \"SweepReadyObject_UsageAllowed\" }, error);\n\t\t}\n\t}\n}\n"]}