[talker_dio_logger] added logging of request's extra, configurable #375
Conversation
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
Reviewer's GuideAdds a new configurable option to log request.extra in the Dio logger: introduces and propagates a printRequestExtra setting, updates log formatter to include JSON-formatted extra data when enabled, and adds corresponding tests. Sequence Diagram: Logging Request 'extra' ConditionallysequenceDiagram
participant DioClient
participant TalkerDioLogger as "TalkerDioLogger (Interceptor)"
participant RequestOptions
participant Settings as "TalkerDioLoggerSettings"
participant DioRequestLog as "DioRequestLog (Log Object)"
participant Talker as "Talker (Logging Backend)"
DioClient->>TalkerDioLogger: onRequest(options, handler)
activate TalkerDioLogger
TalkerDioLogger->>DioRequestLog: new DioRequestLog(options, settings)
activate DioRequestLog
DioRequestLog->>Settings: Reads settings.printRequestExtra
alt if settings.printRequestExtra is true
DioRequestLog->>RequestOptions: Reads options.extra
Note right of DioRequestLog: Includes 'extra' in log message
end
DioRequestLog-->>TalkerDioLogger: log object (message generated)
deactivate DioRequestLog
TalkerDioLogger->>Talker: log(log object)
TalkerDioLogger->>DioClient: handler.next(options)
deactivate TalkerDioLogger
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @lucavenir - I've reviewed your changes - here's some feedback:
- Consider adding error handling in the catch block for extra encoding failures so you can log a fallback message instead of silently swallowing exceptions.
- Add a test to verify that extras are not logged when
printRequestExtrais false (default), ensuring the new flag behaves correctly.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Frezyx
approved these changes
Jun 2, 2025
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #375 +/- ##
==========================================
+ Coverage 98.17% 98.61% +0.43%
==========================================
Files 28 3 -25
Lines 603 144 -459
==========================================
- Hits 592 142 -450
+ Misses 11 2 -9 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
solves #357
Summary by Sourcery
Introduce a configurable printRequestExtra flag to TalkerDioLoggerSettings and update the interceptor and log generator to include request.extra data in logs when enabled.
New Features:
Tests: