@fluidframework/test-utils 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/test-utils",
-  "version": "2.0.0-dev.7.4.0.215930",
+  "version": "2.0.0-dev.7.4.0.216897",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -34,27 +34,27 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/container-loader": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/container-runtime": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/datastore": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/local-driver": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/map": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/aqueduct": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/container-loader": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/container-runtime": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/datastore": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/local-driver": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/map": "2.0.0-dev.7.4.0.216897",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/request-handler": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/routerlicious-driver": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/test-driver-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/request-handler": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/routerlicious-driver": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/test-driver-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.216897",
     "best-random": "^1.0.0",
     "debug": "^4.3.4",
     "uuid": "^9.0.0"
@@ -64,7 +64,7 @@
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.216897",
     "@fluidframework/test-utils-previous": "npm:@fluidframework/test-utils@2.0.0-internal.7.2.0",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/debug": "^4.1.5",
@@ -98,7 +98,16 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "InterfaceDeclaration_ITestObjectProvider": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "ClassDeclaration_TestObjectProvider": {
+        "backCompat": false,
+        "forwardCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
@@ -110,12 +119,13 @@
     "build:docs": "fluid-build . --task api",
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
+    "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 eslint",
+    "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",

package/src/DriverWrappers.ts

@@ -17,6 +17,7 @@ import { ISummaryTree } from "@fluidframework/protocol-definitions";
  * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
  * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
  * callback before it is uploaded to the server.
+ * @internal
  */
 export function wrapDocumentStorageService(
 	innerDocStorageService: IDocumentStorageService,
@@ -39,6 +40,7 @@ export function wrapDocumentStorageService(
  * the client.
  * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
  * to pass in the `uploadSummaryCb`.
+ * @internal
  */
 export function wrapDocumentService(
 	innerDocService: IDocumentService,
@@ -58,6 +60,7 @@ export function wrapDocumentService(
  * uploaded by the client.
  * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
  * pass in the `uploadSummaryCb`.
+ * @internal
  */
 export function wrapDocumentServiceFactory(
 	innerDocServiceFactory: IDocumentServiceFactory,

package/src/TestConfigs.ts

@@ -5,6 +5,9 @@
 
 import { ConfigTypes, IConfigProviderBase } from "@fluidframework/telemetry-utils";
 
+/**
+ * @internal
+ */
 export const mockConfigProvider = (
 	settings: Record<string, ConfigTypes> = {},
 ): IConfigProviderBase => {

package/src/TestSummaryUtils.ts

@@ -77,6 +77,7 @@ const defaultSummaryOptions: ISummaryRuntimeOptions = {
  * Creates a summarizer client from the given container and data store factory, and returns the summarizer client's
  * IContainer and ISummarizer.
  * The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
+ * @internal
  */
 export async function createSummarizerFromFactory(
 	provider: ITestObjectProvider,
@@ -114,6 +115,7 @@ export async function createSummarizerFromFactory(
  * The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
  *
  * Can pass in a test config provider to enable/disable features.
+ * @internal
  */
 export async function createSummarizer(
 	provider: ITestObjectProvider,
@@ -145,6 +147,7 @@ export async function createSummarizer(
  * @param summarizer - The ISummarizer to use to summarize on demand
  * @param inputs - Either the reason string or the full IOnDemandSummarizeOptions.
  * Defaults to the reason "end-to-end test".
+ * @internal
  */
 export async function summarizeNow(
 	summarizer: ISummarizer,

package/src/containerUtils.ts

@@ -7,6 +7,7 @@ import { IContainer } from "@fluidframework/container-definitions";
 import { ConnectionState } from "@fluidframework/container-loader";
 import { IResponse } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils";
+import { IDataStore } from "@fluidframework/runtime-definitions";
 import { PromiseExecutor, timeoutPromise, TimeoutWithError } from "./timeoutUtils";
 
 /**
@@ -29,6 +30,7 @@ import { PromiseExecutor, timeoutPromise, TimeoutWithError } from "./timeoutUtil
  * - Rejects if failOnContainerClose === true and the container emits a 'closed' event before a 'connected' event.
  * - Rejects after timeoutOptions.durationMs if timeoutOptions !== undefined and the container does not emit relevant
  * events, within that timeframe.
+ * @internal
  */
 export async function waitForContainerConnection(
 	container: IContainer,
@@ -53,12 +55,36 @@ export async function waitForContainerConnection(
  * This function should ONLY be used for back compat purposes
  * LTS versions of the Loader/Container will not have the "getEntryPoint" method, so we need to fallback to "request"
  * This function can be removed once LTS version of Loader moves to 2.0.0-internal.7.0.0
+ * @internal
  */
 export async function getContainerEntryPointBackCompat<T>(container: IContainer): Promise<T> {
 	if (container.getEntryPoint !== undefined) {
-		return (await container.getEntryPoint()) as T;
+		const entryPoint = await container.getEntryPoint();
+		// Note: We need to also check if the result of `getEntryPoint()` is defined. This is because when running
+		// cross version compat testing scenarios, if we create with 1.X container and load with 2.X then the
+		// function container.getEntryPoint will be defined for the 2.X container. However, it will not return undefined
+		// since the container's runtime will be on version 1.X, which does not have an entry point defined.
+		if (entryPoint !== undefined) {
+			return entryPoint as T;
+		}
 	}
 	const response: IResponse = await (container as any).request({ url: "/" });
 	assert(response.status === 200, "requesting '/' should return default data object");
 	return response.value as T;
 }
+
+/**
+ * This function should ONLY be used for back compat purposes
+ * Older supported versions of IDataStore do not have the "entryPoint" property, so we need to fallback to "request"
+ * This function can be removed once back-compat support for IDataStore moves to 2.0.0-internal.7.0.0
+ *
+ * @internal
+ */
+export async function getDataStoreEntryPointBackCompat<T>(dataStore: IDataStore): Promise<T> {
+	if (dataStore.entryPoint !== undefined) {
+		return dataStore.entryPoint.get() as Promise<T>;
+	}
+	const response: IResponse = await (dataStore as any).request({ url: "" });
+	assert(response.status === 200, "empty request should return data object");
+	return response.value as T;
+}

package/src/index.ts

@@ -24,10 +24,12 @@ export {
 	DataObjectFactoryType,
 	EventAndErrorTrackingLogger,
 	getUnexpectedLogErrorException,
+	IDocumentIdStrategy,
 	IOpProcessingController,
 	ITestContainerConfig,
 	ITestObjectProvider,
 	TestObjectProvider,
+	TestObjectProviderWithVersionedLoad,
 } from "./testObjectProvider";
 export { createSummarizer, createSummarizerFromFactory, summarizeNow } from "./TestSummaryUtils";
 export {
@@ -37,5 +39,9 @@ export {
 	TimeoutWithError,
 	TimeoutWithValue,
 } from "./timeoutUtils";
-export { waitForContainerConnection, getContainerEntryPointBackCompat } from "./containerUtils";
+export {
+	waitForContainerConnection,
+	getContainerEntryPointBackCompat,
+	getDataStoreEntryPointBackCompat,
+} from "./containerUtils";
 export { createContainerRuntimeFactoryWithDefaultDataStore } from "./testContainerRuntimeFactoryWithDefaultDataStore";

package/src/interfaces.ts

@@ -11,10 +11,16 @@ import {
 } from "@fluidframework/runtime-definitions";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
 
+/**
+ * @internal
+ */
 export interface IProvideTestFluidObject {
 	readonly ITestFluidObject: ITestFluidObject;
 }
 
+/**
+ * @internal
+ */
 export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable {
 	root: ISharedMap;
 	readonly runtime: IFluidDataStoreRuntime;

package/src/loaderContainerTracker.ts

@@ -41,6 +41,9 @@ interface ContainerRecord {
 	lastProposal: number;
 }
 
+/**
+ * @internal
+ */
 export class LoaderContainerTracker implements IOpProcessingController {
 	private readonly containers = new Map<IContainer, ContainerRecord>();
 	private lastProposalSeqNum: number = 0;

package/src/localCodeLoader.ts

@@ -22,6 +22,9 @@ import {
 import { createDataStoreFactory } from "@fluidframework/runtime-utils";
 import { IContainerRuntimeOptions } from "@fluidframework/container-runtime";
 
+/**
+ * @internal
+ */
 export type SupportedExportInterfaces = Partial<
 	IProvideRuntimeFactory &
 		IProvideFluidDataStoreFactory &
@@ -30,11 +33,15 @@ export type SupportedExportInterfaces = Partial<
 >;
 
 // Represents the entry point for a Fluid container.
+/**
+ * @internal
+ */
 export type fluidEntryPoint = SupportedExportInterfaces | IFluidModule;
 
 /**
  * A simple code loader that caches a mapping of package name to a Fluid entry point.
  * On load, it retrieves the entry point matching the package name in the given code details.
+ * @internal
  */
 export class LocalCodeLoader implements ICodeDetailsLoader {
 	private readonly fluidPackageCache = new Map<string, IFluidModuleWithDetails>();

package/src/localLoader.ts

@@ -21,6 +21,7 @@ import { fluidEntryPoint, LocalCodeLoader } from "./localCodeLoader";
  * @param documentServiceFactory - the driver factory to use
  * @param urlResolver - the url resolver to use
  * @param options - loader options
+ * @internal
  */
 export function createLoader(
 	packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>,
@@ -45,6 +46,7 @@ export function createLoader(
  * @param source - The code details used to create the Container.
  * @param loader - The loader to use to initialize the container.
  * @param attachRequest - The request to create new from.
+ * @internal
  */
 
 export async function createAndAttachContainer(

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/test-utils";
-export const pkgVersion = "2.0.0-dev.7.4.0.215930";
+export const pkgVersion = "2.0.0-dev.7.4.0.216897";

package/src/retry.ts

@@ -33,6 +33,7 @@ const retry = async <T>(
  * @param maxTries - maximum number of attempts
  * @param backOffMs - back off between attempts in milliseconds
  * @returns the actual value from the callback when successful or the default value otherwise
+ * @internal
  */
 export const retryWithEventualValue = async <T>(
 	callback: () => Promise<T>,

package/src/testContainerRuntimeFactory.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-// eslint-disable-next-line import/no-deprecated
 import { defaultRouteRequestHandler } from "@fluidframework/aqueduct";
 import { IContainerContext, IRuntime } from "@fluidframework/container-definitions";
 import {
@@ -12,13 +11,13 @@ import {
 	DefaultSummaryConfiguration,
 } from "@fluidframework/container-runtime";
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
-// eslint-disable-next-line import/no-deprecated
 import { buildRuntimeRequestHandler, RuntimeRequestHandler } from "@fluidframework/request-handler";
 import { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions";
 import { RuntimeFactoryHelper } from "@fluidframework/runtime-utils";
 
 /**
  * Create a container runtime factory class that allows you to set runtime options
+ * @internal
  */
 export const createTestContainerRuntimeFactory = (
 	containerRuntimeCtor: typeof ContainerRuntime,
@@ -54,13 +53,34 @@ 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.getAliasedDataStoreEntryPoint("default");
+			// Note: We use the deprecated `getRootDataStore` from v1.X here to allow for cross-major version compat
+			// testing. Can be removed when we no longer support v1.X.
+			await (runtime.getAliasedDataStoreEntryPoint?.("default") ??
+				runtime.getRootDataStore("default"));
 		}
 
 		async preInitialize(
 			context: IContainerContext,
 			existing: boolean,
 		): Promise<IRuntime & IContainerRuntime> {
+			if (containerRuntimeCtor.loadRuntime === undefined) {
+				// Note: We use the deprecated `load` from v1.X here to allow for cross-major version compat testing.
+				// Can be removed when we no longer support v1.X.
+				return containerRuntimeCtor.load(
+					context,
+					[
+						["default", Promise.resolve(this.dataStoreFactory)],
+						[this.type, Promise.resolve(this.dataStoreFactory)],
+					],
+					buildRuntimeRequestHandler(
+						defaultRouteRequestHandler("default"),
+						...this.requestHandlers,
+					),
+					this.runtimeOptions,
+					context.scope,
+					existing,
+				);
+			}
 			const provideEntryPoint = async (runtime: IContainerRuntime) => {
 				const entryPoint = await runtime.getAliasedDataStoreEntryPoint("default");
 				if (entryPoint === undefined) {
@@ -74,9 +94,7 @@ export const createTestContainerRuntimeFactory = (
 					["default", Promise.resolve(this.dataStoreFactory)],
 					[this.type, Promise.resolve(this.dataStoreFactory)],
 				],
-				// eslint-disable-next-line import/no-deprecated
 				requestHandler: buildRuntimeRequestHandler(
-					// eslint-disable-next-line import/no-deprecated
 					defaultRouteRequestHandler("default"),
 					...this.requestHandlers,
 				),
@@ -93,5 +111,6 @@ export const createTestContainerRuntimeFactory = (
 
 /**
  * A container runtime factory that allows you to set runtime options
+ * @internal
  */
 export const TestContainerRuntimeFactory = createTestContainerRuntimeFactory(ContainerRuntime);

package/src/testContainerRuntimeFactoryWithDefaultDataStore.ts

@@ -23,6 +23,7 @@ const getDefaultFluidObject = async (runtime: IContainerRuntime) => {
 
 /**
  * ! Note: This function is purely needed for back-compat as the constructor argument structure was changed
+ * @internal
  */
 export const createContainerRuntimeFactoryWithDefaultDataStore = (
 	Base: typeof ContainerRuntimeFactoryWithDefaultDataStore = ContainerRuntimeFactoryWithDefaultDataStore,

package/src/testFluidObject.ts

@@ -25,6 +25,7 @@ import { ITestFluidObject } from "./interfaces";
  * A test Fluid object that will create a shared object for each key-value pair in the factoryEntries passed to load.
  * The shared objects can be retrieved by passing the key of the entry to getSharedObject.
  * It exposes the IFluidDataStoreContext and IFluidDataStoreRuntime.
+ * @internal
  */
 export class TestFluidObject implements ITestFluidObject {
 	public get ITestFluidObject() {
@@ -122,6 +123,9 @@ export class TestFluidObject implements ITestFluidObject {
 	}
 }
 
+/**
+ * @internal
+ */
 export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFactory]>;
 
 /**
@@ -153,6 +157,7 @@ export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFacto
  * `describeCompat` aims to provide:
  * `SharedMap`s always reference the current version of SharedMap.
  * AB#4670 tracks improving this situation.
+ * @internal
  */
 export class TestFluidObjectFactory implements IFluidDataStoreFactory {
 	public get IFluidDataStoreFactory() {