@fluidframework/container-runtime 2.0.0-dev-rc.2.0.0.245554 → 2.0.0-dev-rc.3.0.0.250606

package/lib/test/documentSchema.spec.js

@@ -0,0 +1,282 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { DocumentsSchemaController, } from "../summary/index.js";
+function boolToProp(b) {
+    return b ? true : undefined;
+}
+describe("Runtime", () => {
+    const validConfig = {
+        version: 1,
+        refSeq: 0,
+        runtime: {
+            // explicitSchemaControl: undefined,
+            compressionLz4: true,
+            idCompressorMode: "delayed",
+            // opGroupingEnabled: undefined,
+        },
+    };
+    const features = {
+        explicitSchemaControl: true,
+        compressionLz4: true,
+        opGroupingEnabled: false,
+        idCompressorMode: "delayed",
+    };
+    function createController(config) {
+        return new DocumentsSchemaController(false, // existing,
+        config, // old schema,
+        features, () => { });
+    }
+    function testWrongConfig(config) {
+        assert.throws(() => {
+            createController(config);
+        }, "should throw on unknown property");
+        const controller = createController(validConfig);
+        assert.throws(() => controller.processDocumentSchemaOp(config, false, // local
+        100)); // sequenceNumber
+    }
+    // Validate first that config is indeed valid, such that all further tests are not tripping
+    // on something else that they are not modifying.
+    it("valid config", () => {
+        createController(validConfig);
+    });
+    // It's hard to say if we will allow additional propeorty trees here like this sample shows.
+    // More likely that will require version bump, to ensure that old code does not run with such structure.
+    // If if such configs will be backward compatible (similar to runtime options we are listing that were in use for very long time),
+    // then maybe ability to add them in such back-compat way is a plus
+    it("extra global property ois Ok", () => {
+        createController({ ...validConfig, appProperty: { foo: 5 } });
+    });
+    it("empty object", () => {
+        testWrongConfig({});
+    });
+    it("wrong version", () => {
+        testWrongConfig({ ...validConfig, version: 4 });
+        testWrongConfig({ ...validConfig, version: "1" });
+        testWrongConfig({ ...validConfig, version: "2.0" });
+    });
+    it("wrong refSeq", () => {
+        testWrongConfig({ ...validConfig, refSeq: "aaa" });
+    });
+    it("no refSeq", () => {
+        testWrongConfig({ ...validConfig, refSeq: undefined });
+    });
+    it("no runtime", () => {
+        testWrongConfig({ ...validConfig, runtime: undefined });
+    });
+    it("unknown runtime property", () => {
+        testWrongConfig({ ...validConfig, runtime: { ...validConfig.runtime, foo: 5 } });
+    });
+    it("wrong values for known properties", () => {
+        testWrongConfig({
+            ...validConfig,
+            runtime: { ...validConfig.runtime, idCompressorMode: 5 },
+        });
+        testWrongConfig({
+            ...validConfig,
+            runtime: { ...validConfig.runtime, idCompressorMode: "foo" },
+        });
+        testWrongConfig({
+            ...validConfig,
+            runtime: { ...validConfig.runtime, opGroupingEnabled: false },
+        });
+        testWrongConfig({
+            ...validConfig,
+            runtime: { ...validConfig.runtime, opGroupingEnabled: "aa" },
+        });
+    });
+    function testSimpleCases(explicitSchemaControl, existing) {
+        const controller = new DocumentsSchemaController(existing, // existing,
+        undefined, // old schema,
+        { ...features, explicitSchemaControl }, () => assert(false, "no schema changes!"));
+        assert(controller.sessionSchema.refSeq === 0, "refSeq");
+        assert(controller.sessionSchema.version === 1, "version");
+        assert(controller.sessionSchema.runtime.explicitSchemaControl ===
+            boolToProp(explicitSchemaControl), "explicitSchemaControl");
+        if (existing && explicitSchemaControl) {
+            assert(controller.sessionSchema.runtime.compressionLz4 === undefined, "lz4");
+            assert(controller.sessionSchema.runtime.idCompressorMode === undefined, "idCompressorMode");
+        }
+        else {
+            assert(controller.sessionSchema.runtime.compressionLz4 === true, "lz4");
+            assert(controller.sessionSchema.runtime.idCompressorMode === "delayed", "idCompressorMode");
+        }
+        assert(controller.sessionSchema.runtime.opGroupingEnabled === undefined, "opGroupingEnabled");
+        if (!existing || !explicitSchemaControl) {
+            controller.onDisconnect();
+            controller.onMessageSent(() => {
+                assert(false, "no messages should be sent!");
+            });
+        }
+        // get rid of all properties with undefined values.
+        const summarySchema = JSON.parse(JSON.stringify(controller.summarizeDocumentSchema(100 /* refSeq */)));
+        if (!explicitSchemaControl) {
+            assert.deepEqual(summarySchema, validConfig, "summarized schema as expected");
+        }
+        else {
+            const expected = {
+                version: 1,
+                refSeq: 0,
+                runtime: {
+                    // Existing files without any schema are considered to be in legacy mode.
+                    explicitSchemaControl: boolToProp(!existing),
+                },
+            };
+            assert.deepEqual(summarySchema, JSON.parse(JSON.stringify(expected)), "summarized schema as expected");
+        }
+        // No local messages are expected
+        assert.throws(() => controller.processDocumentSchemaOp(validConfig, true, // local
+        100)); // sequenceNumber
+    }
+    it("Creation of new document", () => {
+        testSimpleCases(true, // explicitSchemaControl
+        false);
+        testSimpleCases(false, // explicitSchemaControl
+        false);
+    });
+    it("Existing document, no schema", () => {
+        testSimpleCases(true, // explicitSchemaControl
+        true);
+        testSimpleCases(false, // explicitSchemaControl
+        true);
+    });
+    function testExistingDocNoChangesInSchema(schema) {
+        const controller = new DocumentsSchemaController(true, // existing,
+        schema, // old schema,
+        features, () => { });
+        controller.onDisconnect();
+        controller.onMessageSent(() => {
+            assert(false, "no messages should be sent!");
+        });
+    }
+    it("Existing document with existing schema, no changes", () => {
+        testExistingDocNoChangesInSchema(validConfig);
+        testExistingDocNoChangesInSchema({
+            ...validConfig,
+            runtime: { ...validConfig.runtime, explicitSchemaControl: true },
+        });
+    });
+    it("Existing document, changes required; race conditions", () => {
+        const controller = new DocumentsSchemaController(true, // existing,
+        validConfig, // old schema,
+        { ...features, opGroupingEnabled: true }, () => { });
+        let message;
+        controller.onMessageSent((msg) => {
+            message = msg;
+        });
+        assert(message !== undefined);
+        assert(message.runtime.opGroupingEnabled === true);
+        assert(controller.processDocumentSchemaOp(message, true, // local
+        200) === true);
+        assert(controller.sessionSchema.runtime.opGroupingEnabled === true);
+        assert(controller.sessionSchema.refSeq === 200);
+        const schema = controller.summarizeDocumentSchema(300);
+        assert(schema !== undefined);
+        assert(schema.refSeq === 200);
+        const controller2 = new DocumentsSchemaController(true, // existing,
+        schema, // old schema,
+        { ...features, idCompressorMode: undefined, compressionLz4: false }, () => { });
+        assert.deepEqual(controller2.documentSchema, schema);
+        // updates with old refSeq should fail silently.
+        assert(controller.processDocumentSchemaOp({ ...message, refSeq: 100 }, false, // local
+        201) === false);
+        // new change with some future sequence number should never happen, thus code should throw.
+        assert.throws(() => {
+            assert(message !== undefined);
+            controller.processDocumentSchemaOp({ ...message, refSeq: 300 }, false, // local
+            202);
+        });
+        // new change in schema with updated ref seq should be allowed
+        assert(controller.processDocumentSchemaOp({ ...message, refSeq: 200 }, false, // local
+        305) === true);
+        // Sequence numbers should move only forward.
+        assert.throws(() => {
+            assert(message !== undefined);
+            controller.processDocumentSchemaOp({ ...message, refSeq: 305 }, false, // local
+            300);
+        });
+    });
+    it("AzureClient modes", () => {
+        /**
+         * Start with no schema in a document.
+         * There should be no ops sent.
+         */
+        const controller = new DocumentsSchemaController(true, // existing,
+        undefined, // old schema,
+        { ...features, idCompressorMode: undefined, compressionLz4: false }, () => {
+            assert(false, "no changes!");
+        });
+        controller.onMessageSent(() => {
+            assert(false, "no messages should be sent!");
+        });
+        /**
+         * validate that we can summarize, load new client from that summary and it also will not send any ops
+         */
+        const newSchema = controller.summarizeDocumentSchema(100);
+        const controller2 = new DocumentsSchemaController(true, // existing,
+        newSchema, // old schema,
+        { ...features, idCompressorMode: undefined, compressionLz4: false }, () => {
+            assert(false, "no changes!");
+        });
+        controller2.onMessageSent(() => {
+            assert(false, "no messages should be sent!");
+        });
+        /**
+         * Summarize from that new client and ensure we are getting exactly same summary, thus getting to same state.
+         */
+        const newSchema2 = controller.summarizeDocumentSchema(100);
+        assert.deepEqual(newSchema, newSchema2, "got into stable state");
+        /**
+         * Now let's see if we can change schema.
+         */
+        let schemaChanged = false;
+        const controller3 = new DocumentsSchemaController(true, // existing,
+        newSchema, // old schema,
+        { ...features, idCompressorMode: "on", compressionLz4: false }, () => {
+            schemaChanged = true;
+        });
+        // setting is not on yet
+        assert(controller3.sessionSchema.runtime.idCompressorMode === undefined);
+        let message;
+        controller3.onMessageSent((msg) => {
+            message = msg;
+            assert(message.runtime.idCompressorMode === "on");
+        });
+        assert(message !== undefined, "message sent");
+        controller3.processDocumentSchemaOp(message, true, // local
+        100); // sequenceNumber
+        assert(schemaChanged, "schema changed");
+        assert(controller3.sessionSchema.runtime.idCompressorMode === "on");
+        const schema = controller3.summarizeDocumentSchema(200);
+        assert(schema.runtime.idCompressorMode === "on", "now on");
+        controller3.onMessageSent(() => {
+            assert(false, "no more messages to send");
+        });
+        /**
+         * Validate now that another client that was observing schema changes (not initiating them) will arrive to same state
+         * This client will want to flip groupedBatching, but it will process someone else op first...
+         */
+        schemaChanged = false;
+        const controller4 = new DocumentsSchemaController(true, // existing,
+        newSchema, // old schema,
+        {
+            ...features,
+            idCompressorMode: undefined,
+            compressionLz4: false,
+            opGroupingEnabled: true,
+        }, () => (schemaChanged = true));
+        controller4.processDocumentSchemaOp(message, false, // local
+        200); // sequenceNumber
+        assert(schemaChanged, "schema changed");
+        assert(controller4.sessionSchema.runtime.idCompressorMode === "on");
+        controller4.onMessageSent(() => {
+            assert(false, "no messages should be sent - it lost a race and will not attempt to change file format.");
+        });
+        // Validate same summaries by two clients.
+        const schema2 = controller3.summarizeDocumentSchema(200);
+        assert.deepEqual(schema, schema2, "same summaries");
+    });
+});
+//# sourceMappingURL=documentSchema.spec.js.map

