@fluid-internal/test-driver-definitions 2.0.0-dev-rc.3.0.0.253463

package/.eslintrc.cjs

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json"],
+	},
+	overrides: [
+		{
+			// Rules only for test files
+			files: ["*.spec.ts", "src/test/**"],
+			rules: {
+				// This rule causes linting to crash with a "Error: Circularity detected while resolving configuration: /common/build/build-common/tsconfig.base.json"
+				"import/namespace": "off",
+			},
+		},
+	],
+};

package/CHANGELOG.md

@@ -0,0 +1,155 @@
+# @fluid-internal/test-driver-definitions
+
+## 2.0.0-rc.2.0.0
+
+Dependency updates only.
+
+## 2.0.0-rc.1.0.0
+
+### Minor Changes
+
+-   Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
+
+    The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
+
+    -   @fluidframework/gitresources
+    -   @fluidframework/server-kafka-orderer
+    -   @fluidframework/server-lambdas
+    -   @fluidframework/server-lambdas-driver
+    -   @fluidframework/server-local-server
+    -   @fluidframework/server-memory-orderer
+    -   @fluidframework/protocol-base
+    -   @fluidframework/server-routerlicious
+    -   @fluidframework/server-routerlicious-base
+    -   @fluidframework/server-services
+    -   @fluidframework/server-services-client
+    -   @fluidframework/server-services-core
+    -   @fluidframework/server-services-ordering-kafkanode
+    -   @fluidframework/server-services-ordering-rdkafka
+    -   @fluidframework/server-services-ordering-zookeeper
+    -   @fluidframework/server-services-shared
+    -   @fluidframework/server-services-telemetry
+    -   @fluidframework/server-services-utils
+    -   @fluidframework/server-test-utils
+    -   tinylicious
+
+-   Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
+
+    The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
+    changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @fluid-internal/test-driver-definitions
+
+Definitions for test drivers. Test should only take a dependency on these definitions, and not the implementations provided in the `@fluid-private/test-drivers` package. At runtime the environment should provide an implementation for the global getFluidTestDriver driver function, which tests can then use to access the implementation.

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
+}

package/api-extractor.json

@@ -0,0 +1,8 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json",
+	"dtsRollup": {
+		// all APIs are internal - no rollup needed/used
+		"enabled": false
+	}
+}

package/api-report/test-driver-definitions.api.md

@@ -0,0 +1,45 @@
+## API Report File for "@fluid-internal/test-driver-definitions"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { IUrlResolver } from '@fluidframework/driver-definitions/internal';
+
+// @internal
+export type DriverEndpoint = RouterliciousEndpoint | OdspEndpoint;
+
+// @internal
+export interface ITelemetryBufferedLogger extends ITelemetryBaseLogger {
+    flush(): Promise<void>;
+}
+
+// @internal
+export interface ITestDriver {
+    createContainerUrl(testId: string, containerUrl?: IResolvedUrl): Promise<string>;
+    createCreateNewRequest(testId?: string): IRequest;
+    createDocumentServiceFactory(): IDocumentServiceFactory;
+    createUrlResolver(): IUrlResolver;
+    readonly endpointName?: string;
+    readonly tenantName?: string;
+    readonly type: TestDriverTypes;
+    readonly userIndex?: number;
+    readonly version: string;
+}
+
+// @internal
+export type OdspEndpoint = "odsp" | "odsp-df";
+
+// @internal
+export type RouterliciousEndpoint = "frs" | "frsCanary" | "r11s" | "docker";
+
+// @internal
+export type TestDriverTypes = "tinylicious" | "t9s" | "routerlicious" | "r11s" | "odsp" | "local";
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ITelemetryBufferedLogger } from "./interfaces.js";
+declare global {
+    /**
+     * This function may be provided by the environment, like a mocha test hook or dynamic import
+     */
+    export const getTestLogger: (() => ITelemetryBufferedLogger) | undefined;
+}
+export type { DriverEndpoint, ITelemetryBufferedLogger, ITestDriver, OdspEndpoint, RouterliciousEndpoint, TestDriverTypes, } from "./interfaces.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE,OAAO,CAAC,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,MAAM,aAAa,EAAE,CAAC,MAAM,wBAAwB,CAAC,GAAG,SAAS,CAAC;CACzE;AAED,YAAY,EACX,cAAc,EACd,wBAAwB,EACxB,WAAW,EACX,YAAY,EACZ,qBAAqB,EACrB,eAAe,GACf,MAAM,iBAAiB,CAAC"}

