@fluid-internal/presence-runtime 2.93.0

package/dist/runtime/systemWorkspace.js

@@ -0,0 +1,264 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSystemWorkspace = void 0;
+const presence_definitions_1 = require("@fluid-internal/presence-definitions");
+const internal_1 = require("@fluidframework/core-utils/internal");
+const utils_1 = require("@fluid-internal/presence-runtime/utils");
+class SessionClient {
+    constructor(attendeeId, 
+    /**
+     * Order is used to track the most recent client connection
+     * during a session.
+     */
+    order = 0, connectionId = undefined) {
+        this.attendeeId = attendeeId;
+        this.order = order;
+        this.connectionId = connectionId;
+        this.connectionStatus = presence_definitions_1.AttendeeStatus.Disconnected;
+    }
+    getConnectionId() {
+        if (this.connectionId === undefined) {
+            throw new Error("Client has never been connected");
+        }
+        return this.connectionId;
+    }
+    getConnectionStatus() {
+        return this.connectionStatus;
+    }
+    setConnected() {
+        this.connectionStatus = presence_definitions_1.AttendeeStatus.Connected;
+    }
+    setDisconnected() {
+        this.connectionStatus = presence_definitions_1.AttendeeStatus.Disconnected;
+    }
+}
+class SystemWorkspaceImpl {
+    constructor(attendeeId, datastore, events, audience) {
+        this.datastore = datastore;
+        this.events = events;
+        this.audience = audience;
+        /**
+         * `attendees` is this client's understanding of the attendees in the
+         * session. The map covers entries for both session ids and connection
+         * ids, which are never expected to collide, but if they did for same
+         * client that would be fine.
+         * An entry is for session ID if the value's `attendeeId` matches the key.
+         */
+        this.attendees = new Map();
+        // When local client disconnects, we lose the connectivity status updates for remote attendees in the session.
+        // Upon reconnect, we mark all other attendees connections as stale and update their status to disconnected after 30 seconds of inactivity.
+        this.staleConnectionClients = new Set();
+        this.staleConnectionTimer = new utils_1.TimerManager();
+        this.selfAttendee = new SessionClient(attendeeId);
+        this.attendees.set(attendeeId, this.selfAttendee);
+    }
+    ensureContent(_content) {
+        throw new Error("Method not implemented.");
+    }
+    processUpdate(_received, _timeModifier, 
+    /**
+     * Remote datastore typed to match {@link PresenceStatesInternal.processUpdate}'s
+     * `ValueUpdateRecord` type that uses {@link InternalTypes.ValueRequiredState}
+     * and expects an Opaque JSON type. (We get away with a non-`unknown` value type
+     * per TypeScript's method parameter bivariance.) Proper type would be
+     * {@link ConnectionValueState} directly.
+     * {@link ClientConnectionId} use for index is also a deviation, but conveniently
+     * the accurate {@link AttendeeId} type is just a branded string, and
+     * {@link ClientConnectionId} is just `string`.
+     */
+    remoteDatastore, senderConnectionId) {
+        const audienceMembers = this.audience.getMembers();
+        const postUpdateActions = [];
+        for (const [clientConnectionId, value] of Object.entries((0, utils_1.revealOpaqueJson)(remoteDatastore.clientToSessionId))) {
+            const attendeeId = value.value;
+            const { attendee, isJoining } = this.ensureAttendee({
+                attendeeId,
+                clientConnectionId,
+                order: value.rev,
+                isSender: senderConnectionId === clientConnectionId,
+                isInAudience: audienceMembers.has(clientConnectionId),
+            });
+            // If the attendee is joining the session, add them to the list of joining attendees to be announced later.
+            if (isJoining) {
+                postUpdateActions.push(() => this.events.emit("attendeeConnected", attendee));
+            }
+            const knownSessionId = this.datastore.clientToSessionId[clientConnectionId];
+            if (knownSessionId === undefined) {
+                this.datastore.clientToSessionId[clientConnectionId] = value;
+            }
+            else {
+                (0, internal_1.assert)(knownSessionId.value === value.value, 0xa5a /* Mismatched SessionId */);
+            }
+        }
+        return postUpdateActions;
+    }
+    onConnectionAdded(clientConnectionId, audienceOutOfDate) {
+        (0, internal_1.assert)(this.selfAttendee.getConnectionStatus() === presence_definitions_1.AttendeeStatus.Disconnected, 0xaad /* Local client should be 'Disconnected' before adding new connection. */);
+        const selfInAudience = this.audience.getMember(clientConnectionId) !== undefined;
+        (0, internal_1.assert)(selfInAudience || audienceOutOfDate, 0xcc0 /* Local client must be in audience for presence to handle added connection. */);
+        if (!(clientConnectionId in this.datastore.clientToSessionId)) {
+            this.datastore.clientToSessionId[clientConnectionId] = {
+                rev: this.selfAttendee.order++,
+                timestamp: Date.now(),
+                value: this.selfAttendee.attendeeId,
+            };
+        }
+        // Update the self attendee connection information, but not connection
+        // status yet. Connection status is updated once self is in audience -
+        // see later. It is only once our connection is known to audience that
+        // audience can be used to track other attendees' connection statuses
+        // and we seek to present a consistent view locally.
+        this.selfAttendee.connectionId = clientConnectionId;
+        this.attendees.set(clientConnectionId, this.selfAttendee);
+        if (selfInAudience) {
+            // Mark 'Connected' remote attendees connections as stale
+            // Performance note: This will visit attendees multiple times as the
+            // attendee map has attendeeIds and connectionIds entries that point to
+            // the same attendee. But the getConnectionStatus check is cheap and
+            // staleConnectionClients.add will handle duplicates.
+            this.staleConnectionClients.clear();
+            for (const staleConnectionClient of this.attendees.values()) {
+                if (staleConnectionClient.getConnectionStatus() === presence_definitions_1.AttendeeStatus.Connected) {
+                    this.staleConnectionClients.add(staleConnectionClient);
+                }
+            }
+            this.staleConnectionTimer.setTimeout(this.resolveStaleConnections.bind(this), 30_000);
+            this.selfAttendee.setConnected();
+            this.events.emit("attendeeConnected", this.selfAttendee);
+        }
+    }
+    resolveStaleConnections() {
+        const consideredDisconnected = [];
+        for (const client of this.staleConnectionClients) {
+            // Confirm that audience no longer has connection. It is possible
+            // but unlikely that no one mentioned the attendee in this period
+            // and that they were never disconnected.
+            if (this.audience.getMember(client.getConnectionId()) === undefined) {
+                consideredDisconnected.push(client);
+                client.setDisconnected();
+            }
+        }
+        for (const client of consideredDisconnected) {
+            this.events.emit("attendeeDisconnected", client);
+        }
+        this.staleConnectionClients.clear();
+    }
+    removeClientConnectionId(clientConnectionId) {
+        const attendee = this.attendees.get(clientConnectionId);
+        if (!attendee) {
+            return;
+        }
+        // If the local connection is being removed, clear the stale connection timer
+        if (attendee === this.selfAttendee) {
+            this.staleConnectionTimer.clearTimeout();
+        }
+        else {
+            // When self is not connected, audience may go through a refresh that
+            // removes members and adds them back. Defer any removals until self
+            // is connected implying audience is stable.
+            if (this.selfAttendee.getConnectionStatus() !== presence_definitions_1.AttendeeStatus.Connected) {
+                return;
+            }
+        }
+        // If the last known connectionID is different from the connection ID being removed, the attendee has reconnected,
+        // therefore we should not change the attendee connection status or emit a disconnect event.
+        const attendeeReconnected = attendee.getConnectionId() !== clientConnectionId;
+        const connected = attendee.getConnectionStatus() === presence_definitions_1.AttendeeStatus.Connected;
+        if (!attendeeReconnected && connected) {
+            attendee.setDisconnected();
+            this.events.emit("attendeeDisconnected", attendee);
+            this.staleConnectionClients.delete(attendee);
+        }
+    }
+    getAttendees() {
+        return new Set(this.attendees.values());
+    }
+    getAttendee(clientId) {
+        const attendee = this.attendees.get(clientId);
+        if (attendee) {
+            return attendee;
+        }
+        // TODO: Restore option to add attendee on demand to handle internal
+        // lookup cases that must come from internal data.
+        // There aren't any resiliency mechanisms in place to handle a missed
+        // ClientJoin right now.
+        throw new Error("Attendee not found");
+    }
+    getMyself() {
+        return this.selfAttendee;
+    }
+    /**
+     * Make sure the given client session and connection ID pair are represented
+     * in the attendee map. If not present, SessionClient is created and added
+     * to map. If present, make sure the current connection ID is updated.
+     */
+    ensureAttendee({ attendeeId, clientConnectionId, order, isSender, isInAudience, }) {
+        let attendee = this.attendees.get(attendeeId);
+        let isConnected = false;
+        let isJoining = false;
+        if (attendee === undefined) {
+            // New attendee. Create SessionClient and add session ID based
+            // entry to map.
+            attendee = new SessionClient(attendeeId, order, clientConnectionId);
+            this.attendees.set(attendeeId, attendee);
+            // If the attendee update is from the sending remote client itself
+            // OR if the attendee is present in audience,
+            // then the attendee is considered connected. (Otherwise, leave
+            // state as disconnected - default.)
+            if (isSender || isInAudience) {
+                isConnected = true;
+                attendee.setConnected();
+                isJoining = true;
+            }
+        }
+        else {
+            // Known attendee is considered connected if
+            isConnected =
+                // this information is at least up to date with current knowledge
+                order >= attendee.order &&
+                    // AND in the audience OR
+                    (isInAudience ||
+                        // not in audience, but client is the sender and has newer
+                        // info. (Assume that audience is out of date and attendee
+                        // is joining.)
+                        (isSender && order > attendee.order));
+            if (order > attendee.order) {
+                // The given association is newer than the one we have.
+                // Update the order and current connection ID.
+                attendee.order = order;
+                attendee.connectionId = clientConnectionId;
+            }
+            // Known attendee is joining the session if they are currently disconnected.
+            if (isConnected && attendee.getConnectionStatus() === presence_definitions_1.AttendeeStatus.Disconnected) {
+                attendee.setConnected();
+                isJoining = true;
+            }
+        }
+        if (isConnected) {
+            // If the attendee is connected, remove them from the stale connection set
+            this.staleConnectionClients.delete(attendee);
+        }
+        // Always update entry for the connection ID. (Okay if already set.)
+        this.attendees.set(clientConnectionId, attendee);
+        return { attendee, isJoining };
+    }
+}
+/**
+ * Instantiates the system workspace.
+ */
+function createSystemWorkspace(attendeeId, datastore, events, audience) {
+    const workspace = new SystemWorkspaceImpl(attendeeId, datastore, events, audience);
+    return {
+        workspace,
+        statesEntry: {
+            internal: workspace,
+            public: undefined,
+        },
+    };
+}
+exports.createSystemWorkspace = createSystemWorkspace;
+//# sourceMappingURL=systemWorkspace.js.map

