@fluidframework/test-utils 2.0.0-internal.8.0.0 → 2.0.0-rc.1.0.0

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.8.0.0";
+exports.pkgVersion = "2.0.0-rc.1.0.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.8.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,gBAAgB,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-rc.1.0.0\";\n"]}

package/dist/test-utils-alpha.d.ts

@@ -51,7 +51,14 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: ChannelFactoryRegistry */
 
-/* Excluded from this release type: createAndAttachContainer */
+/**
+ * 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 */
 
@@ -79,27 +86,183 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: getUnexpectedLogErrorException */
 
-/* Excluded from this release type: ICodeDetailsLoader */
-
 /* Excluded from this release type: IDocumentIdStrategy */
 
-/* Excluded from this release type: IFluidModuleWithDetails */
-
-/* Excluded from this release type: IOpProcessingController */
-
-/* Excluded from this release type: IProvideTestFluidObject */
-
-/* Excluded from this release type: ISummarizer */
+/**
+ * @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: ITestContainerConfig */
 
 /* Excluded from this release type: ITestDriver */
 
-/* Excluded from this release type: ITestFluidObject */
+/**
+ * @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 */
 
-/* Excluded from this release type: LoaderContainerTracker */
+/**
+ * @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 */
 
@@ -109,6 +272,8 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: summarizeNow */
 
+/* Excluded from this release type: SummaryInfo */
+
 /* Excluded from this release type: SupportedExportInterfaces */
 
 /* Excluded from this release type: TestContainerRuntimeFactory */

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

@@ -51,8 +51,6 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: ChannelFactoryRegistry */
 
-/* Excluded from this release type: ConfigTypes */
-
 /* Excluded from this release type: ContainerRuntime */
 
 /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
@@ -81,20 +79,14 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: fluidEntryPoint */
 
-/* Excluded from this release type: FluidObject */
-
 /* Excluded from this release type: getContainerEntryPointBackCompat */
 
 /* Excluded from this release type: getDataStoreEntryPointBackCompat */
 
 /* Excluded from this release type: getUnexpectedLogErrorException */
 
-/* Excluded from this release type: IChannelFactory */
-
 /* Excluded from this release type: ICodeDetailsLoader */
 
-/* Excluded from this release type: IConfigProviderBase */
-
 /* Excluded from this release type: IContainer */
 
 /* Excluded from this release type: IContainerContext */
@@ -121,20 +113,12 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: IFluidDataStoreFactory */
 
-/* Excluded from this release type: IFluidDataStoreRuntime */
-
-/* Excluded from this release type: IFluidHandle */
-
-/* Excluded from this release type: IFluidLoadable */
-
 /* 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 */
@@ -151,26 +135,14 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: IProvideTestFluidObject */
 
-/* Excluded from this release type: IRequest */
-
 /* Excluded from this release type: IResolvedUrl */
 
-/* Excluded from this release type: IResponse */
-
 /* Excluded from this release type: IRuntime */
 
-/* Excluded from this release type: ISharedMap */
-
 /* Excluded from this release type: ISummarizer */
 
 /* Excluded from this release type: ISummaryContext */
 
-/* Excluded from this release type: ITelemetryBaseEvent */
-
-/* Excluded from this release type: ITelemetryBaseLogger */
-
-/* Excluded from this release type: ITelemetryGenericEvent */
-
 /* Excluded from this release type: ITestContainerConfig */
 
 /* Excluded from this release type: ITestDriver */
@@ -197,6 +169,8 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: summarizeNow */
 
+/* Excluded from this release type: SummaryInfo */
+
 /* Excluded from this release type: SupportedExportInterfaces */
 
 /* Excluded from this release type: TestContainerRuntimeFactory */

package/dist/test-utils-public.d.ts

@@ -51,8 +51,6 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: ChannelFactoryRegistry */
 
-/* Excluded from this release type: ConfigTypes */
-
 /* Excluded from this release type: ContainerRuntime */
 
 /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
