@fluidframework/container-loader 2.0.0-dev-rc.5.0.0.270987 → 2.0.0-dev-rc.5.0.0.271262

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev-rc.5.0.0.270987",
+  "version": "2.0.0-dev-rc.5.0.0.271262",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -117,13 +117,13 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.270987",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.271262",
     "@types/events_pkg": "npm:@types/events@^3.0.0",
     "@ungap/structured-clone": "^1.2.0",
     "debug": "^4.3.4",
@@ -134,9 +134,9 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.270987",
-    "@fluid-private/test-loader-utils": "2.0.0-dev-rc.5.0.0.270987",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.271262",
+    "@fluid-private/test-loader-utils": "2.0.0-dev-rc.5.0.0.271262",
     "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.39.0",

package/src/container.ts

@@ -678,7 +678,7 @@ export class Container
 		return this.deltaManager.clientDetails.capabilities.interactive;
 	}
 
-	private get supportGetSnapshotApi(): boolean {
+	private supportGetSnapshotApi(): boolean {
 		const supportGetSnapshotApi: boolean =
 			this.mc.config.getBoolean("Fluid.Container.UseLoadingGroupIdForSnapshotFetch2") ===
 				true && this.service?.policies?.supportGetSnapshotApi === true;
@@ -965,9 +965,9 @@ export class Container
 				? summaryTree
 				: combineAppAndProtocolSummary(summaryTree, this.captureProtocolSummary());
 
-		// Whether the combined summary tree has been forced on by either the loader option or the monitoring context.
+		// Whether the combined summary tree has been forced on by either the loader option or the monitoring context or supportedFeatures flag by the service.
 		// Even if not forced on via this flag, combined summaries may still be enabled by service policy.
-		const forceEnableSummarizeProtocolTree =
+		const shouldSummarizeProtocolTree =
 			this.mc.config.getBoolean("Fluid.Container.summarizeProtocolTree2") ??
 			options.summarizeProtocolTree;
 
@@ -977,7 +977,7 @@ export class Container
 			pendingLocalState?.snapshotBlobs,
 			pendingLocalState?.loadedGroupIdSnapshots,
 			addProtocolSummaryIfMissing,
-			forceEnableSummarizeProtocolTree,
+			shouldSummarizeProtocolTree,
 		);
 
 		const offlineLoadEnabled =
@@ -991,6 +991,7 @@ export class Container
 			offlineLoadEnabled,
 			this,
 			() => this._deltaManager.connectionManager.shouldJoinWrite(),
+			() => this.supportGetSnapshotApi(),
 		);
 
 		const isDomAvailable =
@@ -1354,11 +1355,7 @@ export class Container
 
 					// If offline load is enabled, attachP will return the attach summary (in Snapshot format) so we can initialize SerializedStateManager
 					const snapshotWithBlobs = await attachP;
