@fluid-internal/presence-runtime 2.93.0

package/lib/states/test/schemaValidation/protocol.spec.js

@@ -0,0 +1,244 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { EventAndErrorTrackingLogger } from "@fluidframework/test-utils/internal";
+import { describe, it, after, afterEach, before, beforeEach } from "mocha";
+import { useFakeTimers } from "sinon";
+import { broadcastJoinResponseDelaysMs } from "@fluid-internal/presence-runtime/internal/test";
+import { StateFactory } from "@fluid-internal/presence-runtime/states";
+import { toOpaqueJson } from "@fluid-internal/presence-runtime/utils";
+import { MockEphemeralRuntime } from "../mockEphemeralRuntime.js";
+import { assertFinalExpectations, attendeeId1, localAttendeeId, connectionId1, initialLocalClientConnectionId, createSpecificAttendeeId, createSpiedValidator, generateBasicClientJoin, prepareConnectedPresence, } from "../testUtils.js";
+describe("Presence/States", () => {
+    describe("Runtime schema validation", () => {
+        const afterCleanUp = [];
+        const initialTime = 500;
+        const attendee1ValueRevisionTimestamp = 600;
+        const testStartTime = 1010;
+        let localAttendee1ValueRevisionTimestamp;
+        let clock;
+        let logger;
+        let presence;
+        let processSignal;
+        let runtime;
+        before(async () => {
+            clock = useFakeTimers();
+        });
+        beforeEach(() => {
+            logger = new EventAndErrorTrackingLogger();
+            runtime = new MockEphemeralRuntime(logger);
+            clock.setSystemTime(initialTime);
+            let localAvgLatency;
+            ({ presence, processSignal, localAvgLatency } = prepareConnectedPresence(runtime, localAttendeeId, initialLocalClientConnectionId, clock, logger));
+            // Note that while the initialTime was set to 500, the prepareConnectedPresence call advances
+            // it. Set a consistent start time for all tests.
+            const deltaToStart = testStartTime - clock.now;
+            assert(deltaToStart >= 10);
+            clock.tick(deltaToStart - 10);
+            // Process remote client update signal (attendeeId-1 is then part of local client's known session).
+            const attendee1UpdateSendTimestamp = deltaToStart - 20;
+            const attendee1AvgLatency = 20;
+            const attendee1ToLocalTimeDelta = clock.now - (localAvgLatency + attendee1AvgLatency + attendee1UpdateSendTimestamp);
+            localAttendee1ValueRevisionTimestamp =
+                attendee1ValueRevisionTimestamp + attendee1ToLocalTimeDelta;
+            processSignal([], {
+                type: "Pres:DatastoreUpdate",
+                content: {
+                    sendTimestamp: attendee1UpdateSendTimestamp,
+                    avgLatency: attendee1AvgLatency,
+                    data: {
+                        "system:presence": {
+                            "clientToSessionId": {
+                                "client1": {
+                                    "rev": 0,
+                                    "timestamp": initialTime + 40,
+                                    "value": attendeeId1,
+                                },
+                            },
+                        },
+                        "s:name:testWorkspace": {
+                            "latest": {
+                                [attendeeId1]: {
+                                    "rev": 1,
+                                    "timestamp": attendee1ValueRevisionTimestamp,
+                                    "value": toOpaqueJson({ x: 1, y: 1, z: 1 }),
+                                },
+                            },
+                            "latestMap": {
+                                [attendeeId1]: {
+                                    "rev": 1,
+                                    "items": {
+                                        "key1": {
+                                            "rev": 1,
+                                            "timestamp": attendee1ValueRevisionTimestamp,
+                                            "value": toOpaqueJson({ a: 1, b: 1 }),
+                                        },
+                                        "key2": {
+                                            "rev": 1,
+                                            "timestamp": attendee1ValueRevisionTimestamp,
+                                            // out of schema value
+                                            "value": toOpaqueJson({ b: 1, d: 1 }),
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+                clientId: "client1",
+            }, false);
+            // Pass a little time (to mimic reality)
+            clock.tick(10);
+        });
+        afterEach(function (done) {
+            clock.reset();
+            // If the test passed so far, check final expectations.
+            if (this.currentTest?.state === "passed") {
+                assertFinalExpectations(runtime, logger);
+            }
+            for (const cleanUp of afterCleanUp) {
+                cleanUp();
+            }
+            afterCleanUp.length = 0;
+            done();
+        });
+        after(() => {
+            clock.restore();
+        });
+        describe("response to Join signal", () => {
+            it("does not contain validation metadata for remote clients", () => {
+                // Setup
+                // Check Join response without active validators
+                const attendeeId4 = createSpecificAttendeeId("attendeeId-4");
+                const connectionId4 = "client4";
+                const client4JoinTime = clock.now - 50;
+                const newAttendeeSignal = generateBasicClientJoin(client4JoinTime, {
+                    averageLatency: 50,
+                    attendeeId: attendeeId4,
+                    clientConnectionId: connectionId4,
+                    updateProviders: [initialLocalClientConnectionId],
+                });
+                const expectedSetupJoinResponse = {
+                    type: "Pres:DatastoreUpdate",
+                    content: {
+                        "avgLatency": 10,
+                        "data": {
+                            "system:presence": {
+                                "clientToSessionId": {
+                                    [initialLocalClientConnectionId]: {
+                                        "rev": 0,
+                                        "timestamp": initialTime,
+                                        "value": localAttendeeId,
+                                    },
+                                    [connectionId1]: {
+                                        "rev": 0,
+                                        "timestamp": initialTime + 40,
+                                        "value": attendeeId1,
+                                    },
+                                    [connectionId4]: {
+                                        "rev": 0,
+                                        "timestamp": client4JoinTime,
+                                        "value": attendeeId4,
+                                    },
+                                },
+                            },
+                            "s:name:testWorkspace": {
+                                "latest": {
+                                    [attendeeId1]: {
+                                        "rev": 1,
+                                        "timestamp": localAttendee1ValueRevisionTimestamp,
+                                        "value": toOpaqueJson({ x: 1, y: 1, z: 1 }),
+                                    },
+                                },
+                                "latestMap": {
+                                    [attendeeId1]: {
+                                        "rev": 1,
+                                        "items": {
+                                            "key1": {
+                                                "rev": 1,
+                                                "timestamp": localAttendee1ValueRevisionTimestamp,
+                                                "value": toOpaqueJson({ a: 1, b: 1 }),
+                                            },
+                                            "key2": {
+                                                "rev": 1,
+                                                "timestamp": localAttendee1ValueRevisionTimestamp,
+                                                "value": toOpaqueJson({ b: 1, d: 1 }),
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                        "isComplete": true,
+                        "joinResponseFor": [connectionId4],
+                        "sendTimestamp": clock.now + broadcastJoinResponseDelaysMs.namedResponder,
+                    },
+                };
+                {
+                    runtime.signalsExpected.push([expectedSetupJoinResponse]);
+                    processSignal([], newAttendeeSignal, false);
+                    clock.tick(broadcastJoinResponseDelaysMs.namedResponder);
+                }
+                // Pass a little time (to distinguish between signals)
+                clock.tick(10);
+                // Create State objects with validators
+                const workspaceSetupTime = clock.now;
+                const point3DValidatorFunction = createSpiedValidator((d) => {
+                    return typeof d === "object" ? d : undefined;
+                });
+                const statesWorkspace = presence.states.getWorkspace("name:testWorkspace", {
+                    latest: StateFactory.latest({
+                        local: { x: 0, y: 0, z: 0 },
+                        validator: point3DValidatorFunction,
+                        settings: {
+                            // To prevent sending messages ahead of full broadcast from
+                            // join below, set the allowable latency to twice expected
+                            // join response time.
+                            allowableUpdateLatencyMs: 2 * broadcastJoinResponseDelaysMs.namedResponder,
+                        },
+                    }),
+                });
+                const latest = statesWorkspace.states.latest;
+                const attendee1 = presence.attendees.getAttendee(attendeeId1);
+                latest.getRemote(attendee1)?.value();
+                const originalJoinResponseData = expectedSetupJoinResponse.content.data;
+                const expectedJoinResponse = {
+                    type: "Pres:DatastoreUpdate",
+                    content: {
+                        "avgLatency": 10,
+                        "data": {
+                            "system:presence": {
+                                "clientToSessionId": {
+                                    ...originalJoinResponseData["system:presence"].clientToSessionId,
+                                },
+                            },
+                            "s:name:testWorkspace": {
+                                "latest": {
+                                    ...originalJoinResponseData["s:name:testWorkspace"].latest,
+                                    [localAttendeeId]: {
+                                        "rev": 0,
+                                        "timestamp": workspaceSetupTime,
+                                        "value": toOpaqueJson({ x: 0, y: 0, z: 0 }),
+                                    },
+                                },
+                                "latestMap": {
+                                    ...originalJoinResponseData["s:name:testWorkspace"].latestMap,
+                                },
+                            },
+                        },
+                        "isComplete": true,
+                        "joinResponseFor": [connectionId4],
+                        "sendTimestamp": clock.now + broadcastJoinResponseDelaysMs.namedResponder,
+                    },
+                };
+                runtime.signalsExpected.push([expectedJoinResponse]);
+                // Act & Verify - resend new attendee Join signal
+                processSignal([], newAttendeeSignal, false);
+                clock.tick(broadcastJoinResponseDelaysMs.namedResponder);
+            });
+        });
+    });
+});
+//# sourceMappingURL=protocol.spec.js.map

package/lib/states/test/schemaValidation/protocol.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.spec.js","sourceRoot":"","sources":["../../../../src/states/test/schemaValidation/protocol.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAwB,MAAM,OAAO,CAAC;AAG5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gDAAgD,CAAC;AAC/F,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,EACN,uBAAuB,EACvB,WAAW,EACX,eAAe,EACf,aAAa,EACb,8BAA8B,EAC9B,wBAAwB,EACxB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,GACxB,MAAM,iBAAiB,CAAC;AAWzB,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAChC,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QAC1C,MAAM,YAAY,GAAmB,EAAE,CAAC;QACxC,MAAM,WAAW,GAAG,GAAG,CAAC;QACxB,MAAM,+BAA+B,GAAG,GAAG,CAAC;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC;QAC3B,IAAI,oCAA4C,CAAC;QAEjD,IAAI,KAAsB,CAAC;QAC3B,IAAI,MAAmC,CAAC;QACxC,IAAI,QAAmC,CAAC;QACxC,IAAI,aAAoC,CAAC;QACzC,IAAI,OAA6B,CAAC;QAElC,MAAM,CAAC,KAAK,IAAI,EAAE;YACjB,KAAK,GAAG,aAAa,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,GAAG,EAAE;YACf,MAAM,GAAG,IAAI,2BAA2B,EAAE,CAAC;YAC3C,OAAO,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAC3C,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAEjC,IAAI,eAAuB,CAAC;YAC5B,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,wBAAwB,CACvE,OAAO,EACP,eAAe,EACf,8BAA8B,EAC9B,KAAK,EACL,MAAM,CACN,CAAC,CAAC;YAEH,6FAA6F;YAC7F,iDAAiD;YACjD,MAAM,YAAY,GAAG,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC;YAC/C,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;YAC3B,KAAK,CAAC,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC;YAE9B,mGAAmG;YACnG,MAAM,4BAA4B,GAAG,YAAY,GAAG,EAAE,CAAC;YACvD,MAAM,mBAAmB,GAAG,EAAE,CAAC;YAC/B,MAAM,yBAAyB,GAC9B,KAAK,CAAC,GAAG,GAAG,CAAC,eAAe,GAAG,mBAAmB,GAAG,4BAA4B,CAAC,CAAC;YACpF,oCAAoC;gBACnC,+BAA+B,GAAG,yBAAyB,CAAC;YAC7D,aAAa,CACZ,EAAE,EACF;gBACC,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE;oBACR,aAAa,EAAE,4BAA4B;oBAC3C,UAAU,EAAE,mBAAmB;oBAC/B,IAAI,EAAE;wBACL,iBAAiB,EAAE;4BAClB,mBAAmB,EAAE;gCACpB,SAAS,EAAE;oCACV,KAAK,EAAE,CAAC;oCACR,WAAW,EAAE,WAAW,GAAG,EAAE;oCAC7B,OAAO,EAAE,WAAW;iCACpB;6BACD;yBACD;wBACD,sBAAsB,EAAE;4BACvB,QAAQ,EAAE;gCACT,CAAC,WAAW,CAAC,EAAE;oCACd,KAAK,EAAE,CAAC;oCACR,WAAW,EAAE,+BAA+B;oCAC5C,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;iCAC3C;6BACD;4BACD,WAAW,EAAE;gCACZ,CAAC,WAAW,CAAC,EAAE;oCACd,KAAK,EAAE,CAAC;oCACR,OAAO,EAAE;wCACR,MAAM,EAAE;4CACP,KAAK,EAAE,CAAC;4CACR,WAAW,EAAE,+BAA+B;4CAC5C,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;yCACrC;wCACD,MAAM,EAAE;4CACP,KAAK,EAAE,CAAC;4CACR,WAAW,EAAE,+BAA+B;4CAC5C,sBAAsB;4CACtB,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;yCACrC;qCACD;iCACD;6BACD;yBACD;qBACD;iBACD;gBACD,QAAQ,EAAE,SAAS;aACnB,EACD,KAAK,CACL,CAAC;YAEF,wCAAwC;YACxC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,UAAU,IAAgB;YACnC,KAAK,CAAC,KAAK,EAAE,CAAC;YAEd,uDAAuD;YACvD,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC1C,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC;YAED,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;gBACpC,OAAO,EAAE,CAAC;YACX,CAAC;YACD,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;YACxB,IAAI,EAAE,CAAC;QACR,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,GAAG,EAAE;YACV,KAAK,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACxC,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;gBAClE,QAAQ;gBAER,gDAAgD;gBAChD,MAAM,WAAW,GAAG,wBAAwB,CAAC,cAAc,CAAC,CAAC;gBAC7D,MAAM,aAAa,GAAG,SAAS,CAAC;gBAChC,MAAM,eAAe,GAAG,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC;gBACvC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,eAAe,EAAE;oBAClE,cAAc,EAAE,EAAE;oBAClB,UAAU,EAAE,WAAW;oBACvB,kBAAkB,EAAE,aAAa;oBACjC,eAAe,EAAE,CAAC,8BAA8B,CAAC;iBACjD,CAAC,CAAC;gBACH,MAAM,yBAAyB,GAAG;oBACjC,IAAI,EAAE,sBAAsB;oBAC5B,OAAO,EAAE;wBACR,YAAY,EAAE,EAAE;wBAChB,MAAM,EAAE;4BACP,iBAAiB,EAAE;gCAClB,mBAAmB,EAAE;oCACpB,CAAC,8BAA8B,CAAC,EAAE;wCACjC,KAAK,EAAE,CAAC;wCACR,WAAW,EAAE,WAAW;wCACxB,OAAO,EAAE,eAAe;qCACxB;oCACD,CAAC,aAAa,CAAC,EAAE;wCAChB,KAAK,EAAE,CAAC;wCACR,WAAW,EAAE,WAAW,GAAG,EAAE;wCAC7B,OAAO,EAAE,WAAW;qCACpB;oCACD,CAAC,aAAa,CAAC,EAAE;wCAChB,KAAK,EAAE,CAAC;wCACR,WAAW,EAAE,eAAe;wCAC5B,OAAO,EAAE,WAAW;qCACpB;iCACD;6BACD;4BACD,sBAAsB,EAAE;gCACvB,QAAQ,EAAE;oCACT,CAAC,WAAW,CAAC,EAAE;wCACd,KAAK,EAAE,CAAC;wCACR,WAAW,EAAE,oCAAoC;wCACjD,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;qCAC3C;iCACD;gCACD,WAAW,EAAE;oCACZ,CAAC,WAAW,CAAC,EAAE;wCACd,KAAK,EAAE,CAAC;wCACR,OAAO,EAAE;4CACR,MAAM,EAAE;gDACP,KAAK,EAAE,CAAC;gDACR,WAAW,EAAE,oCAAoC;gDACjD,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;6CACrC;4CACD,MAAM,EAAE;gDACP,KAAK,EAAE,CAAC;gDACR,WAAW,EAAE,oCAAoC;gDACjD,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;6CACrC;yCACD;qCACD;iCACD;6BACD;yBACD;wBACD,YAAY,EAAE,IAAI;wBAClB,iBAAiB,EAAE,CAAC,aAAa,CAAC;wBAClC,eAAe,EAAE,KAAK,CAAC,GAAG,GAAG,6BAA6B,CAAC,cAAc;qBACzE;iBACiD,CAAC;gBACpD,CAAC;oBACA,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC;oBAC1D,aAAa,CAAC,EAAE,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC;oBAC5C,KAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,cAAc,CAAC,CAAC;gBAC1D,CAAC;gBACD,sDAAsD;gBACtD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAEf,uCAAuC;gBACvC,MAAM,kBAAkB,GAAG,KAAK,CAAC,GAAG,CAAC;gBACrC,MAAM,wBAAwB,GAAG,oBAAoB,CAAU,CAAC,CAAU,EAAE,EAAE;oBAC7E,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAE,CAAa,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC3D,CAAC,CAAC,CAAC;gBACH,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,oBAAoB,EAAE;oBAC1E,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC;wBAC3B,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;wBAC3B,SAAS,EAAE,wBAAwB;wBACnC,QAAQ,EAAE;4BACT,2DAA2D;4BAC3D,0DAA0D;4BAC1D,sBAAsB;4BACtB,wBAAwB,EAAE,CAAC,GAAG,6BAA6B,CAAC,cAAc;yBAC1E;qBACD,CAAC;iBACF,CAAC,CAAC;gBACH,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC7C,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;gBAE9D,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;gBAErC,MAAM,wBAAwB,GAAG,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC;gBACxE,MAAM,oBAAoB,GAAG;oBAC5B,IAAI,EAAE,sBAAsB;oBAC5B,OAAO,EAAE;wBACR,YAAY,EAAE,EAAE;wBAChB,MAAM,EAAE;4BACP,iBAAiB,EAAE;gCAClB,mBAAmB,EAAE;oCACpB,GAAG,wBAAwB,CAAC,iBAAiB,CAAC,CAAC,iBAAiB;iCAChE;6BACD;4BACD,sBAAsB,EAAE;gCACvB,QAAQ,EAAE;oCACT,GAAG,wBAAwB,CAAC,sBAAsB,CAAC,CAAC,MAAM;oCAC1D,CAAC,eAAe,CAAC,EAAE;wCAClB,KAAK,EAAE,CAAC;wCACR,WAAW,EAAE,kBAAkB;wCAC/B,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;qCAC3C;iCACD;gCACD,WAAW,EAAE;oCACZ,GAAG,wBAAwB,CAAC,sBAAsB,CAAC,CAAC,SAAS;iCAC7D;6BACD;yBACD;wBACD,YAAY,EAAE,IAAI;wBAClB,iBAAiB,EAAE,CAAC,aAAa,CAAC;wBAClC,eAAe,EAAE,KAAK,CAAC,GAAG,GAAG,6BAA6B,CAAC,cAAc;qBACzE;iBACiD,CAAC;gBACpD,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAErD,iDAAiD;gBACjD,aAAa,CAAC,EAAE,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC;gBAC5C,KAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,cAAc,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\n\nimport type { PresenceWithNotifications } from \"@fluid-internal/presence-definitions\";\nimport { EventAndErrorTrackingLogger } from \"@fluidframework/test-utils/internal\";\nimport { describe, it, after, afterEach, before, beforeEach } from \"mocha\";\nimport { useFakeTimers, type SinonFakeTimers } from \"sinon\";\n\nimport type { OutboundDatastoreUpdateMessage } from \"@fluid-internal/presence-runtime/internal/test\";\nimport { broadcastJoinResponseDelaysMs } from \"@fluid-internal/presence-runtime/internal/test\";\nimport { StateFactory } from \"@fluid-internal/presence-runtime/states\";\nimport { toOpaqueJson } from \"@fluid-internal/presence-runtime/utils\";\n\nimport { MockEphemeralRuntime } from \"../mockEphemeralRuntime.js\";\nimport type { ProcessSignalFunction } from \"../testUtils.js\";\nimport {\n\tassertFinalExpectations,\n\tattendeeId1,\n\tlocalAttendeeId,\n\tconnectionId1,\n\tinitialLocalClientConnectionId,\n\tcreateSpecificAttendeeId,\n\tcreateSpiedValidator,\n\tgenerateBasicClientJoin,\n\tprepareConnectedPresence,\n} from \"../testUtils.js\";\n\n/**\n * Workspace updates\n */\ninterface Point3D {\n\tx: number;\n\ty: number;\n\tz: number;\n}\n\ndescribe(\"Presence/States\", () => {\n\tdescribe(\"Runtime schema validation\", () => {\n\t\tconst afterCleanUp: (() => void)[] = [];\n\t\tconst initialTime = 500;\n\t\tconst attendee1ValueRevisionTimestamp = 600;\n\t\tconst testStartTime = 1010;\n\t\tlet localAttendee1ValueRevisionTimestamp: number;\n\n\t\tlet clock: SinonFakeTimers;\n\t\tlet logger: EventAndErrorTrackingLogger;\n\t\tlet presence: PresenceWithNotifications;\n\t\tlet processSignal: ProcessSignalFunction;\n\t\tlet runtime: MockEphemeralRuntime;\n\n\t\tbefore(async () => {\n\t\t\tclock = useFakeTimers();\n\t\t});\n\n\t\tbeforeEach(() => {\n\t\t\tlogger = new EventAndErrorTrackingLogger();\n\t\t\truntime = new MockEphemeralRuntime(logger);\n\t\t\tclock.setSystemTime(initialTime);\n\n\t\t\tlet localAvgLatency: number;\n\t\t\t({ presence, processSignal, localAvgLatency } = prepareConnectedPresence(\n\t\t\t\truntime,\n\t\t\t\tlocalAttendeeId,\n\t\t\t\tinitialLocalClientConnectionId,\n\t\t\t\tclock,\n\t\t\t\tlogger,\n\t\t\t));\n\n\t\t\t// Note that while the initialTime was set to 500, the prepareConnectedPresence call advances\n\t\t\t// it. Set a consistent start time for all tests.\n\t\t\tconst deltaToStart = testStartTime - clock.now;\n\t\t\tassert(deltaToStart >= 10);\n\t\t\tclock.tick(deltaToStart - 10);\n\n\t\t\t// Process remote client update signal (attendeeId-1 is then part of local client's known session).\n\t\t\tconst attendee1UpdateSendTimestamp = deltaToStart - 20;\n\t\t\tconst attendee1AvgLatency = 20;\n\t\t\tconst attendee1ToLocalTimeDelta =\n\t\t\t\tclock.now - (localAvgLatency + attendee1AvgLatency + attendee1UpdateSendTimestamp);\n\t\t\tlocalAttendee1ValueRevisionTimestamp =\n\t\t\t\tattendee1ValueRevisionTimestamp + attendee1ToLocalTimeDelta;\n\t\t\tprocessSignal(\n\t\t\t\t[],\n\t\t\t\t{\n\t\t\t\t\ttype: \"Pres:DatastoreUpdate\",\n\t\t\t\t\tcontent: {\n\t\t\t\t\t\tsendTimestamp: attendee1UpdateSendTimestamp,\n\t\t\t\t\t\tavgLatency: attendee1AvgLatency,\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\t\"system:presence\": {\n\t\t\t\t\t\t\t\t\"clientToSessionId\": {\n\t\t\t\t\t\t\t\t\t\"client1\": {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 0,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": initialTime + 40,\n\t\t\t\t\t\t\t\t\t\t\"value\": attendeeId1,\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\t\"s:name:testWorkspace\": {\n\t\t\t\t\t\t\t\t\"latest\": {\n\t\t\t\t\t\t\t\t\t[attendeeId1]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": attendee1ValueRevisionTimestamp,\n\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ x: 1, y: 1, z: 1 }),\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\t\"latestMap\": {\n\t\t\t\t\t\t\t\t\t[attendeeId1]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\"items\": {\n\t\t\t\t\t\t\t\t\t\t\t\"key1\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timestamp\": attendee1ValueRevisionTimestamp,\n\t\t\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ a: 1, b: 1 }),\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"key2\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timestamp\": attendee1ValueRevisionTimestamp,\n\t\t\t\t\t\t\t\t\t\t\t\t// out of schema value\n\t\t\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ b: 1, d: 1 }),\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t},\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\tclientId: \"client1\",\n\t\t\t\t},\n\t\t\t\tfalse,\n\t\t\t);\n\n\t\t\t// Pass a little time (to mimic reality)\n\t\t\tclock.tick(10);\n\t\t});\n\n\t\tafterEach(function (done: Mocha.Done) {\n\t\t\tclock.reset();\n\n\t\t\t// If the test passed so far, check final expectations.\n\t\t\tif (this.currentTest?.state === \"passed\") {\n\t\t\t\tassertFinalExpectations(runtime, logger);\n\t\t\t}\n\n\t\t\tfor (const cleanUp of afterCleanUp) {\n\t\t\t\tcleanUp();\n\t\t\t}\n\t\t\tafterCleanUp.length = 0;\n\t\t\tdone();\n\t\t});\n\n\t\tafter(() => {\n\t\t\tclock.restore();\n\t\t});\n\n\t\tdescribe(\"response to Join signal\", () => {\n\t\t\tit(\"does not contain validation metadata for remote clients\", () => {\n\t\t\t\t// Setup\n\n\t\t\t\t// Check Join response without active validators\n\t\t\t\tconst attendeeId4 = createSpecificAttendeeId(\"attendeeId-4\");\n\t\t\t\tconst connectionId4 = \"client4\";\n\t\t\t\tconst client4JoinTime = clock.now - 50;\n\t\t\t\tconst newAttendeeSignal = generateBasicClientJoin(client4JoinTime, {\n\t\t\t\t\taverageLatency: 50,\n\t\t\t\t\tattendeeId: attendeeId4,\n\t\t\t\t\tclientConnectionId: connectionId4,\n\t\t\t\t\tupdateProviders: [initialLocalClientConnectionId],\n\t\t\t\t});\n\t\t\t\tconst expectedSetupJoinResponse = {\n\t\t\t\t\ttype: \"Pres:DatastoreUpdate\",\n\t\t\t\t\tcontent: {\n\t\t\t\t\t\t\"avgLatency\": 10,\n\t\t\t\t\t\t\"data\": {\n\t\t\t\t\t\t\t\"system:presence\": {\n\t\t\t\t\t\t\t\t\"clientToSessionId\": {\n\t\t\t\t\t\t\t\t\t[initialLocalClientConnectionId]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 0,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": initialTime,\n\t\t\t\t\t\t\t\t\t\t\"value\": localAttendeeId,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t[connectionId1]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 0,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": initialTime + 40,\n\t\t\t\t\t\t\t\t\t\t\"value\": attendeeId1,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t[connectionId4]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 0,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": client4JoinTime,\n\t\t\t\t\t\t\t\t\t\t\"value\": attendeeId4,\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\t\"s:name:testWorkspace\": {\n\t\t\t\t\t\t\t\t\"latest\": {\n\t\t\t\t\t\t\t\t\t[attendeeId1]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": localAttendee1ValueRevisionTimestamp,\n\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ x: 1, y: 1, z: 1 }),\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\t\"latestMap\": {\n\t\t\t\t\t\t\t\t\t[attendeeId1]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\"items\": {\n\t\t\t\t\t\t\t\t\t\t\t\"key1\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timestamp\": localAttendee1ValueRevisionTimestamp,\n\t\t\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ a: 1, b: 1 }),\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"key2\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"rev\": 1,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timestamp\": localAttendee1ValueRevisionTimestamp,\n\t\t\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ b: 1, d: 1 }),\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t},\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\t\"isComplete\": true,\n\t\t\t\t\t\t\"joinResponseFor\": [connectionId4],\n\t\t\t\t\t\t\"sendTimestamp\": clock.now + broadcastJoinResponseDelaysMs.namedResponder,\n\t\t\t\t\t},\n\t\t\t\t} as const satisfies OutboundDatastoreUpdateMessage;\n\t\t\t\t{\n\t\t\t\t\truntime.signalsExpected.push([expectedSetupJoinResponse]);\n\t\t\t\t\tprocessSignal([], newAttendeeSignal, false);\n\t\t\t\t\tclock.tick(broadcastJoinResponseDelaysMs.namedResponder);\n\t\t\t\t}\n\t\t\t\t// Pass a little time (to distinguish between signals)\n\t\t\t\tclock.tick(10);\n\n\t\t\t\t// Create State objects with validators\n\t\t\t\tconst workspaceSetupTime = clock.now;\n\t\t\t\tconst point3DValidatorFunction = createSpiedValidator<Point3D>((d: unknown) => {\n\t\t\t\t\treturn typeof d === \"object\" ? (d as Point3D) : undefined;\n\t\t\t\t});\n\t\t\t\tconst statesWorkspace = presence.states.getWorkspace(\"name:testWorkspace\", {\n\t\t\t\t\tlatest: StateFactory.latest({\n\t\t\t\t\t\tlocal: { x: 0, y: 0, z: 0 },\n\t\t\t\t\t\tvalidator: point3DValidatorFunction,\n\t\t\t\t\t\tsettings: {\n\t\t\t\t\t\t\t// To prevent sending messages ahead of full broadcast from\n\t\t\t\t\t\t\t// join below, set the allowable latency to twice expected\n\t\t\t\t\t\t\t// join response time.\n\t\t\t\t\t\t\tallowableUpdateLatencyMs: 2 * broadcastJoinResponseDelaysMs.namedResponder,\n\t\t\t\t\t\t},\n\t\t\t\t\t}),\n\t\t\t\t});\n\t\t\t\tconst latest = statesWorkspace.states.latest;\n\t\t\t\tconst attendee1 = presence.attendees.getAttendee(attendeeId1);\n\n\t\t\t\tlatest.getRemote(attendee1)?.value();\n\n\t\t\t\tconst originalJoinResponseData = expectedSetupJoinResponse.content.data;\n\t\t\t\tconst expectedJoinResponse = {\n\t\t\t\t\ttype: \"Pres:DatastoreUpdate\",\n\t\t\t\t\tcontent: {\n\t\t\t\t\t\t\"avgLatency\": 10,\n\t\t\t\t\t\t\"data\": {\n\t\t\t\t\t\t\t\"system:presence\": {\n\t\t\t\t\t\t\t\t\"clientToSessionId\": {\n\t\t\t\t\t\t\t\t\t...originalJoinResponseData[\"system:presence\"].clientToSessionId,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"s:name:testWorkspace\": {\n\t\t\t\t\t\t\t\t\"latest\": {\n\t\t\t\t\t\t\t\t\t...originalJoinResponseData[\"s:name:testWorkspace\"].latest,\n\t\t\t\t\t\t\t\t\t[localAttendeeId]: {\n\t\t\t\t\t\t\t\t\t\t\"rev\": 0,\n\t\t\t\t\t\t\t\t\t\t\"timestamp\": workspaceSetupTime,\n\t\t\t\t\t\t\t\t\t\t\"value\": toOpaqueJson({ x: 0, y: 0, z: 0 }),\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\t\"latestMap\": {\n\t\t\t\t\t\t\t\t\t...originalJoinResponseData[\"s:name:testWorkspace\"].latestMap,\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\t\"isComplete\": true,\n\t\t\t\t\t\t\"joinResponseFor\": [connectionId4],\n\t\t\t\t\t\t\"sendTimestamp\": clock.now + broadcastJoinResponseDelaysMs.namedResponder,\n\t\t\t\t\t},\n\t\t\t\t} as const satisfies OutboundDatastoreUpdateMessage;\n\t\t\t\truntime.signalsExpected.push([expectedJoinResponse]);\n\n\t\t\t\t// Act & Verify - resend new attendee Join signal\n\t\t\t\tprocessSignal([], newAttendeeSignal, false);\n\t\t\t\tclock.tick(broadcastJoinResponseDelaysMs.namedResponder);\n\t\t\t});\n\t\t});\n\t});\n});\n"]}