package/dist/runtime/systemWorkspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemWorkspace.js","sourceRoot":"","sources":["../../src/runtime/systemWorkspace.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAUH,+EAAsE;AAStE,kEAA6D;AAE7D,kEAAwF;AAIxF,MAAM,aAAa;IAGlB,YACiB,UAAsB;IACtC;;;OAGG;IACI,QAAgB,CAAC,EACjB,eAA+C,SAAS;QAN/C,eAAU,GAAV,UAAU,CAAY;QAK/B,UAAK,GAAL,KAAK,CAAY;QACjB,iBAAY,GAAZ,YAAY,CAA4C;QATxD,qBAAgB,GAAmB,qCAAc,CAAC,YAAY,CAAC;IAUpE,CAAC;IAEG,eAAe;QACrB,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAEM,mBAAmB;QACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAEM,YAAY;QAClB,IAAI,CAAC,gBAAgB,GAAG,qCAAc,CAAC,SAAS,CAAC;IAClD,CAAC;IAEM,eAAe;QACrB,IAAI,CAAC,gBAAgB,GAAG,qCAAc,CAAC,YAAY,CAAC;IACrD,CAAC;CACD;AAyBD,MAAM,mBAAmB;IAiBxB,YACC,UAAsB,EACL,SAAmC,EACpC,MAA+D,EAC9D,QAAmB;QAFnB,cAAS,GAAT,SAAS,CAA0B;QACpC,WAAM,GAAN,MAAM,CAAyD;QAC9D,aAAQ,GAAR,QAAQ,CAAW;QAnBrC;;;;;;WAMG;QACc,cAAS,GAAG,IAAI,GAAG,EAAkD,CAAC;QAEvF,8GAA8G;QAC9G,2IAA2I;QAC1H,2BAAsB,GAAG,IAAI,GAAG,EAAiB,CAAC;QAElD,yBAAoB,GAAG,IAAI,oBAAY,EAAE,CAAC;QAQ1D,IAAI,CAAC,YAAY,GAAG,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAEM,aAAa,CACnB,QAA2B;QAE3B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC5C,CAAC;IAEM,aAAa,CACnB,SAAiB,EACjB,aAAqB;IACrB;;;;;;;;;OASG;IACH,eAIC,EACD,kBAAsC;QAEtC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACnD,MAAM,iBAAiB,GAAuB,EAAE,CAAC;QACjD,KAAK,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CACvD,IAAA,wBAAgB,EAAC,eAAe,CAAC,iBAAiB,CAAC,CACnD,EAAE,CAAC;YACH,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;YAC/B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;gBACnD,UAAU;gBACV,kBAAkB;gBAClB,KAAK,EAAE,KAAK,CAAC,GAAG;gBAChB,QAAQ,EAAE,kBAAkB,KAAK,kBAAkB;gBACnD,YAAY,EAAE,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC;aACrD,CAAC,CAAC;YACH,2GAA2G;YAC3G,IAAI,SAAS,EAAE,CAAC;gBACf,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC/E,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAC5E,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACP,IAAA,iBAAM,EAAC,cAAc,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAChF,CAAC;QACF,CAAC;QAED,OAAO,iBAAiB,CAAC;IAC1B,CAAC;IAEM,iBAAiB,CACvB,kBAAsC,EACtC,iBAA0B;QAE1B,IAAA,iBAAM,EACL,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,KAAK,qCAAc,CAAC,YAAY,EACvE,KAAK,CAAC,yEAAyE,CAC/E,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAAC,KAAK,SAAS,CAAC;QACjF,IAAA,iBAAM,EACL,cAAc,IAAI,iBAAiB,EACnC,KAAK,CAAC,+EAA+E,CACrF,CAAC;QAEF,IAAI,CAAC,CAAC,kBAAkB,IAAI,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,GAAG;gBACtD,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;gBAC9B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;gBACrB,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU;aACnC,CAAC;QACH,CAAC;QAED,sEAAsE;QACtE,sEAAsE;QACtE,sEAAsE;QACtE,qEAAqE;QACrE,oDAAoD;QACpD,IAAI,CAAC,YAAY,CAAC,YAAY,GAAG,kBAAkB,CAAC;QACpD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACpB,yDAAyD;YACzD,oEAAoE;YACpE,uEAAuE;YACvE,oEAAoE;YACpE,qDAAqD;YACrD,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC;YACpC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC7D,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,KAAK,qCAAc,CAAC,SAAS,EAAE,CAAC;oBAC9E,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;gBACxD,CAAC;YACF,CAAC;YAED,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;YAEtF,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1D,CAAC;IACF,CAAC;IAEO,uBAAuB;QAC9B,MAAM,sBAAsB,GAAG,EAAE,CAAC;QAClC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAClD,iEAAiE;YACjE,iEAAiE;YACjE,yCAAyC;YACzC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,KAAK,SAAS,EAAE,CAAC;gBACrE,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACpC,MAAM,CAAC,eAAe,EAAE,CAAC;YAC1B,CAAC;QACF,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,sBAAsB,EAAE,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IAEM,wBAAwB,CAAC,kBAAsC;QACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,OAAO;QACR,CAAC;QAED,6EAA6E;QAC7E,IAAI,QAAQ,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,CAAC;QAC1C,CAAC;aAAM,CAAC;YACP,qEAAqE;YACrE,oEAAoE;YACpE,4CAA4C;YAC5C,IAAI,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,KAAK,qCAAc,CAAC,SAAS,EAAE,CAAC;gBAC1E,OAAO;YACR,CAAC;QACF,CAAC;QAED,kHAAkH;QAClH,4FAA4F;QAC5F,MAAM,mBAAmB,GAAG,QAAQ,CAAC,eAAe,EAAE,KAAK,kBAAkB,CAAC;QAC9E,MAAM,SAAS,GAAG,QAAQ,CAAC,mBAAmB,EAAE,KAAK,qCAAc,CAAC,SAAS,CAAC;QAC9E,IAAI,CAAC,mBAAmB,IAAI,SAAS,EAAE,CAAC;YACvC,QAAQ,CAAC,eAAe,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;YACnD,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;IAEM,YAAY;QAClB,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAEM,WAAW,CAAC,QAAyC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,QAAQ,EAAE,CAAC;YACd,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,oEAAoE;QACpE,kDAAkD;QAClD,qEAAqE;QACrE,wBAAwB;QACxB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACvC,CAAC;IAEM,SAAS;QACf,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,EACtB,UAAU,EACV,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,YAAY,GAOZ;QACA,IAAI,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC5B,8DAA8D;YAC9D,gBAAgB;YAChB,QAAQ,GAAG,IAAI,aAAa,CAAC,UAAU,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YACzC,kEAAkE;YAClE,6CAA6C;YAC7C,+DAA+D;YAC/D,oCAAoC;YACpC,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;gBAC9B,WAAW,GAAG,IAAI,CAAC;gBACnB,QAAQ,CAAC,YAAY,EAAE,CAAC;gBACxB,SAAS,GAAG,IAAI,CAAC;YAClB,CAAC;QACF,CAAC;aAAM,CAAC;YACP,4CAA4C;YAC5C,WAAW;gBACV,iEAAiE;gBACjE,KAAK,IAAI,QAAQ,CAAC,KAAK;oBACvB,yBAAyB;oBACzB,CAAC,YAAY;wBACZ,0DAA0D;wBAC1D,0DAA0D;wBAC1D,eAAe;wBACf,CAAC,QAAQ,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;YAExC,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC5B,uDAAuD;gBACvD,8CAA8C;gBAC9C,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;gBACvB,QAAQ,CAAC,YAAY,GAAG,kBAAkB,CAAC;YAC5C,CAAC;YAED,4EAA4E;YAC5E,IAAI,WAAW,IAAI,QAAQ,CAAC,mBAAmB,EAAE,KAAK,qCAAc,CAAC,YAAY,EAAE,CAAC;gBACnF,QAAQ,CAAC,YAAY,EAAE,CAAC;gBACxB,SAAS,GAAG,IAAI,CAAC;YAClB,CAAC;QACF,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YACjB,0EAA0E;YAC1E,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAChC,CAAC;CACD;AAED;;GAEG;AACH,SAAgB,qBAAqB,CACpC,UAAsB,EACtB,SAAmC,EACnC,MAA+D,EAC/D,QAAmB;IAQnB,MAAM,SAAS,GAAG,IAAI,mBAAmB,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnF,OAAO;QACN,SAAS;QACT,WAAW,EAAE;YACZ,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAA2D;SACnE;KACD,CAAC;AACH,CAAC;AApBD,sDAoBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tAttendee,\n\tAttendeeId,\n\tAttendeesEvents,\n\tClientConnectionId,\n\tPresence,\n\tStatesWorkspaceSchema,\n} from \"@fluid-internal/presence-definitions\";\nimport { AttendeeStatus } from \"@fluid-internal/presence-definitions\";\nimport type {\n\tAnyWorkspace,\n\tInternalTypes,\n\tPostUpdateAction,\n} from \"@fluid-internal/presence-definitions/internal\";\nimport type { PresenceStatesInternal } from \"@fluid-internal/presence-definitions/internal/workspace-runtime\";\nimport type { IAudience } from \"@fluidframework/container-definitions\";\nimport type { IEmitter, Listenable } from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport { revealOpaqueJson, TimerManager } from \"@fluid-internal/presence-runtime/utils\";\n\nimport type { SystemWorkspaceDatastore } from \"./protocol.js\";\n\nclass SessionClient implements Attendee {\n\tprivate connectionStatus: AttendeeStatus = AttendeeStatus.Disconnected;\n\n\tpublic constructor(\n\t\tpublic readonly attendeeId: AttendeeId,\n\t\t/**\n\t\t * Order is used to track the most recent client connection\n\t\t * during a session.\n\t\t */\n\t\tpublic order: number = 0,\n\t\tpublic connectionId: ClientConnectionId | undefined = undefined,\n\t) {}\n\n\tpublic getConnectionId(): ClientConnectionId {\n\t\tif (this.connectionId === undefined) {\n\t\t\tthrow new Error(\"Client has never been connected\");\n\t\t}\n\t\treturn this.connectionId;\n\t}\n\n\tpublic getConnectionStatus(): AttendeeStatus {\n\t\treturn this.connectionStatus;\n\t}\n\n\tpublic setConnected(): void {\n\t\tthis.connectionStatus = AttendeeStatus.Connected;\n\t}\n\n\tpublic setDisconnected(): void {\n\t\tthis.connectionStatus = AttendeeStatus.Disconnected;\n\t}\n}\n\n/**\n * Internal workspace that manages metadata for session attendees.\n */\nexport interface SystemWorkspace\n\t// Portion of Presence that is handled by SystemWorkspace along with\n\t// responsibility for emitting \"attendeeConnected\" events.\n\textends Exclude<Presence[\"attendees\"], never> {\n\t/**\n\t * Must be called when the current client acquires a new connection.\n\t *\n\t * @param clientConnectionId - The new client connection ID.\n\t * @param audienceOutOfDate - When true, audience cannot be used as authoritative.\n\t */\n\tonConnectionAdded(clientConnectionId: ClientConnectionId, audienceOutOfDate: boolean): void;\n\n\t/**\n\t * Removes the client connection ID from the system workspace.\n\t *\n\t * @param clientConnectionId - The client connection ID to remove.\n\t */\n\tremoveClientConnectionId(clientConnectionId: ClientConnectionId): void;\n}\n\nclass SystemWorkspaceImpl implements PresenceStatesInternal, SystemWorkspace {\n\tprivate readonly selfAttendee: SessionClient;\n\t/**\n\t * `attendees` is this client's understanding of the attendees in the\n\t * session. The map covers entries for both session ids and connection\n\t * ids, which are never expected to collide, but if they did for same\n\t * client that would be fine.\n\t * An entry is for session ID if the value's `attendeeId` matches the key.\n\t */\n\tprivate readonly attendees = new Map<ClientConnectionId | AttendeeId, SessionClient>();\n\n\t// When local client disconnects, we lose the connectivity status updates for remote attendees in the session.\n\t// Upon reconnect, we mark all other attendees connections as stale and update their status to disconnected after 30 seconds of inactivity.\n\tprivate readonly staleConnectionClients = new Set<SessionClient>();\n\n\tprivate readonly staleConnectionTimer = new TimerManager();\n\n\tpublic constructor(\n\t\tattendeeId: AttendeeId,\n\t\tprivate readonly datastore: SystemWorkspaceDatastore,\n\t\tpublic readonly events: Listenable<AttendeesEvents> & IEmitter<AttendeesEvents>,\n\t\tprivate readonly audience: IAudience,\n\t) {\n\t\tthis.selfAttendee = new SessionClient(attendeeId);\n\t\tthis.attendees.set(attendeeId, this.selfAttendee);\n\t}\n\n\tpublic ensureContent<TSchemaAdditional extends StatesWorkspaceSchema>(\n\t\t_content: TSchemaAdditional,\n\t): never {\n\t\tthrow new Error(\"Method not implemented.\");\n\t}\n\n\tpublic processUpdate(\n\t\t_received: number,\n\t\t_timeModifier: number,\n\t\t/**\n\t\t * Remote datastore typed to match {@link PresenceStatesInternal.processUpdate}'s\n\t\t * `ValueUpdateRecord` type that uses {@link InternalTypes.ValueRequiredState}\n\t\t * and expects an Opaque JSON type. (We get away with a non-`unknown` value type\n\t\t * per TypeScript's method parameter bivariance.) Proper type would be\n\t\t * {@link ConnectionValueState} directly.\n\t\t * {@link ClientConnectionId} use for index is also a deviation, but conveniently\n\t\t * the accurate {@link AttendeeId} type is just a branded string, and\n\t\t * {@link ClientConnectionId} is just `string`.\n\t\t */\n\t\tremoteDatastore: {\n\t\t\tclientToSessionId: {\n\t\t\t\t[ConnectionId: ClientConnectionId]: InternalTypes.ValueRequiredState<AttendeeId>;\n\t\t\t};\n\t\t},\n\t\tsenderConnectionId: ClientConnectionId,\n\t): PostUpdateAction[] {\n\t\tconst audienceMembers = this.audience.getMembers();\n\t\tconst postUpdateActions: PostUpdateAction[] = [];\n\t\tfor (const [clientConnectionId, value] of Object.entries(\n\t\t\trevealOpaqueJson(remoteDatastore.clientToSessionId),\n\t\t)) {\n\t\t\tconst attendeeId = value.value;\n\t\t\tconst { attendee, isJoining } = this.ensureAttendee({\n\t\t\t\tattendeeId,\n\t\t\t\tclientConnectionId,\n\t\t\t\torder: value.rev,\n\t\t\t\tisSender: senderConnectionId === clientConnectionId,\n\t\t\t\tisInAudience: audienceMembers.has(clientConnectionId),\n\t\t\t});\n\t\t\t// If the attendee is joining the session, add them to the list of joining attendees to be announced later.\n\t\t\tif (isJoining) {\n\t\t\t\tpostUpdateActions.push(() => this.events.emit(\"attendeeConnected\", attendee));\n\t\t\t}\n\n\t\t\tconst knownSessionId = this.datastore.clientToSessionId[clientConnectionId];\n\t\t\tif (knownSessionId === undefined) {\n\t\t\t\tthis.datastore.clientToSessionId[clientConnectionId] = value;\n\t\t\t} else {\n\t\t\t\tassert(knownSessionId.value === value.value, 0xa5a /* Mismatched SessionId */);\n\t\t\t}\n\t\t}\n\n\t\treturn postUpdateActions;\n\t}\n\n\tpublic onConnectionAdded(\n\t\tclientConnectionId: ClientConnectionId,\n\t\taudienceOutOfDate: boolean,\n\t): void {\n\t\tassert(\n\t\t\tthis.selfAttendee.getConnectionStatus() === AttendeeStatus.Disconnected,\n\t\t\t0xaad /* Local client should be 'Disconnected' before adding new connection. */,\n\t\t);\n\n\t\tconst selfInAudience = this.audience.getMember(clientConnectionId) !== undefined;\n\t\tassert(\n\t\t\tselfInAudience || audienceOutOfDate,\n\t\t\t0xcc0 /* Local client must be in audience for presence to handle added connection. */,\n\t\t);\n\n\t\tif (!(clientConnectionId in this.datastore.clientToSessionId)) {\n\t\t\tthis.datastore.clientToSessionId[clientConnectionId] = {\n\t\t\t\trev: this.selfAttendee.order++,\n\t\t\t\ttimestamp: Date.now(),\n\t\t\t\tvalue: this.selfAttendee.attendeeId,\n\t\t\t};\n\t\t}\n\n\t\t// Update the self attendee connection information, but not connection\n\t\t// status yet. Connection status is updated once self is in audience -\n\t\t// see later. It is only once our connection is known to audience that\n\t\t// audience can be used to track other attendees' connection statuses\n\t\t// and we seek to present a consistent view locally.\n\t\tthis.selfAttendee.connectionId = clientConnectionId;\n\t\tthis.attendees.set(clientConnectionId, this.selfAttendee);\n\n\t\tif (selfInAudience) {\n\t\t\t// Mark 'Connected' remote attendees connections as stale\n\t\t\t// Performance note: This will visit attendees multiple times as the\n\t\t\t// attendee map has attendeeIds and connectionIds entries that point to\n\t\t\t// the same attendee. But the getConnectionStatus check is cheap and\n\t\t\t// staleConnectionClients.add will handle duplicates.\n\t\t\tthis.staleConnectionClients.clear();\n\t\t\tfor (const staleConnectionClient of this.attendees.values()) {\n\t\t\t\tif (staleConnectionClient.getConnectionStatus() === AttendeeStatus.Connected) {\n\t\t\t\t\tthis.staleConnectionClients.add(staleConnectionClient);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tthis.staleConnectionTimer.setTimeout(this.resolveStaleConnections.bind(this), 30_000);\n\n\t\t\tthis.selfAttendee.setConnected();\n\t\t\tthis.events.emit(\"attendeeConnected\", this.selfAttendee);\n\t\t}\n\t}\n\n\tprivate resolveStaleConnections(): void {\n\t\tconst consideredDisconnected = [];\n\t\tfor (const client of this.staleConnectionClients) {\n\t\t\t// Confirm that audience no longer has connection. It is possible\n\t\t\t// but unlikely that no one mentioned the attendee in this period\n\t\t\t// and that they were never disconnected.\n\t\t\tif (this.audience.getMember(client.getConnectionId()) === undefined) {\n\t\t\t\tconsideredDisconnected.push(client);\n\t\t\t\tclient.setDisconnected();\n\t\t\t}\n\t\t}\n\t\tfor (const client of consideredDisconnected) {\n\t\t\tthis.events.emit(\"attendeeDisconnected\", client);\n\t\t}\n\t\tthis.staleConnectionClients.clear();\n\t}\n\n\tpublic removeClientConnectionId(clientConnectionId: ClientConnectionId): void {\n\t\tconst attendee = this.attendees.get(clientConnectionId);\n\t\tif (!attendee) {\n\t\t\treturn;\n\t\t}\n\n\t\t// If the local connection is being removed, clear the stale connection timer\n\t\tif (attendee === this.selfAttendee) {\n\t\t\tthis.staleConnectionTimer.clearTimeout();\n\t\t} else {\n\t\t\t// When self is not connected, audience may go through a refresh that\n\t\t\t// removes members and adds them back. Defer any removals until self\n\t\t\t// is connected implying audience is stable.\n\t\t\tif (this.selfAttendee.getConnectionStatus() !== AttendeeStatus.Connected) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\n\t\t// If the last known connectionID is different from the connection ID being removed, the attendee has reconnected,\n\t\t// therefore we should not change the attendee connection status or emit a disconnect event.\n\t\tconst attendeeReconnected = attendee.getConnectionId() !== clientConnectionId;\n\t\tconst connected = attendee.getConnectionStatus() === AttendeeStatus.Connected;\n\t\tif (!attendeeReconnected && connected) {\n\t\t\tattendee.setDisconnected();\n\t\t\tthis.events.emit(\"attendeeDisconnected\", attendee);\n\t\t\tthis.staleConnectionClients.delete(attendee);\n\t\t}\n\t}\n\n\tpublic getAttendees(): ReadonlySet<Attendee> {\n\t\treturn new Set(this.attendees.values());\n\t}\n\n\tpublic getAttendee(clientId: ClientConnectionId | AttendeeId): Attendee {\n\t\tconst attendee = this.attendees.get(clientId);\n\t\tif (attendee) {\n\t\t\treturn attendee;\n\t\t}\n\n\t\t// TODO: Restore option to add attendee on demand to handle internal\n\t\t// lookup cases that must come from internal data.\n\t\t// There aren't any resiliency mechanisms in place to handle a missed\n\t\t// ClientJoin right now.\n\t\tthrow new Error(\"Attendee not found\");\n\t}\n\n\tpublic getMyself(): Attendee {\n\t\treturn this.selfAttendee;\n\t}\n\n\t/**\n\t * Make sure the given client session and connection ID pair are represented\n\t * in the attendee map. If not present, SessionClient is created and added\n\t * to map. If present, make sure the current connection ID is updated.\n\t */\n\tprivate ensureAttendee({\n\t\tattendeeId,\n\t\tclientConnectionId,\n\t\torder,\n\t\tisSender,\n\t\tisInAudience,\n\t}: {\n\t\tattendeeId: AttendeeId;\n\t\tclientConnectionId: ClientConnectionId;\n\t\torder: number;\n\t\tisSender: boolean;\n\t\tisInAudience: boolean;\n\t}): { attendee: SessionClient; isJoining: boolean } {\n\t\tlet attendee = this.attendees.get(attendeeId);\n\t\tlet isConnected = false;\n\t\tlet isJoining = false;\n\n\t\tif (attendee === undefined) {\n\t\t\t// New attendee. Create SessionClient and add session ID based\n\t\t\t// entry to map.\n\t\t\tattendee = new SessionClient(attendeeId, order, clientConnectionId);\n\t\t\tthis.attendees.set(attendeeId, attendee);\n\t\t\t// If the attendee update is from the sending remote client itself\n\t\t\t// OR if the attendee is present in audience,\n\t\t\t// then the attendee is considered connected. (Otherwise, leave\n\t\t\t// state as disconnected - default.)\n\t\t\tif (isSender || isInAudience) {\n\t\t\t\tisConnected = true;\n\t\t\t\tattendee.setConnected();\n\t\t\t\tisJoining = true;\n\t\t\t}\n\t\t} else {\n\t\t\t// Known attendee is considered connected if\n\t\t\tisConnected =\n\t\t\t\t// this information is at least up to date with current knowledge\n\t\t\t\torder >= attendee.order &&\n\t\t\t\t// AND in the audience OR\n\t\t\t\t(isInAudience ||\n\t\t\t\t\t// not in audience, but client is the sender and has newer\n\t\t\t\t\t// info. (Assume that audience is out of date and attendee\n\t\t\t\t\t// is joining.)\n\t\t\t\t\t(isSender && order > attendee.order));\n\n\t\t\tif (order > attendee.order) {\n\t\t\t\t// The given association is newer than the one we have.\n\t\t\t\t// Update the order and current connection ID.\n\t\t\t\tattendee.order = order;\n\t\t\t\tattendee.connectionId = clientConnectionId;\n\t\t\t}\n\n\t\t\t// Known attendee is joining the session if they are currently disconnected.\n\t\t\tif (isConnected && attendee.getConnectionStatus() === AttendeeStatus.Disconnected) {\n\t\t\t\tattendee.setConnected();\n\t\t\t\tisJoining = true;\n\t\t\t}\n\t\t}\n\n\t\tif (isConnected) {\n\t\t\t// If the attendee is connected, remove them from the stale connection set\n\t\t\tthis.staleConnectionClients.delete(attendee);\n\t\t}\n\n\t\t// Always update entry for the connection ID. (Okay if already set.)\n\t\tthis.attendees.set(clientConnectionId, attendee);\n\n\t\treturn { attendee, isJoining };\n\t}\n}\n\n/**\n * Instantiates the system workspace.\n */\nexport function createSystemWorkspace(\n\tattendeeId: AttendeeId,\n\tdatastore: SystemWorkspaceDatastore,\n\tevents: Listenable<AttendeesEvents> & IEmitter<AttendeesEvents>,\n\taudience: IAudience,\n): {\n\tworkspace: SystemWorkspace;\n\tstatesEntry: {\n\t\tinternal: PresenceStatesInternal;\n\t\tpublic: AnyWorkspace<StatesWorkspaceSchema>;\n\t};\n} {\n\tconst workspace = new SystemWorkspaceImpl(attendeeId, datastore, events, audience);\n\treturn {\n\t\tworkspace,\n\t\tstatesEntry: {\n\t\t\tinternal: workspace,\n\t\t\tpublic: undefined as unknown as AnyWorkspace<StatesWorkspaceSchema>,\n\t\t},\n\t};\n}\n"]}