@fluidframework/map 0.54.2 → 0.56.0-49831

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "0.54.2",
+  "version": "0.56.0-49831",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -23,7 +23,7 @@
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
     "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
     "test": "npm run test:mocha",
@@ -57,35 +57,37 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "^0.41.0",
-    "@fluidframework/datastore-definitions": "^0.54.2",
-    "@fluidframework/driver-utils": "^0.54.2",
-    "@fluidframework/protocol-base": "^0.1034.0",
+    "@fluidframework/core-interfaces": "^0.42.0-0",
+    "@fluidframework/datastore-definitions": "0.56.0-49831",
+    "@fluidframework/driver-utils": "0.56.0-49831",
     "@fluidframework/protocol-definitions": "^0.1026.0",
-    "@fluidframework/shared-object-base": "^0.54.2",
+    "@fluidframework/runtime-definitions": "0.56.0-49831",
+    "@fluidframework/runtime-utils": "0.56.0-49831",
+    "@fluidframework/shared-object-base": "0.56.0-49831",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "^0.54.2",
+    "@fluid-internal/test-dds-utils": "0.56.0-49831",
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.24.0",
-    "@fluidframework/mocha-test-setup": "^0.54.2",
-    "@fluidframework/test-runtime-utils": "^0.54.2",
+    "@fluidframework/eslint-config-fluid": "^0.25.0",
+    "@fluidframework/mocha-test-setup": "0.56.0-49831",
+    "@fluidframework/test-runtime-utils": "0.56.0-49831",
     "@microsoft/api-extractor": "^7.16.1",
+    "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
     "@types/node": "^14.18.0",
-    "@typescript-eslint/eslint-plugin": "~4.14.0",
-    "@typescript-eslint/parser": "~4.14.0",
+    "@typescript-eslint/eslint-plugin": "~5.9.0",
+    "@typescript-eslint/parser": "~5.9.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "cross-env": "^7.0.2",
-    "eslint": "~7.18.0",
+    "eslint": "~8.6.0",
+    "eslint-plugin-editorconfig": "~3.2.0",
     "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.22.1",
+    "eslint-plugin-import": "~2.25.4",
     "eslint-plugin-no-null": "~1.0.2",
-    "eslint-plugin-prefer-arrow": "~1.2.2",
-    "eslint-plugin-react": "~7.22.0",
-    "eslint-plugin-unicorn": "~26.0.1",
+    "eslint-plugin-react": "~7.28.0",
+    "eslint-plugin-unicorn": "~40.0.0",
     "mocha": "^8.4.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",

package/src/directory.ts

@@ -4,12 +4,9 @@
  */
 
 import { assert,TypedEventEmitter } from "@fluidframework/common-utils";
-import { IFluidSerializer } from "@fluidframework/core-interfaces";
 import { readAndParse } from "@fluidframework/driver-utils";
-import { addBlobToTree } from "@fluidframework/protocol-base";
 import {
     ISequencedDocumentMessage,
-    ITree,
     MessageType,
 } from "@fluidframework/protocol-definitions";
 import {
@@ -19,7 +16,9 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
-import { SharedObject, ValueType } from "@fluidframework/shared-object-base";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { IFluidSerializer, SharedObject, ValueType } from "@fluidframework/shared-object-base";
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import * as path from "path-browserify";
 import {
     IDirectory,
@@ -204,10 +203,10 @@ export interface IDirectoryNewStorageFormat {
     content: IDirectoryDataObject;
 }
 
-function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): ITree {
+function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): ISummaryTreeWithStats {
     const MinValueSizeSeparateSnapshotBlob = 8 * 1024;
 
-    const tree: ITree = { entries: [] };
+    const builder = new SummaryTreeBuilder();
     let counter = 0;
     const blobs: string[] = [];
 
@@ -241,7 +240,7 @@ function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): I
                 const blobName = `blob${counter}`;
                 counter++;
                 blobs.push(blobName);
-                addBlobToTree(tree, blobName, extraContent);
+                builder.addBlob(blobName, JSON.stringify(extraContent));
             } else {
                 currentSubDirObject.storage[key] = result;
             }
@@ -261,9 +260,9 @@ function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): I
         blobs,
         content,
     };
-    addBlobToTree(tree, snapshotFileName, newFormat);
+    builder.addBlob(snapshotFileName, JSON.stringify(newFormat));
 
-    return tree;
+    return builder.getSummaryTree();
 }
 
 /**
@@ -417,13 +416,6 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         return this.root.get<T>(key);
     }
 
-    /**
-     * {@inheritDoc IDirectory.wait}
-     */
-    public async wait<T = any>(key: string): Promise<T> {
-        return this.root.wait<T>(key);
-    }
-
     /**
      * {@inheritDoc IDirectory.set}
      */
@@ -560,10 +552,10 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
     }
 
     /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.snapshotCore}
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      * @internal
      */
-    protected snapshotCore(serializer: IFluidSerializer): ITree {
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {
         return serializeDirectory(this.root, serializer);
     }
 
@@ -899,30 +891,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         return this._storage.get(key)?.value as T | undefined;
     }
 
