@fluidframework/container-runtime 2.63.0 → 2.70.0-360753

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.63.0";
+export declare const pkgVersion = "2.70.0-360753";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,sCAAsC,CAAC;AAC3D,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,sCAAsC,CAAC;AAC3D,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

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.63.0";
+export const pkgVersion = "2.70.0-360753";
 //# 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,QAAQ,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.63.0\";\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,eAAe,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.70.0-360753\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "2.63.0",
+  "version": "2.70.0-360753",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -119,18 +119,18 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.63.0",
-    "@fluidframework/container-definitions": "~2.63.0",
-    "@fluidframework/container-runtime-definitions": "~2.63.0",
-    "@fluidframework/core-interfaces": "~2.63.0",
-    "@fluidframework/core-utils": "~2.63.0",
-    "@fluidframework/datastore": "~2.63.0",
-    "@fluidframework/driver-definitions": "~2.63.0",
-    "@fluidframework/driver-utils": "~2.63.0",
-    "@fluidframework/id-compressor": "~2.63.0",
-    "@fluidframework/runtime-definitions": "~2.63.0",
-    "@fluidframework/runtime-utils": "~2.63.0",
-    "@fluidframework/telemetry-utils": "~2.63.0",
+    "@fluid-internal/client-utils": "2.70.0-360753",
+    "@fluidframework/container-definitions": "2.70.0-360753",
+    "@fluidframework/container-runtime-definitions": "2.70.0-360753",
+    "@fluidframework/core-interfaces": "2.70.0-360753",
+    "@fluidframework/core-utils": "2.70.0-360753",
+    "@fluidframework/datastore": "2.70.0-360753",
+    "@fluidframework/driver-definitions": "2.70.0-360753",
+    "@fluidframework/driver-utils": "2.70.0-360753",
+    "@fluidframework/id-compressor": "2.70.0-360753",
+    "@fluidframework/runtime-definitions": "2.70.0-360753",
+    "@fluidframework/runtime-utils": "2.70.0-360753",
+    "@fluidframework/telemetry-utils": "2.70.0-360753",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "double-ended-queue": "^2.1.0-0",
     "lz4js": "^0.2.0",
@@ -140,16 +140,16 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.63.0",
-    "@fluid-private/stochastic-test-utils": "~2.63.0",
-    "@fluid-private/test-pairwise-generator": "~2.63.0",
+    "@fluid-internal/mocha-test-setup": "2.70.0-360753",
+    "@fluid-private/stochastic-test-utils": "2.70.0-360753",
+    "@fluid-private/test-pairwise-generator": "2.70.0-360753",
     "@fluid-tools/benchmark": "^0.51.0",
     "@fluid-tools/build-cli": "^0.58.3",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
-    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.62.0",
+    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.63.0",
     "@fluidframework/eslint-config-fluid": "^6.0.0",
-    "@fluidframework/test-runtime-utils": "~2.63.0",
+    "@fluidframework/test-runtime-utils": "2.70.0-360753",
     "@microsoft/api-extractor": "7.52.11",
     "@types/double-ended-queue": "^2.1.0",
     "@types/lz4js": "^0.2.0",
@@ -168,26 +168,7 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {
-      "Interface_ContainerRuntimeOptions": {
-        "backCompat": false
-      },
-      "Interface_ISummaryRuntimeOptions": {
-        "backCompat": false
-      },
-      "Interface_LoadContainerRuntimeParams": {
-        "backCompat": false
-      },
-      "TypeAlias_IContainerRuntimeOptions": {
-        "backCompat": false
-      },
-      "TypeAlias_ISummaryConfiguration": {
-        "backCompat": false
-      },
-      "Variable_DefaultSummaryConfiguration": {
-        "backCompat": false
-      }
-    },
+    "broken": {},
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/blobManager/blobManager.ts

