@fluidframework/map 0.59.4001 → 1.1.0-75972

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "0.59.4001";
+export const pkgVersion = "1.1.0-75972";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAC7C,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/map\";\nexport const pkgVersion = \"0.59.4001\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAC7C,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/map\";\nexport const pkgVersion = \"1.1.0-75972\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "0.59.4001",
+  "version": "1.1.0-75972",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,45 +62,32 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-utils": "^0.59.4001",
-    "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/datastore-definitions": "^0.59.4001",
-    "@fluidframework/driver-utils": "^0.59.4001",
+    "@fluidframework/container-utils": "1.1.0-75972",
+    "@fluidframework/core-interfaces": "1.1.0-75972",
+    "@fluidframework/datastore-definitions": "1.1.0-75972",
+    "@fluidframework/driver-utils": "1.1.0-75972",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^0.59.4001",
-    "@fluidframework/runtime-utils": "^0.59.4001",
-    "@fluidframework/shared-object-base": "^0.59.4001",
+    "@fluidframework/runtime-definitions": "1.1.0-75972",
+    "@fluidframework/runtime-utils": "1.1.0-75972",
+    "@fluidframework/shared-object-base": "1.1.0-75972",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "^0.59.4001",
-    "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.70857",
+    "@fluid-internal/test-dds-utils": "1.1.0-75972",
+    "@fluidframework/build-common": "^0.24.0-0",
+    "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/map-previous": "npm:@fluidframework/map@0.59.4000",
-    "@fluidframework/mocha-test-setup": "^0.59.4001",
-    "@fluidframework/test-runtime-utils": "^0.59.4001",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@^1.0.0",
+    "@fluidframework/mocha-test-setup": "1.1.0-75972",
+    "@fluidframework/test-runtime-utils": "1.1.0-75972",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^14.18.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": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-jest": "~26.1.3",
-    "eslint-plugin-jsdoc": "~39.3.0",
-    "eslint-plugin-mocha": "~10.0.3",
-    "eslint-plugin-promise": "~6.0.0",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-tsdoc": "~0.2.14",
-    "eslint-plugin-unicorn": "~40.0.0",
-    "eslint-plugin-unused-imports": "~2.0.0",
     "mocha": "^10.0.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
@@ -108,7 +95,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.4001",
+    "version": "1.1.0",
     "broken": {}
   }
 }

package/src/directory.ts

@@ -17,7 +17,7 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { ISummaryTreeWithStats, ITelemetryContext } 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";
@@ -204,67 +204,6 @@ export interface IDirectoryNewStorageFormat {
     content: IDirectoryDataObject;
 }
 
