@fluidframework/odsp-driver 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.246488

package/lib/test/snapshotFormatTests.spec.js

@@ -0,0 +1,218 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { stringToBuffer } from "@fluid-internal/client-utils";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { parseCompactSnapshotResponse } from "../compactSnapshotParser.js";
+import { convertToCompactSnapshot } from "../compactSnapshotWriter.js";
+const snapshotTree = {
+    id: "SnapshotId",
+    blobs: {},
+    trees: {
+        ".protocol": {
+            blobs: {
+                attributes: "bARADgIe4qmDjJl2l2zz12IM3",
+                quorumMembers: "bARBkx1nses1pHL1vKnmFUfIC",
+                quorumProposals: "bARBkx1nses1pHL1vKnmFUfIC",
+            },
+            trees: {},
+        },
+        ".app": {
+            blobs: { ".metadata": "bARD4RKvW4LL1KmaUKp6hUMSp" },
+            trees: {
+                ".channels": {
+                    blobs: {},
+                    trees: {
+                        default: {
+                            blobs: {
+                                ".component": "bARC6dCXlcrPxQHw3PeROtmKc",
+                                "gc": "bARDNMoBed+nKrsf04id52iUA",
+                            },
+                            trees: {
+                                ".channels": {
+                                    blobs: {},
+                                    trees: {
+                                        root: { blobs: {}, trees: {} },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                    unreferenced: true,
+                },
+                ".blobs": { blobs: {}, trees: {} },
+            },
+            unreferenced: true,
+        },
+    },
+};
+const blobContents = new Map([
+    [
+        "bARADgIe4qmDjJl2l2zz12IM3",
+        stringToBuffer(JSON.stringify({ branch: "", minimumSequenceNumber: 0, sequenceNumber: 0, term: 1 }), "utf8"),
+    ],
+    ["bARBkx1nses1pHL1vKnmFUfIC", stringToBuffer(JSON.stringify([]), "utf8")],
+    [
+        "bARD4RKvW4LL1KmaUKp6hUMSp",
+        stringToBuffer(JSON.stringify({ summaryFormatVersion: 1, gcFeature: 0 }), "utf8"),
+    ],
+    [
+        "bARC6dCXlcrPxQHw3PeROtmKc",
+        stringToBuffer(JSON.stringify({
+            pkg: '["@fluid-example/smde"]',
+            summaryFormatVersion: 2,
+            isRootDataStore: true,
+        }), "utf8"),
+    ],
+    [
+        "bARDNMoBed+nKrsf04id52iUA",
+        stringToBuffer(JSON.stringify({
+            usedRoutes: [""],
+            gcData: {
+                gcNodes: {
+                    "/root": ["/default/01b197a2-0432-413b-b2c9-83a992b804c4", "/default"],
+                    "/01b197a2-0432-413b-b2c9-83a992b804c4": ["/default"],
+                    "/": ["/default/root", "/default/01b197a2-0432-413b-b2c9-83a992b804c4"],
+                },
+            },
+        }), "utf8"),
+    ],
+]);
+const ops = [
+    {
+        clientId: "X",
+        clientSequenceNumber: -1,
+        contents: null,
+        minimumSequenceNumber: 0,
+        referenceSequenceNumber: -1,
+        sequenceNumber: 1,
+        timestamp: 1623883807452,
+        type: "join",
+    },
+    {
+        clientId: "Y",
+        clientSequenceNumber: -1,
+        contents: null,
+        minimumSequenceNumber: 0,
+        referenceSequenceNumber: -1,
+        sequenceNumber: 2,
+        timestamp: 1623883811928,
+        type: "join",
+    },
+];
+const snapshotTreeWithGroupId = {
+    id: "SnapshotId",
+    blobs: {},
+    trees: {
+        ".protocol": {
+            blobs: {},
+            trees: {},
+        },
+        ".app": {
+            blobs: { ".metadata": "bARD4RKvW4LL1KmaUKp6hUMSp" },
+            trees: {
+                ".channels": {
+                    blobs: {},
+                    trees: {
+                        default: {
+                            blobs: {},
+                            trees: {
+                                dds: {
+                                    blobs: {},
+                                    trees: {},
+                                },
+                            },
+                            groupId: "G3",
+                        },
+                    },
+                    unreferenced: true,
+                    groupId: "G2",
+                    omitted: false,
+                },
+                ".blobs": { blobs: {}, trees: {} },
+            },
+            unreferenced: true,
+            groupId: "G4",
+        },
+    },
+};
+const blobContents2 = new Map([
+    [
+        "bARD4RKvW4LL1KmaUKp6hUMSp",
+        stringToBuffer(JSON.stringify({ summaryFormatVersion: 1, gcFeature: 0 }), "utf8"),
+    ],
+]);
+describe("Snapshot Format Conversion Tests", () => {
+    it("Conversion test", async () => {
+        const snapshotContents = {
+            snapshotTree,
+            blobContents,
+            ops,
+            sequenceNumber: 0,
+            latestSequenceNumber: 2,
+            snapshotFormatV: 1,
+        };
+        const logger = new MockLogger();
+        const compactSnapshot = convertToCompactSnapshot(snapshotContents);
+        const result = parseCompactSnapshotResponse(compactSnapshot, logger.toTelemetryLogger());
+        assert.deepStrictEqual(result.snapshotTree, snapshotTree, "Tree structure should match");
+        assert.deepStrictEqual(result.blobContents, blobContents, "Blobs content should match");
+        assert.deepStrictEqual(result.ops, ops, "Ops should match");
+        assert(result.sequenceNumber === 0, "Seq number should match");
+        assert(result.latestSequenceNumber === 2, "Latest sequence number should match");
+        assert((result.snapshotTree.id = snapshotContents.snapshotTree.id), "Snapshot id should match");
+        // Convert to compact snapshot again and then match to previous one.
+        const compactSnapshot2 = convertToCompactSnapshot(result);
+        assert.deepStrictEqual(compactSnapshot2.buffer, compactSnapshot.buffer, "Compact representation should remain same");
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+    it("Conversion test with empty ops", async () => {
+        const snapshotContents = {
+            snapshotTree,
+            blobContents,
+            ops: [],
+            sequenceNumber: 0,
+            latestSequenceNumber: 2,
+            snapshotFormatV: 1,
+        };
+        const logger = new MockLogger();
+        const compactSnapshot = convertToCompactSnapshot(snapshotContents);
+        const result = parseCompactSnapshotResponse(compactSnapshot, logger.toTelemetryLogger());
+        assert.deepStrictEqual(result.snapshotTree, snapshotTree, "Tree structure should match");
+        assert.deepStrictEqual(result.blobContents, blobContents, "Blobs content should match");
+        assert.deepStrictEqual(result.ops, [], "Ops should match");
+        assert(result.sequenceNumber === 0, "Seq number should match");
+        assert(result.latestSequenceNumber === 2, "Latest sequence number should match");
+        assert((result.snapshotTree.id = snapshotContents.snapshotTree.id), "Snapshot id should match");
+        // Convert to compact snapshot again and then match to previous one.
+        const compactSnapshot2 = convertToCompactSnapshot(result);
+        assert.deepStrictEqual(compactSnapshot2.buffer, compactSnapshot.buffer, "Compact representation should remain same");
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+    it("Conversion test for snapshot with GroupId", async () => {
+        const snapshotContents = {
+            snapshotTree: snapshotTreeWithGroupId,
+            blobContents: blobContents2,
+            ops,
+            sequenceNumber: 0,
+            latestSequenceNumber: 2,
+            snapshotFormatV: 1,
+        };
+        const logger = new MockLogger();
+        const compactSnapshot = convertToCompactSnapshot(snapshotContents);
+        const result = parseCompactSnapshotResponse(compactSnapshot, logger.toTelemetryLogger());
+        assert.deepStrictEqual(result.snapshotTree, snapshotTreeWithGroupId, "Tree structure should match");
+        assert.deepStrictEqual(result.blobContents, blobContents2, "Blobs content should match");
+        assert.deepStrictEqual(result.ops, ops, "Ops should match");
+        assert(result.sequenceNumber === 0, "Seq number should match");
+        assert(result.latestSequenceNumber === 2, "Latest sequence number should match");
+        assert((result.snapshotTree.id = snapshotContents.snapshotTree.id), "Snapshot id should match");
+        // Convert to compact snapshot again and then match to previous one.
+        const compactSnapshot2 = convertToCompactSnapshot(result);
+        assert.deepStrictEqual(compactSnapshot2.buffer, compactSnapshot.buffer, "Compact representation should remain same");
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+});
+//# sourceMappingURL=snapshotFormatTests.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotFormatTests.spec.js","sourceRoot":"","sources":["../../src/test/snapshotFormatTests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAEvE,MAAM,YAAY,GAAkB;IACnC,EAAE,EAAE,YAAY;IAChB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE;QACN,WAAW,EAAE;YACZ,KAAK,EAAE;gBACN,UAAU,EAAE,2BAA2B;gBACvC,aAAa,EAAE,2BAA2B;gBAC1C,eAAe,EAAE,2BAA2B;aAC5C;YACD,KAAK,EAAE,EAAE;SACT;QACD,MAAM,EAAE;YACP,KAAK,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE;YACnD,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,KAAK,EAAE,EAAE;oBACT,KAAK,EAAE;wBACN,OAAO,EAAE;4BACR,KAAK,EAAE;gCACN,YAAY,EAAE,2BAA2B;gCACzC,IAAI,EAAE,2BAA2B;6BACjC;4BACD,KAAK,EAAE;gCACN,WAAW,EAAE;oCACZ,KAAK,EAAE,EAAE;oCACT,KAAK,EAAE;wCACN,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;qCAC9B;iCACD;6BACD;yBACD;qBACD;oBACD,YAAY,EAAE,IAAI;iBAClB;gBACD,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;aAClC;YACD,YAAY,EAAE,IAAI;SAClB;KACD;CACD,CAAC;AAEF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAsB;IACjD;QACC,2BAA2B;QAC3B,cAAc,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EACpF,MAAM,CACN;KACD;IACD,CAAC,2BAA2B,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IACzE;QACC,2BAA2B;QAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;KACjF;IACD;QACC,2BAA2B;QAC3B,cAAc,CACb,IAAI,CAAC,SAAS,CAAC;YACd,GAAG,EAAE,yBAAyB;YAC9B,oBAAoB,EAAE,CAAC;YACvB,eAAe,EAAE,IAAI;SACrB,CAAC,EACF,MAAM,CACN;KACD;IACD;QACC,2BAA2B;QAC3B,cAAc,CACb,IAAI,CAAC,SAAS,CAAC;YACd,UAAU,EAAE,CAAC,EAAE,CAAC;YAChB,MAAM,EAAE;gBACP,OAAO,EAAE;oBACR,OAAO,EAAE,CAAC,+CAA+C,EAAE,UAAU,CAAC;oBACtE,uCAAuC,EAAE,CAAC,UAAU,CAAC;oBACrD,GAAG,EAAE,CAAC,eAAe,EAAE,+CAA+C,CAAC;iBACvE;aACD;SACD,CAAC,EACF,MAAM,CACN;KACD;CACD,CAAC,CAAC;AAEH,MAAM,GAAG,GAAgC;IACxC;QACC,QAAQ,EAAE,GAAG;QACb,oBAAoB,EAAE,CAAC,CAAC;QACxB,QAAQ,EAAE,IAAI;QACd,qBAAqB,EAAE,CAAC;QACxB,uBAAuB,EAAE,CAAC,CAAC;QAC3B,cAAc,EAAE,CAAC;QACjB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,MAAM;KACZ;IACD;QACC,QAAQ,EAAE,GAAG;QACb,oBAAoB,EAAE,CAAC,CAAC;QACxB,QAAQ,EAAE,IAAI;QACd,qBAAqB,EAAE,CAAC;QACxB,uBAAuB,EAAE,CAAC,CAAC;QAC3B,cAAc,EAAE,CAAC;QACjB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,MAAM;KACZ;CACD,CAAC;AAEF,MAAM,uBAAuB,GAAkB;IAC9C,EAAE,EAAE,YAAY;IAChB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE;QACN,WAAW,EAAE;YACZ,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,EAAE;SACT;QACD,MAAM,EAAE;YACP,KAAK,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE;YACnD,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,KAAK,EAAE,EAAE;oBACT,KAAK,EAAE;wBACN,OAAO,EAAE;4BACR,KAAK,EAAE,EAAE;4BACT,KAAK,EAAE;gCACN,GAAG,EAAE;oCACJ,KAAK,EAAE,EAAE;oCACT,KAAK,EAAE,EAAE;iCACT;6BACD;4BACD,OAAO,EAAE,IAAI;yBACb;qBACD;oBACD,YAAY,EAAE,IAAI;oBAClB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,KAAK;iBACd;gBACD,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;aAClC;YACD,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,IAAI;SACb;KACD;CACD,CAAC;AAEF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAsB;IAClD;QACC,2BAA2B;QAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;KACjF;CACD,CAAC,CAAC;AAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,gBAAgB,GAAc;YACnC,YAAY;YACZ,YAAY;YACZ,GAAG;YACH,cAAc,EAAE,CAAC;YACjB,oBAAoB,EAAE,CAAC;YACvB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,eAAe,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,4BAA4B,CAAC,eAAe,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,6BAA6B,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,4BAA4B,CAAC,CAAC;QACxF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,cAAc,KAAK,CAAC,EAAE,yBAAyB,CAAC,CAAC;QAC/D,MAAM,CAAC,MAAM,CAAC,oBAAoB,KAAK,CAAC,EAAE,qCAAqC,CAAC,CAAC;QACjF,MAAM,CACL,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,gBAAgB,CAAC,YAAY,CAAC,EAAE,CAAC,EAC3D,0BAA0B,CAC1B,CAAC;QACF,oEAAoE;QACpE,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,eAAe,CACrB,gBAAgB,CAAC,MAAM,EACvB,eAAe,CAAC,MAAM,EACtB,2CAA2C,CAC3C,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,gBAAgB,GAAc;YACnC,YAAY;YACZ,YAAY;YACZ,GAAG,EAAE,EAAE;YACP,cAAc,EAAE,CAAC;YACjB,oBAAoB,EAAE,CAAC;YACvB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,eAAe,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,4BAA4B,CAAC,eAAe,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,6BAA6B,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,4BAA4B,CAAC,CAAC;QACxF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,kBAAkB,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,cAAc,KAAK,CAAC,EAAE,yBAAyB,CAAC,CAAC;QAC/D,MAAM,CAAC,MAAM,CAAC,oBAAoB,KAAK,CAAC,EAAE,qCAAqC,CAAC,CAAC;QACjF,MAAM,CACL,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,gBAAgB,CAAC,YAAY,CAAC,EAAE,CAAC,EAC3D,0BAA0B,CAC1B,CAAC;QACF,oEAAoE;QACpE,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,eAAe,CACrB,gBAAgB,CAAC,MAAM,EACvB,eAAe,CAAC,MAAM,EACtB,2CAA2C,CAC3C,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,gBAAgB,GAAc;YACnC,YAAY,EAAE,uBAAuB;YACrC,YAAY,EAAE,aAAa;YAC3B,GAAG;YACH,cAAc,EAAE,CAAC;YACjB,oBAAoB,EAAE,CAAC;YACvB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,eAAe,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,4BAA4B,CAAC,eAAe,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CACrB,MAAM,CAAC,YAAY,EACnB,uBAAuB,EACvB,6BAA6B,CAC7B,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,4BAA4B,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,cAAc,KAAK,CAAC,EAAE,yBAAyB,CAAC,CAAC;QAC/D,MAAM,CAAC,MAAM,CAAC,oBAAoB,KAAK,CAAC,EAAE,qCAAqC,CAAC,CAAC;QACjF,MAAM,CACL,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,gBAAgB,CAAC,YAAY,CAAC,EAAE,CAAC,EAC3D,0BAA0B,CAC1B,CAAC;QACF,oEAAoE;QACpE,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,eAAe,CACrB,gBAAgB,CAAC,MAAM,EACvB,eAAe,CAAC,MAAM,EACtB,2CAA2C,CAC3C,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,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 \"node:assert\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { stringToBuffer } from \"@fluid-internal/client-utils\";\nimport { ISnapshot } from \"@fluidframework/driver-definitions\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { parseCompactSnapshotResponse } from \"../compactSnapshotParser.js\";\nimport { convertToCompactSnapshot } from \"../compactSnapshotWriter.js\";\n\nconst snapshotTree: ISnapshotTree = {\n\tid: \"SnapshotId\",\n\tblobs: {},\n\ttrees: {\n\t\t\".protocol\": {\n\t\t\tblobs: {\n\t\t\t\tattributes: \"bARADgIe4qmDjJl2l2zz12IM3\",\n\t\t\t\tquorumMembers: \"bARBkx1nses1pHL1vKnmFUfIC\",\n\t\t\t\tquorumProposals: \"bARBkx1nses1pHL1vKnmFUfIC\",\n\t\t\t},\n\t\t\ttrees: {},\n\t\t},\n\t\t\".app\": {\n\t\t\tblobs: { \".metadata\": \"bARD4RKvW4LL1KmaUKp6hUMSp\" },\n\t\t\ttrees: {\n\t\t\t\t\".channels\": {\n\t\t\t\t\tblobs: {},\n\t\t\t\t\ttrees: {\n\t\t\t\t\t\tdefault: {\n\t\t\t\t\t\t\tblobs: {\n\t\t\t\t\t\t\t\t\".component\": \"bARC6dCXlcrPxQHw3PeROtmKc\",\n\t\t\t\t\t\t\t\t\"gc\": \"bARDNMoBed+nKrsf04id52iUA\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\ttrees: {\n\t\t\t\t\t\t\t\t\".channels\": {\n\t\t\t\t\t\t\t\t\tblobs: {},\n\t\t\t\t\t\t\t\t\ttrees: {\n\t\t\t\t\t\t\t\t\t\troot: { blobs: {}, trees: {} },\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tunreferenced: true,\n\t\t\t\t},\n\t\t\t\t\".blobs\": { blobs: {}, trees: {} },\n\t\t\t},\n\t\t\tunreferenced: true,\n\t\t},\n\t},\n};\n\nconst blobContents = new Map<string, ArrayBuffer>([\n\t[\n\t\t\"bARADgIe4qmDjJl2l2zz12IM3\",\n\t\tstringToBuffer(\n\t\t\tJSON.stringify({ branch: \"\", minimumSequenceNumber: 0, sequenceNumber: 0, term: 1 }),\n\t\t\t\"utf8\",\n\t\t),\n\t],\n\t[\"bARBkx1nses1pHL1vKnmFUfIC\", stringToBuffer(JSON.stringify([]), \"utf8\")],\n\t[\n\t\t\"bARD4RKvW4LL1KmaUKp6hUMSp\",\n\t\tstringToBuffer(JSON.stringify({ summaryFormatVersion: 1, gcFeature: 0 }), \"utf8\"),\n\t],\n\t[\n\t\t\"bARC6dCXlcrPxQHw3PeROtmKc\",\n\t\tstringToBuffer(\n\t\t\tJSON.stringify({\n\t\t\t\tpkg: '[\"@fluid-example/smde\"]',\n\t\t\t\tsummaryFormatVersion: 2,\n\t\t\t\tisRootDataStore: true,\n\t\t\t}),\n\t\t\t\"utf8\",\n\t\t),\n\t],\n\t[\n\t\t\"bARDNMoBed+nKrsf04id52iUA\",\n\t\tstringToBuffer(\n\t\t\tJSON.stringify({\n\t\t\t\tusedRoutes: [\"\"],\n\t\t\t\tgcData: {\n\t\t\t\t\tgcNodes: {\n\t\t\t\t\t\t\"/root\": [\"/default/01b197a2-0432-413b-b2c9-83a992b804c4\", \"/default\"],\n\t\t\t\t\t\t\"/01b197a2-0432-413b-b2c9-83a992b804c4\": [\"/default\"],\n\t\t\t\t\t\t\"/\": [\"/default/root\", \"/default/01b197a2-0432-413b-b2c9-83a992b804c4\"],\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t}),\n\t\t\t\"utf8\",\n\t\t),\n\t],\n]);\n\nconst ops: ISequencedDocumentMessage[] = [\n\t{\n\t\tclientId: \"X\",\n\t\tclientSequenceNumber: -1,\n\t\tcontents: null,\n\t\tminimumSequenceNumber: 0,\n\t\treferenceSequenceNumber: -1,\n\t\tsequenceNumber: 1,\n\t\ttimestamp: 1623883807452,\n\t\ttype: \"join\",\n\t},\n\t{\n\t\tclientId: \"Y\",\n\t\tclientSequenceNumber: -1,\n\t\tcontents: null,\n\t\tminimumSequenceNumber: 0,\n\t\treferenceSequenceNumber: -1,\n\t\tsequenceNumber: 2,\n\t\ttimestamp: 1623883811928,\n\t\ttype: \"join\",\n\t},\n];\n\nconst snapshotTreeWithGroupId: ISnapshotTree = {\n\tid: \"SnapshotId\",\n\tblobs: {},\n\ttrees: {\n\t\t\".protocol\": {\n\t\t\tblobs: {},\n\t\t\ttrees: {},\n\t\t},\n\t\t\".app\": {\n\t\t\tblobs: { \".metadata\": \"bARD4RKvW4LL1KmaUKp6hUMSp\" },\n\t\t\ttrees: {\n\t\t\t\t\".channels\": {\n\t\t\t\t\tblobs: {},\n\t\t\t\t\ttrees: {\n\t\t\t\t\t\tdefault: {\n\t\t\t\t\t\t\tblobs: {},\n\t\t\t\t\t\t\ttrees: {\n\t\t\t\t\t\t\t\tdds: {\n\t\t\t\t\t\t\t\t\tblobs: {},\n\t\t\t\t\t\t\t\t\ttrees: {},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tgroupId: \"G3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tunreferenced: true,\n\t\t\t\t\tgroupId: \"G2\",\n\t\t\t\t\tomitted: false,\n\t\t\t\t},\n\t\t\t\t\".blobs\": { blobs: {}, trees: {} },\n\t\t\t},\n\t\t\tunreferenced: true,\n\t\t\tgroupId: \"G4\",\n\t\t},\n\t},\n};\n\nconst blobContents2 = new Map<string, ArrayBuffer>([\n\t[\n\t\t\"bARD4RKvW4LL1KmaUKp6hUMSp\",\n\t\tstringToBuffer(JSON.stringify({ summaryFormatVersion: 1, gcFeature: 0 }), \"utf8\"),\n\t],\n]);\n\ndescribe(\"Snapshot Format Conversion Tests\", () => {\n\tit(\"Conversion test\", async () => {\n\t\tconst snapshotContents: ISnapshot = {\n\t\t\tsnapshotTree,\n\t\t\tblobContents,\n\t\t\tops,\n\t\t\tsequenceNumber: 0,\n\t\t\tlatestSequenceNumber: 2,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst logger = new MockLogger();\n\t\tconst compactSnapshot = convertToCompactSnapshot(snapshotContents);\n\t\tconst result = parseCompactSnapshotResponse(compactSnapshot, logger.toTelemetryLogger());\n\t\tassert.deepStrictEqual(result.snapshotTree, snapshotTree, \"Tree structure should match\");\n\t\tassert.deepStrictEqual(result.blobContents, blobContents, \"Blobs content should match\");\n\t\tassert.deepStrictEqual(result.ops, ops, \"Ops should match\");\n\t\tassert(result.sequenceNumber === 0, \"Seq number should match\");\n\t\tassert(result.latestSequenceNumber === 2, \"Latest sequence number should match\");\n\t\tassert(\n\t\t\t(result.snapshotTree.id = snapshotContents.snapshotTree.id),\n\t\t\t\"Snapshot id should match\",\n\t\t);\n\t\t// Convert to compact snapshot again and then match to previous one.\n\t\tconst compactSnapshot2 = convertToCompactSnapshot(result);\n\t\tassert.deepStrictEqual(\n\t\t\tcompactSnapshot2.buffer,\n\t\t\tcompactSnapshot.buffer,\n\t\t\t\"Compact representation should remain same\",\n\t\t);\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n\n\tit(\"Conversion test with empty ops\", async () => {\n\t\tconst snapshotContents: ISnapshot = {\n\t\t\tsnapshotTree,\n\t\t\tblobContents,\n\t\t\tops: [],\n\t\t\tsequenceNumber: 0,\n\t\t\tlatestSequenceNumber: 2,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst logger = new MockLogger();\n\t\tconst compactSnapshot = convertToCompactSnapshot(snapshotContents);\n\t\tconst result = parseCompactSnapshotResponse(compactSnapshot, logger.toTelemetryLogger());\n\t\tassert.deepStrictEqual(result.snapshotTree, snapshotTree, \"Tree structure should match\");\n\t\tassert.deepStrictEqual(result.blobContents, blobContents, \"Blobs content should match\");\n\t\tassert.deepStrictEqual(result.ops, [], \"Ops should match\");\n\t\tassert(result.sequenceNumber === 0, \"Seq number should match\");\n\t\tassert(result.latestSequenceNumber === 2, \"Latest sequence number should match\");\n\t\tassert(\n\t\t\t(result.snapshotTree.id = snapshotContents.snapshotTree.id),\n\t\t\t\"Snapshot id should match\",\n\t\t);\n\t\t// Convert to compact snapshot again and then match to previous one.\n\t\tconst compactSnapshot2 = convertToCompactSnapshot(result);\n\t\tassert.deepStrictEqual(\n\t\t\tcompactSnapshot2.buffer,\n\t\t\tcompactSnapshot.buffer,\n\t\t\t\"Compact representation should remain same\",\n\t\t);\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n\n\tit(\"Conversion test for snapshot with GroupId\", async () => {\n\t\tconst snapshotContents: ISnapshot = {\n\t\t\tsnapshotTree: snapshotTreeWithGroupId,\n\t\t\tblobContents: blobContents2,\n\t\t\tops,\n\t\t\tsequenceNumber: 0,\n\t\t\tlatestSequenceNumber: 2,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst logger = new MockLogger();\n\t\tconst compactSnapshot = convertToCompactSnapshot(snapshotContents);\n\t\tconst result = parseCompactSnapshotResponse(compactSnapshot, logger.toTelemetryLogger());\n\t\tassert.deepStrictEqual(\n\t\t\tresult.snapshotTree,\n\t\t\tsnapshotTreeWithGroupId,\n\t\t\t\"Tree structure should match\",\n\t\t);\n\t\tassert.deepStrictEqual(result.blobContents, blobContents2, \"Blobs content should match\");\n\t\tassert.deepStrictEqual(result.ops, ops, \"Ops should match\");\n\t\tassert(result.sequenceNumber === 0, \"Seq number should match\");\n\t\tassert(result.latestSequenceNumber === 2, \"Latest sequence number should match\");\n\t\tassert(\n\t\t\t(result.snapshotTree.id = snapshotContents.snapshotTree.id),\n\t\t\t\"Snapshot id should match\",\n\t\t);\n\t\t// Convert to compact snapshot again and then match to previous one.\n\t\tconst compactSnapshot2 = convertToCompactSnapshot(result);\n\t\tassert.deepStrictEqual(\n\t\t\tcompactSnapshot2.buffer,\n\t\t\tcompactSnapshot.buffer,\n\t\t\t\"Compact representation should remain same\",\n\t\t);\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n});\n"]}

package/lib/test/socketTests/deltaConnectionUpdateTests.spec.js

@@ -0,0 +1,152 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { stub, useFakeTimers } from "sinon";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { EpochTracker } from "../../epochTracker.js";
+import { LocalPersistentCache } from "../../odspCache.js";
+import { getHashedDocumentId } from "../../odspPublicUtils.js";
+import * as socketModule from "../../socketModule.js";
+import * as joinSession from "../../vroom.js";
+import { OdspDocumentServiceFactory } from "../../odspDocumentServiceFactory.js";
+import { createOdspUrl } from "../../createOdspUrl.js";
+import { OdspDriverUrlResolver } from "../../odspDriverUrlResolver.js";
+import { ClientSocketMock } from "./socketMock.js";
+describe("DeltaConnectionMetadata update tests", () => {
+    let clock;
+    const client = {
+        mode: "write",
+        scopes: ["doc:read", "doc:write"],
+        details: { capabilities: { interactive: true } },
+        permission: [],
+        user: { id: "userId" },
+    };
+    let logger;
+    const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+    const driveId = "driveId";
+    const itemId = "itemId";
+    let epochTracker;
+    let localCache;
+    let hashedDocumentId;
+    let service;
+    let socket;
+    const resolver = new OdspDriverUrlResolver();
+    const joinSessionResponse = {
+        deltaStorageUrl: "https://fake/deltaStorageUrl",
+        deltaStreamSocketUrl: "https://localhost:3001",
+        id: "id",
+        tenantId: "tenantId",
+        snapshotStorageUrl: "https://fake/snapshotStorageUrl",
+        refreshSessionDurationSeconds: 100,
+    };
+    let odspDocumentServiceFactory;
+    // Stash the real setTimeout because sinon fake timers will hijack it.
+    const realSetTimeout = setTimeout;
+    // function to yield control in the Javascript event loop.
+    async function yieldEventLoop() {
+        await new Promise((resolve) => {
+            realSetTimeout(resolve, 0);
+        });
+    }
+    async function tickClock(tickValue) {
+        clock.tick(tickValue);
+        // Yield the event loop because the outbound op will be processed asynchronously.
+        await yieldEventLoop();
+    }
+    function addJoinSessionStub(label) {
+        joinSessionResponse.sensitivityLabelsInfo = JSON.stringify({
+            labels: label,
+            timestamp: Date.now(),
+        });
+        const joinSessionStub = stub(joinSession, "fetchJoinSession").callsFake(async () => joinSessionResponse);
+        return joinSessionStub;
+    }
+    before(async () => {
+        hashedDocumentId = await getHashedDocumentId(driveId, itemId);
+    });
+    beforeEach(async () => {
+        clock = useFakeTimers();
+        odspDocumentServiceFactory = new OdspDocumentServiceFactory(async (_options) => "token", async (_options) => "token", new LocalPersistentCache(2000), { snapshotOptions: { timeout: 2000 } });
+        const locator = { driveId, itemId, siteUrl, dataStorePath: "/" };
+        const request = createOdspUrl(locator);
+        const resolvedUrl = await resolver.resolve({ url: request });
+        logger = new MockLogger().toTelemetryLogger();
+        epochTracker = new EpochTracker(localCache, {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, logger);
+        service = (await odspDocumentServiceFactory.createDocumentService(resolvedUrl, logger));
+    });
+    async function mockSocket(_response, callback) {
+        const getSocketCreationStub = stub(socketModule, "SocketIOClientStatic");
+        getSocketCreationStub.returns(_response);
+        try {
+            return await callback();
+        }
+        finally {
+            getSocketCreationStub.restore();
+        }
+    }
+    it("Delta connection metadata should be updated via Fluid signals and join session response", async () => {
+        await tickClock(1);
+        socket = new ClientSocketMock();
+        let eventRaised = false;
+        let content;
+        const handler = (metadata) => {
+            eventRaised = true;
+            assert.strictEqual(
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            JSON.parse(metadata.sensitivityLabelsInfo).labels, content.labels, "label via event should match");
+        };
+        let joinSessionStub = addJoinSessionStub("label1");
+        content = { labels: "label1" };
+        service.on("metadataUpdate", handler);
+        const connection = (await mockSocket(socket, async () => service.connectToDeltaStream(client)));
+        assert(eventRaised, "event1 should have been raised");
+        service.off("metadataUpdate", handler);
+        joinSessionStub.restore();
+        assert(!connection.disposed, "connection should not be disposed");
+        assert(joinSessionStub.calledOnce, "Should called once on first try");
+        await tickClock(1);
+        // Now change label through signal and listen as event on service.
+        // eslint-disable-next-line require-atomic-updates
+        eventRaised = false;
+        content = { labels: "label2" };
+        const signalContent1 = { labels: "label2", timestamp: Date.now() };
+        const signalMessage1 = {
+            clientId: null,
+            content: JSON.stringify({
+                contents: {
+                    type: "PolicyLabelsUpdate",
+                    content: signalContent1,
+                },
+            }),
+        };
+        service.on("metadataUpdate", handler);
+        socket.emit("signal", signalMessage1);
+        assert(eventRaised, "event2 should have been raised");
+        service.off("metadataUpdate", handler);
+        await tickClock(1);
+        // Now update through join session response
+        // eslint-disable-next-line require-atomic-updates
+        eventRaised = false;
+        content = { labels: "label3" };
+        service.on("metadataUpdate", handler);
+        joinSessionStub = addJoinSessionStub("label3");
+        await tickClock(70000);
+        joinSessionStub.restore();
+        assert(eventRaised, "event3 should have been raised");
+        service.off("metadataUpdate", handler);
+    });
+    afterEach(async () => {
+        clock.reset();
+        socket?.close();
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    afterEach(async () => {
+        clock.restore();
+    });
+});
+//# sourceMappingURL=deltaConnectionUpdateTests.spec.js.map

package/lib/test/socketTests/deltaConnectionUpdateTests.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deltaConnectionUpdateTests.spec.js","sourceRoot":"","sources":["../../../src/test/socketTests/deltaConnectionUpdateTests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,aAAa,EAAmC,MAAM,OAAO,CAAC;AAG7E,OAAO,EAAuB,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElF,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AAEjF,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD,QAAQ,CAAC,sCAAsC,EAAE,GAAG,EAAE;IACrD,IAAI,KAAsB,CAAC;IAC3B,MAAM,MAAM,GAAY;QACvB,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC;QACjC,OAAO,EAAE,EAAE,YAAY,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QAChD,UAAU,EAAE,EAAE;QACd,IAAI,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE;KACtB,CAAC;IAEF,IAAI,MAA2B,CAAC;IAChC,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAC9D,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;IACxB,IAAI,YAA0B,CAAC;IAC/B,IAAI,UAAgC,CAAC;IACrC,IAAI,gBAAwB,CAAC;IAC7B,IAAI,OAA4B,CAAC;IACjC,IAAI,MAAoC,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,MAAM,mBAAmB,GAA4B;QACpD,eAAe,EAAE,8BAA8B;QAC/C,oBAAoB,EAAE,wBAAwB;QAC9C,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,UAAU;QACpB,kBAAkB,EAAE,iCAAiC;QACrD,6BAA6B,EAAE,GAAG;KAClC,CAAC;IACF,IAAI,0BAAsD,CAAC;IAE3D,sEAAsE;IACtE,MAAM,cAAc,GAAG,UAAU,CAAC;IAElC,0DAA0D;IAC1D,KAAK,UAAU,cAAc;QAC5B,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,UAAU,SAAS,CAAC,SAAiB;QACzC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtB,iFAAiF;QACjF,MAAM,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,SAAS,kBAAkB,CAAC,KAAa;QACxC,mBAAmB,CAAC,qBAAqB,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1D,MAAM,EAAE,KAAK;YACb,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACrB,CAAC,CAAC;QACH,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC,SAAS,CACtE,KAAK,IAAI,EAAE,CAAC,mBAAmB,CAC/B,CAAC;QACF,OAAO,eAAe,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACrB,KAAK,GAAG,aAAa,EAAE,CAAC;QACxB,0BAA0B,GAAG,IAAI,0BAA0B,CAC1D,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAC9B,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CACtC,CAAC;QACF,MAAM,OAAO,GAA8B,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC;QAC5F,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAC7D,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC,iBAAiB,EAAE,CAAC;QAC9C,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,MAAM,CACN,CAAC;QAEF,OAAO,GAAG,CAAC,MAAM,0BAA0B,CAAC,qBAAqB,CAChE,WAAW,EACX,MAAM,CACN,CAAwB,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,KAAK,UAAU,UAAU,CAAI,SAAiB,EAAE,QAA0B;QACzE,MAAM,qBAAqB,GAAG,IAAI,CAAC,YAAY,EAAE,sBAAsB,CAAC,CAAC;QACzE,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI;YACH,OAAO,MAAM,QAAQ,EAAE,CAAC;SACxB;gBAAS;YACT,qBAAqB,CAAC,OAAO,EAAE,CAAC;SAChC;IACF,CAAC;IAED,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;QACxG,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAChC,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,OAA+B,CAAC;QAEpC,MAAM,OAAO,GAAG,CAAC,QAAgC,EAAQ,EAAE;YAC1D,WAAW,GAAG,IAAI,CAAC;YACnB,MAAM,CAAC,WAAW;YACjB,sEAAsE;YACtE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,MAAM,EACjD,OAAO,CAAC,MAAM,EACd,8BAA8B,CAC9B,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAEnD,OAAO,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,EAAE,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,CAAC,MAAM,UAAU,CAAC,MAA2B,EAAE,KAAK,IAAI,EAAE,CAC5E,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CACpC,CAAgC,CAAC;QAClC,MAAM,CAAC,WAAW,EAAE,gCAAgC,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACvC,eAAe,CAAC,OAAO,EAAE,CAAC;QAE1B,MAAM,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,mCAAmC,CAAC,CAAC;QAElE,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,iCAAiC,CAAC,CAAC;QAEtE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;QAEnB,kEAAkE;QAClE,kDAAkD;QAClD,WAAW,GAAG,KAAK,CAAC;QACpB,OAAO,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC/B,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QACnE,MAAM,cAAc,GAAmB;YACtC,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;gBACvB,QAAQ,EAAE;oBACT,IAAI,EAAE,oBAAoB;oBAC1B,OAAO,EAAE,cAAc;iBACvB;aACD,CAAC;SACF,CAAC;QAEF,OAAO,CAAC,EAAE,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAEtC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACtC,MAAM,CAAC,WAAW,EAAE,gCAAgC,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAEvC,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;QAEnB,2CAA2C;QAC3C,kDAAkD;QAClD,WAAW,GAAG,KAAK,CAAC;QACpB,OAAO,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,EAAE,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACtC,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QACvB,eAAe,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,CAAC,WAAW,EAAE,gCAAgC,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACpB,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,MAAM,EAAE,KAAK,EAAE,CAAC;QAChB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACpB,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,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 \"node:assert\";\nimport { stub, useFakeTimers, SinonFakeTimers, type SinonStub } from \"sinon\";\nimport { ISocketStorageDiscovery } from \"@fluidframework/odsp-driver-definitions\";\nimport { IClient, ISignalMessage } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLoggerExt, MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { Socket } from \"socket.io-client\";\nimport { EpochTracker } from \"../../epochTracker.js\";\nimport { LocalPersistentCache } from \"../../odspCache.js\";\nimport { getHashedDocumentId } from \"../../odspPublicUtils.js\";\nimport { OdspDocumentDeltaConnection } from \"../../odspDocumentDeltaConnection.js\";\nimport * as socketModule from \"../../socketModule.js\";\nimport * as joinSession from \"../../vroom.js\";\nimport { OdspDocumentService } from \"../../odspDocumentService.js\";\nimport { OdspDocumentServiceFactory } from \"../../odspDocumentServiceFactory.js\";\nimport { OdspFluidDataStoreLocator } from \"../../contractsPublic.js\";\nimport { createOdspUrl } from \"../../createOdspUrl.js\";\nimport { OdspDriverUrlResolver } from \"../../odspDriverUrlResolver.js\";\nimport { ClientSocketMock } from \"./socketMock.js\";\n\ndescribe(\"DeltaConnectionMetadata update tests\", () => {\n\tlet clock: SinonFakeTimers;\n\tconst client: IClient = {\n\t\tmode: \"write\",\n\t\tscopes: [\"doc:read\", \"doc:write\"],\n\t\tdetails: { capabilities: { interactive: true } },\n\t\tpermission: [],\n\t\tuser: { id: \"userId\" },\n\t};\n\n\tlet logger: ITelemetryLoggerExt;\n\tconst siteUrl = \"https://microsoft.sharepoint-df.com/siteUrl\";\n\tconst driveId = \"driveId\";\n\tconst itemId = \"itemId\";\n\tlet epochTracker: EpochTracker;\n\tlet localCache: LocalPersistentCache;\n\tlet hashedDocumentId: string;\n\tlet service: OdspDocumentService;\n\tlet socket: ClientSocketMock | undefined;\n\tconst resolver = new OdspDriverUrlResolver();\n\tconst joinSessionResponse: ISocketStorageDiscovery = {\n\t\tdeltaStorageUrl: \"https://fake/deltaStorageUrl\",\n\t\tdeltaStreamSocketUrl: \"https://localhost:3001\",\n\t\tid: \"id\",\n\t\ttenantId: \"tenantId\",\n\t\tsnapshotStorageUrl: \"https://fake/snapshotStorageUrl\",\n\t\trefreshSessionDurationSeconds: 100,\n\t};\n\tlet odspDocumentServiceFactory: OdspDocumentServiceFactory;\n\n\t// Stash the real setTimeout because sinon fake timers will hijack it.\n\tconst realSetTimeout = setTimeout;\n\n\t// function to yield control in the Javascript event loop.\n\tasync function yieldEventLoop(): Promise<void> {\n\t\tawait new Promise<void>((resolve) => {\n\t\t\trealSetTimeout(resolve, 0);\n\t\t});\n\t}\n\n\tasync function tickClock(tickValue: number): Promise<void> {\n\t\tclock.tick(tickValue);\n\n\t\t// Yield the event loop because the outbound op will be processed asynchronously.\n\t\tawait yieldEventLoop();\n\t}\n\n\tfunction addJoinSessionStub(label: string): SinonStub {\n\t\tjoinSessionResponse.sensitivityLabelsInfo = JSON.stringify({\n\t\t\tlabels: label,\n\t\t\ttimestamp: Date.now(),\n\t\t});\n\t\tconst joinSessionStub = stub(joinSession, \"fetchJoinSession\").callsFake(\n\t\t\tasync () => joinSessionResponse,\n\t\t);\n\t\treturn joinSessionStub;\n\t}\n\n\tbefore(async () => {\n\t\thashedDocumentId = await getHashedDocumentId(driveId, itemId);\n\t});\n\n\tbeforeEach(async () => {\n\t\tclock = useFakeTimers();\n\t\todspDocumentServiceFactory = new OdspDocumentServiceFactory(\n\t\t\tasync (_options) => \"token\",\n\t\t\tasync (_options) => \"token\",\n\t\t\tnew LocalPersistentCache(2000),\n\t\t\t{ snapshotOptions: { timeout: 2000 } },\n\t\t);\n\t\tconst locator: OdspFluidDataStoreLocator = { driveId, itemId, siteUrl, dataStorePath: \"/\" };\n\t\tconst request = createOdspUrl(locator);\n\t\tconst resolvedUrl = await resolver.resolve({ url: request });\n\t\tlogger = new MockLogger().toTelemetryLogger();\n\t\tepochTracker = new EpochTracker(\n\t\t\tlocalCache,\n\t\t\t{\n\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\tresolvedUrl,\n\t\t\t},\n\t\t\tlogger,\n\t\t);\n\n\t\tservice = (await odspDocumentServiceFactory.createDocumentService(\n\t\t\tresolvedUrl,\n\t\t\tlogger,\n\t\t)) as OdspDocumentService;\n\t});\n\n\tasync function mockSocket<T>(_response: Socket, callback: () => Promise<T>): Promise<T> {\n\t\tconst getSocketCreationStub = stub(socketModule, \"SocketIOClientStatic\");\n\t\tgetSocketCreationStub.returns(_response);\n\t\ttry {\n\t\t\treturn await callback();\n\t\t} finally {\n\t\t\tgetSocketCreationStub.restore();\n\t\t}\n\t}\n\n\tit(\"Delta connection metadata should be updated via Fluid signals and join session response\", async () => {\n\t\tawait tickClock(1);\n\t\tsocket = new ClientSocketMock();\n\t\tlet eventRaised = false;\n\t\tlet content: Record<string, string>;\n\n\t\tconst handler = (metadata: Record<string, string>): void => {\n\t\t\teventRaised = true;\n\t\t\tassert.strictEqual(\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\t\tJSON.parse(metadata.sensitivityLabelsInfo).labels,\n\t\t\t\tcontent.labels,\n\t\t\t\t\"label via event should match\",\n\t\t\t);\n\t\t};\n\n\t\tlet joinSessionStub = addJoinSessionStub(\"label1\");\n\n\t\tcontent = { labels: \"label1\" };\n\t\tservice.on(\"metadataUpdate\", handler);\n\t\tconst connection = (await mockSocket(socket as unknown as Socket, async () =>\n\t\t\tservice.connectToDeltaStream(client),\n\t\t)) as OdspDocumentDeltaConnection;\n\t\tassert(eventRaised, \"event1 should have been raised\");\n\t\tservice.off(\"metadataUpdate\", handler);\n\t\tjoinSessionStub.restore();\n\n\t\tassert(!connection.disposed, \"connection should not be disposed\");\n\n\t\tassert(joinSessionStub.calledOnce, \"Should called once on first try\");\n\n\t\tawait tickClock(1);\n\n\t\t// Now change label through signal and listen as event on service.\n\t\t// eslint-disable-next-line require-atomic-updates\n\t\teventRaised = false;\n\t\tcontent = { labels: \"label2\" };\n\t\tconst signalContent1 = { labels: \"label2\", timestamp: Date.now() };\n\t\tconst signalMessage1: ISignalMessage = {\n\t\t\tclientId: null,\n\t\t\tcontent: JSON.stringify({\n\t\t\t\tcontents: {\n\t\t\t\t\ttype: \"PolicyLabelsUpdate\",\n\t\t\t\t\tcontent: signalContent1,\n\t\t\t\t},\n\t\t\t}),\n\t\t};\n\n\t\tservice.on(\"metadataUpdate\", handler);\n\n\t\tsocket.emit(\"signal\", signalMessage1);\n\t\tassert(eventRaised, \"event2 should have been raised\");\n\t\tservice.off(\"metadataUpdate\", handler);\n\n\t\tawait tickClock(1);\n\n\t\t// Now update through join session response\n\t\t// eslint-disable-next-line require-atomic-updates\n\t\teventRaised = false;\n\t\tcontent = { labels: \"label3\" };\n\t\tservice.on(\"metadataUpdate\", handler);\n\t\tjoinSessionStub = addJoinSessionStub(\"label3\");\n\t\tawait tickClock(70000);\n\t\tjoinSessionStub.restore();\n\t\tassert(eventRaised, \"event3 should have been raised\");\n\t\tservice.off(\"metadataUpdate\", handler);\n\t});\n\n\tafterEach(async () => {\n\t\tclock.reset();\n\t\tsocket?.close();\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tafterEach(async () => {\n\t\tclock.restore();\n\t});\n});\n"]}

package/lib/test/socketTests/socketMock.js

@@ -0,0 +1,109 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { v4 as uuid } from "uuid";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { createGenericNetworkError } from "@fluidframework/driver-utils";
+import { ScopeType } from "@fluidframework/protocol-definitions";
+import { pkgVersion as driverVersion } from "../../packageVersion.js";
+/**
+ * Class to mock the client socket connection. It can intercepts the events made on the socket
+ * and then do its custom logic and can also send events to the client back.
+ */
+export class ClientSocketMock extends TypedEventEmitter {
+    constructor(mockSocketConnectResponse = {
+        connect_document: { eventToEmit: "connect_document_success" },
+    }) {
+        super();
+        this.mockSocketConnectResponse = mockSocketConnectResponse;
+        this.disconnected = false;
+    }
+    get connected() {
+        return !this.disconnected;
+    }
+    close() {
+        this.disconnect();
+    }
+    disconnect() {
+        this.disconnected = true;
+    }
+    get io() {
+        return {
+            reconnection: () => false,
+            reconnectionAttempts: () => 0,
+        };
+    }
+    sendDisconnectEvent(reason, details) {
+        const error = reason ??
+            createGenericNetworkError("TestError", { canRetry: false }, { driverVersion });
+        this.emit("disconnect", error, details);
+    }
+    sendErrorEvent(error) {
+        this.emit("error", error ?? createGenericNetworkError("TestError", { canRetry: false }, { driverVersion }));
+    }
+    sendServerDisconnectEvent(socketError, clientId) {
+        if (clientId === undefined) {
+            this.disconnect();
+        }
+        this.emit("server_disconnect", socketError, clientId);
+    }
+    emit(eventName, ...args) {
+        switch (eventName) {
+            case "connect_document": {
+                const connectMessage = args[0];
+                switch (this.mockSocketConnectResponse.connect_document.eventToEmit) {
+                    case "connect_document_error":
+                    case "connect_error": {
+                        const errorToThrow = this.mockSocketConnectResponse.connect_document.errorToThrow ??
+                            createGenericNetworkError("TestError", { canRetry: false }, { driverVersion });
+                        this.emit(this.mockSocketConnectResponse.connect_document.eventToEmit, errorToThrow);
+                        break;
+                    }
+                    case "connect_document_success": {
+                        const iConnected = this.mockSocketConnectResponse
+                            .connect_document.connectMessage ?? {
+                            clientId: uuid(),
+                            existing: true,
+                            initialClients: [],
+                            initialMessages: [],
+                            initialSignals: [],
+                            maxMessageSize: 1000,
+                            mode: connectMessage.mode,
+                            version: connectMessage.versions[0],
+                            serviceConfiguration: { maxMessageSize: 1000, blockSize: 1000 },
+                            claims: {
+                                documentId: connectMessage.id,
+                                scopes: [
+                                    ScopeType.DocWrite,
+                                    ScopeType.DocRead,
+                                    ScopeType.SummaryWrite,
+                                ],
+                                tenantId: connectMessage.tenantId,
+                                ver: "1.0.0",
+                                iat: 10,
+                                exp: 10,
+                                user: connectMessage.client.user,
+                            },
+                            supportedVersions: connectMessage.versions,
+                            epoch: "testEpoch",
+                        };
+                        this.emit("connect_document_success", iConnected);
+                        break;
+                    }
+                    case "connect_timeout": {
+                        this.emit("connect_timeout");
+                        break;
+                    }
+                    default: // No-op
+                }
+                return true;
+            }
+            default: {
+                super.emit(eventName, ...args);
+                return true;
+            }
+        }
+    }
+}
+//# sourceMappingURL=socketMock.js.map

package/lib/test/socketTests/socketMock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketMock.js","sourceRoot":"","sources":["../../../src/test/socketTests/socketMock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAwB,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,yBAAyB,CAAC;AA+BtE;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,iBAAmC;IAExE,YACkB,4BAAwD;QACxE,gBAAgB,EAAE,EAAE,WAAW,EAAE,0BAA0B,EAAE;KAC7D;QAED,KAAK,EAAE,CAAC;QAJS,8BAAyB,GAAzB,yBAAyB,CAEzC;QAJK,iBAAY,GAAG,KAAK,CAAC;IAO5B,CAAC;IAED,IAAW,SAAS;QACnB,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAEM,KAAK;QACX,IAAI,CAAC,UAAU,EAAE,CAAC;IACnB,CAAC;IAEM,UAAU;QAChB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,IAAW,EAAE;QAIZ,OAAO;YACN,YAAY,EAAE,GAAG,EAAE,CAAC,KAAK;YACzB,oBAAoB,EAAE,GAAG,EAAE,CAAC,CAAC;SAC7B,CAAC;IACH,CAAC;IAEM,mBAAmB,CACzB,MAAwB,EACxB,OAAuD;QAEvD,MAAM,KAAK,GACV,MAAM;YACN,yBAAyB,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAEM,cAAc,CAAC,KAAuB;QAC5C,IAAI,CAAC,IAAI,CACR,OAAO,EACP,KAAK,IAAI,yBAAyB,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,CACvF,CAAC;IACH,CAAC;IAEM,yBAAyB,CAAC,WAA6B,EAAE,QAAiB;QAChF,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC3B,IAAI,CAAC,UAAU,EAAE,CAAC;SAClB;QACD,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,IAAI,CAAC,SAAiB,EAAE,GAAG,IAAe;QAChD,QAAQ,SAAS,EAAE;YAClB,KAAK,kBAAkB,CAAC,CAAC;gBACxB,MAAM,cAAc,GAAG,IAAI,CAAC,CAAC,CAAa,CAAC;gBAC3C,QAAQ,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,WAAW,EAAE;oBACpE,KAAK,wBAAwB,CAAC;oBAC9B,KAAK,eAAe,CAAC,CAAC;wBACrB,MAAM,YAAY,GACjB,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,YAAY;4BAC5D,yBAAyB,CACxB,WAAW,EACX,EAAE,QAAQ,EAAE,KAAK,EAAE,EACnB,EAAE,aAAa,EAAE,CACjB,CAAC;wBACH,IAAI,CAAC,IAAI,CACR,IAAI,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,WAAW,EAC3D,YAAY,CACZ,CAAC;wBACF,MAAM;qBACN;oBACD,KAAK,0BAA0B,CAAC,CAAC;wBAChC,MAAM,UAAU,GAAe,IAAI,CAAC,yBAAyB;6BAC3D,gBAAgB,CAAC,cAAc,IAAI;4BACpC,QAAQ,EAAE,IAAI,EAAE;4BAChB,QAAQ,EAAE,IAAI;4BACd,cAAc,EAAE,EAAE;4BAClB,eAAe,EAAE,EAAE;4BACnB,cAAc,EAAE,EAAE;4BAClB,cAAc,EAAE,IAAI;4BACpB,IAAI,EAAE,cAAc,CAAC,IAAI;4BACzB,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;4BACnC,oBAAoB,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;4BAC/D,MAAM,EAAE;gCACP,UAAU,EAAE,cAAc,CAAC,EAAE;gCAC7B,MAAM,EAAE;oCACP,SAAS,CAAC,QAAQ;oCAClB,SAAS,CAAC,OAAO;oCACjB,SAAS,CAAC,YAAY;iCACtB;gCACD,QAAQ,EAAE,cAAc,CAAC,QAAQ;gCACjC,GAAG,EAAE,OAAO;gCACZ,GAAG,EAAE,EAAE;gCACP,GAAG,EAAE,EAAE;gCACP,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,IAAI;6BAChC;4BACD,iBAAiB,EAAE,cAAc,CAAC,QAAQ;4BAC1C,KAAK,EAAE,WAAW;yBAClB,CAAC;wBACF,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;wBAClD,MAAM;qBACN;oBACD,KAAK,iBAAiB,CAAC,CAAC;wBACvB,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;wBAC7B,MAAM;qBACN;oBACD,QAAQ,CAAC,QAAQ;iBACjB;gBACD,OAAO,IAAI,CAAC;aACZ;YACD,OAAO,CAAC,CAAC;gBACR,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;gBAC/B,OAAO,IAAI,CAAC;aACZ;SACD;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { IEvent } from \"@fluidframework/core-interfaces\";\nimport { IAnyDriverError } from \"@fluidframework/driver-definitions\";\nimport { createGenericNetworkError } from \"@fluidframework/driver-utils\";\nimport { IConnect, IConnected, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { pkgVersion as driverVersion } from \"../../packageVersion.js\";\nimport { IOdspSocketError } from \"../../contracts.js\";\n\nexport interface SocketMockEvents extends IEvent {\n\t(event: \"disconnect\", listener: (reason?: IAnyDriverError, details?: unknown) => void): void;\n\t(event: \"error\", listener: (error?: IAnyDriverError) => void): void;\n\t(\n\t\tevent: \"server_disconnect\",\n\t\tlistener: (socketError: IOdspSocketError, clientId?: string) => void,\n\t): void;\n}\n\nexport interface IMockSocketConnectResponse {\n\tconnect_document:\n\t\t| {\n\t\t\t\teventToEmit: \"connect_document_success\";\n\t\t\t\tconnectMessage?: IConnected;\n\t\t  }\n\t\t| {\n\t\t\t\teventToEmit: \"connect_document_error\";\n\t\t\t\terrorToThrow?: IAnyDriverError;\n\t\t  }\n\t\t| {\n\t\t\t\teventToEmit: \"connect_error\";\n\t\t\t\terrorToThrow?: IAnyDriverError;\n\t\t  }\n\t\t| {\n\t\t\t\teventToEmit: \"connect_timeout\";\n\t\t  };\n}\n\n/**\n * Class to mock the client socket connection. It can intercepts the events made on the socket\n * and then do its custom logic and can also send events to the client back.\n */\nexport class ClientSocketMock extends TypedEventEmitter<SocketMockEvents> {\n\tpublic disconnected = false;\n\tconstructor(\n\t\tprivate readonly mockSocketConnectResponse: IMockSocketConnectResponse = {\n\t\t\tconnect_document: { eventToEmit: \"connect_document_success\" },\n\t\t},\n\t) {\n\t\tsuper();\n\t}\n\n\tpublic get connected(): boolean {\n\t\treturn !this.disconnected;\n\t}\n\n\tpublic close(): void {\n\t\tthis.disconnect();\n\t}\n\n\tpublic disconnect(): void {\n\t\tthis.disconnected = true;\n\t}\n\n\tpublic get io(): {\n\t\treconnection: () => boolean;\n\t\treconnectionAttempts: () => number;\n\t} {\n\t\treturn {\n\t\t\treconnection: () => false,\n\t\t\treconnectionAttempts: () => 0,\n\t\t};\n\t}\n\n\tpublic sendDisconnectEvent(\n\t\treason?: IAnyDriverError,\n\t\tdetails?: { context: { type?: string; code?: number } },\n\t): void {\n\t\tconst error =\n\t\t\treason ??\n\t\t\tcreateGenericNetworkError(\"TestError\", { canRetry: false }, { driverVersion });\n\t\tthis.emit(\"disconnect\", error, details);\n\t}\n\n\tpublic sendErrorEvent(error?: IAnyDriverError): void {\n\t\tthis.emit(\n\t\t\t\"error\",\n\t\t\terror ?? createGenericNetworkError(\"TestError\", { canRetry: false }, { driverVersion }),\n\t\t);\n\t}\n\n\tpublic sendServerDisconnectEvent(socketError: IOdspSocketError, clientId?: string): void {\n\t\tif (clientId === undefined) {\n\t\t\tthis.disconnect();\n\t\t}\n\t\tthis.emit(\"server_disconnect\", socketError, clientId);\n\t}\n\n\tpublic emit(eventName: string, ...args: unknown[]): boolean {\n\t\tswitch (eventName) {\n\t\t\tcase \"connect_document\": {\n\t\t\t\tconst connectMessage = args[0] as IConnect;\n\t\t\t\tswitch (this.mockSocketConnectResponse.connect_document.eventToEmit) {\n\t\t\t\t\tcase \"connect_document_error\":\n\t\t\t\t\tcase \"connect_error\": {\n\t\t\t\t\t\tconst errorToThrow =\n\t\t\t\t\t\t\tthis.mockSocketConnectResponse.connect_document.errorToThrow ??\n\t\t\t\t\t\t\tcreateGenericNetworkError(\n\t\t\t\t\t\t\t\t\"TestError\",\n\t\t\t\t\t\t\t\t{ canRetry: false },\n\t\t\t\t\t\t\t\t{ driverVersion },\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\tthis.emit(\n\t\t\t\t\t\t\tthis.mockSocketConnectResponse.connect_document.eventToEmit,\n\t\t\t\t\t\t\terrorToThrow,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tcase \"connect_document_success\": {\n\t\t\t\t\t\tconst iConnected: IConnected = this.mockSocketConnectResponse\n\t\t\t\t\t\t\t.connect_document.connectMessage ?? {\n\t\t\t\t\t\t\tclientId: uuid(),\n\t\t\t\t\t\t\texisting: true,\n\t\t\t\t\t\t\tinitialClients: [],\n\t\t\t\t\t\t\tinitialMessages: [],\n\t\t\t\t\t\t\tinitialSignals: [],\n\t\t\t\t\t\t\tmaxMessageSize: 1000,\n\t\t\t\t\t\t\tmode: connectMessage.mode,\n\t\t\t\t\t\t\tversion: connectMessage.versions[0],\n\t\t\t\t\t\t\tserviceConfiguration: { maxMessageSize: 1000, blockSize: 1000 },\n\t\t\t\t\t\t\tclaims: {\n\t\t\t\t\t\t\t\tdocumentId: connectMessage.id,\n\t\t\t\t\t\t\t\tscopes: [\n\t\t\t\t\t\t\t\t\tScopeType.DocWrite,\n\t\t\t\t\t\t\t\t\tScopeType.DocRead,\n\t\t\t\t\t\t\t\t\tScopeType.SummaryWrite,\n\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\ttenantId: connectMessage.tenantId,\n\t\t\t\t\t\t\t\tver: \"1.0.0\",\n\t\t\t\t\t\t\t\tiat: 10,\n\t\t\t\t\t\t\t\texp: 10,\n\t\t\t\t\t\t\t\tuser: connectMessage.client.user,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tsupportedVersions: connectMessage.versions,\n\t\t\t\t\t\t\tepoch: \"testEpoch\",\n\t\t\t\t\t\t};\n\t\t\t\t\t\tthis.emit(\"connect_document_success\", iConnected);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tcase \"connect_timeout\": {\n\t\t\t\t\t\tthis.emit(\"connect_timeout\");\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tdefault: // No-op\n\t\t\t\t}\n\t\t\t\treturn true;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tsuper.emit(eventName, ...args);\n\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\t}\n}\n"]}