Skip to content

feat(realtime): implement filter query builder to postgres changes #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
diegofesanto wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

feat(realtime): implement filter query builder to postgres changes #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e3c491
feat(realtime): add filter like postgrest parity
diegofesanto Aug 22, 2026
6f25665
feat(realtime): improve scalar validation
diegofesanto Aug 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
306 changes: 306 additions & 0 deletions packages/Realtime/Realtime.Tests/PostgresChanges/Filter/PostgresFilterBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,306 @@
using System;
using System.Collections.Generic;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Supabase.Realtime.PostgresChanges.Filter;

namespace Realtime.Tests.PostgresChanges.Filter;

[TestClass]
[TestCategory("Unit")]
public class PostgresFilterBuilderTests
{
[TestMethod]
[DataRow("test", "test")]
[DataRow("\"test\"", "\"\\\"test\\\"\"")]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
[DataRow(1.5D, "1.5")]
[DataRow(1.5F, "1.5")]
[DataRow(true, "true")]
[DataRow("Hello, World", "\"Hello, World\"")]
public void Filter_ShouldCreateEqual_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Eq;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Eq(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
public void Filter_ShouldCreateEqualChained_GivenInput()
{
const string column1 = "user";
const string column2 = "account";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Eq;
var expected =
$"{column1}={filterOperator.ToMappedString()}.test,{column2}={filterOperator.ToMappedString()}.test";

var result = PostgresFilterBuilder
.Builder()
.Eq(column1, "test")
.Eq(column2, "test")
.Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("open", "open")]
[DataRow("closed", "closed")]
public void Filter_ShouldCreateIsDistinct_GivenInput(object value, string expect)
{
const string column = "status";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.IsDistinct;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().IsDistinct(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("test", "test")]
[DataRow("\"test\"", "\"\\\"test\\\"\"")]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
[DataRow(true, "true")]
[DataRow("Hello, World", "\"Hello, World\"")]
public void Filter_ShouldCreateNotEqual_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Neq;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Neq(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
public void Filter_ShouldCreateLt_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Lt;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Lt(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
public void Filter_ShouldCreateLte_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Lte;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Lte(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
public void Filter_ShouldCreateGt_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Gt;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Gt(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
public void Filter_ShouldCreateGte_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Gte;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Gte(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow(new object[] { "1", "2", "3", "4" }, "(1,2,3,4)")]
[DataRow(new object[] { "hello", "world" }, "(hello,world)")]
[DataRow(new object[] { "hello, world", "world" }, "(\"hello, world\",world)")]
[DataRow(new object[] { 1, 2, 3, 4 }, "(1,2,3,4)")]
public void Filter_ShouldCreateIn_GivenInput(IEnumerable<object?> value, string expect)
{
const string column = "description";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.In;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().In(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("test%", "test%")]
[DataRow("\"%test\"", "\"\\\"%test\\\"\"")]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
[DataRow(true, "true")]
[DataRow("%Hello, World%", "\"%Hello, World%\"")]
public void Filter_ShouldCreateLike_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Like;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Like(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("test%", "test%")]
[DataRow("\"%test\"", "\"\\\"%test\\\"\"")]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
[DataRow(true, "true")]
[DataRow("%Hello, World%", "\"%Hello, World%\"")]
public void Filter_ShouldCreateILike_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.ILike;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().ILike(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("test%", "test%")]
[DataRow("\"%test\"", "\"\\\"%test\\\"\"")]
[DataRow(2, "2")]
[DataRow(2D, "2")]
[DataRow(2F, "2")]
[DataRow(true, "true")]
[DataRow("%Hello, World%", "\"%Hello, World%\"")]
public void Filter_ShouldCreateNot_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.ILike;
var expected = $"{column}=not.{filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Not(column, filterOperator, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow(new object[] { "1", "2", "3", "4" }, "(1,2,3,4)")]
[DataRow(new object[] { "hello", "world" }, "(hello,world)")]
[DataRow(new object[] { "hello, world", "world" }, "(\"hello, world\",world)")]
[DataRow(new object[] { 1, 2, 3, 4 }, "(1,2,3,4)")]
public void Filter_ShouldCreateNotIn_GivenInput(IEnumerable<object?> value, string expect)
{
const string column = "description";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.In;
var expected = $"{column}=not.{filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Not(column, filterOperator, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("null", "null")]
[DataRow(null, "null")]
[DataRow(true, "true")]
[DataRow(false, "false")]
public void Filter_ShouldCreateIs_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Is;
var expected = $"{column}={filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Is(column, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
[DataRow("null", "null")]
[DataRow(null, "null")]
[DataRow(true, "true")]
[DataRow(false, "false")]
public void Filter_ShouldCreateNotIs_GivenInput(object value, string expect)
{
const string column = "user";
const PostgresChangesFilterOperator filterOperator = PostgresChangesFilterOperator.Is;
var expected = $"{column}=not.{filterOperator.ToMappedString()}.{expect}";

var result = PostgresFilterBuilder.Builder().Not(column, filterOperator, value).Build();

Assert.IsNotNull(result);
Assert.AreEqual(expected, result);
}

[TestMethod]
public void Filter_ShouldThrow_GivenInWithString()
{
Assert.Throws<ArgumentException>(() =>
PostgresFilterBuilder
.Builder()
.Not("status", PostgresChangesFilterOperator.In, "open")
.Build()
);
}

[TestMethod]
public void Filter_ShouldThrow_GivenInWithEmptyCollection()
{
Assert.Throws<ArgumentException>(() =>
PostgresFilterBuilder.Builder().In("status", Array.Empty<object?>()).Build()
);
}

[TestMethod]
public void Filter_ShouldThrow_GivenIsWithInvalidString()
{
Assert.Throws<ArgumentException>(() =>
PostgresFilterBuilder.Builder().Is("status", "open").Build()
);
}
}
17 changes: 12 additions & 5 deletions packages/Realtime/Realtime.Tests/PostgresChanges/PostgresChangesDeliveryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using Supabase.Realtime;
using Supabase.Realtime.Interfaces;
using Supabase.Realtime.PostgresChanges;
using Supabase.Realtime.PostgresChanges.Filter;
using static Supabase.Realtime.Constants;
using static Supabase.Realtime.PostgresChanges.PostgresChangesOptions;

Expand Down Expand Up @@ -68,12 +69,13 @@ public async Task OnPostgresChange_ShouldReceiveFilteredInsert()
{
var tsc = new TaskCompletionSource<bool>();
var channel = socketClient.Channel("realtime", "public", "todos");
var filter = PostgresFilterBuilder.Builder().Eq("details", "Client receives filtered insert callback? ✅");
channel.OnPostgresChange((_, changes) =>
{
Assert.AreEqual("Client receives filtered insert callback? ✅", changes.Model<Todo>()?.Details);
tsc.SetResult(true);
}, ListenType.Inserts,
new PostgresChangesFilter { Table = "todos", Filter = "details=eq.Client receives filtered insert callback? ✅" });
new PostgresChangesFilter { Table = "todos", Filter = filter.Build() });
await channel.Subscribe();
await restClient.Table<Todo>().Insert(new Todo { UserId = 1, Details = "Client receives insert callback? ✅" });
await restClient.Table<Todo>().Insert(new Todo { UserId = 2, Details = "Client receives filtered insert callback? ✅" });
Expand Down Expand Up @@ -105,11 +107,12 @@ await restClient.Table<Todo>()
tsc.SetResult(true);
}, ListenType.Updates, new PostgresChangesFilter { Table = "todos" });
const string filter = "Client receives filtered insert callback? ✅";
var filterBuilder = PostgresFilterBuilder.Builder().Eq("details", filter);
channel.OnPostgresChange((_, changes) =>
{
Assert.AreEqual("Client receives filtered insert callback? ✅", changes.Model<Todo>()?.Details);
tsc.SetResult(true);
}, ListenType.Inserts, new PostgresChangesFilter { Table = "todos", Filter = $"details=eq.{filter}" });
}, ListenType.Inserts, new PostgresChangesFilter { Table = "todos", Filter = filterBuilder.Build() });
await channel.Subscribe();
await restClient.Table<Todo>().Set(x => x.Details!, newDetails).Match(model).Update();
Assert.IsTrue(await tsc.Task);
Expand Down Expand Up @@ -164,14 +167,15 @@ public async Task OnPostgresChange_ShouldReceiveFilteredDelete()
var todo1 = await restClient.Table<Todo>().Insert(new Todo { UserId = 1, Details = "Client receives callbacks 1? ✅" });
var todo2 = await restClient.Table<Todo>().Insert(new Todo { UserId = 2, Details = "Client receives callbacks 2? ✅" });
await restClient.Table<Todo>().Insert(new Todo { UserId = 3, Details = "Client receives callbacks 3? ✅" });
var filterBuilder = PostgresFilterBuilder.Builder().Eq("details", todo1.Model?.Details);
channel.OnPostgresChange((_, removed) =>
{
var result = removed.OldModel<Todo>();
Assert.AreEqual(result?.Details, todo1.Model?.Details);
Assert.AreNotEqual(result?.Details, todo2.Model?.Details);
tsc.SetResult(true);
}, ListenType.Deletes,
new PostgresChangesFilter { Table = "todos", Filter = $"details=eq.{todo1.Model?.Details}" });
new PostgresChangesFilter { Table = "todos", Filter = filterBuilder.Build() });
await channel.Subscribe();
await restClient.Table<Todo>().Match(todo1.Models.First()).Delete();
await restClient.Table<Todo>().Match(todo2.Models.First()).Delete();
Expand Down Expand Up @@ -213,6 +217,9 @@ public async Task OnPostgresChange_ShouldFanOutToMultipleInsertListeners()
var insertTask3 = new TaskCompletionSource<bool>();
const string filter1 = "Client receives callbacks 1? ✅";
const string filter2 = "Client receives callbacks 2? ✅";
var filterBuilder1 = PostgresFilterBuilder.Builder().Eq("details", filter1).Build();
var filterBuilder2 = PostgresFilterBuilder.Builder().Eq("details", filter2).Build();

var channel = socketClient.Channel("realtime", "public", "todos");
var count = 0;
channel.OnPostgresChange((_, _) =>
Expand All @@ -222,10 +229,10 @@ public async Task OnPostgresChange_ShouldFanOutToMultipleInsertListeners()
}, ListenType.Inserts, new PostgresChangesFilter { Table = "todos" });
channel.OnPostgresChange((_, added) =>
insertTask2.SetResult(added.Model<Todo>()?.Details == filter1), ListenType.Inserts,
new PostgresChangesFilter { Table = "todos", Filter = $"details=eq.{filter1}" });
new PostgresChangesFilter { Table = "todos", Filter = filterBuilder1 });
channel.OnPostgresChange((_, added) =>
insertTask3.SetResult(added.Model<Todo>()?.Details == filter2), ListenType.Inserts,
new PostgresChangesFilter { Table = "todos", Filter = $"details=eq.{filter2}" });
new PostgresChangesFilter { Table = "todos", Filter = filterBuilder2 });
await channel.Subscribe();
await restClient.Table<Todo>().Insert(new Todo { UserId = 1, Details = "Client receives wildcard callbacks? ✅" });
await restClient.Table<Todo>().Insert(new Todo { UserId = 1, Details = filter1 });
Expand Down
Loading
Loading