@fluidframework/test-utils 2.118.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/test-utils",
-  "version": "2.118.0",
+  "version": "3.0.0",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,38 +14,24 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./lib/public.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/public.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/public.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/public.d.ts"
       }
     },
     "./legacy": {
-      "import": {
-        "types": "./lib/legacy.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/legacy.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/legacy.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/legacy.d.ts"
       }
     },
     "./internal": {
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
     }
   },
-  "main": "lib/index.js",
-  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -67,26 +53,26 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/test-driver-definitions": "~2.118.0",
-    "@fluidframework/container-definitions": "~2.118.0",
-    "@fluidframework/container-loader": "~2.118.0",
-    "@fluidframework/container-runtime": "~2.118.0",
-    "@fluidframework/container-runtime-definitions": "~2.118.0",
-    "@fluidframework/core-interfaces": "~2.118.0",
-    "@fluidframework/core-utils": "~2.118.0",
-    "@fluidframework/datastore": "~2.118.0",
-    "@fluidframework/datastore-definitions": "~2.118.0",
-    "@fluidframework/driver-definitions": "~2.118.0",
-    "@fluidframework/driver-utils": "~2.118.0",
-    "@fluidframework/local-driver": "~2.118.0",
-    "@fluidframework/map": "~2.118.0",
-    "@fluidframework/odsp-driver": "~2.118.0",
-    "@fluidframework/request-handler": "~2.118.0",
-    "@fluidframework/routerlicious-driver": "~2.118.0",
-    "@fluidframework/runtime-definitions": "~2.118.0",
-    "@fluidframework/runtime-utils": "~2.118.0",
-    "@fluidframework/shared-object-base": "~2.118.0",
-    "@fluidframework/telemetry-utils": "~2.118.0",
+    "@fluid-internal/test-driver-definitions": "~3.0.0",
+    "@fluidframework/container-definitions": "~3.0.0",
+    "@fluidframework/container-loader": "~3.0.0",
+    "@fluidframework/container-runtime": "~3.0.0",
+    "@fluidframework/container-runtime-definitions": "~3.0.0",
+    "@fluidframework/core-interfaces": "~3.0.0",
+    "@fluidframework/core-utils": "~3.0.0",
+    "@fluidframework/datastore": "~3.0.0",
+    "@fluidframework/datastore-definitions": "~3.0.0",
+    "@fluidframework/driver-definitions": "~3.0.0",
+    "@fluidframework/driver-utils": "~3.0.0",
+    "@fluidframework/local-driver": "~3.0.0",
+    "@fluidframework/map": "~3.0.0",
+    "@fluidframework/odsp-driver": "~3.0.0",
+    "@fluidframework/request-handler": "~3.0.0",
+    "@fluidframework/routerlicious-driver": "~3.0.0",
+    "@fluidframework/runtime-definitions": "~3.0.0",
+    "@fluidframework/runtime-utils": "~3.0.0",
+    "@fluidframework/shared-object-base": "~3.0.0",
+    "@fluidframework/telemetry-utils": "~3.0.0",
     "best-random": "^1.0.0",
     "debug": "^4.3.4",
     "uuid": "^11.1.0"
@@ -94,7 +80,7 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-internal/mocha-test-setup": "~2.118.0",
+    "@fluid-internal/mocha-test-setup": "~3.0.0",
     "@fluid-tools/build-cli": "^0.67.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.67.0",
@@ -115,29 +101,39 @@
     "mocha": "^11.7.5",
     "mocha-multi-reporters": "^1.5.1",
     "rimraf": "^6.1.3",
-    "typescript": "~5.4.5"
+    "typescript": "~6.0.3"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Interface_IProvideTestFluidObject": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "Interface_ITestFluidObject": {
+        "backCompat": false,
+        "forwardCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
-    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
-    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor-report.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor-report.legacy.json",
+    "build:cjs": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "build:compile": "fluid-build . --task compile",
     "build:compile:min": "npm run build:compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "api-extractor run --local --config api-extractor/api-extractor-model.json",
     "build:entrypoints": "fluid-build . --task build:entrypoints",
     "build:entrypoints:cjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist",
