feat(request): Enhance PSR-7 integration with detailed method documentation and improved fallback handling. #19
Conversation
…tation and improved fallback handling.
WalkthroughA new enum case was added to the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Request
participant ServerRequestAdapter
participant YiiRequest
Client->>Request: setPsr7Request(ServerRequestInterface)
Request->>ServerRequestAdapter: Store adapter
Client->>Request: getBodyParams()/getHeaders()/etc.
alt Adapter is set
Request->>ServerRequestAdapter: Delegate method call
ServerRequestAdapter-->>Request: Return PSR-7 data
else Adapter not set
Request->>YiiRequest: Call parent Yii2 method
YiiRequest-->>Request: Return Yii2 data
end
Client->>Request: getPsr7Request()
alt Adapter is set
Request-->>Client: Return PSR-7 ServerRequest
else Adapter not set
Request-->>Client: Throw InvalidConfigException with Message::PSR7_REQUEST_ADAPTER_NOT_SET
end
Estimated code review effort4 (60–120 minutes) Possibly related PRs
Suggested labels
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #19 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 99 99
===========================================
Files 6 6
Lines 252 252
===========================================
Hits 252 252 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/http/Request.php (1)
511-522: Consider null-safe handling for file sizeThe
getSize()method on PSR-7UploadedFileInterfacecan returnnullif the size is unknown. Consider adding a null-coalescing operator for consistency with other properties:- 'size' => $psrFile->getSize(), + 'size' => $psrFile->getSize() ?? 0,
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/exception/Message.php(1 hunks)src/http/Request.php(13 hunks)tests/http/RequestTest.php(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: terabytesoftw
PR: yii2-extensions/psr-bridge#6
File: tests/http/RequestTest.php:1536-1552
Timestamp: 2025-07-20T16:35:15.300Z
Learning: In the yii2-extensions/psr-bridge project, the base TestCase class already handles $_SERVER cleanup in setUp() and tearDown() methods, so individual test methods that extend TestCase don't need manual $_SERVER restoration.
Learnt from: terabytesoftw
PR: yii2-extensions/psr-bridge#6
File: tests/http/RequestTest.php:1536-1552
Timestamp: 2025-07-20T16:35:15.300Z
Learning: In the yii2-extensions/psr-bridge project, the base TestCase class already handles $_SERVER cleanup in setUp() and tearDown() methods (lines 28 and 32), so individual test methods that extend TestCase don't need manual $_SERVER restoration.
tests/http/RequestTest.php (3)
Learnt from: terabytesoftw
PR: #6
File: tests/http/RequestTest.php:1536-1552
Timestamp: 2025-07-20T16:35:15.300Z
Learning: In the yii2-extensions/psr-bridge project, the base TestCase class already handles $_SERVER cleanup in setUp() and tearDown() methods, so individual test methods that extend TestCase don't need manual $_SERVER restoration.
Learnt from: terabytesoftw
PR: #6
File: tests/http/RequestTest.php:1536-1552
Timestamp: 2025-07-20T16:35:15.300Z
Learning: In the yii2-extensions/psr-bridge project, the base TestCase class already handles $_SERVER cleanup in setUp() and tearDown() methods (lines 28 and 32), so individual test methods that extend TestCase don't need manual $_SERVER restoration.
Learnt from: terabytesoftw
PR: #6
File: tests/http/RequestTest.php:1564-1578
Timestamp: 2025-07-20T16:33:57.457Z
Learning: The TestCase class in yii2-extensions/psr-bridge automatically handles $_SERVER superglobal cleanup by saving its original state before each test and restoring it afterward in setUp() and tearDown() methods. Manual $_SERVER cleanup in individual test methods is unnecessary when extending this TestCase.
src/http/Request.php (3)
Learnt from: terabytesoftw
PR: #6
File: tests/http/RequestTest.php:1536-1552
Timestamp: 2025-07-20T16:35:15.300Z
Learning: In the yii2-extensions/psr-bridge project, the base TestCase class already handles $_SERVER cleanup in setUp() and tearDown() methods, so individual test methods that extend TestCase don't need manual $_SERVER restoration.
Learnt from: terabytesoftw
PR: #6
File: tests/http/RequestTest.php:1536-1552
Timestamp: 2025-07-20T16:35:15.300Z
Learning: In the yii2-extensions/psr-bridge project, the base TestCase class already handles $_SERVER cleanup in setUp() and tearDown() methods (lines 28 and 32), so individual test methods that extend TestCase don't need manual $_SERVER restoration.
Learnt from: terabytesoftw
PR: #6
File: tests/http/RequestTest.php:1564-1578
Timestamp: 2025-07-20T16:33:57.457Z
Learning: The TestCase class in yii2-extensions/psr-bridge automatically handles $_SERVER superglobal cleanup by saving its original state before each test and restoring it afterward in setUp() and tearDown() methods. Manual $_SERVER cleanup in individual test methods is unnecessary when extending this TestCase.
🧬 Code Graph Analysis (2)
tests/http/RequestTest.php (1)
src/exception/Message.php (1)
getMessage(90-93)
src/http/Request.php (4)
src/adapter/ServerRequestAdapter.php (3)
ServerRequestAdapter(47-449)getHeaders(141-150)getQueryString(249-252)src/exception/Message.php (1)
getMessage(90-93)tests/provider/RequestProvider.php (1)
getQueryString(256-284)tests/support/FactoryHelper.php (1)
createUploadedFile(181-189)
🔇 Additional comments (5)
src/exception/Message.php (1)
53-58: LGTM!The new enum case follows the established pattern and provides a clear, standardized error message for PSR-7 adapter configuration issues.
tests/http/RequestTest.php (1)
12-12: Good consistency improvement!The test now uses the standardized error message from the enum, which improves maintainability and consistency across the codebase.
Also applies to: 1524-1524
src/http/Request.php (3)
15-57: Excellent documentation enhancement!The comprehensive class-level documentation clearly explains the PSR-7 bridge functionality, key features, and usage patterns. The property definitions are well-documented and appropriately scoped.
59-419: Comprehensive method documentation added!The detailed documentation for all public methods provides excellent clarity on:
- PSR-7 adapter behavior and fallback mechanisms
- Exception handling
- Return types and usage examples
- Compatibility considerations
This significantly improves the developer experience.
251-258: Proper use of standardized error messaging!The method correctly uses the new enum message for consistency and throws the appropriate exception when the adapter is not configured.
Summary by CodeRabbit
New Features
Bug Fixes
Tests