@fluidframework/map 2.0.0-internal.2.2.0 → 2.0.0-internal.2.3.0

package/src/localValues.ts

@@ -28,6 +28,8 @@ export interface ILocalValue {
     /**
      * The in-memory value stored within.
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     readonly value: any;
 
     /**
@@ -42,13 +44,24 @@ export interface ILocalValue {
     ): ISerializedValue;
 }
 
+/**
+ * Converts the provided `localValue` to its serialized form.
+ *
+ * @param localValue - The value to serialize.
+ * @param serializer - Data store runtime's serializer.
+ * @param bind - Container type's handle.
+ *
+ * @see {@link ILocalValue.makeSerialized}
+ */
 export function makeSerializable(
     localValue: ILocalValue,
     serializer: IFluidSerializer,
-    bind: IFluidHandle): ISerializableValue {
+    bind: IFluidHandle,
+): ISerializableValue {
     const value = localValue.makeSerialized(serializer, bind);
     return {
         type: value.type,
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         value: value.value && JSON.parse(value.value),
     };
 }
@@ -61,8 +74,7 @@ export class PlainLocalValue implements ILocalValue {
      * Create a new PlainLocalValue.
      * @param value - The value to store, which may contain shared object handles
      */
-    constructor(public readonly value: any) {
-    }
+    public constructor(public readonly value: unknown) { }
 
     /**
      * {@inheritDoc ILocalValue."type"}
@@ -98,8 +110,7 @@ export class LocalValueMaker {
      * Create a new LocalValueMaker.
      * @param serializer - The serializer to serialize / parse handles.
      */
-    constructor(private readonly serializer: IFluidSerializer) {
-    }
+    public constructor(private readonly serializer: IFluidSerializer) { }
 
     /**
      * Create a new local value from an incoming serialized value.
@@ -116,7 +127,7 @@ export class LocalValueMaker {
             serializable.value = handle;
         }
 
-        const translatedValue = parseHandles(serializable.value, this.serializer);
+        const translatedValue: unknown = parseHandles(serializable.value, this.serializer);
 
         return new PlainLocalValue(translatedValue);
     }
@@ -126,7 +137,7 @@ export class LocalValueMaker {
      * @param value - The value to store
      * @returns An ILocalValue containing the value
      */
-    public fromInMemory(value: any): ILocalValue {
+    public fromInMemory(value: unknown): ILocalValue {
         return new PlainLocalValue(value);
     }
 }

package/src/map.ts

@@ -22,7 +22,7 @@ import {
     ISharedMap,
     ISharedMapEvents,
 } from "./interfaces";
-import { IMapDataObjectSerializable, MapKernel } from "./mapKernel";
+import { IMapDataObjectSerializable, IMapOperation, MapKernel } from "./mapKernel";
 import { pkgVersion } from "./packageVersion";
 
 interface IMapSerializationFormat {
@@ -55,14 +55,14 @@ export class MapFactory implements IChannelFactory {
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
      */
-    public get type() {
+    public get type(): string {
         return MapFactory.Type;
     }
 
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
      */
-    public get attributes() {
+    public get attributes(): IChannelAttributes {
         return MapFactory.Attributes;
     }
 
@@ -137,7 +137,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * @param runtime - Data store runtime.
      * @param attributes - The attributes for the map.
      */
-    constructor(
+    public constructor(
         id: string,
         runtime: IFluidDataStoreRuntime,
         attributes: IChannelAttributes,
@@ -164,6 +164,8 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * Get an iterator over the entries in this map.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public entries(): IterableIterator<[string, any]> {
         return this.kernel.entries();
     }
@@ -172,6 +174,8 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * Get an iterator over the values in this map.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public values(): IterableIterator<any> {
         return this.kernel.values();
     }
@@ -180,6 +184,8 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * Get an iterator over the entries in this map.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public [Symbol.iterator](): IterableIterator<[string, any]> {
         return this.kernel.entries();
     }
@@ -187,7 +193,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
     /**
      * The number of key/value pairs stored in the map.
      */
-    public get size() {
+    public get size(): number {
         return this.kernel.size;
     }
 
@@ -195,13 +201,18 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * Executes the given callback on each entry in the map.
      * @param callbackFn - Callback function
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void {
+        // eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
         this.kernel.forEach(callbackFn);
     }
 
     /**
      * {@inheritDoc ISharedMap.get}
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public get<T = any>(key: string): T | undefined {
         return this.kernel.get<T>(key);
     }
@@ -218,7 +229,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
     /**
      * {@inheritDoc ISharedMap.set}
      */
-    public set(key: string, value: any): this {
+    public set(key: string, value: unknown): this {
         this.kernel.set(key, value);
         return this;
     }
@@ -282,7 +293,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
                 const content: IMapDataObjectSerializable = {
                     [key]: {
                         type: value.type,
-                        value: JSON.parse(value.value),
+                        value: JSON.parse(value.value) as unknown,
                     },
                 };
                 builder.addBlob(blobName, JSON.stringify(content));
@@ -302,7 +313,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
                 }
                 headerBlob[key] = {
                     type: value.type,
-                    value: value.value === undefined ? undefined : JSON.parse(value.value),
+                    value: value.value === undefined ? undefined : JSON.parse(value.value) as unknown,
                 };
             }
         }
@@ -320,7 +331,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
      * @internal
      */
-    protected async loadCore(storage: IChannelStorageService) {
+    protected async loadCore(storage: IChannelStorageService): Promise<void> {
         const json = await readAndParse<object>(storage, snapshotFileName);
         const newFormat = json as IMapSerializationFormat;
         if (Array.isArray(newFormat.blobs)) {
@@ -338,31 +349,31 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
      * @internal
      */
-    protected onDisconnect() { }
+    protected onDisconnect(): void { }
 
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
      * @internal
      */
-    protected reSubmitCore(content: any, localOpMetadata: unknown) {
-        this.kernel.trySubmitMessage(content, localOpMetadata);
+    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void {
+        this.kernel.trySubmitMessage(content as IMapOperation, localOpMetadata);
     }
 
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      * @internal
      */
-    protected applyStashedOp(content: any): unknown {
-        return this.kernel.tryApplyStashedOp(content);
+    protected applyStashedOp(content: unknown): unknown {
+        return this.kernel.tryApplyStashedOp(content as IMapOperation);
     }
 
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
      * @internal
      */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void {
         if (message.type === MessageType.Operation) {
-            this.kernel.tryProcessMessage(message.contents, local, localOpMetadata);
+            this.kernel.tryProcessMessage(message.contents as IMapOperation, local, localOpMetadata);
         }
     }
 
@@ -370,7 +381,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
      * @internal
     */
-    protected rollback(content: any, localOpMetadata: unknown) {
+    protected rollback(content: unknown, localOpMetadata: unknown): void {
         this.kernel.rollback(content, localOpMetadata);
     }
 }

package/src/mapKernel.ts

@@ -84,6 +84,8 @@ export interface IMapDataObjectSerialized {
 type MapKeyLocalOpMetadata = IMapKeyEditLocalOpMetadata | IMapKeyAddLocalOpMetadata;
 type MapLocalOpMetadata = IMapClearLocalOpMetadata | MapKeyLocalOpMetadata;
 
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
+
 function isMapKeyLocalOpMetadata(metadata: any): metadata is MapKeyLocalOpMetadata {
     return metadata !== undefined && typeof metadata.pendingMessageId === "number" &&
         (metadata.type === "add" || metadata.type === "edit");
@@ -98,6 +100,8 @@ function isMapLocalOpMetadata(metadata: any): metadata is MapLocalOpMetadata {
         (metadata.type === "add" || metadata.type === "edit" || metadata.type === "clear");
 }
 
+/* eslint-enable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
+
 function createClearLocalOpMetadata(op: IMapClearOperation,
     pendingClearMessageId: number, previousMap?: Map<string, ILocalValue>): IMapClearLocalOpMetadata {
     const localMetadata: IMapClearLocalOpMetadata = {
@@ -165,10 +169,10 @@ export class MapKernel {
      * @param valueTypes - The value types to register
      * @param eventEmitter - The object that will emit map events
      */
-    constructor(
+    public constructor(
         private readonly serializer: IFluidSerializer,
         private readonly handle: IFluidHandle,
-        private readonly submitMessage: (op: any, localOpMetadata: unknown) => void,
+        private readonly submitMessage: (op: unknown, localOpMetadata: unknown) => void,
         private readonly isAttached: () => boolean,
         private readonly eventEmitter: TypedEventEmitter<ISharedMapEvents>,
     ) {
@@ -188,17 +192,19 @@ export class MapKernel {
      * Get an iterator over the entries in this map.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public entries(): IterableIterator<[string, any]> {
         const localEntriesIterator = this.data.entries();
         const iterator = {
-            next(): IteratorResult<[string, any]> {
+            next(): IteratorResult<[string, unknown]> {
                 const nextVal = localEntriesIterator.next();
                 return nextVal.done
                     ? { value: undefined, done: true }
                     // Unpack the stored value
                     : { value: [nextVal.value[0], nextVal.value[1].value], done: false };
             },
-            [Symbol.iterator]() {
+            [Symbol.iterator](): IterableIterator<[string, unknown]> {
                 return this;
             },
         };
@@ -209,17 +215,19 @@ export class MapKernel {
      * Get an iterator over the values in this map.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public values(): IterableIterator<any> {
         const localValuesIterator = this.data.values();
         const iterator = {
-            next(): IteratorResult<any> {
+            next(): IteratorResult<unknown> {
                 const nextVal = localValuesIterator.next();
                 return nextVal.done
                     ? { value: undefined, done: true }
                     // Unpack the stored value
-                    : { value: nextVal.value.value, done: false };
+                    : { value: nextVal.value.value as unknown, done: false };
             },
-            [Symbol.iterator]() {
+            [Symbol.iterator](): IterableIterator<unknown> {
                 return this;
             },
         };
@@ -230,6 +238,8 @@ export class MapKernel {
      * Get an iterator over the entries in this map.
      * @returns The iterator
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public [Symbol.iterator](): IterableIterator<[string, any]> {
         return this.entries();
     }
@@ -238,7 +248,8 @@ export class MapKernel {
      * Executes the given callback on each entry in the map.
      * @param callbackFn - Callback function
      */
-    public forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void {
+    public forEach(callbackFn: (value: unknown, key: string, map: Map<string, unknown>) => void): void {
+        // eslint-disable-next-line unicorn/no-array-for-each
         this.data.forEach((localValue, key, m) => {
             callbackFn(localValue.value, key, m);
         });
@@ -247,6 +258,8 @@ export class MapKernel {
     /**
      * {@inheritDoc ISharedMap.get}
      */
+    // TODO: Use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public get<T = any>(key: string): T | undefined {
         const localValue = this.data.get(key);
         return localValue === undefined ? undefined : localValue.value as T;
@@ -264,7 +277,7 @@ export class MapKernel {
     /**
      * {@inheritDoc ISharedMap.set}
      */
-    public set(key: string, value: any) {
+    public set(key: string, value: unknown): void {
         // 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");
@@ -347,17 +360,17 @@ export class MapKernel {
      */
     public getSerializedStorage(serializer: IFluidSerializer): IMapDataObjectSerialized {
         const serializableMapData: IMapDataObjectSerialized = {};
-        this.data.forEach((localValue, key) => {
+        for (const [key, localValue] of this.data.entries()) {
             serializableMapData[key] = localValue.makeSerialized(serializer, this.handle);
-        });
+        }
         return serializableMapData;
     }
 
     public getSerializableStorage(serializer: IFluidSerializer): IMapDataObjectSerializable {
         const serializableMapData: IMapDataObjectSerializable = {};
-        this.data.forEach((localValue, key) => {
+        for (const [key, localValue] of this.data.entries()) {
             serializableMapData[key] = makeSerializable(localValue, serializer, this.handle);
-        });
+        }
         return serializableMapData;
     }
 
@@ -392,21 +405,21 @@ export class MapKernel {
      * also sent if we are asked to resubmit the message.
      * @returns True if the operation was submitted, false otherwise.
      */
-    public trySubmitMessage(op: any, localOpMetadata: unknown): boolean {
+    public trySubmitMessage(op: IMapOperation, localOpMetadata: unknown): boolean {
         const handler = this.messageHandlers.get(op.type);
         if (handler === undefined) {
             return false;
         }
-        handler.submit(op as IMapOperation, localOpMetadata as MapLocalOpMetadata);
+        handler.submit(op, localOpMetadata as MapLocalOpMetadata);
         return true;
     }
 
-    public tryApplyStashedOp(op: any): unknown {
+    public tryApplyStashedOp(op: IMapOperation): unknown {
         const handler = this.messageHandlers.get(op.type);
         if (handler === undefined) {
             throw new Error("no apply stashed op handler");
         }
-        return handler.applyStashedOp(op as IMapOperation);
+        return handler.applyStashedOp(op);
     }
 
     /**
@@ -430,12 +443,15 @@ export class MapKernel {
         return true;
     }
 
+    /* eslint-disable @typescript-eslint/no-unsafe-member-access */
+
     /**
      * Rollback a local op
      * @param op - The operation to rollback
      * @param localOpMetadata - The local metadata associated with the op.
      */
-    public rollback(op: any, localOpMetadata: unknown) {
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    public rollback(op: any, localOpMetadata: unknown): void {
         if (!isMapLocalOpMetadata(localOpMetadata)) {
             throw new Error("Invalid localOpMetadata");
         }
@@ -444,9 +460,9 @@ export class MapKernel {
             if (localOpMetadata.previousMap === undefined) {
                 throw new Error("Cannot rollback without previous map");
             }
-            localOpMetadata.previousMap.forEach((localValue, key) => {
+            for (const [key, localValue] of localOpMetadata.previousMap.entries()) {
                 this.setCore(key, localValue, true);
-            });
+            }
 
             const lastPendingClearId = this.pendingClearMessageIds.pop();
             if (lastPendingClearId === undefined || lastPendingClearId !== localOpMetadata.pendingMessageId) {
@@ -454,26 +470,28 @@ export class MapKernel {
             }
         } else if (op.type === "delete" || op.type === "set") {
             if (localOpMetadata.type === "add") {
-                this.deleteCore(op.key, true);
+                this.deleteCore(op.key as string, true);
             } else if (localOpMetadata.type === "edit" && localOpMetadata.previousValue !== undefined) {
-                this.setCore(op.key, localOpMetadata.previousValue, true);
+                this.setCore(op.key as string, localOpMetadata.previousValue, true);
             } else {
                 throw new Error("Cannot rollback without previous value");
             }
 
-            const pendingMessageIds = this.pendingKeys.get(op.key);
+            const pendingMessageIds = this.pendingKeys.get(op.key as string);
             const lastPendingMessageId = pendingMessageIds?.pop();
             if (!pendingMessageIds || lastPendingMessageId !== localOpMetadata.pendingMessageId) {
                 throw new Error("Rollback op does not match last pending");
             }
             if (pendingMessageIds.length === 0) {
-                this.pendingKeys.delete(op.key);
+                this.pendingKeys.delete(op.key as string);
             }
         } else {
             throw new Error("Unsupported op for rollback");
         }
     }
 
+    /* eslint-enable @typescript-eslint/no-unsafe-member-access */
+
     /**
      * Set implementation used for both locally sourced sets as well as incoming remote sets.
      * @param key - The key being set
@@ -483,7 +501,7 @@ export class MapKernel {
      */
     private setCore(key: string, value: ILocalValue, local: boolean): ILocalValue | undefined {
         const previousLocalValue = this.data.get(key);
-        const previousValue = previousLocalValue?.value;
+        const previousValue: unknown = previousLocalValue?.value;
         this.data.set(key, value);
         this.eventEmitter.emit("valueChanged", { key, previousValue }, local, this.eventEmitter);
         return previousLocalValue;
@@ -506,7 +524,7 @@ export class MapKernel {
      */
     private deleteCore(key: string, local: boolean): ILocalValue | undefined {
         const previousLocalValue = this.data.get(key);
-        const previousValue = previousLocalValue?.value;
+        const previousValue: unknown = previousLocalValue?.value;
         const successfullyRemoved = this.data.delete(key);
         if (successfullyRemoved) {
             this.eventEmitter.emit("valueChanged", { key, previousValue }, local, this.eventEmitter);
@@ -521,14 +539,14 @@ export class MapKernel {
         // Assuming the pendingKeys is small and the map is large
         // we will get the value for the pendingKeys and clear the map
         const temp = new Map<string, ILocalValue>();
-        this.pendingKeys.forEach((value, key) => {
+        for (const key of this.pendingKeys.keys()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             temp.set(key, this.data.get(key)!);
-        });
+        }
         this.clearCore(false);
-        temp.forEach((value, key) => {
+        for (const [key, value] of temp.entries()) {
             this.setCore(key, value, true);
-        });
+        }
     }
 
     /**
@@ -599,7 +617,7 @@ export class MapKernel {
      * Get the message handlers for the map.
      * @returns A map of string op names to IMapMessageHandlers for those ops
      */
-    private getMessageHandlers() {
+    private getMessageHandlers(): Map<string, IMapMessageHandler> {
         const messageHandlers = new Map<string, IMapMessageHandler>();
         messageHandlers.set(
             "clear",
@@ -613,7 +631,7 @@ export class MapKernel {
                             0x2fb /* pendingMessageId does not match */);
                         return;
                     }
-                    if (this.pendingKeys.size !== 0) {
+                    if (this.pendingKeys.size > 0) {
                         this.clearExceptPendingKeys();
                         return;
                     }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-internal.2.2.0";
+export const pkgVersion = "2.0.0-internal.2.3.0";