@fluidframework/map 2.0.0-rc.1.0.6 → 2.0.0-rc.2.0.1

package/lib/{directory.mjs → directory.js}

@@ -3,17 +3,17 @@
  * Licensed under the MIT License.
  */
 var _a, _b;
-import { assert } from "@fluidframework/core-utils";
+import { assert, unreachableCase } from "@fluidframework/core-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { UsageError } from "@fluidframework/telemetry-utils";
 import { readAndParse } from "@fluidframework/driver-utils";
 import { MessageType } from "@fluidframework/protocol-definitions";
-import { SharedObject, ValueType } from "@fluidframework/shared-object-base";
+import { SharedObject, ValueType, parseHandles, } from "@fluidframework/shared-object-base";
 import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import path from "path-browserify";
 import { RedBlackTree } from "@fluidframework/merge-tree";
-import { LocalValueMaker, makeSerializable } from "./localValues.mjs";
-import { pkgVersion } from "./packageVersion.mjs";
+import { LocalValueMaker, makeSerializable } from "./localValues.js";
+import { pkgVersion } from "./packageVersion.js";
 // We use path-browserify since this code can run safely on the server or the browser.
 // We standardize on using posix slashes everywhere.
 const posix = path.posix;
@@ -90,19 +90,19 @@ const seqDataComparator = (a, b) => {
     if (isAcknowledgedOrDetached(a)) {
         if (isAcknowledgedOrDetached(b)) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            return a.seq !== b.seq ? a.seq - b.seq : a.clientSeq - b.clientSeq;
+            return a.seq === b.seq ? a.clientSeq - b.clientSeq : a.seq - b.seq;
         }
         else {
             return -1;
         }
     }
     else {
-        if (!isAcknowledgedOrDetached(b)) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            return a.seq !== b.seq ? a.seq - b.seq : a.clientSeq - b.clientSeq;
+        if (isAcknowledgedOrDetached(b)) {
+            return 1;
         }
         else {
-            return 1;
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return a.seq === b.seq ? a.clientSeq - b.clientSeq : a.seq - b.seq;
         }
     }
 };
