feat(reqlog): added WithSkip #47
Merged
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 Guide by SourceryThis pull request introduces a skip functionality for the request logging middleware by adding a new WithSkip option, which enables conditional bypassing of log messages based on the request context. The changes span test updates, middleware modifications, and documentation improvements. Sequence diagram for WithSkip logic in reqlog middlewaresequenceDiagram
participant C as Client Request
participant M as ReqLog Middleware
participant N as Next Handler
C->>M: Incoming Request
M->>M: Check if SkipFunc is set
alt SkipFunc returns true
M->>N: Call next(c) without logging
else SkipFunc returns false
M->>M: Record start time
M->>N: Call next(c)
M->>M: Log request details
end
Class diagram for Options struct and WithSkip functionclassDiagram
class Options {
+GetVisitor(c: *xun.Context) string
+GetUser(c: *xun.Context) string
+Format: Format
+SkipFunc: func(c: *xun.Context) bool
}
class WithSkip {
+WithSkip(f: func(c: *xun.Context) bool) Option
}
Options --> WithSkip : configured by
note for Options "Added SkipFunc field to support conditional log skipping"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @cnlangzi - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a benchmark to evaluate the performance impact of the
WithSkipoption.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 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.
|
Here's the code health analysis summary for commits Analysis Summary
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #47 +/- ##
==========================================
+ Coverage 93.02% 93.10% +0.07%
==========================================
Files 49 49
Lines 1892 1899 +7
==========================================
+ Hits 1760 1768 +8
+ Misses 98 97 -1
Partials 34 34
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Changed
Fixed
Added
WithSkipTests
Tasks to complete before merging PR:
make unit-testto check for any regressions 📋make lintto check for any issuesSummary by Sourcery
New Features:
WithSkipoption to the request logger to allow skipping logging for specific requests.