@fluidframework/test-utils 2.0.0-internal.7.0.0 → 2.0.0-internal.7.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/test-utils
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.0.0
 
 ### Major Changes

package/api-extractor.json

@@ -1,4 +1,12 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json",
+	"messages": {
+		"extractorMessageReporting": {
+			"ae-missing-release-tag": {
+				// TODO: Fix violations and remove this rule override
+				"logLevel": "none"
+			}
+		}
+	}
 }

package/api-report/test-utils.api.md

@@ -0,0 +1,385 @@
+## API Report File for "@fluidframework/test-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ConfigTypes } from '@fluidframework/telemetry-utils';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { ContainerRuntimeFactoryWithDefaultDataStore } from '@fluidframework/aqueduct';
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
+import { IConfigProviderBase } from '@fluidframework/telemetry-utils';
+import { IContainer } from '@fluidframework/container-definitions';
+import { IContainerContext } from '@fluidframework/container-definitions';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { IContainerRuntimeOptions } from '@fluidframework/container-runtime';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IFluidCodeDetails } from '@fluidframework/container-definitions';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { IFluidModule } from '@fluidframework/container-definitions';
+import { IFluidModuleWithDetails } from '@fluidframework/container-definitions';
+import { IHostLoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { ILoaderProps } from '@fluidframework/container-loader';
+import { IOnDemandSummarizeOptions } from '@fluidframework/container-runtime';
+import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
+import { IProvideFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
+import { IProvideRuntimeFactory } from '@fluidframework/container-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IRequestHeader } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { IRuntime } from '@fluidframework/container-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import { ISummarizer } from '@fluidframework/container-runtime';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryGenericEvent } from '@fluidframework/core-interfaces';
+import { ITestDriver } from '@fluidframework/test-driver-definitions';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { Loader } from '@fluidframework/container-loader';
+import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
+import { RuntimeRequestHandler } from '@fluidframework/request-handler';
+
+// @public (undocumented)
+export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFactory]>;
+
+// @public
+export function createAndAttachContainer(source: IFluidCodeDetails, loader: IHostLoader, attachRequest: IRequest): Promise<IContainer>;
+
+// @public
+export const createContainerRuntimeFactoryWithDefaultDataStore: (Base: typeof ContainerRuntimeFactoryWithDefaultDataStore | undefined, ctorArgs: {
+    defaultFactory: IFluidDataStoreFactory;
+    registryEntries: NamedFluidDataStoreRegistryEntries;
+    dependencyContainer?: any;
+    requestHandlers?: RuntimeRequestHandler[] | undefined;
+    runtimeOptions?: IContainerRuntimeOptions | undefined;
+    provideEntryPoint?: ((runtime: IContainerRuntime) => Promise<FluidObject>) | undefined;
+}) => ContainerRuntimeFactoryWithDefaultDataStore;
+
+// @public (undocumented)
+export const createDocumentId: () => string;
+
+// @public
+export function createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, documentServiceFactory: IDocumentServiceFactory, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger, options?: ILoaderOptions): IHostLoader;
+
+// @public
+export function createSummarizer(provider: ITestObjectProvider, container: IContainer, config?: ITestContainerConfig, summaryVersion?: string, logger?: ITelemetryBaseLogger): Promise<{
+    container: IContainer;
+    summarizer: ISummarizer;
+}>;
+
+// @public
+export function createSummarizerFromFactory(provider: ITestObjectProvider, container: IContainer, dataStoreFactory: IFluidDataStoreFactory, summaryVersion?: string, containerRuntimeFactoryType?: typeof ContainerRuntimeFactoryWithDefaultDataStore, registryEntries?: NamedFluidDataStoreRegistryEntries, logger?: ITelemetryBaseLogger, configProvider?: IConfigProviderBase): Promise<{
+    container: IContainer;
+    summarizer: ISummarizer;
+}>;
+
+// @public
+export const createTestContainerRuntimeFactory: (containerRuntimeCtor: typeof ContainerRuntime) => {
+    new (type: string, dataStoreFactory: IFluidDataStoreFactory, runtimeOptions?: IContainerRuntimeOptions, requestHandlers?: RuntimeRequestHandler[]): {
+        type: string;
+        dataStoreFactory: IFluidDataStoreFactory;
+        runtimeOptions: IContainerRuntimeOptions;
+        requestHandlers: RuntimeRequestHandler[];
+        instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
+        instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
+        preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & IContainerRuntime>;
+        readonly IRuntimeFactory: any;
+        instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+        hasInitialized(_runtime: IContainerRuntime): Promise<void>;
+    };
+};
+
+// @public (undocumented)
+export enum DataObjectFactoryType {
+    // (undocumented)
+    Primed = 0,
+    // (undocumented)
+    Test = 1
+}
+
+// @public (undocumented)
+export const defaultTimeoutDurationMs = 250;
+
+// @public
+export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
+    constructor(baseLogger: ITelemetryBaseLogger);
+    // (undocumented)
+    registerExpectedEvent(...orderedExpectedEvents: ITelemetryGenericEvent[]): void;
+    // (undocumented)
+    reportAndClearTrackedEvents(): {
+        expectedNotFound: ({
+            index: number;
+            event: ITelemetryGenericEvent | undefined;
+        } | undefined)[];
+        unexpectedErrors: ITelemetryBaseEvent[];
+    };
+    // (undocumented)
+    send(event: ITelemetryBaseEvent): void;
+}
+
+// @public (undocumented)
+export type fluidEntryPoint = SupportedExportInterfaces | IFluidModule;
+
+// @public (undocumented)
+export function getUnexpectedLogErrorException(logger: EventAndErrorTrackingLogger | undefined, prefix?: string): Error | undefined;
+
+// @public (undocumented)
+export interface IOpProcessingController {
+    // (undocumented)
+    pauseProcessing(...containers: IContainer[]): Promise<void>;
+    // (undocumented)
+    processIncoming(...containers: IContainer[]): Promise<void>;
+    // (undocumented)
+    processOutgoing(...containers: IContainer[]): Promise<void>;
+    // (undocumented)
+    resumeProcessing(...containers: IContainer[]): void;
+}
+
+// @public (undocumented)
+export interface IProvideTestFluidObject {
+    // (undocumented)
+    readonly ITestFluidObject: ITestFluidObject;
+}
+
+// @public (undocumented)
+export interface ITestContainerConfig {
+    enableAttribution?: boolean;
+    fluidDataObjectType?: DataObjectFactoryType;
+    loaderProps?: Partial<ILoaderProps>;
+    registry?: ChannelFactoryRegistry;
+    runtimeOptions?: IContainerRuntimeOptions;
+}
+
+// @public (undocumented)
+export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable {
+    // (undocumented)
+    readonly channel: IFluidDataStoreChannel;
+    // (undocumented)
+    readonly context: IFluidDataStoreContext;
+    // (undocumented)
+    getSharedObject<T = any>(id: string): Promise<T>;
+    // (undocumented)
+    root: ISharedMap;
+    // (undocumented)
+    readonly runtime: IFluidDataStoreRuntime;
+}
+
+// @public (undocumented)
+export interface ITestObjectProvider {
+    // (undocumented)
+    createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
+    // (undocumented)
+    createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
+    // (undocumented)
+    createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): IHostLoader;
+    // (undocumented)
+    defaultCodeDetails: IFluidCodeDetails;
+    // (undocumented)
+    documentId: string;
+    // (undocumented)
+    documentServiceFactory: IDocumentServiceFactory;
+    // (undocumented)
+    driver: ITestDriver;
+    // (undocumented)
+    ensureSynchronized(timeoutDuration?: number): Promise<void>;
+    // (undocumented)
+    loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
+    // (undocumented)
+    loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
+    // (undocumented)
+    logger: ITelemetryBaseLogger;
+    // (undocumented)
+    makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
+    makeTestLoader(testContainerConfig?: ITestContainerConfig): IHostLoader;
+    // (undocumented)
+    opProcessingController: IOpProcessingController;
+    // (undocumented)
+    reset(): void;
+    // (undocumented)
+    updateDocumentId(url: IResolvedUrl | undefined): void;
+    // (undocumented)
+    urlResolver: IUrlResolver;
+}
+
+// @public (undocumented)
+export class LoaderContainerTracker implements IOpProcessingController {
+    constructor(syncSummarizerClients?: boolean);
+    add<LoaderType extends IHostLoader>(loader: LoaderType): void;
+    ensureSynchronized(...containers: IContainer[]): Promise<void>;
+    pauseProcessing(...containers: IContainer[]): Promise<void>;
+    processIncoming(...containers: IContainer[]): Promise<void>;
+    processOutgoing(...containers: IContainer[]): Promise<void>;
+    reset(): void;
+    resumeProcessing(...containers: IContainer[]): IContainer[];
+}
+
+// @public
+export class LocalCodeLoader implements ICodeDetailsLoader {
+    constructor(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, runtimeOptions?: IContainerRuntimeOptions);
+    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
+}
+
+// @public (undocumented)
+export const mockConfigProvider: (settings?: Record<string, ConfigTypes>) => IConfigProviderBase;
+
+// @public
+export const retryWithEventualValue: <T>(callback: () => Promise<T>, check: (value: T) => boolean, defaultValue: T, maxTries?: number, backOffMs?: number) => Promise<T>;
+
+// @public
+export function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<{
+    summaryTree: ISummaryTree;
+    summaryVersion: string;
+    summaryRefSeq: number;
+}>;
+
+// @public (undocumented)
+export type SupportedExportInterfaces = Partial<IProvideRuntimeFactory & IProvideFluidDataStoreFactory & IProvideFluidDataStoreRegistry & IProvideFluidCodeDetailsComparer>;
+
+// @public
+export const TestContainerRuntimeFactory: {
+    new (type: string, dataStoreFactory: IFluidDataStoreFactory, runtimeOptions?: IContainerRuntimeOptions, requestHandlers?: RuntimeRequestHandler[]): {
+        type: string;
+        dataStoreFactory: IFluidDataStoreFactory;
+        runtimeOptions: IContainerRuntimeOptions;
+        requestHandlers: RuntimeRequestHandler[];
+        instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
+        instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
+        preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & IContainerRuntime>;
+        readonly IRuntimeFactory: any;
+        instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+        hasInitialized(_runtime: IContainerRuntime): Promise<void>;
+    };
+};
+
+// @public
+export class TestFluidObject implements ITestFluidObject {
+    constructor(runtime: IFluidDataStoreRuntime, channel: IFluidDataStoreChannel, context: IFluidDataStoreContext, factoryEntriesMap: Map<string, IChannelFactory>);
+    // (undocumented)
+    readonly channel: IFluidDataStoreChannel;
+    // (undocumented)
+    readonly context: IFluidDataStoreContext;
+    getSharedObject<T = any>(id: string): Promise<T>;
+    // (undocumented)
+    get handle(): IFluidHandle<this>;
+    // (undocumented)
+    get IFluidLoadable(): this;
+    // @deprecated (undocumented)
+    get IFluidRouter(): this;
+    // (undocumented)
+    initialize(existing: boolean): Promise<void>;
+    // (undocumented)
+    get ITestFluidObject(): this;
+    // @deprecated (undocumented)
+    request(request: IRequest): Promise<IResponse>;
+    // (undocumented)
+    root: ISharedMap;
+    // (undocumented)
+    readonly runtime: IFluidDataStoreRuntime;
+}
+
+// @public
+export class TestFluidObjectFactory implements IFluidDataStoreFactory {
+    constructor(factoryEntries: ChannelFactoryRegistry, type?: string);
+    // (undocumented)
+    get IFluidDataStoreFactory(): this;
+    // (undocumented)
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
+    // (undocumented)
+    readonly type: string;
+}
+
+// @public
+export class TestObjectProvider implements ITestObjectProvider {
+    constructor(LoaderConstructor: typeof Loader, driver: ITestDriver, createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint);
+    createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
+    // (undocumented)
+    readonly createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
+    createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): Loader;
+    // (undocumented)
+    get defaultCodeDetails(): IFluidCodeDetails;
+    // (undocumented)
+    get documentId(): string;
+    // (undocumented)
+    get documentServiceFactory(): IDocumentServiceFactory;
+    // (undocumented)
+    readonly driver: ITestDriver;
+    // (undocumented)
+    ensureSynchronized(): Promise<void>;
+    // (undocumented)
+    loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
+    // (undocumented)
+    readonly LoaderConstructor: typeof Loader;
+    loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
+    // (undocumented)
+    get logger(): EventAndErrorTrackingLogger;
+    set logger(logger: EventAndErrorTrackingLogger);
+    makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
+    makeTestLoader(testContainerConfig?: ITestContainerConfig): Loader;
+    // (undocumented)
+    get opProcessingController(): IOpProcessingController;
+    // (undocumented)
+    reset(): void;
+    // (undocumented)
+    resetLoaderContainerTracker(syncSummarizerClients?: boolean): void;
+    // (undocumented)
+    updateDocumentId(resolvedUrl: IResolvedUrl | undefined): void;
+    // (undocumented)
+    get urlResolver(): IUrlResolver;
+    // (undocumented)
+    waitContainerToCatchUp(container: IContainer): Promise<boolean>;
+}
+
+// @public
+export function timeoutAwait<T = void>(promise: PromiseLike<T>, timeoutOptions?: TimeoutWithError | TimeoutWithValue<T>): Promise<T>;
+
+// @public
+export function timeoutPromise<T = void>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, timeoutOptions?: TimeoutWithError | TimeoutWithValue<T>): Promise<T>;
+
+// @public (undocumented)
+export interface TimeoutWithError {
+    durationMs?: number;
+    // (undocumented)
+    errorMsg?: string;
+    // (undocumented)
+    reject?: true;
+}
+
+// @public (undocumented)
+export interface TimeoutWithValue<T = void> {
+    durationMs?: number;
+    // (undocumented)
+    reject: false;
+    // (undocumented)
+    value: T;
+}
+
+// @public
+export function waitForContainerConnection(container: IContainer, failOnContainerClose?: boolean, timeoutOptions?: TimeoutWithError): Promise<void>;
+
+// @public
+export function wrapDocumentService(innerDocService: IDocumentService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentService;
+
+// @public
+export function wrapDocumentServiceFactory(innerDocServiceFactory: IDocumentServiceFactory, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentServiceFactory;
+
+// @public
+export function wrapDocumentStorageService(innerDocStorageService: IDocumentStorageService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentStorageService;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/test-utils";
-export declare const pkgVersion = "2.0.0-internal.7.0.0";
+export declare const pkgVersion = "2.0.0-internal.7.1.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/test-utils";
-exports.pkgVersion = "2.0.0-internal.7.0.0";
+exports.pkgVersion = "2.0.0-internal.7.1.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4BAA4B,CAAC;AACvC,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/test-utils\";\nexport const pkgVersion = \"2.0.0-internal.7.0.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4BAA4B,CAAC;AACvC,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/test-utils\";\nexport const pkgVersion = \"2.0.0-internal.7.1.0\";\n"]}