supabase / supabase-flutter / 37446858483

92%

push

github

refactor: define shared HTTP header names in supabase_common (#1917)

Header names were written as string literals throughout the packages,
and the same header was sometimes spelled with different casing
(`Content-Type` and `content-type`). This adds an `HttpHeader` class to
`supabase_common` with constants for the headers more than one package
uses, and replaces the literals in `lib/` with them.

The constants are:

- `apikey`
- `Accept`
- `Accept-Profile`
- `Authorization`
- `Content-Profile`
- `Content-Type`
- `Prefer`
- `X-Client-Info`

What stays as it was:

- Headers only one package uses, such as `x-upsert`,
`X-Iceberg-Access-Delegation` and `x-region`.
- Tests and `supabase_test`, which keep literal strings so a typo in a
constant still fails a test.
- The lowercase credential lists in `redaction.dart` and
`trace_http_client.dart`, which are lowercase on purpose because they
are compared case insensitively.
- Realtime's `apikey` query parameter, which is not a header.

`HttpHeader` is not marked `@internal`, because the other packages
import it. Like the rest of `supabase_common`, it is excluded from the
compliance scan through `.sdk-parse-ignore`. No package re-exports it.

This does not change behavior. Every header is sent with the same name
as before. `mediaType` now looks up `Content-Type` instead of
`content-type`, and that lookup ignores case.

Resolves SDK-2138


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

## Summary by CodeRabbit

* **Developer Improvements**
* Added reusable constants for common HTTP header names, available
through the shared utilities package.
* Updated database, authentication, functions, realtime, and storage
requests to use these shared header definitions.
* **Behavior**
* Existing header values, request conditions, and behavior remain
unchanged.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

54 of 54 new or added lines in 21 files covered. (100.0%)

9276 of 10143 relevant lines covered (91.45%)

5.13 hits per line