Feat/add supabase by fgilde · Pull Request #1114 · CommunityToolkit/Aspire

fgilde · 2026-01-20T15:51:32Z

Closes #417

Overview

This PR adds a complete Supabase stack integration for .NET Aspire, enabling local development with full Supabase functionality.

Features

Full Supabase Stack: PostgreSQL, Auth (GoTrue), REST API (PostgREST), Storage, Kong API Gateway, Studio Dashboard, Postgres-Meta, and Edge Functions
Fluent Configuration API: Configure each component individually via ConfigureAuth(), ConfigureDatabase(), ConfigureStorage(), etc.
Project Sync: Synchronize schema, data, storage buckets, and edge functions from remote Supabase projects
Local Migrations: Apply local SQL migration files
Edge Functions: Support for local Deno-based edge functions
Pre-registered Users: Create development users on startup
Dashboard Commands: Add custom commands to the Aspire dashboard (e.g., "Clear All Data")

Usage

var builder = DistributedApplication.CreateBuilder(args);

var supabase = builder.AddSupabase("supabase")
    .ConfigureAuth(auth => auth
        .WithSiteUrl("http://localhost:3000")
        .WithAutoConfirm(true))
    .ConfigureStorage(storage => storage
        .WithFileSizeLimit(100_000_000))
    .WithMigrations("<path_to_migrations>")
    .WithEdgeFunctions("<path_to_functions>");

builder.Build().Run();

PR Checklist

Other information

Tests

44 unit tests covering resource creation, configuration, and container setup
Tests run sequentially via [Collection("Supabase")] to avoid file locking issues during parallel execution

Example Project

Complete AppHost example demonstrating all configuration options
ServiceDefaults project with standard OpenTelemetry/HealthChecks setup

Container Images Used

supabase/postgres - PostgreSQL with Supabase extensions
supabase/gotrue - Authentication service
postgrest/postgrest - REST API
supabase/storage-api - File storage
kong - API Gateway
supabase/postgres-meta - Database metadata API
supabase/studio - Dashboard UI
supabase/edge-runtime - Edge Functions runtime

Update Readme

Copilot

Pull request overview

This PR adds a complete Supabase stack integration for .NET Aspire, enabling local development with full Supabase functionality. The integration goes beyond the original issue's scope by providing not just PostgreSQL, but a complete Supabase stack including Auth (GoTrue), REST API (PostgREST), Storage, Kong API Gateway, Studio Dashboard, Postgres-Meta, and Edge Functions support.

Changes:

Complete Supabase stack with 8+ containerized services working together
Fluent configuration API for each Supabase component
Project synchronization from remote Supabase instances
Local migrations and Edge Functions support
44 comprehensive unit tests

Reviewed changes

