fix: reject nested DSN query parameters - #59
Open
trearcul wants to merge 1 commit into
Open
Conversation
parse_str() turns a query such as "?heartbeat[]=120" into an array value, and casting that to int in Connection::fromDsn() silently evaluates to 1 on php 8 with no warning or notice at all. Such a DSN therefore configured a 1 second heartbeat instead of 120, with nothing to point at the cause. Reject nested parameters in the Dsn constructor, next to the existing malformed/incomplete/invalid scheme validation, naming the offending keys so a config typo is obvious. This also makes the string[] annotation on Dsn::$parameters true again, so the previously widened array<array<mixed>|string> is reverted and consumers keep reading plain strings.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #59 +/- ##
==========================================
+ Coverage 51.98% 52.63% +0.65%
==========================================
Files 29 29
Lines 654 663 +9
==========================================
+ Hits 340 349 +9
Misses 314 314 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR hardens DSN parsing by rejecting nested query parameters (e.g., heartbeat[]=120) that parse_str() would otherwise decode into arrays, preventing silent misconfiguration when those values are later cast to integers.
Changes:
- Added validation in
Dsnto reject any DSN query parameters whose decoded value is not a string, and surface the offending key(s) in an exception. - Introduced a dedicated
InvalidDsn::nestedParameters()exception factory for clearer configuration error reporting. - Added a PHPUnit test covering nested DSN query parameters.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/Configuration/DsnTest.php | Adds coverage for rejecting nested query parameters in DSNs. |
| src/Exception/InvalidDsn.php | Adds a new exception factory to report nested DSN query keys. |
| src/Configuration/Dsn.php | Validates decoded DSN query parameters are single (string) values and rejects nested structures. |
Suppressed comments (1)
src/Configuration/Dsn.php:122
getParameters()returns an associative map of query param name => value, so@return string[]is incorrect (it implies a list).
/** @return string[] */
public function getParameters(): array
{
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+40
to
41
| /** @var string[] */ | ||
| private $parameters = []; |
Comment on lines
+29
to
+31
| /** @param array<int|string> $keys */ | ||
| public static function nestedParameters(array $keys): self | ||
| { |
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.
parse_str() turns a query such as "?heartbeat[]=120" into an array value, and casting that to int in Connection::fromDsn() silently evaluates to 1 on php 8 with no warning or notice at all. Such a DSN therefore configured a 1 second heartbeat instead of 120, with nothing to point at the cause.
Reject nested parameters in the Dsn constructor, next to the existing malformed/incomplete/invalid scheme validation, naming the offending keys so a config typo is obvious.
This also makes the string[] annotation on Dsn::$parameters true again, so the previously widened array<array|string> is reverted and consumers keep reading plain strings.