Skip to content

fix(session): eliminate memory leak in session managers#14972

Merged
christian-bromann merged 1 commit intowebdriverio:mainfrom
mccmrunal:fix/listener-leak
Jan 8, 2026
Merged

fix(session): eliminate memory leak in session managers#14972
christian-bromann merged 1 commit intowebdriverio:mainfrom
mccmrunal:fix/listener-leak

Conversation

@mccmrunal
Copy link
Contributor

fix #14707

Proposed changes

Fixed a memory leak in the session management layer where event listeners were not being properly removed during session reload or deletion.
The issue was caused by using Function.prototype.bind() inline when registering and unregistering event listeners (for example, browser.on('event', this.method.bind(this))).
Since .bind() creates a new function reference every time it is called, the reference used during listener removal did not match the one used during registration. As a result, listeners were never removed and accumulated with each reloadSession() call, eventually triggering a MaxListenersExceededWarning.

Refactored SessionManager, ContextManager, NetworkManager, ShadowRootManager, PolyfillManager, and DialogManager.

Stored bound listener functions in private class properties (for example, #onCommandListener) to ensure a stable reference.

Updated removeListeners() in NetworkManager to use these stored references, ensuring successful listener removal.

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

  • This change is solely for v9 and doesn't need to be back-ported
  • Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

@mccmrunal
Copy link
Contributor Author

I was working on this bug for 2-3 weeks unable to replicate it , in the process I have created 3 repos that replicate the memory leak , on which I have tested the changes which works fine on those.
If required let me know I will add those also here

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 29, 2025

Open in StackBlitz

create-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/create-wdio@14972

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@14972

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@14972

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@14972

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@14972

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@14972

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@14972

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@14972

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@14972

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@14972

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@14972

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@14972

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@14972

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@14972

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@14972

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@14972

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@14972

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@14972

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@14972

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@14972

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@14972

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@14972

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@14972

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@14972

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@14972

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@14972

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@14972

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@14972

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@14972

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@14972

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@14972

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@14972

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@14972

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@14972

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@14972

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@14972

@wdio/xvfb

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/xvfb@14972

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@14972

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@14972

commit: 19643f6

@mccmrunal mccmrunal closed this Dec 29, 2025
@mccmrunal mccmrunal reopened this Dec 29, 2025
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

🐐

@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Jan 8, 2026
@christian-bromann christian-bromann merged commit dadb94b into webdriverio:main Jan 8, 2026
117 of 118 checks passed
@wdio-bot
Copy link
Contributor

wdio-bot commented Jan 8, 2026

Hey mccmrunal 👋

Thank you for your contribution to WebdriverIO! Your pull request has been marked as an "Expensable" contribution.

We've sent you an email with further instructions on how to claim your expenses from our development fund.
Please make sure to check your spam folder as well. If you have any questions, feel free to reach out to us at expense@webdriver.io or in the contributing channel on Discord.

We are looking forward to more contributions from you in the future 🙌

Have a nice day,
The WebdriverIO Team 🤖

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Expensable $25 💸 PR: Bug Fix 🐛 PRs that contain bug fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[🐛 Bug]: MaxListenersExceededWarning: Possible EventEmitter memory leak detected

3 participants