@fluidframework/test-utils 1.2.6 → 2.0.0-dev.1.3.0.96595

package/dist/DriverWrappers.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentService, IDocumentServiceFactory, IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+/**
+ * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
+ * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
+ * callback before it is uploaded to the server.
+ */
+export declare function wrapDocumentStorageService(innerDocStorageService: IDocumentStorageService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentStorageService;
+/**
+ * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the
+ * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by
+ * the client.
+ * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
+ * to pass in the `uploadSummaryCb`.
+ */
+export declare function wrapDocumentService(innerDocService: IDocumentService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentService;
+/**
+ * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb
+ * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is
+ * uploaded by the client.
+ * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
+ * pass in the `uploadSummaryCb`.
+ */
+export declare function wrapDocumentServiceFactory(innerDocServiceFactory: IDocumentServiceFactory, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentServiceFactory;
+//# sourceMappingURL=DriverWrappers.d.ts.map

package/dist/DriverWrappers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DriverWrappers.d.ts","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EAEvB,eAAe,EAClB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;;;GAIG;AACH,wBAAgB,0BAA0B,CACtC,sBAAsB,EAAE,uBAAuB,EAC/C,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,2BAW5F;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAC/B,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,oBAQ5F;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACtC,sBAAsB,EAAE,uBAAuB,EAC/C,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,2BAa5F"}

package/dist/DriverWrappers.js

@@ -0,0 +1,54 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapDocumentServiceFactory = exports.wrapDocumentService = exports.wrapDocumentStorageService = void 0;
+/**
+ * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
+ * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
+ * callback before it is uploaded to the server.
+ */
+function wrapDocumentStorageService(innerDocStorageService, uploadSummaryCb) {
+    const outerDocStorageService = Object.create(innerDocStorageService);
+    outerDocStorageService.uploadSummaryWithContext = async (summary, context) => {
+        const newContext = uploadSummaryCb(summary, context);
+        return innerDocStorageService.uploadSummaryWithContext(summary, newContext);
+    };
+    return outerDocStorageService;
+}
+exports.wrapDocumentStorageService = wrapDocumentStorageService;
+/**
+ * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the
+ * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by
+ * the client.
+ * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
+ * to pass in the `uploadSummaryCb`.
+ */
+function wrapDocumentService(innerDocService, uploadSummaryCb) {
+    const outerDocService = Object.create(innerDocService);
+    outerDocService.connectToStorage = async () => {
+        const storageService = await innerDocService.connectToStorage();
+        return wrapDocumentStorageService(storageService, uploadSummaryCb);
+    };
+    return outerDocService;
+}
+exports.wrapDocumentService = wrapDocumentService;
+/**
+ * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb
+ * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is
+ * uploaded by the client.
+ * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
+ * pass in the `uploadSummaryCb`.
+ */
+function wrapDocumentServiceFactory(innerDocServiceFactory, uploadSummaryCb) {
+    const outerDocServiceFactory = Object.create(innerDocServiceFactory);
+    outerDocServiceFactory.createDocumentService = async (resolvedUrl, logger, clientIsSummarizer) => {
+        const documentService = await innerDocServiceFactory.createDocumentService(resolvedUrl, logger, clientIsSummarizer);
+        return wrapDocumentService(documentService, uploadSummaryCb);
+    };
+    return outerDocServiceFactory;
+}
+exports.wrapDocumentServiceFactory = wrapDocumentServiceFactory;
+//# sourceMappingURL=DriverWrappers.js.map

package/dist/DriverWrappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DriverWrappers.js","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH;;;;GAIG;AACH,SAAgB,0BAA0B,CACtC,sBAA+C,EAC/C,eAAyF;IAEzF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAA4B,CAAC;IAChG,sBAAsB,CAAC,wBAAwB,GAAG,KAAK,EACnD,OAAqB,EACrB,OAAwB,EACT,EAAE;QACjB,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAChF,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAClC,CAAC;AAbD,gEAaC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAC/B,eAAiC,EACjC,eAAyF;IAEzF,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAqB,CAAC;IAC3E,eAAe,CAAC,gBAAgB,GAAG,KAAK,IAAsC,EAAE;QAC5E,MAAM,cAAc,GAAG,MAAM,eAAe,CAAC,gBAAgB,EAAE,CAAC;QAChE,OAAO,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACvE,CAAC,CAAC;IACF,OAAO,eAAe,CAAC;AAC3B,CAAC;AAVD,kDAUC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACtC,sBAA+C,EAC/C,eAAyF;IAEzF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAA4B,CAAC;IAChG,sBAAsB,CAAC,qBAAqB,GAAG,KAAK,EAChD,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B,EACH,EAAE;QAC3B,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,qBAAqB,CACtE,WAAW,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAC7C,OAAO,mBAAmB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAClC,CAAC;AAfD,gEAeC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IDocumentStorageService,\n    IResolvedUrl,\n    ISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the\n * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the\n * callback before it is uploaded to the server.\n */\nexport function wrapDocumentStorageService(\n    innerDocStorageService: IDocumentStorageService,\n    uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n    const outerDocStorageService = Object.create(innerDocStorageService) as IDocumentStorageService;\n    outerDocStorageService.uploadSummaryWithContext = async (\n        summary: ISummaryTree,\n        context: ISummaryContext,\n    ): Promise<string> => {\n        const newContext = uploadSummaryCb(summary, context);\n        return innerDocStorageService.uploadSummaryWithContext(summary, newContext);\n    };\n    return outerDocStorageService;\n}\n\n/**\n * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the\n * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by\n * the client.\n * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`\n * to pass in the `uploadSummaryCb`.\n */\nexport function wrapDocumentService(\n    innerDocService: IDocumentService,\n    uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n    const outerDocService = Object.create(innerDocService) as IDocumentService;\n    outerDocService.connectToStorage = async (): Promise<IDocumentStorageService> => {\n        const storageService = await innerDocService.connectToStorage();\n        return wrapDocumentStorageService(storageService, uploadSummaryCb);\n    };\n    return outerDocService;\n}\n\n/**\n * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb\n * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is\n * uploaded by the client.\n * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to\n * pass in the `uploadSummaryCb`.\n */\nexport function wrapDocumentServiceFactory(\n    innerDocServiceFactory: IDocumentServiceFactory,\n    uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n    const outerDocServiceFactory = Object.create(innerDocServiceFactory) as IDocumentServiceFactory;\n    outerDocServiceFactory.createDocumentService = async (\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> => {\n        const documentService = await innerDocServiceFactory.createDocumentService(\n            resolvedUrl, logger, clientIsSummarizer);\n        return wrapDocumentService(documentService, uploadSummaryCb);\n    };\n    return outerDocServiceFactory;\n}\n"]}

package/dist/TestConfigs.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ConfigTypes, IConfigProviderBase } from "@fluidframework/telemetry-utils";
+export declare const mockConfigProvider: (settings?: Record<string, ConfigTypes>) => IConfigProviderBase;
+//# sourceMappingURL=TestConfigs.d.ts.map

package/dist/TestConfigs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestConfigs.d.ts","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEnF,eAAO,MAAM,kBAAkB,cAAe,OAAO,MAAM,EAAE,WAAW,CAAC,KAAQ,mBAM/E,CAAC"}

package/dist/TestConfigs.js

@@ -0,0 +1,15 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockConfigProvider = void 0;
+exports.mockConfigProvider = ((settings = {}) => {
+    settings["Fluid.GarbageCollection.TrackGCState"] = "true";
+    settings["Fluid.GarbageCollection.WriteDataAtRoot"] = "true";
+    return {
+        getRawConfig: (name) => settings[name],
+    };
+});
+//# sourceMappingURL=TestConfigs.js.map

package/dist/TestConfigs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestConfigs.js","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIU,QAAA,kBAAkB,GAAG,CAAC,CAAC,WAAwC,EAAE,EAAuB,EAAE;IACnG,QAAQ,CAAC,sCAAsC,CAAC,GAAG,MAAM,CAAC;IAC1D,QAAQ,CAAC,yCAAyC,CAAC,GAAG,MAAM,CAAC;IAC7D,OAAO;QACH,YAAY,EAAE,CAAC,IAAY,EAAe,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;KAC9D,CAAC;AACN,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ConfigTypes, IConfigProviderBase } from \"@fluidframework/telemetry-utils\";\n\nexport const mockConfigProvider = ((settings: Record<string, ConfigTypes> = {}): IConfigProviderBase => {\n    settings[\"Fluid.GarbageCollection.TrackGCState\"] = \"true\";\n    settings[\"Fluid.GarbageCollection.WriteDataAtRoot\"] = \"true\";\n    return {\n        getRawConfig: (name: string): ConfigTypes => settings[name],\n    };\n});\n"]}