package/lib/test/documentSchema.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentSchema.spec.js","sourceRoot":"","sources":["../../src/test/documentSchema.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EACN,yBAAyB,GAGzB,MAAM,qBAAqB,CAAC;AAE7B,SAAS,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7B,CAAC;AAED,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACxB,MAAM,WAAW,GAA2B;QAC3C,OAAO,EAAE,CAAC;QACV,MAAM,EAAE,CAAC;QACT,OAAO,EAAE;YACR,oCAAoC;YACpC,cAAc,EAAE,IAAI;YACpB,gBAAgB,EAAE,SAAS;YAC3B,gCAAgC;SAChC;KACD,CAAC;IAEF,MAAM,QAAQ,GAA4B;QACzC,qBAAqB,EAAE,IAAI;QAC3B,cAAc,EAAE,IAAI;QACpB,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,SAAS;KAC3B,CAAC;IAEF,SAAS,gBAAgB,CAAC,MAAe;QACxC,OAAO,IAAI,yBAAyB,CACnC,KAAK,EAAE,YAAY;QACnB,MAAgC,EAAE,cAAc;QAChD,QAAQ,EACR,GAAG,EAAE,GAAE,CAAC,CACR,CAAC;IACH,CAAC;IAED,SAAS,eAAe,CAAC,MAAe;QACvC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;YAClB,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,EAAE,kCAAkC,CAAC,CAAC;QAEvC,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAClB,UAAU,CAAC,uBAAuB,CACjC,MAAgC,EAChC,KAAK,EAAE,QAAQ;QACf,GAAG,CACH,CACD,CAAC,CAAC,iBAAiB;IACrB,CAAC;IAED,2FAA2F;IAC3F,iDAAiD;IACjD,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACvB,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,4FAA4F;IAC5F,wGAAwG;IACxG,kIAAkI;IAClI,mEAAmE;IACnE,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACvC,gBAAgB,CAAC,EAAE,GAAG,WAAW,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACvB,eAAe,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;QACxB,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAChD,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;QAClD,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACvB,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;QACpB,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;QACrB,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACnC,eAAe,CAAC,EAAE,GAAG,WAAW,EAAE,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC5C,eAAe,CAAC;YACf,GAAG,WAAW;YACd,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,gBAAgB,EAAE,CAAC,EAAE;SACxD,CAAC,CAAC;QACH,eAAe,CAAC;YACf,GAAG,WAAW;YACd,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE;SAC5D,CAAC,CAAC;QACH,eAAe,CAAC;YACf,GAAG,WAAW;YACd,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE;SAC7D,CAAC,CAAC;QACH,eAAe,CAAC;YACf,GAAG,WAAW;YACd,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE;SAC5D,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,eAAe,CAAC,qBAA8B,EAAE,QAAiB;QACzE,MAAM,UAAU,GAAG,IAAI,yBAAyB,CAC/C,QAAQ,EAAE,YAAY;QACtB,SAAS,EAAE,cAAc;QACzB,EAAE,GAAG,QAAQ,EAAE,qBAAqB,EAAE,EACtC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,oBAAoB,CAAC,CACzC,CAAC;QAEF,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;QAC1D,MAAM,CACL,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,qBAAqB;YACrD,UAAU,CAAC,qBAAqB,CAAC,EAClC,uBAAuB,CACvB,CAAC;QAEF,IAAI,QAAQ,IAAI,qBAAqB,EAAE;YACtC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,KAAK,CAAC,CAAC;YAC7E,MAAM,CACL,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAC/D,kBAAkB,CAClB,CAAC;SACF;aAAM;YACN,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,cAAc,KAAK,IAAI,EAAE,KAAK,CAAC,CAAC;YACxE,MAAM,CACL,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAC/D,kBAAkB,CAClB,CAAC;SACF;QACD,MAAM,CACL,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,iBAAiB,KAAK,SAAS,EAChE,mBAAmB,CACnB,CAAC;QAEF,IAAI,CAAC,QAAQ,IAAI,CAAC,qBAAqB,EAAE;YACxC,UAAU,CAAC,YAAY,EAAE,CAAC;YAC1B,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE;gBAC7B,MAAM,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;SACH;QAED,mDAAmD;QACnD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,uBAAuB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CACpE,CAAC;QACF,IAAI,CAAC,qBAAqB,EAAE;YAC3B,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,WAAW,EAAE,+BAA+B,CAAC,CAAC;SAC9E;aAAM;YACN,MAAM,QAAQ,GAAG;gBAChB,OAAO,EAAE,CAAC;gBACV,MAAM,EAAE,CAAC;gBACT,OAAO,EAAE;oBACR,yEAAyE;oBACzE,qBAAqB,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC;iBAC5C;aACD,CAAC;YACF,MAAM,CAAC,SAAS,CACf,aAAa,EACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EACpC,+BAA+B,CAC/B,CAAC;SACF;QAED,iCAAiC;QACjC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAClB,UAAU,CAAC,uBAAuB,CACjC,WAAW,EACX,IAAI,EAAE,QAAQ;QACd,GAAG,CACH,CACD,CAAC,CAAC,iBAAiB;IACrB,CAAC;IAED,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACnC,eAAe,CACd,IAAI,EAAE,wBAAwB;QAC9B,KAAK,CACL,CAAC;QACF,eAAe,CACd,KAAK,EAAE,wBAAwB;QAC/B,KAAK,CACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACvC,eAAe,CACd,IAAI,EAAE,wBAAwB;QAC9B,IAAI,CACJ,CAAC;QACF,eAAe,CACd,KAAK,EAAE,wBAAwB;QAC/B,IAAI,CACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,gCAAgC,CAAC,MAA8B;QACvE,MAAM,UAAU,GAAG,IAAI,yBAAyB,CAC/C,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,cAAc;QACtB,QAAQ,EACR,GAAG,EAAE,GAAE,CAAC,CACR,CAAC;QAEF,UAAU,CAAC,YAAY,EAAE,CAAC;QAC1B,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE;YAC7B,MAAM,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC7D,gCAAgC,CAAC,WAAW,CAAC,CAAC;QAC9C,gCAAgC,CAAC;YAChC,GAAG,WAAW;YACd,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE;SAChE,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC/D,MAAM,UAAU,GAAG,IAAI,yBAAyB,CAC/C,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,cAAc;QAC3B,EAAE,GAAG,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,EACxC,GAAG,EAAE,GAAE,CAAC,CACR,CAAC;QAEF,IAAI,OAA2C,CAAC;QAChD,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,EAAE;YAChC,OAAO,GAAG,GAA6B,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,KAAK,IAAI,CAAC,CAAC;QAEnD,MAAM,CACL,UAAU,CAAC,uBAAuB,CACjC,OAAO,EACP,IAAI,EAAE,QAAQ;QACd,GAAG,CACH,KAAK,IAAI,CACV,CAAC;QAEF,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,iBAAiB,KAAK,IAAI,CAAC,CAAC;QACpE,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC;QAEhD,MAAM,MAAM,GAAG,UAAU,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC;QAE9B,MAAM,WAAW,GAAG,IAAI,yBAAyB,CAChD,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,cAAc;QACtB,EAAE,GAAG,QAAQ,EAAE,gBAAgB,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,EACnE,GAAG,EAAE,GAAE,CAAC,CACR,CAAC;QAEF,MAAM,CAAC,SAAS,CAAE,WAAmB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAE9D,gDAAgD;QAChD,MAAM,CACL,UAAU,CAAC,uBAAuB,CACjC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,EAC3B,KAAK,EAAE,QAAQ;QACf,GAAG,CACH,KAAK,KAAK,CACX,CAAC;QAEF,2FAA2F;QAC3F,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;YAClB,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;YAC9B,UAAU,CAAC,uBAAuB,CACjC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,EAC3B,KAAK,EAAE,QAAQ;YACf,GAAG,CACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,8DAA8D;QAC9D,MAAM,CACL,UAAU,CAAC,uBAAuB,CACjC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,EAC3B,KAAK,EAAE,QAAQ;QACf,GAAG,CACH,KAAK,IAAI,CACV,CAAC;QAEF,6CAA6C;QAC7C,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;YAClB,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;YAC9B,UAAU,CAAC,uBAAuB,CACjC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,EAC3B,KAAK,EAAE,QAAQ;YACf,GAAG,CACH,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC5B;;;WAGG;QACH,MAAM,UAAU,GAAG,IAAI,yBAAyB,CAC/C,IAAI,EAAE,YAAY;QAClB,SAAS,EAAE,cAAc;QACzB,EAAE,GAAG,QAAQ,EAAE,gBAAgB,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,EACnE,GAAG,EAAE;YACJ,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAC9B,CAAC,CACD,CAAC;QAEF,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE;YAC7B,MAAM,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH;;WAEG;QACH,MAAM,SAAS,GAAG,UAAU,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,IAAI,yBAAyB,CAChD,IAAI,EAAE,YAAY;QAClB,SAAS,EAAE,cAAc;QACzB,EAAE,GAAG,QAAQ,EAAE,gBAAgB,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,EACnE,GAAG,EAAE;YACJ,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAC9B,CAAC,CACD,CAAC;QAEF,WAAW,CAAC,aAAa,CAAC,GAAG,EAAE;YAC9B,MAAM,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH;;WAEG;QACH,MAAM,UAAU,GAAG,UAAU,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;QAC3D,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,EAAE,uBAAuB,CAAC,CAAC;QAEjE;;WAEG;QACH,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI,yBAAyB,CAChD,IAAI,EAAE,YAAY;QAClB,SAAS,EAAE,cAAc;QACzB,EAAE,GAAG,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,EAC9D,GAAG,EAAE;YACJ,aAAa,GAAG,IAAI,CAAC;QACtB,CAAC,CACD,CAAC;QAEF,wBAAwB;QACxB,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QAEzE,IAAI,OAA2C,CAAC;QAChD,WAAW,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,EAAE;YACjC,OAAO,GAAG,GAA6B,CAAC;YACxC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,cAAc,CAAC,CAAC;QAE9C,WAAW,CAAC,uBAAuB,CAClC,OAAO,EACP,IAAI,EAAE,QAAQ;QACd,GAAG,CACH,CAAC,CAAC,iBAAiB;QACpB,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,WAAW,CAAC,uBAAuB,CAAC,GAAG,CAA2B,CAAC;QAClF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE3D,WAAW,CAAC,aAAa,CAAC,GAAG,EAAE;YAC9B,MAAM,CAAC,KAAK,EAAE,0BAA0B,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH;;;WAGG;QACH,aAAa,GAAG,KAAK,CAAC;QACtB,MAAM,WAAW,GAAG,IAAI,yBAAyB,CAChD,IAAI,EAAE,YAAY;QAClB,SAAS,EAAE,cAAc;QACzB;YACC,GAAG,QAAQ;YACX,gBAAgB,EAAE,SAAS;YAC3B,cAAc,EAAE,KAAK;YACrB,iBAAiB,EAAE,IAAI;SACvB,EACD,GAAG,EAAE,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,CAC5B,CAAC;QACF,WAAW,CAAC,uBAAuB,CAClC,OAAO,EACP,KAAK,EAAE,QAAQ;QACf,GAAG,CACH,CAAC,CAAC,iBAAiB;QACpB,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC;QACpE,WAAW,CAAC,aAAa,CAAC,GAAG,EAAE;YAC9B,MAAM,CACL,KAAK,EACL,yFAAyF,CACzF,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,0CAA0C;QAC1C,MAAM,OAAO,GAAG,WAAW,CAAC,uBAAuB,CAAC,GAAG,CAA2B,CAAC;QACnF,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACrD,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 */\nimport { strict as assert } from \"assert\";\nimport {\n\tDocumentsSchemaController,\n\ttype IDocumentSchemaCurrent,\n\ttype IDocumentSchemaFeatures,\n} from \"../summary/index.js\";\n\nfunction boolToProp(b: boolean) {\n\treturn b ? true : undefined;\n}\n\ndescribe(\"Runtime\", () => {\n\tconst validConfig: IDocumentSchemaCurrent = {\n\t\tversion: 1,\n\t\trefSeq: 0,\n\t\truntime: {\n\t\t\t// explicitSchemaControl: undefined,\n\t\t\tcompressionLz4: true,\n\t\t\tidCompressorMode: \"delayed\",\n\t\t\t// opGroupingEnabled: undefined,\n\t\t},\n\t};\n\n\tconst features: IDocumentSchemaFeatures = {\n\t\texplicitSchemaControl: true,\n\t\tcompressionLz4: true,\n\t\topGroupingEnabled: false,\n\t\tidCompressorMode: \"delayed\",\n\t};\n\n\tfunction createController(config: unknown) {\n\t\treturn new DocumentsSchemaController(\n\t\t\tfalse, // existing,\n\t\t\tconfig as IDocumentSchemaCurrent, // old schema,\n\t\t\tfeatures,\n\t\t\t() => {}, // onSchemaChange\n\t\t);\n\t}\n\n\tfunction testWrongConfig(config: unknown) {\n\t\tassert.throws(() => {\n\t\t\tcreateController(config);\n\t\t}, \"should throw on unknown property\");\n\n\t\tconst controller = createController(validConfig);\n\t\tassert.throws(() =>\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\tconfig as IDocumentSchemaCurrent,\n\t\t\t\tfalse, // local\n\t\t\t\t100,\n\t\t\t),\n\t\t); // sequenceNumber\n\t}\n\n\t// Validate first that config is indeed valid, such that all further tests are not tripping\n\t// on something else that they are not modifying.\n\tit(\"valid config\", () => {\n\t\tcreateController(validConfig);\n\t});\n\n\t// It's hard to say if we will allow additional propeorty trees here like this sample shows.\n\t// More likely that will require version bump, to ensure that old code does not run with such structure.\n\t// If if such configs will be backward compatible (similar to runtime options we are listing that were in use for very long time),\n\t// then maybe ability to add them in such back-compat way is a plus\n\tit(\"extra global property ois Ok\", () => {\n\t\tcreateController({ ...validConfig, appProperty: { foo: 5 } });\n\t});\n\n\tit(\"empty object\", () => {\n\t\ttestWrongConfig({});\n\t});\n\n\tit(\"wrong version\", () => {\n\t\ttestWrongConfig({ ...validConfig, version: 4 });\n\t\ttestWrongConfig({ ...validConfig, version: \"1\" });\n\t\ttestWrongConfig({ ...validConfig, version: \"2.0\" });\n\t});\n\n\tit(\"wrong refSeq\", () => {\n\t\ttestWrongConfig({ ...validConfig, refSeq: \"aaa\" });\n\t});\n\n\tit(\"no refSeq\", () => {\n\t\ttestWrongConfig({ ...validConfig, refSeq: undefined });\n\t});\n\n\tit(\"no runtime\", () => {\n\t\ttestWrongConfig({ ...validConfig, runtime: undefined });\n\t});\n\n\tit(\"unknown runtime property\", () => {\n\t\ttestWrongConfig({ ...validConfig, runtime: { ...validConfig.runtime, foo: 5 } });\n\t});\n\n\tit(\"wrong values for known properties\", () => {\n\t\ttestWrongConfig({\n\t\t\t...validConfig,\n\t\t\truntime: { ...validConfig.runtime, idCompressorMode: 5 },\n\t\t});\n\t\ttestWrongConfig({\n\t\t\t...validConfig,\n\t\t\truntime: { ...validConfig.runtime, idCompressorMode: \"foo\" },\n\t\t});\n\t\ttestWrongConfig({\n\t\t\t...validConfig,\n\t\t\truntime: { ...validConfig.runtime, opGroupingEnabled: false },\n\t\t});\n\t\ttestWrongConfig({\n\t\t\t...validConfig,\n\t\t\truntime: { ...validConfig.runtime, opGroupingEnabled: \"aa\" },\n\t\t});\n\t});\n\n\tfunction testSimpleCases(explicitSchemaControl: boolean, existing: boolean) {\n\t\tconst controller = new DocumentsSchemaController(\n\t\t\texisting, // existing,\n\t\t\tundefined, // old schema,\n\t\t\t{ ...features, explicitSchemaControl },\n\t\t\t() => assert(false, \"no schema changes!\"), // onSchemaChange\n\t\t);\n\n\t\tassert(controller.sessionSchema.refSeq === 0, \"refSeq\");\n\t\tassert(controller.sessionSchema.version === 1, \"version\");\n\t\tassert(\n\t\t\tcontroller.sessionSchema.runtime.explicitSchemaControl ===\n\t\t\t\tboolToProp(explicitSchemaControl),\n\t\t\t\"explicitSchemaControl\",\n\t\t);\n\n\t\tif (existing && explicitSchemaControl) {\n\t\t\tassert(controller.sessionSchema.runtime.compressionLz4 === undefined, \"lz4\");\n\t\t\tassert(\n\t\t\t\tcontroller.sessionSchema.runtime.idCompressorMode === undefined,\n\t\t\t\t\"idCompressorMode\",\n\t\t\t);\n\t\t} else {\n\t\t\tassert(controller.sessionSchema.runtime.compressionLz4 === true, \"lz4\");\n\t\t\tassert(\n\t\t\t\tcontroller.sessionSchema.runtime.idCompressorMode === \"delayed\",\n\t\t\t\t\"idCompressorMode\",\n\t\t\t);\n\t\t}\n\t\tassert(\n\t\t\tcontroller.sessionSchema.runtime.opGroupingEnabled === undefined,\n\t\t\t\"opGroupingEnabled\",\n\t\t);\n\n\t\tif (!existing || !explicitSchemaControl) {\n\t\t\tcontroller.onDisconnect();\n\t\t\tcontroller.onMessageSent(() => {\n\t\t\t\tassert(false, \"no messages should be sent!\");\n\t\t\t});\n\t\t}\n\n\t\t// get rid of all properties with undefined values.\n\t\tconst summarySchema = JSON.parse(\n\t\t\tJSON.stringify(controller.summarizeDocumentSchema(100 /* refSeq */)),\n\t\t);\n\t\tif (!explicitSchemaControl) {\n\t\t\tassert.deepEqual(summarySchema, validConfig, \"summarized schema as expected\");\n\t\t} else {\n\t\t\tconst expected = {\n\t\t\t\tversion: 1,\n\t\t\t\trefSeq: 0,\n\t\t\t\truntime: {\n\t\t\t\t\t// Existing files without any schema are considered to be in legacy mode.\n\t\t\t\t\texplicitSchemaControl: boolToProp(!existing),\n\t\t\t\t},\n\t\t\t};\n\t\t\tassert.deepEqual(\n\t\t\t\tsummarySchema,\n\t\t\t\tJSON.parse(JSON.stringify(expected)),\n\t\t\t\t\"summarized schema as expected\",\n\t\t\t);\n\t\t}\n\n\t\t// No local messages are expected\n\t\tassert.throws(() =>\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\tvalidConfig,\n\t\t\t\ttrue, // local\n\t\t\t\t100,\n\t\t\t),\n\t\t); // sequenceNumber\n\t}\n\n\tit(\"Creation of new document\", () => {\n\t\ttestSimpleCases(\n\t\t\ttrue, // explicitSchemaControl\n\t\t\tfalse, // existing\n\t\t);\n\t\ttestSimpleCases(\n\t\t\tfalse, // explicitSchemaControl\n\t\t\tfalse, // existing\n\t\t);\n\t});\n\n\tit(\"Existing document, no schema\", () => {\n\t\ttestSimpleCases(\n\t\t\ttrue, // explicitSchemaControl\n\t\t\ttrue, // existing\n\t\t);\n\t\ttestSimpleCases(\n\t\t\tfalse, // explicitSchemaControl\n\t\t\ttrue, // existing\n\t\t);\n\t});\n\n\tfunction testExistingDocNoChangesInSchema(schema: IDocumentSchemaCurrent) {\n\t\tconst controller = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tschema, // old schema,\n\t\t\tfeatures,\n\t\t\t() => {}, // onSchemaChange\n\t\t);\n\n\t\tcontroller.onDisconnect();\n\t\tcontroller.onMessageSent(() => {\n\t\t\tassert(false, \"no messages should be sent!\");\n\t\t});\n\t}\n\n\tit(\"Existing document with existing schema, no changes\", () => {\n\t\ttestExistingDocNoChangesInSchema(validConfig);\n\t\ttestExistingDocNoChangesInSchema({\n\t\t\t...validConfig,\n\t\t\truntime: { ...validConfig.runtime, explicitSchemaControl: true },\n\t\t});\n\t});\n\n\tit(\"Existing document, changes required; race conditions\", () => {\n\t\tconst controller = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tvalidConfig, // old schema,\n\t\t\t{ ...features, opGroupingEnabled: true },\n\t\t\t() => {}, // onSchemaChange\n\t\t);\n\n\t\tlet message: IDocumentSchemaCurrent | undefined;\n\t\tcontroller.onMessageSent((msg) => {\n\t\t\tmessage = msg as IDocumentSchemaCurrent;\n\t\t});\n\n\t\tassert(message !== undefined);\n\t\tassert(message.runtime.opGroupingEnabled === true);\n\n\t\tassert(\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\tmessage,\n\t\t\t\ttrue, // local\n\t\t\t\t200,\n\t\t\t) === true,\n\t\t);\n\n\t\tassert(controller.sessionSchema.runtime.opGroupingEnabled === true);\n\t\tassert(controller.sessionSchema.refSeq === 200);\n\n\t\tconst schema = controller.summarizeDocumentSchema(300);\n\t\tassert(schema !== undefined);\n\t\tassert(schema.refSeq === 200);\n\n\t\tconst controller2 = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tschema, // old schema,\n\t\t\t{ ...features, idCompressorMode: undefined, compressionLz4: false },\n\t\t\t() => {}, // onSchemaChange\n\t\t);\n\n\t\tassert.deepEqual((controller2 as any).documentSchema, schema);\n\n\t\t// updates with old refSeq should fail silently.\n\t\tassert(\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\t{ ...message, refSeq: 100 },\n\t\t\t\tfalse, // local\n\t\t\t\t201,\n\t\t\t) === false,\n\t\t);\n\n\t\t// new change with some future sequence number should never happen, thus code should throw.\n\t\tassert.throws(() => {\n\t\t\tassert(message !== undefined);\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\t{ ...message, refSeq: 300 },\n\t\t\t\tfalse, // local\n\t\t\t\t202,\n\t\t\t);\n\t\t});\n\n\t\t// new change in schema with updated ref seq should be allowed\n\t\tassert(\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\t{ ...message, refSeq: 200 },\n\t\t\t\tfalse, // local\n\t\t\t\t305,\n\t\t\t) === true,\n\t\t);\n\n\t\t// Sequence numbers should move only forward.\n\t\tassert.throws(() => {\n\t\t\tassert(message !== undefined);\n\t\t\tcontroller.processDocumentSchemaOp(\n\t\t\t\t{ ...message, refSeq: 305 },\n\t\t\t\tfalse, // local\n\t\t\t\t300,\n\t\t\t);\n\t\t});\n\t});\n\n\tit(\"AzureClient modes\", () => {\n\t\t/**\n\t\t * Start with no schema in a document.\n\t\t * There should be no ops sent.\n\t\t */\n\t\tconst controller = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tundefined, // old schema,\n\t\t\t{ ...features, idCompressorMode: undefined, compressionLz4: false },\n\t\t\t() => {\n\t\t\t\tassert(false, \"no changes!\");\n\t\t\t}, // onSchemaChange\n\t\t);\n\n\t\tcontroller.onMessageSent(() => {\n\t\t\tassert(false, \"no messages should be sent!\");\n\t\t});\n\n\t\t/**\n\t\t * validate that we can summarize, load new client from that summary and it also will not send any ops\n\t\t */\n\t\tconst newSchema = controller.summarizeDocumentSchema(100);\n\t\tconst controller2 = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tnewSchema, // old schema,\n\t\t\t{ ...features, idCompressorMode: undefined, compressionLz4: false },\n\t\t\t() => {\n\t\t\t\tassert(false, \"no changes!\");\n\t\t\t}, // onSchemaChange\n\t\t);\n\n\t\tcontroller2.onMessageSent(() => {\n\t\t\tassert(false, \"no messages should be sent!\");\n\t\t});\n\n\t\t/**\n\t\t * Summarize from that new client and ensure we are getting exactly same summary, thus getting to same state.\n\t\t */\n\t\tconst newSchema2 = controller.summarizeDocumentSchema(100);\n\t\tassert.deepEqual(newSchema, newSchema2, \"got into stable state\");\n\n\t\t/**\n\t\t * Now let's see if we can change schema.\n\t\t */\n\t\tlet schemaChanged = false;\n\t\tconst controller3 = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tnewSchema, // old schema,\n\t\t\t{ ...features, idCompressorMode: \"on\", compressionLz4: false },\n\t\t\t() => {\n\t\t\t\tschemaChanged = true;\n\t\t\t}, // onSchemaChange\n\t\t);\n\n\t\t// setting is not on yet\n\t\tassert(controller3.sessionSchema.runtime.idCompressorMode === undefined);\n\n\t\tlet message: IDocumentSchemaCurrent | undefined;\n\t\tcontroller3.onMessageSent((msg) => {\n\t\t\tmessage = msg as IDocumentSchemaCurrent;\n\t\t\tassert(message.runtime.idCompressorMode === \"on\");\n\t\t});\n\t\tassert(message !== undefined, \"message sent\");\n\n\t\tcontroller3.processDocumentSchemaOp(\n\t\t\tmessage,\n\t\t\ttrue, // local\n\t\t\t100,\n\t\t); // sequenceNumber\n\t\tassert(schemaChanged, \"schema changed\");\n\t\tassert(controller3.sessionSchema.runtime.idCompressorMode === \"on\");\n\t\tconst schema = controller3.summarizeDocumentSchema(200) as IDocumentSchemaCurrent;\n\t\tassert(schema.runtime.idCompressorMode === \"on\", \"now on\");\n\n\t\tcontroller3.onMessageSent(() => {\n\t\t\tassert(false, \"no more messages to send\");\n\t\t});\n\n\t\t/**\n\t\t * Validate now that another client that was observing schema changes (not initiating them) will arrive to same state\n\t\t * This client will want to flip groupedBatching, but it will process someone else op first...\n\t\t */\n\t\tschemaChanged = false;\n\t\tconst controller4 = new DocumentsSchemaController(\n\t\t\ttrue, // existing,\n\t\t\tnewSchema, // old schema,\n\t\t\t{\n\t\t\t\t...features,\n\t\t\t\tidCompressorMode: undefined,\n\t\t\t\tcompressionLz4: false,\n\t\t\t\topGroupingEnabled: true,\n\t\t\t},\n\t\t\t() => (schemaChanged = true), // onSchemaChange\n\t\t);\n\t\tcontroller4.processDocumentSchemaOp(\n\t\t\tmessage,\n\t\t\tfalse, // local\n\t\t\t200,\n\t\t); // sequenceNumber\n\t\tassert(schemaChanged, \"schema changed\");\n\t\tassert(controller4.sessionSchema.runtime.idCompressorMode === \"on\");\n\t\tcontroller4.onMessageSent(() => {\n\t\t\tassert(\n\t\t\t\tfalse,\n\t\t\t\t\"no messages should be sent - it lost a race and will not attempt to change file format.\",\n\t\t\t);\n\t\t});\n\n\t\t// Validate same summaries by two clients.\n\t\tconst schema2 = controller3.summarizeDocumentSchema(200) as IDocumentSchemaCurrent;\n\t\tassert.deepEqual(schema, schema2, \"same summaries\");\n\t});\n});\n"]}

