@fluidframework/map 0.58.2002 → 0.59.1000

package/lib/directory.js

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 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 { SharedObject, ValueType } from "@fluidframework/shared-object-base";
@@ -196,6 +197,12 @@ export class SharedDirectory extends SharedObject {
         this.root.set(key, value);
         return this;
     }
+    dispose(error) {
+        this.root.dispose(error);
+    }
+    get disposed() {
+        return this.root.disposed;
+    }
     /**
      * Deletes the given key from within this IDirectory.
      * @param key - The key to delete
@@ -245,6 +252,12 @@ export class SharedDirectory extends SharedObject {
     entries() {
         return this.root.entries();
     }
+    /**
+     * {@inheritDoc IDirectory.countSubDirectory}
+     */
+    countSubDirectory() {
+        return this.root.countSubDirectory();
+    }
     /**
      * Get an iterator over the keys under this IDirectory.
      * @returns The iterator
@@ -527,6 +540,10 @@ class SubDirectory extends TypedEventEmitter {
         this.runtime = runtime;
         this.serializer = serializer;
         this.absolutePath = absolutePath;
+        /**
+         * Tells if the sub directory is disposed or not.
+         */
+        this._disposed = false;
         /**
          * String representation for the class.
          */
@@ -557,12 +574,25 @@ class SubDirectory extends TypedEventEmitter {
          */
         this.pendingClearMessageId = -1;
     }
