@fluidframework/container-runtime 2.13.0 → 2.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "2.13.0",
+  "version": "2.20.0",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -63,16 +63,6 @@
         "default": "./dist/deltaScheduler.js"
       }
     },
-    "./internal/test/scheduleManager": {
-      "import": {
-        "types": "./lib/scheduleManager.d.ts",
-        "default": "./lib/scheduleManager.js"
-      },
-      "require": {
-        "types": "./dist/scheduleManager.d.ts",
-        "default": "./dist/scheduleManager.js"
-      }
-    },
     "./internal/test/blobManager": {
       "import": {
         "types": "./lib/blobManager/index.d.ts",
@@ -129,18 +119,18 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.13.0",
-    "@fluidframework/container-definitions": "~2.13.0",
-    "@fluidframework/container-runtime-definitions": "~2.13.0",
-    "@fluidframework/core-interfaces": "~2.13.0",
-    "@fluidframework/core-utils": "~2.13.0",
-    "@fluidframework/datastore": "~2.13.0",
-    "@fluidframework/driver-definitions": "~2.13.0",
-    "@fluidframework/driver-utils": "~2.13.0",
-    "@fluidframework/id-compressor": "~2.13.0",
-    "@fluidframework/runtime-definitions": "~2.13.0",
-    "@fluidframework/runtime-utils": "~2.13.0",
-    "@fluidframework/telemetry-utils": "~2.13.0",
+    "@fluid-internal/client-utils": "~2.20.0",
+    "@fluidframework/container-definitions": "~2.20.0",
+    "@fluidframework/container-runtime-definitions": "~2.20.0",
+    "@fluidframework/core-interfaces": "~2.20.0",
+    "@fluidframework/core-utils": "~2.20.0",
+    "@fluidframework/datastore": "~2.20.0",
+    "@fluidframework/driver-definitions": "~2.20.0",
+    "@fluidframework/driver-utils": "~2.20.0",
+    "@fluidframework/id-compressor": "~2.20.0",
+    "@fluidframework/runtime-definitions": "~2.20.0",
+    "@fluidframework/runtime-utils": "~2.20.0",
+    "@fluidframework/telemetry-utils": "~2.20.0",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "double-ended-queue": "^2.1.0-0",
     "lz4js": "^0.2.0",
@@ -149,18 +139,19 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.13.0",
-    "@fluid-private/stochastic-test-utils": "~2.13.0",
-    "@fluid-private/test-pairwise-generator": "~2.13.0",
+    "@fluid-internal/mocha-test-setup": "~2.20.0",
+    "@fluid-private/stochastic-test-utils": "~2.20.0",
+    "@fluid-private/test-pairwise-generator": "~2.20.0",
     "@fluid-tools/benchmark": "^0.50.0",
     "@fluid-tools/build-cli": "^0.51.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.51.0",
-    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.12.0",
+    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.13.0",
     "@fluidframework/eslint-config-fluid": "^5.6.0",
-    "@fluidframework/test-runtime-utils": "~2.13.0",
+    "@fluidframework/test-runtime-utils": "~2.20.0",
     "@microsoft/api-extractor": "7.47.8",
     "@types/double-ended-queue": "^2.1.0",
+    "@types/lz4js": "^0.2.0",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "@types/sinon": "^17.0.3",
@@ -179,7 +170,29 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Class_ContainerRuntime": {
+        "backCompat": false
+      },
+      "Class_DocumentsSchemaController": {
+        "forwardCompat": false
+      },
+      "ClassStatics_ContainerRuntime": {
+        "backCompat": false
+      },
+      "TypeAlias_SummarizerStopReason": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "Interface_ISummarizeEventProps": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "Interface_ISummarizerEvents": {
+        "backCompat": false,
+        "forwardCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {
@@ -198,7 +211,7 @@
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./internal/test/containerRuntime ./internal/test/deltaScheduler ./internal/test/scheduleManager ./internal/test/blobManager ./internal/test/summary ./internal/test/gc",
+    "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./internal/test/containerRuntime ./internal/test/deltaScheduler ./internal/test/blobManager ./internal/test/summary ./internal/test/gc",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",

package/src/batchTracker.ts

@@ -36,41 +36,38 @@ export class BatchTracker {
 			this.trackedBatchCount++;
 		});
 
-		this.batchEventEmitter.on(
-			"batchEnd",
-			(error: any | undefined, message: BatchTrackerMessage) => {
-				assert(
-					this.startBatchSequenceNumber !== undefined &&
-						this.batchProcessingStartTimeStamp !== undefined,
-					0x2ba /* "batchBegin must fire before batchEnd" */,
-				);
+		this.batchEventEmitter.on("batchEnd", (error: unknown, message: BatchTrackerMessage) => {
+			assert(
+				this.startBatchSequenceNumber !== undefined &&
+					this.batchProcessingStartTimeStamp !== undefined,
+				0x2ba /* "batchBegin must fire before batchEnd" */,
+			);
 
-				const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;
-				if (length >= batchLengthThreshold) {
-					this.logger.sendPerformanceEvent({
-						eventName: "LengthTooBig",
-						length,
-						threshold: batchLengthThreshold,
-						batchEndSequenceNumber: message.sequenceNumber,
-						duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
-						batchError: error !== undefined,
-					});
-				}
+			const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;
+			if (length >= batchLengthThreshold) {
+				this.logger.sendPerformanceEvent({
+					eventName: "LengthTooBig",
+					length,
+					threshold: batchLengthThreshold,
+					batchEndSequenceNumber: message.sequenceNumber,
+					duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
+					batchError: error !== undefined,
+				});
+			}
 
-				if (this.trackedBatchCount % batchCountSamplingRate === 0) {
-					this.logger.sendPerformanceEvent({
-						eventName: "Length",
-						length,
-						samplingRate: batchCountSamplingRate,
-						batchEndSequenceNumber: message.sequenceNumber,
-						duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
-					});
-				}
+			if (this.trackedBatchCount % batchCountSamplingRate === 0) {
+				this.logger.sendPerformanceEvent({
+					eventName: "Length",
+					length,
+					samplingRate: batchCountSamplingRate,
+					batchEndSequenceNumber: message.sequenceNumber,
+					duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
+				});
+			}
 
-				this.startBatchSequenceNumber = undefined;
-				this.batchProcessingStartTimeStamp = undefined;
-			},
-		);
+			this.startBatchSequenceNumber = undefined;
+			this.batchProcessingStartTimeStamp = undefined;
+		});
 	}
 }
 
