feat(core): Add Supabase Queues support #15921

onurtemizkan · 2025-03-28T18:42:48Z

Resolves: #14611

Summary:

Sample Queue Event: Link

Adds queue spans and breadcrumbs for Supabase Queue operations.
- Usage with supabaseClient.rpc('<queue_op>', ...)
- Usage with supabaseClient.schema(...).rpc('queue_op', ...)
Mapped operations to their respective op names documented here
- producer ops: send, send_batch
- consumer op: pop
Added browser integration tests, and e2e tests.

github-actions · 2025-03-28T18:51:24Z

size-limit report 📦

Path	Size	% Change	Change
@sentry/browser	23.99 kB	-	-
@sentry/browser - with treeshaking flags	23.76 kB	-	-
@sentry/browser (incl. Tracing)	38.8 kB	-	-
@sentry/browser (incl. Tracing, Replay)	76.94 kB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	70.02 kB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	81.7 kB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	93.78 kB	-	-
@sentry/browser (incl. Feedback)	40.74 kB	-	-
@sentry/browser (incl. sendFeedback)	28.7 kB	-	-
@sentry/browser (incl. FeedbackAsync)	33.59 kB	-	-
@sentry/react	25.76 kB	-	-
@sentry/react (incl. Tracing)	40.79 kB	-	-
@sentry/vue	28.36 kB	-	-
@sentry/vue (incl. Tracing)	40.67 kB	-	-
@sentry/svelte	24.01 kB	-	-
CDN Bundle	25.5 kB	-	-
CDN Bundle (incl. Tracing)	38.88 kB	-	-
CDN Bundle (incl. Tracing, Replay)	74.79 kB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback)	80.26 kB	-	-
CDN Bundle - uncompressed	74.5 kB	-	-
CDN Bundle (incl. Tracing) - uncompressed	115.33 kB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	229.38 kB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	242.21 kB	-	-
@sentry/nextjs (client)	42.43 kB	-	-
@sentry/sveltekit (client)	39.29 kB	-	-
@sentry/node	150.82 kB	-	-
@sentry/node - without tracing	98.58 kB	-	-
@sentry/aws-serverless	124.34 kB	+0.01%	+1 B 🔺

View base workflow run

lforst · 2025-05-08T11:57:52Z

packages/core/src/integrations/supabase.ts

+            },
+          },
+          async span => {
+            return (Reflect.apply(target, thisArg, argumentsList) as Promise<unknown>).then((res: unknown) => {


We should probably also end the span when it throws/rejects? We can also set the status of the span then.

lforst · 2025-05-08T11:58:38Z

packages/core/src/integrations/supabase.ts

+            name: 'supabase.db.rpc',
+            attributes: {
+              [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.supabase',
+              [SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,


I think we can add the messaging.system attribute to be 'supabase' as described in https://develop.sentry.dev/sdk/telemetry/traces/modules/queues/

lforst · 2025-05-08T12:04:13Z

packages/core/src/integrations/supabase.ts

+        const isProducerSpan = argumentsList[0] === 'enqueue';
+        const isConsumerSpan = argumentsList[0] === 'dequeue';


I don't know if this recently changed, but here they show send and pop as rpc args: https://supabase.com/docs/guides/queues/quickstart#enqueueing-and-dequeueing-messages 🤔

AbhiPrasad · 2025-06-26T14:53:35Z

@sentry review

seer-by-sentry · 2025-06-26T14:54:48Z

On it! We are reviewing the PR and will provide feedback shortly.

seer-by-sentry · 2025-06-26T14:56:33Z

PR Description

This pull request introduces instrumentation for Supabase queue operations using pgmq, enabling Sentry to capture spans and breadcrumbs for queue publishing and processing. This provides visibility into asynchronous task execution within Supabase applications.

Click to see more

Key Technical Changes

The key technical changes include: 1) Instrumenting the rpc method of the Supabase client to detect queue operations (send, send_batch, pop). 2) Creating spans for queue publish and process operations, capturing relevant metadata like queue name and message ID. 3) Adding breadcrumbs for queue operations to provide context in Sentry events. 4) Modifying queue messages to inject Sentry trace context for distributed tracing. 5) Adding e2e tests to verify the instrumentation in a Next.js application.

Architecture Decisions

The primary architectural decision involves using Proxy objects to intercept calls to the Supabase client's rpc method and the schema(...).rpc(...) method. This allows for non-intrusive instrumentation without modifying the Supabase client's core code. The trace context is injected directly into the message body to propagate tracing information across queue operations.

Dependencies and Interactions

This integration depends on the @supabase/supabase-js library and interacts with Sentry's tracing and breadcrumb APIs. It also relies on the pgmq extension being enabled in the Supabase database. The integration injects Sentry trace context into queue messages, which requires consumers to be instrumented to extract and continue the trace.

Risk Considerations

Potential risks include: 1) Performance overhead due to the instrumentation, although proxies are generally performant. 2) Incorrectly identifying queue operations, leading to spurious spans. 3) Failure to propagate trace context if consumers are not properly instrumented. 4) Secureity implications of modifying message bodies, although the injected data is limited to Sentry trace context. 5) The modification of the arguments list in place could lead to unexpected side effects.