@@ -81,20 +79,14 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: fluidEntryPoint */
 
-/* Excluded from this release type: FluidObject */
-
 /* Excluded from this release type: getContainerEntryPointBackCompat */
 
 /* Excluded from this release type: getDataStoreEntryPointBackCompat */
 
 /* Excluded from this release type: getUnexpectedLogErrorException */
 
-/* Excluded from this release type: IChannelFactory */
-
 /* Excluded from this release type: ICodeDetailsLoader */
 
-/* Excluded from this release type: IConfigProviderBase */
-
 /* Excluded from this release type: IContainer */
 
 /* Excluded from this release type: IContainerContext */
@@ -121,20 +113,12 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: IFluidDataStoreFactory */
 
-/* Excluded from this release type: IFluidDataStoreRuntime */
-
-/* Excluded from this release type: IFluidHandle */
-
-/* Excluded from this release type: IFluidLoadable */
-
 /* 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 */
@@ -151,26 +135,14 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: IProvideTestFluidObject */
 
-/* Excluded from this release type: IRequest */
-
 /* Excluded from this release type: IResolvedUrl */
 
-/* Excluded from this release type: IResponse */
-
 /* Excluded from this release type: IRuntime */
 
-/* Excluded from this release type: ISharedMap */
-
 /* Excluded from this release type: ISummarizer */
 
 /* Excluded from this release type: ISummaryContext */
 
-/* Excluded from this release type: ITelemetryBaseEvent */
-
-/* Excluded from this release type: ITelemetryBaseLogger */
-
-/* Excluded from this release type: ITelemetryGenericEvent */
-
 /* Excluded from this release type: ITestContainerConfig */
 
 /* Excluded from this release type: ITestDriver */
@@ -197,6 +169,8 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler';
 
 /* Excluded from this release type: summarizeNow */
 
+/* Excluded from this release type: SummaryInfo */
+
 /* Excluded from this release type: SupportedExportInterfaces */
 
 /* Excluded from this release type: TestContainerRuntimeFactory */

package/dist/test-utils-untrimmed.d.ts

@@ -59,7 +59,7 @@ export declare type ChannelFactoryRegistry = Iterable<[string | undefined, IChan
  * @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.
- * @internal
+ * @alpha
  */
 export declare function createAndAttachContainer(source: IFluidCodeDetails, loader: IHostLoader, attachRequest: IRequest): Promise<IContainer>;
 
@@ -222,7 +222,7 @@ export declare interface IDocumentIdStrategy {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IOpProcessingController {
     processIncoming(...containers: IContainer[]): Promise<void>;
@@ -232,7 +232,7 @@ export declare interface IOpProcessingController {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IProvideTestFluidObject {
     readonly ITestFluidObject: ITestFluidObject;
@@ -255,7 +255,7 @@ export declare interface ITestContainerConfig {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable {
     root: ISharedMap;
@@ -366,7 +366,7 @@ export declare interface ITestObjectProvider {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare class LoaderContainerTracker implements IOpProcessingController {
     private readonly syncSummarizerClients;
@@ -551,11 +551,26 @@ export declare const retryWithEventualValue: <T>(callback: () => Promise<T>, che
  * Defaults to the reason "end-to-end test".
  * @internal
  */
-export declare function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<{
+export declare function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<SummaryInfo>;
+
+/**
+ * Summary information containing the summary tree, summary version, and summary sequence number.
+ * @internal
+ */
+export declare 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;
-}>;
+}
 
 /**
  * @internal

package/dist/testObjectProvider.d.ts

@@ -11,7 +11,7 @@ import { ITestDriver } from "@fluidframework/test-driver-definitions";
 import { fluidEntryPoint } from "./localCodeLoader";
 import { ChannelFactoryRegistry } from "./testFluidObject";
 /**
- * @internal
+ * @alpha
  */
 export interface IOpProcessingController {
     processIncoming(...containers: IContainer[]): Promise<void>;