package/dist/TestSummaryUtils.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ContainerRuntimeFactoryWithDefaultDataStore } from "@fluidframework/aqueduct";
+import { IContainer } from "@fluidframework/container-definitions";
+import { IGCRuntimeOptions, ISummarizer } from "@fluidframework/container-runtime";
+import { IFluidDataStoreFactory, NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
+import { IConfigProviderBase } from "@fluidframework/telemetry-utils";
+import { ITestObjectProvider } from "./testObjectProvider";
+export declare function createSummarizerFromFactory(provider: ITestObjectProvider, container: IContainer, dataStoreFactory: IFluidDataStoreFactory, summaryVersion?: string, containerRuntimeFactoryType?: typeof ContainerRuntimeFactoryWithDefaultDataStore, registryEntries?: NamedFluidDataStoreRegistryEntries): Promise<ISummarizer>;
+export declare function createSummarizer(provider: ITestObjectProvider, container: IContainer, summaryVersion?: string, gcOptions?: IGCRuntimeOptions, configProvider?: IConfigProviderBase): Promise<ISummarizer>;
+export declare function summarizeNow(summarizer: ISummarizer, reason?: string): Promise<{
+    summaryTree: import("@fluidframework/protocol-definitions").ISummaryTree;
+    summaryVersion: string;
+}>;
+export declare function waitForContainerConnection(container: IContainer): Promise<void>;
+//# sourceMappingURL=TestSummaryUtils.d.ts.map

package/dist/TestSummaryUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestSummaryUtils.d.ts","sourceRoot":"","sources":["../src/TestSummaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,0BAA0B,CAAC;AAEvF,OAAO,EAAE,UAAU,EAA6B,MAAM,uCAAuC,CAAC;AAE9F,OAAO,EACH,iBAAiB,EACjB,WAAW,EAEd,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EAEH,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAwB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AA6CjF,wBAAsB,2BAA2B,CAC7C,QAAQ,EAAE,mBAAmB,EAC7B,SAAS,EAAE,UAAU,EACrB,gBAAgB,EAAE,sBAAsB,EACxC,cAAc,CAAC,EAAE,MAAM,EACvB,2BAA2B,qDAA8C,EACzE,eAAe,CAAC,EAAE,kCAAkC,GACrD,OAAO,CAAC,WAAW,CAAC,CAoBtB;AAED,wBAAsB,gBAAgB,CAClC,QAAQ,EAAE,mBAAmB,EAC7B,SAAS,EAAE,UAAU,EACrB,cAAc,CAAC,EAAE,MAAM,EACvB,SAAS,CAAC,EAAE,iBAAiB,EAC7B,cAAc,GAAE,mBAA0C,GAC3D,OAAO,CAAC,WAAW,CAAC,CAWtB;AAED,wBAAsB,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,GAAE,MAA0B;;;GAqB7F;AAED,wBAAsB,0BAA0B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrF"}

package/dist/TestSummaryUtils.js

@@ -0,0 +1,95 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForContainerConnection = exports.summarizeNow = exports.createSummarizer = exports.createSummarizerFromFactory = void 0;
+const aqueduct_1 = require("@fluidframework/aqueduct");
+const common_utils_1 = require("@fluidframework/common-utils");
+const container_definitions_1 = require("@fluidframework/container-definitions");
+const container_loader_1 = require("@fluidframework/container-loader");
+const driver_definitions_1 = require("@fluidframework/driver-definitions");
+const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const TestConfigs_1 = require("./TestConfigs");
+const summarizerClientType = "summarizer";
+async function createSummarizerCore(container, loader, summaryVersion) {
+    const absoluteUrl = await container.getAbsoluteUrl("");
+    if (absoluteUrl === undefined) {
+        throw new Error("URL could not be resolved");
+    }
+    const request = {
+        headers: {
+            [container_definitions_1.LoaderHeader.cache]: false,
+            [container_definitions_1.LoaderHeader.clientDetails]: {
+                capabilities: { interactive: false },
+                type: summarizerClientType,
+            },
+            [driver_definitions_1.DriverHeader.summarizingClient]: true,
+            [container_definitions_1.LoaderHeader.reconnect]: false,
+            [container_definitions_1.LoaderHeader.version]: summaryVersion,
+        },
+        url: absoluteUrl,
+    };
+    const summarizerContainer = await loader.resolve(request);
+    await waitForContainerConnection(summarizerContainer);
+    const fluidObject = await (0, runtime_utils_1.requestFluidObject)(summarizerContainer, { url: "_summarizer" });
+    if (fluidObject.ISummarizer === undefined) {
+        throw new Error("Fluid object does not implement ISummarizer");
+    }
+    return fluidObject.ISummarizer;
+}
+const defaultSummaryOptions = {
+    summaryConfigOverrides: {
+        state: "disableHeuristics",
+        maxAckWaitTime: 10000,
+        maxOpsSinceLastSummary: 7000,
+        initialSummarizerDelayMs: 0,
+        summarizerClientElection: false,
+    },
+};
+async function createSummarizerFromFactory(provider, container, dataStoreFactory, summaryVersion, containerRuntimeFactoryType = aqueduct_1.ContainerRuntimeFactoryWithDefaultDataStore, registryEntries) {
+    const innerRequestHandler = async (request, runtime) => runtime.IFluidHandleContext.resolveHandle(request);
+    const runtimeFactory = new containerRuntimeFactoryType(dataStoreFactory, registryEntries !== null && registryEntries !== void 0 ? registryEntries : [
+        [dataStoreFactory.type, Promise.resolve(dataStoreFactory)],
+    ], undefined, [innerRequestHandler], { summaryOptions: defaultSummaryOptions });
+    const loader = provider.createLoader([[provider.defaultCodeDetails, runtimeFactory]], { configProvider: (0, TestConfigs_1.mockConfigProvider)() });
+    return createSummarizerCore(container, loader, summaryVersion);
+}
+exports.createSummarizerFromFactory = createSummarizerFromFactory;
+async function createSummarizer(provider, container, summaryVersion, gcOptions, configProvider = (0, TestConfigs_1.mockConfigProvider)()) {
+    const testContainerConfig = {
+        runtimeOptions: {
+            summaryOptions: defaultSummaryOptions,
+            gcOptions,
+        },
+        loaderProps: { configProvider },
+    };
+    const loader = provider.makeTestLoader(testContainerConfig);
+    return createSummarizerCore(container, loader, summaryVersion);
+}
+exports.createSummarizer = createSummarizer;
+async function summarizeNow(summarizer, reason = "end-to-end test") {
+    const result = summarizer.summarizeOnDemand({ reason });
+    const submitResult = await result.summarySubmitted;
+    (0, common_utils_1.assert)(submitResult.success, "on-demand summary should submit");
+    (0, common_utils_1.assert)(submitResult.data.stage === "submit", "on-demand summary submitted data stage should be submit");
+    (0, common_utils_1.assert)(submitResult.data.summaryTree !== undefined, "summary tree should exist");
+    const broadcastResult = await result.summaryOpBroadcasted;
+    (0, common_utils_1.assert)(broadcastResult.success, "summary op should be broadcast");
+    const ackNackResult = await result.receivedSummaryAckOrNack;
+    (0, common_utils_1.assert)(ackNackResult.success, "summary op should be acked");
+    await new Promise((resolve) => process.nextTick(resolve));
+    return {
+        summaryTree: submitResult.data.summaryTree,
+        summaryVersion: ackNackResult.data.summaryAckOp.contents.handle,
+    };
+}
+exports.summarizeNow = summarizeNow;
+async function waitForContainerConnection(container) {
+    if (container.connectionState !== container_loader_1.ConnectionState.Connected) {
+        return new Promise((resolve) => container.once("connected", () => resolve()));
+    }
+}
+exports.waitForContainerConnection = waitForContainerConnection;
+//# sourceMappingURL=TestSummaryUtils.js.map

package/dist/TestSummaryUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestSummaryUtils.js","sourceRoot":"","sources":["../src/TestSummaryUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAAuF;AACvF,+DAAsD;AACtD,iFAA8F;AAC9F,uEAAmE;AAOnE,2EAAkE;AAMlE,iEAAmE;AAGnE,+CAAmD;AAEnD,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAE1C,KAAK,UAAU,oBAAoB,CAAC,SAAqB,EAAE,MAAmB,EAAE,cAAuB;IACnG,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACvD,IAAI,WAAW,KAAK,SAAS,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAChD;IAED,MAAM,OAAO,GAAa;QACtB,OAAO,EAAE;YACL,CAAC,oCAAY,CAAC,KAAK,CAAC,EAAE,KAAK;YAC3B,CAAC,oCAAY,CAAC,aAAa,CAAC,EAAE;gBAC1B,YAAY,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;gBACpC,IAAI,EAAE,oBAAoB;aAC7B;YACD,CAAC,iCAAY,CAAC,iBAAiB,CAAC,EAAE,IAAI;YACtC,CAAC,oCAAY,CAAC,SAAS,CAAC,EAAE,KAAK;YAC/B,CAAC,oCAAY,CAAC,OAAO,CAAC,EAAE,cAAc;SACzC;QACD,GAAG,EAAE,WAAW;KACnB,CAAC;IACF,MAAM,mBAAmB,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1D,MAAM,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;IAEtD,MAAM,WAAW,GACb,MAAM,IAAA,kCAAkB,EAA2B,mBAAmB,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;IACpG,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;KAClE;IACD,OAAO,WAAW,CAAC,WAAW,CAAC;AACnC,CAAC;AAED,MAAM,qBAAqB,GAA2B;IAClD,sBAAsB,EAAE;QACpB,KAAK,EAAE,mBAAmB;QAC1B,cAAc,EAAE,KAAK;QACrB,sBAAsB,EAAE,IAAI;QAC5B,wBAAwB,EAAE,CAAC;QAC3B,wBAAwB,EAAE,KAAK;KAClC;CACJ,CAAC;AAEK,KAAK,UAAU,2BAA2B,CAC7C,QAA6B,EAC7B,SAAqB,EACrB,gBAAwC,EACxC,cAAuB,EACvB,2BAA2B,GAAG,sDAA2C,EACzE,eAAoD;IAEpD,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAiB,EAAE,OAA8B,EAAE,EAAE,CACpF,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,IAAI,2BAA2B,CAClD,gBAAgB,EAChB,eAAe,aAAf,eAAe,cAAf,eAAe,GACf;QACI,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;KAC7D,EACD,SAAS,EACT,CAAC,mBAAmB,CAAC,EACrB,EAAE,cAAc,EAAE,qBAAqB,EAAE,CAC5C,CAAC;IAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,YAAY,CAChC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC,EAC/C,EAAE,cAAc,EAAE,IAAA,gCAAkB,GAAE,EAAE,CAC3C,CAAC;IAEF,OAAO,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;AACnE,CAAC;AA3BD,kEA2BC;AAEM,KAAK,UAAU,gBAAgB,CAClC,QAA6B,EAC7B,SAAqB,EACrB,cAAuB,EACvB,SAA6B,EAC7B,iBAAsC,IAAA,gCAAkB,GAAE;IAE1D,MAAM,mBAAmB,GAAyB;QAC9C,cAAc,EAAE;YACZ,cAAc,EAAE,qBAAqB;YACrC,SAAS;SACZ;QACD,WAAW,EAAE,EAAE,cAAc,EAAE;KAClC,CAAC;IAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAC5D,OAAO,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;AACnE,CAAC;AAjBD,4CAiBC;AAEM,KAAK,UAAU,YAAY,CAAC,UAAuB,EAAE,SAAiB,iBAAiB;IAC1F,MAAM,MAAM,GAAG,UAAU,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAExD,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC;IACnD,IAAA,qBAAM,EAAC,YAAY,CAAC,OAAO,EAAE,iCAAiC,CAAC,CAAC;IAChE,IAAA,qBAAM,EAAC,YAAY,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ,EACvC,yDAAyD,CAAC,CAAC;IAC/D,IAAA,qBAAM,EAAC,YAAY,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,2BAA2B,CAAC,CAAC;IAEjF,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC;IAC1D,IAAA,qBAAM,EAAC,eAAe,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC;IAC5D,IAAA,qBAAM,EAAC,aAAa,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAE5D,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAE1D,OAAO;QACH,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,WAAW;QAC1C,cAAc,EAAE,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM;KAClE,CAAC;AACN,CAAC;AArBD,oCAqBC;AAEM,KAAK,UAAU,0BAA0B,CAAC,SAAqB;IAClE,IAAI,SAAS,CAAC,eAAe,KAAK,kCAAe,CAAC,SAAS,EAAE;QACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;KACjF;AACL,CAAC;AAJD,gEAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ContainerRuntimeFactoryWithDefaultDataStore } from \"@fluidframework/aqueduct\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IContainer, IHostLoader, LoaderHeader } from \"@fluidframework/container-definitions\";\nimport { ConnectionState } from \"@fluidframework/container-loader\";\nimport {\n    IGCRuntimeOptions,\n    ISummarizer,\n    ISummaryRuntimeOptions,\n} from \"@fluidframework/container-runtime\";\nimport { FluidObject, IRequest } from \"@fluidframework/core-interfaces\";\nimport { DriverHeader } from \"@fluidframework/driver-definitions\";\nimport {\n    IContainerRuntimeBase,\n    IFluidDataStoreFactory,\n    NamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport { IConfigProviderBase } from \"@fluidframework/telemetry-utils\";\nimport { ITestContainerConfig, ITestObjectProvider } from \"./testObjectProvider\";\nimport { mockConfigProvider } from \"./TestConfigs\";\n\nconst summarizerClientType = \"summarizer\";\n\nasync function createSummarizerCore(container: IContainer, loader: IHostLoader, summaryVersion?: string) {\n    const absoluteUrl = await container.getAbsoluteUrl(\"\");\n    if (absoluteUrl === undefined) {\n        throw new Error(\"URL could not be resolved\");\n    }\n\n    const request: IRequest = {\n        headers: {\n            [LoaderHeader.cache]: false,\n            [LoaderHeader.clientDetails]: {\n                capabilities: { interactive: false },\n                type: summarizerClientType,\n            },\n            [DriverHeader.summarizingClient]: true,\n            [LoaderHeader.reconnect]: false,\n            [LoaderHeader.version]: summaryVersion,\n        },\n        url: absoluteUrl,\n    };\n    const summarizerContainer = await loader.resolve(request);\n    await waitForContainerConnection(summarizerContainer);\n\n    const fluidObject =\n        await requestFluidObject<FluidObject<ISummarizer>>(summarizerContainer, { url: \"_summarizer\" });\n    if (fluidObject.ISummarizer === undefined) {\n        throw new Error(\"Fluid object does not implement ISummarizer\");\n    }\n    return fluidObject.ISummarizer;\n}\n\nconst defaultSummaryOptions: ISummaryRuntimeOptions = {\n    summaryConfigOverrides: {\n        state: \"disableHeuristics\",\n        maxAckWaitTime: 10000,\n        maxOpsSinceLastSummary: 7000,\n        initialSummarizerDelayMs: 0,\n        summarizerClientElection: false,\n    },\n};\n\nexport async function createSummarizerFromFactory(\n    provider: ITestObjectProvider,\n    container: IContainer,\n    dataStoreFactory: IFluidDataStoreFactory,\n    summaryVersion?: string,\n    containerRuntimeFactoryType = ContainerRuntimeFactoryWithDefaultDataStore,\n    registryEntries?: NamedFluidDataStoreRegistryEntries,\n): Promise<ISummarizer> {\n    const innerRequestHandler = async (request: IRequest, runtime: IContainerRuntimeBase) =>\n        runtime.IFluidHandleContext.resolveHandle(request);\n    const runtimeFactory = new containerRuntimeFactoryType(\n        dataStoreFactory,\n        registryEntries ??\n        [\n            [dataStoreFactory.type, Promise.resolve(dataStoreFactory)],\n        ],\n        undefined,\n        [innerRequestHandler],\n        { summaryOptions: defaultSummaryOptions },\n    );\n\n    const loader = provider.createLoader(\n        [[provider.defaultCodeDetails, runtimeFactory]],\n        { configProvider: mockConfigProvider() },\n    );\n\n    return createSummarizerCore(container, loader, summaryVersion);\n}\n\nexport async function createSummarizer(\n    provider: ITestObjectProvider,\n    container: IContainer,\n    summaryVersion?: string,\n    gcOptions?: IGCRuntimeOptions,\n    configProvider: IConfigProviderBase = mockConfigProvider(),\n): Promise<ISummarizer> {\n    const testContainerConfig: ITestContainerConfig = {\n        runtimeOptions: {\n            summaryOptions: defaultSummaryOptions,\n            gcOptions,\n        },\n        loaderProps: { configProvider },\n    };\n\n    const loader = provider.makeTestLoader(testContainerConfig);\n    return createSummarizerCore(container, loader, summaryVersion);\n}\n\nexport async function summarizeNow(summarizer: ISummarizer, reason: string = \"end-to-end test\") {\n    const result = summarizer.summarizeOnDemand({ reason });\n\n    const submitResult = await result.summarySubmitted;\n    assert(submitResult.success, \"on-demand summary should submit\");\n    assert(submitResult.data.stage === \"submit\",\n        \"on-demand summary submitted data stage should be submit\");\n    assert(submitResult.data.summaryTree !== undefined, \"summary tree should exist\");\n\n    const broadcastResult = await result.summaryOpBroadcasted;\n    assert(broadcastResult.success, \"summary op should be broadcast\");\n\n    const ackNackResult = await result.receivedSummaryAckOrNack;\n    assert(ackNackResult.success, \"summary op should be acked\");\n\n    await new Promise((resolve) => process.nextTick(resolve));\n\n    return {\n        summaryTree: submitResult.data.summaryTree,\n        summaryVersion: ackNackResult.data.summaryAckOp.contents.handle,\n    };\n}\n\nexport async function waitForContainerConnection(container: IContainer): Promise<void> {\n    if (container.connectionState !== ConnectionState.Connected) {\n        return new Promise((resolve) => container.once(\"connected\", () => resolve()));\n    }\n}\n"]}