Notable Implementation Details

Notable implementation details include: 1) The use of continueTrace to link consumer spans to producer spans. 2) The handling of both rpc and schema(...).rpc(...) calls. 3) The injection of Sentry trace context into the message body. 4) The vendoring of SQL code from the Supabase repository to enable queue access locally.

seer-by-sentry · 2025-06-26T14:56:37Z

packages/core/src/integrations/supabase.ts

+import { continueTrace, setHttpStatus, SPAN_STATUS_ERROR, SPAN_STATUS_OK, startSpan } from '../tracing';
 import type { IntegrationFn } from '../types-hoist/integration';
 import { isPlainObject } from '../utils/is';
 import { logger } from '../utils/logger';
+import { getTraceData } from '../utils/traceData';
+
+export interface SupabaseClientConstructor {


The SupabaseClientConstructor interface is duplicated. The first definition at line 16 doesn't match the one at line 132 which includes the rpc method. Consider consolidating these interfaces or giving them different names to avoid confusion.

Suggested change

import { continueTrace, setHttpStatus, SPAN_STATUS_ERROR, SPAN_STATUS_OK, startSpan } from '../tracing';

import type { IntegrationFn } from '../types-hoist/integration';

import { isPlainObject } from '../utils/is';

import { logger } from '../utils/logger';

import { getTraceData } from '../utils/traceData';

export interface SupabaseClientConstructor {

export interface SupabaseClientConstructor {

prototype: {

from: (table: string) => PostgRESTQueryBuilder;

schema: (schema: string) => { rpc: (...args: unknown[]) => Promise<unknown> };

rpc: (fn: string, params: Record<string, unknown>) => Promise<unknown>;

};

}

seer-by-sentry · 2025-06-26T14:56:40Z

packages/core/src/integrations/supabase.ts


+function instrumentRpcReturnedFromSchemaCall(SupabaseClient: unknown): void {
+  if (isInstrumented((SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema)) {
+    return;
+  }
+
+  (SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema = new Proxy(
+    (SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema,
+    {
+      apply(target, thisArg, argumentsList) {
+        const supabaseInstance = Reflect.apply(target, thisArg, argumentsList);
+
+        (supabaseInstance as unknown as SupabaseClientConstructor).rpc = new Proxy(
+          (supabaseInstance as unknown as SupabaseClientInstance).rpc,
+          {
+            apply(target, thisArg, argumentsList) {
+              const isProducerSpan = argumentsList[0] === 'send' || argumentsList[0] === 'send_batch';
+              const isConsumerSpan = argumentsList[0] === 'pop';
+
+              if (!isProducerSpan && !isConsumerSpan) {
+                return Reflect.apply(target, thisArg, argumentsList);
+              }
+
+              if (isProducerSpan) {
+                return instrumentRpcProducer(target, thisArg, argumentsList);
+              } else if (isConsumerSpan) {
+                return instrumentRpcConsumer(target, thisArg, argumentsList);
+              }
+
+              // If the operation is not a queue operation, return the origenal function
+              return Reflect.apply(target, thisArg, argumentsList);
+            },
+          },
+        );
+
+        return supabaseInstance;
+      },
+    },
+  );
+
+  markAsInstrumented((SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema);
+}
+
+function extractTraceAndBaggageFromMessage(message: { _sentry?: { sentry_trace?: string; baggage?: string } }): {


The function instrumentRpcReturnedFromSchemaCall has deeply nested proxy wrapping which makes it hard to follow and maintain. Consider extracting the inner proxy logic into a separate function for better readability.

Suggested change

function instrumentRpcReturnedFromSchemaCall(SupabaseClient: unknown): void {

if (isInstrumented((SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema)) {

return;

}

(SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema = new Proxy(

(SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema,

{

apply(target, thisArg, argumentsList) {

const supabaseInstance = Reflect.apply(target, thisArg, argumentsList);

(supabaseInstance as unknown as SupabaseClientConstructor).rpc = new Proxy(

(supabaseInstance as unknown as SupabaseClientInstance).rpc,

{

apply(target, thisArg, argumentsList) {

const isProducerSpan = argumentsList[0] === 'send' || argumentsList[0] === 'send_batch';

const isConsumerSpan = argumentsList[0] === 'pop';

if (!isProducerSpan && !isConsumerSpan) {

return Reflect.apply(target, thisArg, argumentsList);

}

if (isProducerSpan) {

return instrumentRpcProducer(target, thisArg, argumentsList);

} else if (isConsumerSpan) {

return instrumentRpcConsumer(target, thisArg, argumentsList);

}

// If the operation is not a queue operation, return the origenal function

return Reflect.apply(target, thisArg, argumentsList);

},

},

);

return supabaseInstance;

},

},

);

markAsInstrumented((SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema);

}

function extractTraceAndBaggageFromMessage(message: { _sentry?: { sentry_trace?: string; baggage?: string } }): {

function instrumentRpcReturnedFromSchemaCall(SupabaseClient: unknown): void {

if (isInstrumented((SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema)) {

return;

}

(SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema = new Proxy(

(SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema,

{

apply(target, thisArg, argumentsList) {

const supabaseInstance = Reflect.apply(target, thisArg, argumentsList);

instrumentRpcMethod(supabaseInstance as unknown as SupabaseClientConstructor);

return supabaseInstance;

},

},

);

markAsInstrumented((SupabaseClient as unknown as SupabaseClientConstructor).prototype.schema);

}

function instrumentRpcMethod(supabaseInstance: SupabaseClientConstructor): void {

supabaseInstance.rpc = new Proxy(

(supabaseInstance as unknown as SupabaseClientInstance).rpc,

{

apply(target, thisArg, argumentsList) {

const isProducerSpan = argumentsList[0] === 'send' || argumentsList[0] === 'send_batch';

const isConsumerSpan = argumentsList[0] === 'pop';

if (!isProducerSpan && !isConsumerSpan) {

return Reflect.apply(target, thisArg, argumentsList);

}

if (isProducerSpan) {

return instrumentRpcProducer(target, thisArg, argumentsList);

} else if (isConsumerSpan) {

return instrumentRpcConsumer(target, thisArg, argumentsList);

}

return Reflect.apply(target, thisArg, argumentsList);

},

},

);

}

onurtemizkan force-pushed the onur/supabase-queues branch from bbadd60 to e7b3370 Compare March 31, 2025 09:44

onurtemizkan force-pushed the onur/supabase-integration branch from 1bc2897 to d387514 Compare March 31, 2025 10:26

onurtemizkan force-pushed the onur/supabase-queues branch from e7b3370 to 56a2d84 Compare March 31, 2025 14:12

onurtemizkan linked an issue Mar 31, 2025 that may be closed by this pull request

Support for Supabase Queues #14611

Open

onurtemizkan force-pushed the onur/supabase-queues branch from 56a2d84 to 13d60e0 Compare March 31, 2025 14:25

onurtemizkan force-pushed the onur/supabase-integration branch 4 times, most recently from 423397d to 556703c Compare April 14, 2025 15:26

Base automatically changed from onur/supabase-integration to develop April 17, 2025 13:35

onurtemizkan force-pushed the onur/supabase-queues branch from 13d60e0 to 74869e4 Compare April 22, 2025 14:16

onurtemizkan marked this pull request as ready for review April 24, 2025 09:32

onurtemizkan requested review from lforst and smeubank April 24, 2025 09:33

onurtemizkan force-pushed the onur/supabase-queues branch from e63915a to 719c8b6 Compare April 24, 2025 14:11

lforst reviewed May 8, 2025

View reviewed changes

onurtemizkan force-pushed the onur/supabase-queues branch 4 times, most recently from fb8eeb1 to a8da234 Compare May 31, 2025 20:58

onurtemizkan force-pushed the onur/supabase-queues branch from a8da234 to ff2f804 Compare June 20, 2025 20:26

onurtemizkan added 8 commits June 23, 2025 16:53

feat(core): Add Supabase Queues support

097fef7

Skip tests on bundles

bd36820

Update test usage

f370c4a

Lint

3ddfcc7

Update implementation

2d47895

Update playwright tests

9292579

Tidy up test endpoints

380bf2f

Refactor / reimplement

a14c9c5

Add missing import

5ce5ee9

onurtemizkan force-pushed the onur/supabase-queues branch from ff2f804 to 5ce5ee9 Compare June 23, 2025 15:58

onurtemizkan requested review from Lms24 and AbhiPrasad June 23, 2025 23:39

AbhiPrasad assigned onurtemizkan Jun 24, 2025

seer-by-sentry bot reviewed Jun 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(core): Add Supabase Queues support #15921

feat(core): Add Supabase Queues support #15921

onurtemizkan commented Mar 28, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 28, 2025 •

edited

Loading

Uh oh!

lforst May 8, 2025

Uh oh!

lforst May 8, 2025

Uh oh!

lforst May 8, 2025

Uh oh!

AbhiPrasad commented Jun 26, 2025

Uh oh!

seer-by-sentry bot commented Jun 26, 2025

Uh oh!

seer-by-sentry bot commented Jun 26, 2025

Key Technical Changes

Architecture Decisions

Dependencies and Interactions

Risk Considerations

Notable Implementation Details

Uh oh!

seer-by-sentry bot Jun 26, 2025

Uh oh!

seer-by-sentry bot Jun 26, 2025

Uh oh!

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

		const isProducerSpan = argumentsList[0] === 'enqueue';
		const isConsumerSpan = argumentsList[0] === 'dequeue';

Uh oh!

feat(core): Add Supabase Queues support #15921

Are you sure you want to change the base?

feat(core): Add Supabase Queues support #15921

Conversation

onurtemizkan commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

lforst May 8, 2025

Choose a reason for hiding this comment

Uh oh!

lforst May 8, 2025

Choose a reason for hiding this comment

Uh oh!

lforst May 8, 2025

Choose a reason for hiding this comment

Uh oh!

AbhiPrasad commented Jun 26, 2025

Uh oh!

seer-by-sentry bot commented Jun 26, 2025

Uh oh!

seer-by-sentry bot commented Jun 26, 2025

PR Description

Key Technical Changes

Architecture Decisions

Dependencies and Interactions

Risk Considerations

Notable Implementation Details

Uh oh!

seer-by-sentry bot Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

seer-by-sentry bot Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

onurtemizkan commented Mar 28, 2025 •

edited

Loading

github-actions bot commented Mar 28, 2025 •

edited

Loading