@@ -87,4 +84,5 @@ export const BindBatchTracker = (
 	logger: ITelemetryLoggerExt,
 	batchLengthThreshold: number = 1000,
 	batchCountSamplingRate: number = 1000,
-) => new BatchTracker(batchEventEmitter, logger, batchLengthThreshold, batchCountSamplingRate);
+): BatchTracker =>
+	new BatchTracker(batchEventEmitter, logger, batchLengthThreshold, batchCountSamplingRate);

package/src/blobManager/blobManager.ts

@@ -80,14 +80,14 @@ export class BlobHandle extends FluidHandleBase<ArrayBufferLike> {
 		this.absolutePath = generateHandleContextPath(path, this.routeContext);
 	}
 
-	public attachGraph() {
+	public attachGraph(): void {
 		if (!this.attached) {
 			this.attached = true;
 			this.onAttachGraph?.();
 		}
 	}
 
-	public bind(handle: IFluidHandleInternal) {
+	public bind(handle: IFluidHandleInternal): void {
 		throw new Error("Cannot bind to blob handle");
 	}
 }
@@ -96,7 +96,7 @@ export class BlobHandle extends FluidHandleBase<ArrayBufferLike> {
 // the contract explicit and reduces the amount of mocking required for tests.
 export type IBlobManagerRuntime = Pick<
 	IContainerRuntime,
-	"attachState" | "connected" | "baseLogger" | "clientDetails"
+	"attachState" | "connected" | "baseLogger" | "clientDetails" | "disposed"
 > &
 	TypedEventEmitter<IContainerRuntimeEvents>;
 
@@ -329,7 +329,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 		);
 	}
 
