@fluidframework/test-utils 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/test-utils",
-  "version": "1.4.0-115997",
+  "version": "2.0.0-dev-rc.1.0.0.224419",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -12,38 +12,18 @@
   "author": "Microsoft and contributors",
   "sideEffects": false,
   "main": "dist/index.js",
-  "module": "lib/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile:min": "npm run build:compile",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:genver": "gen-version",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir . --no-generateInName",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
-  "nyc": {
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
-      "src/test/**/*.ts",
-      "dist/test/**/*.js"
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
     ],
     "exclude-after-remap": false,
     "include": [
-      "src/**/*.ts",
-      "dist/**/*.js"
+      "src/**/*.*ts",
+      "dist/**/*.*js"
     ],
     "report-dir": "nyc/report",
     "reporter": [
@@ -54,57 +34,111 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "1.4.0-115997",
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "1.4.0-115997",
-    "@fluidframework/container-loader": "1.4.0-115997",
-    "@fluidframework/container-runtime": "1.4.0-115997",
-    "@fluidframework/container-runtime-definitions": "1.4.0-115997",
-    "@fluidframework/core-interfaces": "1.4.0-115997",
-    "@fluidframework/datastore": "1.4.0-115997",
-    "@fluidframework/datastore-definitions": "1.4.0-115997",
-    "@fluidframework/driver-definitions": "1.4.0-115997",
-    "@fluidframework/driver-utils": "1.4.0-115997",
-    "@fluidframework/local-driver": "1.4.0-115997",
-    "@fluidframework/map": "1.4.0-115997",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/request-handler": "1.4.0-115997",
-    "@fluidframework/routerlicious-driver": "1.4.0-115997",
-    "@fluidframework/runtime-definitions": "1.4.0-115997",
-    "@fluidframework/runtime-utils": "1.4.0-115997",
-    "@fluidframework/telemetry-utils": "1.4.0-115997",
-    "@fluidframework/test-driver-definitions": "1.4.0-115997",
-    "@fluidframework/test-runtime-utils": "1.4.0-115997",
-    "debug": "^4.1.1",
-    "uuid": "^8.3.1"
+    "@fluidframework/aqueduct": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/container-loader": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/container-runtime": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/datastore": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/local-driver": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/map": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/request-handler": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/routerlicious-driver": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/runtime-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/test-driver-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "best-random": "^1.0.0",
+    "debug": "^4.3.4",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/test-utils-previous": "npm:@fluidframework/test-utils@1.3.1",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.224419",
+    "@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",
     "@types/diff": "^3.5.1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
-    "@types/random-js": "^1.0.31",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "@types/node": "^18.19.0",
+    "@types/uuid": "^9.0.2",
+    "c8": "^7.7.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
     "diff": "^3.5.0",
-    "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
-    "random-js": "^1.0.8",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "eslint": "~8.50.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
   },
   "typeValidation": {
-    "version": "1.4.0",
-    "baselineRange": "~1.3.0",
-    "baselineVersion": "1.3.1",
-    "broken": {}
+    "broken": {
+      "ClassDeclaration_TestFluidObject": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_ITestObjectProvider": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "ClassDeclaration_TestObjectProvider": {
+        "backCompat": false,
+        "forwardCompat": false
+      }
+    }
+  },
+  "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": "fluid-build . --task api",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack",
+    "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 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",
+    "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",
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
-}
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/DriverWrappers.ts

@@ -0,0 +1,83 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import {
+	IDocumentService,
+	IDocumentServiceFactory,
+	IDocumentStorageService,
+	IResolvedUrl,
+	ISummaryContext,
+} from "@fluidframework/driver-definitions";
+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,
+	uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,
+) {
+	const outerDocStorageService = Object.create(innerDocStorageService) as IDocumentStorageService;
+	outerDocStorageService.uploadSummaryWithContext = async (
+		summary: ISummaryTree,
+		context: ISummaryContext,
+	): Promise<string> => {
+		const newContext = uploadSummaryCb(summary, context);
+		return innerDocStorageService.uploadSummaryWithContext(summary, newContext);
+	};
+	return outerDocStorageService;
+}
+
+/**
+ * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the
+ * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by
+ * 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,
+	uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,
+) {
+	const outerDocService = Object.create(innerDocService) as IDocumentService;
+	outerDocService.connectToStorage = async (): Promise<IDocumentStorageService> => {
+		const storageService = await innerDocService.connectToStorage();
+		return wrapDocumentStorageService(storageService, uploadSummaryCb);
+	};
+	return outerDocService;
+}
+
+/**
+ * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb
+ * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is
+ * 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,
+	uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,
+) {
+	const outerDocServiceFactory = Object.create(innerDocServiceFactory) as IDocumentServiceFactory;
+	outerDocServiceFactory.createDocumentService = async (
+		resolvedUrl: IResolvedUrl,
+		logger?: ITelemetryBaseLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService> => {
+		const documentService = await innerDocServiceFactory.createDocumentService(
+			resolvedUrl,
+			logger,
+			clientIsSummarizer,
+		);
+		return wrapDocumentService(documentService, uploadSummaryCb);
+	};
+	return outerDocServiceFactory;
+}

package/src/TestConfigs.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ConfigTypes, IConfigProviderBase } from "@fluidframework/core-interfaces";
+
+/**
+ * @internal
+ */
+export const mockConfigProvider = (
+	settings: Record<string, ConfigTypes> = {},
+): IConfigProviderBase => {
+	return {
+		getRawConfig: (name: string): ConfigTypes => settings[name],
+	};
+};

