@fluidframework/shared-object-base 2.32.0 → 2.33.0

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAI5E;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAC/B,KAAc,EACd,UAA4B,EAC5B,IAAkB;IAElB,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CACtC,KAAc,EACd,UAA4B,EAC5B,IAAkB;IAElB,OAAO,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,UAA4B;IACxE,OAAO,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACtC,GAAW,EACX,OAA4B;IAE5B,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACzC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAC1B,KAAc,EACd,UAA4B,EAC5B,IAAkB;IAElB,sEAAsE;IACtE,0EAA0E;IAC1E,4EAA4E;IAC5E,sEAAsE;IACtE,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAChC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport type { IChannel } from \"@fluidframework/datastore-definitions/internal\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions/internal\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport { IFluidSerializer } from \"./serializer.js\";\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object\n * where the handle objects have been replaced with a serializable form.\n * @param value - The mostly-plain object\n * @param serializer - The serializer that knows how to convert handles into serializable format\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns Result of strigifying an object\n * @internal\n */\nexport function serializeHandles(\n\tvalue: unknown,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n): string | undefined {\n\treturn value === undefined ? value : serializer.stringify(value, bind);\n}\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n * where any embedded IFluidHandles have been replaced with a serializable form.\n *\n * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n * the root to any replaced handles.  (If no handles are found, returns the original object.)\n *\n * @param input - The mostly-plain object\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns The fully-plain object\n * @legacy\n * @alpha\n */\nexport function makeHandlesSerializable(\n\tvalue: unknown,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n): unknown {\n\treturn serializer.encode(value, bind);\n}\n\n/**\n * Given a fully-plain object that may have serializable-form handles within, will return the mostly-plain object\n * with handle objects created instead.\n * @remarks Idempotent when called multiple times.\n * @param value - The fully-plain object\n * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects\n * @param context - The handle context for the container\n * @returns The mostly-plain object with handle objects within\n * @legacy\n * @alpha\n */\nexport function parseHandles(value: unknown, serializer: IFluidSerializer): unknown {\n\treturn serializer.decode(value);\n}\n\n/**\n * Create a new summary containing one blob\n * @param key - the key for the blob in the summary\n * @param content - blob content\n * @returns The summary containing the blob\n * @internal\n */\nexport function createSingleBlobSummary(\n\tkey: string,\n\tcontent: string | Uint8Array,\n): ISummaryTreeWithStats {\n\tconst builder = new SummaryTreeBuilder();\n\tbuilder.addBlob(key, content);\n\treturn builder.getSummaryTree();\n}\n\n/**\n * Binds all handles found in `value` to `bind`. Does not modify original input.\n *\n * @internal\n */\nexport function bindHandles(\n\tvalue: unknown,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n): void {\n\t// N.B. AB#7316 this could be made more efficient by writing an ad hoc\n\t// implementation that doesn't clone at all. Today the distinction between\n\t// this function and `encode` is purely semantic -- encoding both serializes\n\t// handles and binds them, but sometimes we only wish to do the latter\n\tserializer.encode(value, bind);\n}\n\n/**\n * Information about a Fluid channel.\n * @privateRemarks\n * This is distinct from {@link IChannel} as it omits the APIs used by the runtime to manage the channel and instead only has things which are useful (and safe) to expose to users of the channel.\n * @internal\n */\nexport type IChannelView = Pick<IChannel, \"id\" | \"attributes\" | \"isAttached\">;\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAI5E;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAC/B,KAAc,EACd,UAA4B,EAC5B,IAAkB;IAElB,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CACtC,KAAc,EACd,UAA4B,EAC5B,IAAkB;IAElB,OAAO,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,UAA4B;IACxE,OAAO,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACtC,GAAW,EACX,OAA4B;IAE5B,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACzC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAC1B,KAAQ,EACR,UAA4B,EAC5B,IAAkB;IAElB,sEAAsE;IACtE,0EAA0E;IAC1E,4EAA4E;IAC5E,sEAAsE;IACtE,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE/B,wFAAwF;IACxF,OAAO,KAAK,CAAC;AACd,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport type { IChannel } from \"@fluidframework/datastore-definitions/internal\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions/internal\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport { IFluidSerializer } from \"./serializer.js\";\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object\n * where the handle objects have been replaced with a serializable form.\n * @param value - The mostly-plain object\n * @param serializer - The serializer that knows how to convert handles into serializable format\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns Result of strigifying an object\n * @internal\n */\nexport function serializeHandles(\n\tvalue: unknown,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n): string | undefined {\n\treturn value === undefined ? value : serializer.stringify(value, bind);\n}\n\n/**\n * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n * where any embedded IFluidHandles have been replaced with a serializable form.\n *\n * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n * the root to any replaced handles.  (If no handles are found, returns the original object.)\n *\n * @param input - The mostly-plain object\n * @param context - The handle context for the container\n * @param bind - Bind any other handles we find in the object against this given handle.\n * @returns The fully-plain object\n * @legacy\n * @alpha\n */\nexport function makeHandlesSerializable(\n\tvalue: unknown,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n): unknown {\n\treturn serializer.encode(value, bind);\n}\n\n/**\n * Given a fully-plain object that may have serializable-form handles within, will return the mostly-plain object\n * with handle objects created instead.\n * @remarks Idempotent when called multiple times.\n * @param value - The fully-plain object\n * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects\n * @param context - The handle context for the container\n * @returns The mostly-plain object with handle objects within\n * @legacy\n * @alpha\n */\nexport function parseHandles(value: unknown, serializer: IFluidSerializer): unknown {\n\treturn serializer.decode(value);\n}\n\n/**\n * Create a new summary containing one blob\n * @param key - the key for the blob in the summary\n * @param content - blob content\n * @returns The summary containing the blob\n * @internal\n */\nexport function createSingleBlobSummary(\n\tkey: string,\n\tcontent: string | Uint8Array,\n): ISummaryTreeWithStats {\n\tconst builder = new SummaryTreeBuilder();\n\tbuilder.addBlob(key, content);\n\treturn builder.getSummaryTree();\n}\n\n/**\n * Binds all handles found in `value` to `bind`. Does not modify original input.\n *\n * @internal\n */\nexport function bindHandles<T = unknown>(\n\tvalue: T,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n): T {\n\t// N.B. AB#7316 this could be made more efficient by writing an ad hoc\n\t// implementation that doesn't clone at all. Today the distinction between\n\t// this function and `encode` is purely semantic -- encoding both serializes\n\t// handles and binds them, but sometimes we only wish to do the latter\n\tserializer.encode(value, bind);\n\n\t// Return the input value so this function can be swapped in for makeHandlesSerializable\n\treturn value;\n}\n\n/**\n * Information about a Fluid channel.\n * @privateRemarks\n * This is distinct from {@link IChannel} as it omits the APIs used by the runtime to manage the channel and instead only has things which are useful (and safe) to expose to users of the channel.\n * @internal\n */\nexport type IChannelView = Pick<IChannel, \"id\" | \"attributes\" | \"isAttached\">;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/shared-object-base",
-  "version": "2.32.0",
+  "version": "2.33.0",
   "description": "Fluid base class for shared distributed data structures",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,33 +69,34 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.32.0",
