@fluidframework/map 2.0.0-dev.2.2.0.111723 → 2.0.0-dev.3.1.0.125672

package/lib/directory.js

@@ -6,11 +6,11 @@ var _a, _b;
 import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
 import { UsageError } from "@fluidframework/container-utils";
 import { readAndParse } from "@fluidframework/driver-utils";
-import { MessageType, } from "@fluidframework/protocol-definitions";
+import { MessageType } from "@fluidframework/protocol-definitions";
 import { SharedObject, ValueType } from "@fluidframework/shared-object-base";
 import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import * as path from "path-browserify";
-import { LocalValueMaker, makeSerializable, } from "./localValues";
+import { LocalValueMaker, makeSerializable } from "./localValues";
 import { pkgVersion } from "./packageVersion";
 // We use path-browserify since this code can run safely on the server or the browser.
 // We standardize on using posix slashes everywhere.
@@ -137,6 +137,8 @@ export class SharedDirectory extends SharedObject {
     /**
      * {@inheritDoc IDirectory.get}
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     get(key) {
         return this.root.get(key);
     }
@@ -185,13 +187,18 @@ export class SharedDirectory extends SharedObject {
      * Issue a callback on each entry under this IDirectory.
      * @param callback - Callback to issue
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     forEach(callback) {
+        // eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
         this.root.forEach(callback);
     }
     /**
      * Get an iterator over the entries under this IDirectory.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     [(_a = Symbol.toStringTag, Symbol.iterator)]() {
         return this.root[Symbol.iterator]();
     }
@@ -199,6 +206,8 @@ export class SharedDirectory extends SharedObject {
      * Get an iterator over the entries under this IDirectory.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     entries() {
         return this.root.entries();
     }
@@ -219,6 +228,8 @@ export class SharedDirectory extends SharedObject {
      * Get an iterator over the values under this IDirectory.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     values() {
         return this.root.values();
     }
@@ -261,7 +272,7 @@ export class SharedDirectory extends SharedObject {
             return this.root;
         }
         let currentSubDir = this.root;
-        const subdirs = absolutePath.substr(1).split(posix.sep);
+        const subdirs = absolutePath.slice(1).split(posix.sep);
         for (const subdir of subdirs) {
             currentSubDir = currentSubDir.getSubDirectory(subdir);
             if (!currentSubDir) {
@@ -366,7 +377,7 @@ export class SharedDirectory extends SharedObject {
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
      * @internal
-    */
+     */
     rollback(content, localOpMetadata) {
         const op = content;
         const subdir = this.getWorkingDirectory(op.path);
@@ -392,7 +403,8 @@ export class SharedDirectory extends SharedObject {
      * @returns The local value that was produced
      */
     makeLocal(key, absolutePath, serializable) {
-        assert(serializable.type === ValueType[ValueType.Plain] || serializable.type === ValueType[ValueType.Shared], 0x1e4 /* "Unexpected serializable type" */);
+        assert(serializable.type === ValueType[ValueType.Plain] ||
+            serializable.type === ValueType[ValueType.Shared], 0x1e4 /* "Unexpected serializable type" */);
         return this.localValueMaker.fromSerializable(serializable);
     }
     /**
@@ -475,7 +487,6 @@ export class SharedDirectory extends SharedObject {
                     parentSubdir.resubmitSubDirectoryMessage(op, localOpMetadata);
                 }
             },
-            // eslint-disable-next-line max-len
             applyStashedOp: (op) => {
                 const parentSubdir = this.getWorkingDirectory(op.path);
                 if (parentSubdir) {
@@ -497,7 +508,6 @@ export class SharedDirectory extends SharedObject {
                     parentSubdir.resubmitSubDirectoryMessage(op, localOpMetadata);
                 }
             },
-            // eslint-disable-next-line max-len
             applyStashedOp: (op) => {
                 const parentSubdir = this.getWorkingDirectory(op.path);
                 if (parentSubdir) {
@@ -507,6 +517,7 @@ export class SharedDirectory extends SharedObject {
         });
     }
     /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      * @internal
      */
     applyStashedOp(op) {
@@ -533,14 +544,13 @@ export class SharedDirectory extends SharedObject {
                 }
                 const result = {
                     type: value.type,
-                    // eslint-disable-next-line @typescript-eslint/ban-types
                     value: value.value && JSON.parse(value.value),
                 };
                 if (value.value && value.value.length >= MinValueSizeSeparateSnapshotBlob) {
                     const extraContent = {};
                     let largeContent = extraContent;
                     if (currentSubDir.absolutePath !== posix.sep) {
-                        for (const dir of currentSubDir.absolutePath.substr(1).split(posix.sep)) {
+                        for (const dir of currentSubDir.absolutePath.slice(1).split(posix.sep)) {
                             const subDataObject = {};
                             largeContent.subdirectories = { [dir]: subDataObject };
                             largeContent = subDataObject;
@@ -573,24 +583,33 @@ export class SharedDirectory extends SharedObject {
         return builder.getSummaryTree();
     }
 }
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
 function isKeyEditLocalOpMetadata(metadata) {
-    return metadata !== undefined && typeof metadata.pendingMessageId === "number" && metadata.type === "edit";
+    return (metadata !== undefined &&
+        typeof metadata.pendingMessageId === "number" &&
+        metadata.type === "edit");
 }
 function isClearLocalOpMetadata(metadata) {
-    return metadata !== undefined && metadata.type === "clear" && typeof metadata.pendingMessageId === "number" &&
-        typeof metadata.previousStorage === "object";
+    return (metadata !== undefined &&
+        metadata.type === "clear" &&
+        typeof metadata.pendingMessageId === "number" &&
+        typeof metadata.previousStorage === "object");
 }
 function isSubDirLocalOpMetadata(metadata) {
-    return metadata !== undefined && typeof metadata.pendingMessageId === "number" &&
+    return (metadata !== undefined &&
+        typeof metadata.pendingMessageId === "number" &&
         ((metadata.type === "createSubDir" && typeof metadata.previouslyExisted === "boolean") ||
-            metadata.type === "deleteSubDir");
+            metadata.type === "deleteSubDir"));
 }
 function isDirectoryLocalOpMetadata(metadata) {
-    return metadata !== undefined && typeof metadata.pendingMessageId === "number" &&
-        (metadata.type === "edit" || metadata.type === "deleteSubDir" ||
+    return (metadata !== undefined &&
+        typeof metadata.pendingMessageId === "number" &&
+        (metadata.type === "edit" ||
+            metadata.type === "deleteSubDir" ||
             (metadata.type === "clear" && typeof metadata.previousStorage === "object") ||
-            (metadata.type === "createSubDir" && typeof metadata.previouslyExisted === "boolean"));
+            (metadata.type === "createSubDir" && typeof metadata.previouslyExisted === "boolean")));
 }
+/* eslint-enable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
 /**
  * Node of the directory tree.
  * @sealed
@@ -647,10 +666,11 @@ class SubDirectory extends TypedEventEmitter {
         this.emit("disposed", this);
     }
     /**
-     * Unmark the deleted property when rolling back delete.
+     * Unmark the deleted property only when rolling back delete.
      */
     undispose() {
         this._deleted = false;
+        this.emit("undisposed", this);
     }
     get disposed() {
         return this._deleted;
@@ -830,6 +850,7 @@ class SubDirectory extends TypedEventEmitter {
      */
     forEach(callback) {
         this.throwIfDisposed();
+        // eslint-disable-next-line unicorn/no-array-for-each
         this._storage.forEach((localValue, key, map) => {
             callback(localValue.value, key, map);
         });
@@ -957,7 +978,11 @@ class SubDirectory extends TypedEventEmitter {
         this.throwIfDisposed();
         const previousValue = this.deleteCore(op.key, true);
         const pendingMessageId = this.getKeyMessageId(op);
-        const localMetadata = { type: "edit", pendingMessageId, previousValue };
+        const localMetadata = {
+            type: "edit",
+            pendingMessageId,
+            previousValue,
+        };
         return localMetadata;
     }
     /**
@@ -989,7 +1014,11 @@ class SubDirectory extends TypedEventEmitter {
         const previousValue = this.setCore(op.key, context, true);
         // Create metadata
         const pendingMessageId = this.getKeyMessageId(op);
-        const localMetadata = { type: "edit", pendingMessageId, previousValue };
+        const localMetadata = {
+            type: "edit",
+            pendingMessageId,
+            previousValue,
+        };
         return localMetadata;
     }
     /**
@@ -1118,7 +1147,8 @@ class SubDirectory extends TypedEventEmitter {
         assert(isKeyEditLocalOpMetadata(localOpMetadata), 0x32d /* Invalid localOpMetadata in submit */);
         // clear the old pending message id
         const pendingMessageIds = this.pendingKeys.get(op.key);
-        assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x32e /* Unexpected pending message received */);
+        assert(pendingMessageIds !== undefined &&
+            pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x32e /* Unexpected pending message received */);
         pendingMessageIds.shift();
         if (pendingMessageIds.length === 0) {
             this.pendingKeys.delete(op.key);
@@ -1180,7 +1210,8 @@ class SubDirectory extends TypedEventEmitter {
         assert(isSubDirLocalOpMetadata(localOpMetadata), 0x32f /* Invalid localOpMetadata for sub directory op */);
         // clear the old pending message id
         const pendingMessageIds = this.pendingSubDirectories.get(op.subdirName);
-        assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x330 /* Unexpected pending message received */);
+        assert(pendingMessageIds !== undefined &&
+            pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x330 /* Unexpected pending message received */);
         pendingMessageIds.shift();
         if (pendingMessageIds.length === 0) {
             this.pendingSubDirectories.delete(op.subdirName);
@@ -1252,21 +1283,24 @@ class SubDirectory extends TypedEventEmitter {
             map.delete(key);
         }
     }
+    /* eslint-disable @typescript-eslint/no-unsafe-member-access */
     /**
      * Rollback a local op
      * @param op - The operation to rollback
      * @param localOpMetadata - The local metadata associated with the op.
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     rollback(op, localOpMetadata) {
         if (!isDirectoryLocalOpMetadata(localOpMetadata)) {
             throw new Error("Invalid localOpMetadata");
         }
         if (op.type === "clear" && localOpMetadata.type === "clear") {
-            localOpMetadata.previousStorage.forEach((localValue, key) => {
+            for (const [key, localValue] of localOpMetadata.previousStorage.entries()) {
                 this.setCore(key, localValue, true);
-            });
+            }
             const lastPendingClearId = this.pendingClearMessageIds.pop();
-            if (lastPendingClearId === undefined || lastPendingClearId !== localOpMetadata.pendingMessageId) {
+            if (lastPendingClearId === undefined ||
+                lastPendingClearId !== localOpMetadata.pendingMessageId) {
                 throw new Error("Rollback op does match last clear");
             }
         }
@@ -1298,6 +1332,7 @@ class SubDirectory extends TypedEventEmitter {
             throw new Error("Unsupported op for rollback");
         }
     }
+    /* eslint-enable @typescript-eslint/no-unsafe-member-access */
     /**
      * Converts the given relative path into an absolute path.
      * @param path - Relative path to convert
@@ -1318,7 +1353,8 @@ class SubDirectory extends TypedEventEmitter {
     needProcessStorageOperation(op, local, localOpMetadata) {
         if (this.pendingClearMessageIds.length > 0) {
             if (local) {
-                assert(localOpMetadata !== undefined && isKeyEditLocalOpMetadata(localOpMetadata) &&
+                assert(localOpMetadata !== undefined &&
+                    isKeyEditLocalOpMetadata(localOpMetadata) &&
                     localOpMetadata.pendingMessageId < this.pendingClearMessageIds[0], 0x010 /* "Received out of order storage op when there is an unackd clear message" */);
             }
             // If I have a NACK clear, we can ignore all ops.
@@ -1331,7 +1367,8 @@ class SubDirectory extends TypedEventEmitter {
             if (local) {
                 assert(localOpMetadata !== undefined && isKeyEditLocalOpMetadata(localOpMetadata), 0x011 /* pendingMessageId is missing from the local client's operation */);
                 const pendingMessageIds = this.pendingKeys.get(op.key);
-                assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x331 /* Unexpected pending message received */);
+                assert(pendingMessageIds !== undefined &&
+                    pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x331 /* Unexpected pending message received */);
                 pendingMessageIds.shift();
                 if (pendingMessageIds.length === 0) {
                     this.pendingKeys.delete(op.key);
@@ -1358,7 +1395,8 @@ class SubDirectory extends TypedEventEmitter {
             if (local) {
                 assert(isSubDirLocalOpMetadata(localOpMetadata), 0x012 /* pendingMessageId is missing from the local client's operation */);
                 const pendingMessageIds = this.pendingSubDirectories.get(op.subdirName);
-                assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x332 /* Unexpected pending message received */);
+                assert(pendingMessageIds !== undefined &&
+                    pendingMessageIds[0] === localOpMetadata.pendingMessageId, 0x332 /* Unexpected pending message received */);
                 pendingMessageIds.shift();
                 if (pendingMessageIds.length === 0) {
                     this.pendingSubDirectories.delete(op.subdirName);
@@ -1375,14 +1413,14 @@ class SubDirectory extends TypedEventEmitter {
         // Assuming the pendingKeys is small and the map is large
         // we will get the value for the pendingKeys and clear the map
         const temp = new Map();
-        this.pendingKeys.forEach((value, key, map) => {
+        for (const [key] of this.pendingKeys) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             temp.set(key, this._storage.get(key));
-        });
+        }
         this.clearCore(local);
-        temp.forEach((value, key, map) => {
+        for (const [key, value] of temp.entries()) {
             this.setCore(key, value, true);
-        });
+        }
     }
     /**
      * Clear implementation used for both locally sourced clears as well as incoming remote clears.