@fluidframework/container-runtime 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "1.4.0-121020",
+  "version": "2.0.0-dev-rc.1.0.0.224419",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,45 +11,86 @@
   "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/doc-models/* ../../../_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": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs"
+    },
+    "./test/containerRuntime": {
+      "import": {
+        "types": "./lib/containerRuntime.d.mts",
+        "default": "./lib/containerRuntime.mjs"
+      },
+      "require": {
+        "types": "./dist/containerRuntime.d.ts",
+        "default": "./dist/containerRuntime.cjs"
+      }
+    },
+    "./test/deltaScheduler": {
+      "import": {
+        "types": "./lib/deltaScheduler.d.mts",
+        "default": "./lib/deltaScheduler.mjs"
+      },
+      "require": {
+        "types": "./dist/deltaScheduler.d.ts",
+        "default": "./dist/deltaScheduler.cjs"
+      }
+    },
+    "./test/scheduleManager": {
+      "import": {
+        "types": "./lib/scheduleManager.d.mts",
+        "default": "./lib/scheduleManager.mjs"
+      },
+      "require": {
+        "types": "./dist/scheduleManager.d.ts",
+        "default": "./dist/scheduleManager.cjs"
+      }
+    },
+    "./test/blobManager": {
+      "import": {
+        "types": "./lib/blobManager.d.mts",
+        "default": "./lib/blobManager.mjs"
+      },
+      "require": {
+        "types": "./dist/blobManager.d.ts",
+        "default": "./dist/blobManager.cjs"
+      }
+    },
+    "./test/summary": {
+      "import": {
+        "types": "./lib/summary/index.d.mts",
+        "default": "./lib/summary/index.mjs"
+      },
+      "require": {
+        "types": "./dist/summary/index.d.ts",
+        "default": "./dist/summary/index.cjs"
+      }
+    },
+    "./test/gc": {
+      "import": {
+        "types": "./lib/gc/index.d.mts",
+        "default": "./lib/gc/index.mjs"
+      },
+      "require": {
+        "types": "./gc/index.d.ts",
+        "default": "./gc/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,54 +101,114 @@
     "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-runtime-definitions": "1.4.0-121020",
-    "@fluidframework/container-utils": "1.4.0-121020",
-    "@fluidframework/core-interfaces": "1.4.0-121020",
-    "@fluidframework/datastore": "1.4.0-121020",
-    "@fluidframework/driver-definitions": "1.4.0-121020",
-    "@fluidframework/driver-utils": "1.4.0-121020",
-    "@fluidframework/garbage-collector": "1.4.0-121020",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "1.4.0-121020",
-    "@fluidframework/runtime-utils": "1.4.0-121020",
-    "@fluidframework/telemetry-utils": "1.4.0-121020",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/datastore": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/id-compressor": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/runtime-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.224419",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
-    "uuid": "^8.3.1"
+    "lz4js": "^0.2.0",
+    "sorted-btree": "^1.8.0",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@1.3.1",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "1.4.0-121020",
-    "@fluidframework/test-runtime-utils": "1.4.0-121020",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluid-tools/benchmark": "^0.48.0",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.0.0-internal.7.2.0",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@microsoft/api-extractor": "^7.38.3",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",
     "@types/mocha": "^9.1.1",
     "@types/sinon": "^7.0.13",
-    "@types/uuid": "^8.3.0",
-    "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",
+    "@types/uuid": "^9.0.2",
+    "c8": "^7.7.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",
+    "renamer": "^4.0.0",
+    "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": {}
+    "broken": {
+      "ClassDeclaration_ContainerRuntime": {
+        "backCompat": false
+      },
+      "RemovedFunctionDeclaration_TEST_requestSummarizer": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IGCStats": {
+        "forwardCompat": false
+      }
+    }
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
+    "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:rename-types": "renamer \"lib/**\" -f .d.ts -r .d.mts --force",
+    "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:benchmark:report": "mocha --timeout 999999 --perfMode --parentProcess --fgrep @Benchmark --reporter @fluid-tools/benchmark/dist/MochaReporter.js \"./dist/**/*.perf.spec.*js\"",
+    "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/batchTracker.ts

@@ -4,77 +4,82 @@
  */
 
 import { EventEmitter } from "events";
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { assert, performance } from "@fluidframework/common-utils";
+import { ITelemetryLoggerExt, createChildLogger } from "@fluidframework/telemetry-utils";
+import { assert } from "@fluidframework/core-utils";
+import { performance } from "@fluid-internal/client-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { ChildLogger } from "@fluidframework/telemetry-utils";
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 
 export class BatchTracker {
-    private readonly logger: ITelemetryLogger;
-    private startBatchSequenceNumber: number | undefined;
-    private trackedBatchCount: number = 0;
-    private batchProcessingStartTimeStamp: number | undefined;
+	private readonly logger: ITelemetryLoggerExt;
+	private startBatchSequenceNumber: number | undefined;
+	private trackedBatchCount: number = 0;
+	private batchProcessingStartTimeStamp: number | undefined;
 
-    constructor(
-        private readonly batchEventEmitter: EventEmitter,
-        logger: ITelemetryLogger,
-        batchLengthThreshold: number,
-        batchCountSamplingRate: number,
-        dateTimeProvider: () => number = () => performance.now(),
-    ) {
-        this.logger = ChildLogger.create(logger, "Batching");
+	constructor(
+		private readonly batchEventEmitter: EventEmitter,
+		logger: ITelemetryBaseLogger,
+		batchLengthThreshold: number,
+		batchCountSamplingRate: number,
+		dateTimeProvider: () => number = () => performance.now(),
+	) {
+		this.logger = createChildLogger({ logger, namespace: "Batching" });
 
-        this.batchEventEmitter.on("batchBegin", (message: ISequencedDocumentMessage) => {
-            this.startBatchSequenceNumber = message.sequenceNumber;
-            this.batchProcessingStartTimeStamp = dateTimeProvider();
-            this.trackedBatchCount++;
-        });
+		this.batchEventEmitter.on("batchBegin", (message: ISequencedDocumentMessage) => {
+			this.startBatchSequenceNumber = message.sequenceNumber;
+			this.batchProcessingStartTimeStamp = dateTimeProvider();
+			this.trackedBatchCount++;
+		});
 
-        this.batchEventEmitter.on("batchEnd", (error: any | undefined, message: ISequencedDocumentMessage) => {
-            assert(
-                this.startBatchSequenceNumber !== undefined && this.batchProcessingStartTimeStamp !== undefined,
-                0x2ba /* "batchBegin must fire before batchEnd" */);
+		this.batchEventEmitter.on(
+			"batchEnd",
+			(error: any | undefined, message: ISequencedDocumentMessage) => {
+				assert(
+					this.startBatchSequenceNumber !== undefined &&
+						this.batchProcessingStartTimeStamp !== undefined,
+					0x2ba /* "batchBegin must fire before batchEnd" */,
+				);
 
-            const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;
-            if (length >= batchLengthThreshold) {
-                this.logger.sendErrorEvent({
-                    eventName: "LengthTooBig",
-                    length,
-                    threshold: batchLengthThreshold,
-                    batchEndSequenceNumber: message.sequenceNumber,
-                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
-                    batchError: error !== undefined,
-                });
-            }
+				const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;
+				if (length >= batchLengthThreshold) {
+					this.logger.sendPerformanceEvent({
+						eventName: "LengthTooBig",
+						length,
+						threshold: batchLengthThreshold,
+						batchEndSequenceNumber: message.sequenceNumber,
+						duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
+						batchError: error !== undefined,
+					});
+				}
 
-            if (this.trackedBatchCount % batchCountSamplingRate === 0) {
-                this.logger.sendPerformanceEvent({
-                    eventName: "Length",
-                    length,
-                    samplingRate: batchCountSamplingRate,
-                    batchEndSequenceNumber: message.sequenceNumber,
-                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
-                });
-            }
+				if (this.trackedBatchCount % batchCountSamplingRate === 0) {
+					this.logger.sendPerformanceEvent({
+						eventName: "Length",
+						length,
+						samplingRate: batchCountSamplingRate,
+						batchEndSequenceNumber: message.sequenceNumber,
+						duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,
+					});
+				}
 
-            this.startBatchSequenceNumber = undefined;
-            this.batchProcessingStartTimeStamp = undefined;
-        });
-    }
+				this.startBatchSequenceNumber = undefined;
+				this.batchProcessingStartTimeStamp = undefined;
+			},
+		);
+	}
 }
 
 /**
  * Track batch sizes in terms of op counts and processing times
  *
  * @param batchEventEmitter - event emitter which tracks the lifecycle of batch operations
- * @param logger - logger
+ * @param logger - See {@link @fluidframework/core-interfaces#ITelemetryLoggerExt}
  * @param batchLengthThreshold - threshold for the length of a batch when to send an error event
  * @param batchCountSamplingRate - rate for batches for which to send an event with its characteristics
- * @returns
  */
 export const BindBatchTracker = (
-    batchEventEmitter: EventEmitter,
-    logger: ITelemetryLogger,
-    batchLengthThreshold: number = 1000,
-    batchCountSamplingRate: number = 1000,
+	batchEventEmitter: EventEmitter,
+	logger: ITelemetryLoggerExt,
+	batchLengthThreshold: number = 1000,
+	batchCountSamplingRate: number = 1000,
 ) => new BatchTracker(batchEventEmitter, logger, batchLengthThreshold, batchCountSamplingRate);