@fluidframework/test-utils 2.0.0-dev-rc.3.0.0.253463 → 2.0.0-dev-rc.3.0.0.254513

package/src/testObjectProvider.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { assert } from "@fluidframework/core-utils/internal";
 import { ITestDriver, TestDriverTypes } from "@fluid-internal/test-driver-definitions";
 import {
 	IContainer,
@@ -27,7 +28,11 @@ import {
 	IUrlResolver,
 } from "@fluidframework/driver-definitions/internal";
 import { type ITelemetryGenericEventExt } from "@fluidframework/telemetry-utils";
-import { createChildLogger, createMultiSinkLogger } from "@fluidframework/telemetry-utils/internal";
+import {
+	createChildLogger,
+	createMultiSinkLogger,
+	type ITelemetryLoggerPropertyBags,
+} from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
 
 import { LoaderContainerTracker } from "./loaderContainerTracker.js";
@@ -77,7 +82,12 @@ export interface ITestObjectProvider {
 	/**
 	 * Logger used to track expected and unexpected events.
 	 */
-	logger: EventAndErrorTrackingLogger | undefined;
+	logger: ITelemetryBaseLogger;
+
+	/**
+	 * Logger used to track expected and unexpected events.
+	 */
+	tracker: IEventAndErrorTrackingLogger;
 
 	/**
 	 * Used to create a url for the created container with any data store path given in the relative url.
@@ -175,6 +185,7 @@ export interface ITestObjectProvider {
 	loadTestContainer(
 		testContainerConfig?: ITestContainerConfig,
 		requestHeader?: IRequestHeader,
+		pendingLocalState?: string,
 	): Promise<IContainer>;
 
 	/**
@@ -283,6 +294,15 @@ function getDocumentIdStrategy(type?: TestDriverTypes): IDocumentIdStrategy {
 	}
 }
 
+/** @internal */
+export interface IEventAndErrorTrackingLogger {
+	registerExpectedEvent: (...orderedExpectedEvents: ITelemetryGenericEventExt[]) => void;
+	reportAndClearTrackedEvents: () => {
+		expectedNotFound: { index: number; event: ITelemetryGenericEventExt }[];
+		unexpectedErrors: ITelemetryBaseEvent[];
+	};
+}
+
 /**
  * This class tracks events. It allows specifying expected events, which will be looked for in order.
  * It also tracks all unexpected errors.
@@ -290,7 +310,9 @@ function getDocumentIdStrategy(type?: TestDriverTypes): IDocumentIdStrategy {
  * any expected events that have not occurred.
  * @internal
  */
-export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
+export class EventAndErrorTrackingLogger
+	implements ITelemetryBaseLogger, IEventAndErrorTrackingLogger
+{
 	/**
 	 * 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)
@@ -305,12 +327,9 @@ export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
 		{ eventName: "fluid:telemetry:OpPerf:OpRoundtripTime" },
 	];
 
-	constructor(private readonly baseLogger: ITelemetryBaseLogger) {}
+	constructor(private readonly baseLogger?: ITelemetryBaseLogger) {}
 
-	private readonly expectedEvents: (
-		| { index: number; event: ITelemetryGenericEventExt | undefined }
-		| undefined
-	)[] = [];
+	private readonly expectedEvents: { index: number; event: ITelemetryGenericEventExt }[] = [];
 	private readonly unexpectedErrors: ITelemetryBaseEvent[] = [];
 
 	public registerExpectedEvent(...orderedExpectedEvents: ITelemetryGenericEventExt[]) {
@@ -328,24 +347,26 @@ export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
 	}
 
 	send(event: ITelemetryBaseEvent): void {
-		const ee = this.expectedEvents[0]?.event;
-		if (ee?.eventName === event.eventName) {
-			let matches = true;
-			for (const key of Object.keys(ee)) {
-				if (ee[key] !== event[key]) {
-					matches = false;
-					break;
+		if (this.expectedEvents.length > 0) {
+			const ee = this.expectedEvents[0].event;
+			if (ee.eventName === event.eventName) {
+				let matches = true;
+				for (const key of Object.keys(ee)) {
+					if (ee[key] !== event[key]) {
+						matches = false;
+						break;
+					}
 				}
-			}
-			if (matches) {
-				// we found an expected event
-				// so remove it from the list of expected events
-				// and if it is an error, change it to generic
-				// this helps keep our telemetry clear of
-				// expected errors.
-				this.expectedEvents.shift();
-				if (event.category === "error") {
-					event.category = "generic";
+				if (matches) {
+					// we found an expected event
+					// so remove it from the list of expected events
+					// and if it is an error, change it to generic
+					// this helps keep our telemetry clear of
+					// expected errors.
+					this.expectedEvents.shift();
+					if (event.category === "error") {
+						event.category = "generic";
+					}
 				}
 			}
 		}
@@ -362,7 +383,7 @@ export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
 			}
 		}
 
-		this.baseLogger.send(event);
+		this.baseLogger?.send(event);
 	}
 
 	public reportAndClearTrackedEvents() {
@@ -387,7 +408,8 @@ export class TestObjectProvider implements ITestObjectProvider {
 	private _loaderContainerTracker = new LoaderContainerTracker();
 	private _documentServiceFactory: IDocumentServiceFactory | undefined;
 	private _urlResolver: IUrlResolver | undefined;
-	private _logger: EventAndErrorTrackingLogger | undefined;
+	private _logger: ITelemetryBaseLogger | undefined;
+	private _tracker: EventAndErrorTrackingLogger | undefined;
 	private readonly _documentIdStrategy: IDocumentIdStrategy;
 	// Since documentId doesn't change we can only create/make one container. Call the load functions instead.
 	private _documentCreated = false;
@@ -416,27 +438,29 @@ export class TestObjectProvider implements ITestObjectProvider {
 	/**
 	 * {@inheritDoc ITestObjectProvider.logger}
 	 */
-	public get logger(): EventAndErrorTrackingLogger {
+	public get logger(): ITelemetryBaseLogger {
 		if (this._logger === undefined) {
-			this._logger = new EventAndErrorTrackingLogger(
-				createChildLogger({
-					logger: getTestLogger?.(),
-					properties: {
-						all: {
-							driverType: this.driver.type,
-							driverEndpointName: this.driver.endpointName,
-							driverTenantName: this.driver.tenantName,
-							driverUserIndex: this.driver.userIndex,
-						},
+			this._tracker = new EventAndErrorTrackingLogger(getTestLogger?.());
+			this._logger = createChildLogger({
+				logger: this._tracker,
+				properties: {
+					all: {
+						testType: this.type,
+						driverType: this.driver.type,
+						driverEndpointName: this.driver.endpointName,
+						driverTenantName: this.driver.tenantName,
+						driverUserIndex: this.driver.userIndex,
 					},
-				}),
-			);
+				},
+			});
 		}
 		return this._logger;
 	}
 
-	private set logger(logger: EventAndErrorTrackingLogger) {
-		this._logger = logger;
+	public get tracker() {
+		void this.logger;
+		assert(this._tracker !== undefined, "should be initialized");
+		return this._tracker;
 	}
 
 	/**
@@ -567,11 +591,18 @@ export class TestObjectProvider implements ITestObjectProvider {
 		return this.resolveContainer(loader, requestHeader);
 	}
 
-	private async resolveContainer(loader: ILoader, headers?: IRequestHeader) {
-		return loader.resolve({
-			url: await this.driver.createContainerUrl(this.documentId),
-			headers,
-		});
+	private async resolveContainer(
+		loader: ILoader,
+		headers?: IRequestHeader,
+		pendingLocalState?: string,
+	) {
+		return loader.resolve(
+			{
+				url: await this.driver.createContainerUrl(this.documentId),
+				headers,
+			},
+			pendingLocalState,
+		);
 	}
 
 	/**
@@ -614,10 +645,11 @@ export class TestObjectProvider implements ITestObjectProvider {
 	public async loadTestContainer(
 		testContainerConfig?: ITestContainerConfig,
 		requestHeader?: IRequestHeader,
+		pendingLocalState?: string,
 	): Promise<IContainer> {
 		const loader = this.makeTestLoader(testContainerConfig);
 
-		const container = await this.resolveContainer(loader, requestHeader);
+		const container = await this.resolveContainer(loader, requestHeader, pendingLocalState);
 		await this.waitContainerToCatchUp(container);
 
 		return container;
@@ -631,11 +663,12 @@ export class TestObjectProvider implements ITestObjectProvider {
 		this._documentServiceFactory = undefined;
 		this._urlResolver = undefined;
 		this._documentIdStrategy.reset();
-		const logError = getUnexpectedLogErrorException(this._logger);
+		const logError = getUnexpectedLogErrorException(this._tracker);
 		if (logError) {
 			throw logError;
 		}
 		this._logger = undefined;
+		this._tracker = undefined;
 		this._documentCreated = false;
 	}
 
@@ -685,7 +718,8 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
 	 */
 	public readonly type = "TestObjectProviderWithVersionedLoad";
 	private _loaderContainerTracker = new LoaderContainerTracker();
-	private _logger: EventAndErrorTrackingLogger | undefined;
+	private _logger: ITelemetryBaseLogger | undefined;
+	private _tracker: EventAndErrorTrackingLogger | undefined;
 	private readonly _documentIdStrategy: IDocumentIdStrategy;
 	private _documentServiceFactory: IDocumentServiceFactory | undefined;
 	private _urlResolver: IUrlResolver | undefined;
@@ -711,6 +745,7 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
 		private readonly createFluidEntryPointForLoading: (
 			testContainerConfig?: ITestContainerConfig,
 		) => fluidEntryPoint,
+		private readonly telemetryProps?: ITelemetryLoggerPropertyBags,
 	) {
 		this._documentIdStrategy = getDocumentIdStrategy(driverForCreating.type);
 	}
@@ -718,17 +753,23 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
 	/**
 	 * {@inheritDoc ITestObjectProvider.logger}
 	 */
-	public get logger(): EventAndErrorTrackingLogger {
+	public get logger() {
 		if (this._logger === undefined) {
-			this._logger = new EventAndErrorTrackingLogger(
-				createChildLogger({
-					logger: getTestLogger?.(),
-				}),
-			);
+			this._tracker = new EventAndErrorTrackingLogger(getTestLogger?.());
+			this._logger = createChildLogger({
+				logger: this._tracker,
+				properties: this.telemetryProps,
+			});
 		}
 		return this._logger;
 	}
 
+	public get tracker() {
+		void this.logger;
+		assert(this._tracker !== undefined, "should be initialized");
+		return this._tracker;
+	}
+
 	/**
 	 * {@inheritDoc ITestObjectProvider.documentServiceFactory}
 	 */
@@ -918,12 +959,16 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
 		loader: ILoader,
 		headers?: IRequestHeader,
 		driver?: ITestDriver,
+		pendingLocalState?: string,
 	) {
-		return loader.resolve({
-			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			url: await driver!.createContainerUrl(this.documentId),
-			headers,
-		});
+		return loader.resolve(
+			{
+				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+				url: await driver!.createContainerUrl(this.documentId),
+				headers,
+			},
+			pendingLocalState,
+		);
 	}
 
 	/**
@@ -970,11 +1015,17 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
 	public async loadTestContainer(
 		testContainerConfig?: ITestContainerConfig,
 		requestHeader?: IRequestHeader,
+		pendingLocalState?: string,
 	): Promise<IContainer> {
 		// Keep track of which Loader we are about to use so we can pass the correct driver through
 		const driver = this.useCreateApi ? this.driverForCreating : this.driverForLoading;
 		const loader = this.makeTestLoader(testContainerConfig);
-		const container = await this.resolveContainer(loader, requestHeader, driver);
+		const container = await this.resolveContainer(
+			loader,
+			requestHeader,
+			driver,
+			pendingLocalState,
+		);
 		await this.waitContainerToCatchUp(container);
 
 		return container;
@@ -987,10 +1038,11 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
 		this.useCreateApi = true;
 		this._loaderContainerTracker.reset();
 		this._logger = undefined;
+		this._tracker = undefined;
 		this._documentServiceFactory = undefined;
 		this._urlResolver = undefined;
 		this._documentIdStrategy.reset();
-		const logError = getUnexpectedLogErrorException(this._logger);
+		const logError = getUnexpectedLogErrorException(this._tracker);
 		if (logError) {
 			throw logError;
 		}
@@ -1036,7 +1088,7 @@ export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider
  * @internal
  */
 export function getUnexpectedLogErrorException(
-	logger: EventAndErrorTrackingLogger | undefined,
+	logger: IEventAndErrorTrackingLogger | undefined,
 	prefix?: string,
 ) {
 	if (logger === undefined) {