-					this.serializedStateManager.setInitialSnapshot(
-						snapshotWithBlobs,
-						this.supportGetSnapshotApi,
-					);
-
+					this.serializedStateManager.setInitialSnapshot(snapshotWithBlobs);
 					if (!this.closed) {
 						this.detachedBlobStorage.dispose?.();
 						this.handleDeltaConnectionArg(attachProps?.deltaConnection, {
@@ -1626,10 +1623,8 @@ export class Container
 		timings.phase2 = performance.now();
 
 		// Fetch specified snapshot.
-		const { baseSnapshot, version } = await this.serializedStateManager.fetchSnapshot(
-			specifiedVersion,
-			this.supportGetSnapshotApi,
-		);
+		const { baseSnapshot, version } =
+			await this.serializedStateManager.fetchSnapshot(specifiedVersion);
 		const baseSnapshotTree: ISnapshotTree | undefined = getSnapshotTree(baseSnapshot);
 		this._loadedFromVersion = version;
 		const attributes: IDocumentAttributes = await getDocumentAttributes(

package/src/containerStorageAdapter.ts

@@ -74,7 +74,7 @@ export class ContainerStorageAdapter
 	 * @param loadingGroupIdSnapshotsFromPendingState - in offline mode, any loading group snapshots we've downloaded from the service that were stored in the pending state
 	 * @param addProtocolSummaryIfMissing - a callback to permit the container to inspect the summary we're about to
 	 * upload, and fix it up with a protocol tree if needed
-	 * @param forceEnableSummarizeProtocolTree - Enforce uploading a protocol summary regardless of the service's policy
+	 * @param shouldSummarizeProtocolTree  - Enforce uploading a protocol summary regardless of the service's policy.
 	 */
 	public constructor(
 		// eslint-disable-next-line import/no-deprecated
@@ -86,10 +86,10 @@ export class ContainerStorageAdapter
 		private readonly blobContents: { [id: string]: ArrayBufferLike | string } = {},
 		private loadingGroupIdSnapshotsFromPendingState: Record<string, ISnapshotInfo> | undefined,
 		private readonly addProtocolSummaryIfMissing: (summaryTree: ISummaryTree) => ISummaryTree,
-		forceEnableSummarizeProtocolTree: boolean | undefined,
+		shouldSummarizeProtocolTree: boolean | undefined,
 	) {
 		this._storageService = new BlobOnlyStorage(detachedBlobStorage, logger);
-		this._summarizeProtocolTree = forceEnableSummarizeProtocolTree;
+		this._summarizeProtocolTree = shouldSummarizeProtocolTree;
 	}
 
 	disposed: boolean = false;
@@ -109,15 +109,22 @@ export class ContainerStorageAdapter
 			this.logger,
 		));
 
-		this._summarizeProtocolTree =
-			this._summarizeProtocolTree ?? service.policies?.summarizeProtocolTree;
-		if (this.summarizeProtocolTree) {
-			this.logger.sendTelemetryEvent({ eventName: "summarizeProtocolTreeEnabled" });
-			this._storageService = new ProtocolTreeStorageService(
-				retriableStorage,
-				this.addProtocolSummaryIfMissing,
-			);
-		}
+		// A storage service wrapper which intercept calls to uploadSummaryWithContext and ensure they include
+		// the protocol summary, provided single-commit summary is enabled.
+		this._storageService = new ProtocolTreeStorageService(
+			retriableStorage,
+			(...props) => {
+				this.logger.sendTelemetryEvent({ eventName: "summarizeProtocolTreeEnabled" });
+				return this.addProtocolSummaryIfMissing(...props);
+			},
+			// A callback to ensure we fetch the most updated value of service.policies.summarizeProtocolTree, which could be set
+			// based on the response received from the service after connection is established.
+			() => {
+				this._summarizeProtocolTree =
+					this._summarizeProtocolTree ?? service.policies?.summarizeProtocolTree ?? false;
+				return this._summarizeProtocolTree;
+			},
+		);
 	}
 
 	public loadSnapshotFromSnapshotBlobs(snapshotBlobs: ISerializableBlobContents) {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.0-dev-rc.5.0.0.270987";
+export const pkgVersion = "2.0.0-dev-rc.5.0.0.271262";

package/src/protocolTreeDocumentStorageService.ts

@@ -15,9 +15,16 @@ import {
  * the protocol summary, using the provided callback to add it if necessary.
  */
 export class ProtocolTreeStorageService implements IDocumentStorageService, IDisposable {
+	/**
+	 *
+	 * @param internalStorageService - Document storage service responsible to make api calls to the storage.
+	 * @param addProtocolSummaryIfMissing - Function to add protocol summary tree to the summary. Used in scenarios where single-commit summaries are used.
+	 * @param shouldSummarizeProtocolTree - Callback function to learn about the service preference on whether single-commit summaries are enabled.
+	 */
 	constructor(
 		private readonly internalStorageService: IDocumentStorageService & IDisposable,
 		private readonly addProtocolSummaryIfMissing: (summaryTree: ISummaryTree) => ISummaryTree,
+		private readonly shouldSummarizeProtocolTree: () => boolean,
 	) {
 		this.getSnapshotTree = internalStorageService.getSnapshotTree.bind(internalStorageService);
 		this.getSnapshot = internalStorageService.getSnapshot?.bind(internalStorageService);
@@ -46,9 +53,11 @@ export class ProtocolTreeStorageService implements IDocumentStorageService, IDis
 		summary: ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string> {
-		return this.internalStorageService.uploadSummaryWithContext(
-			this.addProtocolSummaryIfMissing(summary),
-			context,
-		);
+		return this.shouldSummarizeProtocolTree()
+			? this.internalStorageService.uploadSummaryWithContext(
+					this.addProtocolSummaryIfMissing(summary),
+					context,
+			  )
+			: this.internalStorageService.uploadSummaryWithContext(summary, context);
 	}
 }

package/src/serializedStateManager.ts

@@ -131,19 +131,6 @@ export class SerializedStateManager {
 	private latestSnapshot: ISnapshotInfo | undefined;
 	private refreshSnapshotP: Promise<void> | undefined;
 	private readonly lastSavedOpSequenceNumber: number = 0;
-	private _supportGetSnapshotApi: boolean | undefined;
-
-	private set supportGetSnapshotApi(value: boolean | undefined) {
-		assert(
-			this._supportGetSnapshotApi === undefined,
-			"supportGetSnapshotApi should be declared just once",
-		);
-		this._supportGetSnapshotApi = value;
-	}
-
-	private get supportGetSnapshotApi(): boolean | undefined {
-		return this._supportGetSnapshotApi;
-	}
 
 	/**
 	 * @param pendingLocalState - The pendingLocalState being rehydrated, if any (undefined when loading directly from storage)
@@ -160,6 +147,7 @@ export class SerializedStateManager {
 		private readonly _offlineLoadEnabled: boolean,
 		containerEvent: IEventProvider<ISerializerEvent>,
 		private readonly containerDirty: () => boolean,
+		private readonly supportGetSnapshotApi: () => boolean,
 	) {
 		this.mc = createChildMonitoringContext({
 			logger: subLogger,
@@ -208,16 +196,12 @@ export class SerializedStateManager {
 	 * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree.
 	 * @returns The snapshot to boot the container from
 	 */
-	public async fetchSnapshot(
-		specifiedVersion: string | undefined,
-		supportGetSnapshotApi: boolean,
-	) {
-		this.supportGetSnapshotApi = supportGetSnapshotApi;
+	public async fetchSnapshot(specifiedVersion: string | undefined) {
 		if (this.pendingLocalState === undefined) {
 			const { baseSnapshot, version } = await getSnapshot(
 				this.mc,
 				this.storageAdapter,
-				this.supportGetSnapshotApi,
+				this.supportGetSnapshotApi(),
 				specifiedVersion,
 			);
 			const baseSnapshotTree: ISnapshotTree | undefined = getSnapshotTree(baseSnapshot);
@@ -252,7 +236,7 @@ export class SerializedStateManager {
 				this.mc.config.getBoolean("Fluid.Container.enableOfflineSnapshotRefresh") === true
 			) {
 				// Don't block on the refresh snapshot call - it is for the next time we serialize, not booting this incarnation
-				this.refreshSnapshotP = this.refreshLatestSnapshot(this.supportGetSnapshotApi);
+				this.refreshSnapshotP = this.refreshLatestSnapshot(this.supportGetSnapshotApi());
 				this.refreshSnapshotP.catch((e) => {
 					this.mc.logger.sendErrorEvent({
 						eventName: "RefreshLatestSnapshotFailed",
@@ -370,11 +354,7 @@ export class SerializedStateManager {
 	 * base snapshot when attaching.
 	 * @param snapshot - snapshot and blobs collected while attaching (a form of the attach summary)
 	 */
-	public setInitialSnapshot(
-		snapshot: SnapshotWithBlobs | undefined,
-		supportGetSnapshotApi: boolean,
-	) {
-		this.supportGetSnapshotApi = supportGetSnapshotApi;
+	public setInitialSnapshot(snapshot: SnapshotWithBlobs | undefined) {
 		if (this.offlineLoadEnabled) {
 			assert(
 				this.snapshot === undefined,