@fluidframework/container-loader 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "1.4.0-121020",
+  "version": "2.0.0-dev-rc.1.0.0.225277",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,45 +11,122 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "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",
-    "eslint": "eslint --format stylish src",
-    "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",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc",
-    "tsc:watch": "tsc --watch",
-    "typetests:gen": "flub generate typetests --generate --dir . --no-generateInName",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./test/container": {
+      "import": {
+        "types": "./lib/container.d.mts",
+        "default": "./lib/container.mjs"
+      },
+      "require": {
+        "types": "./dist/container.d.ts",
+        "default": "./dist/container.cjs"
+      }
+    },
+    "./test/contracts": {
+      "import": {
+        "types": "./lib/contracts.d.mts",
+        "default": "./lib/contracts.mjs"
+      },
+      "require": {
+        "types": "./dist/contracts.d.ts",
+        "default": "./dist/contracts.cjs"
+      }
+    },
+    "./test/connectionManager": {
+      "import": {
+        "types": "./lib/connectionManager.d.mts",
+        "default": "./lib/connectionManager.mjs"
+      },
+      "require": {
+        "types": "./dist/connectionManager.d.ts",
+        "default": "./dist/connectionManager.cjs"
+      }
+    },
+    "./test/deltaManager": {
+      "import": {
+        "types": "./lib/deltaManager.d.mts",
+        "default": "./lib/deltaManager.mjs"
+      },
+      "require": {
+        "types": "./dist/deltaManager.d.ts",
+        "default": "./dist/deltaManager.cjs"
+      }
+    },
+    "./test/utils": {
+      "import": {
+        "types": "./lib/utils.d.mts",
+        "default": "./lib/utils.mjs"
+      },
+      "require": {
+        "types": "./dist/utils.d.ts",
+        "default": "./dist/utils.cjs"
+      }
+    },
+    "./alpha": {
+      "import": {
+        "types": "./lib/container-loader-alpha.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/container-loader-alpha.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./beta": {
+      "import": {
+        "types": "./lib/container-loader-beta.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/container-loader-beta.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/container-loader-public.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/container-loader-public.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
-  "nyc": {
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
+  "types": "dist/index.d.ts",
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
-      "src/test/**/*.ts",
-      "dist/test/**/*.js"
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
     ],
     "exclude-after-remap": false,
     "include": [
-      "src/**/*.ts",
-      "dist/**/*.js"
+      "src/**/*.*ts",
+      "dist/**/*.*js"
     ],
     "report-dir": "nyc/report",
     "reporter": [
@@ -60,52 +137,95 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "1.4.0-121020",
-    "@fluidframework/container-utils": "1.4.0-121020",
-    "@fluidframework/core-interfaces": "1.4.0-121020",
-    "@fluidframework/driver-definitions": "1.4.0-121020",
-    "@fluidframework/driver-utils": "1.4.0-121020",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/telemetry-utils": "1.4.0-121020",
-    "abort-controller": "^3.0.0",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/protocol-base": "^3.0.0-223236",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "debug": "^4.3.4",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
-    "lodash": "^4.17.21",
     "url": "^0.11.0",
-    "uuid": "^8.3.1"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@1.3.1",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "1.4.0-121020",
-    "@fluidframework/test-loader-utils": "1.4.0-121020",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-private/test-loader-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.8.0.0",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.225277",
+    "@microsoft/api-extractor": "^7.38.3",
+    "@types/debug": "^4.1.5",
     "@types/double-ended-queue": "^2.1.0",
-    "@types/lodash": "^4.14.118",
+    "@types/events": "^3.0.0",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
+    "@types/node": "^18.19.0",
     "@types/sinon": "^7.0.13",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
-    "cross-env": "^7.0.2",
-    "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
-    "rimraf": "^2.6.2",
+    "c8": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "~8.50.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "tsc-multi": "^1.1.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
   },
   "typeValidation": {
-    "version": "1.4.0",
-    "baselineRange": "~1.3.0",
-    "baselineVersion": "1.3.1",
     "broken": {}
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "fluid-build . --task api",
+    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
+    "build:genver": "gen-version",
+    "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "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",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc-multi --config ../../../common/build/build-common/tsc-multi.cjs.json",
+    "tsc:watch": "tsc --watch",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
-}
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/audience.ts

@@ -3,64 +3,74 @@
  * Licensed under the MIT License.
  */
 import { EventEmitter } from "events";
-import { IAudience } from "@fluidframework/container-definitions";
+import { assert } from "@fluidframework/core-utils";
+import { IAudienceOwner } from "@fluidframework/container-definitions";
 import { IClient } from "@fluidframework/protocol-definitions";
 
 /**
  * Audience represents all clients connected to the op stream.
  */
-export class Audience extends EventEmitter implements IAudience {
-    private readonly members = new Map<string, IClient>();
+export class Audience extends EventEmitter implements IAudienceOwner {
+	private readonly members = new Map<string, IClient>();
 
-    public on(event: "addMember" | "removeMember", listener: (clientId: string, client: IClient) => void): this;
-    public on(event: string, listener: (...args: any[]) => void): this {
-        return super.on(event, listener);
-    }
+	constructor() {
+		super();
+		// We are expecting this class to have many listeners, so we suppress noisy "MaxListenersExceededWarning" logging.
+		super.setMaxListeners(0);
+	}
 
-    /**
-     * Adds a new client to the audience
-     */
-    public addMember(clientId: string, details: IClient) {
-        this.members.set(clientId, details);
-        this.emit("addMember", clientId, details);
-    }
+	public on(
+		event: "addMember" | "removeMember",
+		listener: (clientId: string, client: IClient) => void,
+	): this;
+	public on(event: string, listener: (...args: any[]) => void): this {
+		return super.on(event, listener);
+	}
 
-    /**
-     * Removes a client from the audience. Only emits an event if a client is actually removed
-     * @returns if a client was removed from the audience
-     */
-    public removeMember(clientId: string): boolean {
-        const removedClient = this.members.get(clientId);
-        if (removedClient !== undefined) {
-            this.members.delete(clientId);
-            this.emit("removeMember", clientId, removedClient);
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Adds a new client to the audience
+	 */
+	public addMember(clientId: string, details: IClient) {
+		// Given that signal delivery is unreliable process, we might observe same client being added twice
+		// In such case we should see exactly same payload (IClient), and should not raise event twice!
+		if (this.members.has(clientId)) {
+			const client = this.members.get(clientId);
+			assert(
+				JSON.stringify(client) === JSON.stringify(details),
+				0x4b2 /* new client has different payload from existing one */,
+			);
+		} else {
+			this.members.set(clientId, details);
+			this.emit("addMember", clientId, details);
+		}
+	}
 
-    /**
-     * Retrieves all the members in the audience
-     */
-    public getMembers(): Map<string, IClient> {
-        return new Map(this.members);
-    }
+	/**
+	 * Removes a client from the audience. Only emits an event if a client is actually removed
+	 * @returns if a client was removed from the audience
+	 */
+	public removeMember(clientId: string): boolean {
+		const removedClient = this.members.get(clientId);
+		if (removedClient !== undefined) {
+			this.members.delete(clientId);
+			this.emit("removeMember", clientId, removedClient);
+			return true;
+		} else {
+			return false;
+		}
+	}
 
-    /**
-     * Retrieves a specific member of the audience
-     */
-    public getMember(clientId: string): IClient | undefined {
-        return this.members.get(clientId);
-    }
+	/**
+	 * Retrieves all the members in the audience
+	 */
+	public getMembers(): Map<string, IClient> {
+		return new Map(this.members);
+	}
 
-    /**
-     * Clears the audience
-     */
-    public clear(): void {
-        const clientIds = this.members.keys();
-        for (const clientId of clientIds) {
-            this.removeMember(clientId);
-        }
-    }
+	/**
+	 * Retrieves a specific member of the audience
+	 */
+	public getMember(clientId: string): IClient | undefined {
+		return this.members.get(clientId);
+	}
 }

package/src/catchUpMonitor.ts

@@ -0,0 +1,61 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { IDisposable } from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils";
+import { IDeltaManager } from "@fluidframework/container-definitions";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+
+/** @see CatchUpMonitor for usage */
+type CaughtUpListener = () => void;
+
+/** Monitor that emits an event when a Container has caught up to a given point in the op stream */
+export type ICatchUpMonitor = IDisposable;
+
+/**
+ * Monitors a Container's DeltaManager, notifying listeners when all ops have been processed
+ * that were known at the time the monitor was created.
+ */
+export class CatchUpMonitor implements ICatchUpMonitor {
+	private readonly targetSeqNumber: number;
+	private caughtUp: boolean = false;
+
+	private readonly opHandler = (message: Pick<ISequencedDocumentMessage, "sequenceNumber">) => {
+		if (!this.caughtUp && message.sequenceNumber >= this.targetSeqNumber) {
+			this.caughtUp = true;
+			this.listener();
+		}
+	};
+
+	/**
+	 * Create the CatchUpMonitor, setting the target sequence number to wait for based on DeltaManager's current state.
+	 */
+	constructor(
+		private readonly deltaManager: IDeltaManager<any, any>,
+		private readonly listener: CaughtUpListener,
+	) {
+		this.targetSeqNumber = this.deltaManager.lastKnownSeqNumber;
+
+		assert(
+			this.targetSeqNumber >= this.deltaManager.lastSequenceNumber,
+			0x37c /* Cannot wait for seqNumber below last processed sequence number */,
+		);
+
+		this.deltaManager.on("op", this.opHandler);
+
+		// Simulate the last processed op to set caughtUp in case we already are
+		this.opHandler({ sequenceNumber: this.deltaManager.lastSequenceNumber });
+	}
+
+	public disposed: boolean = false;
+	public dispose() {
+		if (this.disposed) {
+			return;
+		}
+		this.disposed = true;
+
+		this.deltaManager.off("op", this.opHandler);
+	}
+}