@fluidframework/test-utils 2.0.0-internal.5.4.0 → 2.0.0-internal.6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/test-utils",
-  "version": "2.0.0-internal.5.4.0",
+  "version": "2.0.0-internal.6.1.0",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,38 +35,38 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
+    "@fluidframework/aqueduct": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/container-loader": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/container-runtime": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/datastore": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/driver-utils": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/local-driver": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/map": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/container-loader": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/container-runtime": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/datastore": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/local-driver": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/map": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/request-handler": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/routerlicious-driver": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/test-driver-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
+    "@fluidframework/request-handler": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/routerlicious-driver": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/test-driver-definitions": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
     "best-random": "^1.0.0",
     "debug": "^4.1.1",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.21.0",
-    "@fluidframework/build-common": "^1.2.0",
-    "@fluidframework/build-tools": "^0.21.0",
+    "@fluid-tools/build-cli": "^0.22.0",
+    "@fluidframework/build-common": "^2.0.0",
+    "@fluidframework/build-tools": "^0.22.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
-    "@fluidframework/test-utils-previous": "npm:@fluidframework/test-utils@2.0.0-internal.5.2.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.6.1.0 <2.0.0-internal.6.2.0",
+    "@fluidframework/test-utils-previous": "npm:@fluidframework/test-utils@2.0.0-internal.6.0.0",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/debug": "^4.1.5",
     "@types/diff": "^3.5.1",