Copilot reviewed 39 out of 39 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/CommunityToolkit.Aspire.Hosting.Supabase/*.cs	Core implementation with resources, builders, and extensions
src/CommunityToolkit.Aspire.Hosting.Supabase/Sync/*.cs	Remote project synchronization functionality
src/CommunityToolkit.Aspire.Hosting.Supabase/Helpers/*.cs	SQL generation and Edge Function routing
tests/CommunityToolkit.Aspire.Hosting.Supabase.Tests/*.cs	Comprehensive test coverage (44 tests)
examples/supabase/*	Complete AppHost example with ServiceDefaults
README.md, CommunityToolkit.Aspire.slnx	Documentation and solution integration

fgilde · 2026-01-20T16:37:42Z

@fgilde please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@dotnet-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

@dotnet-policy-service agree

axies20 · 2026-01-24T23:32:06Z

Can be added client for supabase that will automatically initialize

var url = Environment.GetEnvironmentVariable("SUPABASE_URL");
var key = Environment.GetEnvironmentVariable("SUPABASE_KEY");
var options = new Supabase.SupabaseOptions
{
    AutoConnectRealtime = true
};
var supabase = new Supabase.Client(url, key, options);
await supabase.InitializeAsync();

something like that:

builder.AddSupabae("SupaBaseName");

aaronpowell

I think there are the bones of a solid integration taking shape here but there's a bit of work that needs to be done before it would fit into the community toolkit.

I've left quite a few comments throughout the PR (although I didn't add them to all the resource classes as there was a set of repeated comments on all of them).

The one thing that I don't think this integration is currently doing well enough is leveraging the Aspire app model design around resource creation and management, and that will need addressing before it could be merged in.

aaronpowell · 2026-01-28T23:49:59Z

.claude/settings.local.json

can you remove this file.

aaronpowell · 2026-01-28T23:51:39Z

examples/supabase/CommunityToolkit.Aspire.Hosting.Supabase.AppHost/Program.cs

+    .WithMigrations("<path_to_migrations_folder>")
+    .WithEdgeFunctions("<path_to_edge_functions_folder>");


obviously this is intended for example purposes, but will this have a problem when running the example app? Would it be better to leave that for the docs instead?

aaronpowell · 2026-01-28T23:57:01Z

examples/supabase/CommunityToolkit.Aspire.Hosting.Supabase.AppHost/Program.cs

+    .ConfigureAuth(auth => auth
+        .WithSiteUrl("http://localhost:3000")
+        .WithAutoConfirm(true)
+        .WithAnonymousUsers(true))
+    .ConfigureStorage(storage => storage
+        .WithFileSizeLimit(100_000_000)  // 100MB
+        .WithImageTransformation(true))
+    .ConfigureDatabase(db => db
+        .WithPassword("your-secure-password")
+        .WithPort(54322))


From an API design perspective, this doesn't align with Aspire, each of those parts should be treated as resources that you manage:

superbase.WithAuth() // pass any required args .WithSiteUrl(...) .WithAutoConfirm(true) .WithAnonymousUsers(true); superbase.WithStorage(fileSizeLimit: 100_000_000) .WithImageTransformation(true); var database = superbase.WithDatabase(password: passwordResource) .WithPort(54322);

aaronpowell · 2026-01-28T23:57:44Z

src/CommunityToolkit.Aspire.Hosting.Supabase/Builders/AuthBuilderExtensions.cs

+        Action<IResourceBuilder<SupabaseAuthResource>> configure)
+    {
+        var stack = builder.Resource;
+        if (stack.Auth == null)


Suggested change

if (stack.Auth == null)

if (stack.Auth is null)

aaronpowell · 2026-01-28T23:58:37Z

src/CommunityToolkit.Aspire.Hosting.Supabase/Builders/DatabaseBuilderExtensions.cs

+        Action<IResourceBuilder<SupabaseDatabaseResource>> configure)
+    {
+        var stack = builder.Resource;
+        if (stack.Database == null)


Suggested change

if (stack.Database == null)

if (stack.Database is null)

aaronpowell · 2026-01-29T01:06:47Z

src/CommunityToolkit.Aspire.Hosting.Supabase/Sync/ProjectSyncExtensions.cs

+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine($"[Supabase Sync] ERROR: {ex.Message}");


Use a logger not Console.

aaronpowell · 2026-01-29T01:09:16Z

src/CommunityToolkit.Aspire.Hosting.Supabase/Sync/SyncService.cs

+/// <summary>
+/// Service for synchronizing data from an online Supabase project to the local development environment.
+/// </summary>
+internal static class SyncService


My initial take on this is that it should be a resource that Aspire manages rather than just some arbitrary code that is run during the app host.

Conceptually, it's similar to an installer provided by npm, yarn, python, etc. and we should design it that way.

aaronpowell · 2026-01-29T01:09:39Z

tests/CommunityToolkit.Aspire.Hosting.Supabase.Tests/AddSupabaseTests.cs

+
+namespace CommunityToolkit.Aspire.Hosting.Supabase.Tests;
+
+[Collection("Supabase")]


We don't use collections.

aaronpowell · 2026-01-29T01:09:56Z

tests/CommunityToolkit.Aspire.Hosting.Supabase.Tests/ResourceConfigurationTests.cs

+
+namespace CommunityToolkit.Aspire.Hosting.Supabase.Tests;
+
+[Collection("Supabase")]


We don't use collections

aaronpowell · 2026-01-29T01:10:16Z

tests/CommunityToolkit.Aspire.Hosting.Supabase.Tests/SupabaseTestCollection.cs

@@ -0,0 +1,6 @@
+namespace CommunityToolkit.Aspire.Hosting.Supabase.Tests;
+
+[CollectionDefinition("Supabase", DisableParallelization = true)]


We don't use collections.

aaronpowell

I think there are the bones of a solid integration taking shape here but there's a bit of work that needs to be done before it would fit into the community toolkit.

I've left quite a few comments throughout the PR (although I didn't add them to all the resource classes as there was a set of repeated comments on all of them).

The one thing that I don't think this integration is currently doing well enough is leveraging the Aspire app model design around resource creation and management, and that will need addressing before it could be merged in.

fgilde added 4 commits January 20, 2026 15:55

Create project for supabase from Nextended

d4c83bf

move project in correct supfolder

76672dc

add tests and example project

7996e4f

add tests.yaml entries

8440e17

Update Readme

Copilot AI review requested due to automatic review settings January 20, 2026 15:51

Copilot started reviewing on behalf of fgilde January 20, 2026 15:52 View session

fgilde mentioned this pull request Jan 20, 2026

[Feature] Add Supabase integration #417

Closed

Copilot AI reviewed Jan 20, 2026

View reviewed changes

aaronpowell requested changes Jan 29, 2026

View reviewed changes

github-actions bot added the Stale label Feb 3, 2026

github-actions bot closed this Feb 5, 2026

		.WithMigrations("<path_to_migrations_folder>")
		.WithEdgeFunctions("<path_to_edge_functions_folder>");


		namespace CommunityToolkit.Aspire.Hosting.Supabase.Tests;

		[Collection("Supabase")]

		@@ -0,0 +1,6 @@
		namespace CommunityToolkit.Aspire.Hosting.Supabase.Tests;

		[CollectionDefinition("Supabase", DisableParallelization = true)]

Conversation

fgilde commented Jan 20, 2026

Overview

Features

Usage

PR Checklist

Other information

Tests

Example Project

Container Images Used

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

fgilde commented Jan 20, 2026

Uh oh!

axies20 commented Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaronpowell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronpowell left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

axies20 commented Jan 24, 2026 •

edited

Loading