@fluidframework/map 2.0.0-dev.5.3.2.178189 → 2.0.0-dev.6.4.0.191457

package/lib/directory.js

@@ -3,8 +3,9 @@
  * Licensed under the MIT License.
  */
 var _a, _b;
-import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
-import { UsageError } from "@fluidframework/container-utils";
+import { assert } 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";
@@ -67,6 +68,7 @@ DirectoryFactory.Attributes = {
  * {@inheritDoc ISharedDirectory}
  *
  * @example
+ *
  * ```typescript
  * mySharedDirectory.createSubDirectory("a").createSubDirectory("b").createSubDirectory("c").set("foo", val1);
  * const mySubDir = mySharedDirectory.getWorkingDirectory("/a/b/c");
@@ -409,7 +411,9 @@ export class SharedDirectory extends SharedObject {
      * @param serializable - The remote information that we can convert into a real object
      * @returns The local value that was produced
      */
-    makeLocal(key, absolutePath, serializable) {
+    makeLocal(key, absolutePath, 
+    // eslint-disable-next-line import/no-deprecated
+    serializable) {
         assert(serializable.type === ValueType[ValueType.Plain] ||
             serializable.type === ValueType[ValueType.Shared], 0x1e4 /* "Unexpected serializable type" */);
         return this.localValueMaker.fromSerializable(serializable);
@@ -417,7 +421,7 @@ export class SharedDirectory extends SharedObject {
     /**
      * This checks if there is pending delete op for local delete for a any subdir in the relative path.
      * @param relativePath - path of sub directory.
-     * @returns - true if there is pending delete.
+     * @returns `true` if there is pending delete, `false` otherwise.
      */
     isSubDirectoryDeletePending(relativePath) {
         const absolutePath = this.makeAbsolute(relativePath);
@@ -586,6 +590,7 @@ export class SharedDirectory extends SharedObject {
                 if (!currentSubDirObject.storage) {
                     currentSubDirObject.storage = {};
                 }
+                // eslint-disable-next-line import/no-deprecated
                 const result = {
                     type: value.type,
                     value: value.value && JSON.parse(value.value),
@@ -750,9 +755,8 @@ class SubDirectory extends TypedEventEmitter {
      * {@inheritDoc IDirectory.get}
      */
     get(key) {
-        var _c;
         this.throwIfDisposed();
-        return (_c = this._storage.get(key)) === null || _c === void 0 ? void 0 : _c.value;
+        return this._storage.get(key)?.value;
     }
     /**
      * {@inheritDoc IDirectory.set}
@@ -791,7 +795,6 @@ class SubDirectory extends TypedEventEmitter {
      * {@inheritDoc IDirectory.createSubDirectory}
      */
     createSubDirectory(subdirName) {
-        var _c;
         this.throwIfDisposed();
         // Undefined/null subdirectory names can't be serialized to JSON in the manner we currently snapshot.
         if (subdirName === undefined || subdirName === null) {
@@ -801,7 +804,7 @@ class SubDirectory extends TypedEventEmitter {
             throw new Error(`SubDirectory name may not contain ${posix.sep}`);
         }
         // Create the sub directory locally first.
-        const isNew = this.createSubDirectoryCore(subdirName, true, -1, (_c = this.runtime.clientId) !== null && _c !== void 0 ? _c : "detached");
+        const isNew = this.createSubDirectoryCore(subdirName, true, this.getLocalSeq(), this.runtime.clientId ?? "detached");
         const subDir = this._subdirectories.get(subdirName);
         assert(subDir !== undefined, 0x5aa /* subdirectory should exist after creation */);
         // If we are not attached, don't submit the op.
@@ -819,6 +822,16 @@ class SubDirectory extends TypedEventEmitter {
         }
         return subDir;
     }
+    /**
+     * @returns A sequenceNumber 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).
+     * TODO: Convert these conventions to named constants. The semantics used here match those for merge-tree.
+     */
+    getLocalSeq() {
+        return this.directory.isAttached() ? -1 : 0;
+    }
     /**
      * {@inheritDoc IDirectory.getSubDirectory}
      */
@@ -872,7 +885,7 @@ class SubDirectory extends TypedEventEmitter {
     /**
      * This checks if there is pending delete op for local delete for a given child subdirectory.
      * @param subDirName - directory name.
-     * @returns - true if there is pending delete.
+     * @returns true if there is pending delete.
      */
     isSubDirectoryDeletePending(subDirName) {
         if (this.pendingDeleteSubDirectoriesTracker.has(subDirName)) {
@@ -1128,10 +1141,9 @@ class SubDirectory extends TypedEventEmitter {
      * @returns metadata generated for stahed op
      */
     applyStashedCreateSubDirMessage(op) {
-        var _c;
         this.throwIfDisposed();
         // Create the sub directory locally first.
-        this.createSubDirectoryCore(op.subdirName, true, -1, (_c = this.runtime.clientId) !== null && _c !== void 0 ? _c : "detached");
+        this.createSubDirectoryCore(op.subdirName, true, this.getLocalSeq(), this.runtime.clientId ?? "detached");
         this.updatePendingSubDirMessageCount(op);
         const localOpMetadata = {
             type: "createSubDir",
@@ -1248,13 +1260,11 @@ class SubDirectory extends TypedEventEmitter {
         }
     }
     incrementPendingSubDirCount(map, subDirName) {
-        var _c;
-        const count = (_c = map.get(subDirName)) !== null && _c !== void 0 ? _c : 0;
+        const count = map.get(subDirName) ?? 0;
         map.set(subDirName, count + 1);
     }
     decrementPendingSubDirCount(map, subDirName) {
-        var _c;
-        const count = (_c = map.get(subDirName)) !== null && _c !== void 0 ? _c : 0;
+        const count = map.get(subDirName) ?? 0;
         map.set(subDirName, count - 1);
         if (count <= 1) {
             map.delete(subDirName);
@@ -1385,7 +1395,7 @@ class SubDirectory extends TypedEventEmitter {
      */
     rollbackPendingMessageId(map, key, pendingMessageId) {
         const pendingMessageIds = map.get(key);
-        const lastPendingMessageId = pendingMessageIds === null || pendingMessageIds === void 0 ? void 0 : pendingMessageIds.pop();
+        const lastPendingMessageId = pendingMessageIds?.pop();
         if (!pendingMessageIds || lastPendingMessageId !== pendingMessageId) {
             throw new Error("Rollback op does not match last pending");
         }
@@ -1573,8 +1583,9 @@ class SubDirectory extends TypedEventEmitter {
             if (op.type === "createSubDirectory") {
                 const dir = this._subdirectories.get(op.subdirName);
                 // Child sub directory create seq number can't be lower than the parent subdirectory.
-                if (this.sequenceNumber !== -1 && this.sequenceNumber < msg.sequenceNumber) {
-                    if ((dir === null || dir === void 0 ? void 0 : dir.sequenceNumber) === -1) {
+                // The sequence number for multiple ops can be the same when multiple createSubDirectory occurs with grouped batching enabled, thus <= and not just <.
+                if (this.sequenceNumber !== -1 && this.sequenceNumber <= msg.sequenceNumber) {
+                    if (dir?.sequenceNumber === -1) {
                         // Only set the seq on the first message, could be more
                         dir.sequenceNumber = msg.sequenceNumber;
                     }
@@ -1625,7 +1636,7 @@ class SubDirectory extends TypedEventEmitter {
      */
     deleteCore(key, local) {
         const previousLocalValue = this._storage.get(key);
-        const previousValue = previousLocalValue === null || previousLocalValue === void 0 ? void 0 : previousLocalValue.value;
+        const previousValue = previousLocalValue?.value;
         const successfullyRemoved = this._storage.delete(key);
         if (successfullyRemoved) {
             const event = { key, path: this.absolutePath, previousValue };
@@ -1644,7 +1655,7 @@ class SubDirectory extends TypedEventEmitter {
      */
     setCore(key, value, local) {
         const previousLocalValue = this._storage.get(key);
-        const previousValue = previousLocalValue === null || previousLocalValue === void 0 ? void 0 : previousLocalValue.value;
+        const previousValue = previousLocalValue?.value;
         this._storage.set(key, value);
         const event = { key, path: this.absolutePath, previousValue };
         this.directory.emit("valueChanged", event, local, this.directory);
@@ -1658,7 +1669,7 @@ class SubDirectory extends TypedEventEmitter {
      * @param local - Whether the message originated from the local client
      * @param seq - Sequence number at which this directory is created
      * @param clientId - Id of client which created this directory.
-     * @returns - True if is newly created, false if it already existed.
+     * @returns True if is newly created, false if it already existed.
      */
     createSubDirectoryCore(subdirName, local, seq, clientId) {
         const subdir = this._subdirectories.get(subdirName);