Warn on connection TTL being greater than the server keep-alive timeout#597
Merged
peter-leonov-ch merged 17 commits intomainfrom Mar 9, 2026
Merged
Warn on connection TTL being greater than the server keep-alive timeout#597peter-leonov-ch merged 17 commits intomainfrom
peter-leonov-ch merged 17 commits intomainfrom
Conversation
in JS undefined can come in places where null is expected, no need to check for the exact value here.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds observability around HTTP keep-alive timeout mismatches by capturing the server-provided keep-alive timeout (via the Keep-Alive header) and emitting a warning when the configured client-side idle socket TTL exceeds it, which can lead to ECONNRESET on socket reuse.
Changes:
- Parse the
Keep-Aliveresponse header to store the server keep-alive timeout per socket and log it at TRACE. - Emit a WARN log on
ECONNRESETwhenkeep_alive.idle_socket_ttlis greater than the server keep-alive timeout. - Add an integration test for the header parsing + warning behavior, and document the change in the changelog.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| packages/client-node/src/connection/node_base_connection.ts | Tracks server keep-alive timeout from response headers and logs a warning on ECONNRESET when TTL > server timeout. |
| packages/client-node/src/config.ts | Updates keep-alive TTL documentation text. |
| packages/client-node/tests/integration/node_keep_alive_header.test.ts | New integration test covering header parsing and warning emission. |
| CHANGELOG.md | Adds a 1.19.0 entry documenting the new warning and reproduction steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/client-node/__tests__/integration/node_keep_alive_header.test.ts
Outdated
Show resolved
Hide resolved
packages/client-node/__tests__/integration/node_keep_alive_header.test.ts
Outdated
Show resolved
Hide resolved
packages/client-node/__tests__/integration/node_keep_alive_header.test.ts
Outdated
Show resolved
Hide resolved
packages/client-node/__tests__/integration/node_keep_alive_header.test.ts
Show resolved
Hide resolved
packages/client-node/__tests__/integration/node_keep_alive_header.test.ts
Outdated
Show resolved
Hide resolved
should be enough to see that values go through the rest should be tested by core
mshustov
reviewed
Mar 5, 2026
| this.params.keep_alive.idle_socket_ttl > serverTimeoutMs | ||
| ) { | ||
| log_writer.warn({ | ||
| message: `${op}: idle socket TTL is greater than server keep-alive timeout, try setting idle socket TTL to a value lower than the server keep-alive timeout to prevent unexpected connection resets, see https://c.house/js_keep_alive_econnreset for more details.`, |
Member
There was a problem hiding this comment.
do we know if url shortener detects hits on broken URLs?
Collaborator
Author
There was a problem hiding this comment.
Likely not, let me double check.
Co-authored-by: Copilot <[email protected]>
mshustov
approved these changes
Mar 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adding a descriptive warning log for cases when the client and server disagree on keep-alive connection timeout. By design the client should respect the timeout coming from the server and keep it smaller to avoid race conditions.
Next steps:
Checklist
Delete items not relevant to your PR: