Disconnect the client when the bot disconnects, with option to disable by mattieruth · Pull Request #185 · pipecat-ai/pipecat-client-web

mattieruth · 2026-03-11T16:37:53Z

Right now, when the bot disconnects, transports handle the situation differently and don't necessarily even inform the client in any way. This change (along with this transport PR) changes the standard bot disconnection path so that the idea is when the bot disconnects, the transport triggers the 'botDisconnected' callback/event and the client then decides whether to disconnect based on the new flag(disconnectOnBotDisconnect). This flag defaults to true which matches behavior of old that got broken somewhere along the way.

Copilot

Pull request overview

This PR updates the JS client packages and adjusts bot-disconnect handling in @pipecat-ai/client-js, including an option to automatically disconnect the client when the bot disconnects.

Changes:

Bump workspace/package-lock versions and update transitive deps (e.g., minimatch, ajv, brace-expansion).
Change botDisconnected / onBotDisconnected callback typings to allow an undefined Participant.
Add disconnectOnBotDisconnect option and trigger PipecatClient.disconnect() on bot disconnect by default.
Relax commitlint rules by disabling header/body case checks.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 5 comments.

File	Description
package-lock.json	Updates lockfile versions for workspace packages and transitive dependencies.
client-js/rtvi/events.ts	Changes `botDisconnected` event handler type to accept an optional `Participant`.
client-js/client/client.ts	Adds `disconnectOnBotDisconnect` option and auto-disconnect behavior; updates callback signature accordingly.
.commitlintrc.json	Disables commitlint `header-case` and `body-case` rules.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T16:42:20Z

client-js/rtvi/events.ts

  botConnected: (participant: Participant) => void;
  botReady: (botData: BotReadyData) => void;
-  botDisconnected: (participant: Participant) => void;
+  botDisconnected: (participant?: Participant) => void;


Changing botDisconnected handler to accept an optional Participant is a breaking TypeScript API change under strictFunctionTypes (existing handlers typed as (participant: Participant) => void will no longer be assignable). If the participant can be missing, consider keeping the public handler type unchanged and guaranteeing a Participant is passed (e.g., cache the bot participant from botConnected / botReady and reuse it on disconnect), or introduce a separate event for disconnect-without-participant rather than weakening this one.

Suggested change

botDisconnected: (participant?: Participant) => void;

botDisconnected: (participant: Participant) => void;

copilot has a valid point here, but i don't know how to NOT break this. There IS no participant when it comes to the smallWebRTC Transport.

Copilot · 2026-03-11T16:42:20Z

client-js/client/client.ts

  onBotConnected: (participant: Participant) => void;
  onBotReady: (botReadyData: BotReadyData) => void;
-  onBotDisconnected: (participant: Participant) => void;
+  onBotDisconnected: (participant?: Participant) => void;


onBotDisconnected now takes an optional Participant, which is a breaking change for TS consumers using (participant: Participant) => void handlers (not assignable to an optional-param callback under strict). Prefer keeping the callback signature stable and ensuring a Participant is always provided, or add a new separate callback/event for the no-participant case instead of changing this one.

Suggested change

onBotDisconnected: (participant?: Participant) => void;

onBotDisconnected: (participant: Participant) => void;

Copilot · 2026-03-11T16:42:21Z

client-js/client/client.ts