@@ -223,7 +223,7 @@ export class SharedDirectory extends SharedObject {
          * Mapping of op types to message handlers.
          */
         this.messageHandlers = new Map();
-        this.localValueMaker = new LocalValueMaker(this.serializer);
+        this.localValueMaker = new LocalValueMaker();
         this.setMessageHandlers();
         // Mirror the containedValueChanged op on the SharedDirectory
         this.root.on("containedValueChanged", (changed, local) => {
@@ -473,9 +473,9 @@ export class SharedDirectory extends SharedObject {
                                 clientSeq: ++currentSubDir.localCreationSeq,
                             };
                         }
-                        newSubDir = new SubDirectory(seqData, createInfo !== undefined
-                            ? new Set(createInfo.ccIds)
-                            : new Set(), this, this.runtime, this.serializer, posix.join(currentSubDir.absolutePath, subdirName), this.logger);
+                        newSubDir = new SubDirectory(seqData, createInfo === undefined
+                            ? new Set()
+                            : new Set(createInfo.ccIds), this, this.runtime, this.serializer, posix.join(currentSubDir.absolutePath, subdirName), this.logger);
                         currentSubDir.populateSubDirectory(subdirName, newSubDir);
                         // Record the newly inserted subdirectory to the creation tracker
                         currentSubDir.ackedCreationSeqTracker.set(subdirName, {
@@ -487,7 +487,9 @@ export class SharedDirectory extends SharedObject {
             }
             if (currentSubDirObject.storage) {
                 for (const [key, serializable] of Object.entries(currentSubDirObject.storage)) {
-                    const localValue = this.makeLocal(key, currentSubDir.absolutePath, serializable);
+                    const localValue = this.makeLocal(key, currentSubDir.absolutePath, 
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    parseHandles(serializable, this.serializer));
                     currentSubDir.populateStorage(key, localValue);
                 }
             }
@@ -536,7 +538,7 @@ export class SharedDirectory extends SharedObject {
     serializable) {
         assert(serializable.type === ValueType[ValueType.Plain] ||
             serializable.type === ValueType[ValueType.Shared], 0x1e4 /* "Unexpected serializable type" */);
-        return this.localValueMaker.fromSerializable(serializable);
+        return this.localValueMaker.fromSerializable(serializable, this.serializer, this.handle);
     }
     /**
      * This checks if there is pending delete op for local delete for a any subdir in the relative path.
@@ -583,12 +585,6 @@ export class SharedDirectory extends SharedObject {
                     subdir.resubmitClearMessage(op, localOpMetadata);
                 }
             },
-            applyStashedOp: (op) => {
-                const subdir = this.getWorkingDirectory(op.path);
-                if (subdir) {
-                    return subdir.applyStashedClearMessage(op);
-                }
-            },
         });
         this.messageHandlers.set("delete", {
             process: (msg, op, local, localOpMetadata) => {
@@ -605,12 +601,6 @@ export class SharedDirectory extends SharedObject {
                     subdir.resubmitKeyMessage(op, localOpMetadata);
                 }
             },
-            applyStashedOp: (op) => {
-                const subdir = this.getWorkingDirectory(op.path);
-                if (subdir) {
-                    return subdir.applyStashedDeleteMessage(op);
-                }
-            },
         });
         this.messageHandlers.set("set", {
             process: (msg, op, local, localOpMetadata) => {
@@ -628,13 +618,6 @@ export class SharedDirectory extends SharedObject {
                     subdir.resubmitKeyMessage(op, localOpMetadata);
                 }
             },
-            applyStashedOp: (op) => {
-                const subdir = this.getWorkingDirectory(op.path);
-                if (subdir) {
-                    const context = this.makeLocal(op.key, op.path, op.value);
-                    return subdir.applyStashedSetMessage(op, context);
-                }
-            },
         });
         this.messageHandlers.set("createSubDirectory", {
             process: (msg, op, local, localOpMetadata) => {
@@ -652,12 +635,6 @@ export class SharedDirectory extends SharedObject {
                     parentSubdir.resubmitSubDirectoryMessage(op, localOpMetadata);
                 }
             },
-            applyStashedOp: (op) => {
-                const parentSubdir = this.getWorkingDirectory(op.path);
-                if (parentSubdir) {
-                    return parentSubdir.applyStashedCreateSubDirMessage(op);
-                }
-            },
         });
         this.messageHandlers.set("deleteSubDirectory", {
             process: (msg, op, local, localOpMetadata) => {
@@ -675,23 +652,39 @@ export class SharedDirectory extends SharedObject {
                     parentSubdir.resubmitSubDirectoryMessage(op, localOpMetadata);
                 }
             },
-            applyStashedOp: (op) => {
-                const parentSubdir = this.getWorkingDirectory(op.path);
-                if (parentSubdir) {
-                    return parentSubdir.applyStashedDeleteSubDirMessage(op);
-                }
-            },
         });
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
     applyStashedOp(op) {
-        const handler = this.messageHandlers.get(op.type);
-        if (handler === undefined) {
-            throw new Error("no apply stashed op handler");
+        const directoryOp = op;
+        const dir = this.getWorkingDirectory(directoryOp.path);
+        switch (directoryOp.type) {
+            case "clear": {
+                dir?.clear();
+                break;
+            }
+            case "createSubDirectory": {
+                dir?.createSubDirectory(directoryOp.subdirName);
+                break;
+            }
+            case "delete": {
+                dir?.delete(directoryOp.key);
+                break;
+            }
+            case "deleteSubDirectory": {
+                dir?.deleteSubDirectory(directoryOp.subdirName);
+                break;
+            }
+            case "set": {
+                dir?.set(directoryOp.key, this.localValueMaker.fromSerializable(directoryOp.value, this.serializer, this.handle).value);
+                break;
+            }
+            default: {
+                unreachableCase(directoryOp);
+            }
         }
-        return handler.applyStashedOp(op);
     }
     serializeDirectory(root, serializer, telemetryContext) {
         const MinValueSizeSeparateSnapshotBlob = 8 * 1024;
@@ -773,6 +766,7 @@ function isDirectoryLocalOpMetadata(metadata) {
         isSubDirLocalOpMetadata(metadata));
 }
 /* eslint-enable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
+// eslint-disable-next-line @rushstack/no-new-null
 function assertNonNullClientId(clientId) {
     assert(clientId !== null, 0x6af /* client id should never be null */);
 }
@@ -951,13 +945,15 @@ class SubDirectory extends TypedEventEmitter {
         return subDir;
     }
     /**
-     * @returns The Sequence Data which should be used for local changes.
+     * Gets the Sequence Data which should be used for local changes.
+     *
      * @remarks While detached, 0 is used rather than -1 to represent a change which should be universally known (as opposed to known
      * only by the local client). This ensures that if the directory is later attached, none of its data needs to be updated (the values
      * last set while detached will now be known to any new client, until they are changed).
      *
      * The client sequence number is incremented by 1 for maintaining the internal order of locally created subdirectories
-     * TODO: Convert these conventions to named constants. The semantics used here match those for merge-tree.
+     *
+     * @privateRemarks TODO: Convert these conventions to named constants. The semantics used here match those for merge-tree.
      */
     getLocalSeq() {
         return this.directory.isAttached()
@@ -1032,6 +1028,7 @@ class SubDirectory extends TypedEventEmitter {
                 if (this.index < subdirNames.length) {
                     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 };
                 }
                 return { value: undefined, done: true };
@@ -1180,7 +1177,6 @@ class SubDirectory extends TypedEventEmitter {
      * @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.
-     * @internal
      */
     processClearMessage(msg, op, local, localOpMetadata) {
         this.throwIfDisposed();
@@ -1195,24 +1191,6 @@ class SubDirectory extends TypedEventEmitter {
         }
         this.clearExceptPendingKeys(false);
     }
-    /**
-     * Apply clear operation locally and generate metadata
-     * @param op - Op to apply
-     * @returns metadata generated for stahed op
-     */
-    applyStashedClearMessage(op) {
-        this.throwIfDisposed();
-        const previousValue = new Map(this._storage);
-        this.clearExceptPendingKeys(true);
-        const pendingMsgId = ++this.pendingMessageId;
-        this.pendingClearMessageIds.push(pendingMsgId);
-        const metadata = {
-            type: "clear",
-            pendingMessageId: pendingMsgId,
-            previousStorage: previousValue,
-        };
-        return metadata;
-    }
     /**
      * Process a delete operation.
      * @param msg - The message from the server to apply.
@@ -1220,7 +1198,6 @@ class SubDirectory extends TypedEventEmitter {
      * @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.
-     * @internal
      */
     processDeleteMessage(msg, op, local, localOpMetadata) {
         this.throwIfDisposed();
@@ -1230,22 +1207,6 @@ class SubDirectory extends TypedEventEmitter {
         }
         this.deleteCore(op.key, local);
     }
-    /**
-     * Apply delete operation locally and generate metadata
-     * @param op - Op to apply
-     * @returns metadata generated for stahed op
-     */
-    applyStashedDeleteMessage(op) {
-        this.throwIfDisposed();
-        const previousValue = this.deleteCore(op.key, true);
-        const pendingMessageId = this.getKeyMessageId(op);
-        const localMetadata = {
-            type: "edit",
-            pendingMessageId,
-            previousValue,
-        };
-        return localMetadata;
-    }
     /**
      * Process a set operation.
      * @param msg - The message from the server to apply.
@@ -1253,7 +1214,6 @@ class SubDirectory extends TypedEventEmitter {
      * @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.
-     * @internal
      */
     processSetMessage(msg, op, context, local, localOpMetadata) {
         this.throwIfDisposed();
@@ -1266,24 +1226,6 @@ class SubDirectory extends TypedEventEmitter {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         this.setCore(op.key, context, local);
     }
-    /**
-     * Apply set operation locally and generate metadata
-     * @param op - Op to apply
-     * @returns metadata generated for stahed op
-     */
-    applyStashedSetMessage(op, context) {
-        this.throwIfDisposed();
-        // Set the value locally.
-        const previousValue = this.setCore(op.key, context, true);
-        // Create metadata
-        const pendingMessageId = this.getKeyMessageId(op);
-        const localMetadata = {
-            type: "edit",
-            pendingMessageId,
-            previousValue,
-        };
-        return localMetadata;
-    }
     /**
      * Process a create subdirectory operation.
      * @param msg - The message from the server to apply.
@@ -1291,7 +1233,6 @@ class SubDirectory extends TypedEventEmitter {
      * @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.
-     * @internal
      */
     processCreateSubDirectoryMessage(msg, op, local, localOpMetadata) {
         this.throwIfDisposed();
@@ -1302,21 +1243,6 @@ class SubDirectory extends TypedEventEmitter {
         assertNonNullClientId(msg.clientId);
         this.createSubDirectoryCore(op.subdirName, local, { seq: msg.sequenceNumber, clientSeq: msg.clientSequenceNumber }, msg.clientId);
     }
-    /**
-     * Apply createSubDirectory operation locally and generate metadata
-     * @param op - Op to apply
-     * @returns metadata generated for stahed op
-     */
-    applyStashedCreateSubDirMessage(op) {
-        this.throwIfDisposed();
-        // Create the sub directory locally first.
-        this.createSubDirectoryCore(op.subdirName, true, this.getLocalSeq(), this.runtime.clientId ?? "detached");
-        this.updatePendingSubDirMessageCount(op);
-        const localOpMetadata = {
-            type: "createSubDir",
-        };
-        return localOpMetadata;
-    }
     /**
      * Process a delete subdirectory operation.
      * @param msg - The message from the server to apply.
@@ -1324,7 +1250,6 @@ class SubDirectory extends TypedEventEmitter {
      * @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.
-     * @internal
      */
     processDeleteSubDirectoryMessage(msg, op, local, localOpMetadata) {
         this.throwIfDisposed();
@@ -1334,21 +1259,6 @@ class SubDirectory extends TypedEventEmitter {
         }
         this.deleteSubDirectoryCore(op.subdirName, local);
     }
-    /**
-     * Apply deleteSubDirectory operation locally and generate metadata
-     * @param op - Op to apply
-     * @returns metadata generated for stahed op
-     */
-    applyStashedDeleteSubDirMessage(op) {
-        this.throwIfDisposed();
-        const subDir = this.deleteSubDirectoryCore(op.subdirName, true);
-        this.updatePendingSubDirMessageCount(op);
-        const metadata = {
-            type: "deleteSubDir",
-            subDirectory: subDir,
-        };
-        return metadata;
-    }
     /**
      * Submit a clear operation.
      * @param op - The operation
@@ -1367,7 +1277,6 @@ class SubDirectory extends TypedEventEmitter {
     /**
      * Resubmit a clear operation.
      * @param op - The operation
-     * @internal
      */
     resubmitClearMessage(op, localOpMetadata) {
         assert(isClearLocalOpMetadata(localOpMetadata), 0x32b /* Invalid localOpMetadata for clear */);
@@ -1386,11 +1295,11 @@ class SubDirectory extends TypedEventEmitter {
         // We don't reuse the metadata pendingMessageId but send a new one on each submit.
         const pendingMessageId = ++this.pendingMessageId;
         const pendingMessageIds = this.pendingKeys.get(op.key);
-        if (pendingMessageIds !== undefined) {
-            pendingMessageIds.push(pendingMessageId);
+        if (pendingMessageIds === undefined) {
+            this.pendingKeys.set(op.key, [pendingMessageId]);
         }
         else {
-            this.pendingKeys.set(op.key, [pendingMessageId]);
+            pendingMessageIds.push(pendingMessageId);
         }
         return pendingMessageId;
     }
@@ -1409,7 +1318,6 @@ class SubDirectory extends TypedEventEmitter {
      * Submit a key message to remote clients based on a previous submit.
      * @param op - The map key message
      * @param localOpMetadata - Metadata from the previous submit
-     * @internal
      */
     resubmitKeyMessage(op, localOpMetadata) {
         assert(isKeyEditLocalOpMetadata(localOpMetadata), 0x32d /* Invalid localOpMetadata in submit */);
@@ -1418,7 +1326,7 @@ class SubDirectory extends TypedEventEmitter {
         // Only submit the op, if we have record for it, otherwise it is possible that the older instance
         // is already deleted, in which case we don't need to submit the op.
         if (pendingMessageIds !== undefined) {
-            const index = pendingMessageIds.findIndex((id) => id === localOpMetadata.pendingMessageId);
+            const index = pendingMessageIds.indexOf(localOpMetadata.pendingMessageId);
             if (index === -1) {
                 return;
             }
@@ -1482,7 +1390,6 @@ class SubDirectory extends TypedEventEmitter {
      * Submit a subdirectory operation again
      * @param op - The operation
      * @param localOpMetadata - metadata submitted with the op originally
-     * @internal
      */
     resubmitSubDirectoryMessage(op, localOpMetadata) {
         assert(isSubDirLocalOpMetadata(localOpMetadata), 0x32f /* Invalid localOpMetadata for sub directory op */);
@@ -1509,7 +1416,6 @@ class SubDirectory extends TypedEventEmitter {
      * Get the storage of this subdirectory in a serializable format, to be used in snapshotting.
      * @param serializer - The serializer to use to serialize handles in its values.
      * @returns The JSONable string representing the storage of this subdirectory
-     * @internal
      */
     *getSerializedStorage(serializer) {
         this.throwIfDisposed();
@@ -1523,7 +1429,7 @@ class SubDirectory extends TypedEventEmitter {
         this.throwIfDisposed();
         const createInfo = {
             csn: this.seqData.seq,
-            ccIds: Array.from(this.clientIds),
+            ccIds: [...this.clientIds],
         };
         return createInfo;
     }
@@ -1531,7 +1437,6 @@ class SubDirectory extends TypedEventEmitter {
      * Populate a key value in this subdirectory's storage, to be used when loading from snapshot.
      * @param key - The key to populate
      * @param localValue - The local value to populate into it
-     * @internal
      */
     populateStorage(key, localValue) {
         this.throwIfDisposed();
@@ -1541,7 +1446,6 @@ class SubDirectory extends TypedEventEmitter {
      * Populate a subdirectory into this subdirectory, to be used when loading from snapshot.
      * @param subdirName - The name of the subdirectory to add
      * @param newSubDir - The new subdirectory to add
-     * @internal
      */
     populateSubDirectory(subdirName, newSubDir) {
         this.throwIfDisposed();
@@ -1552,7 +1456,6 @@ class SubDirectory extends TypedEventEmitter {
      * value so op handlers can be retrieved
      * @param key - The key to retrieve from
      * @returns The local value
-     * @internal
      */
     getLocalValue(key) {
         this.throwIfDisposed();
@@ -1595,37 +1498,46 @@ class SubDirectory extends TypedEventEmitter {
             }
         }
         else if ((op.type === "delete" || op.type === "set") && localOpMetadata.type === "edit") {
+            const key = op.key;
+            assert(key !== undefined, 0x8ad /* "key" property is missing from edit operation. */);
+            assert(typeof key === "string", 0x8ae /* "key" property in edit operation is misconfigured. Expected a string. */);
             if (localOpMetadata.previousValue === undefined) {
-                this.deleteCore(op.key, true);
+                this.deleteCore(key, true);
             }
             else {
-                this.setCore(op.key, localOpMetadata.previousValue, true);
+                this.setCore(key, localOpMetadata.previousValue, true);
             }
-            this.rollbackPendingMessageId(this.pendingKeys, op.key, localOpMetadata.pendingMessageId);
+            this.rollbackPendingMessageId(this.pendingKeys, key, localOpMetadata.pendingMessageId);
         }
         else if (op.type === "createSubDirectory" && localOpMetadata.type === "createSubDir") {
-            this.deleteSubDirectoryCore(op.subdirName, true);
-            this.decrementPendingSubDirCount(this.pendingCreateSubDirectoriesTracker, op.subdirName);
+            const subdirName = op.subdirName;
+            assert(subdirName !== undefined, 0x8af /* "subdirName" property is missing from "createSubDirectory" operation. */);
+            assert(typeof subdirName === "string", 0x8b0 /* "subdirName" property in "createSubDirectory" operation is misconfigured. Expected a string. */);
+            this.deleteSubDirectoryCore(subdirName, true);
+            this.decrementPendingSubDirCount(this.pendingCreateSubDirectoriesTracker, subdirName);
         }
         else if (op.type === "deleteSubDirectory" && localOpMetadata.type === "deleteSubDir") {
+            const subdirName = op.subdirName;
+            assert(subdirName !== undefined, 0x8b1 /* "subdirName" property is missing from "deleteSubDirectory" operation. */);
+            assert(typeof subdirName === "string", 0x8b2 /* "subdirName" property in "deleteSubDirectory" operation is misconfigured. Expected a string. */);
             if (localOpMetadata.subDirectory !== undefined) {
                 this.undeleteSubDirectoryTree(localOpMetadata.subDirectory);
                 // don't need to register events because deleting never unregistered
-                this._subdirectories.set(op.subdirName, localOpMetadata.subDirectory);
+                this._subdirectories.set(subdirName, localOpMetadata.subDirectory);
                 // Restore the record in creation tracker
                 if (isAcknowledgedOrDetached(localOpMetadata.subDirectory.seqData)) {
-                    this.ackedCreationSeqTracker.set(op.subdirName, {
+                    this.ackedCreationSeqTracker.set(subdirName, {
                         ...localOpMetadata.subDirectory.seqData,
                     });
                 }
                 else {
-                    this.localCreationSeqTracker.set(op.subdirName, {
+                    this.localCreationSeqTracker.set(subdirName, {
                         ...localOpMetadata.subDirectory.seqData,
                     });
                 }
-                this.emit("subDirectoryCreated", op.subdirName, true, this);
+                this.emit("subDirectoryCreated", subdirName, true, this);
             }
-            this.decrementPendingSubDirCount(this.pendingDeleteSubDirectoriesTracker, op.subDirName);
+            this.decrementPendingSubDirCount(this.pendingDeleteSubDirectoriesTracker, subdirName);
         }
         else {
             throw new Error("Unsupported op for rollback");
@@ -1874,11 +1786,11 @@ class SubDirectory extends TypedEventEmitter {
              * Store the sequnce numbers of newly created subdirectory to the proper creation tracker, based
              * on whether the creation behavior has been ack'd or not
              */
-            if (!isAcknowledgedOrDetached(seqData)) {
-                this.localCreationSeqTracker.set(subdirName, { ...seqData });
+            if (isAcknowledgedOrDetached(seqData)) {
+                this.ackedCreationSeqTracker.set(subdirName, { ...seqData });
             }
             else {
-                this.ackedCreationSeqTracker.set(subdirName, { ...seqData });
+                this.localCreationSeqTracker.set(subdirName, { ...seqData });
             }
             this.registerEventsOnSubDirectory(subDir, subdirName);
             this._subdirectories.set(subdirName, subDir);
@@ -1946,4 +1858,4 @@ class SubDirectory extends TypedEventEmitter {
         }
     }
 }
-//# sourceMappingURL=directory.mjs.map
+//# sourceMappingURL=directory.js.map