package/lib/test/fuzz/fuzzUtils.js

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { createWeightedAsyncGenerator, combineReducersAsync, } from "@fluid-private/stochastic-test-utils";
+import { combineReducersAsync, createWeightedAsyncGenerator, } from "@fluid-private/stochastic-test-utils";
 import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils";
 const defaultConfig = {
     weights: {
@@ -41,24 +41,28 @@ function makeReducer() {
         await baseReducer(state, operation);
         state.containerRuntimeFactory.processAllMessages();
     };
+    const createNewSummarizer = async (state) => {
+        const oldRuntime = state.containerRuntime;
+        oldRuntime.disposeFn();
+        state.containerRuntime = state.containerRuntimeFactory.createContainerRuntime(new MockFluidDataStoreRuntime());
+        await state.containerRuntime.initializeWithStashedOps(oldRuntime);
+    };
     const reducer = combineReducersAsync({
         reconnect: async (state, _op) => {
-            // TODO AB#6954
             state.containerRuntime.connected = false;
             state.containerRuntime.connected = true;
+            await createNewSummarizer(state);
         },
         newSummarizer: async (state, _op) => {
-            // TODO AB#6954
-            state.containerRuntime.disposeFn();
-            state.containerRuntime = state.containerRuntimeFactory.createContainerRuntime(new MockFluidDataStoreRuntime());
+            await createNewSummarizer(state);
         },
         summaryNack: async (state, _op) => {
-            // TODO AB#6954: not sure if it deadlocks between needing to process the SummaryNack and waiting for it
             state.containerRuntime.prepareSummaryNack();
             await state.containerRuntime.summarize();
         },
         submitOp: async (state, _op) => {
-            // TODO AB#6954: Need to move things around package-wise since DDS Factories are in different packages
+            // Send arbitrary runtime op
+            state.containerRuntime.submit({}, {});
         },
     });
     return wrapper(reducer);

package/lib/test/fuzz/fuzzUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"fuzzUtils.js","sourceRoot":"","sources":["../../../src/test/fuzz/fuzzUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,4BAA4B,EAG5B,oBAAoB,GACpB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AA8B/E,MAAM,aAAa,GAAmD;IACrE,OAAO,EAAE;QACR,SAAS,EAAE,CAAC;QACZ,aAAa,EAAE,CAAC;QAChB,WAAW,EAAE,CAAC;QACd,QAAQ,EAAE,CAAC;KACX;CACD,CAAC;AAEF,MAAM,UAAU,4BAA4B,CAC3C,OAA6C;IAE7C,MAAM,SAAS,GAAG,KAAK,EAAE,MAA+B,EAAsB,EAAE,CAAC,CAAC;QACjF,IAAI,EAAE,WAAW;KACjB,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,KAAK,EAAE,MAA+B,EAA0B,EAAE,CAAC,CAAC;QACzF,IAAI,EAAE,eAAe;KACrB,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,KAAK,EAAE,MAA+B,EAAwB,EAAE,CAAC,CAAC;QACrF,IAAI,EAAE,aAAa;KACnB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,KAAK,EAAE,MAA+B,EAAqB,EAAE,CAAC,CAAC;QAC/E,IAAI,EAAE,UAAU;KAChB,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC;IAE/D,OAAO,4BAA4B,CAA+C;QACjF,CAAC,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;QACpC,CAAC,aAAa,EAAE,aAAa,CAAC,aAAa,CAAC;QAC5C,CAAC,WAAW,EAAE,aAAa,CAAC,WAAW,CAAC;QACxC,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC;KAClC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAmE;IACxF,OAAO,EAAE,WAAW,EAAE;CACtB,CAAC;AAEF,SAAS,WAAW;IACnB,MAAM,OAAO,GACZ,CACC,WAAqD,EACV,EAAE,CAC9C,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;QAC1B,MAAM,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACpC,KAAK,CAAC,uBAAuB,CAAC,kBAAkB,EAAE,CAAC;IACpD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,oBAAoB,CAA+C;QAClF,SAAS,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAc,EAAE,EAAE;YACnE,eAAe;YACf,KAAK,CAAC,gBAAgB,CAAC,SAAS,GAAG,KAAK,CAAC;YACzC,KAAK,CAAC,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC;QACzC,CAAC;QACD,aAAa,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAkB,EAAE,EAAE;YAC3E,eAAe;YACf,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;YACnC,KAAK,CAAC,gBAAgB,GAAG,KAAK,CAAC,uBAAuB,CAAC,sBAAsB,CAC5E,IAAI,yBAAyB,EAAE,CAC/B,CAAC;QACH,CAAC;QACD,WAAW,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAgB,EAAE,EAAE;YACvE,uGAAuG;YACvG,KAAK,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC5C,MAAM,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;QAC1C,CAAC;QACD,QAAQ,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAa,EAAE,EAAE;YACjE,sGAAsG;QACvG,CAAC;KACD,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tcreateWeightedAsyncGenerator,\n\tAsyncGenerator,\n\tAsyncReducer,\n\tcombineReducersAsync,\n} from \"@fluid-private/stochastic-test-utils\";\nimport { MockFluidDataStoreRuntime } from \"@fluidframework/test-runtime-utils\";\nimport type { SummarizerFuzzModel, SummarizerFuzzTestState } from \"./summarizerFuzzSuite.js\";\n\ninterface Reconnect {\n\ttype: \"reconnect\";\n}\n\ninterface NewSummarizer {\n\ttype: \"newSummarizer\";\n}\n\ninterface SummaryNack {\n\ttype: \"summaryNack\";\n}\n\ninterface SubmitOp {\n\ttype: \"submitOp\";\n}\n\nexport type SummarizerOperation = Reconnect | NewSummarizer | SummaryNack | SubmitOp;\n\nexport interface ISummarizerOperationGenerationConfig {\n\tweights?: {\n\t\treconnect: number;\n\t\tnewSummarizer: number;\n\t\tsummaryNack: number;\n\t\tsubmitOp: number;\n\t};\n}\n\nconst defaultConfig: Required<ISummarizerOperationGenerationConfig> = {\n\tweights: {\n\t\treconnect: 1,\n\t\tnewSummarizer: 1,\n\t\tsummaryNack: 1,\n\t\tsubmitOp: 1,\n\t},\n};\n\nexport function summarizerOperationGenerator(\n\toptions: ISummarizerOperationGenerationConfig,\n): AsyncGenerator<SummarizerOperation, SummarizerFuzzTestState> {\n\tconst reconnect = async (_state: SummarizerFuzzTestState): Promise<Reconnect> => ({\n\t\ttype: \"reconnect\",\n\t});\n\n\tconst newSummarizer = async (_state: SummarizerFuzzTestState): Promise<NewSummarizer> => ({\n\t\ttype: \"newSummarizer\",\n\t});\n\n\tconst summaryNack = async (_state: SummarizerFuzzTestState): Promise<SummaryNack> => ({\n\t\ttype: \"summaryNack\",\n\t});\n\n\tconst submitOp = async (_state: SummarizerFuzzTestState): Promise<SubmitOp> => ({\n\t\ttype: \"submitOp\",\n\t});\n\n\tconst usableWeights = options.weights ?? defaultConfig.weights;\n\n\treturn createWeightedAsyncGenerator<SummarizerOperation, SummarizerFuzzTestState>([\n\t\t[reconnect, usableWeights.reconnect],\n\t\t[newSummarizer, usableWeights.newSummarizer],\n\t\t[summaryNack, usableWeights.summaryNack],\n\t\t[submitOp, usableWeights.submitOp],\n\t]);\n}\n\nexport const baseModel: Omit<SummarizerFuzzModel, \"workloadName\" | \"generatorFactory\"> = {\n\treducer: makeReducer(),\n};\n\nfunction makeReducer(): AsyncReducer<SummarizerOperation, SummarizerFuzzTestState> {\n\tconst wrapper =\n\t\t<T>(\n\t\t\tbaseReducer: AsyncReducer<T, SummarizerFuzzTestState>,\n\t\t): AsyncReducer<T, SummarizerFuzzTestState> =>\n\t\tasync (state, operation) => {\n\t\t\tawait baseReducer(state, operation);\n\t\t\tstate.containerRuntimeFactory.processAllMessages();\n\t\t};\n\n\tconst reducer = combineReducersAsync<SummarizerOperation, SummarizerFuzzTestState>({\n\t\treconnect: async (state: SummarizerFuzzTestState, _op: Reconnect) => {\n\t\t\t// TODO AB#6954\n\t\t\tstate.containerRuntime.connected = false;\n\t\t\tstate.containerRuntime.connected = true;\n\t\t},\n\t\tnewSummarizer: async (state: SummarizerFuzzTestState, _op: NewSummarizer) => {\n\t\t\t// TODO AB#6954\n\t\t\tstate.containerRuntime.disposeFn();\n\t\t\tstate.containerRuntime = state.containerRuntimeFactory.createContainerRuntime(\n\t\t\t\tnew MockFluidDataStoreRuntime(),\n\t\t\t);\n\t\t},\n\t\tsummaryNack: async (state: SummarizerFuzzTestState, _op: SummaryNack) => {\n\t\t\t// TODO AB#6954: not sure if it deadlocks between needing to process the SummaryNack and waiting for it\n\t\t\tstate.containerRuntime.prepareSummaryNack();\n\t\t\tawait state.containerRuntime.summarize();\n\t\t},\n\t\tsubmitOp: async (state: SummarizerFuzzTestState, _op: SubmitOp) => {\n\t\t\t// TODO AB#6954: Need to move things around package-wise since DDS Factories are in different packages\n\t\t},\n\t});\n\n\treturn wrapper(reducer);\n}\n"]}
+{"version":3,"file":"fuzzUtils.js","sourceRoot":"","sources":["../../../src/test/fuzz/fuzzUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGN,oBAAoB,EACpB,4BAA4B,GAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AA8B/E,MAAM,aAAa,GAAmD;IACrE,OAAO,EAAE;QACR,SAAS,EAAE,CAAC;QACZ,aAAa,EAAE,CAAC;QAChB,WAAW,EAAE,CAAC;QACd,QAAQ,EAAE,CAAC;KACX;CACD,CAAC;AAEF,MAAM,UAAU,4BAA4B,CAC3C,OAA6C;IAE7C,MAAM,SAAS,GAAG,KAAK,EAAE,MAA+B,EAAsB,EAAE,CAAC,CAAC;QACjF,IAAI,EAAE,WAAW;KACjB,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,KAAK,EAAE,MAA+B,EAA0B,EAAE,CAAC,CAAC;QACzF,IAAI,EAAE,eAAe;KACrB,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,KAAK,EAAE,MAA+B,EAAwB,EAAE,CAAC,CAAC;QACrF,IAAI,EAAE,aAAa;KACnB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,KAAK,EAAE,MAA+B,EAAqB,EAAE,CAAC,CAAC;QAC/E,IAAI,EAAE,UAAU;KAChB,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC;IAE/D,OAAO,4BAA4B,CAA+C;QACjF,CAAC,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;QACpC,CAAC,aAAa,EAAE,aAAa,CAAC,aAAa,CAAC;QAC5C,CAAC,WAAW,EAAE,aAAa,CAAC,WAAW,CAAC;QACxC,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC;KAClC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAmE;IACxF,OAAO,EAAE,WAAW,EAAE;CACtB,CAAC;AAEF,SAAS,WAAW;IACnB,MAAM,OAAO,GACZ,CACC,WAAqD,EACV,EAAE,CAC9C,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;QAC1B,MAAM,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACpC,KAAK,CAAC,uBAAuB,CAAC,kBAAkB,EAAE,CAAC;IACpD,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,KAAK,EAAE,KAA8B,EAAE,EAAE;QACpE,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC1C,UAAU,CAAC,SAAS,EAAE,CAAC;QACvB,KAAK,CAAC,gBAAgB,GAAG,KAAK,CAAC,uBAAuB,CAAC,sBAAsB,CAC5E,IAAI,yBAAyB,EAAE,CAC/B,CAAC;QACF,MAAM,KAAK,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,oBAAoB,CAA+C;QAClF,SAAS,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAc,EAAE,EAAE;YACnE,KAAK,CAAC,gBAAgB,CAAC,SAAS,GAAG,KAAK,CAAC;YACzC,KAAK,CAAC,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC;YACxC,MAAM,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,aAAa,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAkB,EAAE,EAAE;YAC3E,MAAM,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,WAAW,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAgB,EAAE,EAAE;YACvE,KAAK,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC5C,MAAM,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;QAC1C,CAAC;QACD,QAAQ,EAAE,KAAK,EAAE,KAA8B,EAAE,GAAa,EAAE,EAAE;YACjE,4BAA4B;YAC5B,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACvC,CAAC;KACD,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tAsyncGenerator,\n\tAsyncReducer,\n\tcombineReducersAsync,\n\tcreateWeightedAsyncGenerator,\n} from \"@fluid-private/stochastic-test-utils\";\nimport { MockFluidDataStoreRuntime } from \"@fluidframework/test-runtime-utils\";\nimport type { SummarizerFuzzModel, SummarizerFuzzTestState } from \"./summarizerFuzzSuite.js\";\n\ninterface Reconnect {\n\ttype: \"reconnect\";\n}\n\ninterface NewSummarizer {\n\ttype: \"newSummarizer\";\n}\n\ninterface SummaryNack {\n\ttype: \"summaryNack\";\n}\n\ninterface SubmitOp {\n\ttype: \"submitOp\";\n}\n\nexport type SummarizerOperation = Reconnect | NewSummarizer | SummaryNack | SubmitOp;\n\nexport interface ISummarizerOperationGenerationConfig {\n\tweights?: {\n\t\treconnect: number;\n\t\tnewSummarizer: number;\n\t\tsummaryNack: number;\n\t\tsubmitOp: number;\n\t};\n}\n\nconst defaultConfig: Required<ISummarizerOperationGenerationConfig> = {\n\tweights: {\n\t\treconnect: 1,\n\t\tnewSummarizer: 1,\n\t\tsummaryNack: 1,\n\t\tsubmitOp: 1,\n\t},\n};\n\nexport function summarizerOperationGenerator(\n\toptions: ISummarizerOperationGenerationConfig,\n): AsyncGenerator<SummarizerOperation, SummarizerFuzzTestState> {\n\tconst reconnect = async (_state: SummarizerFuzzTestState): Promise<Reconnect> => ({\n\t\ttype: \"reconnect\",\n\t});\n\n\tconst newSummarizer = async (_state: SummarizerFuzzTestState): Promise<NewSummarizer> => ({\n\t\ttype: \"newSummarizer\",\n\t});\n\n\tconst summaryNack = async (_state: SummarizerFuzzTestState): Promise<SummaryNack> => ({\n\t\ttype: \"summaryNack\",\n\t});\n\n\tconst submitOp = async (_state: SummarizerFuzzTestState): Promise<SubmitOp> => ({\n\t\ttype: \"submitOp\",\n\t});\n\n\tconst usableWeights = options.weights ?? defaultConfig.weights;\n\n\treturn createWeightedAsyncGenerator<SummarizerOperation, SummarizerFuzzTestState>([\n\t\t[reconnect, usableWeights.reconnect],\n\t\t[newSummarizer, usableWeights.newSummarizer],\n\t\t[summaryNack, usableWeights.summaryNack],\n\t\t[submitOp, usableWeights.submitOp],\n\t]);\n}\n\nexport const baseModel: Omit<SummarizerFuzzModel, \"workloadName\" | \"generatorFactory\"> = {\n\treducer: makeReducer(),\n};\n\nfunction makeReducer(): AsyncReducer<SummarizerOperation, SummarizerFuzzTestState> {\n\tconst wrapper =\n\t\t<T>(\n\t\t\tbaseReducer: AsyncReducer<T, SummarizerFuzzTestState>,\n\t\t): AsyncReducer<T, SummarizerFuzzTestState> =>\n\t\tasync (state, operation) => {\n\t\t\tawait baseReducer(state, operation);\n\t\t\tstate.containerRuntimeFactory.processAllMessages();\n\t\t};\n\n\tconst createNewSummarizer = async (state: SummarizerFuzzTestState) => {\n\t\tconst oldRuntime = state.containerRuntime;\n\t\toldRuntime.disposeFn();\n\t\tstate.containerRuntime = state.containerRuntimeFactory.createContainerRuntime(\n\t\t\tnew MockFluidDataStoreRuntime(),\n\t\t);\n\t\tawait state.containerRuntime.initializeWithStashedOps(oldRuntime);\n\t};\n\n\tconst reducer = combineReducersAsync<SummarizerOperation, SummarizerFuzzTestState>({\n\t\treconnect: async (state: SummarizerFuzzTestState, _op: Reconnect) => {\n\t\t\tstate.containerRuntime.connected = false;\n\t\t\tstate.containerRuntime.connected = true;\n\t\t\tawait createNewSummarizer(state);\n\t\t},\n\t\tnewSummarizer: async (state: SummarizerFuzzTestState, _op: NewSummarizer) => {\n\t\t\tawait createNewSummarizer(state);\n\t\t},\n\t\tsummaryNack: async (state: SummarizerFuzzTestState, _op: SummaryNack) => {\n\t\t\tstate.containerRuntime.prepareSummaryNack();\n\t\t\tawait state.containerRuntime.summarize();\n\t\t},\n\t\tsubmitOp: async (state: SummarizerFuzzTestState, _op: SubmitOp) => {\n\t\t\t// Send arbitrary runtime op\n\t\t\tstate.containerRuntime.submit({}, {});\n\t\t},\n\t});\n\n\treturn wrapper(reducer);\n}\n"]}

package/lib/test/fuzz/summarizer.fuzz.spec.js

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { takeAsync } from "@fluid-private/stochastic-test-utils";
-import { summarizerOperationGenerator, baseModel } from "./fuzzUtils.js";
+import { baseModel, summarizerOperationGenerator } from "./fuzzUtils.js";
 import { createSummarizerFuzzSuite } from "./summarizerFuzzSuite.js";
 /**
  * Summarizer fuzz test should test that we eventually recover and send a summary successfully.
@@ -17,15 +17,17 @@ describe("Summarizer fuzz testing", () => {
     const model = {
         ...baseModel,
         workloadName: "summarizer",
-        generatorFactory: () => takeAsync(1, summarizerOperationGenerator({
+        generatorFactory: () => takeAsync(1000, summarizerOperationGenerator({
             weights: {
-                reconnect: 2,
-                newSummarizer: 2,
-                summaryNack: 2,
-                submitOp: 2,
+                reconnect: 1,
+                newSummarizer: 1,
+                summaryNack: 1,
+                submitOp: 1,
             },
         })),
     };
-    createSummarizerFuzzSuite(model);
+    createSummarizerFuzzSuite(model, {
+        defaultTestCount: 25,
+    });
 });
 //# sourceMappingURL=summarizer.fuzz.spec.js.map

package/lib/test/fuzz/summarizer.fuzz.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizer.fuzz.spec.js","sourceRoot":"","sources":["../../../src/test/fuzz/summarizer.fuzz.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAAE,4BAA4B,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE;;;;;;;GAOG;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACxC,MAAM,KAAK,GAAG;QACb,GAAG,SAAS;QACZ,YAAY,EAAE,YAAY;QAC1B,gBAAgB,EAAE,GAAG,EAAE,CACtB,SAAS,CACR,CAAC,EACD,4BAA4B,CAAC;YAC5B,OAAO,EAAE;gBACR,SAAS,EAAE,CAAC;gBACZ,aAAa,EAAE,CAAC;gBAChB,WAAW,EAAE,CAAC;gBACd,QAAQ,EAAE,CAAC;aACX;SACD,CAAC,CACF;KACF,CAAC;IAEF,yBAAyB,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { takeAsync } from \"@fluid-private/stochastic-test-utils\";\nimport { summarizerOperationGenerator, baseModel } from \"./fuzzUtils.js\";\nimport { createSummarizerFuzzSuite } from \"./summarizerFuzzSuite.js\";\n\n/**\n * Summarizer fuzz test should test that we eventually recover and send a summary successfully.\n * For DDS, we test for eventual consistency. For summarizer, we could test for eventual recovery.\n * After performing operations (i.e. disconnects, summaryNacks, ops from other clients, etc.) we should:\n * - start a fresh summarizer\n * - attempt a summary\n * If the system doesn't recover properly, then we have a bug to fix.\n */\n\ndescribe(\"Summarizer fuzz testing\", () => {\n\tconst model = {\n\t\t...baseModel,\n\t\tworkloadName: \"summarizer\",\n\t\tgeneratorFactory: () =>\n\t\t\ttakeAsync(\n\t\t\t\t1,\n\t\t\t\tsummarizerOperationGenerator({\n\t\t\t\t\tweights: {\n\t\t\t\t\t\treconnect: 2,\n\t\t\t\t\t\tnewSummarizer: 2,\n\t\t\t\t\t\tsummaryNack: 2,\n\t\t\t\t\t\tsubmitOp: 2,\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t),\n\t};\n\n\tcreateSummarizerFuzzSuite(model);\n});\n"]}
+{"version":3,"file":"summarizer.fuzz.spec.js","sourceRoot":"","sources":["../../../src/test/fuzz/summarizer.fuzz.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE;;;;;;;GAOG;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACxC,MAAM,KAAK,GAAG;QACb,GAAG,SAAS;QACZ,YAAY,EAAE,YAAY;QAC1B,gBAAgB,EAAE,GAAG,EAAE,CACtB,SAAS,CACR,IAAI,EACJ,4BAA4B,CAAC;YAC5B,OAAO,EAAE;gBACR,SAAS,EAAE,CAAC;gBACZ,aAAa,EAAE,CAAC;gBAChB,WAAW,EAAE,CAAC;gBACd,QAAQ,EAAE,CAAC;aACX;SACD,CAAC,CACF;KACF,CAAC;IAEF,yBAAyB,CAAC,KAAK,EAAE;QAChC,gBAAgB,EAAE,EAAE;KACpB,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 { takeAsync } from \"@fluid-private/stochastic-test-utils\";\nimport { baseModel, summarizerOperationGenerator } from \"./fuzzUtils.js\";\nimport { createSummarizerFuzzSuite } from \"./summarizerFuzzSuite.js\";\n\n/**\n * Summarizer fuzz test should test that we eventually recover and send a summary successfully.\n * For DDS, we test for eventual consistency. For summarizer, we could test for eventual recovery.\n * After performing operations (i.e. disconnects, summaryNacks, ops from other clients, etc.) we should:\n * - start a fresh summarizer\n * - attempt a summary\n * If the system doesn't recover properly, then we have a bug to fix.\n */\n\ndescribe(\"Summarizer fuzz testing\", () => {\n\tconst model = {\n\t\t...baseModel,\n\t\tworkloadName: \"summarizer\",\n\t\tgeneratorFactory: () =>\n\t\t\ttakeAsync(\n\t\t\t\t1000,\n\t\t\t\tsummarizerOperationGenerator({\n\t\t\t\t\tweights: {\n\t\t\t\t\t\treconnect: 1,\n\t\t\t\t\t\tnewSummarizer: 1,\n\t\t\t\t\t\tsummaryNack: 1,\n\t\t\t\t\t\tsubmitOp: 1,\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t),\n\t};\n\n\tcreateSummarizerFuzzSuite(model, {\n\t\tdefaultTestCount: 25,\n\t});\n});\n"]}

