@fluidframework/test-utils 2.22.1 → 2.23.0-325054

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/test-utils";
-export const pkgVersion = "2.22.1";
+export const pkgVersion = "2.23.0-325054";

package/src/testContainerRuntimeFactoryWithDefaultDataStore.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ContainerRuntimeFactoryWithDefaultDataStore } from "@fluidframework/aqueduct/internal";
+import type { IRuntimeFactory } from "@fluidframework/container-definitions/internal";
 import { IContainerRuntimeOptions } from "@fluidframework/container-runtime/internal";
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
 import { FluidObject } from "@fluidframework/core-interfaces";
@@ -23,25 +23,65 @@ const getDefaultFluidObject = async (runtime: IContainerRuntime) => {
 };
 
 /**
- * ! Note: This function is purely needed for back-compat as the constructor argument structure was changed
+ * {@link ContainerRuntimeFactoryWithDefaultDataStoreConstructor} input properties.
+ *
+ * @internal
+ */
+export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
+	readonly defaultFactory: IFluidDataStoreFactory;
+	/**
+	 * The data store registry for containers produced.
+	 */
+	readonly registryEntries: NamedFluidDataStoreRegistryEntries;
+
+	/**
+	 * @deprecated Do not use. This strictly exists for backwards compatibility.
+	 */
+	readonly dependencyContainer?: never;
+
+	/**
+	 * Request handlers for containers produced.
+	 * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
+	// eslint-disable-next-line import/no-deprecated
+	readonly requestHandlers?: RuntimeRequestHandler[];
+
+	/**
+	 * The runtime options passed to the IContainerRuntime when instantiating it
+	 */
+	readonly runtimeOptions?: IContainerRuntimeOptions;
+
+	/**
+	 * Function that will initialize the entryPoint of the IContainerRuntime instances
+	 * created with this factory
+	 */
+	readonly provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
+}
+
+/**
+ * {@link @fluidframework/container-definitions#IRuntimeFactory} construct signature.
+ *
+ * @internal
+ */
+export type ContainerRuntimeFactoryWithDefaultDataStoreConstructor = new (
+	props: ContainerRuntimeFactoryWithDefaultDataStoreProps,
+) => IRuntimeFactory;
+
+/**
+ * @remarks
+ * This function is purely needed for back-compat as the constructor argument structure of
+ * `ContainerRuntimeFactoryWithDefaultDataStore` was changed.
+ *
  * @internal
  */
 export const createContainerRuntimeFactoryWithDefaultDataStore = (
-	Base: typeof ContainerRuntimeFactoryWithDefaultDataStore = ContainerRuntimeFactoryWithDefaultDataStore,
-	ctorArgs: {
-		defaultFactory: IFluidDataStoreFactory;
-		registryEntries: NamedFluidDataStoreRegistryEntries;
-		dependencyContainer?: any;
-		// eslint-disable-next-line import/no-deprecated
-		requestHandlers?: RuntimeRequestHandler[];
-		runtimeOptions?: IContainerRuntimeOptions;
-		provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
-	},
-): ContainerRuntimeFactoryWithDefaultDataStore => {
+	ctor: ContainerRuntimeFactoryWithDefaultDataStoreConstructor,
+	ctorProps: ContainerRuntimeFactoryWithDefaultDataStoreProps,
+): IRuntimeFactory => {
 	try {
-		return new Base(ctorArgs);
+		return new ctor(ctorProps);
 	} catch (err) {
-		// IMPORTANT: The constructor argument structure changed, so this is needed for dynamically using older ContainerRuntimeFactoryWithDefaultDataStore's
+		// IMPORTANT: The constructor argument structure changed, so this is needed for dynamically using older `ContainerRuntimeFactoryWithDefaultDataStore`s
 		const {
 			defaultFactory,
 			registryEntries,
@@ -49,9 +89,9 @@ export const createContainerRuntimeFactoryWithDefaultDataStore = (
 			requestHandlers,
 			runtimeOptions,
 			provideEntryPoint,
-		} = ctorArgs;
+		} = ctorProps;
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
-		return new (Base as any)(
+		return new (ctor as any)(
 			defaultFactory,
 			registryEntries,
 			dependencyContainer,

package/src/testFluidObject.ts

@@ -72,11 +72,14 @@ export class TestFluidObject implements ITestFluidObject {
 			throw new Error("Shared objects were not provided during creation.");
 		}
 
-		for (const key of this.factoryEntriesMap.keys()) {
-			if (key === id) {
-				const handle = this.root.get<IFluidHandle>(id);
-				return handle?.get() as Promise<T>;
+		if (this.factoryEntriesMap.has(id)) {
+			const handle = this.root.get<IFluidHandle<T>>(id);
+			if (handle === undefined) {
+				throw new Error(
+					`Shared object with id '${id}' is in factoryEntriesMap but not found under root.`,
+				);
 			}
+			return handle.get();
 		}
 
 		throw new Error(`Shared object with id ${id} not found.`);
@@ -110,6 +113,7 @@ export class TestFluidObject implements ITestFluidObject {
 }
 
 /**
+ * Iterable\<[ChannelId, IChannelFactory]\>.
  * @internal
  */
 export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFactory]>;