Container: Enable getPendingLocalState by default (#25631)

The PR enables calling getPendingLocalState by default, and ensures the
overhead of capturing the pending state is minimized and/or deferred to
the getPendingLocalState call itself. The primary means by which we
reduce the overhead is my switching the in-memory representation of the
snapshot from SnapshotWithBlobs to ISnapshot.

ISnapshot has a number of advantages as an in-memory format, primarily
it matches the native format returned by modern drivers, and includes
both the snapshot tree, as well as the snapshot blobs as ArrayBuffers.
Since this format matches the driver's format, which eventually gets
passed down into the runtime, we ensure we are not storing a duplicate
copy, which could have significant memory overhead for large documents.
SnapshotWithBlobs on the other had stores blobs as strings, which is
great for serialization, but is redundant with the ArrayBuffers the rest
of fluid operates over. In getPendingLocalState we still need to convert
to SnapshotWithBlobs as the result is the serializable, but this is
deferred until it is needed.

For compatibly with older drivers, we still maintain support for driver
that do not return ISnapshot, but now we defer blob retrieval until
getPendingLocalState is called. This ensures the load path doesn't need
to retrieve any additional data than what is required by the load flow.

Outside of the container-loader package, all updates are just to test to
remove the old config, as it is no longer necessary to explicitly enable
the feature.

---------

Co-authored-by: Mark Fields <markfields@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

experimental/dds/tree/src/test/utilities/TestUtilities.ts

@@ -321,7 +321,6 @@ export async function setUpLocalServerTestSharedTree(
 	} = options;
 
 	const featureGates = options.featureGates ?? {};
-	featureGates['Fluid.Container.enableOfflineLoad'] = true;
 
 	const treeId = id ?? 'test';
 	let factory: SharedTreeFactory;

packages/dds/tree/src/test/utils.ts

@@ -38,7 +38,6 @@ import {
 } from "@fluidframework/test-runtime-utils/internal";
 import {
 	type ChannelFactoryRegistry,
-	type ITestContainerConfig,
 	type ITestObjectProvider,
 	type SummaryInfo,
 	TestContainerRuntimeFactory,
@@ -351,16 +350,9 @@ export class TestTreeProvider {
 		const configProvider = (settings: Record<string, ConfigTypes>): IConfigProviderBase => ({
 			getRawConfig: (name: string): ConfigTypes => settings[name],
 		});
-		const testContainerConfig: ITestContainerConfig = {
-			loaderProps: {
-				configProvider: configProvider({
-					"Fluid.Container.enableOfflineLoad": true,
-				}),
-			},
-		};
 		const container =
 			this.trees.length === 0
-				? await this.provider.makeTestContainer(testContainerConfig)
+				? await this.provider.makeTestContainer()
 				: await this.provider.loadTestContainer();
 
 		this._containers.push(container);

packages/loader/container-loader/src/container.ts

@@ -1023,7 +1023,7 @@ export class Container
 			this.isInteractiveClient &&
 			(this.mc.config.getBoolean("Fluid.Container.enableOfflineLoad") ??
 				this.mc.config.getBoolean("Fluid.Container.enableOfflineFull") ??
-				options.enableOfflineLoad === true);
+				options.enableOfflineLoad !== false);
 		this.serializedStateManager = new SerializedStateManager(
 			this.subLogger,
 			this.storageAdapter,
@@ -1668,8 +1668,11 @@ export class Container
 		timings.phase2 = performanceNow();
 
 		// Fetch specified snapshot.
-		const { baseSnapshot, version, attributes } =
-			await this.serializedStateManager.fetchSnapshot(specifiedVersion, pendingLocalState);
+		const {
+			snapshot: baseSnapshot,
+			version,
+			attributes,
+		} = await this.serializedStateManager.fetchSnapshot(specifiedVersion, pendingLocalState);
 		const baseSnapshotTree: ISnapshotTree | undefined = getSnapshotTree(baseSnapshot);
 		this._loadedFromVersion = version;
 

packages/loader/container-loader/src/containerStorageAdapter.ts

@@ -31,7 +31,7 @@ import { ProtocolTreeStorageService } from "./protocolTreeDocumentStorageService
 import { RetriableDocumentStorageService } from "./retriableDocumentStorageService.js";
 import type {
 	ISerializedStateManagerDocumentStorageService,
-	ISnapshotInfo,
+	SerializedSnapshotInfo,
 } from "./serializedStateManager.js";
 import { convertSnapshotInfoToSnapshot } from "./utils.js";
 
@@ -88,7 +88,9 @@ export class ContainerStorageAdapter
 		 * ArrayBufferLikes or utf8 encoded strings, containing blobs from a snapshot
 		 */
 		private readonly blobContents: { [id: string]: ArrayBufferLike | string } = {},
-		private loadingGroupIdSnapshotsFromPendingState: Record<string, ISnapshotInfo> | undefined,
+		private loadingGroupIdSnapshotsFromPendingState:
+			| Record<string, SerializedSnapshotInfo>
+			| undefined,
 		private readonly addProtocolSummaryIfMissing: (summaryTree: ISummaryTree) => ISummaryTree,
 		private readonly enableSummarizeProtocolTree: boolean | undefined,
 	) {
@@ -184,10 +186,7 @@ export class ContainerStorageAdapter
 			const localSnapshot =
 				this.loadingGroupIdSnapshotsFromPendingState[snapshotFetchOptions.loadingGroupIds[0]];
 			assert(localSnapshot !== undefined, 0x970 /* Local snapshot must be present */);
-			snapshot = convertSnapshotInfoToSnapshot(
-				localSnapshot,
-				localSnapshot.snapshotSequenceNumber,
-			);
+			snapshot = convertSnapshotInfoToSnapshot(localSnapshot);
 		} else {
 			if (this._storageService.getSnapshot === undefined) {
 				throw new UsageError(