@fluidframework/container-runtime 2.0.0-rc.1.0.6 → 2.0.0-rc.2.0.1

package/lib/test/summary/summarizerHeuristics.spec.js

@@ -0,0 +1,289 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import sinon from "sinon";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { SummarizeHeuristicData, SummarizeHeuristicRunner, } from "../../summary/index.js";
+describe("Runtime", () => {
+    describe("Summarization", () => {
+        describe("Summarize Heuristic Runner", () => {
+            let clock;
+            before(() => {
+                clock = sinon.useFakeTimers();
+            });
+            after(() => {
+                clock.restore();
+            });
+            const defaultSummaryConfig = {
+                state: "enabled",
+                maxTime: 5000 * 12,
+                maxOps: 1000,
+                minOpsForLastSummaryAttempt: 50,
+                maxAckWaitTime: 120000,
+                maxOpsSinceLastSummary: 7000,
+                initialSummarizerDelayMs: 0,
+                minIdleTime: 5000,
+                maxIdleTime: 5000,
+                nonRuntimeOpWeight: 0.1,
+                runtimeOpWeight: 1.0,
+            };
+            let summaryConfig;
+            let data;
+            let runner;
+            let mockLogger;
+            let attempts;
+            const trySummarize = (reason) => {
+                attempts.push(reason);
+            };
+            const getLastAttempt = () => attempts.length > 0 ? attempts[attempts.length - 1] : undefined;
+            function assertAttemptCount(count, message) {
+                const fullMessage = `${attempts.length} !== ${count}; ${message ?? "unexpected attempt count"}`;
+                assert(attempts.length === count, fullMessage);
+            }
+            function initialize({ refSequenceNumber = 0, lastOpSequenceNumber = refSequenceNumber, summaryTime = Date.now(), maxTime = defaultSummaryConfig.maxTime, maxOps = defaultSummaryConfig.maxOps, maxAckWaitTime = defaultSummaryConfig.maxAckWaitTime, maxOpsSinceLastSummary = defaultSummaryConfig.maxOpsSinceLastSummary, initialSummarizerDelayMs = defaultSummaryConfig.initialSummarizerDelayMs, minOpsForLastSummaryAttempt = defaultSummaryConfig.minOpsForLastSummaryAttempt, run = true, minIdleTime = defaultSummaryConfig.minIdleTime, maxIdleTime = defaultSummaryConfig.maxIdleTime, nonRuntimeOpWeight = defaultSummaryConfig.nonRuntimeOpWeight, runtimeOpWeight = defaultSummaryConfig.runtimeOpWeight, } = {}) {
+                mockLogger = new MockLogger();
+                data = new SummarizeHeuristicData(lastOpSequenceNumber, {
+                    refSequenceNumber,
+                    summaryTime,
+                });
+                summaryConfig = {
+                    state: "enabled",
+                    maxTime,
+                    maxOps,
+                    maxAckWaitTime,
+                    maxOpsSinceLastSummary,
+                    initialSummarizerDelayMs,
+                    minOpsForLastSummaryAttempt,
+                    minIdleTime,
+                    maxIdleTime,
+                    nonRuntimeOpWeight,
+                    runtimeOpWeight,
+                };
+                runner = new SummarizeHeuristicRunner(data, summaryConfig, trySummarize, mockLogger.toTelemetryLogger());
+                if (run) {
+                    runner.run();
+                }
+            }
+            beforeEach(() => {
+                attempts = [];
+            });
+            afterEach(() => {
+                clock.reset();
+            });
+            it("Should summarize after maxOps with no prior summary", () => {
+                const maxOps = 100;
+                initialize({ maxOps });
+                data.lastOpSequenceNumber = maxOps;
+                data.numRuntimeOps = maxOps;
+                runner.run();
+                assertAttemptCount(0, "should not run yet");
+                data.lastOpSequenceNumber++;
+                data.numRuntimeOps++;
+                runner.run();
+                assertAttemptCount(1, "should run now");
+                assert(getLastAttempt() === "maxOps");
+            });
+            it("Should summarize after maxOps", () => {
+                const lastSummary = 1000;
+                const maxOps = 100;
+                initialize({ refSequenceNumber: lastSummary, maxOps });
+                data.lastOpSequenceNumber = lastSummary + maxOps;
+                data.numRuntimeOps = maxOps;
+                runner.run();
+                assertAttemptCount(0, "should not run yet");
+                data.lastOpSequenceNumber++;
+                data.numRuntimeOps++;
+                runner.run();
+                assertAttemptCount(1, "should run now");
+                assert(getLastAttempt() === "maxOps");
+            });
+            it("Should summarize after maxTime", () => {
+                const lastSummary = 1000;
+                const idleTime = 101;
+                const maxTime = 1000;
+                const idlesPerActive = Math.floor((maxTime + 1) / (idleTime - 1));
+                const remainingTime = (maxTime + 1) % (idleTime - 1);
+                initialize({
+                    refSequenceNumber: lastSummary,
+                    minIdleTime: idleTime,
+                    maxIdleTime: idleTime,
+                    maxTime,
+                });
+                data.lastOpSequenceNumber = lastSummary + 1;
+                for (let i = 0; i < idlesPerActive; i++) {
+                    // Prevent idle timer from triggering with periodic "ops" (heuristic runs)
+                    clock.tick(idleTime - 1);
+                    runner.run();
+                }
+                clock.tick(remainingTime - 1);
+                runner.run();
+                assertAttemptCount(0, "should not run yet");
+                clock.tick(1);
+                runner.run();
+                assertAttemptCount(1, "should run now");
+                assert(getLastAttempt() === "maxTime");
+            });
+            it("Should summarize after idleTime", () => {
+                const lastSummary = 1000;
+                const idleTime = 101;
+                const maxTime = 1000;
+                initialize({
+                    refSequenceNumber: lastSummary,
+                    minIdleTime: idleTime,
+                    maxIdleTime: idleTime,
+                    maxTime,
+                });
+                data.lastOpSequenceNumber = lastSummary + 1;
+                clock.tick(idleTime - 1);
+                assertAttemptCount(0, "should not run yet");
+                clock.tick(1);
+                assertAttemptCount(1, "should run now");
+                assert(getLastAttempt() === "idle");
+            });
+            it("Should summarize after idleTime after a few interruptions", () => {
+                const lastSummary = 1000;
+                const idleTime = 101;
+                const maxTime = 1000;
+                initialize({
+                    refSequenceNumber: lastSummary,
+                    minIdleTime: idleTime,
+                    maxIdleTime: idleTime,
+                    maxTime,
+                });
+                data.lastOpSequenceNumber = lastSummary + 1;
+                clock.tick(idleTime - 1);
+                assertAttemptCount(0, "should not run yet");
+                runner.run(); // interrupts idle timer
+                clock.tick(idleTime - 1);
+                assertAttemptCount(0, "still should not run yet");
+                runner.run(); // interrupts idle timer
+                clock.tick(idleTime - 1);
+                assertAttemptCount(0, "still should not run yet again");
+                clock.tick(idleTime);
+                assertAttemptCount(1, "should run now");
+                assert(getLastAttempt() === "idle");
+            });
+            it("Should summarize on close if enough outstanding ops", () => {
+                const minOpsForLastSummaryAttempt = 10;
+                initialize({ minOpsForLastSummaryAttempt, runtimeOpWeight: 1.0 });
+                data.numRuntimeOps = minOpsForLastSummaryAttempt;
+                assert.strictEqual(runner.shouldRunLastSummary(), true, "should run on close");
+            });
+            it("Should not summarize on close if insufficient outstanding ops", () => {
+                const minOpsForLastSummaryAttempt = 10;
+                initialize({ minOpsForLastSummaryAttempt, runtimeOpWeight: 1.0 });
+                data.numRuntimeOps = minOpsForLastSummaryAttempt - 1;
+                assert.strictEqual(runner.shouldRunLastSummary(), false, "should not run on close");
+            });
+            it("Should summarize on close weights ops properly", () => {
+                const minOpsForLastSummaryAttempt = 2;
+                initialize({
+                    minOpsForLastSummaryAttempt,
+                    runtimeOpWeight: 0.1,
+                    nonRuntimeOpWeight: 1.1,
+                });
+                data.numRuntimeOps += 8;
+                assert.strictEqual(runner.shouldRunLastSummary(), false, "should not run yet");
+                data.numNonRuntimeOps += 1;
+                assert.strictEqual(runner.shouldRunLastSummary(), false, "should not run yet");
+                data.numRuntimeOps += 1;
+                assert.strictEqual(runner.shouldRunLastSummary(), true, "should run");
+            });
+            it("Should not run idle timer after dispose", () => {
+                const lastSummary = 1000;
+                const idleTime = 101;
+                const maxTime = 1000;
+                initialize({
+                    refSequenceNumber: lastSummary,
+                    minIdleTime: idleTime,
+                    maxIdleTime: idleTime,
+                    maxTime,
+                });
+                data.lastOpSequenceNumber = lastSummary + 1;
+                clock.tick(idleTime - 1);
+                runner.run();
+                assertAttemptCount(0, "should not run yet");
+                runner.dispose();
+                clock.tick(1);
+                runner.run();
+                assertAttemptCount(0, "should still run since disposed");
+            });
+            it("Idle time value should change based on op counts", () => {
+                const minIdleTime = 0;
+                const maxIdleTime = 1;
+                const maxTime = 1000;
+                const maxOps = 1000;
+                const runtimeOpWeight = 1.0;
+                const nonRuntimeOpWeight = 1.0;
+                initialize({
+                    minIdleTime,
+                    maxIdleTime,
+                    maxTime,
+                    maxOps,
+                    runtimeOpWeight,
+                    nonRuntimeOpWeight,
+                });
+                data.lastOpSequenceNumber = maxOps;
+                assert.strictEqual(runner.idleTime, maxIdleTime, "should start at the maxIdleTime");
+                data.numRuntimeOps += 50;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 0.05);
+                data.numRuntimeOps += 123;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 0.173);
+                data.numRuntimeOps += 500;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 0.673);
+                data.numRuntimeOps += 326;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 0.999);
+                data.numRuntimeOps += 1;
+                assert.strictEqual(runner.idleTime, minIdleTime);
+                data.numRuntimeOps += 100;
+                assert.strictEqual(runner.idleTime, minIdleTime, "should never go below the minIdleTime");
+            });
+            it("Idle time should change based on op weights", () => {
+                const minIdleTime = 0;
+                const maxIdleTime = 1000;
+                const maxTime = 1000;
+                const maxOps = 1000;
+                const runtimeOpWeight = 0.1;
+                const nonRuntimeOpWeight = 1.1;
+                initialize({
+                    minIdleTime,
+                    maxIdleTime,
+                    maxTime,
+                    maxOps,
+                    runtimeOpWeight,
+                    nonRuntimeOpWeight,
+                });
+                data.lastOpSequenceNumber = maxOps;
+                assert.strictEqual(runner.idleTime, maxIdleTime, "should start at the maxIdleTime");
+                data.numRuntimeOps += 50;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 5);
+                data.numRuntimeOps += 123;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 17.3);
+                data.numNonRuntimeOps += 500;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 567.3);
+                data.numNonRuntimeOps += 1;
+                assert.strictEqual(runner.idleTime, maxIdleTime - 568.4);
+            });
+            it("Weights ops properly", () => {
+                const maxOps = 2;
+                const runtimeOpWeight = 0.1;
+                const nonRuntimeOpWeight = 1.1;
+                initialize({ maxOps, runtimeOpWeight, nonRuntimeOpWeight });
+                data.lastOpSequenceNumber = maxOps;
+                data.numRuntimeOps += 9;
+                runner.run();
+                assertAttemptCount(0, "should not run yet");
+                data.numNonRuntimeOps += 1;
+                runner.run();
+                assertAttemptCount(0, "should not run yet");
+                data.numRuntimeOps += 1;
+                runner.run();
+                assertAttemptCount(1, "should run");
+                assert(getLastAttempt() === "maxOps");
+            });
+        });
+    });
+});
+//# sourceMappingURL=summarizerHeuristics.spec.js.map

