@fluid-internal/presence-runtime 2.93.0

package/lib/runtime/presenceDatastoreManager.d.ts

@@ -0,0 +1,146 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { AttendeeId, BroadcastControlSettings, ClientConnectionId, NotificationsWorkspace, NotificationsWorkspaceSchema, PresenceWithNotifications as Presence, PresenceEvents, StatesWorkspace, StatesWorkspaceSchema, WorkspaceAddress } from "@fluid-internal/presence-definitions";
+import type { AnyWorkspace } from "@fluid-internal/presence-definitions/internal";
+import type { PresenceStatesInternal } from "@fluid-internal/presence-definitions/internal/workspace-runtime";
+import type { InboundExtensionMessage } from "@fluidframework/container-runtime-definitions/internal";
+import type { IEmitter } from "@fluidframework/core-interfaces/internal";
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+import type { InternalWorkspaceAddress, SignalMessages, SystemWorkspaceDatastore } from "./protocol.js";
+import type { IEphemeralRuntime } from "./runtimeTypes.js";
+interface AnyWorkspaceEntry<TSchema extends StatesWorkspaceSchema> {
+    public: AnyWorkspace<TSchema>;
+    internal: PresenceStatesInternal;
+}
+/**
+ * High-level contract for manager of singleton Presence datastore
+ */
+export interface PresenceDatastoreManager {
+    joinSession(clientId: ClientConnectionId, alternateProvider: ClientConnectionId | undefined): void;
+    onDisconnected(): void;
+    getWorkspace<TSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema>(internalWorkspaceAddress: `s:${WorkspaceAddress}`, requestedContent: TSchema, controls?: BroadcastControlSettings): StatesWorkspace<TSchema, unknown, TSchemaKeys>;
+    getWorkspace<TSchema extends Partial<NotificationsWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema>(internalWorkspaceAddress: `n:${WorkspaceAddress}`, requestedContent: TSchema): NotificationsWorkspace<TSchema, TSchemaKeys>;
+    processSignal(message: InboundExtensionMessage<SignalMessages> & {
+        clientId: ClientConnectionId;
+    }, local: boolean, optional: boolean): void;
+}
+/**
+ * Delays used for broadcasting join responses to clients.
+ *
+ * @remarks
+ * Exported for test coordination.
+ * These could be made customizable in the future to accommodate different
+ * session configurations.
+ */
+export declare const broadcastJoinResponseDelaysMs: {
+    /**
+     * The delay in milliseconds before a join response is sent to any client.
+     * This is used to accumulate other join response requests and reduce
+     * network traffic.
+     */
+    readonly namedResponder: 200;
+    /**
+     * The additional delay in milliseconds a backup responder waits before sending
+     * a join response to allow others to respond first.
+     */
+    readonly backupResponderIncrement: 40;
+};
+/**
+ * Manages singleton datastore for all Presence.
+ */
+export declare class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
+    private readonly attendeeId;
+    private readonly runtime;
+    private readonly logger;
+    private readonly events;
+    private readonly presence;
+    private readonly datastore;
+    private averageLatency;
+    private returnedMessages;
+    private readonly sendMessageTimer;
+    private readonly workspaces;
+    private readonly targetedSignalSupport;
+    /**
+     * Tracks whether this client has complete snapshot level knowledge and
+     * how that determination was reached.
+     * - "alone": no other audience members detected at join
+     * - "join response": another client has responded to our join request
+     * - "full requests": all others have requested response from us
+     *
+     * @remarks
+     * Only applies when not using targeted join responses.
+     *
+     * Without a complete snapshot, we cannot fully onboard any other clients.
+     * One exception to this is if this client is the only participant in the
+     * session. In such a case, there is no one to respond to the join request.
+     * Another exception is multiple clients attempting to join at the same
+     * time and thus expecting that someone has full knowledge, yet none have
+     * received a complete update to think they are qualified to respond.
+     * Generically if the number of outstanding requestors meets or exceeds the
+     * count of other audience members, then we can consider the snapshot
+     * complete (as all will have provided their own complete information in
+     * their join responses).
+     */
+    private reasonForCompleteSnapshot?;
+    /**
+     * Map of outstanding broadcast (join response) requests.
+     */
+    private readonly broadcastRequests;
+    /**
+     * Timer for managing broadcast (join response) request timing.
+     */
+    private readonly broadcastRequestsTimer;
+    constructor(attendeeId: AttendeeId, runtime: IEphemeralRuntime, logger: ITelemetryLoggerExt, events: IEmitter<PresenceEvents>, presence: Presence, systemWorkspaceDatastore: SystemWorkspaceDatastore, systemWorkspace: AnyWorkspaceEntry<StatesWorkspaceSchema>);
+    private getAudienceInformation;
+    joinSession(selfClientId: ClientConnectionId, alternateProvider?: ClientConnectionId | undefined): void;
+    onDisconnected(): void;
+    getWorkspace<TSchema extends StatesWorkspaceSchema>(internalWorkspaceAddress: InternalWorkspaceAddress, requestedContent: TSchema, controls?: BroadcastControlSettings): AnyWorkspace<TSchema>;
+    /**
+     * The combined contents of all queued updates. Will be `"sendAll"` when a
+     * full broadcast is pending or `undefined` when no messages are queued.
+     */
+    private queuedData;
+    /**
+     * Enqueues a new message to be sent. The message may be queued or may be sent immediately depending on the state of
+     * the send timer, other messages in the queue, the configured allowed latency, etc.
+     */
+    private enqueueMessage;
+    /**
+     * Send any queued signal immediately. Does nothing if no message is queued.
+     */
+    private sendQueuedMessage;
+    /**
+     * Recursively strips validation metadata (validatedValue) from datastore before broadcasting.
+     * This ensures that validation metadata doesn't leak into signals sent to other clients.
+     */
+    private stripValidationMetadata;
+    /**
+     * Strips validation metadata from individual value data entries.
+     */
+    private stripValidationFromValueData;
+    private broadcastAllKnownState;
+    processSignal(message: InboundExtensionMessage<SignalMessages> & {
+        clientId: ClientConnectionId;
+    }, local: boolean, optional: boolean): void;
+    /**
+     * Broadcasts a join response (complete datastore update message)
+     * if there is an outstanding join response request.
+     */
+    private readonly sendJoinResponseIfStillNeeded;
+    /**
+     * Handles responding to another client joining the session.
+     *
+     * @param updateProviders - list of client connection id's that requestor selected
+     * to provide response
+     * @param requestor - `requestor` is only used in telemetry. While it is the requestor's
+     * client connection id, that is not most important. It is important that this is a
+     * unique shared id across all clients that might respond as we want to monitor the
+     * response patterns. The convenience of being client connection id will allow
+     * correlation with other telemetry where it is often called just `clientId`.
+     */
+    private prepareJoinResponse;
+}
+export {};
+//# sourceMappingURL=presenceDatastoreManager.d.ts.map