package/dist/index.d.ts

@@ -11,4 +11,7 @@ export * from "./retry";
 export * from "./testContainerRuntimeFactory";
 export * from "./testFluidObject";
 export * from "./timeoutUtils";
+export * from "./DriverWrappers";
+export * from "./TestSummaryUtils";
+export * from "./TestConfigs";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -23,4 +23,7 @@ __exportStar(require("./retry"), exports);
 __exportStar(require("./testContainerRuntimeFactory"), exports);
 __exportStar(require("./testFluidObject"), exports);
 __exportStar(require("./timeoutUtils"), exports);
+__exportStar(require("./DriverWrappers"), exports);
+__exportStar(require("./TestSummaryUtils"), exports);
+__exportStar(require("./TestConfigs"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,+CAA6B;AAC7B,uDAAqC;AACrC,2DAAyC;AACzC,gDAA8B;AAC9B,oDAAkC;AAClC,0CAAwB;AACxB,gEAA8C;AAC9C,oDAAkC;AAClC,iDAA+B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./interfaces\";\nexport * from \"./testObjectProvider\";\nexport * from \"./loaderContainerTracker\";\nexport * from \"./localLoader\";\nexport * from \"./localCodeLoader\";\nexport * from \"./retry\";\nexport * from \"./testContainerRuntimeFactory\";\nexport * from \"./testFluidObject\";\nexport * from \"./timeoutUtils\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,+CAA6B;AAC7B,uDAAqC;AACrC,2DAAyC;AACzC,gDAA8B;AAC9B,oDAAkC;AAClC,0CAAwB;AACxB,gEAA8C;AAC9C,oDAAkC;AAClC,iDAA+B;AAC/B,mDAAiC;AACjC,qDAAmC;AACnC,gDAA8B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./interfaces\";\nexport * from \"./testObjectProvider\";\nexport * from \"./loaderContainerTracker\";\nexport * from \"./localLoader\";\nexport * from \"./localCodeLoader\";\nexport * from \"./retry\";\nexport * from \"./testContainerRuntimeFactory\";\nexport * from \"./testFluidObject\";\nexport * from \"./timeoutUtils\";\nexport * from \"./DriverWrappers\";\nexport * from \"./TestSummaryUtils\";\nexport * from \"./TestConfigs\";\n"]}

