-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(core): Add Supabase Queues support #15921
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
Open
onurtemizkan
wants to merge
28
commits into
develop
Choose a base branch
from
onur/supabase-queues
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
6d96d3d
feat(core): Add Supabase Queues support
onurtemizkan 3340443
Skip tests on bundles
onurtemizkan e9d0376
Update test usage
onurtemizkan 99426e7
Lint
onurtemizkan e6a17c1
Update implementation
onurtemizkan 3486f90
Update playwright tests
onurtemizkan 72b7f6f
Tidy up test endpoints
onurtemizkan 8b10113
Refactor / reimplement
onurtemizkan c16c56c
Add missing import
onurtemizkan 034cc1d
Rename `SupabaseClientConstructor` to `SupabaseClientConstructorType`
onurtemizkan 0e4c4be
Extract `instrumentRpcMethod`
onurtemizkan 7678945
WIP
onurtemizkan e417fcf
Match with OTEL semantics improve tests
onurtemizkan f8c0d78
Add OTEL operation attributes to queue spans
onurtemizkan a974e97
Fix browser integration tests
onurtemizkan 8e97fbf
Improve data integrity and distributed tracing
onurtemizkan dfea61c
Use span links for consumer distributed tracing, fix prototype instru…
onurtemizkan d2dcf81
Fix mutation and safety issues, ignore, empty queue consumers
onurtemizkan 76d8e2d
Simplify queue spans and fix missing span.end() calls
onurtemizkan ef28d53
Re-address review comments
onurtemizkan 9e121d6
Address review comments
onurtemizkan ee21d9e
Fix linter
onurtemizkan ab4acb8
Add array check for `messages` from params
onurtemizkan 5aa6be2
Remove rethrowing errors
onurtemizkan fcbc6c1
Use OTEL-compliant `messaging.batch.message_count` attribute.
onurtemizkan 45e536e
Add missing telemetry for empty Supabase queue consumer responses
onurtemizkan 71c40cf
Refactor Supabase integration into separate modules
onurtemizkan e6eca29
Fix TypeScript build errors and double-wrap guard
onurtemizkan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
34 changes: 34 additions & 0 deletions
34
dev-packages/browser-integration-tests/suites/integrations/supabase/queues-rpc/init.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
| import { createClient } from '@supabase/supabase-js'; | ||
|
|
||
| window.Sentry = Sentry; | ||
|
|
||
| const supabaseClient = createClient('https://test.supabase.co', 'test-key', { | ||
| db: { | ||
| schema: 'pgmq_public', | ||
| }, | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration({ supabaseClient })], | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
|
|
||
| // Simulate queue operations | ||
| async function performQueueOperations() { | ||
| try { | ||
| await supabaseClient.rpc('send', { | ||
| queue_name: 'todos', | ||
| message: { title: 'Test Todo' }, | ||
| }); | ||
|
|
||
| await supabaseClient.rpc('pop', { | ||
| queue_name: 'todos', | ||
| }); | ||
| } catch (error) { | ||
| Sentry.captureException(error); | ||
| } | ||
| } | ||
|
|
||
| performQueueOperations(); | ||
82 changes: 82 additions & 0 deletions
82
dev-packages/browser-integration-tests/suites/integrations/supabase/queues-rpc/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import type { Page } from '@playwright/test'; | ||
| import { expect } from '@playwright/test'; | ||
| import type { Event } from '@sentry/core'; | ||
| import { sentryTest } from '../../../../utils/fixtures'; | ||
| import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers'; | ||
|
|
||
| async function mockSupabaseRoute(page: Page) { | ||
| await page.route('**/rpc/send', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| body: JSON.stringify([0]), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| await page.route('**/rpc/pop', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| body: JSON.stringify([ | ||
| { | ||
| msg_id: 0, | ||
| }, | ||
| ]), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| }, | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| const bundle = process.env.PW_BUNDLE || ''; | ||
| // We only want to run this in non-CDN bundle mode | ||
| if (bundle.startsWith('bundle')) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| sentryTest('should capture Supabase queue spans from client.rpc', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipTracingTest()) { | ||
| return; | ||
| } | ||
|
|
||
| await mockSupabaseRoute(page); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
|
|
||
| const event = await getFirstSentryEnvelopeRequest<Event>(page, url); | ||
| const queueSpans = event.spans?.filter(({ op }) => op?.startsWith('queue.')); | ||
|
|
||
| expect(queueSpans).toHaveLength(2); | ||
|
|
||
| expect(queueSpans![0]).toMatchObject({ | ||
| description: 'publish todos', | ||
| parent_span_id: event.contexts?.trace?.span_id, | ||
| span_id: expect.any(String), | ||
| start_timestamp: expect.any(Number), | ||
| timestamp: expect.any(Number), | ||
| trace_id: event.contexts?.trace?.trace_id, | ||
| data: expect.objectContaining({ | ||
| 'sentry.op': 'queue.publish', | ||
| 'sentry.origin': 'auto.db.supabase.queue.producer', | ||
| 'messaging.destination.name': 'todos', | ||
| 'messaging.message.id': '0', | ||
| }), | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }); | ||
|
|
||
| expect(queueSpans![1]).toMatchObject({ | ||
| description: 'process todos', | ||
| parent_span_id: event.contexts?.trace?.span_id, | ||
| span_id: expect.any(String), | ||
| start_timestamp: expect.any(Number), | ||
| timestamp: expect.any(Number), | ||
| trace_id: event.contexts?.trace?.trace_id, | ||
| data: expect.objectContaining({ | ||
| 'sentry.op': 'queue.process', | ||
| 'sentry.origin': 'auto.db.supabase.queue.consumer', | ||
| 'messaging.destination.name': 'todos', | ||
| 'messaging.message.id': '0', | ||
| }), | ||
| }); | ||
| }); | ||
33 changes: 33 additions & 0 deletions
33
...es/browser-integration-tests/suites/integrations/supabase/queues-schema-qualified/init.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
| import { createClient } from '@supabase/supabase-js'; | ||
|
|
||
| window.Sentry = Sentry; | ||
|
|
||
| const supabaseClient = createClient('https://test.supabase.co', 'test-key', { | ||
| db: { | ||
| schema: 'pgmq_public', | ||
| }, | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration({ supabaseClient })], | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
|
|
||
| async function performQueueOperations() { | ||
| try { | ||
| await supabaseClient.rpc('pgmq.send', { | ||
| queue_name: 'todos', | ||
| message: { title: 'Test Todo' }, | ||
| }); | ||
|
|
||
| await supabaseClient.rpc('pgmq.pop', { | ||
| queue_name: 'todos', | ||
| }); | ||
| } catch (error) { | ||
| Sentry.captureException(error); | ||
| } | ||
| } | ||
|
|
||
| performQueueOperations(); |
82 changes: 82 additions & 0 deletions
82
...es/browser-integration-tests/suites/integrations/supabase/queues-schema-qualified/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import type { Page } from '@playwright/test'; | ||
| import { expect } from '@playwright/test'; | ||
| import type { Event } from '@sentry/core'; | ||
| import { sentryTest } from '../../../../utils/fixtures'; | ||
| import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers'; | ||
|
|
||
| async function mockSupabaseRoute(page: Page) { | ||
| await page.route('**/rpc/pgmq.send', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| body: JSON.stringify([0]), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| await page.route('**/rpc/pgmq.pop', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| body: JSON.stringify([ | ||
| { | ||
| msg_id: 0, | ||
| }, | ||
| ]), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| }, | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| const bundle = process.env.PW_BUNDLE || ''; | ||
| // We only want to run this in non-CDN bundle mode | ||
| if (bundle.startsWith('bundle')) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| sentryTest('should capture Supabase queue spans from schema-qualified RPC names', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipTracingTest()) { | ||
| return; | ||
| } | ||
|
|
||
| await mockSupabaseRoute(page); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
|
|
||
| const event = await getFirstSentryEnvelopeRequest<Event>(page, url); | ||
| const queueSpans = event.spans?.filter(({ op }) => op?.startsWith('queue.')); | ||
|
|
||
| expect(queueSpans).toHaveLength(2); | ||
|
|
||
| expect(queueSpans![0]).toMatchObject({ | ||
| description: 'publish todos', | ||
| parent_span_id: event.contexts?.trace?.span_id, | ||
| span_id: expect.any(String), | ||
| start_timestamp: expect.any(Number), | ||
| timestamp: expect.any(Number), | ||
| trace_id: event.contexts?.trace?.trace_id, | ||
| data: expect.objectContaining({ | ||
| 'sentry.op': 'queue.publish', | ||
| 'sentry.origin': 'auto.db.supabase.queue.producer', | ||
| 'messaging.destination.name': 'todos', | ||
| 'messaging.message.id': '0', | ||
| }), | ||
| }); | ||
|
|
||
| expect(queueSpans![1]).toMatchObject({ | ||
| description: 'process todos', | ||
| parent_span_id: event.contexts?.trace?.span_id, | ||
| span_id: expect.any(String), | ||
| start_timestamp: expect.any(Number), | ||
| timestamp: expect.any(Number), | ||
| trace_id: event.contexts?.trace?.trace_id, | ||
| data: expect.objectContaining({ | ||
| 'sentry.op': 'queue.process', | ||
| 'sentry.origin': 'auto.db.supabase.queue.consumer', | ||
| 'messaging.destination.name': 'todos', | ||
| 'messaging.message.id': '0', | ||
| }), | ||
| }); | ||
| }); |
34 changes: 34 additions & 0 deletions
34
dev-packages/browser-integration-tests/suites/integrations/supabase/queues-schema/init.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
| import { createClient } from '@supabase/supabase-js'; | ||
|
|
||
| window.Sentry = Sentry; | ||
|
|
||
| const supabaseClient = createClient('https://test.supabase.co', 'test-key', { | ||
| db: { | ||
| schema: 'pgmq_public', | ||
| }, | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration({ supabaseClient })], | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
|
|
||
| // Simulate queue operations | ||
| async function performQueueOperations() { | ||
| try { | ||
| await supabaseClient.schema('pgmq_public').rpc('send', { | ||
| queue_name: 'todos', | ||
| message: { title: 'Test Todo' }, | ||
| }); | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| await supabaseClient.schema('pgmq_public').rpc('pop', { | ||
| queue_name: 'todos', | ||
| }); | ||
| } catch (error) { | ||
| Sentry.captureException(error); | ||
| } | ||
| } | ||
|
|
||
| performQueueOperations(); | ||
83 changes: 83 additions & 0 deletions
83
dev-packages/browser-integration-tests/suites/integrations/supabase/queues-schema/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| import type { Page } from '@playwright/test'; | ||
| import { expect } from '@playwright/test'; | ||
| import type { Event } from '@sentry/core'; | ||
| import { sentryTest } from '../../../../utils/fixtures'; | ||
| import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers'; | ||
|
|
||
| async function mockSupabaseRoute(page: Page) { | ||
| await page.route('**/rpc/send', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| body: JSON.stringify([0]), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| await page.route('**/rpc/pop', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| body: JSON.stringify([ | ||
| { | ||
| msg_id: 0, | ||
| }, | ||
| ]), | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| }, | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| const bundle = process.env.PW_BUNDLE || ''; | ||
| // We only want to run this in non-CDN bundle mode | ||
| if (bundle.startsWith('bundle')) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| sentryTest('should capture Supabase queue spans from client.schema(...).rpc', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipTracingTest()) { | ||
| return; | ||
| } | ||
|
|
||
| await mockSupabaseRoute(page); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
|
|
||
| const event = await getFirstSentryEnvelopeRequest<Event>(page, url); | ||
|
|
||
| const queueSpans = event.spans?.filter(({ op }) => op?.startsWith('queue.')); | ||
|
|
||
| expect(queueSpans).toHaveLength(2); | ||
|
|
||
| expect(queueSpans![0]).toMatchObject({ | ||
| description: 'publish todos', | ||
| parent_span_id: event.contexts?.trace?.span_id, | ||
| span_id: expect.any(String), | ||
| start_timestamp: expect.any(Number), | ||
| timestamp: expect.any(Number), | ||
| trace_id: event.contexts?.trace?.trace_id, | ||
| data: expect.objectContaining({ | ||
| 'sentry.op': 'queue.publish', | ||
| 'sentry.origin': 'auto.db.supabase.queue.producer', | ||
| 'messaging.destination.name': 'todos', | ||
| 'messaging.message.id': '0', | ||
| }), | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }); | ||
|
|
||
| expect(queueSpans![1]).toMatchObject({ | ||
| description: 'process todos', | ||
| parent_span_id: event.contexts?.trace?.span_id, | ||
| span_id: expect.any(String), | ||
| start_timestamp: expect.any(Number), | ||
| timestamp: expect.any(Number), | ||
| trace_id: event.contexts?.trace?.trace_id, | ||
| data: expect.objectContaining({ | ||
| 'sentry.op': 'queue.process', | ||
| 'sentry.origin': 'auto.db.supabase.queue.consumer', | ||
| 'messaging.destination.name': 'todos', | ||
| 'messaging.message.id': '0', | ||
| }), | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.