@fluidframework/test-utils 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254674

package/dist/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// 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/lib/test-utils-alpha.d.ts

@@ -1,310 +0,0 @@
-import { ConfigTypes } from '@fluidframework/core-interfaces';
-import { ContainerRuntime } from '@fluidframework/container-runtime/internal';
-import { ContainerRuntimeFactoryWithDefaultDataStore } from '@fluidframework/aqueduct/internal';
-import { FluidDataStoreRuntime } from '@fluidframework/datastore/internal';
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-import { IContainerContext } from '@fluidframework/container-definitions/internal';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
-import { IContainerRuntimeOptions } from '@fluidframework/container-runtime/internal';
-import { IDataStore } from '@fluidframework/runtime-definitions/internal';
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
-import { IFluidCodeDetails } from '@fluidframework/container-definitions/internal';
-import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { IFluidModule } from '@fluidframework/container-definitions/internal';
-import { IFluidModuleWithDetails } from '@fluidframework/container-definitions/internal';
-import { IHostLoader } from '@fluidframework/container-definitions/internal';
-import { ILoaderOptions } from '@fluidframework/container-definitions/internal';
-import { ILoaderProps } from '@fluidframework/container-loader/internal';
-import { IOnDemandSummarizeOptions } from '@fluidframework/container-runtime/internal';
-import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions/internal';
-import { IProvideFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IProvideRuntimeFactory } from '@fluidframework/container-definitions/internal';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions/internal';
-import { ISharedMap } from '@fluidframework/map';
-import { ISummarizer } from '@fluidframework/container-runtime/internal';
-import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryGenericEventExt } from '@fluidframework/telemetry-utils';
-import { ITelemetryLoggerPropertyBags } from '@fluidframework/telemetry-utils/internal';
-import { ITestDriver } from '@fluid-internal/test-driver-definitions';
-import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
-import { Loader } from '@fluidframework/container-loader/internal';
-import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
-import { RuntimeRequestHandler } from '@fluidframework/request-handler/internal';
-
-/* Excluded from this release type: ChannelFactoryRegistry */
-
-/**
- * Creates a detached Container and attaches it.
- * @param source - The code details used to create the Container.
- * @param loader - The loader to use to initialize the container.
- * @param attachRequest - The request to create new from.
- * @alpha
- */
-export declare function createAndAttachContainer(source: IFluidCodeDetails, loader: IHostLoader, attachRequest: IRequest): Promise<IContainer>;
-
-/* Excluded from this release type: createContainerRuntimeFactoryWithDefaultDataStore */
-
-/* Excluded from this release type: createDocumentId */
-
-/* Excluded from this release type: createLoader */
-
-/* Excluded from this release type: createSummarizer */
-
-/* Excluded from this release type: createSummarizerCore */
-
-/* Excluded from this release type: createSummarizerFromFactory */
-
-/* Excluded from this release type: createTestConfigProvider */
-
-/* Excluded from this release type: createTestContainerRuntimeFactory */
-
-/* Excluded from this release type: DataObjectFactoryType */
-
-/* Excluded from this release type: defaultTimeoutDurationMs */
-
-/* Excluded from this release type: EventAndErrorTrackingLogger */
-
-/* Excluded from this release type: fluidEntryPoint */
-
-/* Excluded from this release type: getContainerEntryPointBackCompat */
-
-/* Excluded from this release type: getDataStoreEntryPointBackCompat */
-
-/* Excluded from this release type: getUnexpectedLogErrorException */
-
-/* Excluded from this release type: IDocumentIdStrategy */
-
-/* Excluded from this release type: IEventAndErrorTrackingLogger */
-
-/**
- * @alpha
- */
-export declare interface IOpProcessingController {
-    processIncoming(...containers: IContainer[]): Promise<void>;
-    processOutgoing(...containers: IContainer[]): Promise<void>;
-    pauseProcessing(...containers: IContainer[]): Promise<void>;
-    resumeProcessing(...containers: IContainer[]): void;
-}
-
-/**
- * @alpha
- */
-export declare interface IProvideTestFluidObject {
-    readonly ITestFluidObject: ITestFluidObject;
-}
-
-/* Excluded from this release type: ITestConfigProvider */
-
-/* Excluded from this release type: ITestContainerConfig */
-
-/**
- * @alpha
- */
-export declare interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable {
-    root: ISharedMap;
-    readonly runtime: IFluidDataStoreRuntime;
-    readonly channel: IFluidDataStoreChannel;
-    readonly context: IFluidDataStoreContext;
-    getSharedObject<T = any>(id: string): Promise<T>;
-}
-
-/* Excluded from this release type: ITestObjectProvider */
-
-/**
- * @alpha
- */
-export declare class LoaderContainerTracker implements IOpProcessingController {
-    private readonly syncSummarizerClients;
-    private readonly containers;
-    private lastProposalSeqNum;
-    constructor(syncSummarizerClients?: boolean);
-    /**
-     * Add a loader to start to track any container created from them
-     * @param loader - loader to start tracking any container created.
-     */
-    add<LoaderType extends IHostLoader>(loader: LoaderType): void;
-    /**
-     * Utility function to add container to be tracked.
-     *
-     * @param container - container to add
-     */
-    private addContainer;
-    /**
-     * Keep track of the trailing NoOp that was sent so we can discount them in the clientSequenceNumber tracking.
-     * The server might coalesce them with other ops, or a single NoOp, or delay it if it don't think it is necessary.
-     *
-     * @param container - the container to track
-     * @param record - the record to update the trailing op information
-     */
-    private trackTrailingNoOps;
-    private trackLastProposal;
-    /**
-     * Reset the tracker, closing all containers and stop tracking them.
-     */
-    reset(): void;
-    /**
-     * Make sure all the tracked containers are synchronized.
-     *
-     * No isDirty (non-readonly) containers
-     * No extra clientId in quorum of any container that is not tracked and still opened.
-     * - i.e. no pending Join/Leave message.
-     * No unresolved proposal (minSeqNum \>= lastProposalSeqNum)
-     * lastSequenceNumber of all container is the same
-     * clientSequenceNumberObserved is the same as clientSequenceNumber sent
-     * - this overlaps with !isDirty, but include task scheduler ops.
-     * - Trailing NoOp is tracked and don't count as pending ops.
-     *
-     * Containers that are already pause will resume process and paused again once
-     * everything is synchronized.  Containers that aren't paused will remain unpaused when this
-     * function returns.
-     */
-    ensureSynchronized(...containers: IContainer[]): Promise<void>;
-    /**
-     * Utility to calculate the set of clientId per container in quorum that is NOT associated with
-     * any container we tracked, indicating there is a pending join or leave op that we need to wait.
-     *
-     * @param containersToApply - the set of containers to check
-     */
-    private getPendingClients;
-    /**
-     * Utility to check synchronization based on sequence number
-     * See ensureSynchronized for more detail
-     *
-     * @param containersToApply - the set of containers to check
-     */
-    private needSequenceNumberSynchronize;
-    private containerIndexStrings;
-    /**
-     * Utility to wait for any clientId in quorum that is NOT associated with any container we
-     * tracked, indicating there is a pending join or leave op that we need to wait.
-     *
-     * Note that this function doesn't account for container that got added after we started waiting
-     *
-     * @param containersToApply - the set of containers to wait for any inbound ops for
-     */
-    private waitForPendingClients;
-    /**
-     * Utility to wait for any inbound ops from a set of containers
-     * @param containersToApply - the set of containers to wait for any inbound ops for
-     */
-    private waitForAnyInboundOps;
-    /**
-     * Resume all queue activities on all paused tracked containers and return them
-     */
-    resumeProcessing(...containers: IContainer[]): IContainer[];
-    /**
-     * Pause all queue activities on the containers given, or all tracked containers
-     * Any containers given that is not tracked will be ignored.
-     *
-     * When a container is paused, it is assumed that we want fine grain control over op
-     * sequencing.  This function will prepare the container and force it into write mode to
-     * avoid missing join messages or change the sequence of event when switching from read to
-     * write mode.
-     */
-    pauseProcessing(...containers: IContainer[]): Promise<void>;
-    /**
-     * When a container is paused, it is assumed that we want fine grain control over op
-     * sequencing.  This function will prepare the container and force it into write mode to
-     * avoid missing join messages or change the sequence of event when switching from read to
-     * write mode.
-     *
-     * @param container - the container to pause
-     * @param record - the record for the container
-     */
-    private pauseContainer;
-    /**
-     * Pause all queue activities on all tracked containers, and resume only
-     * inbound to process ops until it is idle. All queues are left in the paused state
-     * after the function.
-     *
-     * Pausing will switch the container to write mode. See `pauseProcessing`
-     */
-    processIncoming(...containers: IContainer[]): Promise<void>;
-    /**
-     * Pause all queue activities on all tracked containers, and resume only
-     * outbound to process ops until it is idle. All queues are left in the paused state
-     * after the function.
-     *
-     * Pausing will switch the container to write mode. See `pauseProcessing`
-     */
-    processOutgoing(...containers: IContainer[]): Promise<void>;
-    /**
-     * Implementation of processIncoming and processOutgoing
-     */
-    private processQueue;
-    /**
-     * Utility to set up listener to track the outbound ops until it round trip back
-     * Returns a function to remove the handler after it is done.
-     *
-     * @param container - the container to setup
-     * @param inflightTracker - a map to track the clientSequenceNumber per container it expect to get ops back
-     */
-    private setupInOutTracker;
-    /**
-     * Setup debug traces for connection and ops
-     */
-    private setupTrace;
-    /**
-     * Filter out the opened containers based on param.
-     * @param containers - The container to filter to.  If the array is empty, it means don't filter and return
-     * all open containers.
-     */
-    private getContainers;
-}
-
-/* Excluded from this release type: LocalCodeLoader */
-
-/* Excluded from this release type: retryWithEventualValue */
-
-/* Excluded from this release type: summarizeNow */
-
-/* Excluded from this release type: SummaryInfo */
-
-/* Excluded from this release type: SupportedExportInterfaces */
-
-/* Excluded from this release type: TestContainerRuntimeFactory */
-
-/* Excluded from this release type: TestFluidObject */
-
-/* Excluded from this release type: TestFluidObjectFactory */
-
-/* Excluded from this release type: TestObjectProvider */
-
-/* Excluded from this release type: TestObjectProviderWithVersionedLoad */
-
-/* Excluded from this release type: timeoutAwait */
-
-/* Excluded from this release type: timeoutPromise */
-
-/* Excluded from this release type: TimeoutWithError */
-
-/* Excluded from this release type: TimeoutWithValue */
-
-/* Excluded from this release type: waitForContainerConnection */
-
-/* Excluded from this release type: wrapDocumentService */
-
-/* Excluded from this release type: wrapDocumentServiceFactory */
-
-/* Excluded from this release type: wrapDocumentStorageService */
-
-export { }