-	private createAbortError(pending?: PendingBlob) {
+	private createAbortError(pending?: PendingBlob): LoggingError {
 		return new LoggingError("uploadBlob aborted", {
 			acked: pending?.acked,
 			uploadTime: pending?.uploadTime,
@@ -370,8 +370,17 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 		return PerformanceEvent.timedExecAsync(
 			this.mc.logger,
 			{ eventName: "AttachmentReadBlob", id: storageId },
-			async () => {
-				return this.getStorage().readBlob(storageId);
+			async (event) => {
+				return this.getStorage()
+					.readBlob(storageId)
+					.catch((error) => {
+						if (this.runtime.disposed) {
+							// If the runtime is disposed, this is not an error we care to track, it's expected behavior.
+							event.cancel({ category: "generic" });
+						}
+
+						throw error;
+					});
 			},
 			{ end: true, cancel: "error" },
 		);
@@ -445,7 +454,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 		};
 		this.pendingBlobs.set(localId, pendingEntry);
 
-		const abortListener = () => {
+		const abortListener = (): void => {
 			if (!pendingEntry.acked) {
 				pendingEntry.handleP.reject(this.createAbortError(pendingEntry));
 			}
@@ -490,6 +499,8 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 			(error) => {
 				this.mc.logger.sendTelemetryEvent({
 					eventName: "UploadBlobReject",
+					// TODO: better typing
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 					error,
 					localId,
 				});
@@ -506,11 +517,11 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 	 * Set up a mapping in the redirect table from fromId to toId. Also, notify the runtime that a reference is added
 	 * which is required for GC.
 	 */
-	private setRedirection(fromId: string, toId: string | undefined) {
+	private setRedirection(fromId: string, toId: string | undefined): void {
 		this.redirectTable.set(fromId, toId);
 	}
 
-	private deletePendingBlobMaybe(id: string) {
+	private deletePendingBlobMaybe(id: string): void {
 		if (this.pendingBlobs.has(id)) {
 			const entry = this.pendingBlobs.get(id);
 			if (entry?.attached && entry?.acked) {
@@ -519,13 +530,16 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 		}
 	}
 
-	private deletePendingBlob(id: string) {
+	private deletePendingBlob(id: string): void {
 		if (this.pendingBlobs.delete(id) && !this.hasPendingBlobs) {
 			this.emit("noPendingBlobs");
 		}
 	}
 
-	private onUploadResolve(localId: string, response: ICreateBlobResponseWithTTL) {
+	private onUploadResolve(
+		localId: string,
+		response: ICreateBlobResponseWithTTL,
+	): ICreateBlobResponseWithTTL | undefined {
 		const entry = this.pendingBlobs.get(localId);
 		if (entry === undefined && this.pendingStashedBlobs.has(localId)) {
 			// The blob was already processed and deleted. This can happen if the blob was reuploaded by
@@ -587,7 +601,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 	 * submitted to runtime while disconnected.
 	 * @param metadata - op metadata containing storage and/or local IDs
 	 */
-	public reSubmit(metadata: Record<string, unknown> | undefined) {
+	public reSubmit(metadata: Record<string, unknown> | undefined): void {
 		assert(!!metadata, 0x38b /* Resubmitted ops must have metadata */);
 		const { localId, blobId }: { localId?: string; blobId?: string } = metadata;
 		assert(localId !== undefined, 0x50d /* local ID not available on reSubmit */);
@@ -604,7 +618,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 		return this.sendBlobAttachOp(localId, blobId);
 	}
 
-	public processBlobAttachMessage(message: ISequencedMessageEnvelope, local: boolean) {
+	public processBlobAttachMessage(message: ISequencedMessageEnvelope, local: boolean): void {
 		const localId = (message.metadata as IBlobMetadata | undefined)?.localId;
 		const blobId = (message.metadata as IBlobMetadata | undefined)?.blobId;
 
@@ -694,16 +708,20 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 
 	/**
 	 * Delete blobs with the given routes from the redirect table.
+	 *
+	 * @remarks
 	 * The routes are GC nodes paths of format -`/<blobManagerBasePath>/<blobId>`. The blob ids are all local ids.
 	 * Deleting the blobs involves 2 steps:
+	 *
 	 * 1. The redirect table entry for the local ids are deleted.
+	 *
 	 * 2. If the storage ids corresponding to the deleted local ids are not in-use anymore, the redirect table entries
 	 * for the storage ids are deleted as well.
 	 *
 	 * Note that this does not delete the blobs from storage service immediately. Deleting the blobs from redirect table
 	 * will remove them the next summary. The service would them delete them some time in the future.
 	 */
-	private deleteBlobsFromRedirectTable(blobRoutes: readonly string[]) {
+	private deleteBlobsFromRedirectTable(blobRoutes: readonly string[]): void {
 		if (blobRoutes.length === 0) {
 			return;
 		}
@@ -753,7 +771,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 	 * Verifies that the blob with given id is not deleted, i.e., it has not been garbage collected. If the blob is GC'd,
 	 * log an error and throw if necessary.
 	 */
-	private verifyBlobNotDeleted(blobId: string) {
+	private verifyBlobNotDeleted(blobId: string): void {
 		if (!this.isBlobDeleted(getGCNodePathFromBlobId(blobId))) {
 			return;
 		}
@@ -774,7 +792,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 		throw error;
 	}
 
-	public setRedirectTable(table: Map<string, string>) {
+	public setRedirectTable(table: Map<string, string>): void {
 		assert(
 			this.runtime.attachState === AttachState.Detached,
 			0x252 /* "redirect table can only be set in detached container" */,
@@ -841,7 +859,7 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
 										},
 										{ once: true },
 									);
-									const onBlobAttached = (attachedEntry) => {
+									const onBlobAttached = (attachedEntry): void => {
 										if (attachedEntry === entry) {
 											this.off("blobAttached", onBlobAttached);
 											resolve();
@@ -891,12 +909,13 @@ export class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
  * This path must match the path of the blob handle returned by the createBlob API because blobs are marked
  * referenced by storing these handles in a referenced DDS.
  */
-const getGCNodePathFromBlobId = (blobId: string) => `/${blobManagerBasePath}/${blobId}`;
+const getGCNodePathFromBlobId = (blobId: string): string =>
+	`/${blobManagerBasePath}/${blobId}`;
 
 /**
  * For a given GC node path, return the blobId. The node path is of the format `/<basePath>/<blobId>`.
  */
-const getBlobIdFromGCNodePath = (nodePath: string) => {
+const getBlobIdFromGCNodePath = (nodePath: string): string => {
 	const pathParts = nodePath.split("/");
 	assert(areBlobPathParts(pathParts), 0x5bd /* Invalid blob node path */);
 	return pathParts[2];

package/src/blobManager/blobManagerSnapSum.ts

@@ -47,7 +47,7 @@ const loadV1 = async (
 		return {};
 	}
 	let redirectTableEntries: [string, string][] = [];
-	const tableId: string | undefined = blobsTree.blobs[redirectTableBlobName];
+	const tableId = blobsTree.blobs[redirectTableBlobName];
 	if (tableId) {
 		redirectTableEntries = await readAndParse(context.storage, tableId);
 	}
@@ -116,7 +116,7 @@ const summarizeV1 = (
 export const getStorageIds = (
 	redirectTable: Map<string, string | undefined>,
 	attachState: AttachState,
-) => {
+): Set<string> => {
 	const ids = new Set<string | undefined>(redirectTable.values());
 
 	// If we are detached, we will not have storage IDs, only undefined