@fluidframework/test-utils 2.0.0-dev.7.3.0.212138 → 2.0.0-dev.7.4.0.214930

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/test-utils",
-  "version": "2.0.0-dev.7.3.0.212138",
+  "version": "2.0.0-dev.7.4.0.214930",
   "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.3.0.212138",
-    "@fluidframework/container-definitions": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/container-loader": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/container-runtime": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/core-utils": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/datastore": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/datastore-definitions": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/local-driver": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/map": "2.0.0-dev.7.3.0.212138",
+    "@fluidframework/aqueduct": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/container-loader": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/container-runtime": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/datastore": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/local-driver": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/map": "2.0.0-dev.7.4.0.214930",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/request-handler": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/routerlicious-driver": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/runtime-utils": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/test-driver-definitions": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.3.0.212138",
+    "@fluidframework/request-handler": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/routerlicious-driver": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/test-driver-definitions": "2.0.0-dev.7.4.0.214930",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.214930",
     "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.3.0.212138",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.214930",
     "@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",
@@ -73,6 +73,7 @@
     "@types/node": "^16.18.38",
     "@types/uuid": "^9.0.2",
     "c8": "^7.7.1",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "diff": "^3.5.0",
     "eslint": "~8.50.0",
@@ -84,14 +85,29 @@
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
+  },
   "typeValidation": {
     "broken": {}
   },
   "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:compile": "fluid-build . --task compile",
     "build:compile:min": "npm run build:compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "fluid-build . --task api",
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "ci:build:docs": "api-extractor run",
@@ -101,8 +117,8 @@
     "format": "npm run prettier:fix",
     "lint": "npm run prettier && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
     "test:mocha": "mocha  --recursive \"dist/test/*.spec.js\" --exit --project src/test/tsconfig.json -r node_modules/@fluidframework/mocha-test-setup",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",

package/src/containerUtils.ts

@@ -5,6 +5,8 @@
 
 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 { PromiseExecutor, timeoutPromise, TimeoutWithError } from "./timeoutUtils";
 
 /**
@@ -46,3 +48,17 @@ export async function waitForContainerConnection(
 			: timeoutPromise(executor, timeoutOptions);
 	}
 }
+
+/**
+ * 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
+ */
+export async function getContainerEntryPointBackCompat<T>(container: IContainer): Promise<T> {
+	if (container.getEntryPoint !== undefined) {
+		return (await container.getEntryPoint()) 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;
+}

package/src/index.ts

@@ -37,5 +37,5 @@ export {
 	TimeoutWithError,
 	TimeoutWithValue,
 } from "./timeoutUtils";
-export { waitForContainerConnection } from "./containerUtils";
+export { waitForContainerConnection, getContainerEntryPointBackCompat } from "./containerUtils";
 export { createContainerRuntimeFactoryWithDefaultDataStore } from "./testContainerRuntimeFactoryWithDefaultDataStore";

package/src/packageVersion.ts

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

package/src/testContainerRuntimeFactory.ts

@@ -61,7 +61,14 @@ export const createTestContainerRuntimeFactory = (
 			context: IContainerContext,
 			existing: boolean,
 		): Promise<IRuntime & IContainerRuntime> {
-			const runtime: ContainerRuntime = await containerRuntimeCtor.loadRuntime({
+			const provideEntryPoint = async (runtime: IContainerRuntime) => {
+				const entryPoint = await runtime.getAliasedDataStoreEntryPoint("default");
+				if (entryPoint === undefined) {
+					throw new Error("default dataStore must exist");
+				}
+				return entryPoint.get();
+			};
+			return containerRuntimeCtor.loadRuntime({
 				context,
 				registryEntries: [
 					["default", Promise.resolve(this.dataStoreFactory)],
@@ -73,15 +80,13 @@ export const createTestContainerRuntimeFactory = (
 					defaultRouteRequestHandler("default"),
 					...this.requestHandlers,
 				),
-				provideEntryPoint: () => {
-					throw new Error("TODO: AB#4993");
-				},
+				provideEntryPoint,
+				// ! This prop is needed for back-compat. Can be removed in 2.0.0-internal.8.0.0
+				initializeEntryPoint: provideEntryPoint,
 				runtimeOptions: this.runtimeOptions,
 				containerScope: context.scope,
 				existing,
-			});
-
-			return runtime;
+			} as any);
 		}
 	};
 };

package/src/testContainerRuntimeFactoryWithDefaultDataStore.ts

@@ -13,6 +13,14 @@ import {
 	NamedFluidDataStoreRegistryEntries,
 } from "@fluidframework/runtime-definitions";
 
+const getDefaultFluidObject = async (runtime: IContainerRuntime) => {
+	const entryPoint = await runtime.getAliasedDataStoreEntryPoint("default");
+	if (entryPoint === undefined) {
+		throw new Error("default dataStore must exist");
+	}
+	return entryPoint.get();
+};
+
 /**
  * ! Note: This function is purely needed for back-compat as the constructor argument structure was changed
  */
@@ -37,6 +45,7 @@ export const createContainerRuntimeFactoryWithDefaultDataStore = (
 			dependencyContainer,
 			requestHandlers,
 			runtimeOptions,
+			provideEntryPoint,
 		} = ctorArgs;
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
 		return new (Base as any)(
@@ -45,6 +54,7 @@ export const createContainerRuntimeFactoryWithDefaultDataStore = (
 			dependencyContainer,
 			requestHandlers,
 			runtimeOptions,
+			provideEntryPoint ?? getDefaultFluidObject,
 		);
 	}
 };

package/src/testFluidObject.ts

@@ -5,13 +5,7 @@
 
 // eslint-disable-next-line import/no-deprecated
 import { defaultFluidObjectRequestHandler } from "@fluidframework/aqueduct";
-import {
-	IRequest,
-	IResponse,
-	IFluidHandle,
-	FluidObject,
-	IProvideFluidRouter,
-} from "@fluidframework/core-interfaces";
+import { IRequest, IResponse, IFluidHandle } from "@fluidframework/core-interfaces";
 import {
 	FluidObjectHandle,
 	FluidDataStoreRuntime,
@@ -202,12 +196,13 @@ export class TestFluidObjectFactory implements IFluidDataStoreFactory {
 
 		const runtimeClass = mixinRequestHandler(
 			async (request: IRequest, rt: FluidDataStoreRuntime) => {
-				const maybeRouter: FluidObject<IProvideFluidRouter> = await rt.entryPoint.get();
+				// The provideEntryPoint callback below always returns FluidDataStoreRuntime, so this cast is safe
+				const dataObject = (await rt.entryPoint.get()) as FluidDataStoreRuntime;
 				assert(
-					maybeRouter.IFluidRouter !== undefined,
+					dataObject.request !== undefined,
 					"entryPoint should have been initialized by now",
 				);
-				return maybeRouter.IFluidRouter.request(request);
+				return dataObject.request(request);
 			},
 		);