fix: define local Logger interface to remove lib-observability type leak #25
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package libsd | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/LerianStudio/lib-observability/log" | ||
| ) | ||
|
|
||
| // Logger is the minimal structured-logging interface required by | ||
| // lib-service-discovery. | ||
| // | ||
| // It intentionally mirrors the context-aware methods of the standard library's | ||
| // *slog.Logger, so a consumer can supply any structured logger — including | ||
| // *slog.Logger — without being forced to import and version-match a specific | ||
| // logging library. This keeps the lib-observability logging types out of the | ||
| // public API and avoids the type incompatibilities that arise when a consumer | ||
| // pins a different lib-observability version than this library does. | ||
| // | ||
| // Any value implementing these four methods satisfies the interface via Go's | ||
| // structural typing, so no concrete adapter type is required on the caller side. | ||
| type Logger interface { | ||
| InfoContext(ctx context.Context, msg string, args ...any) | ||
| WarnContext(ctx context.Context, msg string, args ...any) | ||
| ErrorContext(ctx context.Context, msg string, args ...any) | ||
| DebugContext(ctx context.Context, msg string, args ...any) | ||
| } | ||
|
|
||
| // nopLogger is a Logger that discards everything. | ||
| type nopLogger struct{} | ||
|
|
||
| func (nopLogger) InfoContext(context.Context, string, ...any) {} | ||
| func (nopLogger) WarnContext(context.Context, string, ...any) {} | ||
| func (nopLogger) ErrorContext(context.Context, string, ...any) {} | ||
| func (nopLogger) DebugContext(context.Context, string, ...any) {} | ||
|
|
||
| // NewNopLogger returns a Logger that discards all output. It is the default used | ||
| // when no logger is supplied via Config.Logger or WithLogger. | ||
| func NewNopLogger() Logger { return nopLogger{} } | ||
|
|
||
| // observabilityAdapter adapts a public Logger to the internal lib-observability | ||
| // log.Logger consumed by the registry and resolvers. It lets the internal | ||
| // logging call sites keep using the log.Log(ctx, level, msg, fields...) style | ||
| // while the public API only ever exposes the version-agnostic Logger interface. | ||
| type observabilityAdapter struct { | ||
| inner Logger | ||
| fields []log.Field | ||
| } | ||
|
|
||
| // toInternalLogger wraps a public Logger in the internal log.Logger contract. | ||
| // A nil Logger yields a lib-observability no-op logger. | ||
| func toInternalLogger(l Logger) log.Logger { | ||
| if l == nil { | ||
| return log.NewNop() | ||
| } | ||
|
|
||
| return &observabilityAdapter{inner: l} | ||
|
Comment on lines
+51
to
+56
There was a problem hiding this comment. 🩺 Stability & Availability | 🟠 Major | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '\n== Files ==\n'
git ls-files | rg '(^|/)(logger\.go|config\.go)$'
printf '\n== logger.go outline ==\n'
ast-grep outline logger.go --view expanded || true
printf '\n== config.go outline ==\n'
ast-grep outline config.go --view expanded || true
printf '\n== Relevant lines: logger.go ==\n'
nl -ba logger.go | sed -n '1,140p'
printf '\n== Relevant lines: config.go ==\n'
nl -ba config.go | sed -n '220,290p'
printf '\n== Search for Logger type and related helpers ==\n'
rg -n "type Logger|NewNopLogger|toInternalLogger|withDefaults|observabilityAdapter|isNil" .Repository: LerianStudio/lib-service-discovery Length of output: 3092 🏁 Script executed: #!/bin/bash
set -euo pipefail
# Fallback if the previous request didn't return results yet: inspect the files directly.
printf '\n== logger.go ==\n'
nl -ba logger.go | sed -n '1,140p'
printf '\n== config.go ==\n'
nl -ba config.go | sed -n '220,290p'
printf '\n== Logger-related definitions ==\n'
rg -n "type Logger|func .*NewNopLogger|func .*toInternalLogger|func .*withDefaults|observabilityAdapter|isNil" logger.go config.goRepository: LerianStudio/lib-service-discovery Length of output: 229 🏁 Script executed: #!/bin/bash
set -euo pipefail
pwd
git rev-parse --show-toplevel
git ls-files | head -n 50Repository: LerianStudio/lib-service-discovery Length of output: 1146 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '== logger.go ==\n'
sed -n '1,140p' logger.go
printf '\n== config.go (selected) ==\n'
sed -n '230,280p' config.go
printf '\n== Logger usages and constructors ==\n'
grep -RIn --exclude-dir=.git -E 'Logger|NewNopLogger|toInternalLogger|withDefaults|observabilityAdapter' . | head -n 200Repository: LerianStudio/lib-service-discovery Length of output: 16857 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '== logger.go ==\n'
sed -n '1,140p' logger.go
printf '\n== config.go (selected) ==\n'
sed -n '230,280p' config.go
printf '\n== Logger-related call sites ==\n'
grep -RIn --exclude-dir=.git -E 'NewNopLogger\(|toInternalLogger\(|withDefaults\(|Logger\s*[:=]' . | head -n 200Repository: LerianStudio/lib-service-discovery Length of output: 8852 Use a typed-nil-safe logger fallback. 📍 Affects 2 files
🤖 Prompt for AI Agents |
||
| } | ||
|
|
||
| // Log routes an internal log event to the appropriate context-aware method of | ||
| // the wrapped Logger, flattening the typed fields into slog-style key/value | ||
| // arguments. | ||
| func (a *observabilityAdapter) Log(ctx context.Context, level log.Level, msg string, fields ...log.Field) { | ||
| all := fields | ||
| if len(a.fields) > 0 { | ||
| all = make([]log.Field, 0, len(a.fields)+len(fields)) | ||
| all = append(all, a.fields...) | ||
| all = append(all, fields...) | ||
| } | ||
|
|
||
| args := make([]any, 0, len(all)*2) | ||
| for _, f := range all { | ||
| args = append(args, f.Key, f.Value) | ||
| } | ||
|
|
||
| switch level { | ||
| case log.LevelError: | ||
| a.inner.ErrorContext(ctx, msg, args...) | ||
| case log.LevelWarn: | ||
| a.inner.WarnContext(ctx, msg, args...) | ||
| case log.LevelDebug: | ||
| a.inner.DebugContext(ctx, msg, args...) | ||
| default: // LevelInfo and any unknown level map to Info. | ||
| a.inner.InfoContext(ctx, msg, args...) | ||
| } | ||
| } | ||
|
|
||
| // With returns a child adapter carrying additional persistent fields. | ||
| // | ||
| //nolint:ireturn // must satisfy the lib-observability log.Logger contract. | ||
| func (a *observabilityAdapter) With(fields ...log.Field) log.Logger { | ||
| merged := make([]log.Field, 0, len(a.fields)+len(fields)) | ||
| merged = append(merged, a.fields...) | ||
| merged = append(merged, fields...) | ||
|
|
||
| return &observabilityAdapter{inner: a.inner, fields: merged} | ||
| } | ||
|
|
||
| // WithGroup is a no-op: the public Logger interface has no grouping concept. | ||
| // | ||
| //nolint:ireturn // must satisfy the lib-observability log.Logger contract. | ||
| func (a *observabilityAdapter) WithGroup(_ string) log.Logger { return a } | ||
|
|
||
| // Enabled always reports true and defers level filtering to the wrapped Logger. | ||
| func (a *observabilityAdapter) Enabled(_ log.Level) bool { return true } | ||
|
|
||
| // Sync is a no-op: flushing is the responsibility of the wrapped Logger. | ||
| func (a *observabilityAdapter) Sync(_ context.Context) error { return nil } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Document the breaking logger migration.
The README explains the new interface but does not warn that existing
lib-observability/log.Loggervalues no longer satisfylibsd.Logger. Add a short migration note directing callers to*slog.Loggeror an adapter.🤖 Prompt for AI Agents