package/dist/loaderContainerTracker.d.ts

@@ -34,17 +34,33 @@ export declare class LoaderContainerTracker implements IOpProcessingController {
      */
     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.
+     * Ensure all tracked containers are synchronized
      */
     ensureSynchronized(...containers: IContainer[]): Promise<void>;
+    /**
+     * Ensure all tracked containers are synchronized with a time limit
+     */
+    ensureSynchronizedWithTimeout?(timeoutDuration: number | undefined, ...containers: IContainer[]): Promise<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.
+     */
+    private processSynchronized;
     /**
      * 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.

package/dist/loaderContainerTracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loaderContainerTracker.d.ts","sourceRoot":"","sources":["../src/loaderContainerTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,UAAU,EAAe,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAI7F,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAqB/D,qBAAa,sBAAuB,YAAW,uBAAuB;IAItD,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAHlD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0C;IACrE,OAAO,CAAC,kBAAkB,CAAa;gBAEV,qBAAqB,GAAE,OAAe;IAEnE;;;OAGG;IACI,GAAG,CAAC,UAAU,SAAS,WAAW,EAAE,MAAM,EAAE,UAAU;IAiB7D;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAsC1B,OAAO,CAAC,iBAAiB;IAQzB;;OAEG;IACI,KAAK;IAUZ;;;;;;;;;;OAUG;IACU,kBAAkB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAqD3D;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAyBzB;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IA0CpC;;;;;;;OAOG;YACW,qBAAqB;IA6BnC;;;OAGG;YACW,oBAAoB;IAclC;;OAEG;IACI,gBAAgB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAgBnD;;;OAGG;IACU,eAAe,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAexD;;;;OAIG;IACU,eAAe,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAIxD;;;;OAIG;IACU,eAAe,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAIxD;;OAEG;YACW,YAAY;IAqC1B;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAyBzB;;OAEG;IACH,OAAO,CAAC,UAAU;IA8DlB;;;;OAIG;IACH,OAAO,CAAC,aAAa;CAIxB"}
+{"version":3,"file":"loaderContainerTracker.d.ts","sourceRoot":"","sources":["../src/loaderContainerTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,UAAU,EAAe,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAK7F,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAyB/D,qBAAa,sBAAuB,YAAW,uBAAuB;IAItD,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAHlD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0C;IACrE,OAAO,CAAC,kBAAkB,CAAa;gBAEV,qBAAqB,GAAE,OAAe;IAEnE;;;OAGG;IACI,GAAG,CAAC,UAAU,SAAS,WAAW,EAAE,MAAM,EAAE,UAAU;IAiB7D;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAsC1B,OAAO,CAAC,iBAAiB;IAQzB;;OAEG;IACI,KAAK;IAUZ;;OAEG;IACU,kBAAkB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;OAEG;IACU,6BAA6B,CAAC,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,UAAU,EAAE,UAAU,EAAE;IAI5G;;;;;;;;;;;;;;;;;;OAkBG;YACW,mBAAmB;IA0EjC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAyBzB;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IA0CpC;;;;;;;OAOG;YACW,qBAAqB;IA6BnC;;;OAGG;YACW,oBAAoB;IAclC;;OAEG;IACI,gBAAgB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAgBnD;;;OAGG;IACU,eAAe,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAexD;;;;OAIG;IACU,eAAe,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAIxD;;;;OAIG;IACU,eAAe,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE;IAIxD;;OAEG;YACW,YAAY;IAqC1B;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAyBzB;;OAEG;IACH,OAAO,CAAC,UAAU;IA8DlB;;;;OAIG;IACH,OAAO,CAAC,aAAa;CAIxB"}

package/dist/loaderContainerTracker.js

@@ -3,13 +3,18 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable @typescript-eslint/strict-boolean-expressions */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoaderContainerTracker = void 0;
 const common_utils_1 = require("@fluidframework/common-utils");
+const driver_utils_1 = require("@fluidframework/driver-utils");
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
 const debug_1 = require("./debug");
+const timeoutUtils_1 = require("./timeoutUtils");
 const debugOp = debug_1.debug.extend("ops");
 const debugWait = debug_1.debug.extend("wait");
+// set the maximum timeout value as 5 mins
+const defaultMaxTimeout = 5 * 6000;
 class LoaderContainerTracker {
     constructor(syncSummarizerClients = false) {
         this.syncSummarizerClients = syncSummarizerClients;
@@ -72,7 +77,7 @@ class LoaderContainerTracker {
     trackTrailingNoOps(container, record) {
         container.deltaManager.outbound.on("op", (messages) => {
             for (const msg of messages) {
-                if (msg.type === protocol_definitions_1.MessageType.NoOp) {
+                if ((0, driver_utils_1.canBeCoalescedByService)(msg)) {
                     // Track the NoOp that was sent.
                     if (record.trailingNoOps === 0) {
                         // record the starting sequence number of the trailing no ops if we haven't been tracking yet.
@@ -88,7 +93,7 @@ class LoaderContainerTracker {
         });
         container.deltaManager.inbound.on("push", (message) => {
             // Received the no op back, update the record if we are tracking
-            if (message.type === protocol_definitions_1.MessageType.NoOp
+            if ((0, driver_utils_1.canBeCoalescedByService)(message)
                 && message.clientId === container.clientId
                 && record.trailingNoOps !== 0
                 && record.startTrailingNoOps <= message.clientSequenceNumber) {
@@ -123,17 +128,38 @@ class LoaderContainerTracker {
         // REVIEW: do we need to unpatch the loaders?
     }
     /**
-     * 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.
+     * Ensure all tracked containers are synchronized
      */
     async ensureSynchronized(...containers) {
+        await this.processSynchronized(undefined, ...containers);
+    }
+    /**
+     * Ensure all tracked containers are synchronized with a time limit
+     */
+    async ensureSynchronizedWithTimeout(timeoutDuration, ...containers) {
+        await this.processSynchronized(timeoutDuration, ...containers);
+    }
+    /**
+     * 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.
+     */
+    async processSynchronized(timeoutDuration, ...containers) {
+        const start = Date.now();
         const resumed = this.resumeProcessing(...containers);
         let waitingSequenceNumberSynchronized = false;
         // eslint-disable-next-line no-constant-condition
@@ -159,12 +185,18 @@ class LoaderContainerTracker {
                         // Only write it out once
                         waitingSequenceNumberSynchronized = true;
                         debugWait("Waiting for sequence number synchronized");
-                        await this.waitForAnyInboundOps(containersToApply);
+                        await (0, timeoutUtils_1.timeoutAwait)(this.waitForAnyInboundOps(containersToApply), {
+                            durationMs: timeoutDuration ? timeoutDuration - (Date.now() - start) : defaultMaxTimeout,
+                            errorMsg: "Timeout on waiting for sequence number synchronized",
+                        });
                     }
                 }
                 else {
                     waitingSequenceNumberSynchronized = false;
-                    await this.waitForPendingClients(pendingClients);
+                    await (0, timeoutUtils_1.timeoutAwait)(this.waitForPendingClients(pendingClients), {
+                        durationMs: timeoutDuration ? timeoutDuration - (Date.now() - start) : defaultMaxTimeout,
+                        errorMsg: "Timeout on waiting for pending join or leave op",
+                    });
                 }
             }
             else {
@@ -172,7 +204,13 @@ class LoaderContainerTracker {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 debugWait(`Waiting container to be saved ${dirtyContainers.map((c) => this.containers.get(c).index)}`);
                 waitingSequenceNumberSynchronized = false;
-                await Promise.all(dirtyContainers.map(async (c) => new Promise((resolve) => c.once("saved", resolve))));
+                const remainedDuration = timeoutDuration ? timeoutDuration - (Date.now() - start) : defaultMaxTimeout;
+                await Promise.all(dirtyContainers.map(async (c) => Promise.race([(0, timeoutUtils_1.timeoutPromise)((resolve) => c.once("saved", () => resolve()), {
+                        durationMs: remainedDuration,
+                        errorMsg: "Timeout on waiting a container to be saved",
+                    }),
+                    new Promise((resolve) => c.once("closed", resolve)),
+                ])));
             }
             // yield a turn to allow side effect of the ops we just processed execute before we check again
             await new Promise((resolve) => { setTimeout(resolve, 0); });
@@ -180,7 +218,10 @@ class LoaderContainerTracker {
         // Pause all container that was resumed
         // don't call pause if resumed is empty and pause everything, which is not what we want
         if (resumed.length !== 0) {
-            await this.pauseProcessing(...resumed);
+            await (0, timeoutUtils_1.timeoutAwait)(this.pauseProcessing(...resumed), {
+                durationMs: timeoutDuration ? timeoutDuration - (Date.now() - start) : defaultMaxTimeout,
+                errorMsg: "Timeout on waiting for pausing all resumed containers",
+            });
         }
         debugWait("Synchronized");
     }
@@ -404,13 +445,13 @@ class LoaderContainerTracker {
     setupInOutTracker(container, inflightTracker) {
         const outHandler = (messages) => {
             for (const message of messages) {
-                if (message.type !== protocol_definitions_1.MessageType.NoOp) {
+                if (!(0, driver_utils_1.canBeCoalescedByService)(message)) {
                     inflightTracker.set(container, message.clientSequenceNumber);
                 }
             }
         };
         const inHandler = (message) => {
-            if (message.type !== protocol_definitions_1.MessageType.NoOp
+            if (!(0, driver_utils_1.canBeCoalescedByService)(message)
                 && message.clientId === container.clientId
                 && inflightTracker.get(container) === message.clientSequenceNumber) {
                 inflightTracker.delete(container);