@fluidframework/container-loader 2.33.2 → 2.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.33.2",
+  "version": "2.40.0",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -119,13 +119,13 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.33.2",
-    "@fluidframework/container-definitions": "~2.33.2",
-    "@fluidframework/core-interfaces": "~2.33.2",
-    "@fluidframework/core-utils": "~2.33.2",
-    "@fluidframework/driver-definitions": "~2.33.2",
-    "@fluidframework/driver-utils": "~2.33.2",
-    "@fluidframework/telemetry-utils": "~2.33.2",
+    "@fluid-internal/client-utils": "~2.40.0",
+    "@fluidframework/container-definitions": "~2.40.0",
+    "@fluidframework/core-interfaces": "~2.40.0",
+    "@fluidframework/core-utils": "~2.40.0",
+    "@fluidframework/driver-definitions": "~2.40.0",
+    "@fluidframework/driver-utils": "~2.40.0",
+    "@fluidframework/telemetry-utils": "~2.40.0",
     "@types/events_pkg": "npm:@types/events@^3.0.0",
     "@ungap/structured-clone": "^1.2.0",
     "debug": "^4.3.4",
@@ -136,9 +136,9 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/client-utils": "~2.33.2",
-    "@fluid-internal/mocha-test-setup": "~2.33.2",
-    "@fluid-private/test-loader-utils": "~2.33.2",
+    "@fluid-internal/client-utils": "~2.40.0",
+    "@fluid-internal/mocha-test-setup": "~2.40.0",
+    "@fluid-private/test-loader-utils": "~2.40.0",
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
@@ -164,7 +164,12 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "TypeAlias_IDetachedBlobStorage": {
+        "forwardCompat": false,
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/attachment.ts

@@ -9,8 +9,7 @@ import { ISummaryTree } from "@fluidframework/driver-definitions";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
 import { CombinedAppAndProtocolSummary } from "@fluidframework/driver-utils/internal";
 
-// eslint-disable-next-line import/no-deprecated
-import { IDetachedBlobStorage } from "./loader.js";
+import type { MemoryDetachedBlobStorage } from "./memoryBlobStorage.js";
 import type { SnapshotWithBlobs } from "./serializedStateManager.js";
 import { getSnapshotTreeAndBlobsFromSerializedContainer } from "./utils.js";
 
@@ -113,8 +112,7 @@ export interface AttachProcessProps {
 	 * The detached blob storage if it exists.
 	 */
 	readonly detachedBlobStorage?: Pick<
-		// eslint-disable-next-line import/no-deprecated
-		IDetachedBlobStorage,
+		MemoryDetachedBlobStorage,
 		"getBlobIds" | "readBlob" | "size"
 	>;
 

package/src/container.ts

@@ -72,7 +72,6 @@ import {
 	ISequencedDocumentMessage,
 	ISignalMessage,
 	type ConnectionMode,
-	type IContainerPackageInfo,
 } from "@fluidframework/driver-definitions/internal";
 import {
 	getSnapshotTree,
@@ -128,14 +127,12 @@ import {
 	getPackageName,
 } from "./contracts.js";
 import { DeltaManager, IConnectionArgs } from "./deltaManager.js";
-// eslint-disable-next-line import/no-deprecated
-import { IDetachedBlobStorage } from "./loader.js";
 import { RelativeLoader } from "./loader.js";
 import { validateRuntimeCompatibility } from "./loaderLayerCompatState.js";
 import {
-	serializeMemoryDetachedBlobStorage,
 	createMemoryDetachedBlobStorage,
 	tryInitializeMemoryDetachedBlobStorage,
+	type MemoryDetachedBlobStorage,
 } from "./memoryBlobStorage.js";
 import { NoopHeuristic } from "./noopHeuristic.js";
 import { pkgVersion } from "./packageVersion.js";
@@ -241,12 +238,6 @@ export interface IContainerCreateProps {
 	 */
 	readonly subLogger: ITelemetryLoggerExt;
 
-	/**
-	 * Blobs storage for detached containers.
-	 */
-	// eslint-disable-next-line import/no-deprecated
-	readonly detachedBlobStorage?: IDetachedBlobStorage;
-
 	/**
 	 * Optional property for allowing the container to use a custom
 	 * protocol implementation for handling the quorum and/or the audience.
@@ -492,8 +483,7 @@ export class Container
 	private readonly options: ILoaderOptions;
 	private readonly scope: FluidObject;
 	private readonly subLogger: ITelemetryLoggerExt;
-	// eslint-disable-next-line import/no-deprecated
-	private readonly detachedBlobStorage: IDetachedBlobStorage | undefined;
+	private readonly detachedBlobStorage: MemoryDetachedBlobStorage | undefined;
 	private readonly protocolHandlerBuilder: ProtocolHandlerBuilder;
 	private readonly client: IClient;
 
@@ -724,17 +714,6 @@ export class Container
 		return this._loadedCodeDetails;
 	}
 
-	/**
-	 * Get the package info for the code details that were used to load the container.
-	 * @returns The package info for the code details that were used to load the container if it is loaded, undefined otherwise
-	 * @deprecated To be removed in 2.40.
-	 * Use getLoadedCodeDetails instead; see https://github.com/microsoft/FluidFramework/issues/23898 for details.
-	 * Deprecating the function here to avoid polluting public container api surface.
-	 */
-	public getContainerPackageInfo?(): IContainerPackageInfo | undefined {
-		return getPackageName(this._loadedCodeDetails);
-	}
-
 	private _loadedModule: IFluidModuleWithDetails | undefined;
 
 	/**
@@ -807,7 +786,6 @@ export class Container
 			options,
 			scope,
 			subLogger,
-			detachedBlobStorage,
 			protocolHandlerBuilder,
 		} = createProps;
 
@@ -1006,10 +984,7 @@ export class Container
 		this.detachedBlobStorage =
 			this.attachState === AttachState.Attached
 				? undefined
-				: (detachedBlobStorage ??
-					(this.mc.config.getBoolean("Fluid.Container.MemoryBlobStorageEnabled") === false
-						? undefined
-						: createMemoryDetachedBlobStorage()));
+				: createMemoryDetachedBlobStorage();
 
 		this.storageAdapter = new ContainerStorageAdapter(
 			this.detachedBlobStorage,
@@ -1284,7 +1259,7 @@ export class Container
 			pendingRuntimeState,
 			hasAttachmentBlobs:
 				this.detachedBlobStorage !== undefined && this.detachedBlobStorage.size > 0,
-			attachmentBlobs: serializeMemoryDetachedBlobStorage(this.detachedBlobStorage),
+			attachmentBlobs: this.detachedBlobStorage?.serialize(),
 		};
 		return JSON.stringify(detachedContainerState);
 	}
@@ -1846,6 +1821,10 @@ export class Container
 	}: IPendingDetachedContainerState): Promise<void> {
 		if (hasAttachmentBlobs) {
 			if (attachmentBlobs !== undefined) {
+				assert(
+					this.detachedBlobStorage !== undefined,
+					0xb8e /* detached blob storage should always exist when detached */,
+				);
 				tryInitializeMemoryDetachedBlobStorage(this.detachedBlobStorage, attachmentBlobs);
 			}
 			assert(

package/src/containerStorageAdapter.ts

@@ -23,8 +23,7 @@ import {
 import { isInstanceOfISnapshot, UsageError } from "@fluidframework/driver-utils/internal";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
-// eslint-disable-next-line import/no-deprecated
-import { IDetachedBlobStorage } from "./loader.js";
+import type { MemoryDetachedBlobStorage } from "./memoryBlobStorage.js";
 import { ProtocolTreeStorageService } from "./protocolTreeDocumentStorageService.js";
 import { RetriableDocumentStorageService } from "./retriableDocumentStorageService.js";
 import type {
@@ -80,8 +79,7 @@ export class ContainerStorageAdapter
 	 * @param enableSummarizeProtocolTree - Enable uploading a protocol summary. Note: preference is given to service policy's "summarizeProtocolTree" before this value.
 	 */
 	public constructor(
-		// eslint-disable-next-line import/no-deprecated
-		detachedBlobStorage: IDetachedBlobStorage | undefined,
+		detachedBlobStorage: MemoryDetachedBlobStorage | undefined,
 		private readonly logger: ITelemetryLoggerExt,
 		/**
 		 * ArrayBufferLikes or utf8 encoded strings, containing blobs from a snapshot
@@ -258,8 +256,7 @@ export class ContainerStorageAdapter
  */
 class BlobOnlyStorage implements IDocumentStorageService {
 	constructor(
-		// eslint-disable-next-line import/no-deprecated
-		private readonly detachedStorage: IDetachedBlobStorage | undefined,
+		private readonly detachedStorage: MemoryDetachedBlobStorage | undefined,
 		private readonly logger: ITelemetryLoggerExt,
 	) {}
 
@@ -271,8 +268,7 @@ class BlobOnlyStorage implements IDocumentStorageService {
 		return this.verifyStorage().readBlob(blobId);
 	}
 
-	// eslint-disable-next-line import/no-deprecated
-	private verifyStorage(): IDetachedBlobStorage {
+	private verifyStorage(): MemoryDetachedBlobStorage {
 		if (this.detachedStorage === undefined) {
 			throw new UsageError("Real storage calls not allowed in Unattached container");
 		}

package/src/index.ts

@@ -16,7 +16,6 @@ export {
 } from "./createAndLoadContainerUtils.js";
 export {
 	ICodeDetailsLoader,
-	IDetachedBlobStorage,
 	IFluidModuleWithDetails,
 	ILoaderProps,
 	ILoaderServices,

package/src/loader.ts

@@ -22,7 +22,6 @@ import {
 import { IClientDetails } from "@fluidframework/driver-definitions";
 import {
 	IDocumentServiceFactory,
-	IDocumentStorageService,
 	IResolvedUrl,
 	IUrlResolver,
 } from "@fluidframework/driver-definitions/internal";
@@ -170,11 +169,6 @@ export interface ILoaderProps {
 	 */
 	readonly logger?: ITelemetryBaseLogger;
 
-	/**
-	 * Blobs storage for detached containers.
-	 */
-	readonly detachedBlobStorage?: IDetachedBlobStorage;
-
 	/**
 	 * The configuration provider which may be used to control features.
 	 */
@@ -228,12 +222,6 @@ export interface ILoaderServices {
 	 */
 	readonly subLogger: ITelemetryLoggerExt;
 
-	/**
-	 * Blobs storage for detached containers.
-	 * @deprecated - IDetachedBlobStorage will be removed in a future release without a replacement. Blobs created while detached will be stored in memory to align with attached container behavior. AB#8049
-	 */
-	readonly detachedBlobStorage?: IDetachedBlobStorage;
-
 	/**
 	 * Optional property for allowing the container to use a custom
 	 * protocol implementation for handling the quorum and/or the audience.
@@ -241,27 +229,6 @@ export interface ILoaderServices {
 	readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
 }
 
-/**
- * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
- * blobs in detached containers.
- * @legacy
- * @alpha
- *
- * @deprecated - IDetachedBlobStorage will be removed in a future release without a replacement. Blobs created while detached will be stored in memory to align with attached container behavior. AB#8049
- */
-export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
-	size: number;
-	/**
-	 * Return an array of all blob IDs present in storage
-	 */
-	getBlobIds(): string[];
-
-	/**
-	 * After the container is attached, the detached blob storage is no longer needed and will be disposed.
-	 */
-	dispose?(): void;
-};
-
 /**
  * Manages Fluid resource loading
  * @legacy
@@ -281,7 +248,6 @@ export class Loader implements IHostLoader {
 			options,
 			scope,
 			logger,
-			detachedBlobStorage,
 			configProvider,
 			protocolHandlerBuilder,
 		} = loaderProps;
@@ -306,7 +272,6 @@ export class Loader implements IHostLoader {
 			options: options ?? {},
 			scope:
 				options?.provideScopeLoader === false ? { ...scope } : { ...scope, ILoader: this },
-			detachedBlobStorage,
 			protocolHandlerBuilder,
 			subLogger: subMc.logger,
 		};

package/src/memoryBlobStorage.ts

@@ -4,57 +4,40 @@
  */
 
 import { bufferToString, stringToBuffer } from "@fluid-internal/client-utils";
-import { assert, isObject } from "@fluidframework/core-utils/internal";
-import type { ICreateBlobResponse } from "@fluidframework/driver-definitions/internal";
+import { assert } from "@fluidframework/core-utils/internal";
+import type {
+	ICreateBlobResponse,
+	IDocumentStorageService,
+} from "@fluidframework/driver-definitions/internal";
 
-// eslint-disable-next-line import/no-deprecated
-import type { IDetachedBlobStorage } from "./loader.js";
-
-const MemoryDetachedBlobStorageIdentifier = Symbol();
+/**
+ * An interface used to manage blobs in memory for detached containers.
+ *
+ * @remarks
+ * On attach of the container the blobs are read, and uploaded to the server.
+ * The interface also supports serialization and initialization which is
+ * used when serializing and rehydrating a detached container with blobs.
+ */
+export interface MemoryDetachedBlobStorage
+	extends Pick<IDocumentStorageService, "createBlob" | "readBlob"> {
+	size: number;
+	/**
+	 * Return an array of all blob IDs present in storage
+	 */
+	getBlobIds(): string[];
 
-// eslint-disable-next-line import/no-deprecated
-interface MemoryDetachedBlobStorage extends IDetachedBlobStorage {
-	[MemoryDetachedBlobStorageIdentifier]: typeof MemoryDetachedBlobStorageIdentifier;
+	/**
+	 * After the container is attached, the detached blob storage is no longer needed and will be disposed.
+	 */
+	dispose?(): void;
 	initialize(attachmentBlobs: string[]): void;
 	serialize(): string | undefined;
 }
 
-function isMemoryDetachedBlobStorage(
-	// eslint-disable-next-line import/no-deprecated
-	detachedStorage: IDetachedBlobStorage | undefined,
-): detachedStorage is MemoryDetachedBlobStorage {
-	return (
-		isObject(detachedStorage) &&
-		MemoryDetachedBlobStorageIdentifier in detachedStorage &&
-		detachedStorage[MemoryDetachedBlobStorageIdentifier] ===
-			MemoryDetachedBlobStorageIdentifier
-	);
-}
-
-export function serializeMemoryDetachedBlobStorage(
-	// eslint-disable-next-line import/no-deprecated
-	detachedStorage: IDetachedBlobStorage | undefined,
-): string | undefined {
-	if (
-		detachedStorage !== undefined &&
-		detachedStorage.size > 0 &&
-		isMemoryDetachedBlobStorage(detachedStorage)
-	) {
-		return detachedStorage.serialize();
-	}
-}
-
 export function tryInitializeMemoryDetachedBlobStorage(
-	// eslint-disable-next-line import/no-deprecated
-	detachedStorage: IDetachedBlobStorage | undefined,
+	detachedStorage: MemoryDetachedBlobStorage,
 	attachmentBlobs: string,
 ): void {
-	if (!isMemoryDetachedBlobStorage(detachedStorage)) {
-		throw new Error(
-			"DetachedBlobStorage was not provided to the loader during serialize so cannot be provided during rehydrate.",
-		);
-	}
-
 	assert(detachedStorage.size === 0, 0x99e /* Blob storage already initialized */);
 	// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 	const maybeAttachmentBlobs = JSON.parse(attachmentBlobs);
@@ -64,11 +47,16 @@ export function tryInitializeMemoryDetachedBlobStorage(
 	detachedStorage.initialize(maybeAttachmentBlobs);
 }
 
+/**
+ * Creates a new instance of `MemoryDetachedBlobStorage`.
+ * The returned storage allows for creating, reading, and managing blobs in memory.
+ * It also provides methods for serialization and initialization with attachment blobs.
+ * @returns A new `MemoryDetachedBlobStorage` instance.
+ */
 // eslint-disable-next-line import/no-deprecated
-export function createMemoryDetachedBlobStorage(): IDetachedBlobStorage {
+export function createMemoryDetachedBlobStorage(): MemoryDetachedBlobStorage {
 	const blobs: ArrayBufferLike[] = [];
 	const storage: MemoryDetachedBlobStorage = {
-		[MemoryDetachedBlobStorageIdentifier]: MemoryDetachedBlobStorageIdentifier,
 		createBlob: async (file: ArrayBufferLike): Promise<ICreateBlobResponse> => ({
 			id: `${blobs.push(file) - 1}`,
 		}),
@@ -79,7 +67,10 @@ export function createMemoryDetachedBlobStorage(): IDetachedBlobStorage {
 		},
 		getBlobIds: (): string[] => blobs.map((_, i) => `${i}`),
 		dispose: () => blobs.splice(0),
-		serialize: () => JSON.stringify(blobs.map((b) => bufferToString(b, "utf8"))),
+		serialize: () =>
+			blobs.length > 0
+				? JSON.stringify(blobs.map((b) => bufferToString(b, "utf8")))
+				: undefined,
 		initialize: (attachmentBlobs: string[]) =>
 			blobs.push(...attachmentBlobs.map((maybeBlob) => stringToBuffer(maybeBlob, "utf8"))),
 	};

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.33.2";
+export const pkgVersion = "2.40.0";