@fluidframework/datastore 2.41.0 → 2.42.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.41.0",
+  "version": "2.42.0",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,29 +69,29 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.41.0",
-    "@fluidframework/container-definitions": "~2.41.0",
-    "@fluidframework/core-interfaces": "~2.41.0",
-    "@fluidframework/core-utils": "~2.41.0",
-    "@fluidframework/datastore-definitions": "~2.41.0",
-    "@fluidframework/driver-definitions": "~2.41.0",
-    "@fluidframework/driver-utils": "~2.41.0",
-    "@fluidframework/id-compressor": "~2.41.0",
-    "@fluidframework/runtime-definitions": "~2.41.0",
-    "@fluidframework/runtime-utils": "~2.41.0",
-    "@fluidframework/telemetry-utils": "~2.41.0",
+    "@fluid-internal/client-utils": "~2.42.0",
+    "@fluidframework/container-definitions": "~2.42.0",
+    "@fluidframework/core-interfaces": "~2.42.0",
+    "@fluidframework/core-utils": "~2.42.0",
+    "@fluidframework/datastore-definitions": "~2.42.0",
+    "@fluidframework/driver-definitions": "~2.42.0",
+    "@fluidframework/driver-utils": "~2.42.0",
+    "@fluidframework/id-compressor": "~2.42.0",
+    "@fluidframework/runtime-definitions": "~2.42.0",
+    "@fluidframework/runtime-utils": "~2.42.0",
+    "@fluidframework/telemetry-utils": "~2.42.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.41.0",
+    "@fluid-internal/mocha-test-setup": "~2.42.0",
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
-    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.40.0",
+    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.41.0",
     "@fluidframework/eslint-config-fluid": "^5.7.4",
-    "@fluidframework/test-runtime-utils": "~2.41.0",
+    "@fluidframework/test-runtime-utils": "~2.42.0",
     "@microsoft/api-extractor": "7.52.8",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^10.0.10",

package/src/dataStoreRuntime.ts

