added glob matching for ignored paths in hws

This commit is contained in:
2026-02-01 19:42:50 +11:00
parent 7ed40c7afe
commit cd29f11296
13 changed files with 833 additions and 11 deletions

View File

@@ -14,6 +14,7 @@ require (
require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/go-logr/logr v1.4.3 // indirect
github.com/gobwas/glob v0.2.3
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.19 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect

View File

@@ -9,6 +9,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=

View File

@@ -6,24 +6,25 @@ import (
"net/url"
"git.haelnorr.com/h/golib/hlog"
"github.com/gobwas/glob"
)
type logger struct {
logger *hlog.Logger
ignoredPaths []string
ignoredPaths []glob.Glob
}
// TODO: add tests to make sure all the fields are correctly set
// LogError uses the attached logger to log a HWSError
func (s *Server) LogError(err HWSError) {
if s.logger == nil {
return
}
switch err.Level {
case ErrorDEBUG:
s.logger.logger.Debug().Msg(err.Message)
s.logger.logger.Debug().Err(err.Error).Msg(err.Message)
return
case ErrorINFO:
s.logger.logger.Info().Msg(err.Message)
s.logger.logger.Info().Err(err.Error).Msg(err.Message)
return
case ErrorWARN:
s.logger.logger.Warn().Err(err.Error).Msg(err.Message)
@@ -53,10 +54,10 @@ func (server *Server) LogFatal(err error) {
server.logger.logger.Fatal().Err(err).Msg("A fatal error has occured")
}
// Server.AddLogger adds a logger to the server to use for request logging.
// AddLogger adds a logger to the server to use for request logging.
func (server *Server) AddLogger(hlogger *hlog.Logger) error {
if hlogger == nil {
return errors.New("Unable to add logger, no logger provided")
return errors.New("unable to add logger, no logger provided")
}
server.logger = &logger{
logger: hlogger,
@@ -64,7 +65,7 @@ func (server *Server) AddLogger(hlogger *hlog.Logger) error {
return nil
}
// Server.LoggerIgnorePaths sets a list of URL paths to ignore logging for.
// LoggerIgnorePaths sets a list of URL paths to ignore logging for.
// Path should match the url.URL.Path field, see https://pkg.go.dev/net/url#URL
// Useful for ignoring requests to CSS files or favicons
func (server *Server) LoggerIgnorePaths(paths ...string) error {
@@ -76,9 +77,22 @@ func (server *Server) LoggerIgnorePaths(paths ...string) error {
u.RawQuery == "" &&
u.Fragment == ""
if !valid {
return fmt.Errorf("Invalid path: '%s'", path)
return fmt.Errorf("invalid path: '%s'", path)
}
}
server.logger.ignoredPaths = paths
server.logger.ignoredPaths = prepareGlobs(paths)
return nil
}
func prepareGlobs(paths []string) []glob.Glob {
compiledGlobs := make([]glob.Glob, 0, len(paths))
for _, pattern := range paths {
g, err := glob.Compile(pattern)
if err != nil {
// If pattern fails to compile, skip it
continue
}
compiledGlobs = append(compiledGlobs, g)
}
return compiledGlobs
}

View File

@@ -2,8 +2,9 @@ package hws
import (
"net/http"
"slices"
"time"
"github.com/gobwas/glob"
)
// Middleware to add logs to console with details of the request
@@ -13,7 +14,7 @@ func logging(next http.Handler, logger *logger) http.Handler {
next.ServeHTTP(w, r)
return
}
if slices.Contains(logger.ignoredPaths, r.URL.Path) {
if globTest(r.URL.Path, logger.ignoredPaths) {
next.ServeHTTP(w, r)
return
}
@@ -36,3 +37,12 @@ func logging(next http.Handler, logger *logger) http.Handler {
Msg("Served")
})
}
func globTest(testPath string, globs []glob.Glob) bool {
for _, g := range globs {
if g.Match(testPath) {
return true
}
}
return false
}