package/dist/interfaces.d.ts

@@ -0,0 +1,108 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IRequest, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IDocumentServiceFactory, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions/internal";
+/**
+ * Types of test drivers.
+ * These values are replicated in {@link @fluid-private/test-version-utils#compatOptions.d.ts}. Ensure that any revisions here are also reflected in test-version-utils.
+ * @internal
+ */
+export type TestDriverTypes = "tinylicious" | "t9s" | "routerlicious" | "r11s" | "odsp" | "local";
+/**
+ * Types of Routerlicious endpoints.
+ * These values are replicated in {@link @fluid-private/test-version-utils#compatOptions.d.ts}. Ensure that any revisions here are also reflected in test-version-utils.
+ * @internal
+ */
+export type RouterliciousEndpoint = "frs" | "frsCanary" | "r11s" | "docker";
+/**
+ * Types of Odsp endpoints.
+ * @internal
+ */
+export type OdspEndpoint = "odsp" | "odsp-df";
+/**
+ * Types of Driver endpoints.
+ * @internal
+ */
+export type DriverEndpoint = RouterliciousEndpoint | OdspEndpoint;
+/**
+ * Base interface for test drivers.
+ * @internal
+ */
+export interface ITestDriver {
+    /**
+     * The type of server the test driver executes against
+     */
+    readonly type: TestDriverTypes;
+    /**
+     * Specific endpoint name if there are any
+     */
+    readonly endpointName?: string;
+    /**
+     * Tenant name if there are any
+     */
+    readonly tenantName?: string;
+    /**
+     * User index if there are any
+     */
+    readonly userIndex?: number;
+    /**
+     * The semantic version of the test drivers package.
+     * In general this version will match that of the  client
+     * interfaces and implementation exposed and used by the test driver.
+     */
+    readonly version: string;
+    /**
+     * Creates a document service factory targetting the server that corresponds to this driver.
+     */
+    createDocumentServiceFactory(): IDocumentServiceFactory;
+    /**
+     * Creates a url resolver targetting the server that corresponds to this driver.
+     */
+    createUrlResolver(): IUrlResolver;
+    /**
+     * Creates a 'create new' request appropriate for the server that corresponds to this driver.
+     *
+     * @remarks
+     * Repeated calls with the same test id will return the same request.
+     * The test id may not map directly to any specific Fluid Framework concept.
+     * If you need more control you should disambiguate the driver based on its
+     * type; this should only be done it absolutely necessary for complex scenarios
+     * as the test may not work against all supported servers if done.
+     *
+     * @param testId - If passed in, implementations should use it in the generated request, which should
+     * also be consistent every time for a given value of this parameter.
+     */
+    createCreateNewRequest(testId?: string): IRequest;
+    /**
+     * Creates a container url that can be resolved by the url resolver for this driver.
+     *
+     * @remarks
+     * Repeated calls with the same test id will return the same container url.
+     * The test id may not map directly to any specific Fluid Framework concept.
+     * If you need more control you should disambiguate the driver based on its
+     * type; this should only be done if absolutely necessary for complex scenarios
+     * as the test may not work against all supported servers if done.
+     *
+     * @param testId - If passed in, implementations should use it in generated url, which should
+     * also be consistent every time for a given value of this parameter.
+     * @param containerUrl - Implementations can use this to help disambiguate the container.
+     * E.g. if passed a value from a container created earlier, the driver can us it as a hint
+     * when resolving the container  URL.
+     */
+    createContainerUrl(testId: string, containerUrl?: IResolvedUrl): Promise<string>;
+}
+/**
+ * Extension of ITelemetryBaseLogger with support for flushing
+ * all buffered logs that have not yet been fully processed (e.g. uploaded)
+ * @internal
+ */
+export interface ITelemetryBufferedLogger extends ITelemetryBaseLogger {
+    /**
+     * Flush any underlying buffer of events that have been sent so far
+     * but not yet fully processed - e.g. uploaded to a log ingestion service.
+     */
+    flush(): Promise<void>;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACtF,OAAO,KAAK,EACX,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,MAAM,6CAA6C,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,KAAK,GAAG,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAElG;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE5E;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,YAAY,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,4BAA4B,IAAI,uBAAuB,CAAC;IAExD;;OAEG;IACH,iBAAiB,IAAI,YAAY,CAAC;IAElC;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAElD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACjF;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACrE;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB"}

package/dist/package.json

@@ -0,0 +1,3 @@
+{
+	"type": "commonjs"
+}

package/lib/index.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ITelemetryBufferedLogger } from "./interfaces.js";
+declare global {
+    /**
+     * This function may be provided by the environment, like a mocha test hook or dynamic import
+     */
+    export const getTestLogger: (() => ITelemetryBufferedLogger) | undefined;
+}
+export type { DriverEndpoint, ITelemetryBufferedLogger, ITestDriver, OdspEndpoint, RouterliciousEndpoint, TestDriverTypes, } from "./interfaces.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE,OAAO,CAAC,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,MAAM,aAAa,EAAE,CAAC,MAAM,wBAAwB,CAAC,GAAG,SAAS,CAAC;CACzE;AAED,YAAY,EACX,cAAc,EACd,wBAAwB,EACxB,WAAW,EACX,YAAY,EACZ,qBAAqB,EACrB,eAAe,GACf,MAAM,iBAAiB,CAAC"}

package/lib/interfaces.d.ts

@@ -0,0 +1,108 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IRequest, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IDocumentServiceFactory, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions/internal";
+/**
+ * Types of test drivers.
+ * These values are replicated in {@link @fluid-private/test-version-utils#compatOptions.d.ts}. Ensure that any revisions here are also reflected in test-version-utils.
+ * @internal
+ */
+export type TestDriverTypes = "tinylicious" | "t9s" | "routerlicious" | "r11s" | "odsp" | "local";
+/**
+ * Types of Routerlicious endpoints.
+ * These values are replicated in {@link @fluid-private/test-version-utils#compatOptions.d.ts}. Ensure that any revisions here are also reflected in test-version-utils.
+ * @internal
+ */
+export type RouterliciousEndpoint = "frs" | "frsCanary" | "r11s" | "docker";
+/**
+ * Types of Odsp endpoints.
+ * @internal
+ */
+export type OdspEndpoint = "odsp" | "odsp-df";
+/**
+ * Types of Driver endpoints.
+ * @internal
+ */
+export type DriverEndpoint = RouterliciousEndpoint | OdspEndpoint;
+/**
+ * Base interface for test drivers.
+ * @internal
+ */
+export interface ITestDriver {
+    /**
+     * The type of server the test driver executes against
+     */
+    readonly type: TestDriverTypes;
+    /**
+     * Specific endpoint name if there are any
+     */
+    readonly endpointName?: string;
+    /**
+     * Tenant name if there are any
+     */
+    readonly tenantName?: string;
+    /**
+     * User index if there are any
+     */
+    readonly userIndex?: number;
+    /**
+     * The semantic version of the test drivers package.
+     * In general this version will match that of the  client
+     * interfaces and implementation exposed and used by the test driver.
+     */
+    readonly version: string;
+    /**
+     * Creates a document service factory targetting the server that corresponds to this driver.
+     */
+    createDocumentServiceFactory(): IDocumentServiceFactory;
+    /**
+     * Creates a url resolver targetting the server that corresponds to this driver.
+     */
+    createUrlResolver(): IUrlResolver;
+    /**
+     * Creates a 'create new' request appropriate for the server that corresponds to this driver.
+     *
+     * @remarks
+     * Repeated calls with the same test id will return the same request.
+     * The test id may not map directly to any specific Fluid Framework concept.
+     * If you need more control you should disambiguate the driver based on its
+     * type; this should only be done it absolutely necessary for complex scenarios
+     * as the test may not work against all supported servers if done.
+     *
+     * @param testId - If passed in, implementations should use it in the generated request, which should
+     * also be consistent every time for a given value of this parameter.
+     */
+    createCreateNewRequest(testId?: string): IRequest;
+    /**
+     * Creates a container url that can be resolved by the url resolver for this driver.
+     *
+     * @remarks
+     * Repeated calls with the same test id will return the same container url.
+     * The test id may not map directly to any specific Fluid Framework concept.
+     * If you need more control you should disambiguate the driver based on its
+     * type; this should only be done if absolutely necessary for complex scenarios
+     * as the test may not work against all supported servers if done.
+     *
+     * @param testId - If passed in, implementations should use it in generated url, which should
+     * also be consistent every time for a given value of this parameter.
+     * @param containerUrl - Implementations can use this to help disambiguate the container.
+     * E.g. if passed a value from a container created earlier, the driver can us it as a hint
+     * when resolving the container  URL.
+     */
+    createContainerUrl(testId: string, containerUrl?: IResolvedUrl): Promise<string>;
+}
+/**
+ * Extension of ITelemetryBaseLogger with support for flushing
+ * all buffered logs that have not yet been fully processed (e.g. uploaded)
+ * @internal
+ */
+export interface ITelemetryBufferedLogger extends ITelemetryBaseLogger {
+    /**
+     * Flush any underlying buffer of events that have been sent so far
+     * but not yet fully processed - e.g. uploaded to a log ingestion service.
+     */
+    flush(): Promise<void>;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/lib/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACtF,OAAO,KAAK,EACX,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,MAAM,6CAA6C,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,KAAK,GAAG,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAElG;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE5E;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,YAAY,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,4BAA4B,IAAI,uBAAuB,CAAC;IAExD;;OAEG;IACH,iBAAiB,IAAI,YAAY,CAAC;IAElC;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAElD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACjF;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACrE;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB"}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.42.3"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@fluid-internal/test-driver-definitions",
+  "version": "2.0.0-dev-rc.3.0.0.253463",
+  "description": "A driver abstraction and implementations for testing against server",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/test/test-driver-definitions"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts"
+      },
+      "require": {
+        "types": "./dist/index.d.ts"
+      }
+    }
+  },
+  "main": "",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.253463",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.253463",
+    "@fluidframework/protocol-definitions": "^3.2.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.15.2",
+    "@biomejs/biome": "^1.6.2",
+    "@fluid-tools/build-cli": "^0.34.0",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
+    "@microsoft/api-extractor": "^7.42.3",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.55.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.1.6"
+  },
+  "typeValidation": {
+    "disabled": true,
+    "broken": {}
+  },
+  "scripts": {
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:compile:min": "npm run build:compile",
+    "build:docs": "api-extractor run --local",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "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",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "fluid-build --task format .",
+    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "lint": "fluid-build . --task lint",
+    "lint:fix": "fluid-build . --task eslint:fix --task format",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist"
+  }
+}

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/index.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { ITelemetryBufferedLogger } from "./interfaces.js";
+
+declare global {
+	/**
+	 * This function may be provided by the environment, like a mocha test hook or dynamic import
+	 */
+	export const getTestLogger: (() => ITelemetryBufferedLogger) | undefined;
+}
+
+export type {
+	DriverEndpoint,
+	ITelemetryBufferedLogger,
+	ITestDriver,
+	OdspEndpoint,
+	RouterliciousEndpoint,
+	TestDriverTypes,
+} from "./interfaces.js";