+    dispose(error) {
+        this._disposed = true;
+        this.emit("disposed", this);
+    }
+    get disposed() {
+        return this._disposed;
+    }
+    throwIfDisposed() {
+        if (this._disposed) {
+            throw new UsageError("Cannot access Disposed subDirectory");
+        }
+    }
     /**
      * Checks whether the given key exists in this IDirectory.
      * @param key - The key to check
      * @returns True if the key exists, false otherwise
      */
     has(key) {
+        this.throwIfDisposed();
         return this._storage.has(key);
     }
     /**
@@ -570,12 +600,14 @@ class SubDirectory extends TypedEventEmitter {
      */
     get(key) {
         var _a;
+        this.throwIfDisposed();
         return (_a = this._storage.get(key)) === null || _a === void 0 ? void 0 : _a.value;
     }
     /**
      * {@inheritDoc IDirectory.set}
      */
     set(key, value) {
+        this.throwIfDisposed();
         // Undefined/null keys can't be serialized to JSON in the manner we currently snapshot.
         if (key === undefined || key === null) {
             throw new Error("Undefined and null keys are not supported");
@@ -598,10 +630,17 @@ class SubDirectory extends TypedEventEmitter {
         this.submitKeyMessage(op);
         return this;
     }
+    /**
+     * {@inheritDoc IDirectory.countSubDirectory}
+     */
+    countSubDirectory() {
+        return this._subdirectories.size;
+    }
     /**
      * {@inheritDoc IDirectory.createSubDirectory}
      */
     createSubDirectory(subdirName) {
+        this.throwIfDisposed();
         // Undefined/null subdirectory names can't be serialized to JSON in the manner we currently snapshot.
         if (subdirName === undefined || subdirName === null) {
             throw new Error("SubDirectory name may not be undefined or null");
@@ -629,18 +668,21 @@ class SubDirectory extends TypedEventEmitter {
      * {@inheritDoc IDirectory.getSubDirectory}
      */
     getSubDirectory(subdirName) {
+        this.throwIfDisposed();
         return this._subdirectories.get(subdirName);
     }
     /**
      * {@inheritDoc IDirectory.hasSubDirectory}
      */
     hasSubDirectory(subdirName) {
+        this.throwIfDisposed();
         return this._subdirectories.has(subdirName);
     }
     /**
      * {@inheritDoc IDirectory.deleteSubDirectory}
      */
     deleteSubDirectory(subdirName) {
+        this.throwIfDisposed();
         // Delete the sub directory locally first.
         const successfullyRemoved = this.deleteSubDirectoryCore(subdirName, true);
         // If we are not attached, don't submit the op.
@@ -659,12 +701,14 @@ class SubDirectory extends TypedEventEmitter {
      * {@inheritDoc IDirectory.subdirectories}
      */
     subdirectories() {
+        this.throwIfDisposed();
         return this._subdirectories.entries();
     }
     /**
      * {@inheritDoc IDirectory.getWorkingDirectory}
      */
     getWorkingDirectory(relativePath) {
+        this.throwIfDisposed();
         return this.directory.getWorkingDirectory(this.makeAbsolute(relativePath));
     }
     /**
@@ -673,6 +717,7 @@ class SubDirectory extends TypedEventEmitter {
      * @returns True if the key existed and was deleted, false if it did not exist
      */
     delete(key) {
+        this.throwIfDisposed();
         // Delete the key locally first.
         const successfullyRemoved = this.deleteCore(key, true);
         // If we are not attached, don't submit the op.
@@ -691,6 +736,7 @@ class SubDirectory extends TypedEventEmitter {
      * Deletes all keys from within this IDirectory.
      */
     clear() {
+        this.throwIfDisposed();
         // Clear the data locally first.
         this.clearCore(true);
         // If we are not attached, don't submit the op.
@@ -708,6 +754,7 @@ class SubDirectory extends TypedEventEmitter {
      * @param callback - Callback to issue
      */
     forEach(callback) {
+        this.throwIfDisposed();
         this._storage.forEach((localValue, key, map) => {
             callback(localValue.value, key, map);
         });
@@ -716,6 +763,7 @@ class SubDirectory extends TypedEventEmitter {
      * The number of entries under this IDirectory.
      */
     get size() {
+        this.throwIfDisposed();
         return this._storage.size;
     }
     /**
@@ -723,6 +771,7 @@ class SubDirectory extends TypedEventEmitter {
      * @returns The iterator
      */
     entries() {
+        this.throwIfDisposed();
         const localEntriesIterator = this._storage.entries();
         const iterator = {
             next() {
@@ -746,6 +795,7 @@ class SubDirectory extends TypedEventEmitter {
      * @returns The iterator
      */
     keys() {
+        this.throwIfDisposed();
         return this._storage.keys();
     }
     /**
@@ -753,6 +803,7 @@ class SubDirectory extends TypedEventEmitter {
      * @returns The iterator
      */
     values() {
+        this.throwIfDisposed();
         const localValuesIterator = this._storage.values();
         const iterator = {
             next() {
@@ -776,6 +827,7 @@ class SubDirectory extends TypedEventEmitter {
      * @returns The iterator
      */
     [Symbol.iterator]() {
+        this.throwIfDisposed();
         return this.entries();
     }
     /**
@@ -788,6 +840,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     processClearMessage(op, local, localOpMetadata) {
+        this.throwIfDisposed();
         if (local) {
             assert(localOpMetadata !== undefined, 0x00f /* `pendingMessageId is missing from the local client's ${op.type} operation` */);
             const pendingMessageId = localOpMetadata;
@@ -809,6 +862,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     processDeleteMessage(op, local, localOpMetadata) {
+        this.throwIfDisposed();
         if (!this.needProcessStorageOperation(op, local, localOpMetadata)) {
             return;
         }
@@ -824,6 +878,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     processSetMessage(op, context, local, localOpMetadata) {
+        this.throwIfDisposed();
         if (!this.needProcessStorageOperation(op, local, localOpMetadata)) {
             return;
         }
@@ -842,6 +897,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     processCreateSubDirectoryMessage(op, local, localOpMetadata) {
+        this.throwIfDisposed();
         if (!this.needProcessSubDirectoryOperations(op, local, localOpMetadata)) {
             return;
         }
@@ -857,6 +913,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     processDeleteSubDirectoryMessage(op, local, localOpMetadata) {
+        this.throwIfDisposed();
         if (!this.needProcessSubDirectoryOperations(op, local, localOpMetadata)) {
             return;
         }
@@ -868,6 +925,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     submitClearMessage(op) {
+        this.throwIfDisposed();
         const pendingMessageId = ++this.pendingMessageId;
         this.directory.submitDirectoryMessage(op, pendingMessageId);
         this.pendingClearMessageId = pendingMessageId;
@@ -878,6 +936,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     submitKeyMessage(op) {
+        this.throwIfDisposed();
         const pendingMessageId = ++this.pendingMessageId;
         this.directory.submitDirectoryMessage(op, pendingMessageId);
         this.pendingKeys.set(op.key, pendingMessageId);
@@ -888,6 +947,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     submitSubDirectoryMessage(op) {
+        this.throwIfDisposed();
         const pendingMessageId = ++this.pendingMessageId;
         this.directory.submitDirectoryMessage(op, pendingMessageId);
         this.pendingSubDirectories.set(op.subdirName, pendingMessageId);
@@ -899,6 +959,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     *getSerializedStorage(serializer) {
+        this.throwIfDisposed();
         for (const [key, localValue] of this._storage) {
             const value = localValue.makeSerialized(serializer, this.directory.handle);
             const res = [key, value];
@@ -912,6 +973,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     populateStorage(key, localValue) {
+        this.throwIfDisposed();
         this._storage.set(key, localValue);
     }
     /**
@@ -921,6 +983,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     populateSubDirectory(subdirName, newSubDir) {
+        this.throwIfDisposed();
         this._subdirectories.set(subdirName, newSubDir);
     }
     /**
@@ -931,6 +994,7 @@ class SubDirectory extends TypedEventEmitter {
      * @internal
      */
     getLocalValue(key) {
+        this.throwIfDisposed();
         return this._storage.get(key);
     }
     /**
@@ -1074,9 +1138,25 @@ class SubDirectory extends TypedEventEmitter {
      * @param op - The message if from a remote delete, or null if from a local delete
      */
     deleteSubDirectoryCore(subdirName, local) {
+        const previousValue = this.getSubDirectory(subdirName);
         // This should make the subdirectory structure unreachable so it can be GC'd and won't appear in snapshots
         // Might want to consider cleaning out the structure more exhaustively though?
-        return this._subdirectories.delete(subdirName);
+        const successfullyRemoved = this._subdirectories.delete(subdirName);
+        this.disposeSubDirectoryTree(previousValue);
+        return successfullyRemoved;
+    }
+    disposeSubDirectoryTree(directory) {
+        if (!directory) {
+            return;
+        }
+        // Dispose the subdirectory tree. This will dispose the subdirectories from bottom to top.
+        const subDirectories = directory.subdirectories();
+        for (const [_, subDirectory] of subDirectories) {
+            this.disposeSubDirectoryTree(subDirectory);
+        }
+        if (typeof directory.dispose === "function") {
+            directory.dispose();
+        }
     }
 }
 //# sourceMappingURL=directory.js.map