package/src/TestSummaryUtils.ts

@@ -0,0 +1,210 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ContainerRuntimeFactoryWithDefaultDataStore } from "@fluidframework/aqueduct";
+import { assert } from "@fluidframework/core-utils";
+import { IContainer, IHostLoader, LoaderHeader } from "@fluidframework/container-definitions";
+import {
+	IOnDemandSummarizeOptions,
+	ISummarizer,
+	ISummaryRuntimeOptions,
+} from "@fluidframework/container-runtime";
+import {
+	ITelemetryBaseLogger,
+	FluidObject,
+	IRequest,
+	IConfigProviderBase,
+} from "@fluidframework/core-interfaces";
+import { DriverHeader } from "@fluidframework/driver-definitions";
+import {
+	IFluidDataStoreFactory,
+	NamedFluidDataStoreRegistryEntries,
+} from "@fluidframework/runtime-definitions";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { ITestContainerConfig, ITestObjectProvider } from "./testObjectProvider";
+import { mockConfigProvider } from "./TestConfigs";
+import { waitForContainerConnection } from "./containerUtils";
+import { timeoutAwait } from "./timeoutUtils";
+import { createContainerRuntimeFactoryWithDefaultDataStore } from "./testContainerRuntimeFactoryWithDefaultDataStore";
+
+const summarizerClientType = "summarizer";
+
+async function createSummarizerCore(
+	container: IContainer,
+	loader: IHostLoader,
+	summaryVersion?: string,
+) {
+	const absoluteUrl = await container.getAbsoluteUrl("");
+	if (absoluteUrl === undefined) {
+		throw new Error("URL could not be resolved");
+	}
+
+	const request: IRequest = {
+		headers: {
+			[LoaderHeader.cache]: false,
+			[LoaderHeader.clientDetails]: {
+				capabilities: { interactive: false },
+				type: summarizerClientType,
+			},
+			[DriverHeader.summarizingClient]: true,
+			[LoaderHeader.version]: summaryVersion,
+		},
+		url: absoluteUrl,
+	};
+	const summarizerContainer = await loader.resolve(request);
+	await waitForContainerConnection(summarizerContainer);
+
+	const fluidObject: FluidObject<ISummarizer> | undefined =
+		await summarizerContainer.getEntryPoint();
+	if (fluidObject?.ISummarizer === undefined) {
+		throw new Error("Fluid object does not implement ISummarizer");
+	}
+
+	return {
+		container: summarizerContainer,
+		summarizer: fluidObject.ISummarizer,
+	};
+}
+
+const defaultSummaryOptions: ISummaryRuntimeOptions = {
+	summaryConfigOverrides: {
+		state: "disableHeuristics",
+		maxAckWaitTime: 20000, // Some of the AFR tests take a long time to ack.
+		maxOpsSinceLastSummary: 7000,
+		initialSummarizerDelayMs: 0,
+	},
+};
+
+/**
+ * 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,
+	container: IContainer,
+	dataStoreFactory: IFluidDataStoreFactory,
+	summaryVersion?: string,
+	containerRuntimeFactoryType = ContainerRuntimeFactoryWithDefaultDataStore,
+	registryEntries?: NamedFluidDataStoreRegistryEntries,
+	logger?: ITelemetryBaseLogger,
+	configProvider: IConfigProviderBase = mockConfigProvider(),
+): Promise<{ container: IContainer; summarizer: ISummarizer }> {
+	const runtimeFactory = createContainerRuntimeFactoryWithDefaultDataStore(
+		containerRuntimeFactoryType,
+		{
+			defaultFactory: dataStoreFactory,
+			registryEntries: registryEntries ?? [
+				[dataStoreFactory.type, Promise.resolve(dataStoreFactory)],
+			],
+			runtimeOptions: { summaryOptions: defaultSummaryOptions },
+		},
+	);
+
+	const loader = provider.createLoader([[provider.defaultCodeDetails, runtimeFactory]], {
+		configProvider,
+		logger,
+	});
+	return createSummarizerCore(container, loader, summaryVersion);
+}
+
+/**
+ * Creates a summarizer client from the given container 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.
+ *
+ * Can pass in a test config provider to enable/disable features.
+ * @internal
+ */
+export async function createSummarizer(
+	provider: ITestObjectProvider,
+	container: IContainer,
+	config?: ITestContainerConfig,
+	summaryVersion?: string,
+	logger?: ITelemetryBaseLogger,
+): Promise<{ container: IContainer; summarizer: ISummarizer }> {
+	const testContainerConfig: ITestContainerConfig = {
+		...config,
+		runtimeOptions: {
+			...config?.runtimeOptions,
+			summaryOptions: config?.runtimeOptions?.summaryOptions ?? defaultSummaryOptions,
+		},
+		loaderProps: {
+			...config?.loaderProps,
+			configProvider: config?.loaderProps?.configProvider ?? mockConfigProvider(),
+			logger,
+		},
+	};
+	const loader = provider.makeTestLoader(testContainerConfig);
+	return createSummarizerCore(container, loader, summaryVersion);
+}
+
+/**
+ * Summarizes on demand and returns the summary tree, the version number and the reference sequence number of the
+ * submitted summary.
+ *
+ * @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,
+	inputs: string | IOnDemandSummarizeOptions = "end-to-end test",
+): Promise<SummaryInfo> {
+	const options: IOnDemandSummarizeOptions =
+		typeof inputs === "string" ? { reason: inputs } : inputs;
+	const result = summarizer.summarizeOnDemand(options);
+
+	const submitResult = await timeoutAwait(result.summarySubmitted);
+	if (!submitResult.success) {
+		if (typeof submitResult.error !== "string") {
+			submitResult.error.data = submitResult.data;
+		}
+		throw submitResult.error;
+	}
+	assert(
+		submitResult.data.stage === "submit",
+		"on-demand summary submitted data stage should be submit",
+	);
+	assert(submitResult.data.summaryTree !== undefined, "summary tree should exist");
+
+	const broadcastResult = await timeoutAwait(result.summaryOpBroadcasted);
+	if (!broadcastResult.success) {
+		throw broadcastResult.error;
+	}
+
+	const ackNackResult = await timeoutAwait(result.receivedSummaryAckOrNack);
+	if (!ackNackResult.success) {
+		throw ackNackResult.error;
+	}
+
+	await new Promise((resolve) => process.nextTick(resolve));
+
+	return {
+		summaryTree: submitResult.data.summaryTree,
+		summaryVersion: ackNackResult.data.summaryAckOp.contents.handle,
+		summaryRefSeq: submitResult.data.referenceSequenceNumber,
+	};
+}
+
+/**
+ * Summary information containing the summary tree, summary version, and summary sequence number.
+ * @internal
+ */
+export interface SummaryInfo {
+	/**
+	 * The summary tree generated
+	 */
+	summaryTree: ISummaryTree;
+	/**
+	 * Handle of the completed summary
+	 */
+	summaryVersion: string;
+	/**
+	 * Reference sequence number of the current summary generation
+	 */
+	summaryRefSeq: number;
+}

