supabase / supabase-flutter / 35970668421

94%

push

github

refactor(supabase)!: require a traceContextProvider in TracePropagationOptions (#1882)

## Summary

`TracePropagationOptions` had two switches that had to agree, which left
two dead states: `enabled: true` without a provider sent nothing, and a
provider with `enabled: false` was never called. `enabled` was read
exactly once, to decide whether to wrap the HTTP client, so it could not
be toggled at runtime anyway.

This collapses the two into one:

- `TracePropagationOptions.enabled` is gone and `traceContextProvider`
is required.
- The `tracePropagationOptions` parameter on `SupabaseClient` and
`Supabase.initialize` is nullable and defaults to `null`, which means
off.
- `TracePropagationClient` no longer warns about a missing provider,
since that state cannot be constructed anymore. The malformed
`traceparent` warning is unchanged.

## Breaking change

`supabase` and `supabase_flutter` are at `3.0.0-dev.7`, so this lands
before 3.0.0 ships. `MIGRATION.md` gets a section under v3 and
`sdk-compliance.yaml` drops the removed symbol.

```dart
// Before
tracePropagationOptions: TracePropagationOptions(
  enabled: true,
  traceContextProvider: () => TraceContext.fromCarrier(carrier),
),

// After
tracePropagationOptions: TracePropagationOptions(
  traceContextProvider: () => TraceContext.fromCarrier(carrier),
),
```

## Testing

- `melos analyze` and `melos format` are clean.
- `dart test` in `packages/supabase` and `flutter test` in
`packages/supabase_flutter` pass. The test for the warning on a missing
provider is removed with the state it covered, and the disabled-client
test now passes no options.
- The SDK compliance symbol, drift and schema checks pass locally
against the pinned `capability-matrix-v1.9.0` tooling.

Closes SDK-1938.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Changes**
* Trace propagation is now enabled by providing a context provider in
`TracePropagationOptions`; the `enabl... (continued)

3 of 3 new or added lines in 2 files covered. (100.0%)

8658 of 9520 relevant lines covered (90.95%)

4.86 hits per line