Skip to content

fix: remove self managed client api#81

Merged
zoedsoupe merged 6 commits intomainfrom
fix/self-managed-client
Feb 4, 2026
Merged

fix: remove self managed client api#81
zoedsoupe merged 6 commits intomainfrom
fix/self-managed-client

Conversation

@zoedsoupe
Copy link
Copy Markdown
Member

@zoedsoupe zoedsoupe commented Jan 24, 2026

Problem

After deprecating the self-managed client pattern in #80, the README and module documentation still extensively
documented and promoted the Agent-based pattern. This could confuse new users who might implement the deprecated
(and unsafe) pattern instead of the recommended functional approach.

Solution

  • Removed references to "two ways to create clients" (one-off vs self-managed)
  • Simplified client initialization documentation to focus on the single recommended pattern
  • Removed @moduledoc sections in lib/supabase/client.ex that explained the Agent-based usage
  • Updated lib/supabase.ex docstrings to remove mentions of self-managed clients

Rationale

Documentation should reflect the recommended patterns, not deprecated ones. Since the self-managed pattern is now
deprecated (#80) due to race condition vulnerabilities, keeping it prominently featured in docs would actively
harm users by encouraging unsafe implementations.

The simplified docs now show only the functional pattern—creating lightweight client structs on-demand—which is
both safer and more idiomatic for server-side Elixir applications. Users still on the old pattern will see the
deprecation warnings when they compile.

Note: This PR depends on #80 (deprecation) being merged first.

Release-As: 0.8.0

@zoedsoupe
Copy link
Copy Markdown
Member Author

the will generate a breaking change

@zoedsoupe zoedsoupe requested a review from Ziinc January 24, 2026 18:39
@zoedsoupe zoedsoupe force-pushed the refactor/remove-over-engineering branch from ba35234 to 8a2e525 Compare February 2, 2026 22:33
@Ziinc
Copy link
Copy Markdown
Contributor

Ziinc commented Feb 3, 2026

Needs minor version bump

@zoedsoupe zoedsoupe force-pushed the fix/self-managed-client branch from c117cbb to 6793c62 Compare February 3, 2026 19:28
Base automatically changed from refactor/remove-over-engineering to main February 3, 2026 19:33
@zoedsoupe zoedsoupe changed the title fix!: remove self managed client api fix: remove self managed client api Feb 3, 2026
@zoedsoupe zoedsoupe requested a review from Ziinc February 3, 2026 19:43
@zoedsoupe zoedsoupe merged commit 7fa2e9c into main Feb 4, 2026
24 checks passed
@zoedsoupe zoedsoupe deleted the fix/self-managed-client branch February 4, 2026 05:13
@zoedsoupe zoedsoupe mentioned this pull request Feb 4, 2026
zoedsoupe added a commit that referenced this pull request Feb 5, 2026
@zoedsoupe zoedsoupe restored the fix/self-managed-client branch March 9, 2026 12:40
zoedsoupe added a commit that referenced this pull request Mar 26, 2026
Reverts #81, we need to launch a different
release for it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants