@fluidframework/container-runtime 2.0.0-dev.4.4.0.161652 → 2.0.0-dev.4.4.0.162089

package/lib/gc/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gc/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACN,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,EAC9B,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,+BAA+B,EAC/B,2BAA2B,EAG3B,uBAAuB,EASvB,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,iBAAiB,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACN,WAAW,EACX,6BAA6B,EAC7B,qBAAqB,EACrB,iCAAiC,EACjC,kBAAkB,EAClB,6BAA6B,EAC7B,yBAAyB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAOnE,OAAO,EACN,cAAc,EACd,qBAAqB,GAErB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,sBAAsB,EACtB,0BAA0B,EAC1B,+BAA+B,GAC/B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { GarbageCollector } from \"./garbageCollection\";\nexport {\n\tcurrentGCVersion,\n\tdefaultInactiveTimeoutMs,\n\tdefaultSessionExpiryDurationMs,\n\tdisableSweepLogKey,\n\tGCNodeType,\n\tgcTestModeKey,\n\tgcTombstoneGenerationOptionName,\n\tgcSweepGenerationOptionName,\n\tGCFeatureMatrix,\n\tGCVersion,\n\tgcVersionUpgradeToV3Key,\n\tIGarbageCollectionRuntime,\n\tIGarbageCollector,\n\tIGarbageCollectorConfigs,\n\tIGarbageCollectorCreateParams,\n\tIGCMetadata,\n\tIGCResult,\n\tIGCRuntimeOptions,\n\tIGCStats,\n\toneDayMs,\n\trunGCKey,\n\trunSessionExpiryKey,\n\trunSweepKey,\n\tstableGCVersion,\n\tsweepAttachmentBlobsKey,\n\tsweepDatastoresKey,\n\tthrowOnTombstoneLoadKey,\n\tthrowOnTombstoneUsageKey,\n\tUnreferencedState,\n} from \"./gcDefinitions\";\nexport {\n\tcloneGCData,\n\tconcatGarbageCollectionStates,\n\tgetGCDataFromSnapshot,\n\tshouldAllowGcTombstoneEnforcement,\n\tshouldAllowGcSweep,\n\ttrimLeadingAndTrailingSlashes,\n\tunpackChildNodesGCDetails,\n} from \"./gcHelpers\";\nexport { runGarbageCollection } from \"./gcReferenceGraphAlgorithm\";\nexport {\n\tIGarbageCollectionNodeData,\n\tIGarbageCollectionSnapshotData,\n\tIGarbageCollectionState,\n\tIGarbageCollectionSummaryDetailsLegacy,\n} from \"./gcSummaryDefinitions\";\nexport {\n\tgcStateBlobKey,\n\tGCSummaryStateTracker,\n\tIGCSummaryTrackingData,\n} from \"./gcSummaryStateTracker\";\nexport {\n\tskipClosureForXDaysKey,\n\tclosuresMapLocalStorageKey,\n\tSweepReadyUsageDetectionHandler,\n} from \"./gcSweepReadyUsageDetection\";\nexport { GCTelemetryTracker, sendGCUnexpectedUsageEvent } from \"./gcTelemetry\";\nexport { UnreferencedStateTracker } from \"./gcUnreferencedStateTracker\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gc/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACN,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,EAC9B,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,+BAA+B,EAC/B,2BAA2B,EAG3B,uBAAuB,EASvB,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,iBAAiB,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACN,WAAW,EACX,6BAA6B,EAC7B,qBAAqB,EACrB,iCAAiC,EACjC,kBAAkB,EAClB,6BAA6B,EAC7B,yBAAyB,EACzB,iBAAiB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAOnE,OAAO,EACN,cAAc,EACd,qBAAqB,GAErB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { GarbageCollector } from \"./garbageCollection\";\nexport {\n\tcurrentGCVersion,\n\tdefaultInactiveTimeoutMs,\n\tdefaultSessionExpiryDurationMs,\n\tdisableSweepLogKey,\n\tGCNodeType,\n\tgcTestModeKey,\n\tgcTombstoneGenerationOptionName,\n\tgcSweepGenerationOptionName,\n\tGCFeatureMatrix,\n\tGCVersion,\n\tgcVersionUpgradeToV3Key,\n\tIGarbageCollectionRuntime,\n\tIGarbageCollector,\n\tIGarbageCollectorConfigs,\n\tIGarbageCollectorCreateParams,\n\tIGCMetadata,\n\tIGCResult,\n\tIGCRuntimeOptions,\n\tIGCStats,\n\toneDayMs,\n\trunGCKey,\n\trunSessionExpiryKey,\n\trunSweepKey,\n\tstableGCVersion,\n\tsweepAttachmentBlobsKey,\n\tsweepDatastoresKey,\n\tthrowOnTombstoneLoadKey,\n\tthrowOnTombstoneUsageKey,\n\tUnreferencedState,\n} from \"./gcDefinitions\";\nexport {\n\tcloneGCData,\n\tconcatGarbageCollectionStates,\n\tgetGCDataFromSnapshot,\n\tshouldAllowGcTombstoneEnforcement,\n\tshouldAllowGcSweep,\n\ttrimLeadingAndTrailingSlashes,\n\tunpackChildNodesGCDetails,\n\ttagAsCodeArtifact,\n} from \"./gcHelpers\";\nexport { runGarbageCollection } from \"./gcReferenceGraphAlgorithm\";\nexport {\n\tIGarbageCollectionNodeData,\n\tIGarbageCollectionSnapshotData,\n\tIGarbageCollectionState,\n\tIGarbageCollectionSummaryDetailsLegacy,\n} from \"./gcSummaryDefinitions\";\nexport {\n\tgcStateBlobKey,\n\tGCSummaryStateTracker,\n\tIGCSummaryTrackingData,\n} from \"./gcSummaryStateTracker\";\nexport { GCTelemetryTracker, sendGCUnexpectedUsageEvent } from \"./gcTelemetry\";\nexport { UnreferencedStateTracker } from \"./gcUnreferencedStateTracker\";\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/container-runtime";
-export declare const pkgVersion = "2.0.0-dev.4.4.0.161652";
+export declare const pkgVersion = "2.0.0-dev.4.4.0.162089";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.0.0-dev.4.4.0.161652";
+export const pkgVersion = "2.0.0-dev.4.4.0.162089";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,mCAAmC,CAAC;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-runtime\";\nexport const pkgVersion = \"2.0.0-dev.4.4.0.161652\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,mCAAmC,CAAC;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-runtime\";\nexport const pkgVersion = \"2.0.0-dev.4.4.0.162089\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "2.0.0-dev.4.4.0.161652",
+  "version": "2.0.0-dev.4.4.0.162089",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,19 +37,19 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-definitions": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/container-utils": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/core-interfaces": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/datastore": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/driver-definitions": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/driver-utils": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/garbage-collector": "2.0.0-dev.4.4.0.161652",
+    "@fluidframework/container-definitions": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/container-utils": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/core-interfaces": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/datastore": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/driver-utils": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/garbage-collector": "2.0.0-dev.4.4.0.162089",
     "@fluidframework/protocol-base": "^0.1039.1000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/runtime-utils": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.4.4.0.161652",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/runtime-utils": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.4.4.0.162089",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
     "lz4js": "^0.2.0",
