Skip to content
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.

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

fix: improve Supabase liveProvider filter handling #6573

Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/shiny-panthers-nail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@refinedev/supabase": patch
---

fix: handle multiple filters in Supabase liveProvider.
This update addresses the handling of multiple filters in the Supabase liveProvider. It ensures only the first filter is applied and introduces a configurable `meta.realtimeFilter` option for custom filter behavior. A warning is logged when multiple filters are detected.

Resolves [#6360](https://github.com/refinedev/refine/issues/6360)
27 changes: 23 additions & 4 deletions packages/supabase/src/liveProvider/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import type {
import { liveTypes, supabaseTypes } from "../types";
import { mapOperator } from "../utils";

const supportedOperators = ["eq", "neq", "gt", "lt", "gte", "lte"];

export const liveProvider = (
supabaseClient: SupabaseClient<any, any, any>,
): LiveProvider => {
Expand Down Expand Up @@ -49,14 +51,31 @@ export const liveProvider = (
}
};

const mapFilter = (filters?: CrudFilters): string | undefined => {
const mapFilter = (
filters?: CrudFilters,
meta?: any,
): string | undefined => {
if (!filters || filters?.length === 0) {
return;
}

return filters
if (filters.length > 1) {
console.warn(
"Multiple filters detected. Supabase Realtime currently supports only one filter. " +
"Using the first filter. You can override this behavior by using 'meta.realtimeFilter'.",
);
}

const effectiveFilter = meta?.realtimeFilter
? [meta.realtimeFilter]
: [filters[0]];

return effectiveFilter
.map((filter: CrudFilter): string | undefined => {
if ("field" in filter) {
if (
"field" in filter &&
supportedOperators.includes(filter.operator)
) {
return `${filter.field}=${mapOperator(filter.operator)}.${
filter.value
}`;
Expand All @@ -70,7 +89,7 @@ export const liveProvider = (
const events = types
.map((x) => supabaseTypes[x])
.sort((a, b) => a.localeCompare(b));
const filter = mapFilter(params?.filters);
const filter = mapFilter(params?.filters, meta);
const ch = `${channel}:${events.join("|")}${filter ? `:${filter}` : ""}`;

let client = supabaseClient.channel(ch);
Expand Down
Loading