@fluidframework/map 0.58.2002 → 0.59.1000

package/src/directory.ts

@@ -4,6 +4,7 @@
  */
 
 import { assert,TypedEventEmitter } from "@fluidframework/common-utils";
+import { UsageError } from "@fluidframework/container-utils";
 import { readAndParse } from "@fluidframework/driver-utils";
 import {
     ISequencedDocumentMessage,
@@ -424,6 +425,14 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         return this;
     }
 
+    public dispose(error?: Error): void {
+        this.root.dispose(error);
+    }
+
+    public get disposed(): boolean {
+        return this.root.disposed;
+    }
+
     /**
      * Deletes the given key from within this IDirectory.
      * @param key - The key to delete
@@ -480,6 +489,13 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         return this.root.entries();
     }
 
+    /**
+     * {@inheritDoc IDirectory.countSubDirectory}
+     */
+    public countSubDirectory(): number {
+        return this.root.countSubDirectory();
+    }
+
     /**
      * Get an iterator over the keys under this IDirectory.
      * @returns The iterator
@@ -802,6 +818,11 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
  * @sealed
  */
 class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirectory {
+    /**
+     * Tells if the sub directory is disposed or not.
+     */
+    private _disposed = false;
+
     /**
      * String representation for the class.
      */
@@ -854,12 +875,28 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         super();
     }
 
+    public dispose(error?: Error): void {
+        this._disposed = true;
+        this.emit("disposed", this);
+    }
+
+    public get disposed(): boolean {
+        return this._disposed;
+    }
+
+    private 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
      */
     public has(key: string): boolean {
+        this.throwIfDisposed();
         return this._storage.has(key);
     }
 
@@ -867,6 +904,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.get}
      */
     public get<T = any>(key: string): T | undefined {
+        this.throwIfDisposed();
         return this._storage.get(key)?.value as T | undefined;
     }
 
@@ -874,6 +912,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.set}
      */
     public set<T = any>(key: string, value: T): this {
+        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");
@@ -908,10 +947,18 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         return this;
     }
 
+    /**
+     * {@inheritDoc IDirectory.countSubDirectory}
+     */
+    public countSubDirectory(): number {
+        return this._subdirectories.size;
+    }
+
     /**
      * {@inheritDoc IDirectory.createSubDirectory}
      */
     public createSubDirectory(subdirName: string): IDirectory {
+        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");
@@ -946,6 +993,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.getSubDirectory}
      */
     public getSubDirectory(subdirName: string): IDirectory | undefined {
+        this.throwIfDisposed();
         return this._subdirectories.get(subdirName);
     }
 
@@ -953,6 +1001,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.hasSubDirectory}
      */
     public hasSubDirectory(subdirName: string): boolean {
+        this.throwIfDisposed();
         return this._subdirectories.has(subdirName);
     }
 
@@ -960,6 +1009,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.deleteSubDirectory}
      */
     public deleteSubDirectory(subdirName: string): boolean {
+        this.throwIfDisposed();
         // Delete the sub directory locally first.
         const successfullyRemoved = this.deleteSubDirectoryCore(subdirName, true);
 
@@ -982,6 +1032,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.subdirectories}
      */
     public subdirectories(): IterableIterator<[string, IDirectory]> {
+        this.throwIfDisposed();
         return this._subdirectories.entries();
     }
 
@@ -989,6 +1040,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * {@inheritDoc IDirectory.getWorkingDirectory}
      */
     public getWorkingDirectory(relativePath: string): IDirectory | undefined {
+        this.throwIfDisposed();
         return this.directory.getWorkingDirectory(this.makeAbsolute(relativePath));
     }
 