-    /**
-     * {@inheritDoc IDirectory.wait}
-     */
-    public async wait<T = any>(key: string): Promise<T> {
-        // Return immediately if the value already exists
-        if (this._storage.has(key)) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            return this._storage.get(key)!.value as T;
-        }
-
-        // Otherwise subscribe to changes
-        return new Promise<T>((resolve, reject) => {
-            const callback = (changed: IDirectoryValueChanged) => {
-                if (this.absolutePath === changed.path && key === changed.key) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    resolve(this._storage.get(key)!.value as T);
-                    this.directory.removeListener("valueChanged", callback);
-                }
-            };
-
-            this.directory.on("valueChanged", callback);
-        });
-    }
-
     /**
      * {@inheritDoc IDirectory.set}
      */

package/src/interfaces.ts

@@ -40,13 +40,6 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
      */
     get<T = any>(key: string): T | undefined;
 
-    /**
-     * A form of get except it will only resolve the promise once the key exists in the directory.
-     * @param key - Key to retrieve from
-     * @returns The stored value once available
-     */
-    wait<T = any>(key: string): Promise<T>;
-
     /**
      * Sets the value stored at key to the provided value.
      * @param key - Key to set at
@@ -264,13 +257,6 @@ export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string,
      */
     get<T = any>(key: string): T | undefined;
 
-    /**
-     * A form of get except it will only resolve the promise once the key exists in the map.
-     * @param key - Key to retrieve from
-     * @returns The stored value once available
-     */
-    wait<T = any>(key: string): Promise<T>;
-
     /**
      * Sets the value stored at key to the provided value.
      * @param key - Key to set at

package/src/localValues.ts

@@ -3,12 +3,10 @@
  * Licensed under the MIT License.
  */
 
+import { IFluidHandle } from "@fluidframework/core-interfaces";
 import {
-    IFluidHandle,
     IFluidSerializer,
     ISerializedHandle,
-} from "@fluidframework/core-interfaces";
-import {
     parseHandles,
     serializeHandles,
     SharedObject,

package/src/map.ts

@@ -3,13 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidSerializer } from "@fluidframework/core-interfaces";
-import { addBlobToTree } from "@fluidframework/protocol-base";
-import {
-    ISequencedDocumentMessage,
-    ITree,
-    MessageType,
-} from "@fluidframework/protocol-definitions";
+import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import {
     IChannelAttributes,
     IFluidDataStoreRuntime,
@@ -17,10 +11,13 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import {
+    IFluidSerializer,
     SharedObject,
 } from "@fluidframework/shared-object-base";
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import {
     ISharedMap,
     ISharedMapEvents,
@@ -211,13 +208,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
         return this.kernel.get<T>(key);
     }
 
-    /**
-     * {@inheritDoc ISharedMap.wait}
-     */
-    public async wait<T = any>(key: string): Promise<T> {
-        return this.kernel.wait<T>(key);
-    }
-
     /**
      * Check if a key exists in the map.
      * @param key - The key to check
@@ -252,18 +242,16 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
     }
 
     /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.snapshotCore}
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      * @internal
      */
-    protected snapshotCore(serializer: IFluidSerializer): ITree {
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {
         let currentSize = 0;
         let counter = 0;
         let headerBlob: IMapDataObjectSerializable = {};
         const blobs: string[] = [];
 
-        const tree: ITree = {
-            entries: [],
-        };
+        const builder = new SummaryTreeBuilder();
 
         const data = this.kernel.getSerializedStorage(serializer);
 
@@ -296,7 +284,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
                         value: JSON.parse(value.value),
                     },
                 };
-                addBlobToTree(tree, blobName, content);
+                builder.addBlob(blobName, JSON.stringify(content));
             } else {
                 currentSize += value.type.length + 21; // Approximation cost of property header
                 if (value.value) {
@@ -307,7 +295,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
                     const blobName = `blob${counter}`;
                     counter++;
                     blobs.push(blobName);
-                    addBlobToTree(tree, blobName, headerBlob);
+                    builder.addBlob(blobName, JSON.stringify(headerBlob));
                     headerBlob = {};
                     currentSize = 0;
                 }
@@ -322,9 +310,9 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
             blobs,
             content: headerBlob,
         };
-        addBlobToTree(tree, snapshotFileName, header);
+        builder.addBlob(snapshotFileName, JSON.stringify(header));
 
-        return tree;
+        return builder.getSummaryTree();
     }
 
     /**

package/src/mapKernel.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidHandle, IFluidSerializer } from "@fluidframework/core-interfaces";
-import { ValueType } from "@fluidframework/shared-object-base";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidSerializer, ValueType } from "@fluidframework/shared-object-base";
 import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
 import {
     ISerializableValue,
@@ -260,30 +260,6 @@ export class MapKernel {
         return localValue.value as T;
     }
 
-    /**
-     * {@inheritDoc ISharedMap.wait}
-     */
-    public async wait<T = any>(key: string): Promise<T> {
-        // Return immediately if the value already exists
-        if (this.has(key)) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            return this.get<T>(key)!;
-        }
-
-        // Otherwise subscribe to changes
-        return new Promise<T>((resolve) => {
-            const callback = (changed: IValueChanged) => {
-                if (key === changed.key) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    resolve(this.get<T>(changed.key)!);
-                    this.eventEmitter.removeListener("valueChanged", callback);
-                }
-            };
-
-            this.eventEmitter.on("valueChanged", callback);
-        });
-    }
-
     /**
      * Check if a key exists in the map.
      * @param key - The key to check

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "0.54.2";
+export const pkgVersion = "0.56.0-49831";