package/lib/test/fuzz/summarizerFuzzMocks.js

@@ -2,15 +2,16 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { MockContainerRuntimeFactoryForReconnection, MockContainerRuntimeForReconnection, } from "@fluidframework/test-runtime-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { createChildLogger, raiseConnectedEvent, } from "@fluidframework/telemetry-utils";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
 import { mergeStats } from "@fluidframework/runtime-utils";
-import { Summarizer, SummaryManager, SummaryCollection, RunWhileConnectedCoordinator, } from "../../summary/index.js";
+import { createChildLogger, raiseConnectedEvent, } from "@fluidframework/telemetry-utils";
+import { MockContainerRuntimeFactoryForReconnection, MockContainerRuntimeForReconnection, } from "@fluidframework/test-runtime-utils";
+import { v4 as uuid } from "uuid";
+import { RunWhileConnectedCoordinator, Summarizer, SummaryCollection, SummaryManager, } from "../../summary/index.js";
 export class MockContainerRuntimeFactoryForSummarizer extends MockContainerRuntimeFactoryForReconnection {
-    createContainerRuntime(dataStoreRuntime, overrides) {
-        const containerRuntime = new MockContainerRuntimeForSummarizer(dataStoreRuntime, this, this.runtimeOptions, overrides);
+    createContainerRuntime(dataStoreRuntime, _) {
+        const containerRuntime = new MockContainerRuntimeForSummarizer(dataStoreRuntime, this, this.runtimeOptions);
         this.runtimes.add(containerRuntime);
         return containerRuntime;
     }
@@ -22,9 +23,11 @@ const DefaultSummaryConfiguration = {
     initialSummarizerDelayMs: 5 * 1000, // 5 secs.
 };
 export class MockContainerRuntimeForSummarizer extends MockContainerRuntimeForReconnection {
-    constructor(dataStoreRuntime, factory, runtimeOptions = {}, overrides) {
-        super(dataStoreRuntime, factory, runtimeOptions, overrides);
+    constructor(dataStoreRuntime, factory, runtimeOptions = {}) {
+        // trackRemoteOps is needed for replaying all ops on creating new ContainerRuntime
+        super(dataStoreRuntime, factory, runtimeOptions, { trackRemoteOps: true });
         this.logger = createChildLogger();
+        this.nackScheduled = false;
         this.disposed = false;
         this.deltaManager.on("op", (message) => {
             this.emit("op", message);
@@ -42,12 +45,7 @@ export class MockContainerRuntimeForSummarizer extends MockContainerRuntimeForRe
     }
     /** Prepare a SummaryNack to be sent by the server */
     prepareSummaryNack() {
-        const contents = {
-            summaryProposal: {
-                summarySequenceNumber: this.deltaManager.lastSequenceNumber,
-            },
-        };
-        this.deltaManager.prepareInboundResponse(MessageType.SummaryNack, contents);
+        this.nackScheduled = true;
     }
     /** Call on the Summarizer object to summarize */
     async summarize() {
@@ -62,27 +60,27 @@ export class MockContainerRuntimeForSummarizer extends MockContainerRuntimeForRe
         ]);
     }
     async submitSummary(options) {
+        const handle = uuid();
         const summaryMessage = {
-            handle: "",
+            handle,
             head: "",
             message: "",
             parents: [],
         };
+        const clientSequenceNumber = ++this.deltaManager.clientSequenceNumber;
         const referenceSequenceNumber = this.deltaManager.lastSequenceNumber;
+        const minimumSequenceNumber = this.factory.getMinSeq();
         const summarizeMessage = {
             type: MessageType.Summarize,
-            clientSequenceNumber: 0,
+            clientSequenceNumber,
             referenceSequenceNumber,
             contents: summaryMessage,
         };
-        this.deltaManager.inbound.push({
-            ...summarizeMessage,
-            clientId: this.clientId,
-            sequenceNumber: 0,
-            minimumSequenceNumber: 0,
-            timestamp: 0,
-        });
         this.deltaManager.outbound.push([summarizeMessage]);
+        this.addPendingMessage(summarizeMessage.contents, summarizeMessage.metadata, summarizeMessage.clientSequenceNumber);
+        this.factory.processAllMessages();
+        this.scheduleAckNack(this.nackScheduled /* isNack */, handle, this.deltaManager.lastSequenceNumber);
+        this.nackScheduled = false;
         const summaryStats = {
             ...mergeStats(),
             dataStoreCount: 1,
@@ -91,10 +89,10 @@ export class MockContainerRuntimeForSummarizer extends MockContainerRuntimeForRe
         };
         return {
             stage: "submit",
-            handle: "",
-            clientSequenceNumber: -1,
+            handle,
+            clientSequenceNumber,
             referenceSequenceNumber,
-            minimumSequenceNumber: -1,
+            minimumSequenceNumber,
             submitOpDuration: 0,
             uploadDuration: 0,
             generateDuration: 0,
@@ -106,6 +104,26 @@ export class MockContainerRuntimeForSummarizer extends MockContainerRuntimeForRe
             summaryStats,
         };
     }
+    scheduleAckNack(isNack, handle, summarySequenceNumber) {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        Promise.resolve().then(() => {
+            const contents = {
+                handle,
+                summaryProposal: {
+                    summarySequenceNumber,
+                },
+            };
+            const summaryAckMessage = {
+                type: isNack ? MessageType.SummaryNack : MessageType.SummaryAck,
+                clientSequenceNumber: ++this.deltaManager.clientSequenceNumber,
+                referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
+                contents,
+            };
+            this.deltaManager.outbound.push([summaryAckMessage]);
+            this.addPendingMessage(summaryAckMessage.contents, undefined, summaryAckMessage.clientSequenceNumber);
+            this.factory.processAllMessages();
+        });
+    }
     async refreshLatestSummaryAck(options) {
         // Do nothing
     }