package/lib/test/summary/summarizerHeuristics.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarizerHeuristics.spec.js","sourceRoot":"","sources":["../../../src/test/summary/summarizerHeuristics.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EACN,sBAAsB,EACtB,wBAAwB,GAIxB,MAAM,wBAAwB,CAAC;AAEhC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACxB,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC9B,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC3C,IAAI,KAA4B,CAAC;YACjC,MAAM,CAAC,GAAG,EAAE;gBACX,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;YAC/B,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,GAAG,EAAE;gBACV,KAAK,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC,CAAC,CAAC;YAEH,MAAM,oBAAoB,GAAoC;gBAC7D,KAAK,EAAE,SAAS;gBAChB,OAAO,EAAE,IAAI,GAAG,EAAE;gBAClB,MAAM,EAAE,IAAI;gBACZ,2BAA2B,EAAE,EAAE;gBAC/B,cAAc,EAAE,MAAM;gBACtB,sBAAsB,EAAE,IAAI;gBAC5B,wBAAwB,EAAE,CAAC;gBAC3B,WAAW,EAAE,IAAI;gBACjB,WAAW,EAAE,IAAI;gBACjB,kBAAkB,EAAE,GAAG;gBACvB,eAAe,EAAE,GAAG;aACpB,CAAC;YACF,IAAI,aAA8C,CAAC;YACnD,IAAI,IAA6B,CAAC;YAClC,IAAI,MAAgC,CAAC;YACrC,IAAI,UAAsB,CAAC;YAE3B,IAAI,QAA2B,CAAC;YAChC,MAAM,YAAY,GAAG,CAAC,MAAuB,EAAE,EAAE;gBAChD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC,CAAC;YACF,MAAM,cAAc,GAAG,GAAG,EAAE,CAC3B,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjE,SAAS,kBAAkB,CAAC,KAAa,EAAE,OAAgB;gBAC1D,MAAM,WAAW,GAAG,GAAG,QAAQ,CAAC,MAAM,QAAQ,KAAK,KAClD,OAAO,IAAI,0BACZ,EAAE,CAAC;gBACH,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,KAAK,EAAE,WAAW,CAAC,CAAC;YAChD,CAAC;YAED,SAAS,UAAU,CAAC,EACnB,iBAAiB,GAAG,CAAC,EACrB,oBAAoB,GAAG,iBAAiB,EACxC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,EACxB,OAAO,GAAG,oBAAoB,CAAC,OAAO,EACtC,MAAM,GAAG,oBAAoB,CAAC,MAAM,EACpC,cAAc,GAAG,oBAAoB,CAAC,cAAc,EACpD,sBAAsB,GAAG,oBAAoB,CAAC,sBAAsB,EACpE,wBAAwB,GAAG,oBAAoB,CAAC,wBAAwB,EACxE,2BAA2B,GAAG,oBAAoB,CAAC,2BAA2B,EAC9E,GAAG,GAAG,IAAI,EACV,WAAW,GAAG,oBAAoB,CAAC,WAAW,EAC9C,WAAW,GAAG,oBAAoB,CAAC,WAAW,EAC9C,kBAAkB,GAAG,oBAAoB,CAAC,kBAAkB,EAC5D,eAAe,GAAG,oBAAoB,CAAC,eAAe,MAOnD,EAAE;gBACL,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;gBAC9B,IAAI,GAAG,IAAI,sBAAsB,CAAC,oBAAoB,EAAE;oBACvD,iBAAiB;oBACjB,WAAW;iBACX,CAAC,CAAC;gBACH,aAAa,GAAG;oBACf,KAAK,EAAE,SAAS;oBAChB,OAAO;oBACP,MAAM;oBACN,cAAc;oBACd,sBAAsB;oBACtB,wBAAwB;oBACxB,2BAA2B;oBAC3B,WAAW;oBACX,WAAW;oBACX,kBAAkB;oBAClB,eAAe;iBACN,CAAC;gBAEX,MAAM,GAAG,IAAI,wBAAwB,CACpC,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,UAAU,CAAC,iBAAiB,EAAE,CAC9B,CAAC;gBAEF,IAAI,GAAG,EAAE;oBACR,MAAM,CAAC,GAAG,EAAE,CAAC;iBACb;YACF,CAAC;YAED,UAAU,CAAC,GAAG,EAAE;gBACf,QAAQ,GAAG,EAAE,CAAC;YACf,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,GAAG,EAAE;gBACd,KAAK,CAAC,KAAK,EAAE,CAAC;YACf,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;gBAC9D,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;gBAEvB,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC;gBACnC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;gBAC5B,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC5B,IAAI,CAAC,aAAa,EAAE,CAAC;gBACrB,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;gBACxC,MAAM,CAAC,cAAc,EAAE,KAAK,QAAQ,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;gBACxC,MAAM,WAAW,GAAG,IAAI,CAAC;gBACzB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,UAAU,CAAC,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;gBAEvD,IAAI,CAAC,oBAAoB,GAAG,WAAW,GAAG,MAAM,CAAC;gBACjD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;gBAC5B,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC5B,IAAI,CAAC,aAAa,EAAE,CAAC;gBACrB,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;gBACxC,MAAM,CAAC,cAAc,EAAE,KAAK,QAAQ,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;gBACzC,MAAM,WAAW,GAAG,IAAI,CAAC;gBACzB,MAAM,QAAQ,GAAG,GAAG,CAAC;gBACrB,MAAM,OAAO,GAAG,IAAI,CAAC;gBACrB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;gBAClE,MAAM,aAAa,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACrD,UAAU,CAAC;oBACV,iBAAiB,EAAE,WAAW;oBAC9B,WAAW,EAAE,QAAQ;oBACrB,WAAW,EAAE,QAAQ;oBACrB,OAAO;iBACP,CAAC,CAAC;gBAEH,IAAI,CAAC,oBAAoB,GAAG,WAAW,GAAG,CAAC,CAAC;gBAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE;oBACxC,0EAA0E;oBAC1E,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;oBACzB,MAAM,CAAC,GAAG,EAAE,CAAC;iBACb;gBACD,KAAK,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;gBAC9B,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACd,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;gBACxC,MAAM,CAAC,cAAc,EAAE,KAAK,SAAS,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;gBAC1C,MAAM,WAAW,GAAG,IAAI,CAAC;gBACzB,MAAM,QAAQ,GAAG,GAAG,CAAC;gBACrB,MAAM,OAAO,GAAG,IAAI,CAAC;gBACrB,UAAU,CAAC;oBACV,iBAAiB,EAAE,WAAW;oBAC9B,WAAW,EAAE,QAAQ;oBACrB,WAAW,EAAE,QAAQ;oBACrB,OAAO;iBACP,CAAC,CAAC;gBAEH,IAAI,CAAC,oBAAoB,GAAG,WAAW,GAAG,CAAC,CAAC;gBAE5C,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACzB,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACd,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;gBACxC,MAAM,CAAC,cAAc,EAAE,KAAK,MAAM,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;gBACpE,MAAM,WAAW,GAAG,IAAI,CAAC;gBACzB,MAAM,QAAQ,GAAG,GAAG,CAAC;gBACrB,MAAM,OAAO,GAAG,IAAI,CAAC;gBACrB,UAAU,CAAC;oBACV,iBAAiB,EAAE,WAAW;oBAC9B,WAAW,EAAE,QAAQ;oBACrB,WAAW,EAAE,QAAQ;oBACrB,OAAO;iBACP,CAAC,CAAC;gBAEH,IAAI,CAAC,oBAAoB,GAAG,WAAW,GAAG,CAAC,CAAC;gBAE5C,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACzB,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAC5C,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,wBAAwB;gBAEtC,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACzB,kBAAkB,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC;gBAClD,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,wBAAwB;gBAEtC,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACzB,kBAAkB,CAAC,CAAC,EAAE,gCAAgC,CAAC,CAAC;gBAExD,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrB,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;gBACxC,MAAM,CAAC,cAAc,EAAE,KAAK,MAAM,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;gBAC9D,MAAM,2BAA2B,GAAG,EAAE,CAAC;gBACvC,UAAU,CAAC,EAAE,2BAA2B,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC;gBAElE,IAAI,CAAC,aAAa,GAAG,2BAA2B,CAAC;gBACjD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,qBAAqB,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;gBACxE,MAAM,2BAA2B,GAAG,EAAE,CAAC;gBACvC,UAAU,CAAC,EAAE,2BAA2B,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC;gBAElE,IAAI,CAAC,aAAa,GAAG,2BAA2B,GAAG,CAAC,CAAC;gBACrD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,yBAAyB,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;gBACzD,MAAM,2BAA2B,GAAG,CAAC,CAAC;gBACtC,UAAU,CAAC;oBACV,2BAA2B;oBAC3B,eAAe,EAAE,GAAG;oBACpB,kBAAkB,EAAE,GAAG;iBACvB,CAAC,CAAC;gBAEH,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;gBACxB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC;gBAE/E,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;gBAC3B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC;gBAE/E,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;gBACxB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;gBAClD,MAAM,WAAW,GAAG,IAAI,CAAC;gBACzB,MAAM,QAAQ,GAAG,GAAG,CAAC;gBACrB,MAAM,OAAO,GAAG,IAAI,CAAC;gBACrB,UAAU,CAAC;oBACV,iBAAiB,EAAE,WAAW;oBAC9B,WAAW,EAAE,QAAQ;oBACrB,WAAW,EAAE,QAAQ;oBACrB,OAAO;iBACP,CAAC,CAAC;gBAEH,IAAI,CAAC,oBAAoB,GAAG,WAAW,GAAG,CAAC,CAAC;gBAE5C,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACzB,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,MAAM,CAAC,OAAO,EAAE,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACd,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,iCAAiC,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;gBAC3D,MAAM,WAAW,GAAG,CAAC,CAAC;gBACtB,MAAM,WAAW,GAAG,CAAC,CAAC;gBACtB,MAAM,OAAO,GAAG,IAAI,CAAC;gBACrB,MAAM,MAAM,GAAG,IAAI,CAAC;gBACpB,MAAM,eAAe,GAAG,GAAG,CAAC;gBAC5B,MAAM,kBAAkB,GAAG,GAAG,CAAC;gBAC/B,UAAU,CAAC;oBACV,WAAW;oBACX,WAAW;oBACX,OAAO;oBACP,MAAM;oBACN,eAAe;oBACf,kBAAkB;iBAClB,CAAC,CAAC;gBAEH,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC;gBACnC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,iCAAiC,CAAC,CAAC;gBAEpF,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC;gBACzB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAC,CAAC;gBAExD,IAAI,CAAC,aAAa,IAAI,GAAG,CAAC;gBAC1B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,IAAI,GAAG,CAAC;gBAC1B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,IAAI,GAAG,CAAC;gBAC1B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;gBACxB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;gBAEjD,IAAI,CAAC,aAAa,IAAI,GAAG,CAAC;gBAC1B,MAAM,CAAC,WAAW,CACjB,MAAM,CAAC,QAAQ,EACf,WAAW,EACX,uCAAuC,CACvC,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;gBACtD,MAAM,WAAW,GAAG,CAAC,CAAC;gBACtB,MAAM,WAAW,GAAG,IAAI,CAAC;gBACzB,MAAM,OAAO,GAAG,IAAI,CAAC;gBACrB,MAAM,MAAM,GAAG,IAAI,CAAC;gBACpB,MAAM,eAAe,GAAG,GAAG,CAAC;gBAC5B,MAAM,kBAAkB,GAAG,GAAG,CAAC;gBAC/B,UAAU,CAAC;oBACV,WAAW;oBACX,WAAW;oBACX,OAAO;oBACP,MAAM;oBACN,eAAe;oBACf,kBAAkB;iBAClB,CAAC,CAAC;gBAEH,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC;gBACnC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,iCAAiC,CAAC,CAAC;gBAEpF,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC;gBACzB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;gBAErD,IAAI,CAAC,aAAa,IAAI,GAAG,CAAC;gBAC1B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAC,CAAC;gBAExD,IAAI,CAAC,gBAAgB,IAAI,GAAG,CAAC;gBAC7B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC;gBAEzD,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;gBAC3B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,KAAK,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;gBAC/B,MAAM,MAAM,GAAG,CAAC,CAAC;gBACjB,MAAM,eAAe,GAAG,GAAG,CAAC;gBAC5B,MAAM,kBAAkB,GAAG,GAAG,CAAC;gBAC/B,UAAU,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC,CAAC;gBAE5D,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC;gBAEnC,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;gBACxB,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;gBAC3B,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE5C,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;gBACxB,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,kBAAkB,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;gBACpC,MAAM,CAAC,cAAc,EAAE,KAAK,QAAQ,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport sinon from \"sinon\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { ISummaryConfiguration, ISummaryConfigurationHeuristics } from \"../../containerRuntime.js\";\nimport {\n\tSummarizeHeuristicData,\n\tSummarizeHeuristicRunner,\n\tISummarizeHeuristicData,\n\tISummarizeAttempt,\n\tSummarizeReason,\n} from \"../../summary/index.js\";\n\ndescribe(\"Runtime\", () => {\n\tdescribe(\"Summarization\", () => {\n\t\tdescribe(\"Summarize Heuristic Runner\", () => {\n\t\t\tlet clock: sinon.SinonFakeTimers;\n\t\t\tbefore(() => {\n\t\t\t\tclock = sinon.useFakeTimers();\n\t\t\t});\n\t\t\tafter(() => {\n\t\t\t\tclock.restore();\n\t\t\t});\n\n\t\t\tconst defaultSummaryConfig: ISummaryConfigurationHeuristics = {\n\t\t\t\tstate: \"enabled\",\n\t\t\t\tmaxTime: 5000 * 12, // 1 min (active)\n\t\t\t\tmaxOps: 1000, // 1k ops (active)\n\t\t\t\tminOpsForLastSummaryAttempt: 50,\n\t\t\t\tmaxAckWaitTime: 120000, // 2 min\n\t\t\t\tmaxOpsSinceLastSummary: 7000,\n\t\t\t\tinitialSummarizerDelayMs: 0,\n\t\t\t\tminIdleTime: 5000, // 5 sec (idle)\n\t\t\t\tmaxIdleTime: 5000, // 5 sec (idle)\n\t\t\t\tnonRuntimeOpWeight: 0.1,\n\t\t\t\truntimeOpWeight: 1.0,\n\t\t\t};\n\t\t\tlet summaryConfig: Readonly<ISummaryConfiguration>;\n\t\t\tlet data: ISummarizeHeuristicData;\n\t\t\tlet runner: SummarizeHeuristicRunner;\n\t\t\tlet mockLogger: MockLogger;\n\n\t\t\tlet attempts: SummarizeReason[];\n\t\t\tconst trySummarize = (reason: SummarizeReason) => {\n\t\t\t\tattempts.push(reason);\n\t\t\t};\n\t\t\tconst getLastAttempt = () =>\n\t\t\t\tattempts.length > 0 ? attempts[attempts.length - 1] : undefined;\n\t\t\tfunction assertAttemptCount(count: number, message?: string) {\n\t\t\t\tconst fullMessage = `${attempts.length} !== ${count}; ${\n\t\t\t\t\tmessage ?? \"unexpected attempt count\"\n\t\t\t\t}`;\n\t\t\t\tassert(attempts.length === count, fullMessage);\n\t\t\t}\n\n\t\t\tfunction initialize({\n\t\t\t\trefSequenceNumber = 0,\n\t\t\t\tlastOpSequenceNumber = refSequenceNumber,\n\t\t\t\tsummaryTime = Date.now(),\n\t\t\t\tmaxTime = defaultSummaryConfig.maxTime,\n\t\t\t\tmaxOps = defaultSummaryConfig.maxOps,\n\t\t\t\tmaxAckWaitTime = defaultSummaryConfig.maxAckWaitTime,\n\t\t\t\tmaxOpsSinceLastSummary = defaultSummaryConfig.maxOpsSinceLastSummary,\n\t\t\t\tinitialSummarizerDelayMs = defaultSummaryConfig.initialSummarizerDelayMs,\n\t\t\t\tminOpsForLastSummaryAttempt = defaultSummaryConfig.minOpsForLastSummaryAttempt,\n\t\t\t\trun = true,\n\t\t\t\tminIdleTime = defaultSummaryConfig.minIdleTime,\n\t\t\t\tmaxIdleTime = defaultSummaryConfig.maxIdleTime,\n\t\t\t\tnonRuntimeOpWeight = defaultSummaryConfig.nonRuntimeOpWeight,\n\t\t\t\truntimeOpWeight = defaultSummaryConfig.runtimeOpWeight,\n\t\t\t}: Partial<\n\t\t\t\tISummaryConfigurationHeuristics &\n\t\t\t\t\tISummarizeAttempt & {\n\t\t\t\t\t\tlastOpSequenceNumber: number;\n\t\t\t\t\t\trun: boolean;\n\t\t\t\t\t}\n\t\t\t> = {}) {\n\t\t\t\tmockLogger = new MockLogger();\n\t\t\t\tdata = new SummarizeHeuristicData(lastOpSequenceNumber, {\n\t\t\t\t\trefSequenceNumber,\n\t\t\t\t\tsummaryTime,\n\t\t\t\t});\n\t\t\t\tsummaryConfig = {\n\t\t\t\t\tstate: \"enabled\",\n\t\t\t\t\tmaxTime,\n\t\t\t\t\tmaxOps,\n\t\t\t\t\tmaxAckWaitTime,\n\t\t\t\t\tmaxOpsSinceLastSummary,\n\t\t\t\t\tinitialSummarizerDelayMs,\n\t\t\t\t\tminOpsForLastSummaryAttempt,\n\t\t\t\t\tminIdleTime,\n\t\t\t\t\tmaxIdleTime,\n\t\t\t\t\tnonRuntimeOpWeight,\n\t\t\t\t\truntimeOpWeight,\n\t\t\t\t} as const;\n\n\t\t\t\trunner = new SummarizeHeuristicRunner(\n\t\t\t\t\tdata,\n\t\t\t\t\tsummaryConfig,\n\t\t\t\t\ttrySummarize,\n\t\t\t\t\tmockLogger.toTelemetryLogger(),\n\t\t\t\t);\n\n\t\t\t\tif (run) {\n\t\t\t\t\trunner.run();\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tbeforeEach(() => {\n\t\t\t\tattempts = [];\n\t\t\t});\n\t\t\tafterEach(() => {\n\t\t\t\tclock.reset();\n\t\t\t});\n\n\t\t\tit(\"Should summarize after maxOps with no prior summary\", () => {\n\t\t\t\tconst maxOps = 100;\n\t\t\t\tinitialize({ maxOps });\n\n\t\t\t\tdata.lastOpSequenceNumber = maxOps;\n\t\t\t\tdata.numRuntimeOps = maxOps;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\tdata.lastOpSequenceNumber++;\n\t\t\t\tdata.numRuntimeOps++;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(1, \"should run now\");\n\t\t\t\tassert(getLastAttempt() === \"maxOps\");\n\t\t\t});\n\n\t\t\tit(\"Should summarize after maxOps\", () => {\n\t\t\t\tconst lastSummary = 1000;\n\t\t\t\tconst maxOps = 100;\n\t\t\t\tinitialize({ refSequenceNumber: lastSummary, maxOps });\n\n\t\t\t\tdata.lastOpSequenceNumber = lastSummary + maxOps;\n\t\t\t\tdata.numRuntimeOps = maxOps;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\tdata.lastOpSequenceNumber++;\n\t\t\t\tdata.numRuntimeOps++;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(1, \"should run now\");\n\t\t\t\tassert(getLastAttempt() === \"maxOps\");\n\t\t\t});\n\n\t\t\tit(\"Should summarize after maxTime\", () => {\n\t\t\t\tconst lastSummary = 1000;\n\t\t\t\tconst idleTime = 101;\n\t\t\t\tconst maxTime = 1000;\n\t\t\t\tconst idlesPerActive = Math.floor((maxTime + 1) / (idleTime - 1));\n\t\t\t\tconst remainingTime = (maxTime + 1) % (idleTime - 1);\n\t\t\t\tinitialize({\n\t\t\t\t\trefSequenceNumber: lastSummary,\n\t\t\t\t\tminIdleTime: idleTime,\n\t\t\t\t\tmaxIdleTime: idleTime,\n\t\t\t\t\tmaxTime,\n\t\t\t\t});\n\n\t\t\t\tdata.lastOpSequenceNumber = lastSummary + 1;\n\n\t\t\t\tfor (let i = 0; i < idlesPerActive; i++) {\n\t\t\t\t\t// Prevent idle timer from triggering with periodic \"ops\" (heuristic runs)\n\t\t\t\t\tclock.tick(idleTime - 1);\n\t\t\t\t\trunner.run();\n\t\t\t\t}\n\t\t\t\tclock.tick(remainingTime - 1);\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\tclock.tick(1);\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(1, \"should run now\");\n\t\t\t\tassert(getLastAttempt() === \"maxTime\");\n\t\t\t});\n\n\t\t\tit(\"Should summarize after idleTime\", () => {\n\t\t\t\tconst lastSummary = 1000;\n\t\t\t\tconst idleTime = 101;\n\t\t\t\tconst maxTime = 1000;\n\t\t\t\tinitialize({\n\t\t\t\t\trefSequenceNumber: lastSummary,\n\t\t\t\t\tminIdleTime: idleTime,\n\t\t\t\t\tmaxIdleTime: idleTime,\n\t\t\t\t\tmaxTime,\n\t\t\t\t});\n\n\t\t\t\tdata.lastOpSequenceNumber = lastSummary + 1;\n\n\t\t\t\tclock.tick(idleTime - 1);\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\tclock.tick(1);\n\t\t\t\tassertAttemptCount(1, \"should run now\");\n\t\t\t\tassert(getLastAttempt() === \"idle\");\n\t\t\t});\n\n\t\t\tit(\"Should summarize after idleTime after a few interruptions\", () => {\n\t\t\t\tconst lastSummary = 1000;\n\t\t\t\tconst idleTime = 101;\n\t\t\t\tconst maxTime = 1000;\n\t\t\t\tinitialize({\n\t\t\t\t\trefSequenceNumber: lastSummary,\n\t\t\t\t\tminIdleTime: idleTime,\n\t\t\t\t\tmaxIdleTime: idleTime,\n\t\t\t\t\tmaxTime,\n\t\t\t\t});\n\n\t\t\t\tdata.lastOpSequenceNumber = lastSummary + 1;\n\n\t\t\t\tclock.tick(idleTime - 1);\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\t\t\t\trunner.run(); // interrupts idle timer\n\n\t\t\t\tclock.tick(idleTime - 1);\n\t\t\t\tassertAttemptCount(0, \"still should not run yet\");\n\t\t\t\trunner.run(); // interrupts idle timer\n\n\t\t\t\tclock.tick(idleTime - 1);\n\t\t\t\tassertAttemptCount(0, \"still should not run yet again\");\n\n\t\t\t\tclock.tick(idleTime);\n\t\t\t\tassertAttemptCount(1, \"should run now\");\n\t\t\t\tassert(getLastAttempt() === \"idle\");\n\t\t\t});\n\n\t\t\tit(\"Should summarize on close if enough outstanding ops\", () => {\n\t\t\t\tconst minOpsForLastSummaryAttempt = 10;\n\t\t\t\tinitialize({ minOpsForLastSummaryAttempt, runtimeOpWeight: 1.0 });\n\n\t\t\t\tdata.numRuntimeOps = minOpsForLastSummaryAttempt;\n\t\t\t\tassert.strictEqual(runner.shouldRunLastSummary(), true, \"should run on close\");\n\t\t\t});\n\n\t\t\tit(\"Should not summarize on close if insufficient outstanding ops\", () => {\n\t\t\t\tconst minOpsForLastSummaryAttempt = 10;\n\t\t\t\tinitialize({ minOpsForLastSummaryAttempt, runtimeOpWeight: 1.0 });\n\n\t\t\t\tdata.numRuntimeOps = minOpsForLastSummaryAttempt - 1;\n\t\t\t\tassert.strictEqual(runner.shouldRunLastSummary(), false, \"should not run on close\");\n\t\t\t});\n\n\t\t\tit(\"Should summarize on close weights ops properly\", () => {\n\t\t\t\tconst minOpsForLastSummaryAttempt = 2;\n\t\t\t\tinitialize({\n\t\t\t\t\tminOpsForLastSummaryAttempt,\n\t\t\t\t\truntimeOpWeight: 0.1,\n\t\t\t\t\tnonRuntimeOpWeight: 1.1,\n\t\t\t\t});\n\n\t\t\t\tdata.numRuntimeOps += 8;\n\t\t\t\tassert.strictEqual(runner.shouldRunLastSummary(), false, \"should not run yet\");\n\n\t\t\t\tdata.numNonRuntimeOps += 1;\n\t\t\t\tassert.strictEqual(runner.shouldRunLastSummary(), false, \"should not run yet\");\n\n\t\t\t\tdata.numRuntimeOps += 1;\n\t\t\t\tassert.strictEqual(runner.shouldRunLastSummary(), true, \"should run\");\n\t\t\t});\n\n\t\t\tit(\"Should not run idle timer after dispose\", () => {\n\t\t\t\tconst lastSummary = 1000;\n\t\t\t\tconst idleTime = 101;\n\t\t\t\tconst maxTime = 1000;\n\t\t\t\tinitialize({\n\t\t\t\t\trefSequenceNumber: lastSummary,\n\t\t\t\t\tminIdleTime: idleTime,\n\t\t\t\t\tmaxIdleTime: idleTime,\n\t\t\t\t\tmaxTime,\n\t\t\t\t});\n\n\t\t\t\tdata.lastOpSequenceNumber = lastSummary + 1;\n\n\t\t\t\tclock.tick(idleTime - 1);\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\trunner.dispose();\n\t\t\t\tclock.tick(1);\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should still run since disposed\");\n\t\t\t});\n\n\t\t\tit(\"Idle time value should change based on op counts\", () => {\n\t\t\t\tconst minIdleTime = 0;\n\t\t\t\tconst maxIdleTime = 1;\n\t\t\t\tconst maxTime = 1000;\n\t\t\t\tconst maxOps = 1000;\n\t\t\t\tconst runtimeOpWeight = 1.0;\n\t\t\t\tconst nonRuntimeOpWeight = 1.0;\n\t\t\t\tinitialize({\n\t\t\t\t\tminIdleTime,\n\t\t\t\t\tmaxIdleTime,\n\t\t\t\t\tmaxTime,\n\t\t\t\t\tmaxOps,\n\t\t\t\t\truntimeOpWeight,\n\t\t\t\t\tnonRuntimeOpWeight,\n\t\t\t\t});\n\n\t\t\t\tdata.lastOpSequenceNumber = maxOps;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime, \"should start at the maxIdleTime\");\n\n\t\t\t\tdata.numRuntimeOps += 50;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 0.05);\n\n\t\t\t\tdata.numRuntimeOps += 123;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 0.173);\n\n\t\t\t\tdata.numRuntimeOps += 500;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 0.673);\n\n\t\t\t\tdata.numRuntimeOps += 326;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 0.999);\n\n\t\t\t\tdata.numRuntimeOps += 1;\n\t\t\t\tassert.strictEqual(runner.idleTime, minIdleTime);\n\n\t\t\t\tdata.numRuntimeOps += 100;\n\t\t\t\tassert.strictEqual(\n\t\t\t\t\trunner.idleTime,\n\t\t\t\t\tminIdleTime,\n\t\t\t\t\t\"should never go below the minIdleTime\",\n\t\t\t\t);\n\t\t\t});\n\n\t\t\tit(\"Idle time should change based on op weights\", () => {\n\t\t\t\tconst minIdleTime = 0;\n\t\t\t\tconst maxIdleTime = 1000;\n\t\t\t\tconst maxTime = 1000;\n\t\t\t\tconst maxOps = 1000;\n\t\t\t\tconst runtimeOpWeight = 0.1;\n\t\t\t\tconst nonRuntimeOpWeight = 1.1;\n\t\t\t\tinitialize({\n\t\t\t\t\tminIdleTime,\n\t\t\t\t\tmaxIdleTime,\n\t\t\t\t\tmaxTime,\n\t\t\t\t\tmaxOps,\n\t\t\t\t\truntimeOpWeight,\n\t\t\t\t\tnonRuntimeOpWeight,\n\t\t\t\t});\n\n\t\t\t\tdata.lastOpSequenceNumber = maxOps;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime, \"should start at the maxIdleTime\");\n\n\t\t\t\tdata.numRuntimeOps += 50;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 5);\n\n\t\t\t\tdata.numRuntimeOps += 123;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 17.3);\n\n\t\t\t\tdata.numNonRuntimeOps += 500;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 567.3);\n\n\t\t\t\tdata.numNonRuntimeOps += 1;\n\t\t\t\tassert.strictEqual(runner.idleTime, maxIdleTime - 568.4);\n\t\t\t});\n\n\t\t\tit(\"Weights ops properly\", () => {\n\t\t\t\tconst maxOps = 2;\n\t\t\t\tconst runtimeOpWeight = 0.1;\n\t\t\t\tconst nonRuntimeOpWeight = 1.1;\n\t\t\t\tinitialize({ maxOps, runtimeOpWeight, nonRuntimeOpWeight });\n\n\t\t\t\tdata.lastOpSequenceNumber = maxOps;\n\n\t\t\t\tdata.numRuntimeOps += 9;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\tdata.numNonRuntimeOps += 1;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(0, \"should not run yet\");\n\n\t\t\t\tdata.numRuntimeOps += 1;\n\t\t\t\trunner.run();\n\t\t\t\tassertAttemptCount(1, \"should run\");\n\t\t\t\tassert(getLastAttempt() === \"maxOps\");\n\t\t\t});\n\t\t});\n\t});\n});\n"]}

