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

WillieHabi · 2025-04-28T18:10:50Z

Description

For Presence to leverage targeted signals, an acknowledgement mechanism will most likely be needed. This change reserves space for such messages in protocol and introduces an acknowledgementID field alongside messages that require acknowledgment. When a client receives a message with an acknowledgementID then they respond with a targeted ack messsage containing the corresponding id. acknowledgementId is typed as number and will be a simple increasing counter. This is sufficient for local uniqueness.

This PR also passes down supportedFeatures property from runtime to PresenceDatastoreManager, to allow Presence to know whether targeted signal capability is available.

Copilot

Pull Request Overview

This PR introduces an acknowledgement message interface for client presence to facilitate acknowledgement responses when clients join.

Added a new constant for the acknowledgement message type and its corresponding interface.
Extended the message type union in helper functions and added a branch in the message handler to accommodate the new acknowledgement messages.

packages/framework/presence/src/presenceDatastoreManager.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…Habi/FluidFramework into presence-ack-message-type

packages/framework/presence/src/presenceDatastoreManager.ts

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

packages/framework/presence/src/presenceDatastoreManager.ts

I was wrong about the utility of having passing acceptance of an Ack message. There isn't any time a client should receive an Ack without asking for one. We can follow up elsewhere on what logic we should put out sooner in Teams.

packages/framework/presence/src/internalTypes.ts

packages/framework/presence/src/presenceDatastoreManager.ts

jason-ha · 2025-05-20T23:28:57Z

packages/framework/presence/src/test/mockEphemeralRuntime.ts

+	public setTargetSignalSupport(supported: boolean): void {
+		if (supported) {
+			this.supportedFeatures.add("submit_signals_v2");
+		} else {
+			this.supportedFeatures.delete("submit_signals_v2");
+		}
+	}


For future use? I don't see reference to this.?

Yes, I assumed in the future we'd want something like this to test behavior of both flows (broadcast join vs targeted join behavior).

packages/framework/presence/src/internalTypes.ts

packages/framework/presence/src/presenceDatastoreManager.ts

packages/framework/presence/src/test/mockEphemeralRuntime.ts

packages/runtime/container-runtime-definitions/src/containerExtension.ts

packages/framework/presence/src/test/testUtils.ts

packages/framework/presence/src/protocol.ts

packages/framework/presence/src/presenceDatastoreManager.ts

packages/framework/presence/src/datastorePresenceManagerFactory.ts

packages/framework/presence/src/presenceDatastoreManager.ts

packages/framework/presence/src/protocol.ts

jason-ha · 2025-06-02T21:19:08Z

packages/framework/presence/src/protocol.ts

+	};
+}
+
+type AcknowledgmentIdType = string;


nits:

It is a type. You don't need to say Type in the name.

Move before it is used. (English reading order.)

Oof right just saw this, will have a follow up fixing this

…4753) ## Description Addresses nit in #24470

