Skip to content

Commit

Permalink
ref(nav): migrate to slog (#354)
Browse files Browse the repository at this point in the history
  • Loading branch information
plastikfan committed Jan 4, 2024
1 parent ae14253 commit a8c8ae1
Show file tree
Hide file tree
Showing 17 changed files with 48 additions and 228 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@
"wgan",
"xname",
"xpander",
"zapslog",
"Zemlya",
"Zeroable"
]
Expand Down
3 changes: 1 addition & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ require (
github.com/onsi/gomega v1.30.0
github.com/samber/lo v1.39.0
go.uber.org/zap v1.26.0
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
)

require (
Expand All @@ -30,10 +29,10 @@ require (
require (
github.com/go-logr/logr v1.3.0 // indirect
github.com/google/go-cmp v0.6.0 // indirect
github.com/natefinch/lumberjack v2.0.0+incompatible
github.com/nicksnyder/go-i18n/v2 v2.3.0
github.com/pkg/errors v0.9.1
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap/exp v0.2.0
golang.org/x/exp v0.0.0-20230321023759-10a507213a29
golang.org/x/net v0.17.0 // indirect
golang.org/x/sys v0.14.0 // indirect
Expand Down
6 changes: 2 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw=
github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8=
github.com/natefinch/lumberjack v2.0.0+incompatible h1:4QJd3OLAMgj7ph+yZTuX13Ld4UpgHp07nNdFX7mqFfM=
github.com/natefinch/lumberjack v2.0.0+incompatible/go.mod h1:Wi9p2TTF5DG5oU+6YfsmYQpsTIOm0B1VNzQg9Mw6nPk=
github.com/nicksnyder/go-i18n/v2 v2.3.0 h1:2NPsCsNFCVd7i+Su0xYsBrIhS3bE2XMv5gNTft2O+PQ=
github.com/nicksnyder/go-i18n/v2 v2.3.0/go.mod h1:nxYSZE9M0bf3Y70gPQjN9ha7XNHX7gMc814+6wVyEI4=
github.com/onsi/ginkgo/v2 v2.13.2 h1:Bi2gGVkfn6gQcjNjZJVO8Gf0FHzMPf2phUei9tejVMs=
Expand All @@ -53,6 +51,8 @@ go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
go.uber.org/zap v1.26.0 h1:sI7k6L95XOKS281NhVKOFCUNIvv9e0w4BF8N3u+tCRo=
go.uber.org/zap v1.26.0/go.mod h1:dtElttAiwGvoJ/vj4IwHBS/gXsEu/pZ50mUIRWuG0so=
go.uber.org/zap/exp v0.2.0 h1:FtGenNNeCATRB3CmB/yEUnjEFeJWpB/pMcy7e2bKPYs=
go.uber.org/zap/exp v0.2.0/go.mod h1:t0gqAIdh1MfKv9EwN/dLwfZnJxe9ITAZN78HEWPFWDQ=
golang.org/x/exp v0.0.0-20230321023759-10a507213a29 h1:ooxPy7fPvB4kwsA2h+iBNHkAbp/4JxTSwCmvdjEYmug=
golang.org/x/exp v0.0.0-20230321023759-10a507213a29/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
golang.org/x/mod v0.13.0 h1:I/DsJXRlw/8l/0c24sM9yb0T4z9liZTduXvdAWYiysY=
Expand All @@ -70,8 +70,6 @@ google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqw
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
Expand Down
23 changes: 0 additions & 23 deletions internal/log/fields.go

This file was deleted.

43 changes: 0 additions & 43 deletions internal/log/log-defs.go

This file was deleted.

36 changes: 0 additions & 36 deletions internal/log/new-logger.go

This file was deleted.

3 changes: 1 addition & 2 deletions xfs/nav/bootstrapper.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package nav

import (
"github.com/snivilised/extendio/collections"
"github.com/snivilised/extendio/xfs/utils"
)

type nullDetacher struct{}
Expand All @@ -29,7 +28,7 @@ func (b *bootstrapper) init() {
b.nc.ns = &NavigationState{
Filters: b.nc.frame.filters,
Root: &b.nc.frame.root,
Logger: utils.NewRoProp[ClientLogger](b.nc.impl.logger()),
Logger: b.o.Monitor.Log,
}
}

Expand Down
26 changes: 6 additions & 20 deletions xfs/nav/helpers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"errors"
"fmt"
"io/fs"
"log/slog"
"math"
"os"
"path/filepath"
Expand All @@ -14,7 +15,6 @@ import (
"github.com/samber/lo"
"github.com/snivilised/extendio/i18n"
"github.com/snivilised/extendio/internal/helpers"
"github.com/snivilised/extendio/internal/log"
"github.com/snivilised/extendio/xfs/nav"
"github.com/snivilised/extendio/xfs/utils"
)
Expand Down Expand Up @@ -114,7 +114,6 @@ type resumeTE struct {
active activeTE
clientListenAt string
profile string
log bool
}

type cascadeTE struct {
Expand Down Expand Up @@ -144,26 +143,13 @@ func musico() string {
panic("could not get root path")
}

func logo() nav.LoggingOptions {
return nav.LoggingOptions{
Enabled: true,
Path: helpers.Log(),
TimeStampFormat: "2006-01-02 15:04:05",
Rotation: nav.LogRotationOptions{
MaxSizeInMb: 5,
MaxNoOfBackups: 1,
MaxAgeInDays: 7,
},
}
}

func begin(em string) nav.BeginHandler {
return func(state *nav.NavigationState) {
state.Logger.Get().Info("💧 Beginning Traversal (client side)",
log.String("Root", state.Root.Get()),
log.Uint("Foo", 42),
log.Int("Bar", 13),
log.Float64("Pi", float64(math.Pi)),
state.Logger.Info("💧 Beginning Traversal (client side)",
slog.String("Root", state.Root.Get()),
slog.Int("Foo", 42),
slog.Int("Bar", 13),
slog.Float64("Pi", float64(math.Pi)),
)

GinkgoWriter.Printf(
Expand Down
12 changes: 6 additions & 6 deletions xfs/nav/navigation-controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ package nav

import (
"context"
"log/slog"

"github.com/samber/lo"
"github.com/snivilised/extendio/internal/log"
"github.com/snivilised/extendio/xfs/utils"
)

Expand Down Expand Up @@ -33,12 +33,12 @@ func (nc *navigationController) init() {
nc.ns = &NavigationState{
Filters: nc.frame.filters,
Root: &nc.frame.root,
Logger: utils.NewRoProp[ClientLogger](nc.impl.logger()),
Logger: nc.logger(),
}
nc.impl.init(nc.ns)
}

func (nc *navigationController) logger() log.Logger {
func (nc *navigationController) logger() *slog.Logger {
return nc.impl.logger()
}

Expand All @@ -48,15 +48,15 @@ func (nc *navigationController) ensync(ctx context.Context, cancel context.Cance

func (nc *navigationController) walk(root string) (*TraverseResult, error) {
nc.frame.root.Set(root)
nc.impl.logger().Info("walk", log.String("root", root))
nc.impl.logger().Info("walk", slog.String("root", root))

nc.frame.notifiers.begin.invoke(nc.ns)

result, err := nc.impl.top(nc.frame, root)

fields := []log.Field{}
fields := []any{}
for _, m := range result.Metrics.collection {
fields = append(fields, log.Uint(m.Name, m.Count))
fields = append(fields, slog.Int(m.Name, int(m.Count)))
}

nc.impl.logger().Info("Result", fields...)
Expand Down
1 change: 0 additions & 1 deletion xfs/nav/navigation-listener_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,6 @@ var _ = Describe("Listener", Ordered, func() {
return nil
},
}
o.Store.Logging = logo()
}
})

Expand Down
12 changes: 5 additions & 7 deletions xfs/nav/navigator-abstract.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,15 @@ import (
"context"
"fmt"
"io/fs"
"log/slog"
"strings"

"github.com/google/uuid"
"github.com/snivilised/extendio/internal/log"
"github.com/snivilised/extendio/xfs/utils"
)

type navigator struct {
o *TraverseOptions
agent *navigationAgent
log utils.RoProp[log.Logger]
samplingActive bool
filteringActive bool
samplingFilterActive bool
Expand Down Expand Up @@ -57,7 +55,7 @@ func (n *navigator) ensync(
if err, ok := pe.(error); ok || strings.Contains(err.Error(),
"send on closed channel") {
n.logger().Error("☠️☠️☠️ send on closed channel",
log.String("item-path", item.Path),
slog.String("item-path", item.Path),
)
} else {
panic(pe)
Expand Down Expand Up @@ -98,8 +96,8 @@ func (n *navigator) ensync(
frame.decorate("boost decorator", decorator)
}

func (n *navigator) logger() log.Logger {
return n.log.Get()
func (n *navigator) logger() *slog.Logger {
return n.o.Monitor.Log
}

func (n *navigator) descend(navi *NavigationInfo) bool {
Expand All @@ -120,7 +118,7 @@ func (n *navigator) ascend(navi *NavigationInfo, permit bool) {
}

func (n *navigator) finish() error {
return n.log.Get().Sync()
return nil
}

func (n *navigator) keep(stash *inspection) {
Expand Down
22 changes: 1 addition & 21 deletions xfs/nav/new-navigator.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package nav

import (
"github.com/snivilised/extendio/internal/log"
"github.com/snivilised/extendio/xfs/utils"

"github.com/snivilised/extendio/i18n"
)

Expand Down Expand Up @@ -57,11 +54,9 @@ func (f navigatorImplFactory) new(o *TraverseOptions) navigatorImpl {
handler: &notifyCallbackErrorHandler{},
samplingFilterActive: samplingFilterActive,
})
logger = f.makeLogger(o)
n = navigator{
n = navigator{
o: o,
agent: agent,
log: logger,
samplingActive: samplingActive,
filteringActive: filteringActive,
samplingFilterActive: samplingFilterActive,
Expand Down Expand Up @@ -89,18 +84,3 @@ func (f navigatorImplFactory) new(o *TraverseOptions) navigatorImpl {

return impl
}

func (f navigatorImplFactory) makeLogger(o *TraverseOptions) utils.RoProp[log.Logger] {
return log.NewLogger(&log.LoggerInfo{
Rotation: log.Rotation{
Filename: o.Store.Logging.Path,
MaxSizeInMb: o.Store.Logging.Rotation.MaxSizeInMb,
MaxNoOfBackups: o.Store.Logging.Rotation.MaxNoOfBackups,
MaxAgeInDays: o.Store.Logging.Rotation.MaxAgeInDays,
},
Enabled: o.Store.Logging.Enabled,
Path: o.Store.Logging.Path,
TimeStampFormat: o.Store.Logging.TimeStampFormat,
Level: o.Store.Logging.Level,
})
}
Loading

0 comments on commit a8c8ae1

Please sign in to comment.