package/lib/runtime/presenceDatastoreManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presenceDatastoreManager.d.ts","sourceRoot":"","sources":["../../src/runtime/presenceDatastoreManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,4BAA4B,EAC5B,yBAAyB,IAAI,QAAQ,EACrC,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EACX,YAAY,EAMZ,MAAM,+CAA+C,CAAC;AACvD,OAAO,KAAK,EAEX,sBAAsB,EAGtB,MAAM,iEAAiE,CAAC;AACzE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wDAAwD,CAAC;AACtG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AAEzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AASpF,OAAO,KAAK,EAKX,wBAAwB,EAExB,cAAc,EAEd,wBAAwB,EACxB,MAAM,eAAe,CAAC;AAMvB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,UAAU,iBAAiB,CAAC,OAAO,SAAS,qBAAqB;IAChE,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC9B,QAAQ,EAAE,sBAAsB,CAAC;CACjC;AAuCD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,WAAW,CACV,QAAQ,EAAE,kBAAkB,EAC5B,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,GAC/C,IAAI,CAAC;IACR,cAAc,IAAI,IAAI,CAAC;IACvB,YAAY,CACX,OAAO,SAAS,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAC3D,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,EAE1C,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,EACjD,gBAAgB,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,wBAAwB,GACjC,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAClD,YAAY,CACX,OAAO,SAAS,OAAO,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAClE,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,EAE1C,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,EACjD,gBAAgB,EAAE,OAAO,GACvB,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAChD,aAAa,CACZ,OAAO,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG;QAAE,QAAQ,EAAE,kBAAkB,CAAA;KAAE,EACnF,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,OAAO,GACf,IAAI,CAAC;CACR;AAqCD;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;IACzC;;;;OAIG;;IAEH;;;OAGG;;CAEM,CAAC;AAEX;;GAEG;AACH,qBAAa,4BAA6B,YAAW,wBAAwB;IA4C3E,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IA/C1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsB;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA+D;IAC1F,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAU;IAEhD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,yBAAyB,CAAC,CAA8C;IAEhF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAG9B;IACJ;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAsB;gBAG3C,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,EAChC,QAAQ,EAAE,QAAQ,EACnC,wBAAwB,EAAE,wBAAwB,EAClD,eAAe,EAAE,iBAAiB,CAAC,qBAAqB,CAAC;IAY1D,OAAO,CAAC,sBAAsB;IAkCvB,WAAW,CACjB,YAAY,EAAE,kBAAkB,EAChC,iBAAiB,GAAE,kBAAkB,GAAG,SAAqB,GAC3D,IAAI;IAuEA,cAAc,IAAI,IAAI;IAItB,YAAY,CAAC,OAAO,SAAS,qBAAqB,EACxD,wBAAwB,EAAE,wBAAwB,EAClD,gBAAgB,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,wBAAwB,GACjC,YAAY,CAAC,OAAO,CAAC;IA6CxB;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAyD;IAE3E;;;OAGG;IACH,OAAO,CAAC,cAAc;IA4CtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmDzB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IA6B/B;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAkCpC,OAAO,CAAC,sBAAsB;IAkDvB,aAAa,CACnB,OAAO,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG;QAAE,QAAQ,EAAE,kBAAkB,CAAA;KAAE,EACnF,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,OAAO,GACf,IAAI;IAyJP;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAsB5C;IAEF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,mBAAmB;CAqG3B"}