package/lib/test/summary/summaryCollection.spec.js

@@ -0,0 +1,200 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockDeltaManager } from "@fluidframework/test-runtime-utils";
+import { MessageType, } from "@fluidframework/protocol-definitions";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { SummaryCollection } from "../../summary/index.js";
+const summaryOp = {
+    clientId: "cliendId",
+    clientSequenceNumber: 5,
+    minimumSequenceNumber: 5,
+    referenceSequenceNumber: 5,
+    sequenceNumber: 6,
+    timestamp: 6,
+    type: MessageType.Summarize,
+    contents: {
+        handle: "OpHandle",
+        head: "head",
+        message: "message",
+        parents: ["parents"],
+    },
+};
+const summaryAckContents = {
+    handle: "AckHandle",
+    summaryProposal: { summarySequenceNumber: summaryOp.sequenceNumber },
+};
+const summaryAck = {
+    clientId: "cliendId",
+    clientSequenceNumber: summaryOp.clientSequenceNumber + 1,
+    minimumSequenceNumber: summaryOp.sequenceNumber,
+    referenceSequenceNumber: summaryOp.sequenceNumber,
+    sequenceNumber: summaryOp.sequenceNumber + 1,
+    timestamp: summaryOp.timestamp + 1,
+    type: MessageType.SummaryAck,
+    contents: summaryAckContents,
+    data: JSON.stringify(summaryAckContents),
+};
+const summaryNackContents = {
+    message: "Nack",
+    summaryProposal: { summarySequenceNumber: summaryOp.sequenceNumber },
+};
+const summaryNack = {
+    clientId: "cliendId",
+    clientSequenceNumber: summaryOp.clientSequenceNumber + 1,
+    minimumSequenceNumber: summaryOp.sequenceNumber,
+    referenceSequenceNumber: summaryOp.sequenceNumber,
+    sequenceNumber: summaryOp.sequenceNumber + 1,
+    timestamp: summaryOp.timestamp + 1,
+    type: MessageType.SummaryNack,
+    contents: summaryNackContents,
+    data: JSON.stringify(summaryNackContents),
+};
+describe("Summary Collection", () => {
+    describe("latestAck", () => {
+        it("Ack with op", () => {
+            const dm = new MockDeltaManager();
+            const sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());
+            assert.equal(sc.latestAck, undefined, "last ack undefined");
+            dm.emit("op", summaryOp);
+            dm.emit("op", summaryAck);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const latestAck = sc.latestAck;
+            assert(latestAck !== undefined, "last ack undefined");
+            assert.deepEqual({
+                summaryOp,
+                summaryAck,
+            }, sc.latestAck);
+        });
+        it("Ack without op", () => {
+            const dm = new MockDeltaManager();
+            const sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());
+            assert.equal(sc.latestAck, undefined, "last ack undefined");
+            dm.emit("op", summaryAck);
+            assert.equal(sc.latestAck, undefined, "last ack undefined");
+        });
+        it("Nack with op", () => {
+            const dm = new MockDeltaManager();
+            const sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());
+            assert.equal(sc.latestAck, undefined, "last ack undefined");
+            dm.emit("op", summaryAck);
+            dm.emit("op", summaryNack);
+            assert.equal(sc.latestAck, undefined, "last ack undefined");
+        });
+    });
+    describe("opsSinceLastAck", () => {
+        it("Ack with op", () => {
+            const dm = new MockDeltaManager();
+            dm.on("op", (op) => {
+                dm.lastSequenceNumber = op.sequenceNumber;
+            });
+            const sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());
+            assert.equal(sc.opsSinceLastAck, 0);
+            dm.emit("op", summaryOp);
+            assert.equal(sc.opsSinceLastAck, summaryOp.sequenceNumber);
+            dm.emit("op", summaryAck);
+            assert.equal(sc.opsSinceLastAck, 0);
+        });
+        it("Nack with op", () => {
+            const dm = new MockDeltaManager();
+            dm.on("op", (op) => {
+                dm.lastSequenceNumber = op.sequenceNumber;
+            });
+            const sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());
+            assert.equal(sc.opsSinceLastAck, 0);
+            dm.emit("op", summaryOp);
+            assert.equal(sc.opsSinceLastAck, summaryOp.sequenceNumber);
+            dm.emit("op", summaryNack);
+            assert.equal(sc.opsSinceLastAck, summaryNack.sequenceNumber);
+        });
+        it("Ack after Nack with op", () => {
+            const dm = new MockDeltaManager();
+            dm.on("op", (op) => {
+                dm.lastSequenceNumber = op.sequenceNumber;
+            });
+            const sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());
+            assert.equal(sc.opsSinceLastAck, 0);
+            dm.emit("op", summaryOp);
+            dm.emit("op", summaryNack);
+            dm.emit("op", summaryAck);
+            assert.equal(sc.opsSinceLastAck, summaryAck.sequenceNumber);
+        });
+    });
+    describe("opActions", () => {
+        function createSummaryCollection(deltaManager) {
+            const summaryCollection = new SummaryCollection(deltaManager, new MockLogger().toTelemetryLogger());
+            const callCounts = {
+                default: 0,
+                summarize: 0,
+                summaryAck: 0,
+                summaryNack: 0,
+            };
+            summaryCollection.on("default", () => callCounts.default++);
+            summaryCollection.on(MessageType.Summarize, () => callCounts.summarize++);
+            summaryCollection.on(MessageType.SummaryAck, () => callCounts.summaryAck++);
+            summaryCollection.on(MessageType.SummaryNack, () => callCounts.summaryNack++);
+            return { summaryCollection, callCounts };
+        }
+        it("Summary op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryOp);
+            assert.equal(callCounts.summarize, 1);
+        });
+        it("Summary Ack without op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryAck);
+            assert.equal(callCounts.summaryAck, 0);
+        });
+        it("Summary Ack with op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryOp);
+            dm.emit("op", summaryAck);
+            assert.equal(callCounts.summarize, 1);
+            assert.equal(callCounts.summaryAck, 1);
+        });
+        it("Double Summary Ack with op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryOp);
+            dm.emit("op", summaryAck);
+            dm.emit("op", summaryAck);
+            assert.equal(callCounts.summarize, 1);
+            assert.equal(callCounts.summaryAck, 1);
+        });
+        it("Summary Nack without op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryNack);
+            assert.equal(callCounts.summaryNack, 0);
+        });
+        it("Summary Nack with op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryOp);
+            dm.emit("op", summaryNack);
+            assert.equal(callCounts.summarize, 1);
+            assert.equal(callCounts.summaryNack, 1);
+        });
+        it("Double Summary Nack with op", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", summaryOp);
+            dm.emit("op", summaryNack);
+            dm.emit("op", summaryNack);
+            assert.equal(callCounts.summarize, 1);
+            assert.equal(callCounts.summaryNack, 1);
+        });
+        it("default", () => {
+            const dm = new MockDeltaManager();
+            const { callCounts } = createSummaryCollection(dm);
+            dm.emit("op", {});
+            assert.equal(callCounts.default, 1);
+        });
+    });
+});
+//# sourceMappingURL=summaryCollection.spec.js.map

