@fluidframework/map 2.20.0 → 2.22.0

package/src/directory.ts

@@ -805,7 +805,10 @@ export class SharedDirectory
 		if (message.type === MessageType.Operation) {
 			const op: IDirectoryOperation = message.contents as IDirectoryOperation;
 			const handler = this.messageHandlers.get(op.type);
-			assert(handler !== undefined, 0x00e /* Missing message handler for message type */);
+			assert(
+				handler !== undefined,
+				0x00e /* "Missing message handler for message type: op may be from a newer version */,
+			);
 			handler.process(message, op, local, localOpMetadata);
 		}
 	}
@@ -864,18 +867,15 @@ export class SharedDirectory
 			return false;
 		}
 		let currentParent = this.root;
-		const nodeList = absolutePath.split(posix.sep);
-		let start = 1;
-		while (start < nodeList.length) {
-			const subDirName = nodeList[start];
-			if (currentParent.isSubDirectoryDeletePending(subDirName)) {
+		const pathParts = absolutePath.split(posix.sep).slice(1);
+		for (const dirName of pathParts) {
+			if (currentParent.isSubDirectoryDeletePending(dirName)) {
 				return true;
 			}
-			currentParent = currentParent.getSubDirectory(subDirName) as SubDirectory;
+			currentParent = currentParent.getSubDirectory(dirName) as SubDirectory;
 			if (currentParent === undefined) {
 				return true;
 			}
-			start += 1;
 		}
 		return false;
 	}
@@ -1492,7 +1492,9 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 			dirs: this._subdirectories,
 			next(): IteratorResult<[string, IDirectory]> {
 				if (this.index < subdirNames.length) {
-					const subdirName = subdirNames[this.index++];
+					// Bounds check above guarantees non-null (at least at compile time, assuming all types are respected)
+					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+					const subdirName = subdirNames[this.index++]!;
 					const subdir = this.dirs.get(subdirName);
 					assert(subdir !== undefined, 0x8ac /* Could not find expected sub-directory. */);
 					return { value: [subdirName, subdir], done: false };
@@ -2181,21 +2183,27 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		local: boolean,
 		localOpMetadata: unknown,
 	): boolean {
-		if (this.pendingClearMessageIds.length > 0) {
+		const firstPendingClearMessageId = this.pendingClearMessageIds[0];
+		if (firstPendingClearMessageId !== undefined) {
 			if (local) {
 				assert(
 					localOpMetadata !== undefined &&
 						isKeyEditLocalOpMetadata(localOpMetadata) &&
-						localOpMetadata.pendingMessageId < this.pendingClearMessageIds[0],
+						localOpMetadata.pendingMessageId < firstPendingClearMessageId,
 					0x010 /* "Received out of order storage op when there is an unackd clear message" */,
 				);
 				// Remove all pendingMessageIds lower than first pendingClearMessageId.
-				const lowestPendingClearMessageId = this.pendingClearMessageIds[0];
+				const lowestPendingClearMessageId = firstPendingClearMessageId;
 				const pendingKeyMessageIdArray = this.pendingKeys.get(op.key);
 				if (pendingKeyMessageIdArray !== undefined) {
 					let index = 0;
-					while (pendingKeyMessageIdArray[index] < lowestPendingClearMessageId) {
+					let pendingKeyMessageId = pendingKeyMessageIdArray[index];
+					while (
+						pendingKeyMessageId !== undefined &&
+						pendingKeyMessageId < lowestPendingClearMessageId
+					) {
 						index += 1;
+						pendingKeyMessageId = pendingKeyMessageIdArray[index];
 					}
 					const newPendingKeyMessageId = pendingKeyMessageIdArray.splice(index);
 					if (newPendingKeyMessageId.length === 0) {

package/src/map.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { assert } from "@fluidframework/core-utils/internal";
 import type {
 	IChannelAttributes,
 	IFluidDataStoreRuntime,
@@ -202,8 +203,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 		//    and result in non-incremental snapshot.
 		//    This can be improved in the future, without being format breaking change, as loading sequence
 		//    loads all blobs at once and partitioning schema has no impact on that process.
-		for (const key of Object.keys(data)) {
-			const value = data[key];
+		for (const [key, value] of Object.entries(data)) {
 			if (value.value && value.value.length >= MinValueSizeSeparateSnapshotBlob) {
 				const blobName = `blob${counter}`;
 				counter++;
@@ -293,7 +293,14 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 	): void {
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
 		if (message.type === MessageType.Operation) {
-			this.kernel.tryProcessMessage(message.contents as IMapOperation, local, localOpMetadata);
+			assert(
+				this.kernel.tryProcessMessage(
+					message.contents as IMapOperation,
+					local,
+					localOpMetadata,
+				),
+				0xab2 /* Map received an unrecognized op, possibly from a newer version */,
+			);
 		}
 	}
 

package/src/mapKernel.ts

@@ -437,11 +437,18 @@ export class MapKernel {
 
 	/**
 	 * Process the given op if a handler is registered.
-	 * @param op - The message to process
+	 * @param message - The message to process
 	 * @param local - Whether the message originated from the local client
 	 * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
 	 * For messages from a remote client, this will be undefined.
-	 * @returns True if the operation was processed, false otherwise.
+	 * @returns True if the operation was recognized and thus processed, false otherwise.
+	 *
+	 * @remarks
+	 * When this returns false and the caller doesn't handle the op itself, then the op could be from a different version of this code.
+	 * In such a case, not applying the op would result in this client becoming out of sync with clients that do handle the op
+	 * and could result in data corruption or data loss as well.
+	 * Therefore, in such cases the caller should typically throw an error, ensuring that this client treats the situation as data corruption
+	 * (since its data no longer matches what other clients think the data should be) and will avoid overriding document content or misleading the users into thinking their current state is accurate.
 	 */
 	public tryProcessMessage(
 		op: IMapOperation,
@@ -607,7 +614,7 @@ export class MapKernel {
 		local: boolean,
 		localOpMetadata: MapLocalOpMetadata,
 	): boolean {
-		if (this.pendingClearMessageIds.length > 0) {
+		if (this.pendingClearMessageIds[0] !== undefined) {
 			if (local) {
 				assert(
 					localOpMetadata !== undefined &&

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.20.0";
+export const pkgVersion = "2.22.0";

package/tsconfig.json

@@ -5,7 +5,6 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
-		"noUncheckedIndexedAccess": false,
 		"exactOptionalPropertyTypes": false,
 	},
 }