@@ -998,6 +1050,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @returns True if the key existed and was deleted, false if it did not exist
      */
     public delete(key: string): boolean {
+        this.throwIfDisposed();
         // Delete the key locally first.
         const successfullyRemoved = this.deleteCore(key, true);
 
@@ -1020,6 +1073,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Deletes all keys from within this IDirectory.
      */
     public clear(): void {
+        this.throwIfDisposed();
         // Clear the data locally first.
         this.clearCore(true);
 
@@ -1040,6 +1094,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @param callback - Callback to issue
      */
     public forEach(callback: (value: any, key: string, map: Map<string, any>) => void): void {
+        this.throwIfDisposed();
         this._storage.forEach((localValue, key, map) => {
             callback(localValue.value, key, map);
         });
@@ -1049,6 +1104,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * The number of entries under this IDirectory.
      */
     public get size(): number {
+        this.throwIfDisposed();
         return this._storage.size;
     }
 
@@ -1057,6 +1113,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @returns The iterator
      */
     public entries(): IterableIterator<[string, any]> {
+        this.throwIfDisposed();
         const localEntriesIterator = this._storage.entries();
         const iterator = {
             next(): IteratorResult<[string, any]> {
@@ -1080,6 +1137,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @returns The iterator
      */
     public keys(): IterableIterator<string> {
+        this.throwIfDisposed();
         return this._storage.keys();
     }
 
@@ -1088,6 +1146,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @returns The iterator
      */
     public values(): IterableIterator<any> {
+        this.throwIfDisposed();
         const localValuesIterator = this._storage.values();
         const iterator = {
             next(): IteratorResult<any> {
@@ -1111,6 +1170,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @returns The iterator
      */
     public [Symbol.iterator](): IterableIterator<[string, any]> {
+        this.throwIfDisposed();
         return this.entries();
     }
 
@@ -1128,6 +1188,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         local: boolean,
         localOpMetadata: unknown,
     ): void {
+        this.throwIfDisposed();
         if (local) {
             assert(localOpMetadata !== undefined,
                 0x00f /* `pendingMessageId is missing from the local client's ${op.type} operation` */);
@@ -1155,6 +1216,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         local: boolean,
         localOpMetadata: unknown,
     ): void {
+        this.throwIfDisposed();
         if (!this.needProcessStorageOperation(op, local, localOpMetadata)) {
             return;
         }
@@ -1176,6 +1238,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         local: boolean,
         localOpMetadata: unknown,
     ): void {
+        this.throwIfDisposed();
         if (!this.needProcessStorageOperation(op, local, localOpMetadata)) {
             return;
         }
@@ -1201,6 +1264,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         local: boolean,
         localOpMetadata: unknown,
     ): void {
+        this.throwIfDisposed();
         if (!this.needProcessSubDirectoryOperations(op, local, localOpMetadata)) {
             return;
         }
@@ -1221,6 +1285,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         local: boolean,
         localOpMetadata: unknown,
     ): void {
+        this.throwIfDisposed();
         if (!this.needProcessSubDirectoryOperations(op, local, localOpMetadata)) {
             return;
         }
@@ -1233,6 +1298,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public submitClearMessage(op: IDirectoryClearOperation): void {
+        this.throwIfDisposed();
         const pendingMessageId = ++this.pendingMessageId;
         this.directory.submitDirectoryMessage(op, pendingMessageId);
         this.pendingClearMessageId = pendingMessageId;
@@ -1244,6 +1310,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public submitKeyMessage(op: IDirectoryKeyOperation): void {
+        this.throwIfDisposed();
         const pendingMessageId = ++this.pendingMessageId;
         this.directory.submitDirectoryMessage(op, pendingMessageId);
         this.pendingKeys.set(op.key, pendingMessageId);
@@ -1255,6 +1322,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public submitSubDirectoryMessage(op: IDirectorySubDirectoryOperation): void {
+        this.throwIfDisposed();
         const pendingMessageId = ++this.pendingMessageId;
         this.directory.submitDirectoryMessage(op, pendingMessageId);
         this.pendingSubDirectories.set(op.subdirName, pendingMessageId);
@@ -1267,6 +1335,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public *getSerializedStorage(serializer: IFluidSerializer) {
+        this.throwIfDisposed();
         for (const [key, localValue] of this._storage) {
             const value = localValue.makeSerialized(serializer, this.directory.handle);
             const res: [string, ISerializedValue] = [key, value];
@@ -1281,6 +1350,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public populateStorage(key: string, localValue: ILocalValue): void {
+        this.throwIfDisposed();
         this._storage.set(key, localValue);
     }
 
@@ -1291,6 +1361,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public populateSubDirectory(subdirName: string, newSubDir: SubDirectory): void {
+        this.throwIfDisposed();
         this._subdirectories.set(subdirName, newSubDir);
     }
 
@@ -1302,6 +1373,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public getLocalValue<T extends ILocalValue = ILocalValue>(key: string): T {
+        this.throwIfDisposed();
         return this._storage.get(key) as T;
     }
 
@@ -1475,8 +1547,25 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @param op - The message if from a remote delete, or null if from a local delete
      */
     private deleteSubDirectoryCore(subdirName: string, local: boolean) {
+        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;
+    }
+
+    private disposeSubDirectoryTree(directory: IDirectory | undefined) {
+        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();
+        }
     }
 }

package/src/interfaces.ts

@@ -4,7 +4,7 @@
  */
 
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
-import { IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/common-definitions";
+import { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/common-definitions";
 
 /**
  * Type of "valueChanged" event parameter.
@@ -27,7 +27,7 @@ export interface IValueChanged {
  * @remarks
  * When used as a Map, operates on its keys.
  */
-export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents> {
+export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {
     /**
      * The absolute path of the directory.
      */
@@ -48,6 +48,12 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
      */
     set<T = any>(key: string, value: T): this;
 
+    /**
+     * Get the number of sub directory within the directory.
+     * @returns The number of sub directory within a directory.
+     */
+    countSubDirectory?(): number;
+
     /**
      * Creates an IDirectory child of this IDirectory, or retrieves the existing IDirectory child if one with the
      * same name already exists.
@@ -164,6 +170,18 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
  * - `local` - Whether the change originated from the this client.
  *
  * - `target` - The IDirectory itself.
+ *
+ * ### "disposed"
+ *
+ * The dispose event is emitted when this sub directory is deleted.
+ *
+ * #### Listener signature
+ *
+ * ```typescript
+ * (local: boolean, target: IEventThisPlaceHolder) => void
+ * ```
+ *
+ * - `target` - The IDirectory itself.
  */
 export interface IDirectoryEvents extends IEvent {
     (event: "containedValueChanged", listener: (
@@ -171,6 +189,9 @@ export interface IDirectoryEvents extends IEvent {
         local: boolean,
         target: IEventThisPlaceHolder,
     ) => void);
+    (event: "disposed", listener: (
+        target: IEventThisPlaceHolder,
+    ) => void);
 }
 
 /**

package/src/packageVersion.ts

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