REFACTOR: Migrate Connection string sanitization from regex to parser-based#522
Open
bewithgaurav wants to merge 5 commits intomainfrom
Open
REFACTOR: Migrate Connection string sanitization from regex to parser-based#522bewithgaurav wants to merge 5 commits intomainfrom
bewithgaurav wants to merge 5 commits intomainfrom
Conversation
…-based approach - move sanitize_connection_string() to connection_string_parser.py using _ConnectionStringParser for correct ODBC braced-value handling - helpers.py retains thin delegate for backward compatibility - connection.py imports directly from connection_string_parser - on parse failure, redact entire string instead of regex fallback - add 5 new tests for braced values, escaped braces, and edge cases
9a9c4c7 to
9916cb1
Compare
📊 Code Coverage Report
Diff CoverageDiff: main...HEAD, staged and unstaged changes
Summary
📋 Files Needing Attention📉 Files with overall lowest coverage (click to expand)mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.pybind.ddbc_bindings.h: 67.8%
mssql_python.row.py: 70.5%
mssql_python.pybind.logger_bridge.hpp: 70.8%
mssql_python.pybind.ddbc_bindings.cpp: 74.2%
mssql_python.pybind.connection.connection.cpp: 75.8%
mssql_python.__init__.py: 77.3%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.pybind.connection.connection_pool.cpp: 79.6%
mssql_python.connection.py: 85.3%🔗 Quick Links
|
Contributor
There was a problem hiding this comment.
Pull request overview
Refactors connection string sanitization to use the existing ODBC connection string parser/builder instead of a regex, improving correctness for braced values and escaped braces per MS-ODBCSTR.
Changes:
- Added a parser-based
sanitize_connection_string()implementation inconnection_string_parser.pywith full redaction on parse failure. - Kept
helpers.sanitize_connection_string()as a thin delegate for backwards compatibility and adjustedconnection.pyto import the new implementation directly. - Expanded logging sanitization tests to cover braced values, escaped braces, end-of-string PWD, and malformed strings.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
tests/test_007_logging.py |
Adds/updates unit tests for password masking (including braced and malformed cases). |
mssql_python/helpers.py |
Replaces regex sanitizer with a delegation wrapper to the parser-based implementation. |
mssql_python/connection_string_parser.py |
Introduces the new parser-based sanitizer and sensitive key list. |
mssql_python/connection.py |
Updates imports to use the new sanitizer directly for connection logging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Replaces the regex-based
sanitize_connection_string()with a parser-based implementationthat uses
_ConnectionStringParserto correctly handle all ODBC connection string valueformats including braced values per ODBC spec.
Changes
sanitize_connection_string()toconnection_string_parser.pywhere it naturallybelongs alongside the parser it depends on — eliminates circular import between helpers
and parser modules
helpers.pyretains a thin delegate for backward compatibilityconnection.pyimports directly fromconnection_string_parserTesting
TestPasswordSanitizationtests pass