@fluidframework/map 2.74.0 → 2.81.0-374083

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.74.0",
+  "version": "2.81.0-374083",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -81,45 +81,45 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.74.0",
-    "@fluidframework/core-interfaces": "~2.74.0",
-    "@fluidframework/core-utils": "~2.74.0",
-    "@fluidframework/datastore-definitions": "~2.74.0",
-    "@fluidframework/driver-definitions": "~2.74.0",
-    "@fluidframework/driver-utils": "~2.74.0",
-    "@fluidframework/runtime-definitions": "~2.74.0",
-    "@fluidframework/runtime-utils": "~2.74.0",
-    "@fluidframework/shared-object-base": "~2.74.0",
-    "@fluidframework/telemetry-utils": "~2.74.0",
+    "@fluid-internal/client-utils": "2.81.0-374083",
+    "@fluidframework/core-interfaces": "2.81.0-374083",
+    "@fluidframework/core-utils": "2.81.0-374083",
+    "@fluidframework/datastore-definitions": "2.81.0-374083",
+    "@fluidframework/driver-definitions": "2.81.0-374083",
+    "@fluidframework/driver-utils": "2.81.0-374083",
+    "@fluidframework/runtime-definitions": "2.81.0-374083",
+    "@fluidframework/runtime-utils": "2.81.0-374083",
+    "@fluidframework/shared-object-base": "2.81.0-374083",
+    "@fluidframework/telemetry-utils": "2.81.0-374083",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
+    "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.74.0",
-    "@fluid-private/stochastic-test-utils": "~2.74.0",
-    "@fluid-private/test-dds-utils": "~2.74.0",
-    "@fluid-tools/benchmark": "^0.51.0",
-    "@fluid-tools/build-cli": "^0.61.0",
+    "@fluid-internal/mocha-test-setup": "2.81.0-374083",
+    "@fluid-private/stochastic-test-utils": "2.81.0-374083",
+    "@fluid-private/test-dds-utils": "2.81.0-374083",
+    "@fluid-tools/benchmark": "^0.52.0",
+    "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.61.0",
-    "@fluidframework/container-definitions": "~2.74.0",
-    "@fluidframework/eslint-config-fluid": "~2.74.0",
-    "@fluidframework/map-previous": "npm:@fluidframework/map@2.73.0",
-    "@fluidframework/test-runtime-utils": "~2.74.0",
+    "@fluidframework/build-tools": "^0.63.0",
+    "@fluidframework/container-definitions": "2.81.0-374083",
+    "@fluidframework/eslint-config-fluid": "2.81.0-374083",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@2.80.0",
+    "@fluidframework/test-runtime-utils": "2.81.0-374083",
     "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "@types/path-browserify": "^1.0.0",
     "c8": "^10.1.3",
