@fluidframework/container-runtime 2.70.0-361092 → 2.70.0-361788

package/src/opLifecycle/opGroupingManager.ts

@@ -72,7 +72,7 @@ export class OpGroupingManager {
 	 * This is needed as a placeholder if a batch becomes empty on resubmit, but we are tracking batch IDs.
 	 * @param resubmittingBatchId - batch ID of the resubmitting batch
 	 * @param referenceSequenceNumber - reference sequence number
-	 * @returns - The outbound batch as well as the interior placeholder message
+	 * @returns The outbound batch as well as the interior placeholder message
 	 */
 	public createEmptyGroupedBatch(
 		resubmittingBatchId: string,
@@ -112,7 +112,7 @@ export class OpGroupingManager {
 	 *
 	 * If the batch already has only 1 message, it is returned as-is.
 	 *
-	 * @remarks - Remember that a BatchMessage has its content JSON serialized, so the incoming batch message contents
+	 * @remarks Remember that a BatchMessage has its content JSON serialized, so the incoming batch message contents
 	 * must be parsed first, and then the type and contents mentioned above are hidden in that JSON serialization.
 	 */
 	public groupBatch(batch: OutboundBatch): OutboundSingletonBatch {
@@ -132,7 +132,7 @@ export class OpGroupingManager {
 			});
 		}
 		// We expect this will be on the first message, if present at all.
-		let groupedBatchId;
+		let groupedBatchId: unknown;
 		for (const message of batch.messages) {
 			if (message.metadata !== undefined) {
 				const { batch: _batch, batchId, ...rest } = message.metadata;
@@ -146,7 +146,10 @@ export class OpGroupingManager {
 		const serializedContent = JSON.stringify({
 			type: OpGroupingManager.groupedBatchOp,
 			contents: batch.messages.map<IGroupedMessage>((message) => ({
-				contents: message.contents === undefined ? undefined : JSON.parse(message.contents),
+				contents:
+					message.contents === undefined
+						? undefined
+						: (JSON.parse(message.contents) as unknown),
 				metadata: message.metadata,
 				compression: message.compression,
 			})),

package/src/opLifecycle/opSerialization.ts

@@ -18,7 +18,7 @@ import type { EmptyGroupedBatch } from "./opGroupingManager.js";
  * Takes an incoming runtime message (outer type "op"), JSON.parses the message's contents in place,
  * if needed (old Loader does this for us).
  * Only to be used for runtime messages. The contents here would be the virtualized payload for a batch of ops.
- * @remarks - Serialization during submit happens via {@link serializeOp}
+ * @remarks Serialization during submit happens via {@link serializeOp}
  * @param mutableMessage - op message received
  */
 export function ensureContentsDeserialized(mutableMessage: ISequencedDocumentMessage): void {
@@ -31,7 +31,7 @@ export function ensureContentsDeserialized(mutableMessage: ISequencedDocumentMes
 
 /**
  * Before submitting an op to the Outbox, its contents must be serialized using this function.
- * @remarks - The deserialization on process happens via the function {@link ensureContentsDeserialized}.
+ * @remarks The deserialization on process happens via the function {@link ensureContentsDeserialized}.
  *
  * @param toSerialize - op message to serialize. Also supports an array of ops.
  */

package/src/opLifecycle/opSplitter.ts

@@ -118,7 +118,7 @@ export class OpSplitter {
 	 * To illustrate the current functionality, if the input is `[largeOp]`, `largeOp` will be split into `[chunk1, chunk2, chunk3, chunk4]`.
 	 * `chunk1`, `chunk2` and `chunk3` will be sent individually and `[chunk4]` will be returned.
 	 *
-	 * @remarks - A side effect here is that 1 or more chunks are queued immediately for sending in next JS turn.
+	 * @remarks A side effect here is that 1 or more chunks are queued immediately for sending in next JS turn.
 	 *
 	 * @privateRemarks
 	 * This maintains support for splitting a compressed batch with multiple messages (empty placeholders after the first),

package/src/opLifecycle/outbox.ts

@@ -252,7 +252,7 @@ export class Outbox {
 	 * message as the first message. If flushing partial batch is not enabled, we will throw (except for reentrant ops).
 	 * This would indicate we expected this case to be precluded by logic elsewhere.
 	 *
-	 * @remarks - To detect batch interruption, we compare both the reference sequence number
+	 * @remarks To detect batch interruption, we compare both the reference sequence number
 	 * (i.e. last message processed by DeltaManager) and the client sequence number of the
 	 * last message processed by the ContainerRuntime. In the absence of op reentrancy, this
 	 * pair will remain stable during a single JS turn during which the batch is being built up.
@@ -365,6 +365,16 @@ export class Outbox {
 	 * @param resubmitInfo - Key information when flushing a resubmitted batch. Undefined means this is not resubmit.
 	 */
 	public flush(resubmitInfo?: BatchResubmitInfo): void {
+		// We have nothing to flush if all batchManagers are empty, and we we're not needing to resubmit an empty batch placeholder
+		if (
+			this.idAllocationBatch.empty &&
+			this.blobAttachBatch.empty &&
+			this.mainBatch.empty &&
+			resubmitInfo?.batchId === undefined
+		) {
+			return;
+		}
+
 		assert(
 			!this.isContextReentrant(),
 			0xb7b /* Flushing must not happen while incoming changes are being processed */,
@@ -539,7 +549,7 @@ export class Outbox {
 	/**
 	 * As necessary and enabled, groups / compresses / chunks the given batch.
 	 *
-	 * @remarks - If chunking happens, a side effect here is that 1 or more chunks are queued immediately for sending in next JS turn.
+	 * @remarks If chunking happens, a side effect here is that 1 or more chunks are queued immediately for sending in next JS turn.
 	 *
 	 * @param localBatch - Local Batch to be virtualized - i.e. transformed into an Outbound Batch
 	 * @param groupingEnabled - If true, Grouped batching is enabled.

package/src/packageVersion.ts

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

package/src/pendingStateManager.ts

@@ -608,7 +608,7 @@ export class PendingStateManager implements IDisposable {
 	 * @param sequenceNumber - The sequenceNumber from the server corresponding to the next pending message.
 	 * @param message - [optional] The entire incoming message, for comparing contents with the pending message for extra validation.
 	 * @throws DataProcessingError if the pending message content doesn't match the incoming message content.
-	 * @returns - The localOpMetadata of the next pending message, to be sent to whoever submitted the original message.
+	 * @returns The localOpMetadata of the next pending message, to be sent to whoever submitted the original message.
 	 */
 	private processNextPendingMessage(
 		sequenceNumber: number,

package/src/runtimeLayerCompatState.ts

@@ -3,17 +3,19 @@
  * Licensed under the MIT License.
  */
 
-import {
-	checkLayerCompatibility,
-	type ILayerCompatDetails,
-	type ILayerCompatSupportRequirements,
+import type {
+	ILayerCompatDetails,
+	ILayerCompatSupportRequirements,
 } from "@fluid-internal/client-utils";
 import type { ICriticalContainerError } from "@fluidframework/container-definitions";
 import {
 	encodeHandlesInContainerRuntime,
 	notifiesReadOnlyState,
 } from "@fluidframework/runtime-definitions/internal";
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
+import {
+	validateLayerCompatibility,
+	type ITelemetryLoggerExt,
+} from "@fluidframework/telemetry-utils/internal";
 
 import { pkgVersion } from "./packageVersion.js";
 
@@ -95,26 +97,17 @@ export const dataStoreSupportRequirementsForRuntime: ILayerCompatSupportRequirem
 export function validateLoaderCompatibility(
 	maybeLoaderCompatDetailsForRuntime: ILayerCompatDetails | undefined,
 	disposeFn: (error?: ICriticalContainerError) => void,
+	logger: ITelemetryLoggerExt,
 ): void {
-	const layerCheckResult = checkLayerCompatibility(
+	validateLayerCompatibility(
+		"runtime",
+		"loader",
+		runtimeCompatDetailsForLoader,
 		loaderSupportRequirementsForRuntime,
 		maybeLoaderCompatDetailsForRuntime,
+		disposeFn,
+		logger,
 	);
-	if (!layerCheckResult.isCompatible) {
-		const error = new UsageError("Runtime is not compatible with Loader", {
-			errorDetails: JSON.stringify({
-				runtimeVersion: runtimeCoreCompatDetails.pkgVersion,
-				loaderVersion: maybeLoaderCompatDetailsForRuntime?.pkgVersion,
-				runtimeGeneration: runtimeCoreCompatDetails.generation,
-				loaderGeneration: maybeLoaderCompatDetailsForRuntime?.generation,
-				minSupportedGeneration: loaderSupportRequirementsForRuntime.minSupportedGeneration,
-				isGenerationCompatible: layerCheckResult.isGenerationCompatible,
-				unsupportedFeatures: layerCheckResult.unsupportedFeatures,
-			}),
-		});
-		disposeFn(error);
-		throw error;
-	}
 }
 
 /**
@@ -122,26 +115,17 @@ export function validateLoaderCompatibility(
  * @internal
  */
 export function validateDatastoreCompatibility(
-	maybeDataStoreCompatDetails: ILayerCompatDetails | undefined,
+	maybeDataStoreCompatDetailsForRuntime: ILayerCompatDetails | undefined,
 	disposeFn: () => void,
+	logger: ITelemetryLoggerExt,
 ): void {
-	const layerCheckResult = checkLayerCompatibility(
+	validateLayerCompatibility(
+		"runtime",
+		"dataStore",
+		runtimeCompatDetailsForDataStore,
 		dataStoreSupportRequirementsForRuntime,
-		maybeDataStoreCompatDetails,
+		maybeDataStoreCompatDetailsForRuntime,
+		disposeFn,
+		logger,
 	);
-	if (!layerCheckResult.isCompatible) {
-		const error = new UsageError("Runtime is not compatible with DataStore", {
-			errorDetails: JSON.stringify({
-				runtimeVersion: runtimeCoreCompatDetails.pkgVersion,
-				dataStoreVersion: maybeDataStoreCompatDetails?.pkgVersion,
-				runtimeGeneration: runtimeCoreCompatDetails.generation,
-				dataStoreGeneration: maybeDataStoreCompatDetails?.generation,
-				minSupportedGeneration: dataStoreSupportRequirementsForRuntime.minSupportedGeneration,
-				isGenerationCompatible: layerCheckResult.isGenerationCompatible,
-				unsupportedFeatures: layerCheckResult.unsupportedFeatures,
-			}),
-		});
-		disposeFn();
-		throw error;
-	}
 }

package/src/storageServiceWithAttachBlobs.ts

@@ -3,20 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type {
-	FetchSource,
-	ICreateBlobResponse,
-	IDocumentStorageServicePolicies,
-	ISnapshot,
-	ISnapshotFetchOptions,
-	ISnapshotTree,
-	ISummaryContext,
-	ISummaryHandle,
-	ISummaryTree,
-	IVersion,
-} from "@fluidframework/driver-definitions/internal";
 import type { IRuntimeStorageService } from "@fluidframework/runtime-definitions/internal";
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * IRuntimeStorageService proxy which intercepts requests if they can be satisfied by the blobs received in the
@@ -28,14 +15,6 @@ export class StorageServiceWithAttachBlobs implements IRuntimeStorageService {
 		private readonly attachBlobs: Map<string, ArrayBufferLike>,
 	) {}
 
-	/**
-	 * {@link IRuntimeStorageService.policies}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public get policies(): IDocumentStorageServicePolicies | undefined {
-		return this.internalStorageService.policies;
-	}
-
 	public async readBlob(id: string): Promise<ArrayBufferLike> {
 		const blob = this.attachBlobs.get(id);
 		if (blob !== undefined) {
@@ -46,75 +25,4 @@ export class StorageServiceWithAttachBlobs implements IRuntimeStorageService {
 		// IRuntimeStorageService to cache appropriately, no need to double-cache.
 		return this.internalStorageService.readBlob(id);
 	}
-
-	/**
-	 * {@link IRuntimeStorageService.getSnapshotTree}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public async getSnapshotTree(
-		version?: IVersion,
-		scenarioName?: string,
-		// eslint-disable-next-line @rushstack/no-new-null
-	): Promise<ISnapshotTree | null> {
-		return this.internalStorageService.getSnapshotTree(version, scenarioName);
-	}
-
-	/**
-	 * {@link IRuntimeStorageService.getSnapshot}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public async getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot> {
-		if (this.internalStorageService.getSnapshot !== undefined) {
-			return this.internalStorageService.getSnapshot(snapshotFetchOptions);
-		}
-		throw new UsageError(
-			"getSnapshot api should exist on internal storage in documentStorageServiceProxy class",
-		);
-	}
-
-	/**
-	 * {@link IRuntimeStorageService.getVersions}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public async getVersions(
-		// eslint-disable-next-line @rushstack/no-new-null
-		versionId: string | null,
-		count: number,
-		scenarioName?: string,
-		fetchSource?: FetchSource,
-	): Promise<IVersion[]> {
-		return this.internalStorageService.getVersions(
-			versionId,
-			count,
-			scenarioName,
-			fetchSource,
-		);
-	}
-
-	/**
-	 * {@link IRuntimeStorageService.uploadSummaryWithContext}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public async uploadSummaryWithContext(
-		summary: ISummaryTree,
-		context: ISummaryContext,
-	): Promise<string> {
-		return this.internalStorageService.uploadSummaryWithContext(summary, context);
-	}
-
-	/**
-	 * {@link IRuntimeStorageService.createBlob}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
-		return this.internalStorageService.createBlob(file);
-	}
-
-	/**
-	 * {@link IRuntimeStorageService.downloadSummary}.
-	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
-	 */
-	public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {
-		return this.internalStorageService.downloadSummary(handle);
-	}
 }

package/src/summary/documentSchema.ts

@@ -740,7 +740,7 @@ export class DocumentsSchemaController {
 	 * @param contents - contents of the messages
 	 * @param local - whether op is local
 	 * @param sequenceNumber - sequence number of the op
-	 * @returns - true if schema was accepted, otherwise false (rejected due to failed CAS)
+	 * @returns true if schema was accepted, otherwise false (rejected due to failed CAS)
 	 */
 	public processDocumentSchemaMessages(
 		contents: IDocumentSchemaChangeMessageIncoming[],

package/src/summary/summaryFormat.ts

@@ -23,7 +23,7 @@ import type { IGCMetadata } from "../gc/index.js";
 import type { IDocumentSchema } from "./documentSchema.js";
 
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export type OmitAttributesVersions<T> = Omit<
@@ -32,7 +32,7 @@ export type OmitAttributesVersions<T> = Omit<
 >;
 
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export interface IFluidDataStoreAttributes0 {
@@ -48,7 +48,7 @@ export interface IFluidDataStoreAttributes0 {
 }
 
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export interface IFluidDataStoreAttributes1
@@ -58,7 +58,7 @@ export interface IFluidDataStoreAttributes1
 }
 
 /**
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  * @legacy @beta
  */
 export interface IFluidDataStoreAttributes2
@@ -81,7 +81,7 @@ export interface IFluidDataStoreAttributes2
  * store like the package, snapshotFormatVersion to take different decisions based on a particular
  * snapshotFormatVersion.
  *
- * @deprecated - This interface will no longer be exported in the future(AB#8004).
+ * @deprecated This interface will no longer be exported in the future(AB#8004).
  *
  * @legacy @beta
  *
@@ -126,7 +126,7 @@ export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): b
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
 	readonly summaryFormatVersion: 1;
 	/**
-	 * @deprecated - used by old (prior to 2.0 RC3) runtimes
+	 * @deprecated used by old (prior to 2.0 RC3) runtimes
 	 */
 	readonly message?: ISummaryMetadataMessage;
 	/**