-    "@fluidframework/container-definitions": "~2.32.0",
-    "@fluidframework/core-interfaces": "~2.32.0",
-    "@fluidframework/core-utils": "~2.32.0",
-    "@fluidframework/datastore": "~2.32.0",
-    "@fluidframework/datastore-definitions": "~2.32.0",
-    "@fluidframework/driver-definitions": "~2.32.0",
-    "@fluidframework/runtime-definitions": "~2.32.0",
-    "@fluidframework/runtime-utils": "~2.32.0",
-    "@fluidframework/telemetry-utils": "~2.32.0",
+    "@fluid-internal/client-utils": "~2.33.0",
+    "@fluidframework/container-definitions": "~2.33.0",
+    "@fluidframework/core-interfaces": "~2.33.0",
+    "@fluidframework/core-utils": "~2.33.0",
+    "@fluidframework/datastore": "~2.33.0",
+    "@fluidframework/datastore-definitions": "~2.33.0",
+    "@fluidframework/driver-definitions": "~2.33.0",
+    "@fluidframework/runtime-definitions": "~2.33.0",
+    "@fluidframework/runtime-utils": "~2.33.0",
+    "@fluidframework/telemetry-utils": "~2.33.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.32.0",
-    "@fluid-private/test-pairwise-generator": "~2.32.0",
+    "@fluid-internal/mocha-test-setup": "~2.33.0",
+    "@fluid-private/test-pairwise-generator": "~2.33.0",
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
     "@fluidframework/eslint-config-fluid": "^5.7.3",
