@fluidframework/map 0.52.0-44610 → 0.53.0

package/src/directory.ts

@@ -52,14 +52,12 @@ interface IDirectoryMessageHandler {
      * Apply the given operation.
      * @param op - The directory operation to apply
      * @param local - Whether the message originated from the local client
-     * @param message - The full message
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      */
     process(
         op: IDirectoryOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): void;
 
@@ -687,7 +685,7 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
             const op: IDirectoryOperation = message.contents as IDirectoryOperation;
             const handler = this.messageHandlers.get(op.type);
             assert(handler !== undefined, 0x00e /* `Missing message handler for message type: ${message.type}` */);
-            handler.process(op, local, message, localOpMetadata);
+            handler.process(op, local, localOpMetadata);
         }
     }
 
@@ -728,10 +726,10 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         this.messageHandlers.set(
             "clear",
             {
-                process: (op: IDirectoryClearOperation, local, message, localOpMetadata) => {
+                process: (op: IDirectoryClearOperation, local, localOpMetadata) => {
                     const subdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
                     if (subdir) {
-                        subdir.processClearMessage(op, local, message, localOpMetadata);
+                        subdir.processClearMessage(op, local, localOpMetadata);
                     }
                 },
                 submit: (op: IDirectoryClearOperation, localOpMetadata: unknown) => {
@@ -746,10 +744,10 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         this.messageHandlers.set(
             "delete",
             {
-                process: (op: IDirectoryDeleteOperation, local, message, localOpMetadata) => {
+                process: (op: IDirectoryDeleteOperation, local, localOpMetadata) => {
                     const subdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
                     if (subdir) {
-                        subdir.processDeleteMessage(op, local, message, localOpMetadata);
+                        subdir.processDeleteMessage(op, local, localOpMetadata);
                     }
                 },
                 submit: (op: IDirectoryDeleteOperation, localOpMetadata: unknown) => {
@@ -764,11 +762,11 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         this.messageHandlers.set(
             "set",
             {
-                process: (op: IDirectorySetOperation, local, message, localOpMetadata) => {
+                process: (op: IDirectorySetOperation, local, localOpMetadata) => {
                     const subdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
                     if (subdir) {
                         const context = local ? undefined : this.makeLocal(op.key, op.path, op.value);
-                        subdir.processSetMessage(op, context, local, message, localOpMetadata);
+                        subdir.processSetMessage(op, context, local, localOpMetadata);
                     }
                 },
                 submit: (op: IDirectorySetOperation, localOpMetadata: unknown) => {
@@ -784,10 +782,10 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         this.messageHandlers.set(
             "createSubDirectory",
             {
-                process: (op: IDirectoryCreateSubDirectoryOperation, local, message, localOpMetadata) => {
+                process: (op: IDirectoryCreateSubDirectoryOperation, local, localOpMetadata) => {
                     const parentSubdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
                     if (parentSubdir) {
-                        parentSubdir.processCreateSubDirectoryMessage(op, local, message, localOpMetadata);
+                        parentSubdir.processCreateSubDirectoryMessage(op, local, localOpMetadata);
                     }
                 },
                 submit: (op: IDirectoryCreateSubDirectoryOperation, localOpMetadata: unknown) => {
@@ -803,10 +801,10 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
         this.messageHandlers.set(
             "deleteSubDirectory",
             {
-                process: (op: IDirectoryDeleteSubDirectoryOperation, local, message, localOpMetadata) => {
+                process: (op: IDirectoryDeleteSubDirectoryOperation, local, localOpMetadata) => {
                     const parentSubdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
                     if (parentSubdir) {
-                        parentSubdir.processDeleteSubDirectoryMessage(op, local, message, localOpMetadata);
+                        parentSubdir.processDeleteSubDirectoryMessage(op, local, localOpMetadata);
                     }
                 },
                 submit: (op: IDirectoryDeleteSubDirectoryOperation, localOpMetadata: unknown) => {
@@ -946,7 +944,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
             key,
             localValue,
             true,
-            null,
         );
 
         // If we are not attached, don't submit the op.
@@ -978,7 +975,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         }
 
         // Create the sub directory locally first.
-        this.createSubDirectoryCore(subdirName, true, null);
+        this.createSubDirectoryCore(subdirName, true);
 
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         const subDir: IDirectory = this._subdirectories.get(subdirName)!;
@@ -1017,7 +1014,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      */
     public deleteSubDirectory(subdirName: string): boolean {
         // Delete the sub directory locally first.
-        const successfullyRemoved = this.deleteSubDirectoryCore(subdirName, true, null);
+        const successfullyRemoved = this.deleteSubDirectoryCore(subdirName, true);
 
         // If we are not attached, don't submit the op.
         if (!this.directory.isAttached()) {
@@ -1055,7 +1052,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      */
     public delete(key: string): boolean {
         // Delete the key locally first.
-        const successfullyRemoved = this.deleteCore(key, true, null);
+        const successfullyRemoved = this.deleteCore(key, true);
 
         // If we are not attached, don't submit the op.
         if (!this.directory.isAttached()) {
@@ -1077,7 +1074,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      */
     public clear(): void {
         // Clear the data locally first.
-        this.clearCore(true, null);
+        this.clearCore(true);
 
         // If we are not attached, don't submit the op.
         if (!this.directory.isAttached()) {
@@ -1182,7 +1179,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     public processClearMessage(
         op: IDirectoryClearOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): void {
         if (local) {
@@ -1195,7 +1191,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
             return;
         }
         this.clearExceptPendingKeys();
-        this.directory.emit("clear", local, op, this.directory);
+        this.directory.emit("clear", local, this.directory);
     }
 
     /**
@@ -1210,13 +1206,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     public processDeleteMessage(
         op: IDirectoryDeleteOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): void {
-        if (!this.needProcessStorageOperation(op, local, message, localOpMetadata)) {
+        if (!this.needProcessStorageOperation(op, local, localOpMetadata)) {
             return;
         }
-        this.deleteCore(op.key, local, message);
+        this.deleteCore(op.key, local);
     }
 
     /**
@@ -1232,10 +1227,9 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         op: IDirectorySetOperation,
         context: ILocalValue | undefined,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): void {
-        if (!this.needProcessStorageOperation(op, local, message, localOpMetadata)) {
+        if (!this.needProcessStorageOperation(op, local, localOpMetadata)) {
             return;
         }
 
@@ -1243,7 +1237,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         // so we can assume context is not undefined
 
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        this.setCore(op.key, context!, local, message);
+        this.setCore(op.key, context!, local);
     }
 
     /**
@@ -1258,13 +1252,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     public processCreateSubDirectoryMessage(
         op: IDirectoryCreateSubDirectoryOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): void {
-        if (!this.needProcessSubDirectoryOperations(op, local, message, localOpMetadata)) {
+        if (!this.needProcessSubDirectoryOperations(op, local, localOpMetadata)) {
             return;
         }
-        this.createSubDirectoryCore(op.subdirName, local, message);
+        this.createSubDirectoryCore(op.subdirName, local);
     }
 
     /**
@@ -1279,13 +1272,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     public processDeleteSubDirectoryMessage(
         op: IDirectoryDeleteSubDirectoryOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): void {
-        if (!this.needProcessSubDirectoryOperations(op, local, message, localOpMetadata)) {
+        if (!this.needProcessSubDirectoryOperations(op, local, localOpMetadata)) {
             return;
         }
-        this.deleteSubDirectoryCore(op.subdirName, local, message);
+        this.deleteSubDirectoryCore(op.subdirName, local);
     }
 
     /**
@@ -1388,7 +1380,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     private needProcessStorageOperation(
         op: IDirectoryKeyOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): boolean {
         if (this.pendingClearMessageId !== -1) {
@@ -1432,7 +1423,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     private needProcessSubDirectoryOperations(
         op: IDirectorySubDirectoryOperation,
         local: boolean,
-        message: ISequencedDocumentMessage,
         localOpMetadata: unknown,
     ): boolean {
         if (this.pendingSubDirectories.has(op.subdirName)) {
@@ -1473,9 +1463,9 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @param local - Whether the message originated from the local client
      * @param op - The message if from a remote clear, or null if from a local clear
      */
-    private clearCore(local: boolean, op: ISequencedDocumentMessage | null) {
+    private clearCore(local: boolean) {
         this._storage.clear();
-        this.directory.emit("clear", local, op, this.directory);
+        this.directory.emit("clear", local, this.directory);
     }
 
     /**
@@ -1485,12 +1475,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @param op - The message if from a remote delete, or null if from a local delete
      * @returns True if the key existed and was deleted, false if it did not exist
      */
-    private deleteCore(key: string, local: boolean, op: ISequencedDocumentMessage | null) {
+    private deleteCore(key: string, local: boolean) {
         const previousValue = this.get(key);
         const successfullyRemoved = this._storage.delete(key);
         if (successfullyRemoved) {
             const event: IDirectoryValueChanged = { key, path: this.absolutePath, previousValue };
-            this.directory.emit("valueChanged", event, local, op, this.directory);
+            this.directory.emit("valueChanged", event, local, this.directory);
             const containedEvent: IValueChanged = { key, previousValue };
             this.emit("containedValueChanged", containedEvent, local, this);
         }
@@ -1504,11 +1494,11 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @param local - Whether the message originated from the local client
      * @param op - The message if from a remote set, or null if from a local set
      */
-    private setCore(key: string, value: ILocalValue, local: boolean, op: ISequencedDocumentMessage | null) {
+    private setCore(key: string, value: ILocalValue, local: boolean) {
         const previousValue = this.get(key);
         this._storage.set(key, value);
         const event: IDirectoryValueChanged = { key, path: this.absolutePath, previousValue };
-        this.directory.emit("valueChanged", event, local, op, this.directory);
+        this.directory.emit("valueChanged", event, local, this.directory);
         const containedEvent: IValueChanged = { key, previousValue };
         this.emit("containedValueChanged", containedEvent, local, this);
     }
@@ -1517,9 +1507,8 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Create subdirectory implementation used for both locally sourced creation as well as incoming remote creation.
      * @param subdirName - The name of the subdirectory being created
      * @param local - Whether the message originated from the local client
-     * @param op - The message if from a remote create, or null if from a local create
      */
-    private createSubDirectoryCore(subdirName: string, local: boolean, op: ISequencedDocumentMessage | null) {
+    private createSubDirectoryCore(subdirName: string, local: boolean) {
         if (!this._subdirectories.has(subdirName)) {
             this._subdirectories.set(
                 subdirName,
@@ -1538,7 +1527,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @param local - Whether the message originated from the local client
      * @param op - The message if from a remote delete, or null if from a local delete
      */
-    private deleteSubDirectoryCore(subdirName: string, local: boolean, op: ISequencedDocumentMessage | null) {
+    private deleteSubDirectoryCore(subdirName: string, local: boolean) {
         // 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);

package/src/interfaces.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 import { IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/common-definitions";
 
@@ -146,12 +145,10 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
     (event: "valueChanged", listener: (
         changed: IDirectoryValueChanged,
         local: boolean,
-        op: ISequencedDocumentMessage | null,
         target: IEventThisPlaceHolder,
     ) => void);
     (event: "clear", listener: (
         local: boolean,
-        op: ISequencedDocumentMessage | null,
         target: IEventThisPlaceHolder,
     ) => void);
 }
@@ -249,11 +246,9 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
     (event: "valueChanged", listener: (
         changed: IValueChanged,
         local: boolean,
-        op: ISequencedDocumentMessage | null,
         target: IEventThisPlaceHolder) => void);
     (event: "clear", listener: (
         local: boolean,
-        op: ISequencedDocumentMessage | null,
         target: IEventThisPlaceHolder
     ) => void);
 }

package/src/map.ts

@@ -364,7 +364,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * @internal
      */
     protected applyStashedOp(content: any): unknown {
-        this.kernel.tryProcessMessage(content, false, undefined, undefined);
+        this.kernel.tryProcessMessage(content, false, undefined);
         return this.kernel.tryGetStashedOpLocalMetadata(content);
     }
 
@@ -374,7 +374,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      */
     protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {
         if (message.type === MessageType.Operation) {
-            this.kernel.tryProcessMessage(message.contents, local, message, localOpMetadata);
+            this.kernel.tryProcessMessage(message.contents, local, localOpMetadata);
         }
     }
 

package/src/mapKernel.ts

@@ -4,7 +4,6 @@
  */
 
 import { IFluidHandle, IFluidSerializer } from "@fluidframework/core-interfaces";
-import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { ValueType } from "@fluidframework/shared-object-base";
 import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
 import {
@@ -27,14 +26,12 @@ interface IMapMessageHandler {
      * Apply the given operation.
      * @param op - The map operation to apply
      * @param local - Whether the message originated from the local client
-     * @param message - The full message. Not provided for stashed ops.
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      */
     process(
         op: IMapOperation,
         local: boolean,
-        message: ISequencedDocumentMessage | undefined,
         localOpMetadata: unknown,
     ): void;
 
@@ -317,7 +314,6 @@ export class MapKernel {
             key,
             localValue,
             true,
-            undefined,
         );
 
         // If we are not attached, don't submit the op.
@@ -340,7 +336,7 @@ export class MapKernel {
      */
     public delete(key: string): boolean {
         // Delete the key locally first.
-        const successfullyRemoved = this.deleteCore(key, true, undefined);
+        const successfullyRemoved = this.deleteCore(key, true);
 
         // If we are not attached, don't submit the op.
         if (!this.isAttached()) {
@@ -361,7 +357,7 @@ export class MapKernel {
      */
     public clear(): void {
         // Clear the data locally first.
-        this.clearCore(true, undefined);
+        this.clearCore(true);
 
         // If we are not attached, don't submit the op.
         if (!this.isAttached()) {
@@ -456,14 +452,13 @@ export class MapKernel {
     public tryProcessMessage(
         op: IMapOperation,
         local: boolean,
-        message: ISequencedDocumentMessage | undefined,
         localOpMetadata: unknown,
     ): boolean {
         if (this.messageHandlers.has(op.type)) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this.messageHandlers
                 .get(op.type)!
-                .process(op, local, message, localOpMetadata);
+                .process(op, local, localOpMetadata);
             return true;
         }
         return false;
@@ -476,11 +471,11 @@ export class MapKernel {
      * @param local - Whether the message originated from the local client
      * @param op - The message if from a remote set, or null if from a local set
      */
-    private setCore(key: string, value: ILocalValue, local: boolean, op: ISequencedDocumentMessage | undefined): void {
+    private setCore(key: string, value: ILocalValue, local: boolean): void {
         const previousValue = this.get(key);
         this.data.set(key, value);
         const event: IValueChanged = { key, previousValue };
-        this.eventEmitter.emit("valueChanged", event, local, op, this.eventEmitter);
+        this.eventEmitter.emit("valueChanged", event, local, this.eventEmitter);
     }
 
     /**
@@ -488,9 +483,9 @@ export class MapKernel {
      * @param local - Whether the message originated from the local client
      * @param op - The message if from a remote clear, or null if from a local clear
      */
-    private clearCore(local: boolean, op: ISequencedDocumentMessage | undefined): void {
+    private clearCore(local: boolean): void {
         this.data.clear();
-        this.eventEmitter.emit("clear", local, op, this.eventEmitter);
+        this.eventEmitter.emit("clear", local, this.eventEmitter);
     }
 
     /**
@@ -500,12 +495,12 @@ export class MapKernel {
      * @param op - The message if from a remote delete, or null if from a local delete
      * @returns True if the key existed and was deleted, false if it did not exist
      */
-    private deleteCore(key: string, local: boolean, op: ISequencedDocumentMessage | undefined): boolean {
+    private deleteCore(key: string, local: boolean): boolean {
         const previousValue = this.get(key);
         const successfullyRemoved = this.data.delete(key);
         if (successfullyRemoved) {
             const event: IValueChanged = { key, previousValue };
-            this.eventEmitter.emit("valueChanged", event, local, op, this.eventEmitter);
+            this.eventEmitter.emit("valueChanged", event, local, this.eventEmitter);
         }
         return successfullyRemoved;
     }
@@ -597,7 +592,7 @@ export class MapKernel {
         messageHandlers.set(
             "clear",
             {
-                process: (op: IMapClearOperation, local, message, localOpMetadata) => {
+                process: (op: IMapClearOperation, local, localOpMetadata) => {
                     if (local) {
                         assert(localOpMetadata !== undefined,
                             0x015 /* "pendingMessageId is missing from the local client's clear operation" */);
@@ -611,7 +606,7 @@ export class MapKernel {
                         this.clearExceptPendingKeys();
                         return;
                     }
-                    this.clearCore(local, message);
+                    this.clearCore(local);
                 },
                 submit: (op: IMapClearOperation, localOpMetadata: unknown) => {
                     // We don't reuse the metadata but send a new one on each submit.
@@ -625,11 +620,11 @@ export class MapKernel {
         messageHandlers.set(
             "delete",
             {
-                process: (op: IMapDeleteOperation, local, message, localOpMetadata) => {
+                process: (op: IMapDeleteOperation, local, localOpMetadata) => {
                     if (!this.needProcessKeyOperation(op, local, localOpMetadata)) {
                         return;
                     }
-                    this.deleteCore(op.key, local, message);
+                    this.deleteCore(op.key, local);
                 },
                 submit: (op: IMapDeleteOperation, localOpMetadata: unknown) => {
                     // We don't reuse the metadata but send a new one on each submit.
@@ -643,14 +638,14 @@ export class MapKernel {
         messageHandlers.set(
             "set",
             {
-                process: (op: IMapSetOperation, local, message, localOpMetadata) => {
+                process: (op: IMapSetOperation, local, localOpMetadata) => {
                     if (!this.needProcessKeyOperation(op, local, localOpMetadata)) {
                         return;
                     }
 
                     // needProcessKeyOperation should have returned false if local is true
                     const context = this.makeLocal(op.key, op.value);
-                    this.setCore(op.key, context, local, message);
+                    this.setCore(op.key, context, local);
                 },
                 submit: (op: IMapSetOperation, localOpMetadata: unknown) => {
                     // We don't reuse the metadata but send a new one on each submit.

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "0.52.0-44610";
+export const pkgVersion = "0.53.0";