-    "concurrently": "^8.2.1",
+    "concurrently": "^9.2.1",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.3",
-    "eslint": "~8.57.1",
+    "cross-env": "^10.1.0",
+    "eslint": "~9.39.1",
     "jiti": "^2.6.1",
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
-    "rimraf": "^4.4.0",
+    "rimraf": "^6.1.2",
     "typescript": "~5.4.5"
   },
   "typeValidation": {

package/src/directory.ts

@@ -3,6 +3,9 @@
  * Licensed under the MIT License.
  */
 
+// TODO: Fix prefer-nullish-coalescing and prefer-optional-chain lint violations
+/* eslint-disable @typescript-eslint/prefer-nullish-coalescing, @typescript-eslint/prefer-optional-chain */
+
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import type {
@@ -40,7 +43,7 @@ import type {
 	IDirectoryEvents,
 	IDirectoryValueChanged,
 	ISharedDirectory,
-	ISharedDirectoryEventsInternal,
+	ISharedDirectoryEvents,
 	IValueChanged,
 } from "./interfaces.js";
 import type {
@@ -402,7 +405,7 @@ interface SequenceData {
  * @sealed
  */
 export class SharedDirectory
-	extends SharedObject<ISharedDirectoryEventsInternal>
+	extends SharedObject<ISharedDirectoryEvents>
 	implements ISharedDirectory
 {
 	/**
@@ -525,7 +528,7 @@ export class SharedDirectory
 	// TODO: Use `unknown` instead (breaking change).
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public forEach(callback: (value: any, key: string, map: Map<string, any>) => void): void {
-		// eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
+		// eslint-disable-next-line unicorn/no-array-for-each
 		this.root.forEach(callback);
 	}
 
@@ -1512,7 +1515,11 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		if (!this.directory.isAttached()) {
 			const successfullyRemoved = this.sequencedStorageData.delete(key);
 			// Only emit if we actually deleted something.
-			if (previousOptimisticLocalValue !== undefined && successfullyRemoved) {
+			if (
+				this.isNotDisposedAndReachable() &&
+				previousOptimisticLocalValue !== undefined &&
+				successfullyRemoved
+			) {
 				const event: IDirectoryValueChanged = {
 					key,
 					path: this.absolutePath,
@@ -1545,7 +1552,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		// Only emit if we locally believe we deleted something.  Otherwise we still send the op
 		// (permitting speculative deletion even if we don't see anything locally) but don't emit
 		// a valueChanged since we in fact did not locally observe a value change.
-		if (previousOptimisticLocalValue !== undefined) {
+		if (this.isNotDisposedAndReachable() && previousOptimisticLocalValue !== undefined) {
 			const event: IDirectoryValueChanged = {
 				key,
 				path: this.absolutePath,
@@ -1570,7 +1577,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		if (!this.directory.isAttached()) {
 			this.sequencedStorageData.clear();
 			this.directory.emit("clear", true, this.directory);
-			this.directory.emit("clearInternal", this.absolutePath, true, this.directory);
+			this.directory.emit("cleared", this.absolutePath, true, this.directory);
 			return;
 		}
 
@@ -1582,7 +1589,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		this.pendingStorageData.push(pendingClear);
 
 		this.directory.emit("clear", true, this.directory);
-		this.directory.emit("clearInternal", this.absolutePath, true, this.directory);
+		this.directory.emit("cleared", this.absolutePath, true, this.directory);
 		const op: IDirectoryOperation = {
 			type: "clear",
 			path: this.absolutePath,
@@ -1859,6 +1866,29 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		return subdir;
 	};
 
+	/**
+	 * Checks if this directory should be considered visible in the optimistic view.
+	 * This requires both:
+	 * 1. The directory object must not be disposed (disposed = true means fully deleted)
+	 * 2. The directory must be reachable via getWorkingDirectory (respects pending deletes)
+	 *
+	 * There's a timing window where a directory has a pending delete but is not yet disposed:
+	 * - When deleteSubDirectory is called locally, it adds a pending delete entry and emits a
+	 * "dispose" event, but doesn't set disposed = true yet.
+	 * - The directory only gets fully disposed when the delete message is sequenced.
+	 * - During this window, !disposed is true but getWorkingDirectory returns undefined.
+	 *
+	 * This method should be used before emitting events during remote message processing to ensure
+	 * events aren't emitted for directories that are invisible in the optimistic view.
+	 *
+	 * @returns true if this directory is visible in the optimistic view, false otherwise
+	 */
+	private isNotDisposedAndReachable(): boolean {
+		return (
+			!this.disposed && this.directory.getWorkingDirectory(this.absolutePath) !== undefined
+		);
+	}
+
 	public get sequencedSubdirectories(): ReadonlyMap<string, SubDirectory> {
 		this.throwIfDisposed();
 		return this._sequencedSubdirectories;
@@ -1907,14 +1937,19 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 
 			// Only emit for remote ops, we would have already emitted for local ops. Only emit if there
 			// is no optimistically-applied local pending clear that would supersede this remote clear.
+			// Don't emit events if this directory has been disposed or no longer exists
 			if (!this.pendingStorageData.some((entry) => entry.type === "clear")) {
 				this.directory.emit("clear", local, this.directory);
-				this.directory.emit("clearInternal", this.absolutePath, local, this.directory);
+				this.directory.emit("cleared", this.absolutePath, local, this.directory);
 			}
 
 			// For pending set operations, emit valueChanged events
 			// Include 'path' so listeners can identify which subdirectory the change occurred in
 			for (const { key, previousValue } of pendingSets) {
+				// Stop emitting events if this directory has been disposed or is no longer reachable
+				if (!this.isNotDisposedAndReachable()) {
+					break;
+				}
 				this.directory.emit(
 					"valueChanged",
 					{
@@ -1967,6 +2002,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 			this.sequencedStorageData.delete(op.key);
 			// Suppress the event if local changes would cause the incoming change to be invisible optimistically.
 			if (
+				this.isNotDisposedAndReachable() &&
 				!this.pendingStorageData.some(
 					(entry) => entry.type === "clear" || entry.key === op.key,
 				)
@@ -2032,6 +2068,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 
 			// Suppress the event if local changes would cause the incoming change to be invisible optimistically.
 			if (
+				this.isNotDisposedAndReachable() &&
 				!this.pendingStorageData.some((entry) => entry.type === "clear" || entry.key === key)
 			) {
 				const event: IDirectoryValueChanged = { key, path: this.absolutePath, previousValue };
@@ -2121,7 +2158,10 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 			this._sequencedSubdirectories.set(op.subdirName, subDir);
 
 			// Suppress the event if local changes would cause the incoming change to be invisible optimistically.
-			if (!this.pendingSubDirectoryData.some((entry) => entry.subdirName === op.subdirName)) {
+			if (
+				!this.pendingSubDirectoryData.some((entry) => entry.subdirName === op.subdirName) &&
+				subDir.isNotDisposedAndReachable()
+			) {
 				this.emit("subDirectoryCreated", op.subdirName, local, this);
 			}
 		}

package/src/interfaces.ts

@@ -153,6 +153,8 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	/**
 	 * Emitted when the {@link ISharedDirectory} is cleared.
 	 *
+	 * @deprecated Use the "cleared" event instead which provides the path that was cleared.
+	 *
 	 * @remarks Listener parameters:
 	 *
 	 * - `local` - Whether the clear originated from this client.
@@ -161,6 +163,22 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	 */
 	(event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void);
 
+	/**
+	 * Emitted when the {@link ISharedDirectory} is cleared.
+	 *
+	 * @remarks Listener parameters:
+	 *
+	 * - `path` - The absolute path to the directory that was cleared.
+	 *
+	 * - `local` - Whether the clear originated from this client.
+	 *
+	 * - `target` - The {@link ISharedDirectory} itself.
+	 */
+	(
+		event: "cleared",
+		listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void,
+	);
+
 	/**
 	 * Emitted when a subdirectory is created.
 	 *
@@ -277,28 +295,6 @@ export interface IDirectoryEvents extends IEvent {
 	(event: "undisposed", listener: (target: IEventThisPlaceHolder) => void);
 }
 
-/**
- * Internal events for {@link ISharedDirectory}.
- * @internal
- */
-export interface ISharedDirectoryEventsInternal extends ISharedDirectoryEvents {
-	/**
-	 * Emitted when the {@link ISharedDirectory} is cleared.
-	 *
-	 * @remarks Listener parameters:
-	 *
-	 * - `path` - The absolute path to the directory that was cleared.
-	 *
-	 * - `local` - Whether the clear originated from this client.
-	 *
-	 * - `target` - The {@link ISharedDirectory} itself.
-	 */
-	(
-		event: "clearInternal",
-		listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void,
-	);
-}
-
 /**
  * Provides a hierarchical organization of map-like data structures as SubDirectories.
  * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.

package/src/map.ts

@@ -124,7 +124,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 	// TODO: Use `unknown` instead (breaking change).
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void {
-		// eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
+		// eslint-disable-next-line unicorn/no-array-for-each
 		this.kernel.forEach(callbackFn);
 	}
 

package/src/mapKernel.ts

@@ -495,11 +495,32 @@ export class MapKernel {
 	 */
 	public clear(): void {
 		if (!this.isAttached()) {
+			// Collect keys to delete before clearing
+			// eslint-disable-next-line @typescript-eslint/no-shadow
+			const keysToDelete: { key: string; previousValue: unknown }[] = [];
+			for (const [key, value] of this.sequencedData) {
+				keysToDelete.push({ key, previousValue: value.value });
+			}
 			this.sequencedData.clear();
 			this.eventEmitter.emit("clear", true, this.eventEmitter);
+			// Emit delete-like valueChanged events for keys that were removed
+			for (const { key, previousValue } of keysToDelete) {
+				this.eventEmitter.emit(
+					"valueChanged",
+					{ key, previousValue },
+					true,
+					this.eventEmitter,
+				);
+			}
 			return;
 		}
 
+		// Collect keys that will be deleted (those without pending ops that supersede the clear)
+		const keysToDelete: { key: string; previousValue: unknown }[] = [];
+		for (const [key, value] of this.internalIterator()) {
+			keysToDelete.push({ key, previousValue: value.value });
+		}
+
 		const pendingClear: PendingClear = {
 			type: "clear",
 		};
@@ -510,6 +531,10 @@ export class MapKernel {
 		};
 		this.submitMessage(op, pendingClear);
 		this.eventEmitter.emit("clear", true, this.eventEmitter);
+		// Emit delete-like valueChanged events for keys that were removed
+		for (const { key, previousValue } of keysToDelete) {
+			this.eventEmitter.emit("valueChanged", { key, previousValue }, true, this.eventEmitter);
+		}
 	}
 
 	/**
@@ -616,6 +641,7 @@ export class MapKernel {
 			// A pending clear will be last in the list, since it terminates all prior lifetimes.
 			const pendingClear = this.pendingData.pop();
 			assert(
+				// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 				pendingClear !== undefined &&
 					pendingClear.type === "clear" &&
 					pendingClear === typedLocalOpMetadata,
@@ -689,6 +715,7 @@ export class MapKernel {
 					this.sequencedData.clear();
 					const pendingClear = this.pendingData.shift();
 					assert(
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						pendingClear !== undefined &&
 							pendingClear.type === "clear" &&
 							pendingClear === localOpMetadata,
@@ -745,6 +772,7 @@ export class MapKernel {
 					);
 					const pendingEntry = this.pendingData[pendingEntryIndex];
 					assert(
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						pendingEntry !== undefined &&
 							pendingEntry.type === "delete" &&
 							pendingEntry === localOpMetadata,
@@ -785,6 +813,7 @@ export class MapKernel {
 					);
 					const pendingEntry = this.pendingData[pendingEntryIndex];
 					assert(
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						pendingEntry !== undefined && pendingEntry.type === "lifetime",
 						0xbf8 /* Couldn't match local set message to pending lifetime */,
 					);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.74.0";
+export const pkgVersion = "2.81.0-374083";

package/.eslintrc.cjs

@@ -1,28 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
-	parserOptions: {
-		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
-	},
-	rules: {
-		"@typescript-eslint/no-use-before-define": "off",
-		"@typescript-eslint/strict-boolean-expressions": "off",
-
-		// TODO: consider re-enabling once we have addressed how this rule conflicts with our error codes.
-		"unicorn/numeric-separators-style": "off",
-		"@fluid-internal/fluid/no-unchecked-record-access": "warn",
-	},
-	overrides: [
-		{
-			files: ["src/test/**"],
-			rules: {
-				// Allow tests (which only run in Node.js) use `__dirname`
-				"unicorn/prefer-module": "off",
-			},
-		},
-	],
-};