feat(presence): Add support for signal batching

packages/framework/presence/src/latestMapValueManager.ts

@@ -12,6 +12,7 @@ import type {
 	LatestValueMetadata,
 } from "./latestValueTypes.js";
 import type { ClientSessionId, ISessionClient, SpecificSessionClient } from "./presence.js";
+import type { LocalUpdateOptions } from "./presenceStates.js";
 import { datastoreFromHandle, type StateDatastore } from "./stateDatastore.js";
 import { brandIVM } from "./valueManager.js";
 
@@ -191,7 +192,7 @@ class ValueMapImpl<T, K extends string | number> implements ValueMap<K, T> {
 		private readonly value: InternalTypes.MapValueState<T>,
 		private readonly localUpdate: (
 			updates: InternalTypes.MapValueState<T>,
-			forceUpdate: boolean,
+			options: LocalUpdateOptions,
 		) => void,
 	) {
 		// All initial items are expected to be defined.
@@ -210,7 +211,7 @@ class ValueMapImpl<T, K extends string | number> implements ValueMap<K, T> {
 			item.value = value;
 		}
 		const update = { rev: this.value.rev, items: { [key]: item } };
-		this.localUpdate(update, /* forceUpdate */ false);
+		this.localUpdate(update, { forceBroadcast: false });
 	}
 
 	public clear(): void {
@@ -333,8 +334,8 @@ class LatestMapValueManagerImpl<
 
 		this.local = new ValueMapImpl<T, Keys>(
 			value,
-			(updates: InternalTypes.MapValueState<T>, forceUpdate: boolean) => {
-				datastore.localUpdate(key, updates, forceUpdate);
+			(updates: InternalTypes.MapValueState<T>, options: LocalUpdateOptions) => {
+				datastore.localUpdate(key, updates, options);
 			},
 		);
 	}

packages/framework/presence/src/latestValueManager.ts

@@ -103,7 +103,7 @@ class LatestValueManagerImpl<T, Key extends string>
 		this.value.rev += 1;
 		this.value.timestamp = Date.now();
 		this.value.value = value;
-		this.datastore.localUpdate(this.key, this.value, /* forceUpdate */ false);
+		this.datastore.localUpdate(this.key, this.value, { forceBroadcast: false });
 	}
 
 	public *clientValues(): IterableIterator<LatestValueClientData<T>> {

packages/framework/presence/src/presenceDatastoreManager.ts

@@ -12,6 +12,7 @@ import type { IEphemeralRuntime } from "./internalTypes.js";
 import type { ClientSessionId, ISessionClient } from "./presence.js";
 import type {
 	ClientUpdateEntry,
+	LocalUpdateOptions,
 	PresenceStatesInternal,
 	ValueElementMap,
 } from "./presenceStates.js";
@@ -148,7 +149,7 @@ export class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
 
 		const localUpdate = (
 			states: { [key: string]: ClientUpdateEntry },
-			forceBroadcast: boolean,
+			options: LocalUpdateOptions,
 		): void => {
 			// Check for connectivity before sending updates.
 			if (!this.runtime.connected) {
@@ -177,7 +178,7 @@ export class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
 					},
 					[internalWorkspaceAddress]: updates,
 				},
-				forceBroadcast,
+				options,
 			);
 		};
 
@@ -195,7 +196,7 @@ export class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
 		return entry.public;
 	}
 
-	private localUpdate(data: DatastoreMessageContent, _forceBroadcast: boolean): void {
+	private localUpdate(data: DatastoreMessageContent, options: LocalUpdateOptions): void {
 		const content = {
 			sendTimestamp: Date.now(),
 			avgLatency: this.averageLatency,

packages/framework/presence/src/presenceStates.ts

@@ -23,13 +23,21 @@ export type MapSchemaElement<
 	Keys extends keyof TSchema = keyof TSchema,
 > = ReturnType<TSchema[Keys]>[Part];
 
+/**
+ * @internal
+ */
+export interface LocalUpdateOptions {
+	forceBroadcast: boolean;
+	allowableUpdateLatency?: number;
+}
+
 /**
  * @internal
  */
 export interface PresenceRuntime {
 	readonly clientSessionId: ClientSessionId;
 	lookupClient(clientId: ClientConnectionId): ISessionClient;
-	localUpdate(states: { [key: string]: ClientUpdateEntry }, forceBroadcast: boolean): void;
+	localUpdate(states: { [key: string]: ClientUpdateEntry }, options: LocalUpdateOptions): void;
 }
 
 type PresenceSubSchemaFromWorkspaceSchema<
@@ -242,7 +250,7 @@ class PresenceStatesImpl<TSchema extends PresenceStatesSchema>
 			this.props = this.nodes as unknown as PresenceStates<TSchema>["props"];
 
 			if (anyInitialValues) {
-				this.runtime.localUpdate(initial.newValues, false);
+				this.runtime.localUpdate(initial.newValues, { forceBroadcast: false });
 			}
 		}
 	}
@@ -262,9 +270,9 @@ class PresenceStatesImpl<TSchema extends PresenceStatesSchema>
 	public localUpdate<Key extends keyof TSchema & string>(
 		key: Key,
 		value: MapSchemaElement<TSchema, "value", Key> & ClientUpdateEntry,
-		forceBroadcast: boolean,
+		options: LocalUpdateOptions,
 	): void {
-		this.runtime.localUpdate({ [key]: value }, forceBroadcast);
+		this.runtime.localUpdate({ [key]: value }, options);
 	}
 
 	public update<Key extends keyof TSchema & string>(
@@ -301,7 +309,7 @@ class PresenceStatesImpl<TSchema extends PresenceStatesSchema>
 				this.datastore[key] = {};
 			}
 			this.datastore[key][this.runtime.clientSessionId] = nodeData.value;
-			this.runtime.localUpdate({ [key]: nodeData.value }, false);
+			this.runtime.localUpdate({ [key]: nodeData.value }, { forceBroadcast: false });
 		}
 	}
 

packages/framework/presence/src/stateDatastore.ts

@@ -7,6 +7,7 @@ import type { ClientConnectionId } from "./baseTypes.js";
 import type { InternalTypes } from "./exposedInternalTypes.js";
 import type { ClientRecord } from "./internalTypes.js";
 import type { ClientSessionId, ISessionClient } from "./presence.js";
+import type { LocalUpdateOptions } from "./presenceStates.js";
 
 // type StateDatastoreSchemaNode<
 // 	TValue extends InternalTypes.ValueDirectoryOrState<any> = InternalTypes.ValueDirectoryOrState<unknown>,
@@ -35,7 +36,7 @@ export interface StateDatastore<
 		value: TValue & {
 			ignoreUnmonitored?: true;
 		},
-		forceBroadcast: boolean,
+		options: LocalUpdateOptions,
 	): void;
 	update(key: TKey, clientSessionId: ClientSessionId, value: TValue): void;
 	knownValues(key: TKey): {