@@ -168,7 +168,7 @@ interface UploadedBlob {
 
 /**
  * A blob tracked by BlobManager that has been uploaded to storage and is in the process of sending
- * a BlobAttach op and waiting for the ack.
+ * a BlobAttach message and waiting for the ack.
  */
 interface AttachingBlob {
 	state: "attaching";
@@ -179,7 +179,7 @@ interface AttachingBlob {
 }
 
 /**
- * A blob tracked by BlobManager that has been uploaded to storage and its BlobAttach op has been
+ * A blob tracked by BlobManager that has been uploaded to storage and its BlobAttach message has been
  * ack'd. It is fully shared and available to all clients, and is no longer considered pending.
  */
 interface AttachedBlob {
@@ -205,7 +205,7 @@ type LocalBlobRecord =
  * Omits attached blobs since they are fully uploaded and don't need to be saved and restored.
  * Omits uploading and attaching states since upon restore we will need to restart those processes.
  */
-type SerializableLocalBlobRecord =
+export type SerializableLocalBlobRecord =
 	| (Omit<LocalOnlyBlob, "blob"> & { blob: string })
 	| (Omit<UploadedBlob, "blob"> & { blob: string });
 
@@ -259,7 +259,7 @@ export class BlobManager {
 	 */
 	private readonly pendingOnlyLocalIds: Set<string> = new Set();
 
-	private readonly sendBlobAttachOp: (localId: string, storageId: string) => void;
+	private readonly sendBlobAttachMessage: (localId: string, storageId: string) => void;
 
 	private readonly routeContext: IFluidHandleContext;
 	private readonly storage: Pick<IContainerStorageService, "createBlob" | "readBlob">;
@@ -280,16 +280,16 @@ export class BlobManager {
 		blobManagerLoadInfo: IBlobManagerLoadInfo;
 		readonly storage: Pick<IContainerStorageService, "createBlob" | "readBlob">;
 		/**
-		 * Submit a BlobAttach op. When a blob is uploaded, there is a short grace period before which the blob is
-		 * deleted. The BlobAttach op notifies the server that blob is in use. The server will then not delete the
+		 * Submit a BlobAttach message. When a blob is uploaded, there is a short grace period before which the blob is
+		 * deleted. The BlobAttach message notifies the server that blob is in use. The server will then not delete the
 		 * the blob as long as it is listed as referenced in future summaries. The summarizing client will know to
-		 * include the storage ID in the summary when it sees the op.
+		 * include the storage ID in the summary when it sees the message.
 		 *
-		 * The op will also include a local ID to inform all clients of the relation to the storage ID, without
-		 * knowledge of which they cannot request the blob from storage. It's important that this op is sequenced
-		 * before any ops that reference the local ID, otherwise, an invalid handle could be added to the document.
+		 * The message will also include a local ID to inform all clients of the relation to the storage ID, without
+		 * knowledge of which they cannot request the blob from storage. It's important that this message is sequenced
+		 * before any messages that reference the local ID, otherwise, an invalid handle could be added to the document.
 		 */
-		sendBlobAttachOp: (localId: string, storageId: string) => void;
+		sendBlobAttachMessage: (localId: string, storageId: string) => void;
 		// Called when a blob node is requested. blobPath is the path of the blob's node in GC's graph.
 		// blobPath's format - `/<basePath>/<localId>`.
 		readonly blobRequested: (blobPath: string) => void;
@@ -305,7 +305,7 @@ export class BlobManager {
 			routeContext,
 			blobManagerLoadInfo,
 			storage,
-			sendBlobAttachOp,
+			sendBlobAttachMessage,
 			blobRequested,
 			isBlobDeleted,
 			runtime,
@@ -315,7 +315,7 @@ export class BlobManager {
 		} = props;
 		this.routeContext = routeContext;
 		this.storage = storage;
-		this.sendBlobAttachOp = sendBlobAttachOp;
+		this.sendBlobAttachMessage = sendBlobAttachMessage;
 		this.blobRequested = blobRequested;
 		this.isBlobDeleted = isBlobDeleted;
 		this.runtime = runtime;
@@ -404,7 +404,7 @@ export class BlobManager {
 			// Handles for detached blobs are not payload pending, though they should also always be present
 			// in the localBlobCache and therefore should never need to refer to storage.
 			assert(payloadPending, 0x11f /* "requesting unknown blobs" */);
-			// If we didn't find it in the redirectTable and it's payloadPending, assume the attach op is coming
+			// If we didn't find it in the redirectTable and it's payloadPending, assume the attach message is coming
 			// eventually and wait. We do this even if the local client doesn't have the blob payloadPending flag
 			// enabled, in case a remote client does have it enabled. This wait may be infinite if the uploading
 			// client failed the upload and doesn't exist anymore.
@@ -559,7 +559,7 @@ export class BlobManager {
 		 * rejects on error during upload or if the signal is aborted.
 		 *
 		 * Most of the time this should be expected to exit in uploaded state, but if we are loading from pending
-		 * state we may see an attach op from the client that generated the pending state, which can complete the
+		 * state we may see an attach message from the client that generated the pending state, which can complete the
 		 * attach while the upload is outstanding.
 		 */
 		const ensureUploaded = async (): Promise<void> => {
@@ -640,7 +640,7 @@ export class BlobManager {
 			const localBlobRecord = this.localBlobCache.get(localId);
 			if (localBlobRecord?.state === "attached") {
 				// In normal creation flows, the blob will be in uploaded state here. But if we are loading from pending
-				// state and see an attach op from the client that generated the pending state, we may have reached
+				// state and see an attach message from the client that generated the pending state, we may have reached
 				// attached state in the middle of the upload attempt. In that case there's no more work to do and we
 				// can just return.
 				return true;
@@ -678,7 +678,7 @@ export class BlobManager {
 							resolve(true);
 						}
 					};
-					// Although we already checked for TTL expiry above, the op we're about to send may later be asked
+					// Although we already checked for TTL expiry above, the message we're about to send may later be asked
 					// to resubmit. Before we resubmit, we check again for TTL expiry - this listener is how we learn if
 					// we discovered expiry in the resubmit flow.
 					const onBlobExpired = (_localId: string): void => {
@@ -702,7 +702,7 @@ export class BlobManager {
 					this.internalEvents.on("processedBlobAttach", onProcessedBlobAttach);
 					this.internalEvents.on("blobExpired", onBlobExpired);
 					signal?.addEventListener("abort", onSignalAbort);
-					this.sendBlobAttachOp(localId, localBlobRecord.storageId);
+					this.sendBlobAttachMessage(localId, localBlobRecord.storageId);
 				});
 			}
 		};
@@ -721,16 +721,16 @@ export class BlobManager {
 	};
 
 	/**
-	 * Resubmit a BlobAttach op. Used to add storage IDs to ops that were
+	 * Resubmit a BlobAttach op. Used to add storage IDs to messages that were
 	 * submitted to runtime while disconnected.
-	 * @param metadata - op metadata containing storage and/or local IDs
+	 * @param metadata - message metadata containing storage and/or local IDs
 	 */
 	public reSubmit(metadata: Record<string, unknown> | undefined): void {
 		assert(isBlobMetadata(metadata), 0xc01 /* Expected blob metadata for a BlobAttach op */);
 		const { localId, blobId: storageId } = metadata;
 		// Any blob that we're actively trying to advance to attached state must be in attaching state.
 		// Decline to resubmit for anything else.
-		// For example, we might be asked to resubmit stashed ops for blobs that never had their handle
+		// For example, we might be asked to resubmit stashed messages for blobs that never had their handle
 		// attached - these won't have a localBlobCache entry because we filter them out when generating
 		// pending state. We shouldn't try to attach them since they won't be accessible to the customer
 		// and would just be considered garbage immediately.
@@ -742,7 +742,7 @@ export class BlobManager {
 				this.localBlobCache.set(localId, { state: "localOnly", blob: localBlobRecord.blob });
 				this.internalEvents.emit("blobExpired", localId);
 			} else {
-				this.sendBlobAttachOp(localId, storageId);
+				this.sendBlobAttachMessage(localId, storageId);
 			}
 		}
 	}
@@ -759,9 +759,9 @@ export class BlobManager {
 				state: "attached",
 				blob: maybeLocalBlobRecord.blob,
 			};
-			// Processing a blob attach op is authoritative and may stomp on any existing state. Other
+			// Processing a blob attach message is authoritative and may stomp on any existing state. Other
 			// callsites that update localBlobCache entries must take proper caution to handle the case
-			// that a blob attach op is processed concurrently.
+			// that a blob attach message is processed concurrently.
 			this.localBlobCache.set(localId, attachedBlobRecord);
 			// Note there may or may not be an entry in pendingBlobsWithAttachedHandles for this localId,
 			// in particular for the non-payloadPending case since we should be reaching this point
@@ -824,7 +824,7 @@ export class BlobManager {
 			const localId = getLocalIdFromGCNodePath(route);
 			// If the blob hasn't already been deleted, log an error because this should never happen.
 			// If the blob has already been deleted, log a telemetry event. This can happen because multiple GC
-			// sweep ops can contain the same data store. It would be interesting to track how often this happens.
+			// sweep messages can contain the same data store. It would be interesting to track how often this happens.
 			const alreadyDeleted = this.isBlobDeleted(route);
 			const storageId = this.redirectTable.get(localId);
 			if (storageId === undefined) {
@@ -947,8 +947,8 @@ export class BlobManager {
 			// We downgrade uploading blobs to localOnly, and attaching blobs to uploaded. In the case of
 			// uploading blobs, we don't have a way to retrieve the eventual storageId so the upload will
 			// need to be restarted anyway. In the case of attaching blobs, we can't know whether the
-			// BlobAttach op will eventually be ack'd. So we assume we'll need to send another op, but also
-			// remain prepared to handle seeing the ack of the original op after loading from pending state.
+			// BlobAttach message will eventually be ack'd. So we assume we'll need to send another message, but also
+			// remain prepared to handle seeing the ack of the original message after loading from pending state.
 			pendingBlobs[localId] =
 				localBlobRecord.state === "localOnly" || localBlobRecord.state === "uploading"
 					? {

package/src/blobManager/index.ts

@@ -11,6 +11,7 @@ export {
 	type ICreateBlobResponseWithTTL,
 	type IPendingBlobs,
 	isBlobPath,
+	type SerializableLocalBlobRecord,
 } from "./blobManager.js";
 export {
 	blobsTreeName,

package/src/containerRuntime.ts

@@ -730,7 +730,9 @@ export interface LoadContainerRuntimeParams {
 	 */
 	existing: boolean;
 	/**
-	 * Additional options to be passed to the runtime
+	 * Additional options to be passed to the runtime.
+	 * @remarks
+	 * Defaults to `{}`.
 	 */
 	runtimeOptions?: IContainerRuntimeOptions;
 	/**
@@ -829,37 +831,60 @@ export class ContainerRuntime
 {
 	/**
 	 * Load the stores from a snapshot and returns the runtime.
-	 * @param params - An object housing the runtime properties:
-	 * - context - Context of the container.
-	 * - registryEntries - Mapping from data store types to their corresponding factories.
-	 * - existing - Pass 'true' if loading from an existing snapshot.
-	 * - requestHandler - (optional) Request handler for the request() method of the container runtime.
-	 * Only relevant for back-compat while we remove the request() method and move fully to entryPoint as the main pattern.
-	 * - runtimeOptions - Additional options to be passed to the runtime
-	 * - containerScope - runtime services provided with context
-	 * - containerRuntimeCtor - Constructor to use to create the ContainerRuntime instance.
-	 * This allows mixin classes to leverage this method to define their own async initializer.
-	 * - provideEntryPoint - Promise that resolves to an object which will act as entryPoint for the Container.
-	 * - minVersionForCollab - Minimum version of the FF runtime that this runtime supports collaboration with.
-	 * This object should provide all the functionality that the Container is expected to provide to the loader layer.
+	 * @param params - An object housing the runtime properties.
+	 * {@link LoadContainerRuntimeParams} except internal, while still having layer compat obligations.
+	 * @privateRemarks
+	 * Despite this being `@internal`, `@fluidframework/test-utils` uses it in `createTestContainerRuntimeFactory` and assumes multiple versions of the package expose the same API.
+	 *
+	 * Also note that `mixinAttributor` from `@fluid-experimental/attributor` overrides this function:
+	 * that will have to be updated if changing the signature of this function as well.
+	 *
+	 * Assuming these usages are updated appropriately,
+	 * `loadRuntime` could be removed (replaced by `loadRuntime2` which could be renamed back to `loadRuntime`).
 	 */
-	public static async loadRuntime(params: {
-		context: IContainerContext;
-		registryEntries: NamedFluidDataStoreRegistryEntries;
-		existing: boolean;
-		runtimeOptions?: IContainerRuntimeOptionsInternal;
-		containerScope?: FluidObject;
-		containerRuntimeCtor?: typeof ContainerRuntime;
-		/**
-		 * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
-		 */
-		requestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;
-		provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;
-		minVersionForCollab?: MinimumVersionForCollab;
-	}): Promise<ContainerRuntime> {
+	public static async loadRuntime(
+		params: LoadContainerRuntimeParams & {
+			/**
+			 * Constructor to use to create the ContainerRuntime instance.
+			 * @remarks
+			 * Defaults to {@link ContainerRuntime}.
+			 */
+			containerRuntimeCtor?: typeof ContainerRuntime;
+		},
+	): Promise<ContainerRuntime> {
+		return ContainerRuntime.loadRuntime2({
+			...params,
+			registry: new FluidDataStoreRegistry(params.registryEntries),
+		});
+	}
+
+	/**
+	 * Load the stores from a snapshot and returns the runtime.
+	 * @remarks
+	 * Same as {@link ContainerRuntime.loadRuntime},
+	 * but with `registry` instead of `registryEntries` and more `runtimeOptions`.
+	 */
+	public static async loadRuntime2(
+		params: Omit<LoadContainerRuntimeParams, "registryEntries" | "runtimeOptions"> & {
+			/**
+			 * Mapping from data store types to their corresponding factories.
+			 */
+			registry: IFluidDataStoreRegistry;
+			/**
+			 * Constructor to use to create the ContainerRuntime instance.
+			 * @remarks
+			 * Defaults to {@link ContainerRuntime}.
+			 */
+			containerRuntimeCtor?: typeof ContainerRuntime;
+			/**
+			 * {@link LoadContainerRuntimeParams.runtimeOptions}, except with additional internal only options.
+			 */
+			runtimeOptions?: IContainerRuntimeOptionsInternal;
+		},
+	): Promise<ContainerRuntime> {
 		const {
 			context,
-			registryEntries,
+			registry,
 			existing,
 			requestHandler,
 			provideEntryPoint,
@@ -959,8 +984,6 @@ export class ContainerRuntime
 				? runtimeOptions.enableRuntimeIdCompressor
 				: defaultConfigs.enableRuntimeIdCompressor;
 
-		const registry = new FluidDataStoreRegistry(registryEntries);
-
 		const tryFetchBlob = async <T>(blobName: string): Promise<T | undefined> => {
 			const blobId = context.baseSnapshot?.blobs[blobName];
 			if (context.baseSnapshot !== undefined && blobId !== undefined) {
@@ -1916,7 +1939,7 @@ export class ContainerRuntime
 			routeContext: this.handleContext,
 			blobManagerLoadInfo,
 			storage: this.storage,
-			sendBlobAttachOp: (localId: string, blobId: string) => {
+			sendBlobAttachMessage: (localId: string, blobId: string) => {
 				if (!this.disposed) {
 					this.submit(
 						{ type: ContainerMessageType.BlobAttach, contents: undefined },

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.63.0";
+export const pkgVersion = "2.70.0-360753";