Repository navigation
FIX: Bound pooled connection checkout on unresponsive sockets - #859
Open
Jahnvi Thakkar (jahnvi480) wants to merge 3 commits into
Open
Jahnvi Thakkar (jahnvi480) wants to merge 3 commits into
Jahnvi Thakkar (jahnvi480) wants to merge 3 commits into
Conversation
Apply a temporary native connection timeout during pooled reset and autocommit configuration, then restore it on success. Replace a failed candidate instead of probing all idle sockets sequentially. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
PR Performance Report✅ No regression detectedNo consistent slowdowns detected across all 2 environments. 0 IMPROVEMENTS 0 SLOWDOWNS 2/2 ENVIRONMENTS Coverage: 2 of 2 environments completed. Advisory result; does not block merging. Performance diagnosticsPhase times are inclusive diagnostics and must not be added together. They identify where measured time changed, not why it changed. Unix / SQL Server 2022Connection opening: no measured phase delta. Call changes: ddbc::Connection::setAutocommit (added, removed, or intermittent); ddbc::ConnectionHandle::setAutocommit (added, removed, or intermittent). Unix / SQL Server 2025Connection opening: no measured phase delta. Call changes: ddbc::Connection::setAutocommit (added, removed, or intermittent); ddbc::ConnectionHandle::setAutocommit (added, removed, or intermittent). All database tasks and timingsUnix / SQL Server 2022
Unix / SQL Server 2025
Build and measurement detailsPR head:
A consistent change requires more than 20% median paired movement, at least 1 ms between the median runtimes, and at least 80% of pairs exceeding the relative threshold in the same direction. A slowdown without enough pair agreement is reported as inconsistent. The displayed change is the median of paired before-and-after ratios. It is not recalculated from the two displayed median runtimes. Both revisions use profiling-enabled builds on the same agent and database, with alternating order and discarded warmups. Results are diagnostic and do not represent production-wheel latency. Raw samples and logs are attached to the ADO run as |
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The reported native crash remains unexplained, and Windows/macOS timeout and cleanup behavior still needs validation.
1 open issue
What changed in this PR
Addresses #854 by limiting pooled-connection validation on unresponsive sockets without imposing an end-to-end connect() deadline.
Changes:
- Applies a temporary native timeout during reset and autocommit configuration, restoring it after successful checkout.
- Opens a replacement after failed validation instead of probing every stale idle connection.
- Adds stalled-socket and isolation-reset regressions, adjusts exception mocks, and documents timeout behavior.
| File | Description |
|---|---|
tests/test_009_pooling.py |
Adds stalled-checkout, timeout-restoration, and SQL isolation-reset coverage. |
tests/test_006_exceptions.py |
Injects close failures after connection construction. |
README.md |
Documents checkout timeout selection and limitations. |
mssql_python/pybind/connection/connection.h |
Extends reset to accept timeout and autocommit settings. |
mssql_python/pybind/connection/connection.cpp |
Applies and restores the temporary native timeout. |
mssql_python/pybind/connection/connection_pool.cpp |
Selects validation settings and replaces failed candidates directly. |
mssql_python/connection.py |
Passes autocommit into native checkout and documents timeout semantics. |
Review effort: Balanced
Read SQL_ATTR_CONNECTION_TIMEOUT through a private native accessor and check zero and nonzero values on the same reused SQL Server session. Mutation tests reject omitted restoration and unconditional zero. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
📊 Code Coverage Report
Diff CoverageDiff: main...HEAD, staged and unstaged changes
Summary
mssql_python/pybind/connection/connection.cppLines 606-616 606 }
607 clearResultMetadata();
608 // Login and statement timeouts do not bound connection-attribute calls.
609 // Keep a finite connection timeout through reset and lease configuration;
! 610 // retain it on failure so discarding the candidate is bounded too (#854).
! 611 SQLULEN originalTimeout = 0;
! 612 SQLRETURN ret = SQLGetConnectAttr_ptr(_dbcHandle->get(), SQL_ATTR_CONNECTION_TIMEOUT,
613 &originalTimeout, 0, nullptr);
614 if (!SQL_SUCCEEDED(ret)) {
615 LOG("Failed to read pooled connection timeout (ret=%d). Marking as dead.", ret);
616 return false;Lines 616-626 616 return false;
617 }
618 {
619 py::gil_scoped_release release;
! 620 ret = SQLSetConnectAttr_ptr(
! 621 _dbcHandle->get(), SQL_ATTR_CONNECTION_TIMEOUT,
! 622 reinterpret_cast<SQLPOINTER>(static_cast<SQLULEN>(timeoutSeconds)), SQL_IS_UINTEGER);
623 }
624 if (!SQL_SUCCEEDED(ret)) {
625 LOG("Failed to set pooled connection timeout (ret=%d). Marking as dead.", ret);
626 return false;Lines 664-674 664 }
665 setAutocommit(autocommit);
666 {
667 py::gil_scoped_release release;
! 668 ret = SQLSetConnectAttr_ptr(
! 669 _dbcHandle->get(), SQL_ATTR_CONNECTION_TIMEOUT,
! 670 reinterpret_cast<SQLPOINTER>(originalTimeout), SQL_IS_UINTEGER);
671 }
672 if (!SQL_SUCCEEDED(ret)) {
673 LOG("Failed to restore pooled connection timeout (ret=%d). Marking as dead.", ret);
674 return false;Lines 937-947 937 SQLULEN ConnectionHandle::getConnectionTimeout() const {
938 if (!_conn) {
939 ThrowStdException("Connection object is not initialized");
940 }
! 941 SQLULEN timeout = 0;
! 942 const auto& handle = _conn->getDbcHandle();
! 943 SQLRETURN ret = SQLGetConnectAttr_ptr(handle->get(), SQL_ATTR_CONNECTION_TIMEOUT,
944 &timeout, 0, nullptr);
945 if (!SQL_SUCCEEDED(ret)) {
946 ErrorInfo error = SQLCheckError_Wrap(SQL_HANDLE_DBC, handle, ret);
947 ThrowStdException("Failed to read connection timeout: " + error.ddbcErrorMsg);Lines 946-955 946 ErrorInfo error = SQLCheckError_Wrap(SQL_HANDLE_DBC, handle, ret);
947 ThrowStdException("Failed to read connection timeout: " + error.ddbcErrorMsg);
948 }
949 return timeout;
! 950 }
! 951
952 py::object ConnectionHandle::getInfo(SQLUSMALLINT infoType) const {
953 PERF_TIMER("ConnectionHandle::getInfo");
954 if (!_conn) {
955 ThrowStdException("Connection object is not initialized");mssql_python/pybind/connection/connection_pool.cppLines 186-197 186 // expiry) before the threshold, so the safe-reuse path above
187 // is taken in practice. We favor never handing out a token
188 // that may expire mid-query over avoiding the churn.
189 candidate->setTokenExpiry(fresh_expiry);
! 190 if (candidate->isAlive()) {
! 191 validation_attempted = true;
! 192 reuse_candidate = candidate->reset(validation_timeout, autocommit);
! 193 }
194 if (!reuse_candidate) {
195 // The token is still valid but the socket is dead
196 // (isAlive()/reset() failed). We already minted the
197 // fresh attrs, so carry them forward and let Phase 3Lines 269-280 269 ++_current_size;
270 needs_connect = true;
271 break;
272 }
! 273 if (validation_attempted) {
! 274 throw std::runtime_error(
! 275 "ConnectionPool::acquire: pool size limit reached");
! 276 }
277 // A concurrent acquire reserved the slot freed by token rotation.
278 // Retry token comparison with another idle candidate.
279 }
280 }📋 Files Needing Attention📉 Files with overall lowest coverage (click to expand)mssql_python.pybind.performance_counter.hpp: 0.7%
mssql_python.pybind.logger_bridge.cpp: 57.9%
mssql_python.pybind.ddbc_bindings.h: 62.6%
mssql_python.pybind.logger_bridge.hpp: 70.8%
mssql_python.pybind.connection.connection_pool.cpp: 81.3%
mssql_python.pybind.connection.connection.cpp: 82.5%
mssql_python.logging.py: 86.2%
mssql_python.pooling.py: 90.1%
mssql_python.pybind.fetch_temporal.hpp: 92.1%
mssql_python.cursor.py: 92.5%🔗 Quick Links
|
Sumit Sarabhai (sumitmsft)
approved these changes
Oct 22, 2026
Sumit Sarabhai (sumitmsft)
left a comment
Sumit Sarabhai (sumitmsft)
left a comment
Contributor
There was a problem hiding this comment.
Reviewed the PR for correctness, security, reliability, performance, test coverage, repository conventions, and applicable architecture and design specifications. No actionable issues were identified. The implementation is consistent with repository standards and the applicable approved design requirements.
Recommendation: Approve
Jahnvi Thakkar (jahnvi480)
enabled auto-merge (squash)
October 23, 2026 04:46
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.
Work Item / Issue Reference
Summary
Bound pooled connection reset and autocommit configuration using a temporary native connection timeout. Use the positive login timeout (explicit attrs_before takes precedence), or a 15-second validation default, and restore the previous connection timeout on success. After validation fails, open a replacement rather than probing every stale idle socket sequentially. Preserve isolation/transaction cleanup and document that cancellation, cleanup, and replacement login can add time: this is not an end-to-end connect deadline.
Add stalled-socket regressions covering both autocommit modes, one/three stale sockets, timeout precedence, the finite default, and timeout restoration. Extend isolation reset coverage to SQL SET statements and adjust close-error mocks to inject failures after construction.
Validation (Linux x64, Python 3.13, SQL Server 2022):
bash build.shand subsequentcmake --build /work/mssql_python/pybind/build --config Release -j2: passed; rebuilt native extension used for testing.python -m pytest -v --tb=short: 5,537 passed, 167 skipped, 42 deselected. Linux test copy used LF shell scripts to avoid Windows checkout CRLF failures.python -m pre_commit run black-check --all-files --hook-stage pre-push: passed.Fixes: #854