@@ -27,6 +27,8 @@ import {
 	IFluidDataStoreRuntime,
 	IFluidDataStoreRuntimeEvents,
 	type IDeltaManagerErased,
+	// eslint-disable-next-line import/no-deprecated
+	type IFluidDataStoreRuntimeExperimental,
 } from "@fluidframework/datastore-definitions/internal";
 import {
 	IClientDetails,
@@ -148,6 +150,22 @@ const defaultPolicies: IFluidDataStorePolicies = {
 	readonlyInStagingMode: true,
 };
 
+/**
+ * Set up the boxed pendingOpCount value.
+ */
+function initializePendingOpCount(): { value: number } {
+	let value = 0;
+	return {
+		get value() {
+			return value;
+		},
+		set value(newValue: number) {
+			assert(newValue >= 0, 0xbbd /* pendingOpCount must be non-negative */);
+			value = newValue;
+		},
+	};
+}
+
 /**
  * Base data store class
  * @legacy
@@ -421,17 +439,30 @@ export class FluidDataStoreRuntime
 		this.localChangesTelemetryCount =
 			this.mc.config.getNumber("Fluid.Telemetry.LocalChangesTelemetryCount") ?? 10;
 
-		// eslint-disable-next-line import/no-deprecated
-		const base: IContainerRuntimeBaseExperimental | undefined =
+		// Reference these properties to avoid unused private member errors.
+		// They're accessed via IFluidDataStoreRuntimeExperimental interface.
+		// eslint-disable-next-line no-void
+		void [this.inStagingMode, this.isDirty];
+	}
+
+	/**
+	 * Implementation of IFluidDataStoreRuntimeExperimental.inStagingMode
+	 */
+	// eslint-disable-next-line import/no-deprecated
+	private get inStagingMode(): IFluidDataStoreRuntimeExperimental["inStagingMode"] {
+		return (
 			// eslint-disable-next-line import/no-deprecated
-			this.dataStoreContext.containerRuntime satisfies IContainerRuntimeBaseExperimental;
-		if (base !== undefined && "inStagingMode" in base) {
-			Object.defineProperty(this, "inStagingMode", {
-				get: () => {
-					return base.inStagingMode;
-				},
-			});
-		}
+			(this.dataStoreContext.containerRuntime as IContainerRuntimeBaseExperimental)
+				?.inStagingMode
+		);
+	}
+
+	/**
+	 * Implementation of IFluidDataStoreRuntimeExperimental.isDirty
+	 */
+	// eslint-disable-next-line import/no-deprecated
+	private get isDirty(): IFluidDataStoreRuntimeExperimental["isDirty"] {
+		return this.pendingOpCount.value > 0;
 	}
 
 	get deltaManager(): IDeltaManagerErased {
@@ -873,7 +904,12 @@ export class FluidDataStoreRuntime
 	public processMessages(messageCollection: IRuntimeMessageCollection): void {
 		this.verifyNotClosed();
 
-		const { envelope, messagesContent } = messageCollection;
+		const { envelope, local, messagesContent } = messageCollection;
+
+		if (local) {
+			this.pendingOpCount.value -= messagesContent.length;
+		}
+
 		try {
 			switch (envelope.type) {
 				case DataStoreMessageType.ChannelOp: {
@@ -1219,6 +1255,12 @@ export class FluidDataStoreRuntime
 		this.submit(DataStoreMessageType.ChannelOp, envelope, localOpMetadata);
 	}
 
+	/**
+	 * Count of pending ops that have been submitted but not yet ack'd.
+	 * Used to compute {@link FluidDataStoreRuntime.isDirty}
+	 */
+	private readonly pendingOpCount: { value: number } = initializePendingOpCount();
+
 	private submit(
 		type: DataStoreMessageType,
 		content: unknown,
@@ -1226,6 +1268,7 @@ export class FluidDataStoreRuntime
 	): void {
 		this.verifyNotClosed();
 		this.dataStoreContext.submitMessage(type, content, localOpMetadata);
+		++this.pendingOpCount.value;
 	}
 
 	/**
@@ -1245,12 +1288,17 @@ export class FluidDataStoreRuntime
 	): void {
 		this.verifyNotClosed();
 
+		// The op being resubmitted was not / will not be submitted, so decrement the count.
+		// The calls below may result in one or more ops submitted again, which will increment the count (or not if nothing needs to be submitted anymore).
+		--this.pendingOpCount.value;
+
 		switch (type) {
 			case DataStoreMessageType.ChannelOp: {
 				// For Operations, find the right channel and trigger resubmission on it.
 				const envelope = content as IEnvelope;
 				const channelContext = this.contexts.get(envelope.address);
 				assert(!!channelContext, 0x183 /* "There should be a channel context for the op" */);
+
 				channelContext.reSubmit(envelope.contents, localOpMetadata, squash);
 				break;
 			}
@@ -1279,12 +1327,16 @@ export class FluidDataStoreRuntime
 	): void {
 		this.verifyNotClosed();
 
+		// The op being rolled back was not/will not be submitted, so decrement the count.
+		--this.pendingOpCount.value;
+
 		switch (type) {
 			case DataStoreMessageType.ChannelOp: {
 				// For Operations, find the right channel and trigger resubmission on it.
 				const envelope = content as IEnvelope;
 				const channelContext = this.contexts.get(envelope.address);
 				assert(!!channelContext, 0x2ed /* "There should be a channel context for the op" */);
+
 				channelContext.rollback(envelope.contents, localOpMetadata);
 				break;
 			}
@@ -1297,6 +1349,10 @@ export class FluidDataStoreRuntime
 	// TODO: use something other than `any` here
 	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 	public async applyStashedOp(content: any): Promise<unknown> {
+		// The op being applied may have been submitted in a previous session, so we increment the count here.
+		// Either the ack will arrive and be processed, or that previous session's connection will end, at which point the op will be resubmitted.
+		++this.pendingOpCount.value;
+
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 		const type = content?.type as DataStoreMessageType;
 		switch (type) {
@@ -1336,6 +1392,13 @@ export class FluidDataStoreRuntime
 		}
 	}
 
+	/**
+	 * Indicates the given channel is dirty from Summarizer's point of view,
+	 * i.e. it has local changes that need to be included in the summary.
+	 *
+	 * @remarks - If a channel's changes are rolled back or rebased away, we won't
+	 * clear the dirty flag set here.
+	 */
 	private setChannelDirty(address: string): void {
 		this.verifyNotClosed();
 		this.dataStoreContext.setChannelDirty(address);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.41.0";
+export const pkgVersion = "2.42.0";