fix(client-presence): Announce 'attendeeConnected' for self-attendee #26123

WillieHabi · 2026-01-05T22:14:22Z

Description

Fixes AB#56686 -- self-attendee is announced via 'attendeeConnected' when the local client connects.

To test this, we added prepareDisconnectedPresence test helper which creates a presence instance in a disconnected state. This allows us to test and setup event listeners before initial connection occurs.

We also refactor usage of client2 as the local client in our unit testing to be more explicit. This is so when we do prepareConnectedPresence, the client is only added to the audience during the connect step.

List of test added:

- PresenceManager
    - self attendee
        - is announced via `attendeeConnected` upon initial connection
        - has status "Disconnected" when presence initializes while self not in Audience
        - 'has status "Disconnected" when runtime is connected but self is not yet in Audience
        - is announced via `attendeeConnected` when added to Audience while runtime is connected
        - has status "Connected" when announced via `attendeeConnected
        - is announced via `attendeeDisconnected` when local client disconnects
        - is announced via `attendeeConnected` when local client reconnects

- self attendee - is announced via 'attendeeConnected' when local client connects - has status "Connected" when announced via 'attendeeConnected' - is announced via 'attendeeConnected' when local client reconnects

Copilot

Pull request overview

This PR fixes issue AB#56686 by ensuring the self-attendee is announced via the attendeeConnected event when the local client connects or reconnects. Previously, this event was not being emitted for the self-attendee due to a TODO comment blocking the implementation.

Key changes:

Enabled the attendeeConnected event emission for self-attendee in systemWorkspace.ts
Added prepareDisconnectedPresence test helper to support testing connection events from a disconnected state
Added three comprehensive test cases to verify self-attendee connection announcement behavior

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
packages/framework/presence/src/systemWorkspace.ts	Removed TODO comment and enabled event emission for self-attendee connection
packages/framework/presence/src/test/testUtils.ts	Added new test helper function to create presence instances in disconnected state for testing connection events
packages/framework/presence/src/test/presenceManager.spec.ts	Added test suite for self-attendee connection events and updated existing tests to exclude self-attendee from assertions

Copilot · 2026-01-05T22:19:26Z

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

+			// Pass time (to mimic likely response)
+			clock.tick(broadcastJoinResponseDelaysMs.namedResponder + 20);
+
+			// Send a fake join response


The comment on line 351 is missing contextual information that would help readers understand the purpose of the fake join response. The similar comment in prepareConnectedPresence (lines 227-230) includes a helpful explanation: "There are no other attendees in the session (not realistic) but this convinces the presence manager that it now has full knowledge, which enables it to respond to other's join requests accurately." Consider adding this explanation here as well for consistency and better code maintainability.

Suggested change

// Send a fake join response

// Send a fake join response. There are no other attendees in the session (not realistic) but

// this convinces the presence manager that it now has full knowledge, which enables it to

// respond to other's join requests accurately.

jason-ha · 2026-01-06T22:25:22Z

runtime: MockEphemeralRuntime,

How is prepareConnectedPresence different from calling prepareDisconnectedPresence followed by using connectPresence that it returns?

Refers to: packages/framework/presence/src/test/testUtils.ts:141 in a11008f. [](commit_id = a11008f, deletion_comment = False)

jason-ha

self-Attendee section should also have a test for attendeeDisconnected.

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

…nce with new helper functions

…elf not in Audience

WillieHabi · 2026-01-08T01:21:11Z

runtime: MockEphemeralRuntime,

How is prepareConnectedPresence different from calling prepareDisconnectedPresence followed by using connectPresence that it returns?

Refers to: packages/framework/presence/src/test/testUtils.ts:141 in a11008f. [](commit_id = a11008f, deletion_comment = False)

prepareConnectedPresence before would return instantiate presence but it wouldn't go through the full connected flow (runtime.connect). I changed this now so it does go through connect flow by using 'prepareDisconnectedPresence' + 'connect'.

jason-ha

I didn't get through looking at everything, but here are some notes.
Also still missing a self attendeeDisconnected case.

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

jason-ha · 2026-01-08T08:49:40Z

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

+			// Add to quorum as a write client (consistent with buildClientDataArray creating write clients)
+			const quorumSize = this.quorum.getMembers().size;
+			this.quorum.addMember(newClientId, {
+				client: newMember,
+				sequenceNumber: 10 * quorumSize,
+			});


Hmm. I think there are a number of questions for this change:

why is it needed / desired?

assuming it is kept, where is the related removal?

the timing does not appear to be correct. quorum is an op-based construct. This connect is should only go up to minimal connection status. Ops that change quorum would come later.

There is no check to see that client is a write client and would appear in quorum.

Note that the Audience that Presence cares about is the Signal-only Audience.

I'll ended up adding a syncWithQuorum method to MockEphemeralRuntime instead of doing this. I think that's better for testing purposes and more just correct, but here's the responses I wrote before and my thought process.

When we connect/disconnect our local client in our testing, there's currently no mechanism to keep quorum in sync. This is desirable/needed for example when we test responding to ClientJoin -- since quorum is not synced with connect flow, the local client does not appear in quorum and cannot compute its join order. This only worked before because we used client2 as the designated local client and tested against it's hardcoded quorum sequenceNumber/join order. But if we had a test where we disconnect + reconnect with new clientID and try to test the same scenario it would all fall apart since quorum is not synced with the local connection flow.

I saw we handle removal of clients from audience and quorum in runtime.removeMember(). But in runtime.disconnect() we don't handle removal of local client from either audience or quorum, which doesn't seem right since it's impossible for local client to disconnect and still be in quorum. I think maybe calling removeMember(this.clientId) in disconnect() would make sense here(?)

Yeah this callout makes sense to me, the timing of audience and quorum removal at the same time is not right.

We build the new client doing buildClientDataArray([clientId], 1 \* numWriteClients *\) so we always connect as write client.

Note that Quorum is a funny beast. When you join a document as a writer, it takes note of you being there. When you join later Quorum and traditional Audience will show add- and removeMember for everyone in the history (I think we don't see it too often because Summarization is aggressive and squashes the history.)
We largely do not require Quorum any longer. We do leverage it as fallback when other Join mechanism don't perform as intended. I hope that is very rare now. And things should be functional whether our local write client is in Quorum at time of demand or not. Ideally, we have coverage for both. What does our coverage look like for presenceDatastoreManager.ts lines 857 to 877 running just the Presence > protocol handling tests?

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

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

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

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

packages/framework/presence/src/test/schemaValidation/protocol.spec.ts

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

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

jason-ha

PR description is still stale

jason-ha · 2026-01-12T21:57:45Z

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

 			});

-			it("is announced via `attendeeConnected` when presence initializes while self is in Audience", () => {
+			it("is announced via `attendeeConnected` upon initial connection", () => {


"while self is in Audience" is important criteria/qualification.
What happens when runtime is connected but self isn't in Audience?

renamed test to "is announced via attendeeConnected upon connect while self is in audience".

...What happens when runtime is connected but self isn't in Audience?

Apologies, I thought this was a rhetorical question -- completley forgot it was possible to be connected to service and not be present in signal audience. I added a test that confirms the self attendee has status Disconnected in this case.

I now am wondering if we're missing the case where self attendee is in audience when presence initializes but we are not connected to service. Is this possible? Or does transition to CatchingUp always beat membership in signalAudience?

edit: I now see in our usage of addClientConnectionId we trigger presence join based on audience addMember() events for self and we don't listen to "joined" events.

When disconnected, self should be removed from Audience. At least I think that is always supposed to be the case.

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

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

… self is in audience upon initial connection

…onId2 to presenceManager.spec.ts

…stants in testUtils.ts

jason-ha

Looks pretty good - 75% nits

one test case request

packages/framework/presence/src/test/schemaValidation/protocol.spec.ts

jason-ha · 2026-01-14T22:35:47Z

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

 					logger,
 				));

+				runtime.addAudienceWriteClientsToQuorum();


Why is this important here, but not something we see in other places?
(Please add comment)

Yeah thanks for this callout, this is not needed anymore now that localClient defaults to being in audience/quorum.

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

jason-ha · 2026-01-14T22:41:54Z

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

+				);
+			});
+
+			it('has status "Disconnected" when presence initializes while self not in Audience', () => {


I think this should be a case, but the implementation here has container fully disconnected. Fully disconnected trumps self not in Audience. At no time, AFAIK, should self be in Audience while disconnected.
The description for this logic could mention container disconnected container.

Renamed to 'has status "Disconnected" when presence initializes while container is disconnected'

…not yet in Audience"

jason-ha

Good enough to approve :)
Be sure to update description with the test cases.
That said there looks like one more case of interest - could be added as a follow-up.

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

…ile runtime is connected"

jason-ha · 2026-01-16T00:17:35Z

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

+				// Expect join signal when self is added to audience while connected
+				const expectedJoin = generateBasicClientJoin(clock.now, {
+					attendeeId: localAttendeeId,
+					clientConnectionId: initialLocalClientConnectionId,
+					updateProviders: ["client0", "client1", "client3"],
+				});
+				delete (expectedJoin as Partial<typeof expectedJoin>).clientId;
+				runtime.signalsExpected.push([expectedJoin]);


Looks like prepareExpectedClientJoin though that one figures out updateProviders on its own

I'll get what I have so far in and address this one separately. Think I can maybe also pull out a prepareConnectedPresenceWithoutSelfInAudience for these two new tests as well.

## Description Changeset for #26123

WillieHabi added 3 commits January 5, 2026 13:23

Add prepareDisconnectedPresence util to testUtils.ts

cfded76

Add self-attendee tests to presenceManager.spec.ts:

1e15826

- self attendee - is announced via 'attendeeConnected' when local client connects - has status "Connected" when announced via 'attendeeConnected' - is announced via 'attendeeConnected' when local client reconnects

emit "attendeeConnected" for self-attendee

a11008f

Copilot AI review requested due to automatic review settings January 5, 2026 22:14

Copilot started reviewing on behalf of WillieHabi January 5, 2026 22:14 View session

Copilot AI reviewed Jan 5, 2026

View reviewed changes

WillieHabi requested a review from jason-ha January 5, 2026 23:19

jason-ha reviewed Jan 6, 2026

View reviewed changes

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

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

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

WillieHabi added 5 commits January 7, 2026 14:45

remove duplicate code in testUtils by composing prepareConnectedPrese…

499857c

…nce with new helper functions

fix assert to be more clear

3a15cf6

restructure attendeeConnected assert

ed55c2c

Add test: has status "Disconnected" when presence initializes while s…

75ab983

…elf not in Audience

replace usage of selfAttendeeId and selfClientConnectionId

40372df

WillieHabi requested a review from jason-ha January 8, 2026 04:02

jason-ha reviewed Jan 8, 2026

View reviewed changes

WillieHabi added 3 commits January 8, 2026 15:18

requested changes

0ef728f

no need to specify initial when naming attendeeId since it is stable

87c473e

attendeeDisconnected test

cce825b

WillieHabi requested a review from jason-ha January 9, 2026 17:32

jason-ha reviewed Jan 9, 2026

View reviewed changes

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

jason-ha reviewed Jan 9, 2026

View reviewed changes

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

jason-ha reviewed Jan 9, 2026

View reviewed changes

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

jason-ha reviewed Jan 9, 2026

View reviewed changes

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

jason-ha reviewed Jan 9, 2026

View reviewed changes

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

WillieHabi added 3 commits January 9, 2026 14:08

rename syncWithQuorum

bab88b6

track quorum sequence number properly

3ceadd4

fix buildClientDataArray comment

da41270

jason-ha reviewed Jan 9, 2026

View reviewed changes

packages/framework/presence/src/test/testUtils.ts Show resolved Hide resolved

WillieHabi added 5 commits January 12, 2026 12:30

return localAvgLatency from preparePresence

31644f8

remove duplicaiton from preparePresence functions

32d2945

localClient renames

9ecb5e5

assert clientId not in quorum or audience in prepareDisconnectedPresence

ec059e9

reorder tests

acd0e31

jason-ha reviewed Jan 12, 2026

View reviewed changes

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

rename rejoin value instead of symbol

29975b0

jason-ha reviewed Jan 12, 2026

View reviewed changes

WillieHabi added 7 commits January 13, 2026 17:50

extract prepareExpectedClientJoin into it's own function

3f58402

rename test: self attendee is announced via attendeeConnected while…

1a00044

… self is in audience upon initial connection

move rejoinedLocalClientConnectionId1 and rejoinedLocalClientConnecti…

526a086

…onId2 to presenceManager.spec.ts

rename createPresence function

eb84f63

move export of initialLocalClientConnectionId near other exported con…

c148606

…stants in testUtils.ts

type-import styling for mockEphemeralRuntime in testUtils.ts

a5f3e3a

move removal of client from audience to prepareDisconnectedPresence

079a073

WillieHabi requested a review from jason-ha January 14, 2026 05:38

format test name

e9d58cb

jason-ha reviewed Jan 14, 2026

View reviewed changes

WillieHabi added 4 commits January 15, 2026 10:08

move localAvgLatency in beforeEach scope

914a8a0

remove addAudienceWriteClientsToQuorum.

8b6036f

restore comment and rename disconnected test

4f8af2e

add "has status "Disconnected" when runtime is connected but self is …

264a9c9

…not yet in Audience"

jason-ha approved these changes Jan 15, 2026

View reviewed changes

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

WillieHabi and others added 2 commits January 15, 2026 14:57

test: "is announced via attendeeConnected when added to Audience wh…

d025ef6

…ile runtime is connected"

Merge branch 'main' into presence-fix-self-attendee-connected

21d2ac5

WillieHabi requested a review from jason-ha January 15, 2026 23:50

jason-ha approved these changes Jan 16, 2026

View reviewed changes

WillieHabi merged commit f41dea7 into microsoft:main Jan 16, 2026
30 checks passed

WillieHabi mentioned this pull request Jan 20, 2026

Changeset for self attendee "attendeeConnected" #26247

Merged

WillieHabi added a commit that referenced this pull request Jan 20, 2026

Changeset for self attendee "attendeeConnected" (#26247)

f838524

## Description Changeset for #26123

-			// Send a fake join response
+			// Send a fake join response. There are no other attendees in the session (not realistic) but
+			// this convinces the presence manager that it now has full knowledge, which enables it to
+			// respond to other's join requests accurately.

fix(client-presence): Announce 'attendeeConnected' for self-attendee #26123

fix(client-presence): Announce 'attendeeConnected' for self-attendee #26123

Uh oh!

Conversation

WillieHabi commented Jan 5, 2026 • 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

Reviewed changes

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

jason-ha commented Jan 6, 2026

Uh oh!

jason-ha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WillieHabi commented Jan 8, 2026

Uh oh!

jason-ha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WillieHabi Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

jason-ha left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WillieHabi Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jason-ha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WillieHabi commented Jan 5, 2026 •

edited

Loading

WillieHabi Jan 8, 2026 •

edited

Loading

WillieHabi Jan 15, 2026 •

edited

Loading