package/src/interfaces.ts

@@ -0,0 +1,126 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { IRequest, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type {
+	IDocumentServiceFactory,
+	IResolvedUrl,
+	IUrlResolver,
+} from "@fluidframework/driver-definitions/internal";
+
+/**
+ * Types of test drivers.
+ * These values are replicated in {@link @fluid-private/test-version-utils#compatOptions.d.ts}. Ensure that any revisions here are also reflected in test-version-utils.
+ * @internal
+ */
+export type TestDriverTypes = "tinylicious" | "t9s" | "routerlicious" | "r11s" | "odsp" | "local";
+
+/**
+ * Types of Routerlicious endpoints.
+ * These values are replicated in {@link @fluid-private/test-version-utils#compatOptions.d.ts}. Ensure that any revisions here are also reflected in test-version-utils.
+ * @internal
+ */
+export type RouterliciousEndpoint = "frs" | "frsCanary" | "r11s" | "docker";
+
+/**
+ * Types of Odsp endpoints.
+ * @internal
+ */
+export type OdspEndpoint = "odsp" | "odsp-df";
+
+/**
+ * Types of Driver endpoints.
+ * @internal
+ */
+export type DriverEndpoint = RouterliciousEndpoint | OdspEndpoint;
+
+/**
+ * Base interface for test drivers.
+ * @internal
+ */
+export interface ITestDriver {
+	/**
+	 * The type of server the test driver executes against
+	 */
+	readonly type: TestDriverTypes;
+
+	/**
+	 * Specific endpoint name if there are any
+	 */
+	readonly endpointName?: string;
+
+	/**
+	 * Tenant name if there are any
+	 */
+	readonly tenantName?: string;
+
+	/**
+	 * User index if there are any
+	 */
+	readonly userIndex?: number;
+
+	/**
+	 * The semantic version of the test drivers package.
+	 * In general this version will match that of the  client
+	 * interfaces and implementation exposed and used by the test driver.
+	 */
+	readonly version: string;
+
+	/**
+	 * Creates a document service factory targetting the server that corresponds to this driver.
+	 */
+	createDocumentServiceFactory(): IDocumentServiceFactory;
+
+	/**
+	 * Creates a url resolver targetting the server that corresponds to this driver.
+	 */
+	createUrlResolver(): IUrlResolver;
+
+	/**
+	 * Creates a 'create new' request appropriate for the server that corresponds to this driver.
+	 *
+	 * @remarks
+	 * Repeated calls with the same test id will return the same request.
+	 * The test id may not map directly to any specific Fluid Framework concept.
+	 * If you need more control you should disambiguate the driver based on its
+	 * type; this should only be done it absolutely necessary for complex scenarios
+	 * as the test may not work against all supported servers if done.
+	 *
+	 * @param testId - If passed in, implementations should use it in the generated request, which should
+	 * also be consistent every time for a given value of this parameter.
+	 */
+	createCreateNewRequest(testId?: string): IRequest;
+
+	/**
+	 * Creates a container url that can be resolved by the url resolver for this driver.
+	 *
+	 * @remarks
+	 * Repeated calls with the same test id will return the same container url.
+	 * The test id may not map directly to any specific Fluid Framework concept.
+	 * If you need more control you should disambiguate the driver based on its
+	 * type; this should only be done if absolutely necessary for complex scenarios
+	 * as the test may not work against all supported servers if done.
+	 *
+	 * @param testId - If passed in, implementations should use it in generated url, which should
+	 * also be consistent every time for a given value of this parameter.
+	 * @param containerUrl - Implementations can use this to help disambiguate the container.
+	 * E.g. if passed a value from a container created earlier, the driver can us it as a hint
+	 * when resolving the container  URL.
+	 */
+	createContainerUrl(testId: string, containerUrl?: IResolvedUrl): Promise<string>;
+}
+
+/**
+ * Extension of ITelemetryBaseLogger with support for flushing
+ * all buffered logs that have not yet been fully processed (e.g. uploaded)
+ * @internal
+ */
+export interface ITelemetryBufferedLogger extends ITelemetryBaseLogger {
+	/**
+	 * Flush any underlying buffer of events that have been sent so far
+	 * but not yet fully processed - e.g. uploaded to a log ingestion service.
+	 */
+	flush(): Promise<void>;
+}

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+	// This config must be used in a "type": "commonjs" environment. (Use fluid-tsc commonjs.)
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./dist",
+	},
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"include": ["src/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./lib",
+		"emitDeclarationOnly": true,
+	},
+}