@@ -90,12 +90,7 @@
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "broken": {
-      "RemovedFunctionDeclaration_createSummarizerWithTestConfig": {
-        "forwardCompat": false,
-        "backCompat": false
-      }
-    }
+    "broken": {}
   },
   "scripts": {
     "build": "fluid-build . --task build",

package/src/TestSummaryUtils.ts

@@ -66,7 +66,7 @@ async function createSummarizerCore(
 const defaultSummaryOptions: ISummaryRuntimeOptions = {
 	summaryConfigOverrides: {
 		state: "disableHeuristics",
-		maxAckWaitTime: 10000,
+		maxAckWaitTime: 20000, // Some of the AFR tests take a long time to ack.
 		maxOpsSinceLastSummary: 7000,
 		initialSummarizerDelayMs: 0,
 	},
@@ -142,7 +142,9 @@ export async function summarizeNow(summarizer: ISummarizer, reason: string = "en
 
 	const submitResult = await timeoutAwait(result.summarySubmitted);
 	if (!submitResult.success) {
-		submitResult.error.data = submitResult.data;
+		if (typeof submitResult.error !== "string") {
+			submitResult.error.data = submitResult.data;
+		}
 		throw submitResult.error;
 	}
 	assert(

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/test-utils";
-export const pkgVersion = "2.0.0-internal.5.4.0";
+export const pkgVersion = "2.0.0-internal.6.1.0";

package/src/testContainerRuntimeFactory.ts

@@ -52,7 +52,8 @@ export const createTestContainerRuntimeFactory = (
 		public async instantiateFromExisting(runtime: ContainerRuntime): Promise<void> {
 			// Validate we can load root data stores.
 			// We should be able to load any data store that was created in initializeFirstTime!
-			await runtime.getRootDataStore("default");
+			await (runtime.getAliasedDataStoreEntryPoint?.("default") ??
+				runtime.getRootDataStore("default"));
 		}
 
 		async preInitialize(

package/src/testFluidObject.ts

@@ -8,7 +8,6 @@ import {
 	IRequest,
 	IResponse,
 	IFluidHandle,
-	IFluidRouter,
 	FluidObject,
 	IProvideFluidRouter,
 } from "@fluidframework/core-interfaces";
@@ -32,20 +31,7 @@ import { ITestFluidObject } from "./interfaces";
  * The shared objects can be retrieved by passing the key of the entry to getSharedObject.
  * It exposes the IFluidDataStoreContext and IFluidDataStoreRuntime.
  */
-export class TestFluidObject implements ITestFluidObject, IFluidRouter {
-	public static async load(
-		runtime: IFluidDataStoreRuntime,
-		channel: IFluidDataStoreChannel,
-		context: IFluidDataStoreContext,
-		factoryEntries: Map<string, IChannelFactory>,
-		existing: boolean,
-	) {
-		const fluidObject = new TestFluidObject(runtime, channel, context, factoryEntries);
-		await fluidObject.initialize(existing);
-
-		return fluidObject;
-	}
-
+export class TestFluidObject implements ITestFluidObject {
 	public get ITestFluidObject() {
 		return this;
 	}
@@ -54,6 +40,9 @@ export class TestFluidObject implements ITestFluidObject, IFluidRouter {
 		return this;
 	}
 
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
 	public get IFluidRouter() {
 		return this;
 	}
@@ -64,6 +53,7 @@ export class TestFluidObject implements ITestFluidObject, IFluidRouter {
 
 	public root!: ISharedMap;
 	private readonly innerHandle: IFluidHandle<this>;
+	private initializeP: Promise<void> | undefined;
 
 	/**
 	 * Creates a new TestFluidObject.
@@ -100,23 +90,39 @@ export class TestFluidObject implements ITestFluidObject, IFluidRouter {
 		throw new Error(`Shared object with id ${id} not found.`);
 	}
 
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
 	public async request(request: IRequest): Promise<IResponse> {
 		return defaultFluidObjectRequestHandler(this, request);
 	}
 
-	private async initialize(existing: boolean) {
-		if (!existing) {
-			this.root = SharedMap.create(this.runtime, "root");
+	public async initialize(existing: boolean) {
+		const doInitialization = async () => {
+			if (!existing) {
+				this.root = SharedMap.create(this.runtime, "root");
+
+				this.factoryEntriesMap.forEach(
+					(sharedObjectFactory: IChannelFactory, key: string) => {
+						const sharedObject = this.runtime.createChannel(
+							key,
+							sharedObjectFactory.type,
+						);
+						this.root.set(key, sharedObject.handle);
+					},
+				);
 
-			this.factoryEntriesMap.forEach((sharedObjectFactory: IChannelFactory, key: string) => {
-				const sharedObject = this.runtime.createChannel(key, sharedObjectFactory.type);
-				this.root.set(key, sharedObject.handle);
-			});
+				this.root.bindToContext();
+			}
 
-			this.root.bindToContext();
+			this.root = (await this.runtime.getChannel("root")) as ISharedMap;
+		};
+
+		if (this.initializeP === undefined) {
+			this.initializeP = doInitialization();
 		}
 
-		this.root = (await this.runtime.getChannel("root")) as ISharedMap;
+		return this.initializeP;
 	}
 }
 
@@ -178,18 +184,16 @@ export class TestFluidObjectFactory implements IFluidDataStoreFactory {
 		dataTypes.set(sharedMapFactory.type, sharedMapFactory);
 
 		// Add the object factories to the list to be sent to data store runtime.
-		for (const entry of this.factoryEntries) {
-			const factory = entry[1];
+		for (const [, factory] of this.factoryEntries) {
 			dataTypes.set(factory.type, factory);
 		}
 
 		// Create a map from the factory entries with entries that don't have the id as undefined. This will be
 		// passed to the Fluid object.
 		const factoryEntriesMapForObject = new Map<string, IChannelFactory>();
-		for (const entry of this.factoryEntries) {
-			const id = entry[0];
+		for (const [id, factory] of this.factoryEntries) {
 			if (id !== undefined) {
-				factoryEntriesMapForObject.set(id, entry[1]);
+				factoryEntriesMapForObject.set(id, factory);
 			}
 		}
 
@@ -205,20 +209,22 @@ export class TestFluidObjectFactory implements IFluidDataStoreFactory {
 			},
 		);
 
-		return new runtimeClass(
+		const runtime = new runtimeClass(context, dataTypes, existing, async () => {
+			await instance.initialize(true);
+			return instance;
+		});
+
+		const instance: TestFluidObject = new TestFluidObject(
+			runtime, // runtime
+			runtime, // channel
 			context,
-			dataTypes,
-			existing,
-			async (dataStoreRuntime: IFluidDataStoreRuntime) =>
-				TestFluidObject.load(
-					dataStoreRuntime,
-					// This works because 'runtime' is an instance of runtimeClass (which is a FluidDataStoreRuntime and
-					// thus implements IFluidDataStoreChannel) which passes itself as the parameter to this function.
-					dataStoreRuntime as FluidDataStoreRuntime,
-					context,
-					factoryEntriesMapForObject,
-					existing,
-				),
+			factoryEntriesMapForObject,
 		);
+
+		if (!existing) {
+			await instance.initialize(false);
+		}
+
+		return runtime;
 	}
 }

package/src/testObjectProvider.ts

@@ -29,11 +29,7 @@ import {
 } from "@fluidframework/driver-definitions";
 import { ITestDriver, TestDriverTypes } from "@fluidframework/test-driver-definitions";
 import { v4 as uuid } from "uuid";
-import {
-	createChildLogger,
-	createMultiSinkLogger,
-	TelemetryLogger,
-} from "@fluidframework/telemetry-utils";
+import { createChildLogger, createMultiSinkLogger } from "@fluidframework/telemetry-utils";
 import { LoaderContainerTracker } from "./loaderContainerTracker";
 import { fluidEntryPoint, LocalCodeLoader } from "./localCodeLoader";
 import { createAndAttachContainer } from "./localLoader";
@@ -164,7 +160,7 @@ function getDocumentIdStrategy(type?: TestDriverTypes): IDocumentIdStrategy {
  * At any point you call reportAndClearTrackedEvents which will provide all unexpected errors, and
  * any expected events that have not occurred.
  */
-export class EventAndErrorTrackingLogger extends TelemetryLogger {
+export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
 	/**
 	 * Even if these error events are logged, tests should still be allowed to pass
 	 * Additionally, if downgrade is true, then log as generic (e.g. to avoid polluting the e2e test logs)
@@ -179,9 +175,7 @@ export class EventAndErrorTrackingLogger extends TelemetryLogger {
 		{ eventName: "fluid:telemetry:OpPerf:OpRoundtripTime" },
 	];
 
-	constructor(private readonly baseLogger: ITelemetryBaseLogger) {
-		super();
-	}
+	constructor(private readonly baseLogger: ITelemetryBaseLogger) {}
 
 	private readonly expectedEvents: (
 		| { index: number; event: ITelemetryGenericEvent | undefined }