supabase / supabase-flutter / 32299689172

89%

Build Type

push

github

Committed by web-flow

Commit Message

refactor!: rework logging to emit only through the supabase logger hierarchy (#1741)

## What kind of change does this PR introduce?

Refactor of how logging works across all packages, for v3.

Closes #1533

## What is the current behavior?

- `Supabase.initialize(debug:)` attaches a `debugPrint` listener inside
the SDK, with the default derived from `kDebugMode &&
!isRunningInFlutterTest` (the test-detection hack that prompted #1533).
- Because nothing sets `hierarchicalLoggingEnabled`,
`Logger('supabase').onRecord` resolves to the root logger's stream, so
the listener actually prints every `INFO`+ record of the entire
application, not just Supabase records.
- The README example (`Logger('supabase').level = Level.ALL`) throws
`UnsupportedError` under default `package:logging` settings.
- `RealtimeClient` has a second, JS-ported logging path: a public
`logger` callback and a public `log(kind, message, data, level)` method,
with almost everything logged at `FINEST` including genuine errors.
- Each file constructs its own `Logger`, partly as per-instance fields,
with the name string duplicated across files.

## What is the new behavior?

Libraries emit, applications listen:

- Every package emits through one package-private `package:logging`
logger defined in a single `src/logger.dart` (marked `@internal`). No
Supabase package prints, attaches listeners, or mutates
`package:logging` state anymore.
- `Supabase.initialize(debug:)`, the internal `debugPrint` listener, and
the Flutter-test detection are removed.
- `RealtimeClient.logger` and `RealtimeClient.log` are removed; realtime
call sites now log directly on the `supabase.realtime` logger with
deliberate levels (`FINEST` wire payloads, `FINE` lifecycle, `WARNING`
for failures such as decode errors, heartbeat timeouts, and connection
errors that were previously logged at `FINEST`).
- Logger names are cleaned up: `supabase.supabase` becomes
`supabase.dart` and `supabase.supabase_flutter` becomes
`supaba... (continued)

Coverage Stats

128 of 169 new or added lines in 25 files covered. (75.74%)

7 existing lines in 4 files now uncovered.

5909 of 6681 relevant lines covered (88.44%)

4.35 hits per line