package/lib/test-utils-beta.d.ts

@@ -1,211 +0,0 @@
-import { ConfigTypes } from '@fluidframework/core-interfaces';
-import { ContainerRuntime } from '@fluidframework/container-runtime/internal';
-import { ContainerRuntimeFactoryWithDefaultDataStore } from '@fluidframework/aqueduct/internal';
-import { FluidDataStoreRuntime } from '@fluidframework/datastore/internal';
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IContainer } from '@fluidframework/container-definitions/internal';
-import { IContainerContext } from '@fluidframework/container-definitions/internal';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
-import { IContainerRuntimeOptions } from '@fluidframework/container-runtime/internal';
-import { IDataStore } from '@fluidframework/runtime-definitions/internal';
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
-import { IFluidCodeDetails } from '@fluidframework/container-definitions/internal';
-import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { IFluidModule } from '@fluidframework/container-definitions/internal';
-import { IFluidModuleWithDetails } from '@fluidframework/container-definitions/internal';
-import { IHostLoader } from '@fluidframework/container-definitions/internal';
-import { ILoaderOptions } from '@fluidframework/container-definitions/internal';
-import { ILoaderProps } from '@fluidframework/container-loader/internal';
-import { IOnDemandSummarizeOptions } from '@fluidframework/container-runtime/internal';
-import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions/internal';
-import { IProvideFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IProvideRuntimeFactory } from '@fluidframework/container-definitions/internal';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions/internal';
-import { ISharedMap } from '@fluidframework/map';
-import { ISummarizer } from '@fluidframework/container-runtime/internal';
-import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryGenericEventExt } from '@fluidframework/telemetry-utils';
-import { ITelemetryLoggerPropertyBags } from '@fluidframework/telemetry-utils/internal';
-import { ITestDriver } from '@fluid-internal/test-driver-definitions';
-import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
-import { Loader } from '@fluidframework/container-loader/internal';
-import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
-import { RuntimeRequestHandler } from '@fluidframework/request-handler/internal';
-
-/* Excluded from this release type: ChannelFactoryRegistry */
-
-/* Excluded from this release type: ContainerRuntime */
-
-/* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
-
-/* Excluded from this release type: createAndAttachContainer */
-
-/* Excluded from this release type: createContainerRuntimeFactoryWithDefaultDataStore */
-
-/* Excluded from this release type: createDocumentId */
-
-/* Excluded from this release type: createLoader */
-
-/* Excluded from this release type: createSummarizer */
-
-/* Excluded from this release type: createSummarizerCore */
-
-/* Excluded from this release type: createSummarizerFromFactory */
-
-/* Excluded from this release type: createTestConfigProvider */
-
-/* Excluded from this release type: createTestContainerRuntimeFactory */
-
-/* Excluded from this release type: DataObjectFactoryType */
-
-/* Excluded from this release type: defaultTimeoutDurationMs */
-
-/* Excluded from this release type: EventAndErrorTrackingLogger */
-
-/* Excluded from this release type: FluidDataStoreRuntime */
-
-/* Excluded from this release type: fluidEntryPoint */
-
-/* Excluded from this release type: getContainerEntryPointBackCompat */
-
-/* Excluded from this release type: getDataStoreEntryPointBackCompat */
-
-/* Excluded from this release type: getUnexpectedLogErrorException */
-
-/* Excluded from this release type: ICodeDetailsLoader */
-
-/* Excluded from this release type: IContainer */
-
-/* Excluded from this release type: IContainerContext */
-
-/* Excluded from this release type: IContainerRuntime */
-
-/* Excluded from this release type: IContainerRuntimeOptions */
-
-/* Excluded from this release type: IDataStore */
-
-/* Excluded from this release type: IDocumentIdStrategy */
-
-/* Excluded from this release type: IDocumentService */
-
-/* Excluded from this release type: IDocumentServiceFactory */
-
-/* Excluded from this release type: IDocumentStorageService */
-
-/* Excluded from this release type: IEventAndErrorTrackingLogger */
-
-/* Excluded from this release type: IFluidCodeDetails */
-
-/* Excluded from this release type: IFluidDataStoreChannel */
-
-/* Excluded from this release type: IFluidDataStoreContext */
-
-/* Excluded from this release type: IFluidDataStoreFactory */
-
-/* Excluded from this release type: IFluidModule */
-
-/* Excluded from this release type: IFluidModuleWithDetails */
-
-/* Excluded from this release type: IHostLoader */
-
-/* Excluded from this release type: ILoaderOptions */
-
-/* Excluded from this release type: ILoaderProps */
-
-/* Excluded from this release type: IOnDemandSummarizeOptions */
-
-/* Excluded from this release type: IOpProcessingController */
-
-/* Excluded from this release type: IProvideFluidCodeDetailsComparer */
-
-/* Excluded from this release type: IProvideFluidDataStoreFactory */
-
-/* Excluded from this release type: IProvideFluidDataStoreRegistry */
-
-/* Excluded from this release type: IProvideRuntimeFactory */
-
-/* Excluded from this release type: IProvideTestFluidObject */
-
-/* Excluded from this release type: IResolvedUrl */
-
-/* Excluded from this release type: IRuntime */
-
-/* Excluded from this release type: ISummarizer */
-
-/* Excluded from this release type: ISummaryContext */
-
-/* Excluded from this release type: ITelemetryLoggerPropertyBags */
-
-/* Excluded from this release type: ITestConfigProvider */
-
-/* Excluded from this release type: ITestContainerConfig */
-
-/* Excluded from this release type: ITestFluidObject */
-
-/* Excluded from this release type: ITestObjectProvider */
-
-/* Excluded from this release type: IUrlResolver */
-
-/* Excluded from this release type: Loader */
-
-/* Excluded from this release type: LoaderContainerTracker */
-
-/* Excluded from this release type: LocalCodeLoader */
-
-/* Excluded from this release type: NamedFluidDataStoreRegistryEntries */
-
-/* Excluded from this release type: retryWithEventualValue */
-
-/* Excluded from this release type: RuntimeRequestHandler */
-
-/* Excluded from this release type: summarizeNow */
-
-/* Excluded from this release type: SummaryInfo */
-
-/* Excluded from this release type: SupportedExportInterfaces */
-
-/* Excluded from this release type: TestContainerRuntimeFactory */
-
-/* Excluded from this release type: TestFluidObject */
-
-/* Excluded from this release type: TestFluidObjectFactory */
-
-/* Excluded from this release type: TestObjectProvider */
-
-/* Excluded from this release type: TestObjectProviderWithVersionedLoad */
-
-/* Excluded from this release type: timeoutAwait */
-
-/* Excluded from this release type: timeoutPromise */
-
-/* Excluded from this release type: TimeoutWithError */
-
-/* Excluded from this release type: TimeoutWithValue */
-
-/* Excluded from this release type: waitForContainerConnection */
-
-/* Excluded from this release type: wrapDocumentService */
-
-/* Excluded from this release type: wrapDocumentServiceFactory */
-
-/* Excluded from this release type: wrapDocumentStorageService */
-
-export { }