Replaced some of the package functions with direct access to the default controller

Author: Russ Egan

v2/TODO.md

@@ -24,9 +24,15 @@
   - And what else?
 - [ ] Review ConfigFromEnv().  Not sure if I should break that down more.
 - [ ] Docs
-- [ ] flumetest, and could this be replaced by 
+- [ ] flumetest, and could this be replaced by https://github.com/neilotoole/slogt/blob/master/slogt.go
 - [ ] LoggerWriter, could this be replaced by an off the shelf sink?
 - [ ] Make the "logger" key name configurable
 - [ ] What happens when using flume with no configuration, by default?  Should it act like slog, and forward to the legacy log package?
+      - for now, it forwards to the slog default handler, which in turn forwards to the legacy log package.  I considered adding
+        a function which reverses that flow, by setting slog.SetDefault() to a flume handler...but that gets really wierd.  slog's
+        package level functions, like With(), don't make much sense, since setting the slog default handler *after* calling
+        slog.With(), means that child logger will be stuck with the older handler...it generally poses the same order-of-init problems
+        which flume is trying to solve in general.  So, for now, I'm leaving out this type of function.  I will document that users
+        *can* do this if they wish, by first setting a new default sink, then setting slog's default handler, but that there are caveats.
 - [ ] When using Config to set all the levels, does that clear any prior level settings?  Is there generally a way to clear/reset
       all confs?

v2/default_controller.go

@@ -28,10 +28,10 @@ const (
 //	package http
 //	var logger = flume.New("http")
 func New(name string) *slog.Logger {
-	return deflt().Logger(name)
+	return Default().Logger(name)
 }
 
-// NewHandler creates a named flume Handler, managed by the default flume.Controller.
+// Handler creates a named flume Handler, managed by the default flume.Controller.
 //
 // These package-level functions are typically used to initialize
 // package-level loggers in var initializers, which can later
@@ -41,50 +41,9 @@ func New(name string) *slog.Logger {
 // Example:
 //
 //	package http
-//	var logger = slog.New(flume.NewHandler("http"))
-func NewHandler(name string) slog.Handler {
-	return deflt().Handler(name)
-}
-
-// SetSink sets the sink handler for flume handlers with the given
-// name, managed by the default flume.Controller.
-// See [Controller.SetSink]
-func SetSink(name string, sink slog.Handler) {
-	deflt().SetSink(name, sink)
-}
-
-// SetDefaultSink sets the default sink for the default flume.Controller.
-// See [Controller.SetDefaultSink]
-func SetDefaultSink(sink slog.Handler) {
-	deflt().SetDefaultSink(sink)
-}
-
-// SetLevel sets the log level for flume handlers with the give name,
-// managed by the default flume.Controller.
-// See [Controller.SetLevel]
-func SetLevel(name string, l slog.Level) {
-	deflt().SetLevel(name, l)
-}
-
-// SetDefaultLevel sets the default log level for the default
-// flume.Controller.
-// See [Controller.SetDefaultLevel]
-func SetDefaultLevel(l slog.Level) {
-	deflt().SetDefaultLevel(l)
-}
-
-// Use applies middleware to flume handlers with the given name, managed
-// by the default flume.Controller.
-// See [Controller.Use]
-func Use(name string, middleware ...Middleware) {
-	deflt().Use(name, middleware...)
-}
-
-// UseDefault applies middleware to all flume handlers managed by
-// the default flume.Controller.
-// See [Controller.Use.Default]
-func UseDefault(middleware ...Middleware) {
-	deflt().UseDefault(middleware...)
+//	var logger = slog.New(flume.Handler("http"))
+func Handler(name string) slog.Handler {
+	return Default().Handler(name)
 }
 
 var defaultFactory atomic.Pointer[Controller]
@@ -94,6 +53,6 @@ func init() {
 	defaultFactory.Store(NewController(slog.Default().Handler()))
 }
 
-func deflt() *Controller {
+func Default() *Controller {
 	return defaultFactory.Load()
 }

v2/handler_test.go

@@ -224,58 +224,58 @@ func TestHandlers(t *testing.T) {
 			name:     "default",
 			wantJSON: `{"level":  "INFO", "logger": "def1", "msg":"hi"}`,
 			handlerFn: func(_ *testing.T, buf *bytes.Buffer, opts *slog.HandlerOptions) slog.Handler {
-				SetDefaultSink(slog.NewJSONHandler(buf, opts))
-				return NewHandler("def1")
+				Default().SetDefaultSink(slog.NewJSONHandler(buf, opts))
+				return Handler("def1")
 			},
 		},
 		{
 			name:     "default with text",
 			wantText: "level=INFO msg=hi logger=def1\n",
 			handlerFn: func(_ *testing.T, buf *bytes.Buffer, opts *slog.HandlerOptions) slog.Handler {
-				SetDefaultSink(slog.NewTextHandler(buf, opts))
-				return NewHandler("def1")
+				Default().SetDefaultSink(slog.NewTextHandler(buf, opts))
+				return Handler("def1")
 			},
 		},
 		{
 			name:     "default with specific logger",
 			wantText: "level=INFO msg=hi logger=def2\n",
 			handlerFn: func(_ *testing.T, buf *bytes.Buffer, opts *slog.HandlerOptions) slog.Handler {
-				SetDefaultSink(slog.NewJSONHandler(buf, opts))
-				SetSink("def2", slog.NewTextHandler(buf, opts))
+				Default().SetDefaultSink(slog.NewJSONHandler(buf, opts))
+				Default().SetSink("def2", slog.NewTextHandler(buf, opts))
 
-				return NewHandler("def2")
+				return Handler("def2")
 			},
 		},
 		{
 			name:  "default log level",
 			level: slog.LevelDebug,
 			// wantText: "level=INFO msg=hi logger=def1\n",
 			handlerFn: func(_ *testing.T, buf *bytes.Buffer, opts *slog.HandlerOptions) slog.Handler {
-				SetDefaultSink(slog.NewTextHandler(buf, opts))
-				return NewHandler("def1")
+				Default().SetDefaultSink(slog.NewTextHandler(buf, opts))
+				return Handler("def1")
 			},
 		},
 		{
 			name:     "set default log level",
 			level:    slog.LevelDebug,
 			wantText: "level=DEBUG msg=hi logger=def1\n",
 			handlerFn: func(_ *testing.T, buf *bytes.Buffer, opts *slog.HandlerOptions) slog.Handler {
-				SetDefaultSink(slog.NewTextHandler(buf, opts))
-				SetDefaultLevel(slog.LevelDebug)
+				Default().SetDefaultSink(slog.NewTextHandler(buf, opts))
+				Default().SetDefaultLevel(slog.LevelDebug)
 
-				return NewHandler("def1")
+				return Handler("def1")
 			},
 		},
 		{
 			name:     "set specific log level",
 			level:    slog.LevelDebug,
 			wantText: "level=DEBUG msg=hi logger=TestHandlers/set_specific_log_level\n",
 			handlerFn: func(t *testing.T, buf *bytes.Buffer, opts *slog.HandlerOptions) slog.Handler {
-				SetDefaultSink(slog.NewTextHandler(buf, opts))
-				SetDefaultLevel(slog.LevelInfo)
-				SetLevel(t.Name(), slog.LevelDebug)
+				Default().SetDefaultSink(slog.NewTextHandler(buf, opts))
+				Default().SetDefaultLevel(slog.LevelInfo)
+				Default().SetLevel(t.Name(), slog.LevelDebug)
 
-				return NewHandler(t.Name())
+				return Handler(t.Name())
 			},
 		},
 	}