-    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
-    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib",
+    "build:esm": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "build:test": "concurrently npm:build:test:esm npm:build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack .",
+    "check:are-the-types-wrong": "attw --pack . --profile esm-only",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
@@ -147,9 +143,9 @@
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
-    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
-    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
-    "ci:build:docs": "api-extractor run",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor-report.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor-report.legacy.json",
+    "ci:build:docs": "api-extractor run --config api-extractor/api-extractor-model.json",
     "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --quiet --format stylish src",
     "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -162,7 +158,6 @@
     "test:mocha:cjs": "cross-env FLUID_TEST_MODULE_SYSTEM=CJS mocha",
     "test:mocha:esm": "mocha",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "flub generate typetests --dir . -v"
   }
 }

package/src/TestSummaryUtils.ts

@@ -35,6 +35,7 @@ import {
 	type ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
 	createContainerRuntimeFactoryWithDefaultDataStore,
 } from "./testContainerRuntimeFactoryWithDefaultDataStore.js";
+import { defaultTestOldestSupportedClient } from "./testCompatibility.js";
 import { ITestContainerConfig, ITestObjectProvider } from "./testObjectProvider.js";
 import { timeoutAwait } from "./timeoutUtils.js";
 
@@ -136,6 +137,7 @@ export async function createSummarizerFromFactory(
 		containerRuntimeFactoryType ?? ContainerRuntimeFactoryWithDefaultDataStore,
 		{
 			defaultFactory: dataStoreFactory,
+			oldestSupportedClient: defaultTestOldestSupportedClient,
 			registryEntries: registryEntries ?? [
 				[dataStoreFactory.type, Promise.resolve(dataStoreFactory)],
 			],

package/src/containerRuntimeFactories.ts

@@ -33,6 +33,8 @@ import type {
 } from "@fluidframework/runtime-definitions/internal";
 import { RequestParser, RuntimeFactoryHelper } from "@fluidframework/runtime-utils/internal";
 
+import { defaultTestOldestSupportedClient } from "./testCompatibility.js";
+
 const defaultDataStoreId = "default";
 
 async function getDefaultFluidObject(runtime: IContainerRuntime): Promise<FluidObject> {
@@ -126,7 +128,7 @@ export class ContainerRuntimeFactoryWithDefaultDataStore
 	/**
 	 * {@inheritDoc ContainerRuntimeFactoryWithDefaultDataStoreProps.minVersionForCollab}
 	 */
-	private readonly minVersionForCollab: OldestSupportedClientVersion | undefined;
+	private readonly minVersionForCollab: OldestSupportedClientVersion;
 
 	public constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps) {
 		super();
@@ -153,7 +155,7 @@ export class ContainerRuntimeFactoryWithDefaultDataStore
 		this.provideEntryPoint = props.provideEntryPoint ?? getDefaultFluidObject;
 		this.requestHandlers = [getDefaultObject];
 		this.registry = new FluidDataStoreRegistry(this.registryEntries);
-		this.minVersionForCollab = props.minVersionForCollab;
+		this.minVersionForCollab = props.minVersionForCollab ?? defaultTestOldestSupportedClient;
 	}
 
 	public async instantiateFirstTime(runtime: IContainerRuntime): Promise<void> {

package/src/eventAndErrorLogger.ts

@@ -64,7 +64,7 @@ export class EventAndErrorTrackingLogger
 		);
 	}
 
-	send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void {
+	send(event: ITelemetryBaseEvent, logLevel: LogLevel): void {
 		if (isNonEmptyArray(this.expectedEvents)) {
 			const ee = this.expectedEvents[0].event;
 			if (ee.eventName === event.eventName) {

package/src/index.ts

@@ -83,5 +83,6 @@ export {
 	type ContainerRuntimeFactoryWithDefaultDataStoreProps,
 	createContainerRuntimeFactoryWithDefaultDataStore,
 } from "./testContainerRuntimeFactoryWithDefaultDataStore.js";
+export { defaultTestOldestSupportedClient } from "./testCompatibility.js";
 
 export { TestFluidObjectInternal } from "./testFluidObjectInternal.js";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/test-utils";
-export const pkgVersion = "2.118.0";
+export const pkgVersion = "3.0.0";

package/src/testCompatibility.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { OldestSupportedClientVersion } from "@fluidframework/runtime-definitions/internal";
+import { defaultMinVersionForCollab } from "@fluidframework/runtime-utils/internal";
+
+/**
+ * Canonical compatibility setting for generic runtime tests. Tests for a specific feature should
+ * instead use that feature's minimum supported client version.
+ *
+ * @internal
+ */
+export const defaultTestOldestSupportedClient =
+	defaultMinVersionForCollab satisfies OldestSupportedClientVersion;

package/src/testContainerRuntimeFactory.ts

@@ -33,6 +33,8 @@ import {
 } from "@fluidframework/runtime-definitions/internal";
 import { RequestParser, RuntimeFactoryHelper } from "@fluidframework/runtime-utils/internal";
 
+import { defaultTestOldestSupportedClient } from "./testCompatibility.js";
+
 interface backCompat_IFluidRouter {
 	IFluidRouter?: backCompat_IFluidRouter;
 	request(request: IRequest): Promise<IResponse>;
@@ -107,7 +109,7 @@ export const createTestContainerRuntimeFactory = (
 					},
 				},
 			},
-			public minVersionForCollab: OldestSupportedClientVersion | undefined = undefined,
+			public minVersionForCollab: OldestSupportedClientVersion = defaultTestOldestSupportedClient,
 			// eslint-disable-next-line import-x/no-deprecated
 			public requestHandlers: RuntimeRequestHandler[] = [],
 		) {

package/src/testContainerRuntimeFactoryWithDefaultDataStore.ts

@@ -9,11 +9,13 @@ import { IContainerRuntime } from "@fluidframework/container-runtime-definitions
 import { FluidObject } from "@fluidframework/core-interfaces";
 // eslint-disable-next-line import-x/no-deprecated
 import { RuntimeRequestHandler } from "@fluidframework/request-handler/internal";
-import {
+import type {
 	IFluidDataStoreFactory,
 	NamedFluidDataStoreRegistryEntries,
 } from "@fluidframework/runtime-definitions/internal";
 
+import type { defaultTestOldestSupportedClient } from "./testCompatibility.js";
+
 const getDefaultFluidObject = async (runtime: IContainerRuntime): Promise<FluidObject> => {
 	const entryPoint = await runtime.getAliasedDataStoreEntryPoint("default");
 	if (entryPoint === undefined) {
@@ -29,6 +31,16 @@ const getDefaultFluidObject = async (runtime: IContainerRuntime): Promise<FluidO
  */
 export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
 	readonly defaultFactory: IFluidDataStoreFactory;
+
+	/**
+	 * Compatibility setting used by all constructor shapes supported by this helper.
+	 *
+	 * @remarks
+	 * Object-shaped constructors receive this setting explicitly. Positional constructors predate
+	 * the setting and continue to use the historical package's own implicit default.
+	 */
+	readonly oldestSupportedClient: typeof defaultTestOldestSupportedClient;
+
 	/**
 	 * The data store registry for containers produced.
 	 */
@@ -63,16 +75,60 @@ export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
  *
  * @internal
  */
-export type ContainerRuntimeFactoryWithDefaultDataStoreConstructor = new (
-	props: ContainerRuntimeFactoryWithDefaultDataStoreProps,
-) => IRuntimeFactory;
+export type ContainerRuntimeFactoryWithDefaultDataStoreConstructor = (
+	| (new (
+			props: ContainerRuntimeFactoryWithDefaultDataStoreProps,
+	  ) => IRuntimeFactory)
+	| (new (
+			defaultFactory: IFluidDataStoreFactory,
+			registryEntries: NamedFluidDataStoreRegistryEntries,
+			dependencyContainer?: never,
+			// eslint-disable-next-line import-x/no-deprecated
+			requestHandlers?: RuntimeRequestHandler[],
+			runtimeOptions?: IContainerRuntimeOptions,
+			provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>,
+	  ) => IRuntimeFactory)
+) & { readonly length: number };
+
+type ObjectContainerRuntimeFactoryWithDefaultDataStoreConstructor = Extract<
+	ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
+	new (
+		props: ContainerRuntimeFactoryWithDefaultDataStoreProps,
+	) => IRuntimeFactory
+>;
+
+type PositionalContainerRuntimeFactoryWithDefaultDataStoreConstructor = Exclude<
+	ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
+	ObjectContainerRuntimeFactoryWithDefaultDataStoreConstructor
+>;
+
+const objectConstructorArity = 1;
+const positionalConstructorArity = 3;
+
+function isObjectConstructor(
+	ctor: ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
+): ctor is ObjectContainerRuntimeFactoryWithDefaultDataStoreConstructor & {
+	readonly length: typeof objectConstructorArity;
+} {
+	return ctor.length === objectConstructorArity;
+}
+
+function isPositionalConstructor(
+	ctor: ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
+): ctor is PositionalContainerRuntimeFactoryWithDefaultDataStoreConstructor & {
+	readonly length: typeof positionalConstructorArity;
+} {
+	return ctor.length === positionalConstructorArity;
+}
 
 /**
  * Creates a container runtime factory with default data store for backward compatibility.
  *
  * @remarks
- * This function is purely needed for back-compat as the constructor argument structure of
- * `ContainerRuntimeFactoryWithDefaultDataStore` was changed.
+ * Exact constructors loaded by compatibility tests use the positional shape through
+ * `2.0.0-internal.5.4.2` and the object shape beginning with `2.0.0-internal.7.0.0`.
+ * JavaScript constructor length counts parameters before the first default-valued parameter, so
+ * these shapes have arity 3 and 1 respectively. Unknown arities are rejected rather than guessed.
  *
  * @internal
  */
@@ -80,10 +136,12 @@ export const createContainerRuntimeFactoryWithDefaultDataStore = (
 	ctor: ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
 	ctorProps: ContainerRuntimeFactoryWithDefaultDataStoreProps,
 ): IRuntimeFactory => {
-	try {
+	const constructorArity = ctor.length;
+	if (isObjectConstructor(ctor)) {
 		return new ctor(ctorProps);
-	} catch (err) {
-		// IMPORTANT: The constructor argument structure changed, so this is needed for dynamically using older `ContainerRuntimeFactoryWithDefaultDataStore`s
+	}
+
+	if (isPositionalConstructor(ctor)) {
 		const {
 			defaultFactory,
 			registryEntries,
@@ -92,8 +150,7 @@ export const createContainerRuntimeFactoryWithDefaultDataStore = (
 			runtimeOptions,
 			provideEntryPoint,
 		} = ctorProps;
-		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
-		return new (ctor as any)(
+		return new ctor(
 			defaultFactory,
 			registryEntries,
 			dependencyContainer,
@@ -102,4 +159,8 @@ export const createContainerRuntimeFactoryWithDefaultDataStore = (
 			provideEntryPoint ?? getDefaultFluidObject,
 		);
 	}
+
+	throw new Error(
+		`Unsupported ContainerRuntimeFactoryWithDefaultDataStore constructor arity: ${constructorArity}`,
+	);
 };

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"extends": "../../../common/build/build-common/tsconfig.node20.json",
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {
 		"rootDir": "./src",

package/internal.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/index.js";

package/legacy.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/legacy.js";