Supabase.Functions 8.0.0

Supabase.Functions

A C# client for invoking Supabase Edge Functions.

Part of the Supabase C# SDK. Most projects use it through the Supabase meta-package (supabase.Functions); reference this package directly when you only need to invoke functions.

Installation

dotnet add package Supabase.Functions

Targets .NET Standard 2.0.

Getting started

Create a client pointed at your project's Functions URL, then invoke a function by name:

using Supabase.Functions;

var client = new Client("https://PROJECT_ID.supabase.co/functions/v1");

// Invoke and read the raw string response.
var body = await client.Invoke("hello-world", token: SUPABASE_ANON_KEY);

Invoke needs a bearer token to authorize the request — your project's anon key, or a user's access token. Through the Supabase meta-package the token is supplied for you.

Deserializing the response

Use the generic overload to deserialize the JSON body into a type:

var result = await client.Invoke<MyResponse>("hello-world", token: SUPABASE_ANON_KEY);

Passing a body, headers, method, or region

InvokeFunctionOptions covers the common per-call settings:

var options = new Client.InvokeFunctionOptions
{
    Body = new Dictionary<string, object> { { "name", "world" } },
    Headers = new Dictionary<string, string> { { "x-trace", "abc" } },
    HttpMethod = HttpMethod.Post,
    FunctionRegion = FunctionRegion.UsEast1
};

var result = await client.Invoke<MyResponse>("hello-world", token: SUPABASE_ANON_KEY, options);

Observability (OpenTelemetry)

The client emits traces and metrics through System.Diagnostics, so you can wire them into OpenTelemetry (or any ActivityListener / MeterListener) without taking a dependency on the OpenTelemetry packages. Emission is zero-cost while nothing is listening, so it is always on and stays silent until you subscribe.

Register the client's ActivitySource and Meter by name. Use the FunctionsDiagnostics.SourceName constant rather than hardcoding the string, so a typo becomes a compile error instead of a silent no-op:

using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;
using Supabase.Functions;

// Requires OpenTelemetry.Extensions.Hosting and an exporter package (e.g. OTLP) in your app.
builder.Services.AddOpenTelemetry()
    .WithTracing(tracing => tracing
        .AddSource(FunctionsDiagnostics.SourceName)
        .AddOtlpExporter())
    .WithMetrics(metrics => metrics
        .AddMeter(FunctionsDiagnostics.SourceName)
        .AddOtlpExporter());

Once subscribed you get:

• A client span per invocation, named {METHOD} {path} and following OpenTelemetry HTTP conventions (method, status code, and a sanitized URL — the query string is never recorded, and neither is the request body). A faas.invoked_name tag carries the invoked function name. A relay error is reported as a failed span even when the HTTP status is a success.
• A supabase.functions.invoke.duration histogram (seconds), tagged with method, host, path, function name, and status code.

If you are not using the OpenTelemetry SDK, a raw listener works too:

using System.Diagnostics;
using Supabase.Functions;

using var listener = new ActivityListener
{
    ShouldListenTo = source => source.Name == FunctionsDiagnostics.SourceName,
    Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllData,
    ActivityStopped = activity => Console.WriteLine($"{activity.OperationName} {activity.Duration.TotalMilliseconds}ms {activity.Status}")
};
ActivitySource.AddActivityListener(listener);

Contributing

Contributions are welcome. See the repository root for how to build and test the SDK.

License

MIT