-    "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@2.31.0",
-    "@fluidframework/test-runtime-utils": "~2.32.0",
-    "@microsoft/api-extractor": "7.50.1",
+    "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@2.32.0",
+    "@fluidframework/test-runtime-utils": "~2.33.0",
+    "@microsoft/api-extractor": "7.52.5",
     "@types/benchmark": "^2.1.0",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
+    "@types/sinon": "^17.0.3",
     "@types/uuid": "^9.0.2",
     "benchmark": "^2.1.4",
     "c8": "^8.0.1",
@@ -105,9 +106,8 @@
     "eslint": "~8.55.0",
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
-    "moment": "^2.21.0",
-    "replace-in-file": "^6.3.5",
     "rimraf": "^4.4.0",
+    "sinon": "^18.0.1",
     "ts-node": "^10.9.1",
     "typescript": "~5.4.5"
   },

package/src/gcHandleVisitor.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
+import { type ISerializedHandle } from "@fluidframework/runtime-utils/internal";
+
+import { FluidSerializer } from "./serializer.js";
+
+/**
+ * Implementation of IFluidSerializer used by GC to visit all the handles in the DDS to collect its outbound routes
+ *
+ * @remarks - This is given to DDS code that typically produces a serialization of the data, which is then ignored.
+ * All that is needed is getSerializedRoutes() to get the routes. This strategy could be optimized if needed.
+ */
+export class GCHandleVisitor extends FluidSerializer {
+	private readonly visitedHandlePaths: Set<string> = new Set();
+	public getVisitedHandlePaths(): string[] {
+		return [...this.visitedHandlePaths];
+	}
+
+	protected bindAndEncodeHandle(
+		handle: IFluidHandleInternal,
+		bind: IFluidHandleInternal,
+	): ISerializedHandle {
+		this.visitedHandlePaths.add(handle.absolutePath);
+
+		// Just return a dummy value. The serialization itself is not used.
+		// It's especially important we don't bind since that has side effects that are irrelevant to GC.
+		return {
+			type: "__fluid_handle__",
+			url: "UNUSED (see GCHandleVisitor)",
+		};
+	}
+}

package/src/handle.ts

@@ -3,8 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
+import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
 import { FluidObjectHandle } from "@fluidframework/datastore/internal";
+// eslint-disable-next-line import/no-deprecated
+import type { IFluidDataStoreRuntimeExperimental } from "@fluidframework/datastore-definitions/internal";
 
 import { ISharedObject } from "./types.js";
 