…ckRequested` flow (microsoft#24470) ## Description For Presence to leverage targeted signals, an acknowledgement mechanism will most likely be needed. This change reserves space for such messages in protocol and introduces an `acknowledgementID` field alongside messages that require acknowledgment. When a client receives a message with an `acknowledgementID` then they respond with a targeted ack messsage containing the corresponding `id`. `acknowledgementId` is typed as `number` and will be a simple increasing counter. This is sufficient for local uniqueness. This PR also passes down `supportedFeatures` property from runtime to PresenceDatastoreManager, to allow Presence to know whether targeted signal capability is available. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…crosoft#24753) ## Description Addresses nit in microsoft#24470

initial changes

649f757

Copilot AI review requested due to automatic review settings April 28, 2025 18:10

Copilot AI reviewed Apr 28, 2025

View reviewed changes

packages/framework/presence/src/presenceDatastoreManager.ts Outdated Show resolved Hide resolved

github-actions bot added area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch labels Apr 28, 2025

WillieHabi and others added 4 commits April 28, 2025 19:12

Update packages/framework/presence/src/presenceDatastoreManager.ts

f3d92c5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

change comment

36e46f6

Merge branch 'presence-ack-message-type' of https://github.com/Willie…

f679bc9

…Habi/FluidFramework into presence-ack-message-type

fix mispelling

a5bcfa7

WillieHabi changed the title ~~feat(client-presenece): Create Acknowldegment message interface~~ feat(client-presence): Create Acknowledgment message interface Apr 28, 2025

jason-ha reviewed Apr 29, 2025

View reviewed changes

packages/framework/presence/src/presenceDatastoreManager.ts Outdated Show resolved Hide resolved

packages/framework/presence/src/presenceDatastoreManager.ts Outdated Show resolved Hide resolved

packages/framework/presence/src/presenceDatastoreManager.ts Show resolved Hide resolved

WillieHabi marked this pull request as draft April 29, 2025 06:39

req changes

ad1793f

WillieHabi requested a review from jason-ha April 29, 2025 13:23

WillieHabi marked this pull request as ready for review April 29, 2025 13:23

jason-ha reviewed Apr 30, 2025

View reviewed changes

packages/framework/presence/src/test/presenceDatastoreManager.spec.ts Outdated Show resolved Hide resolved

packages/framework/presence/src/test/presenceDatastoreManager.spec.ts Outdated Show resolved Hide resolved

jason-ha reviewed Apr 30, 2025

View reviewed changes

packages/framework/presence/src/presenceDatastoreManager.ts Outdated Show resolved Hide resolved

more comments

35757eb

jason-ha previously approved these changes May 5, 2025

View reviewed changes

jason-ha changed the title ~~feat(client-presence): Create Acknowledgment message interface~~ feat(client-presence): Create stub Acknowledgment message interface May 5, 2025

ackRequested and supportedFeatures

e6c52b1

WillieHabi changed the title ~~feat(client-presence): Create stub Acknowledgment message interface~~ feat(client-presence): Create stub Acknowledgment message interface and ackRequested flow May 13, 2025

WillieHabi marked this pull request as draft May 13, 2025 16:41

ILayerCompatDetails

433df8b

WillieHabi marked this pull request as ready for review May 13, 2025 20:18

WillieHabi requested a review from jason-ha May 13, 2025 21:30

WillieHabi marked this pull request as draft May 13, 2025 23:25

WillieHabi added 2 commits May 14, 2025 09:12

acknowledgmentId

bd69e1d

remove comment

d50f7d3

WillieHabi changed the title ~~feat(client-presence): Create stub Acknowledgment message interface and ackRequested flow~~ feat(client-presence): Create Acknowledgment message interface and ackRequested flow May 14, 2025

WillieHabi marked this pull request as ready for review May 14, 2025 16:26

jason-ha reviewed May 15, 2025

View reviewed changes

WillieHabi added 3 commits May 15, 2025 11:52

update ts-doc for ack message type

b524bd8

requested changes

3f55646

test title

a820892

WillieHabi requested a review from jason-ha May 15, 2025 21:03

jason-ha reviewed May 21, 2025

View reviewed changes

FluidObject + correct changes

cb28f2a

WillieHabi requested a review from jason-ha May 21, 2025 22:29

WillieHabi added 4 commits May 27, 2025 17:08

Merge branch 'main' into presence-ack-message-type

acc759a

additional changes

3815ef3

add targeted signal support

c7b1ed2

Add supportedFeatures to ExtensionHost

bb62127

github-actions bot added the area: runtime Runtime related issues label May 28, 2025

jason-ha reviewed May 30, 2025

View reviewed changes

req changes

354fc29

github-actions bot added the dependencies Pull requests that update a dependency file label Jun 2, 2025

WillieHabi requested a review from jason-ha June 2, 2025 17:11

Merge branch 'main' into presence-ack-message-type

b88ed5d

jason-ha approved these changes Jun 2, 2025

View reviewed changes

WillieHabi merged commit 8a2d212 into microsoft:main Jun 2, 2025
33 checks passed

WillieHabi mentioned this pull request Jun 2, 2025

refactor(client-presence): rename and move acknowledgment ID type #24753

Merged

WillieHabi added a commit that referenced this pull request Jun 2, 2025

refactor(client-presence): rename and move acknowledgment ID type (#2…

9e7bbd3

…4753) ## Description Addresses nit in #24470

MarioJGMsoft pushed a commit to MarioJGMsoft/FluidFramework that referenced this pull request Jun 10, 2025

refactor(client-presence): rename and move acknowledgment ID type (mi…

194c04c

…crosoft#24753) ## Description Addresses nit in microsoft#24470

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

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

Uh oh!

Conversation

WillieHabi commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jason-ha May 20, 2025

Choose a reason for hiding this comment

Uh oh!

WillieHabi May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jason-ha Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

WillieHabi Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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

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

WillieHabi commented Apr 28, 2025 •

edited

Loading