-function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): ISummaryTreeWithStats {
-    const MinValueSizeSeparateSnapshotBlob = 8 * 1024;
-
-    const builder = new SummaryTreeBuilder();
-    let counter = 0;
-    const blobs: string[] = [];
-
-    const stack: [SubDirectory, IDirectoryDataObject][] = [];
-    const content: IDirectoryDataObject = {};
-    stack.push([root, content]);
-
-    while (stack.length > 0) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const [currentSubDir, currentSubDirObject] = stack.pop()!;
-        for (const [key, value] of currentSubDir.getSerializedStorage(serializer)) {
-            if (!currentSubDirObject.storage) {
-                currentSubDirObject.storage = {};
-            }
-            const result: ISerializableValue = {
-                type: value.type,
-                value: value.value && JSON.parse(value.value) as object,
-            };
-            if (value.value && value.value.length >= MinValueSizeSeparateSnapshotBlob) {
-                const extraContent: IDirectoryDataObject = {};
-                let largeContent = extraContent;
-                if (currentSubDir.absolutePath !== posix.sep) {
-                    for (const dir of currentSubDir.absolutePath.substr(1).split(posix.sep)) {
-                        const subDataObject: IDirectoryDataObject = {};
-                        largeContent.subdirectories = { [dir]: subDataObject };
-                        largeContent = subDataObject;
-                    }
-                }
-                largeContent.storage = { [key]: result };
-                const blobName = `blob${counter}`;
-                counter++;
-                blobs.push(blobName);
-                builder.addBlob(blobName, JSON.stringify(extraContent));
-            } else {
-                currentSubDirObject.storage[key] = result;
-            }
-        }
-
-        for (const [subdirName, subdir] of currentSubDir.subdirectories()) {
-            if (!currentSubDirObject.subdirectories) {
-                currentSubDirObject.subdirectories = {};
-            }
-            const subDataObject: IDirectoryDataObject = {};
-            currentSubDirObject.subdirectories[subdirName] = subDataObject;
-            stack.push([subdir as SubDirectory, subDataObject]);
-        }
-    }
-
-    const newFormat: IDirectoryNewStorageFormat = {
-        blobs,
-        content,
-    };
-    builder.addBlob(snapshotFileName, JSON.stringify(newFormat));
-
-    return builder.getSummaryTree();
-}
-
 /**
  * The factory that defines the directory.
  * @sealed
@@ -397,7 +336,7 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         runtime: IFluidDataStoreRuntime,
         attributes: IChannelAttributes,
     ) {
-        super(id, runtime, attributes);
+        super(id, runtime, attributes, "fluid_directory_");
         this.localValueMaker = new LocalValueMaker(this.serializer);
         this.setMessageHandlers();
         // Mirror the containedValueChanged op on the SharedDirectory
@@ -582,8 +521,11 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      * @internal
      */
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {
-        return serializeDirectory(this.root, serializer);
+    protected summarizeCore(
+        serializer: IFluidSerializer,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats {
+        return this.serializeDirectory(this.root, serializer);
     }
 
     /**
@@ -822,6 +764,72 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
     protected applyStashedOp() {
         throw new Error("not implemented");
     }
+
+    private serializeDirectory(
+        root: SubDirectory,
+        serializer: IFluidSerializer,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats {
+        const MinValueSizeSeparateSnapshotBlob = 8 * 1024;
+
+        const builder = new SummaryTreeBuilder();
+        let counter = 0;
+        const blobs: string[] = [];
+
+        const stack: [SubDirectory, IDirectoryDataObject][] = [];
+        const content: IDirectoryDataObject = {};
+        stack.push([root, content]);
+
+        while (stack.length > 0) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const [currentSubDir, currentSubDirObject] = stack.pop()!;
+            for (const [key, value] of currentSubDir.getSerializedStorage(serializer)) {
+                if (!currentSubDirObject.storage) {
+                    currentSubDirObject.storage = {};
+                }
+                const result: ISerializableValue = {
+                    type: value.type,
+                    // eslint-disable-next-line @typescript-eslint/ban-types
+                    value: value.value && JSON.parse(value.value) as object,
+                };
+                if (value.value && value.value.length >= MinValueSizeSeparateSnapshotBlob) {
+                    const extraContent: IDirectoryDataObject = {};
+                    let largeContent = extraContent;
+                    if (currentSubDir.absolutePath !== posix.sep) {
+                        for (const dir of currentSubDir.absolutePath.substr(1).split(posix.sep)) {
+                            const subDataObject: IDirectoryDataObject = {};
+                            largeContent.subdirectories = { [dir]: subDataObject };
+                            largeContent = subDataObject;
+                        }
+                    }
+                    largeContent.storage = { [key]: result };
+                    const blobName = `blob${counter}`;
+                    counter++;
+                    blobs.push(blobName);
+                    builder.addBlob(blobName, JSON.stringify(extraContent));
+                } else {
+                    currentSubDirObject.storage[key] = result;
+                }
+            }
+
+            for (const [subdirName, subdir] of currentSubDir.subdirectories()) {
+                if (!currentSubDirObject.subdirectories) {
+                    currentSubDirObject.subdirectories = {};
+                }
+                const subDataObject: IDirectoryDataObject = {};
+                currentSubDirObject.subdirectories[subdirName] = subDataObject;
+                stack.push([subdir as SubDirectory, subDataObject]);
+            }
+        }
+
+        const newFormat: IDirectoryNewStorageFormat = {
+            blobs,
+            content,
+        };
+        builder.addBlob(snapshotFileName, JSON.stringify(newFormat));
+
+        return builder.getSummaryTree();
+    }
 }
 
 /**
@@ -1421,14 +1429,14 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
             return false;
         }
 
-        if (this.pendingKeys.has(op.key)) {
+        const pendingKeyMessageId = this.pendingKeys.get(op.key);
+        if (pendingKeyMessageId !== undefined) {
             // Found an NACK op, clear it from the directory if the latest sequence number in the directory
             // match the message's and don't process the op.
             if (local) {
                 assert(localOpMetadata !== undefined,
                     0x011 /* pendingMessageId is missing from the local client's operation */);
                 const pendingMessageId = localOpMetadata as number;
-                const pendingKeyMessageId = this.pendingKeys.get(op.key);
                 if (pendingKeyMessageId === pendingMessageId) {
                     this.pendingKeys.delete(op.key);
                 }
@@ -1455,12 +1463,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         local: boolean,
         localOpMetadata: unknown,
     ): boolean {
-        if (this.pendingSubDirectories.has(op.subdirName)) {
+        const pendingSubDirectoryMessageId = this.pendingSubDirectories.get(op.subdirName);
+        if (pendingSubDirectoryMessageId !== undefined) {
             if (local) {
                 assert(localOpMetadata !== undefined,
                     0x012 /* pendingMessageId is missing from the local client's operation */);
                 const pendingMessageId = localOpMetadata as number;
-                const pendingSubDirectoryMessageId = this.pendingSubDirectories.get(op.subdirName);
                 if (pendingSubDirectoryMessageId === pendingMessageId) {
                     this.pendingSubDirectories.delete(op.subdirName);
                 }

package/src/interfaces.ts

@@ -144,9 +144,10 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
  * ```typescript
  * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
  * ```
- * - `path` -  The relative path to the key that is created.It is relative from the object which raises the event.
+ * - `path` -  The relative path to the subdirectory that is created.
+ *             It is relative from the object which raises the event.
  *
- * - `local` - Whether the clear originated from the this client.
+ * - `local` - Whether the create originated from the this client.
  *
  * - `target` - The ISharedDirectory itself.
  *
@@ -159,9 +160,10 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
  * ```typescript
  * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
  * ```
- * - `path` - The relative path to the key that is deleted.It is relative from the object which raises the event.
+ * - `path` - The relative path to the subdirectory that is deleted.
+ *            It is relative from the object which raises the event.
  *
- * - `local` - Whether the clear originated from the this client.
+ * - `local` - Whether the delete originated from the this client.
  *
  * - `target` - The ISharedDirectory itself.
  */
@@ -216,9 +218,10 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
  * ```typescript
  * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
  * ```
- * - `path` - The relative path to the key that is created. It is relative from the object which raises the event.
+ * - `path` - The relative path to the subdirectory that is created.
+ *            It is relative from the object which raises the event.
  *
- * - `local` - Whether the clear originated from the this client.
+ * - `local` - Whether the creation originated from the this client.
  *
  * - `target` - The ISharedDirectory itself.
  *
@@ -231,9 +234,10 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
  * ```typescript
  * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
  * ```
- * - `path` - The relative path to the key that is deleted. It is relative from the object which raises the event.
+ * - `path` - The relative path to the subdirectory that is deleted.
+ *            It is relative from the object which raises the event.
  *
- * - `local` - Whether the clear originated from the this client.
+ * - `local` - Whether the delete originated from the this client.
  *
  * - `target` - The ISharedDirectory itself.
  *
@@ -306,7 +310,6 @@ export interface IDirectoryValueChanged extends IValueChanged {
  * (
  *     changed: IValueChanged,
  *     local: boolean,
- *     op: ISequencedDocumentMessage | null,
  *     target: IEventThisPlaceHolder,
  * ) => void
  * ```
@@ -314,8 +317,6 @@ export interface IDirectoryValueChanged extends IValueChanged {
  *
  * - `local` - Whether the change originated from the this client.
  *
- * - `op` - The op that caused the change in value.
- *
  * - `target` - The map itself.
  *
  * ### "clear"
@@ -325,12 +326,10 @@ export interface IDirectoryValueChanged extends IValueChanged {
  * #### Listener signature
  *
  * ```typescript
- * (local: boolean, op: ISequencedDocumentMessage | null, target: IEventThisPlaceHolder) => void
+ * (local: boolean, target: IEventThisPlaceHolder) => void
  * ```
  * - `local` - Whether the clear originated from the this client.
  *
- * - `op` - The op that caused the clear.
- *
  * - `target` - The map itself.
  */
 export interface ISharedMapEvents extends ISharedObjectEvents {
@@ -340,8 +339,7 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
         target: IEventThisPlaceHolder) => void);
     (event: "clear", listener: (
         local: boolean,
-        target: IEventThisPlaceHolder
-    ) => void);
+        target: IEventThisPlaceHolder) => void);
 }
 
 /**

package/src/map.ts

@@ -11,7 +11,7 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import {
     IFluidSerializer,
@@ -144,7 +144,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
         runtime: IFluidDataStoreRuntime,
         attributes: IChannelAttributes,
     ) {
-        super(id, runtime, attributes);
+        super(id, runtime, attributes, "fluid_map_");
         this.kernel = new MapKernel(
             this.serializer,
             this.handle,
@@ -245,7 +245,10 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      * @internal
      */
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {
+    protected summarizeCore(
+        serializer: IFluidSerializer,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats {
         let currentSize = 0;
         let counter = 0;
         let headerBlob: IMapDataObjectSerializable = {};
@@ -365,4 +368,12 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
             this.kernel.tryProcessMessage(message.contents, local, localOpMetadata);
         }
     }
+
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
+     * @internal
+    */
+   protected rollback(content: any, localOpMetadata: unknown) {
+       this.kernel.rollback(content, localOpMetadata);
+   }
 }