@@ -57,15 +57,15 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/stochastic-test-utils": "2.0.0-dev.4.4.0.161652",
+    "@fluid-internal/stochastic-test-utils": "2.0.0-dev.4.4.0.162089",
     "@fluid-tools/benchmark": "^0.46.0",
     "@fluid-tools/build-cli": "^0.17.0",
     "@fluidframework/build-common": "^1.1.0",
     "@fluidframework/build-tools": "^0.17.0",
     "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.0.0-internal.4.1.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.4.0.161652",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev.4.4.0.161652",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.4.0.162089",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.4.4.0.162089",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",

package/src/containerRuntime.ts

@@ -2791,7 +2791,7 @@ export class ContainerRuntime
 			const summaryStats: IGeneratedSummaryStats = {
 				dataStoreCount: this.dataStores.size,
 				summarizedDataStoreCount: this.dataStores.size - handleCount,
-				gcStateUpdatedDataStoreCount: summarizeResult.gcStats?.updatedDataStoreCount,
+				gcStateUpdatedDataStoreCount: this.garbageCollector.updatedDSCountSinceLastSummary,
 				gcBlobNodeCount: gcSummaryTreeStats?.blobNodeCount,
 				gcTotalBlobsSize: gcSummaryTreeStats?.totalBlobSize,
 				summaryNumber,

package/src/gc/garbageCollection.ts

@@ -121,6 +121,11 @@ export class GarbageCollector implements IGarbageCollector {
 		return this.summaryStateTracker.doesSummaryStateNeedReset;
 	}
 
+	/** Returns the count of data stores whose GC state updated since the last summary. */
+	public get updatedDSCountSinceLastSummary(): number {
+		return this.summaryStateTracker.updatedDSCountSinceLastSummary;
+	}
+
 	protected constructor(createParams: IGarbageCollectorCreateParams) {
 		this.runtime = createParams.runtime;
 		this.isSummarizerClient = createParams.isSummarizerClient;
@@ -505,6 +510,8 @@ export class GarbageCollector implements IGarbageCollector {
 				// updates its state so that we don't send false positives based on intermediate state. For example, we may get
 				// reference to an unreferenced node from another unreferenced node which means the node wasn't revived.
 				await this.telemetryTracker.logPendingEvents(logger);
+				// Update the state of summary state tracker from this run's stats.
+				this.summaryStateTracker.updateStateFromGCRunStats(gcStats);
 				this.newReferencesSinceLastRun.clear();
 				this.completedRuns++;
 
@@ -884,7 +891,7 @@ export class GarbageCollector implements IGarbageCollector {
 		}
 
 		this.telemetryTracker.nodeUsed({
-			nodeId: nodePath,
+			id: nodePath,
 			usageType: reason,
 			currentReferenceTimestampMs:
 				timestampMs ?? this.runtime.getCurrentReferenceTimestampMs(),
@@ -913,7 +920,7 @@ export class GarbageCollector implements IGarbageCollector {
 		this.newReferencesSinceLastRun.set(fromNodePath, outboundRoutes);
 
 		this.telemetryTracker.nodeUsed({
-			nodeId: toNodePath,
+			id: toNodePath,
 			usageType: "Revived",
 			currentReferenceTimestampMs: this.runtime.getCurrentReferenceTimestampMs(),
 			packagePath: undefined,

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,
@@ -303,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 ".";
@@ -50,6 +50,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<
@@ -286,6 +290,7 @@ export class GCSummaryStateTracker {
 			this.latestSummaryGCVersion = this.currentGCVersion;
 			this.latestSummaryData = this.pendingSummaryData;
 			this.pendingSummaryData = undefined;
+			this.updatedDSCountSinceLastSummary = 0;
 			return 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-dev.4.4.0.161652";
+export const pkgVersion = "2.0.0-dev.4.4.0.162089";

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