Skip to content

Prevent 'connected' event listener accumulation on reconnect by using .once() instead of .on() #3211

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

Open
kuan121 wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −1
Open

Prevent 'connected' event listener accumulation on reconnect by using .once() instead of .on() #3211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3442918
prevent 'connected' event listener accumulation on reconnect by using…
kuan121 Feb 21, 2026
4aeae98
prevent duplicate event emissions on flaky connections with multiple …
kuan121 Feb 21, 2026
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
3 changes: 3 additions & 0 deletions packages/xrpl/HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr

## Unreleased

### Fixed
* Fix event listener accumulation bug where `'connected'` event handlers would fire multiple times after each reconnection. The fix cleans up stale listeners from previous reconnect attempts to prevent duplicate event emissions on flaky connections with multiple sequential reconnect attempts.

## 4.6.0 (2026-02-12)

### Added
Expand Down
13 changes: 12 additions & 1 deletion packages/xrpl/src/client/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,19 @@ class Client extends EventEmitter<EventTypes> {
this.emit('error', errorCode, errorMessage, data)
})

let connectedListener: (() => void) | undefined
this.connection.on('reconnect', () => {
this.connection.on('connected', () => this.emit('connected'))
// Clean up any stale listener from previous reconnect attempt
// This prevents duplicate event emissions when multiple reconnect attempts
// occur before a successful connection (e.g., on flaky networks)
if (connectedListener !== undefined) {
this.connection.off('connected', connectedListener)
}

connectedListener = (): boolean => this.emit('connected')
// Use .once() so the listener auto-removes after firing
// This prevents listener accumulation across reconnections
this.connection.once('connected', connectedListener)
})

this.connection.on('disconnected', (code: number) => {
Expand Down
Loading