+  /**
+   * Disconnect when the bot disconnects.
+   *
+   * Default to true


disconnectOnBotDisconnect defaults to true, which changes default client behavior (auto-disconnect on bot disconnect) without the caller opting in. For a library patch/minor release this is likely an unexpected breaking behavior change; consider defaulting to false (opt-in), or clearly treating this as a breaking change (major bump / explicit migration note) if the new default is required.

Suggested change

* Default to true

* Default to true.

*

* NOTE: This default of `true` is a breaking change compared to earlier

* versions, where the client would remain connected when the bot

* disconnected unless this behavior was explicitly requested.

* If you rely on the previous behavior, explicitly set

* `disconnectOnBotDisconnect: false` when creating the client.

another good point by copilot except... that technically the current behavior is breaking. we used to disconnect the client when the bot disconnected but somewhere along the way that stopped and it's pretty annoying.

Copilot · 2026-03-11T16:42:21Z

client-js/client/client.ts

        this.emit(RTVIEvent.BotDisconnected, p);
+        if (this._disconnectOnBotDisconnect) {
+          logger.info("Bot disconnected. Disconnecting client...");
+          this.disconnect();


disconnect() is async and can reject, but it's being called without await/error handling inside the onBotDisconnected callback. This can lead to unhandled promise rejections and makes disconnect failures silent. Consider explicitly handling the promise (e.g., await in an async wrapper or attach a .catch(...) that reports via onError/logger).

Suggested change

this.disconnect();

this.disconnect().catch((error) => {

logger.error("Failed to disconnect client after bot disconnected", error);

});

Copilot · 2026-03-11T16:42:21Z

client-js/client/client.ts

      onBotDisconnected: (p) => {
        options?.callbacks?.onBotDisconnected?.(p);
        this.emit(RTVIEvent.BotDisconnected, p);
+        if (this._disconnectOnBotDisconnect) {
+          logger.info("Bot disconnected. Disconnecting client...");
+          this.disconnect();
+        }


New behavior (auto-disconnect when the bot disconnects, and the disconnectOnBotDisconnect opt-out) isn’t covered by existing Jest tests in client-js/tests/client.spec.ts. Please add tests that simulate a bot-disconnect callback from the transport and assert (1) disconnect is triggered by default, and (2) disconnect is not triggered when disconnectOnBotDisconnect: false.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-03-11T16:48:58Z

@mattieruth I've opened a new pull request, #186, to work on those changes. Once the pull request is ready, I'll request review from you.

…e option to stay connected

Co-authored-by: mattieruth <4050826+mattieruth@users.noreply.github.com>

mattieruth requested a review from Copilot March 11, 2026 16:37

mattieruth added the client-js label Mar 11, 2026

Copilot started reviewing on behalf of mattieruth March 11, 2026 16:38 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

mattieruth mentioned this pull request Mar 11, 2026

fix(small-webrtc,websocket): Fix bot disconnection logic to match Daily pipecat-ai/pipecat-client-web-transports#101

Open

Copilot AI mentioned this pull request Mar 11, 2026

test: add coverage for disconnectOnBotDisconnect behavior #186

Merged

mattieruth force-pushed the mrkb/disconnect-with-bot branch from f8bd058 to bf6c51b Compare March 11, 2026 16:56

mattieruth and others added 5 commits March 11, 2026 14:49

feat(js): disconnect the client when the bot disconnects, but give th…

9e43a28

…e option to stay connected

fix: fix vulnerabilities

ca48670

style: let's be lenient on how people write

63888dc

Initial plan

015de48

test: add tests for disconnectOnBotDisconnect behavior

ad1c19a

Co-authored-by: mattieruth <4050826+mattieruth@users.noreply.github.com>

mattieruth force-pushed the mrkb/disconnect-with-bot branch from 32be552 to ad1c19a Compare March 11, 2026 18:49

mattieruth requested review from Regaddi and filipi87 March 12, 2026 13:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Disconnect the client when the bot disconnects, with option to disable#185

Disconnect the client when the bot disconnects, with option to disable#185
mattieruth wants to merge 5 commits intomainfrom
mrkb/disconnect-with-bot

mattieruth commented Mar 11, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

mattieruth Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

mattieruth Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

mattieruth Mar 11, 2026

Uh oh!

Copilot AI commented Mar 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	botDisconnected: (participant?: Participant) => void;
	botDisconnected: (participant: Participant) => void;

	onBotDisconnected: (participant?: Participant) => void;
	onBotDisconnected: (participant: Participant) => void;

-   * Default to true
+   * Default to true.
+   *
+   * NOTE: This default of `true` is a breaking change compared to earlier
+   * versions, where the client would remain connected when the bot
+   * disconnected unless this behavior was explicitly requested.
+   * If you rely on the previous behavior, explicitly set
+   * `disconnectOnBotDisconnect: false` when creating the client.

-          this.disconnect();
+          this.disconnect().catch((error) => {
+            logger.error("Failed to disconnect client after bot disconnected", error);
+          });

Conversation

mattieruth commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

mattieruth Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

mattieruth Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

mattieruth Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Mar 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mattieruth commented Mar 11, 2026 •

edited

Loading