@@ -37,9 +39,10 @@ export class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {
 	constructor(
 		protected readonly value: ISharedObject,
 		path: string,
-		routeContext: IFluidHandleContext,
+		// eslint-disable-next-line import/no-deprecated
+		private readonly runtime: IFluidDataStoreRuntimeExperimental,
 	) {
-		super(value, path, routeContext);
+		super(value, path, runtime.IFluidHandleContext);
 	}
 
 	/**
@@ -50,4 +53,13 @@ export class SharedObjectHandle extends FluidObjectHandle<ISharedObject> {
 		this.value.bindToContext();
 		super.attachGraph();
 	}
+
+	public bind(handle: IFluidHandleInternal): void {
+		// We don't bind handles in staging mode to defer the attachment of any new objects
+		// until we've exited staging mode. This way if we discard changes or a new handle is not present in the final
+		// committed state, we will never end up attaching the discarded object.
+		if (this.runtime.inStagingMode !== true) {
+			super.bind(handle);
+		}
+	}
 }

package/src/index.ts

@@ -11,7 +11,6 @@ export {
 	SharedObjectKind,
 	createSharedObjectKind,
 } from "./sharedObject.js";
-export { SummarySerializer } from "./summarySerializer.js";
 export { ISharedObject, ISharedObjectEvents } from "./types.js";
 export {
 	createSingleBlobSummary,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "2.32.0";
+export const pkgVersion = "2.33.0";

package/src/serializer.ts

@@ -88,7 +88,7 @@ export class FluidSerializer implements IFluidSerializer {
 		// return the result of 'recursivelyReplace()'.
 		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
 		return !!input && typeof input === "object"
-			? this.recursivelyReplace(input, this.encodeValue, bind)
+			? this.recursivelyReplace(input, this.encodeValue.bind(this), bind)
 			: input;
 	}
 
@@ -106,7 +106,7 @@ export class FluidSerializer implements IFluidSerializer {
 		// return the result of 'recursivelyReplace()'.
 		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
 		return !!input && typeof input === "object"
-			? this.recursivelyReplace(input, this.decodeValue)
+			? this.recursivelyReplace(input, this.decodeValue.bind(this))
 			: input;
 	}
 
@@ -131,20 +131,20 @@ export class FluidSerializer implements IFluidSerializer {
 	 * If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.
 	 * Otherwise returns the original 'value'.  Used by 'encode()' and 'stringify()'.
 	 */
-	private readonly encodeValue = (value: unknown, bind?: IFluidHandleInternal): unknown => {
+	protected encodeValue(value: unknown, bind?: IFluidHandleInternal): unknown {
 		// If 'value' is an IFluidHandle return its encoded form.
 		if (isFluidHandle(value)) {
 			assert(bind !== undefined, 0xa93 /* Cannot encode a handle without a bind context */);
 			return this.bindAndEncodeHandle(toFluidHandleInternal(value), bind);
 		}
 		return value;
-	};
+	}
 
 	/**
 	 * If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.
 	 * Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.
 	 */
-	private readonly decodeValue = (value: unknown): unknown => {
+	protected decodeValue(value: unknown): unknown {
 		// If 'value' is a serialized IFluidHandle return the deserialized result.
 		if (isSerializedHandle(value)) {
 			// Old documents may have handles with relative path in their summaries. Convert these to absolute
@@ -153,11 +153,15 @@ export class FluidSerializer implements IFluidSerializer {
 				? value.url
 				: generateHandleContextPath(value.url, this.context);
 
-			return new RemoteFluidObjectHandle(absolutePath, this.root);
+			return new RemoteFluidObjectHandle(
+				absolutePath,
+				this.root,
+				value.payloadPending === true,
+			);
 		} else {
 			return value;
 		}
-	};
+	}
 
 	/**
 	 * Invoked for non-null objects to recursively replace references to IFluidHandles.

package/src/sharedObject.ts

@@ -20,6 +20,7 @@ import {
 	type IChannelFactory,
 	IFluidDataStoreRuntime,
 	type IDeltaHandler,
+	type IFluidDataStoreRuntimeInternalConfig,
 } from "@fluidframework/datastore-definitions/internal";
 import {
 	type IDocumentMessage,
@@ -53,11 +54,11 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
 
+import { GCHandleVisitor } from "./gcHandleVisitor.js";
 import { SharedObjectHandle } from "./handle.js";
 import { FluidSerializer, IFluidSerializer } from "./serializer.js";
-import { SummarySerializer } from "./summarySerializer.js";
 import { ISharedObject, ISharedObjectEvents } from "./types.js";
-import { makeHandlesSerializable, parseHandles } from "./utils.js";
+import { bindHandles, makeHandlesSerializable, parseHandles } from "./utils.js";
 
 /**
  * Custom telemetry properties used in {@link SharedObjectCore} to instantiate {@link TelemetryEventBatcher} class.
@@ -144,7 +145,7 @@ export abstract class SharedObjectCore<
 
 		assert(!id.includes("/"), 0x304 /* Id cannot contain slashes */);
 
-		this.handle = new SharedObjectHandle(this, id, runtime.IFluidHandleContext);
+		this.handle = new SharedObjectHandle(this, id, runtime);
 
 		this.logger = createChildLogger({
 			logger: runtime.logger,
@@ -459,8 +460,13 @@ export abstract class SharedObjectCore<
 		this.verifyNotClosed();
 		if (this.isAttached()) {
 			// NOTE: We may also be encoding in the ContainerRuntime layer.
-			// Once the layer-compat window passes we can stop encoding here and only bind
-			const contentToSubmit = makeHandlesSerializable(content, this.serializer, this.handle);
+			// Once the layer-compat window passes we can remove the encoding codepath here altogether
+			const onlyBind =
+				(this.runtime as IFluidDataStoreRuntimeInternalConfig)
+					.submitMessagesWithoutEncodingHandles === true;
+			const contentToSubmit = onlyBind
+				? bindHandles(content, this.serializer, this.handle)
+				: makeHandlesSerializable(content, this.serializer, this.handle);
 
 			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 			this.services!.deltaConnection.submit(contentToSubmit, localOpMetadata);
@@ -743,10 +749,10 @@ export abstract class SharedObject<
 
 	protected get serializer(): IFluidSerializer {
 		/**
-		 * During garbage collection, the SummarySerializer keeps track of IFluidHandles that are serialized. These
+		 * During garbage collection, the GCHandleVisitor "serializer" keeps track of IFluidHandles that are serialized. These
 		 * handles represent references to other Fluid objects.
 		 *
-		 * This is fine for now. However, if we implement delay loading in DDss, they may load and de-serialize content
+		 * This is fine for now. However, if we implement delay loading in DDSes, they may load and de-serialize content
 		 * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.
 		 */
 		assert(
@@ -825,8 +831,7 @@ export abstract class SharedObject<
 	 * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}
 	 */
 	public getGCData(fullGC: boolean = false): IGarbageCollectionData {
-		// Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles
-		// in this object's data.
+		// Set _isGCing to true. This flag is used to ensure that we only use GCHandleVisitor in this codepath and not when trying to truly serialize.
 		assert(
 			!this._isGCing,
 			0x078 /* "Possible re-entrancy! Summary should not already be in progress." */,
@@ -835,11 +840,11 @@ export abstract class SharedObject<
 
 		let gcData: IGarbageCollectionData;
 		try {
-			const serializer = new SummarySerializer(this.runtime.channelsRoutingContext);
-			this.processGCDataCore(serializer);
+			const handleVisitor = new GCHandleVisitor(this.runtime.channelsRoutingContext);
+			this.processGCDataCore(handleVisitor);
 			// The GC data for this shared object contains a single GC node. The outbound routes of this node are the
 			// routes of handles serialized during summarization.
-			gcData = { gcNodes: { "/": serializer.getSerializedRoutes() } };
+			gcData = { gcNodes: { "/": handleVisitor.getVisitedHandlePaths() } };
 			assert(
 				this._isGCing,
 				0x079 /* "Possible re-entrancy! Summary should have been in progress." */,
@@ -854,6 +859,12 @@ export abstract class SharedObject<
 	/**
 	 * Calls the serializer over all data in this object that reference other GC nodes.
 	 * Derived classes must override this to provide custom list of references to other GC nodes.
+	 *
+	 * @remarks Serialization itself doesn't matter (the result is ignored). We're tapping into the serialization infrastructure
+	 * as a way to visit all the content in this content that may reference other objects via handle.
+	 *
+	 * @param serializer - The "serializer" (more like handle visitor) to use.
+	 * Implementations should ensure that serialize is called on all handles, as the way to visit them.
 	 */
 	protected processGCDataCore(serializer: IFluidSerializer): void {
 		// We run the full summarize logic to get the list of outbound routes from this object. This is a little

package/src/utils.ts

@@ -86,16 +86,19 @@ export function createSingleBlobSummary(
  *
  * @internal
  */
-export function bindHandles(
-	value: unknown,
+export function bindHandles<T = unknown>(
+	value: T,
 	serializer: IFluidSerializer,
 	bind: IFluidHandle,
-): void {
+): T {
 	// N.B. AB#7316 this could be made more efficient by writing an ad hoc
 	// implementation that doesn't clone at all. Today the distinction between
 	// this function and `encode` is purely semantic -- encoding both serializes
 	// handles and binds them, but sometimes we only wish to do the latter
 	serializer.encode(value, bind);
+
+	// Return the input value so this function can be swapped in for makeHandlesSerializable
+	return value;
 }
 
 /**

package/dist/summarySerializer.d.ts

@@ -1,17 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
-import type { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
-import { FluidSerializer } from "./serializer.js";
-/**
- * Serializer implementation for serializing handles during summary.
- * @internal
- */
-export declare class SummarySerializer extends FluidSerializer {
-    private readonly serializedRoutes;
-    getSerializedRoutes(): string[];
-    protected bindAndEncodeHandle(handle: IFluidHandleInternal, bind: IFluidHandleInternal): ISerializedHandle;
-}
-//# sourceMappingURL=summarySerializer.d.ts.map

package/dist/summarySerializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarySerializer.d.ts","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACrD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA0B;IACpD,mBAAmB,IAAI,MAAM,EAAE;IAItC,SAAS,CAAC,mBAAmB,CAC5B,MAAM,EAAE,oBAAoB,EAC5B,IAAI,EAAE,oBAAoB,GACxB,iBAAiB;CAIpB"}

package/dist/summarySerializer.js

@@ -1,27 +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.SummarySerializer = void 0;
-const serializer_js_1 = require("./serializer.js");
-/**
- * Serializer implementation for serializing handles during summary.
- * @internal
- */
-class SummarySerializer extends serializer_js_1.FluidSerializer {
-    constructor() {
-        super(...arguments);
-        this.serializedRoutes = new Set();
-    }
-    getSerializedRoutes() {
-        return [...this.serializedRoutes];
-    }
-    bindAndEncodeHandle(handle, bind) {
-        this.serializedRoutes.add(handle.absolutePath);
-        return super.bindAndEncodeHandle(handle, bind);
-    }
-}
-exports.SummarySerializer = SummarySerializer;
-//# sourceMappingURL=summarySerializer.js.map

package/dist/summarySerializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarySerializer.js","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,mDAAkD;AAElD;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,+BAAe;IAAtD;;QACkB,qBAAgB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAY5D,CAAC;IAXO,mBAAmB;QACzB,OAAO,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACnC,CAAC;IAES,mBAAmB,CAC5B,MAA4B,EAC5B,IAA0B;QAE1B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;CACD;AAbD,8CAaC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IFluidHandleInternal } from \"@fluidframework/core-interfaces/internal\";\nimport type { ISerializedHandle } from \"@fluidframework/runtime-utils/internal\";\n\nimport { FluidSerializer } from \"./serializer.js\";\n\n/**\n * Serializer implementation for serializing handles during summary.\n * @internal\n */\nexport class SummarySerializer extends FluidSerializer {\n\tprivate readonly serializedRoutes: Set<string> = new Set();\n\tpublic getSerializedRoutes(): string[] {\n\t\treturn [...this.serializedRoutes];\n\t}\n\n\tprotected bindAndEncodeHandle(\n\t\thandle: IFluidHandleInternal,\n\t\tbind: IFluidHandleInternal,\n\t): ISerializedHandle {\n\t\tthis.serializedRoutes.add(handle.absolutePath);\n\t\treturn super.bindAndEncodeHandle(handle, bind);\n\t}\n}\n"]}

package/lib/summarySerializer.d.ts

@@ -1,17 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
-import type { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
-import { FluidSerializer } from "./serializer.js";
-/**
- * Serializer implementation for serializing handles during summary.
- * @internal
- */
-export declare class SummarySerializer extends FluidSerializer {
-    private readonly serializedRoutes;
-    getSerializedRoutes(): string[];
-    protected bindAndEncodeHandle(handle: IFluidHandleInternal, bind: IFluidHandleInternal): ISerializedHandle;
-}
-//# sourceMappingURL=summarySerializer.d.ts.map

package/lib/summarySerializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarySerializer.d.ts","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACrD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA0B;IACpD,mBAAmB,IAAI,MAAM,EAAE;IAItC,SAAS,CAAC,mBAAmB,CAC5B,MAAM,EAAE,oBAAoB,EAC5B,IAAI,EAAE,oBAAoB,GACxB,iBAAiB;CAIpB"}

package/lib/summarySerializer.js

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { FluidSerializer } from "./serializer.js";
-/**
- * Serializer implementation for serializing handles during summary.
- * @internal
- */
-export class SummarySerializer extends FluidSerializer {
-    constructor() {
-        super(...arguments);
-        this.serializedRoutes = new Set();
-    }
-    getSerializedRoutes() {
-        return [...this.serializedRoutes];
-    }
-    bindAndEncodeHandle(handle, bind) {
-        this.serializedRoutes.add(handle.absolutePath);
-        return super.bindAndEncodeHandle(handle, bind);
-    }
-}
-//# sourceMappingURL=summarySerializer.js.map

package/lib/summarySerializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarySerializer.js","sourceRoot":"","sources":["../src/summarySerializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IAAtD;;QACkB,qBAAgB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAY5D,CAAC;IAXO,mBAAmB;QACzB,OAAO,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACnC,CAAC;IAES,mBAAmB,CAC5B,MAA4B,EAC5B,IAA0B;QAE1B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IFluidHandleInternal } from \"@fluidframework/core-interfaces/internal\";\nimport type { ISerializedHandle } from \"@fluidframework/runtime-utils/internal\";\n\nimport { FluidSerializer } from \"./serializer.js\";\n\n/**\n * Serializer implementation for serializing handles during summary.\n * @internal\n */\nexport class SummarySerializer extends FluidSerializer {\n\tprivate readonly serializedRoutes: Set<string> = new Set();\n\tpublic getSerializedRoutes(): string[] {\n\t\treturn [...this.serializedRoutes];\n\t}\n\n\tprotected bindAndEncodeHandle(\n\t\thandle: IFluidHandleInternal,\n\t\tbind: IFluidHandleInternal,\n\t): ISerializedHandle {\n\t\tthis.serializedRoutes.add(handle.absolutePath);\n\t\treturn super.bindAndEncodeHandle(handle, bind);\n\t}\n}\n"]}

package/src/summarySerializer.ts

@@ -1,28 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
-import type { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
-
-import { FluidSerializer } from "./serializer.js";
-
-/**
- * Serializer implementation for serializing handles during summary.
- * @internal
- */
-export class SummarySerializer extends FluidSerializer {
-	private readonly serializedRoutes: Set<string> = new Set();
-	public getSerializedRoutes(): string[] {
-		return [...this.serializedRoutes];
-	}
-
-	protected bindAndEncodeHandle(
-		handle: IFluidHandleInternal,
-		bind: IFluidHandleInternal,
-	): ISerializedHandle {
-		this.serializedRoutes.add(handle.absolutePath);
-		return super.bindAndEncodeHandle(handle, bind);
-	}
-}