Skip to content

Make useSession wait for agent only if an agent was dispatched #1226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 29, 2025
Merged

Make useSession wait for agent only if an agent was dispatched #1226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0a9c2c5
feat: temporarily copy decodeTokenPayload into this project from live…
1egoman Oct 24, 2025
c0bac8a
feat: add logic to only wait for agent to be available if an agent was
1egoman Oct 24, 2025
388ac32
fix: add changeset
1egoman Oct 24, 2025
3ab537f
Revert "feat: temporarily copy decodeTokenPayload into this project f…
1egoman Oct 28, 2025
d8cc488
feat: install updated livekit-client package with new decodeTokenPayl…
1egoman Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/slick-cougars-pick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@livekit/components-react': patch
---

Make useSession wait for agent only if an agent was dispatched
17 changes: 13 additions & 4 deletions packages/react/src/hooks/useSession.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
TokenSourceFixed,
TokenSourceFetchOptions,
RoomConnectOptions,
decodeTokenPayload,
} from 'livekit-client';
import { EventEmitter } from 'events';

Expand Down Expand Up @@ -451,12 +452,18 @@ export function useSession(
};
signal?.addEventListener('abort', onSignalAbort);

let tokenDispatchesAgent = false;
await Promise.all([
// FIXME: swap the below line in once the new `livekit-client` changes are published
// room.connect(tokenSource, { tokenSourceOptions }),
tokenSourceFetch().then(({ serverUrl, participantToken }) =>
room.connect(serverUrl, participantToken, roomConnectOptions),
),
tokenSourceFetch().then(({ serverUrl, participantToken }) => {
const participantTokenPayload = decodeTokenPayload(participantToken);
const participantTokenAgentDispatchCount =
participantTokenPayload.roomConfig?.agents?.length ?? 0;
tokenDispatchesAgent = participantTokenAgentDispatchCount > 0;

return room.connect(serverUrl, participantToken, roomConnectOptions);
}),

// Start microphone (with preconnect buffer) by default
tracks.microphone?.enabled
Expand All @@ -469,7 +476,9 @@ export function useSession(
]);

await waitUntilConnected(signal);
Copy link

@xianshijing-lk xianshijing-lk Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question

without knowing enough context on the code, I wonder if we shoul do both waitUntilConnected() and await agent.waitUntilAvailable(signal); in some cases ?

or it should be something like
if (tokenDispatchesAgent && agent) {
await agent.waitUntilAvailable(signal);
} else {
await waitUntilConnected(signal);
}

also, should you guard agent ?

Copy link
Contributor Author

@1egoman 1egoman Oct 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or it should be something like

waitUntilConnected will block until a the underlying room is connected, and agent.waitUntilAvailable will block until the agent has connected. One is dependent on the other, and while I guess technically the agent could never connect until the room connects first, this should always happen in a sequential fashion so I'm not sure that it really matters that much. So I guess I don't have a strong preference given both should behave identically, but maybe lean slightly towards what I have now.

also, should you guard agent ?

No, this isn't required - agent is always set, but its internal state changes as the agent goes through the connection lifecycle.

await agent.waitUntilAvailable(signal);
if (tokenDispatchesAgent) {
await agent.waitUntilAvailable(signal);
}

signal?.removeEventListener('abort', onSignalAbort);
},
Expand Down
62 changes: 34 additions & 28 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ packages:
- 'tooling/*'

catalog:
livekit-client: ^2.15.8
livekit-client: ^2.15.14
"@livekit/protocol": ^1.42.0