1 Commits

Author SHA1 Message Date
jay f51a11ba00 remove error returns from component getter functions 2026-05-11 17:34:33 -04:00
3 changed files with 34 additions and 63 deletions
+5 -7
View File
@@ -48,7 +48,7 @@ logger to carry `module` and `path` automatically.
func NewPool(ctx context.Context, id string, handler slog.Handler) (*Pool, error) { func NewPool(ctx context.Context, id string, handler slog.Handler) (*Pool, error) {
ctx = component.MustNew(ctx, "honeybee", "outbound_pool") ctx = component.MustNew(ctx, "honeybee", "outbound_pool")
c, _ := component.Get(ctx) c := component.FromContext(ctx)
logger := slog.New(handler).With(slog.Any("component", c), slog.String("pool_id", id)) logger := slog.New(handler).With(slog.Any("component", c), slog.String("pool_id", id))
return &Pool{ctx: ctx, logger: logger}, nil return &Pool{ctx: ctx, logger: logger}, nil
@@ -64,7 +64,7 @@ path. No parent identifiers need to be passed as arguments.
func NewWorker(ctx context.Context, id string, handler slog.Handler) (*Worker, error) { func NewWorker(ctx context.Context, id string, handler slog.Handler) (*Worker, error) {
ctx = component.MustExtend(ctx, "outbound_worker") ctx = component.MustExtend(ctx, "outbound_worker")
c, _ := component.Get(ctx) c := component.FromContext(ctx)
logger := slog.New(handler).With(slog.Any("component", c), slog.Any("peer_id", id)) logger := slog.New(handler).With(slog.Any("component", c), slog.Any("peer_id", id))
return &Worker{ctx: ctx, logger: logger}, nil return &Worker{ctx: ctx, logger: logger}, nil
@@ -76,19 +76,17 @@ At the connection layer, another `MustExtend` call extends the path to
### Usage Notes ### Usage Notes
**Function Variants**: **Error-Returning vs Panic Variants**:
- Use `New` and `Extend` when a missing or invalid component is a recoverable - Use `New` and `Extend` when a missing or invalid component is a recoverable
condition. condition.
- Use `MustNew` and `MustExtend` at library boundaries where a missing - Use `MustNew` and `MustExtend` at library boundaries where a missing
component is a programming error that should halt execution immediately. component is a programming error that should halt execution immediately.
- Use `TryExtend` if you only want to extend a component if it exists,
otherwise use the parent context as-is.
**Generic Output**: **Generic Output**:
`GetFields` provides the component fields as a `map[string]string` for non-slog `FieldsFromContext` provides the component fields as a `map[string]string` for non-slog
consumers such as OpenTelemetry or Prometheus. consumers such as OpenTelemetry or Prometheus. It returns `nil` if no component is present.
## Testing ## Testing
+17 -30
View File
@@ -42,23 +42,25 @@ func insert(ctx context.Context, module string, name string, path []string) cont
}) })
} }
// Get retrieves the current component from the context; returns false if none is present. // FromContext retrieves the current component from the context; returns nil if none is present.
func Get(ctx context.Context) (Component, bool) { func FromContext(ctx context.Context) Component {
t, ok := ctx.Value(storageKey).(component) c, ok := ctx.Value(storageKey).(component)
return t, ok
}
// GetFields returns the component as a string map with keys "module" and "path".
func GetFields(ctx context.Context) (map[string]string, bool) {
c, ok := Get(ctx)
if !ok { if !ok {
return nil, false return nil
}
return c
} }
// FieldsFromContext returns the component as a string map with keys "module" and "path"; returns nil if none is present.
func FieldsFromContext(ctx context.Context) map[string]string {
c := FromContext(ctx)
if c == nil {
return nil
}
return map[string]string{ return map[string]string{
"module": c.Module(), "module": c.Module(),
"path": c.PathString(), "path": c.PathString(),
}, true }
} }
// New sets a new component on the context, resetting any existing component. // New sets a new component on the context, resetting any existing component.
@@ -81,8 +83,8 @@ func Extend(ctx context.Context, name string) (context.Context, error) {
return nil, fmt.Errorf("context is nil") return nil, fmt.Errorf("context is nil")
} }
c, ok := Get(ctx) c := FromContext(ctx)
if !ok { if c == nil {
return nil, fmt.Errorf("missing parent component") return nil, fmt.Errorf("missing parent component")
} }
@@ -93,21 +95,6 @@ func Extend(ctx context.Context, name string) (context.Context, error) {
return insert(ctx, c.Module(), name, c.Path()), nil return insert(ctx, c.Module(), name, c.Path()), nil
} }
// TryExtend returns ctx if no parent component is attached, otherwise
// extends the existing component path.
func TryExtend(ctx context.Context, name string) (context.Context, error) {
if ctx == nil {
return nil, fmt.Errorf("context is nil")
}
c, ok := Get(ctx)
if !ok || name == "" {
return ctx, nil
}
return insert(ctx, c.Module(), name, c.Path()), nil
}
// MustNew is New but panics on error. // MustNew is New but panics on error.
func MustNew(ctx context.Context, module string, name string) context.Context { func MustNew(ctx context.Context, module string, name string) context.Context {
if ctx == nil { if ctx == nil {
@@ -128,8 +115,8 @@ func MustExtend(ctx context.Context, name string) context.Context {
panic("context is nil") panic("context is nil")
} }
c, ok := Get(ctx) c := FromContext(ctx)
if !ok { if c == nil {
panic("missing parent component") panic("missing parent component")
} }
+12 -26
View File
@@ -22,8 +22,8 @@ func TestNew(t *testing.T) {
if err != nil { if err != nil {
t.Fatalf("expected no error, got %v", err) t.Fatalf("expected no error, got %v", err)
} }
c, ok := Get(ctx) c := FromContext(ctx)
if !ok { if c == nil {
t.Fatal("expected component in context") t.Fatal("expected component in context")
} }
if c.Module() != "mymodule" { if c.Module() != "mymodule" {
@@ -58,8 +58,8 @@ func TestExtend(t *testing.T) {
if err != nil { if err != nil {
t.Fatalf("expected no error, got %v", err) t.Fatalf("expected no error, got %v", err)
} }
c, ok := Get(ctx) c := FromContext(ctx)
if !ok { if c == nil {
t.Fatal("expected component in context") t.Fatal("expected component in context")
} }
if c.Module() != "mymodule" { if c.Module() != "mymodule" {
@@ -80,17 +80,6 @@ func TestExtend(t *testing.T) {
} }
}) })
t.Run("try passes through", func(t *testing.T) {
inCtx := context.Background()
outCtx, err := TryExtend(inCtx, "subcomponent")
if err != nil {
t.Fatal("unexpected error:", err)
}
if outCtx != inCtx {
t.Errorf("expected context to pass through")
}
})
t.Run("must variant should panic", func(t *testing.T) { t.Run("must variant should panic", func(t *testing.T) {
assertPanics(t, func() { assertPanics(t, func() {
MustExtend(context.Background(), "subcomponent") MustExtend(context.Background(), "subcomponent")
@@ -98,28 +87,25 @@ func TestExtend(t *testing.T) {
}) })
} }
func TestGet(t *testing.T) { func TestFromContext(t *testing.T) {
_, ok := Get(context.Background()) if FromContext(context.Background()) != nil {
if ok {
t.Fatal("expected no component on bare context") t.Fatal("expected no component on bare context")
} }
ctx := MustNew(context.Background(), "mymodule", "mycomponent") ctx := MustNew(context.Background(), "mymodule", "mycomponent")
_, ok = Get(ctx) if FromContext(ctx) == nil {
if !ok {
t.Fatal("expected component in context") t.Fatal("expected component in context")
} }
} }
func TestGetFields(t *testing.T) { func TestFieldsFromContext(t *testing.T) {
_, ok := GetFields(context.Background()) if FieldsFromContext(context.Background()) != nil {
if ok {
t.Fatal("expected no fields on bare context") t.Fatal("expected no fields on bare context")
} }
ctx := MustNew(context.Background(), "mymodule", "mycomponent") ctx := MustNew(context.Background(), "mymodule", "mycomponent")
fields, ok := GetFields(ctx) fields := FieldsFromContext(ctx)
if !ok { if fields == nil {
t.Fatal("expected fields in context") t.Fatal("expected fields in context")
} }
if fields["module"] != "mymodule" { if fields["module"] != "mymodule" {
@@ -132,7 +118,7 @@ func TestGetFields(t *testing.T) {
func TestLogValue(t *testing.T) { func TestLogValue(t *testing.T) {
ctx := MustNew(context.Background(), "mymodule", "mycomponent") ctx := MustNew(context.Background(), "mymodule", "mycomponent")
c, _ := Get(ctx) c := FromContext(ctx)
v := c.LogValue() v := c.LogValue()
attrs := v.Group() attrs := v.Group()
if len(attrs) != 2 { if len(attrs) != 2 {