package/lib/test/summary/summaryCollection.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summaryCollection.spec.js","sourceRoot":"","sources":["../../../src/test/summary/summaryCollection.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAGN,WAAW,GACX,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAqB,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE9E,MAAM,SAAS,GAAsB;IACpC,QAAQ,EAAE,UAAU;IACpB,oBAAoB,EAAE,CAAC;IACvB,qBAAqB,EAAE,CAAC;IACxB,uBAAuB,EAAE,CAAC;IAC1B,cAAc,EAAE,CAAC;IACjB,SAAS,EAAE,CAAC;IACZ,IAAI,EAAE,WAAW,CAAC,SAAS;IAC3B,QAAQ,EAAE;QACT,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,CAAC,SAAS,CAAC;KACpB;CACD,CAAC;AAEF,MAAM,kBAAkB,GAAG;IAC1B,MAAM,EAAE,WAAW;IACnB,eAAe,EAAE,EAAE,qBAAqB,EAAE,SAAS,CAAC,cAAc,EAAE;CACpE,CAAC;AACF,MAAM,UAAU,GAAiD;IAChE,QAAQ,EAAE,UAAU;IACpB,oBAAoB,EAAE,SAAS,CAAC,oBAAoB,GAAG,CAAC;IACxD,qBAAqB,EAAE,SAAS,CAAC,cAAc;IAC/C,uBAAuB,EAAE,SAAS,CAAC,cAAc;IACjD,cAAc,EAAE,SAAS,CAAC,cAAc,GAAG,CAAC;IAC5C,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,CAAC;IAClC,IAAI,EAAE,WAAW,CAAC,UAAU;IAC5B,QAAQ,EAAE,kBAAkB;IAC5B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;CACxC,CAAC;AAEF,MAAM,mBAAmB,GAAG;IAC3B,OAAO,EAAE,MAAM;IACf,eAAe,EAAE,EAAE,qBAAqB,EAAE,SAAS,CAAC,cAAc,EAAE;CACpE,CAAC;AACF,MAAM,WAAW,GAAiD;IACjE,QAAQ,EAAE,UAAU;IACpB,oBAAoB,EAAE,SAAS,CAAC,oBAAoB,GAAG,CAAC;IACxD,qBAAqB,EAAE,SAAS,CAAC,cAAc;IAC/C,uBAAuB,EAAE,SAAS,CAAC,cAAc;IACjD,cAAc,EAAE,SAAS,CAAC,cAAc,GAAG,CAAC;IAC5C,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,CAAC;IAClC,IAAI,EAAE,WAAW,CAAC,WAAW;IAC7B,QAAQ,EAAE,mBAAmB;IAC7B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC;CACzC,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACnC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACtB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;YAC5D,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,oEAAoE;YACpE,MAAM,SAAS,GAAG,EAAE,CAAC,SAAU,CAAC;YAChC,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,oBAAoB,CAAC,CAAC;YACtD,MAAM,CAAC,SAAS,CACf;gBACC,SAAS;gBACT,UAAU;aACV,EACD,EAAE,CAAC,SAAS,CACZ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;YACzB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;YAC5D,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;YACvB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;YAC5D,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACtB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;gBAClB,EAAE,CAAC,kBAAkB,GAAG,EAAE,CAAC,cAAc,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;YACpC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;YAC3D,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;YACvB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;gBAClB,EAAE,CAAC,kBAAkB,GAAG,EAAE,CAAC,cAAc,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;YACpC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;YAC3D,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACjC,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;gBAClB,EAAE,CAAC,kBAAkB,GAAG,EAAE,CAAC,cAAc,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;YACpC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QAU1B,SAAS,uBAAuB,CAC/B,YAAwE;YAExE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAC9C,YAAY,EACZ,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CACpC,CAAC;YACF,MAAM,UAAU,GAAiD;gBAChE,OAAO,EAAE,CAAC;gBACV,SAAS,EAAE,CAAC;gBACZ,UAAU,EAAE,CAAC;gBACb,WAAW,EAAE,CAAC;aACd,CAAC;YACF,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,iBAAiB,CAAC,EAAE,CAAC,WAAW,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;YAC1E,iBAAiB,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;YAC5E,iBAAiB,CAAC,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;YAC9E,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAC;QAC1C,CAAC;QACD,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACrB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACjC,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC9B,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACrC,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YAClC,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC/B,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACtC,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACzB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAClB,MAAM,EAAE,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,EAAE,UAAU,EAAE,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACnD,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAClB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { MockDeltaManager } from \"@fluidframework/test-runtime-utils\";\nimport {\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tMessageType,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { ISummaryOpMessage, SummaryCollection } from \"../../summary/index.js\";\n\nconst summaryOp: ISummaryOpMessage = {\n\tclientId: \"cliendId\",\n\tclientSequenceNumber: 5,\n\tminimumSequenceNumber: 5,\n\treferenceSequenceNumber: 5,\n\tsequenceNumber: 6,\n\ttimestamp: 6,\n\ttype: MessageType.Summarize,\n\tcontents: {\n\t\thandle: \"OpHandle\",\n\t\thead: \"head\",\n\t\tmessage: \"message\",\n\t\tparents: [\"parents\"],\n\t},\n};\n\nconst summaryAckContents = {\n\thandle: \"AckHandle\",\n\tsummaryProposal: { summarySequenceNumber: summaryOp.sequenceNumber },\n};\nconst summaryAck: ISequencedDocumentMessage & { data: string } = {\n\tclientId: \"cliendId\",\n\tclientSequenceNumber: summaryOp.clientSequenceNumber + 1,\n\tminimumSequenceNumber: summaryOp.sequenceNumber,\n\treferenceSequenceNumber: summaryOp.sequenceNumber,\n\tsequenceNumber: summaryOp.sequenceNumber + 1,\n\ttimestamp: summaryOp.timestamp + 1,\n\ttype: MessageType.SummaryAck,\n\tcontents: summaryAckContents,\n\tdata: JSON.stringify(summaryAckContents),\n};\n\nconst summaryNackContents = {\n\tmessage: \"Nack\",\n\tsummaryProposal: { summarySequenceNumber: summaryOp.sequenceNumber },\n};\nconst summaryNack: ISequencedDocumentMessage & { data: string } = {\n\tclientId: \"cliendId\",\n\tclientSequenceNumber: summaryOp.clientSequenceNumber + 1,\n\tminimumSequenceNumber: summaryOp.sequenceNumber,\n\treferenceSequenceNumber: summaryOp.sequenceNumber,\n\tsequenceNumber: summaryOp.sequenceNumber + 1,\n\ttimestamp: summaryOp.timestamp + 1,\n\ttype: MessageType.SummaryNack,\n\tcontents: summaryNackContents,\n\tdata: JSON.stringify(summaryNackContents),\n};\n\ndescribe(\"Summary Collection\", () => {\n\tdescribe(\"latestAck\", () => {\n\t\tit(\"Ack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());\n\t\t\tassert.equal(sc.latestAck, undefined, \"last ack undefined\");\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tconst latestAck = sc.latestAck!;\n\t\t\tassert(latestAck !== undefined, \"last ack undefined\");\n\t\t\tassert.deepEqual(\n\t\t\t\t{\n\t\t\t\t\tsummaryOp,\n\t\t\t\t\tsummaryAck,\n\t\t\t\t},\n\t\t\t\tsc.latestAck,\n\t\t\t);\n\t\t});\n\n\t\tit(\"Ack without op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());\n\t\t\tassert.equal(sc.latestAck, undefined, \"last ack undefined\");\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tassert.equal(sc.latestAck, undefined, \"last ack undefined\");\n\t\t});\n\n\t\tit(\"Nack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());\n\t\t\tassert.equal(sc.latestAck, undefined, \"last ack undefined\");\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tassert.equal(sc.latestAck, undefined, \"last ack undefined\");\n\t\t});\n\t});\n\tdescribe(\"opsSinceLastAck\", () => {\n\t\tit(\"Ack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tdm.on(\"op\", (op) => {\n\t\t\t\tdm.lastSequenceNumber = op.sequenceNumber;\n\t\t\t});\n\n\t\t\tconst sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());\n\t\t\tassert.equal(sc.opsSinceLastAck, 0);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tassert.equal(sc.opsSinceLastAck, summaryOp.sequenceNumber);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tassert.equal(sc.opsSinceLastAck, 0);\n\t\t});\n\t\tit(\"Nack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tdm.on(\"op\", (op) => {\n\t\t\t\tdm.lastSequenceNumber = op.sequenceNumber;\n\t\t\t});\n\n\t\t\tconst sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());\n\t\t\tassert.equal(sc.opsSinceLastAck, 0);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tassert.equal(sc.opsSinceLastAck, summaryOp.sequenceNumber);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tassert.equal(sc.opsSinceLastAck, summaryNack.sequenceNumber);\n\t\t});\n\t\tit(\"Ack after Nack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tdm.on(\"op\", (op) => {\n\t\t\t\tdm.lastSequenceNumber = op.sequenceNumber;\n\t\t\t});\n\n\t\t\tconst sc = new SummaryCollection(dm, new MockLogger().toTelemetryLogger());\n\t\t\tassert.equal(sc.opsSinceLastAck, 0);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tassert.equal(sc.opsSinceLastAck, summaryAck.sequenceNumber);\n\t\t});\n\t});\n\n\tdescribe(\"opActions\", () => {\n\t\tinterface ISummaryCollectionWithCounters {\n\t\t\tsummaryCollection: SummaryCollection;\n\t\t\tcallCounts: {\n\t\t\t\tdefault: number;\n\t\t\t\tsummarize: number;\n\t\t\t\tsummaryAck: number;\n\t\t\t\tsummaryNack: number;\n\t\t\t};\n\t\t}\n\t\tfunction createSummaryCollection(\n\t\t\tdeltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n\t\t): ISummaryCollectionWithCounters {\n\t\t\tconst summaryCollection = new SummaryCollection(\n\t\t\t\tdeltaManager,\n\t\t\t\tnew MockLogger().toTelemetryLogger(),\n\t\t\t);\n\t\t\tconst callCounts: ISummaryCollectionWithCounters[\"callCounts\"] = {\n\t\t\t\tdefault: 0,\n\t\t\t\tsummarize: 0,\n\t\t\t\tsummaryAck: 0,\n\t\t\t\tsummaryNack: 0,\n\t\t\t};\n\t\t\tsummaryCollection.on(\"default\", () => callCounts.default++);\n\t\t\tsummaryCollection.on(MessageType.Summarize, () => callCounts.summarize++);\n\t\t\tsummaryCollection.on(MessageType.SummaryAck, () => callCounts.summaryAck++);\n\t\t\tsummaryCollection.on(MessageType.SummaryNack, () => callCounts.summaryNack++);\n\t\t\treturn { summaryCollection, callCounts };\n\t\t}\n\t\tit(\"Summary op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tassert.equal(callCounts.summarize, 1);\n\t\t});\n\n\t\tit(\"Summary Ack without op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tassert.equal(callCounts.summaryAck, 0);\n\t\t});\n\n\t\tit(\"Summary Ack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tassert.equal(callCounts.summarize, 1);\n\t\t\tassert.equal(callCounts.summaryAck, 1);\n\t\t});\n\n\t\tit(\"Double Summary Ack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tdm.emit(\"op\", summaryAck);\n\t\t\tassert.equal(callCounts.summarize, 1);\n\t\t\tassert.equal(callCounts.summaryAck, 1);\n\t\t});\n\n\t\tit(\"Summary Nack without op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tassert.equal(callCounts.summaryNack, 0);\n\t\t});\n\n\t\tit(\"Summary Nack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tassert.equal(callCounts.summarize, 1);\n\t\t\tassert.equal(callCounts.summaryNack, 1);\n\t\t});\n\n\t\tit(\"Double Summary Nack with op\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", summaryOp);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tdm.emit(\"op\", summaryNack);\n\t\t\tassert.equal(callCounts.summarize, 1);\n\t\t\tassert.equal(callCounts.summaryNack, 1);\n\t\t});\n\n\t\tit(\"default\", () => {\n\t\t\tconst dm = new MockDeltaManager();\n\t\t\tconst { callCounts } = createSummaryCollection(dm);\n\t\t\tdm.emit(\"op\", {});\n\t\t\tassert.equal(callCounts.default, 1);\n\t\t});\n\t});\n});\n"]}