blackteay/gin
3
0
Fork 0
mirror of https://github.com/gin-gonic/gin.git synced 2025-10-17 05:42:09 +08:00
Code Issues Projects Releases Wiki Activity

Logger skip paths use Context.fullPath

Browse Source 
This is more flexible and is breaking only in
very rare cases.

Restore original behavior

Update logger path skipping tests
This commit is contained in:
Hanyu Cui 2022-05-05 22:31:01 -07:00
parent 90e7073d56
commit 40991b4a82
2 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
logger.go
View File

@ -234,13 +234,14 @@ func LoggerWithConfig(conf LoggerConfig) HandlerFunc {
// Start timer // Start timer
start := time.Now() start := time.Now()
path := c.Request.URL.Path path := c.Request.URL.Path
fullPath := c.FullPath()
raw := c.Request.URL.RawQuery raw := c.Request.URL.RawQuery
// Process request // Process request
c.Next() c.Next()
// Log only when path is not being skipped // Log only when fullPath is not being skipped
if _, ok := skip[path]; !ok { if _, ok := skip[fullPath]; !ok {
param := LogFormatterParams{ param := LogFormatterParams{
Request: c.Request, Request: c.Request,
isTerm: isTerm, isTerm: isTerm,

28
logger_test.go
View File

@ -384,16 +384,26 @@ func TestErrorLogger(t *testing.T) {
func TestLoggerWithWriterSkippingPaths(t *testing.T) { func TestLoggerWithWriterSkippingPaths(t *testing.T) {
buffer := new(bytes.Buffer) buffer := new(bytes.Buffer)
router := New() router := New()
router.Use(LoggerWithWriter(buffer, "/skipped")) router.Use(LoggerWithWriter(buffer, "/skipped", "/skippedUsers/:id"))
router.GET("/logged", func(c *Context) {}) router.GET("/logged", func(c *Context) {})
router.GET("/loggedUsers/:id", func(c *Context) {})
router.GET("/skipped", func(c *Context) {}) router.GET("/skipped", func(c *Context) {})
router.GET("/skippedUsers/:id", func(c *Context) {})
PerformRequest(router, "GET", "/logged") PerformRequest(router, "GET", "/logged")
assert.Contains(t, buffer.String(), "200") assert.Contains(t, buffer.String(), "200")
buffer.Reset()
PerformRequest(router, "GET", "/loggedUsers/2")
assert.Contains(t, buffer.String(), "200")
buffer.Reset() buffer.Reset()
PerformRequest(router, "GET", "/skipped") PerformRequest(router, "GET", "/skipped")
assert.Contains(t, buffer.String(), "") assert.Equal(t, "", buffer.String())
buffer.Reset()
PerformRequest(router, "GET", "/skippedUsers/3")
assert.Equal(t, "", buffer.String())
} }
func TestLoggerWithConfigSkippingPaths(t *testing.T) { func TestLoggerWithConfigSkippingPaths(t *testing.T) {
@ -401,17 +411,27 @@ func TestLoggerWithConfigSkippingPaths(t *testing.T) {
router := New() router := New()
router.Use(LoggerWithConfig(LoggerConfig{ router.Use(LoggerWithConfig(LoggerConfig{
Output: buffer, Output: buffer,
SkipPaths: []string{"/skipped"}, SkipPaths: []string{"/skipped", "/skippedUsers/:id"},
})) }))
router.GET("/logged", func(c *Context) {}) router.GET("/logged", func(c *Context) {})
router.GET("/loggedUsers/:id", func(c *Context) {})
router.GET("/skipped", func(c *Context) {}) router.GET("/skipped", func(c *Context) {})
router.GET("/skippedUsers/:id", func(c *Context) {})
PerformRequest(router, "GET", "/logged") PerformRequest(router, "GET", "/logged")
assert.Contains(t, buffer.String(), "200") assert.Contains(t, buffer.String(), "200")
buffer.Reset()
PerformRequest(router, "GET", "/loggedUsers/2")
assert.Contains(t, buffer.String(), "200")
buffer.Reset() buffer.Reset()
PerformRequest(router, "GET", "/skipped") PerformRequest(router, "GET", "/skipped")
assert.Contains(t, buffer.String(), "") assert.Equal(t, "", buffer.String())
buffer.Reset()
PerformRequest(router, "GET", "/skippedUsers/3")
assert.Equal(t, "", buffer.String())
} }
func TestDisableConsoleColor(t *testing.T) { func TestDisableConsoleColor(t *testing.T) {