@fluidframework/map 2.0.0-dev.5.3.2.178189 → 2.0.0-dev.6.4.0.191457

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.0.0-dev.5.3.2.178189",
+  "version": "2.0.0-dev.6.4.0.191457",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,7 +14,7 @@
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
-  "nyc": {
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
@@ -35,34 +35,34 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-utils": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/core-interfaces": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/datastore-definitions": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/driver-utils": "2.0.0-dev.5.3.2.178189",
+    "@fluid-internal/client-utils": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/core-interfaces": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/core-utils": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/driver-utils": "2.0.0-dev.6.4.0.191457",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/runtime-utils": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/shared-object-base": "2.0.0-dev.5.3.2.178189",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/runtime-utils": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/shared-object-base": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.6.4.0.191457",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-internal/stochastic-test-utils": "2.0.0-dev.5.3.2.178189",
-    "@fluid-internal/test-dds-utils": "2.0.0-dev.5.3.2.178189",
+    "@fluid-internal/stochastic-test-utils": "2.0.0-dev.6.4.0.191457",
+    "@fluid-internal/test-dds-utils": "2.0.0-dev.6.4.0.191457",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.21.0",
-    "@fluidframework/build-common": "^1.2.0",
-    "@fluidframework/build-tools": "^0.21.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-internal.5.2.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev.5.3.2.178189",
+    "@fluid-tools/build-cli": "^0.22.0",
+    "@fluidframework/build-common": "^2.0.0",
+    "@fluidframework/build-tools": "^0.22.0",
+    "@fluidframework/eslint-config-fluid": "^2.1.0",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-internal.6.3.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.6.4.0.191457",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.38",
+    "@types/node": "^16.18.38",
     "@types/path-browserify": "^1.0.0",
-    "concurrently": "^7.6.0",
+    "c8": "^7.7.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
@@ -70,7 +70,6 @@
     "mocha-json-output-reporter": "^2.0.1",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
-    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
     "rimraf": "^4.4.0",
     "typescript": "~4.5.5"
@@ -87,7 +86,7 @@
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "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",
+    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp' 'nyc'",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
@@ -96,11 +95,10 @@
     "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:coverage": "c8 npm test",
     "test:memory": "mocha --config ./src/test/memory/.mocharc.js",
     "test:memory-profiling:report": "mocha --config ./src/test/memory/.mocharc.js",
-    "test:mocha": "mocha --unhandled-rejections=strict --recursive 'dist/test/mocha/**/*.spec.js' -r node_modules/@fluidframework/mocha-test-setup --exit",
-    "test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
+    "test:mocha": "mocha --recursive 'dist/test/mocha/**/*.spec.js' -r node_modules/@fluidframework/mocha-test-setup --exit",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "typetests:gen": "fluid-type-test-generator",

package/src/directory.ts

@@ -3,8 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
-import { UsageError } from "@fluidframework/container-utils";
+import { assert } from "@fluidframework/core-utils";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { UsageError } from "@fluidframework/telemetry-utils";
 import { readAndParse } from "@fluidframework/driver-utils";
 import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import {
@@ -22,6 +23,7 @@ import {
 	IDirectory,
 	IDirectoryEvents,
 	IDirectoryValueChanged,
+	// eslint-disable-next-line import/no-deprecated
 	ISerializableValue,
 	ISerializedValue,
 	ISharedDirectory,
@@ -88,6 +90,7 @@ export interface IDirectorySetOperation {
 	/**
 	 * Value to be set on the key.
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	value: ISerializableValue;
 }
 
@@ -215,6 +218,7 @@ export interface IDirectoryDataObject {
 	/**
 	 * Key/value date set by the user.
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	storage?: { [key: string]: ISerializableValue };
 
 	/**
@@ -313,6 +317,7 @@ export class DirectoryFactory implements IChannelFactory {
  * {@inheritDoc ISharedDirectory}
  *
  * @example
+ *
  * ```typescript
  * mySharedDirectory.createSubDirectory("a").createSubDirectory("b").createSubDirectory("c").set("foo", val1);
  * const mySubDir = mySharedDirectory.getWorkingDirectory("/a/b/c");
@@ -735,6 +740,7 @@ export class SharedDirectory
 	private makeLocal(
 		key: string,
 		absolutePath: string,
+		// eslint-disable-next-line import/no-deprecated
 		serializable: ISerializableValue,
 	): ILocalValue {
 		assert(
@@ -748,7 +754,7 @@ export class SharedDirectory
 	/**
 	 * This checks if there is pending delete op for local delete for a any subdir in the relative path.
 	 * @param relativePath - path of sub directory.
-	 * @returns - true if there is pending delete.
+	 * @returns `true` if there is pending delete, `false` otherwise.
 	 */
 	private isSubDirectoryDeletePending(relativePath: string): boolean {
 		const absolutePath = this.makeAbsolute(relativePath);
@@ -960,6 +966,7 @@ export class SharedDirectory
 				if (!currentSubDirObject.storage) {
 					currentSubDirObject.storage = {};
 				}
+				// eslint-disable-next-line import/no-deprecated
 				const result: ISerializableValue = {
 					type: value.type,
 					value: value.value && (JSON.parse(value.value) as object),
@@ -1250,7 +1257,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		const isNew = this.createSubDirectoryCore(
 			subdirName,
 			true,
-			-1,
+			this.getLocalSeq(),
 			this.runtime.clientId ?? "detached",
 		);
 		const subDir = this._subdirectories.get(subdirName);
@@ -1274,6 +1281,17 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		return subDir;
 	}
 
+	/**
+	 * @returns A sequenceNumber which should be used for local changes.
+	 * @remarks While detached, 0 is used rather than -1 to represent a change which should be universally known (as opposed to known
+	 * only by the local client). This ensures that if the directory is later attached, none of its data needs to be updated (the values
+	 * last set while detached will now be known to any new client, until they are changed).
+	 * TODO: Convert these conventions to named constants. The semantics used here match those for merge-tree.
+	 */
+	private getLocalSeq(): number {
+		return this.directory.isAttached() ? -1 : 0;
+	}
+
 	/**
 	 * {@inheritDoc IDirectory.getSubDirectory}
 	 */
@@ -1335,7 +1353,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 	/**
 	 * This checks if there is pending delete op for local delete for a given child subdirectory.
 	 * @param subDirName - directory name.
-	 * @returns - true if there is pending delete.
+	 * @returns true if there is pending delete.
 	 */
 	public isSubDirectoryDeletePending(subDirName: string): boolean {
 		if (this.pendingDeleteSubDirectoriesTracker.has(subDirName)) {
@@ -1661,7 +1679,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 	): ICreateSubDirLocalOpMetadata {
 		this.throwIfDisposed();
 		// Create the sub directory locally first.
-		this.createSubDirectoryCore(op.subdirName, true, -1, this.runtime.clientId ?? "detached");
+		this.createSubDirectoryCore(
+			op.subdirName,
+			true,
+			this.getLocalSeq(),
+			this.runtime.clientId ?? "detached",
+		);
 		this.updatePendingSubDirMessageCount(op);
 
 		const localOpMetadata: ICreateSubDirLocalOpMetadata = {
@@ -2232,7 +2255,8 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 			if (op.type === "createSubDirectory") {
 				const dir = this._subdirectories.get(op.subdirName);
 				// Child sub directory create seq number can't be lower than the parent subdirectory.
-				if (this.sequenceNumber !== -1 && this.sequenceNumber < msg.sequenceNumber) {
+				// The sequence number for multiple ops can be the same when multiple createSubDirectory occurs with grouped batching enabled, thus <= and not just <.
+				if (this.sequenceNumber !== -1 && this.sequenceNumber <= msg.sequenceNumber) {
 					if (dir?.sequenceNumber === -1) {
 						// Only set the seq on the first message, could be more
 						dir.sequenceNumber = msg.sequenceNumber;
@@ -2328,7 +2352,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 	 * @param local - Whether the message originated from the local client
 	 * @param seq - Sequence number at which this directory is created
 	 * @param clientId - Id of client which created this directory.
-	 * @returns - True if is newly created, false if it already existed.
+	 * @returns True if is newly created, false if it already existed.
 	 */
 	private createSubDirectoryCore(
 		subdirName: string,

package/src/interfaces.ts

@@ -4,8 +4,12 @@
  */
 
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
-import { IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/common-definitions";
-import { IDisposable } from "@fluidframework/core-interfaces";
+import {
+	IDisposable,
+	IEvent,
+	IEventProvider,
+	IEventThisPlaceHolder,
+} from "@fluidframework/core-interfaces";
 
 /**
  * Type of "valueChanged" event parameter.

package/src/internalInterfaces.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+// eslint-disable-next-line import/no-deprecated
 import { ISerializableValue } from "./interfaces";
 import { ILocalValue } from "./localValues";
 
@@ -23,6 +24,7 @@ export interface IMapSetOperation {
 	/**
 	 * Value to be set on the key.
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	value: ISerializableValue;
 }
 

package/src/localValues.ts

@@ -11,6 +11,7 @@ import {
 	serializeHandles,
 	ValueType,
 } from "@fluidframework/shared-object-base";
+// eslint-disable-next-line import/no-deprecated
 import { ISerializableValue, ISerializedValue } from "./interfaces";
 
 /**
@@ -51,6 +52,7 @@ export function makeSerializable(
 	localValue: ILocalValue,
 	serializer: IFluidSerializer,
 	bind: IFluidHandle,
+	// eslint-disable-next-line import/no-deprecated
 ): ISerializableValue {
 	const value = localValue.makeSerialized(serializer, bind);
 	return {
@@ -107,6 +109,7 @@ export class LocalValueMaker {
 	 * Create a new local value from an incoming serialized value.
 	 * @param serializable - The serializable value to make local
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	public fromSerializable(serializable: ISerializableValue): ILocalValue {
 		// Migrate from old shared value to handles
 		if (serializable.type === ValueType[ValueType.Shared]) {

package/src/mapKernel.ts

@@ -5,7 +5,9 @@
 
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { IFluidSerializer, ValueType } from "@fluidframework/shared-object-base";
-import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+// eslint-disable-next-line import/no-deprecated
 import { ISerializableValue, ISerializedValue, ISharedMapEvents } from "./interfaces";
 import {
 	IMapSetOperation,
@@ -59,6 +61,7 @@ export type IMapOperation = IMapKeyOperation | IMapClearOperation;
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
  */
 export interface IMapDataObjectSerializable {
+	// eslint-disable-next-line import/no-deprecated
 	[key: string]: ISerializableValue;
 }
 
@@ -572,6 +575,7 @@ export class MapKernel {
 	 * @param serializable - The remote information that we can convert into a real object
 	 * @returns The local value that was produced
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	private makeLocal(key: string, serializable: ISerializableValue): ILocalValue {
 		if (
 			serializable.type === ValueType[ValueType.Plain] ||

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-dev.5.3.2.178189";
+export const pkgVersion = "2.0.0-dev.6.4.0.191457";