http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

http: fix keylog listener setup on existing agent sockets - #65066

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets
Aug 17, 2026
Merged

http: fix keylog listener setup on existing agent sockets#65066
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
shani-singh1:http-agent-keylog-existing-sockets

Conversation

@shani-singh1

Copy link
Copy Markdown
Contributor

maybeEnableKeylog() runs as the agent's 'newListener' handler and attaches the agent's keylog handler to the sockets the agent already owns:

// Existing sockets will start listening on keylog now.constsockets=ObjectValues(this.sockets);for(leti=0;i<sockets.length;i++){sockets[i].on('keylog',this[kOnKeylog]);}

agent.sockets maps a name to an array of sockets, so ObjectValues() yields arrays, not sockets, and .on() is called on an array. Agent.prototype.destroy() in the same file gets this right with a nested walk over both maps.

Two things follow. Adding a 'keylog' listener to an agent that already owns a socket throws, and because the throw happens inside the 'newListener' handler it propagates out of agent.on()before the listener is stored, so the caller gets an exception and no listener. Separately, agent.freeSockets is never visited, so idle keep-alive sockets never start listening even once the crash is out of the way.

Reproduction

consthttp=require('http');constserver=http.createServer((req,res)=>setTimeout(()=>res.end('ok'),300));server.listen(0,'127.0.0.1',()=>{constagent=newhttp.Agent({keepAlive: true});constreq=http.get({host: '127.0.0.1',port: server.address().port, agent },(res)=>res.resume());req.on('error',()=>{});req.on('socket',()=>setImmediate(()=>{console.log('bucket is an Array :',Array.isArray(Object.values(agent.sockets)[0]));try{agent.on('keylog',()=>{});console.log('agent.on("keylog") : OK');}catch(err){console.log('agent.on("keylog") : THREW '+err.constructor.name+': '+err.message);}console.log('keylog listeners :',agent.listenerCount('keylog'),'(expected 1)');agent.destroy();server.close();process.exit(0);}));});

On v24.11.1:

bucket is an Array : true
agent.on("keylog") : THREW TypeError: sockets[i].on is not a function
keylog listeners : 0 (expected 1)

The documented 'keylog' event on https.Agent is therefore unusable on any agent that has already opened a socket, which is the normal case for a long-lived agent. The existing coverage in test/parallel/test-https-agent-keylog.js registers the listener on https.globalAgent before any request is made, so agent.sockets is empty and the loop body never runs.

Change

Walk both maps the same way Agent.prototype.destroy() does.

Verification

Running the old and new loop bodies against a real http.Agent holding one idle socket and one in-flight socket:

sockets in freeSockets : 1
sockets in sockets : 1
total existing sockets : 2
OLD loop : THREW TypeError: sockets[i].on is not a function
NEW loop : no throw
sockets wired by NEW : 2 / 2 (expected all)

The added test uses two servers so the sockets get different names and one stays parked in freeSockets rather than being reused. It fails on main with the TypeError above at the agent.on('keylog', ...) line, and passes with this change.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added http Issues and PRs related to the http subsystem. needs-ci PRs that need a full CI run. labels Aug 6, 2026
@codecov

codecovBot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.28%. Comparing base (51c0d94) to head (9058cd0).
⚠️ Report is 180 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #65066 +/- ##
==========================================
- Coverage 90.30% 90.28% -0.03% 
==========================================
Files 759 759 Lines 247644 247761 +117 Branches 46687 46716 +29 ==========================================
+ Hits 223645 223693 +48 - Misses 15474 15520 +46 - Partials 8525 8548 +23 
Files with missing linesCoverage Δ
lib/_http_agent.js96.59% <100.00%> (+0.46%)⬆️

... and 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pimterrypimterry left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work, thanks for fixing this @shani-singh1!

Commit linting is failing as there's no sign-off trailer, so you'll need to git commit --amend -s and then force push to update it.

`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
@shani-singh1
shani-singh1force-pushed the http-agent-keylog-existing-sockets branch from 898e685 to 9058cd0CompareAugust 6, 2026 11:18
@shani-singh1

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

Amended with -s and force pushed, so the head is now 9058cd0 and carries the sign-off trailer. I applied the same to my three other open PRs (#65064, #65065, #65067) since they would have hit the same lint failure once CI ran on them.

@pimterrypimterry added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Aug 6, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pimterrypimterry added the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 45d6d31 into nodejs:mainAug 17, 2026
75 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 45d6d31

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 17, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
`maybeEnableKeylog()` runs as the agent's `'newListener'` handler and
attaches the agent's keylog handler to the sockets the agent already
owns. `agent.sockets` maps a name to an array of sockets, but the loop
treated those arrays as sockets and called `.on()` on them.
Adding a `'keylog'` listener to an agent that already owned a socket
therefore threw `TypeError: sockets[i].on is not a function` out of
`agent.on('keylog', ...)`. Since the throw happened inside the
`'newListener'` handler it propagated before the listener was stored,
so the caller got an exception and no listener. Sockets parked in
`agent.freeSockets` were never visited at all.
Walk both maps the way `Agent.prototype.destroy()` does.
Signed-off-by: Shani Singh <teamdeveloperworld@gmail.com>
PR-URL: #65066
Reviewed-By: Tim Perry <pimterry@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.httpIssues and PRs related to the http subsystem.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shani-singh1@nodejs-github-bot@pimterry