feat(client-presence): Create Acknowledgment message interface and ackRequested flow

packages/framework/presence/src/presenceDatastoreManager.ts

@@ -90,9 +90,16 @@ interface ClientJoinMessage extends IInboundSignalMessage {
 	};
 }
 
+const acknowledgementMessageType = "Pres:Ack";
+
+interface AcknowledgementMessage extends IInboundSignalMessage {
+	type: typeof acknowledgementMessageType;
+	content: unknown;
+}
+
 function isPresenceMessage(
 	message: IInboundSignalMessage,
-): message is DatastoreUpdateMessage | ClientJoinMessage {
+): message is DatastoreUpdateMessage | ClientJoinMessage | AcknowledgementMessage {
 	return message.type.startsWith("Pres:");
 }
 /**
@@ -356,14 +363,26 @@ export class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
 		// IExtensionMessage is a subset of IInboundSignalMessage so this is safe.
 		// Change types of DatastoreUpdateMessage | ClientJoinMessage to
 		// IExtensionMessage<> derivatives to see the issues.
-		message: IInboundSignalMessage | DatastoreUpdateMessage | ClientJoinMessage,
+		message:
+			| IInboundSignalMessage
+			| DatastoreUpdateMessage
+			| ClientJoinMessage
+			| AcknowledgementMessage,
 		local: boolean,
 	): void {
 		const received = Date.now();
 		assert(message.clientId !== null, 0xa3a /* Map received signal without clientId */);
 		if (!isPresenceMessage(message)) {
 			return;
 		}
+
+		// Here we accept acknowledgement messages passively.
+		// Once implemented, these will be used for tracking message delivery status.
+		// For now, we just skip processing these messages.
+		if (message.type === acknowledgementMessageType) {
+			return;
+		}
+
 		if (local) {
 			const deliveryDelta = received - message.content.sendTimestamp;
 			// Limit returnedMessages count to 256 such that newest message

packages/framework/presence/src/test/presenceDatastoreManager.spec.ts

@@ -438,5 +438,29 @@ describe("Presence", () => {
 				assert.strictEqual(listener.callCount, 1);
 			});
 		});
+
+		describe("receiving AcknowledgementMessage", () => {
+			it("accpets passively without failing", () => {
+				const presence = prepareConnectedPresence(
+					runtime,
+					"attendeeId-2",
+					"client2",
+					clock,
+					logger,
+				);
+
+				presence.processSignal(
+					"",
+					{
+						type: "Pres:Ack",
+						content: {
+							messageId: "messageId",
+						},
+						clientId: "client1",
+					},
+					false,
+				);
+			});
+		});
 	});
 });