starred/godoxy
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-04-23 09:18:51 +02:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

refactor(errs): migrate from gperr.Error to standard Go error interface

Browse Source 
This is a large-scale refactoring across the codebase that replaces the custom
`gperr.Error` type with Go's standard `error` interface. The changes include:

- Replacing `gperr.Error` return types with `error` in function signatures
- Using `errors.New()` and `fmt.Errorf()` instead of `gperr.New()` and `gperr.Errorf()`
- Using `%w` format verb for error wrapping instead of `.With()` method
- Replacing `gperr.Subject()` calls with `gperr.PrependSubject()`
- Converting error logging from `gperr.Log*()` functions to zerolog's `.Err().Msg()` pattern
- Update NewLogger to handle multiline error message
- Updating `goutils` submodule to latest commit

This refactoring aligns with Go idioms and removes the dependency on
custom error handling abstractions in favor of standard library patterns.
This commit is contained in:
yusing
2026-02-08 12:07:36 +08:00
parent 7eb2a78041
commit 6da7227f9b
118 changed files with 572 additions and 563 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
internal/net/gphttp/middleware/captcha/README.md
View File

@@ -249,7 +249,7 @@ The package includes an embedded HTML template (`captcha.html`) that renders the
## Error Handling
```go
var ErrCaptchaVerificationFailed = gperr.New("captcha verification failed")
var ErrCaptchaVerificationFailed = errors.New("captcha verification failed")
// Verification errors are logged with request details
log.Warn().Err(err).Str("url", r.URL.String()).Str("remote_addr", r.RemoteAddr).Msg("failed to verify captcha")

5
internal/net/gphttp/middleware/captcha/provider.go
View File

@@ -1,10 +1,9 @@
package captcha
import (
"errors"
"net/http"
"time"
gperr "github.com/yusing/goutils/errs"
)
type Provider interface {
@@ -16,4 +15,4 @@ type Provider interface {
FormHTML() string
}
var ErrCaptchaVerificationFailed = gperr.New("captcha verification failed")
var ErrCaptchaVerificationFailed = errors.New("captcha verification failed")

3
internal/net/gphttp/middleware/errorpage/error_page.go
View File

@@ -11,7 +11,6 @@ import (
"github.com/yusing/godoxy/internal/common"
"github.com/yusing/godoxy/internal/watcher"
"github.com/yusing/godoxy/internal/watcher/events"
gperr "github.com/yusing/goutils/errs"
"github.com/yusing/goutils/fs"
"github.com/yusing/goutils/task"
)
@@ -93,7 +92,7 @@ func watchDir() {
loadContent()
}
case err := <-errCh:
gperr.LogError("error watching error page directory", err)
log.Err(err).Msg("error watching error page directory")
}
}
}

14
internal/net/gphttp/middleware/middleware.go
View File

@@ -1,6 +1,7 @@
package middleware
import (
"fmt"
"maps"
"net/http"
"reflect"
@@ -10,15 +11,12 @@ import (
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"github.com/yusing/godoxy/internal/serialization"
gperr "github.com/yusing/goutils/errs"
httputils "github.com/yusing/goutils/http"
"github.com/yusing/goutils/http/httpheaders"
"github.com/yusing/goutils/http/reverseproxy"
)
type (
Error = gperr.Error
ReverseProxy = reverseproxy.ReverseProxy
ProxyRequest = reverseproxy.ProxyRequest
@@ -87,7 +85,7 @@ func (m *Middleware) setup() {
}
}
func (m *Middleware) apply(optsRaw OptionsRaw) gperr.Error {
func (m *Middleware) apply(optsRaw OptionsRaw) error {
if len(optsRaw) == 0 {
return nil
}
@@ -120,10 +118,10 @@ func (m *Middleware) finalize() error {
return nil
}
func (m *Middleware) New(optsRaw OptionsRaw) (*Middleware, gperr.Error) {
func (m *Middleware) New(optsRaw OptionsRaw) (*Middleware, error) {
if m.construct == nil { // likely a middleware from compose
if len(optsRaw) != 0 {
return nil, gperr.New("additional options not allowed for middleware").Subject(m.name)
return nil, fmt.Errorf("additional options not allowed for middleware %s", m.name)
}
return m, nil
}
@@ -133,7 +131,7 @@ func (m *Middleware) New(optsRaw OptionsRaw) (*Middleware, gperr.Error) {
return nil, err
}
if err := mid.finalize(); err != nil {
return nil, gperr.Wrap(err)
return nil, err
}
mid.impl = mid.withCheckBypass()
return mid, nil
@@ -252,7 +250,7 @@ func (m *Middleware) LogError(req *http.Request) *zerolog.Event {
Str("path", req.URL.Path)
}
func PatchReverseProxy(rp *ReverseProxy, middlewaresMap map[string]OptionsRaw) (err gperr.Error) {
func PatchReverseProxy(rp *ReverseProxy, middlewaresMap map[string]OptionsRaw) (err error) {
var middlewares []*Middleware
middlewares, err = compileMiddlewares(middlewaresMap)
if err != nil {

11
internal/net/gphttp/middleware/middleware_builder.go
View File

@@ -1,6 +1,7 @@
package middleware
import (
"errors"
"fmt"
"os"
"path"
@@ -10,7 +11,7 @@ import (
gperr "github.com/yusing/goutils/errs"
)
var ErrMissingMiddlewareUse = gperr.New("missing middleware 'use' field")
var ErrMissingMiddlewareUse = errors.New("missing middleware 'use' field")
func BuildMiddlewaresFromComposeFile(filePath string, eb *gperr.Builder) map[string]*Middleware {
fileContent, err := os.ReadFile(filePath)
@@ -32,7 +33,7 @@ func BuildMiddlewaresFromYAML(source string, data []byte, eb *gperr.Builder) map
for name, defs := range rawMap {
chain, err := BuildMiddlewareFromChainRaw(name, defs)
if err != nil {
eb.Add(err.Subject(source))
eb.AddSubject(err, source)
} else {
middlewares[name+"@file"] = chain
}
@@ -40,7 +41,7 @@ func BuildMiddlewaresFromYAML(source string, data []byte, eb *gperr.Builder) map
return middlewares
}
func compileMiddlewares(middlewaresMap map[string]OptionsRaw) ([]*Middleware, gperr.Error) {
func compileMiddlewares(middlewaresMap map[string]OptionsRaw) ([]*Middleware, error) {
middlewares := make([]*Middleware, 0, len(middlewaresMap))
var errs gperr.Builder
@@ -68,7 +69,7 @@ func compileMiddlewares(middlewaresMap map[string]OptionsRaw) ([]*Middleware, gp
return middlewares, errs.Error()
}
func BuildMiddlewareFromMap(name string, middlewaresMap map[string]OptionsRaw) (*Middleware, gperr.Error) {
func BuildMiddlewareFromMap(name string, middlewaresMap map[string]OptionsRaw) (*Middleware, error) {
compiled, err := compileMiddlewares(middlewaresMap)
if err != nil {
return nil, err
@@ -77,7 +78,7 @@ func BuildMiddlewareFromMap(name string, middlewaresMap map[string]OptionsRaw) (
}
// TODO: check conflict or duplicates.
func BuildMiddlewareFromChainRaw(name string, defs []map[string]any) (*Middleware, gperr.Error) {
func BuildMiddlewareFromChainRaw(name string, defs []map[string]any) (*Middleware, error) {
var chainErr gperr.Builder
chain := make([]*Middleware, 0, len(defs))
for i, def := range defs {

3
internal/net/gphttp/middleware/middleware_chain.go
View File

@@ -2,6 +2,7 @@ package middleware
import (
"net/http"
"strconv"
gperr "github.com/yusing/goutils/errs"
)
@@ -47,7 +48,7 @@ func (m *middlewareChain) modifyResponse(resp *http.Response) error {
}
for i, mr := range m.modResps {
if err := mr.modifyResponse(resp); err != nil {
return gperr.Wrap(err).Subjectf("%d", i)
return gperr.PrependSubject(err, strconv.Itoa(i))
}
}
return nil

15
internal/net/gphttp/middleware/middlewares.go
View File

@@ -44,15 +44,14 @@ var allMiddlewares = map[string]*Middleware{
}
var (
ErrUnknownMiddleware = gperr.New("unknown middleware")
ErrMiddlewareAlreadyExists = gperr.New("middleware with the same name already exists")
ErrUnknownMiddleware = errors.New("unknown middleware")
ErrMiddlewareAlreadyExists = errors.New("middleware with the same name already exists")
)
func Get(name string) (*Middleware, Error) {
func Get(name string) (*Middleware, error) {
middleware, ok := allMiddlewares[strutils.ToLowerNoSnake(name)]
if !ok {
return nil, ErrUnknownMiddleware.
Subject(name).
return nil, gperr.PrependSubject(ErrUnknownMiddleware, name).
With(gperr.DoYouMeanField(name, allMiddlewares))
}
return middleware, nil
@@ -63,7 +62,7 @@ func All() map[string]*Middleware {
}
func LoadComposeFiles() {
errs := gperr.NewBuilder("middleware compile errors")
var errs gperr.Builder
middlewareDefs, err := fsutils.ListFiles(common.MiddlewareComposeBasePath, 0)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
@@ -81,7 +80,7 @@ func LoadComposeFiles() {
for name, m := range mws {
name = strutils.ToLowerNoSnake(name)
if _, ok := allMiddlewares[name]; ok {
errs.Add(ErrMiddlewareAlreadyExists.Subject(name))
errs.AddSubject(ErrMiddlewareAlreadyExists, name)
continue
}
allMiddlewares[name] = m
@@ -111,6 +110,6 @@ func LoadComposeFiles() {
}
}
if errs.HasError() {
gperr.LogError(errs.About(), errs.Error())
log.Err(errs.Error()).Msg("middleware compile errors")
}
}

3
internal/net/gphttp/middleware/oidc.go
View File

@@ -8,7 +8,6 @@ import (
"sync/atomic"
"github.com/yusing/godoxy/internal/auth"
gperr "github.com/yusing/goutils/errs"
)
type oidcMiddleware struct {
@@ -28,7 +27,7 @@ var OIDC = NewMiddleware[oidcMiddleware]()
func (amw *oidcMiddleware) finalize() error {
if !auth.IsOIDCEnabled() {
return gperr.New("OIDC not enabled but OIDC middleware is used")
return errors.New("OIDC not enabled but OIDC middleware is used")
}
return nil
}

7
internal/net/gphttp/middleware/test_utils.go
View File

@@ -11,7 +11,6 @@ import (
"github.com/bytedance/sonic"
"github.com/yusing/godoxy/internal/common"
nettypes "github.com/yusing/godoxy/internal/net/types"
gperr "github.com/yusing/goutils/errs"
"github.com/yusing/goutils/http/reverseproxy"
)
@@ -121,7 +120,7 @@ func (args *testArgs) bodyReader() io.Reader {
return nil
}
func newMiddlewareTest(middleware *Middleware, args *testArgs) (*TestResult, gperr.Error) {
func newMiddlewareTest(middleware *Middleware, args *testArgs) (*TestResult, error) {
if args == nil {
args = new(testArgs)
}
@@ -135,7 +134,7 @@ func newMiddlewareTest(middleware *Middleware, args *testArgs) (*TestResult, gpe
return newMiddlewaresTest([]*Middleware{mid}, args)
}
func newMiddlewaresTest(middlewares []*Middleware, args *testArgs) (*TestResult, gperr.Error) {
func newMiddlewaresTest(middlewares []*Middleware, args *testArgs) (*TestResult, error) {
if args == nil {
args = new(testArgs)
}
@@ -160,7 +159,7 @@ func newMiddlewaresTest(middlewares []*Middleware, args *testArgs) (*TestResult,
data, err := io.ReadAll(resp.Body)
if err != nil {
return nil, gperr.Wrap(err)
return nil, err
}
return &TestResult{

5
internal/net/gphttp/middleware/themed.go
View File

@@ -2,6 +2,7 @@ package middleware
import (
"bytes"
"errors"
"fmt"
"net/http"
"os"
@@ -66,7 +67,7 @@ func (m *themed) finalize() error {
m.m.HTML += buf.String()
}
if m.CSS != "" && m.Theme != "" {
return gperr.New("css and theme are mutually exclusive")
return errors.New("css and theme are mutually exclusive")
}
// credit: https://hackcss.egoist.dev
if m.Theme != "" {
@@ -78,7 +79,7 @@ func (m *themed) finalize() error {
case SolarizedDarkTheme:
m.m.HTML += wrapStyleTag(solarizedDarkModeCSS)
default:
return gperr.New("invalid theme").Subject(string(m.Theme))
return gperr.PrependSubject(errors.New("invalid theme"), m.Theme)
}
}
if m.CSS != "" {