package/src/containerUtils.ts

@@ -0,0 +1,90 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+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";
+
+/**
+ * Utility function to wait for the specified Container to be in Connected state.
+ * If the Container is already connected, the Promise returns immediately; otherwise it resolves when the Container emits
+ * its 'connected' event.
+ * If failOnContainerClose === true, the returned Promise will be rejected if the container emits a 'closed' event
+ * before a 'connected' event.
+ * @param container - The container to wait for.
+ * @param failOnContainerClose - If true, the returned Promise will be rejected if the container emits a 'closed' event
+ * before a 'connected' event.
+ * Defaults to true.
+ * @param timeoutOptions - Options related to the behavior of the timeout.
+ * If provided, the returned Promise will reject if the container hasn't emitted relevant events in timeoutOptions.durationMs.
+ * If not provided, the Promise will wait indefinitely for the Container to emit its 'connected' (or 'closed', if
+ * failOnContainerClose === true) event.
+ *
+ * @returns A Promise that either:
+ * - Resolves when the specified container emits a 'connected' event (or immediately if the Container is already connected).
+ * - 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,
+	failOnContainerClose: boolean = true,
+	timeoutOptions?: TimeoutWithError,
+): Promise<void> {
+	if (container.connectionState !== ConnectionState.Connected) {
+		const executor: PromiseExecutor = (resolve, reject) => {
+			container.once("connected", () => resolve());
+			if (failOnContainerClose) {
+				container.once("closed", (error) => reject(error));
+			}
+		};
+
+		return timeoutOptions === undefined
+			? new Promise(executor)
+			: 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
+ * @internal
+ */
+export async function getContainerEntryPointBackCompat<T>(container: IContainer): Promise<T> {
+	if (container.getEntryPoint !== undefined) {
+		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;
+}