feat: Add Supabase Integration #15719

onurtemizkan · 2025-03-18T09:59:49Z

Summary:

Ports https://github.com/supabase-community/sentry-integration-js into @sentry/core
Adds support for auth and auth.admin operations
Adds browser integration tests
Adds E2E tests running on NextJS

github-actions · 2025-03-18T10:06:21Z

size-limit report 📦

⚠️ Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

Path	Size	% Change	Change
@sentry/browser	23.28 KB	-	-
@sentry/browser - with treeshaking flags	23.12 KB	-	-
@sentry/browser (incl. Tracing)	36.99 KB	-	-
@sentry/browser (incl. Tracing, Replay)	74.17 KB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	67.55 KB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	78.83 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	90.65 KB	-	-
@sentry/browser (incl. Feedback)	39.68 KB	-	-
@sentry/browser (incl. sendFeedback)	27.9 KB	-	-
@sentry/browser (incl. FeedbackAsync)	32.67 KB	-	-
@sentry/react	25.09 KB	-	-
@sentry/react (incl. Tracing)	38.91 KB	-	-
@sentry/vue	27.51 KB	-	-
@sentry/vue (incl. Tracing)	38.71 KB	-	-
@sentry/svelte	23.32 KB	-	-
CDN Bundle	24.51 KB	-	-
⛔️ CDN Bundle (incl. Tracing) (max: 38.09 KB)	38.47 KB	+4.02%	+1.49 KB 🔺
CDN Bundle (incl. Tracing, Replay)	73.51 KB	+2.06%	+1.48 KB 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)	78.64 KB	+1.9%	+1.47 KB 🔺
CDN Bundle - uncompressed	71.47 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	113.28 KB	+3.61%	+3.94 KB 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed	224.57 KB	+1.79%	+3.94 KB 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	237.1 KB	+1.69%	+3.94 KB 🔺
@sentry/nextjs (client)	40.53 KB	-	-
@sentry/sveltekit (client)	37.44 KB	-	-
@sentry/node	143.23 KB	-	-
@sentry/node - without tracing	96.47 KB	-0.01%	-1 B 🔽
@sentry/aws-serverless	120.77 KB	-	-

View base workflow run

smeubank · 2025-03-28T09:29:33Z

lookin good @onurtemizkan! part of getting this in will be updating the docs, and we can do some changelog post and updates to landing page, but i can help with all that it's simple

onurtemizkan · 2025-03-28T10:36:54Z

@smeubank thanks, it would be great! We can then merge in queues support separately.

s1gr1d · 2025-04-01T09:00:43Z

packages/core/src/integrations/supabase.ts

+  AUTH_ADMIN_OPERATIONS_TO_INSTRUMENT.forEach((operation: AuthAdminOperationName) => {
+    const authAdminOperation = auth.admin[operation];
+    if (typeof authAdminOperation === 'function') {
+      auth.admin[operation] = instrumentAuthOperation(authAdminOperation);


Doesn't this need the isAdmin as a second parameter if it is an admin operation? 🤔

Maybe also add a test for the admin behavior.

s1gr1d · 2025-04-01T09:16:51Z

packages/core/src/integrations/supabase.ts

+
+function instrumentSupabaseAuthClient(supabaseClientInstance: SupabaseClientInstance): void {
+  const auth = supabaseClientInstance.auth;
+


Do we need to check for instrumented.has() here as well?

s1gr1d · 2025-04-01T09:25:57Z

packages/core/src/integrations/supabase.ts

+type AuthOperationFn = (...args: unknown[]) => Promise<unknown>;
+type AuthOperationName = (typeof AUTH_OPERATIONS_TO_INSTRUMENT)[number];
+type AuthAdminOperationName = (typeof AUTH_ADMIN_OPERATIONS_TO_INSTRUMENT)[number];
+type PostgrestQueryOperationName = (typeof AVAILABLE_OPERATIONS)[number];


Just to be sure: This is PostgREST and not PostgreSQL?

Super Nit: Call the variable PostgREST.... so it's easier to read and understand. As it was lower-case, I read PostgreSQL at first sight.

Also valid for all other variable names in the file. But ignore this comment if you think this is not necessary.

I believe yes @s1gr1d. Some more context here

supabase-community/sentry-integration-js#5 (comment)

and

getsentry/relay#3153

s1gr1d · 2025-04-01T09:37:00Z

packages/core/src/integrations/supabase.ts

+        const table = pathParts.length > 0 ? pathParts[pathParts.length - 1] : '';
+        const description = `from(${table})`;
+
+        const query: string[] = [];


As it's an array, I would suggest adding items to the name. "Query" kinda suggests it's a string.

Suggested change

const query: string[] = [];

const queryItems: string[] = [];

packages/core/src/integrations/supabase.ts

s1gr1d · 2025-04-01T09:47:12Z

packages/core/src/integrations/supabase.ts

+  };
+}) satisfies IntegrationFn;
+
+export const supabaseIntegration = defineIntegration((supabaseClient: unknown) => {


~~Should the supabaseIntegration be added by default? If yes, then you should add it to getDefaultIntegrations.~~

Edit: Ah, as the supabase client needs to be passed, it actually cannot be default 🤔

s1gr1d · 2025-04-01T09:49:37Z

dev-packages/e2e-tests/test-applications/supabase-nextjs/README.md

It's fine to delete this file if it's empty

s1gr1d · 2025-04-01T09:51:01Z

dev-packages/e2e-tests/test-applications/supabase-nextjs/lib/initSupabaseAdmin.ts

+// These are the default development keys for a local Supabase instance
+const NEXT_PUBLIC_SUPABASE_URL = 'http://localhost:54321';
+const SUPABASE_SERVICE_ROLE_KEY =
+  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU';


Is it okay to leave this here? Or should we rather add this to the environment?

Same for NEXT_PUBLIC_SUPABASE_ANON_KEY

These are default local supabase server keys. I think it's ok to leave them here.

lforst

A first pass - but it's already looking great!

lforst · 2025-04-07T13:43:53Z

packages/core/src/integrations/supabase.ts

+export const supabaseIntegration = defineIntegration((supabaseClient: unknown) => {
+  return {


Different comment here: The client as a simple first arg leaves us a bit unflexible in the future. I would almost make the integration accept an options object with a supabaseClient property.

lforst · 2025-04-07T13:44:39Z

packages/core/src/integrations/supabase.ts

+
+export const supabaseIntegration = defineIntegration((supabaseClient: unknown) => {
+  return {
+    ..._supabaseIntegration(supabaseClient),


Can we inline this? I don't fully get the purpose of spreading a function here.

lforst · 2025-04-07T13:46:44Z

packages/core/src/integrations/supabase.ts

+const _supabaseIntegration = (supabaseClient => {
+  // Instrumenting here instead of `setup` or `setupOnce` because we may need to instrument multiple clients.
+  // So we don't want the instrumentation is skipped because the integration is already installed.
+  instrumentSupabase(supabaseClient);


If we potentially need to instrument multiple clients. Would it make sense to either

make the integration also accept an array of clients as args

maybe export the instrumentSupabase() function so that people can actually call Sentry.init() before they instantiate their supabase clients?

lforst · 2025-04-07T13:47:15Z

packages/core/src/integrations/supabase.ts

+
+const instrumentSupabase = (supabaseClientInstance: unknown): void => {
+  if (!supabaseClientInstance) {
+    throw new Error('Supabase client instance is not available.');


I would probably not throw but log here.

lforst · 2025-04-07T13:48:32Z

packages/core/src/integrations/supabase.ts

+  ) => Promise<T>;
+}
+
+const instrumented = new Map();


I would make this a weakmap or actually a WeakSet should be better for this usecase.

I removed this and flagged instrumented objects instead, which is more reliable for browser/client and multiple clients usage.

lforst · 2025-04-07T13:57:46Z

packages/core/src/integrations/supabase.ts

+          attributes,
+        });
+
+        return (Reflect.apply(target, thisArg, []) as Promise<SupabaseResponse>)


We should always pass the original args. They might be needed in future versions and then we break.

I tried this, and it breaks the code. I did not debug that much, and it's from the original implementation. The arguments are passed in the chained then at the bottom.

packages/core/src/integrations/supabase.ts

smeubank · 2025-04-09T13:15:30Z

@onurtemizkan do you have an example in team-sdks or something for this? I am just curious what this looks like in product, to also look at for the flutter integration later

Adds support for auth and auth.admin operations

onurtemizkan · 2025-04-10T08:56:13Z

@smeubank, sure, I'll create example events and post links here after making the reviewed changes today 👍

Co-authored-by: Sigrid Huemer <[email protected]>

…ping

Co-authored-by: Luca Forstner <[email protected]>

onurtemizkan · 2025-04-14T16:11:42Z

@lforst - I updated the PR addressing the comments. I have exported instrumentSupabase and ended up thinking that we may not even need an 'integration' for this use case. Most of the uses I have seen have multiple client instances and recreating instances looks like the norm. We can still export the integration for whenever it's needed, though.

lforst

One last minor thing then 🚀

lforst · 2025-04-15T13:39:56Z

packages/core/src/integrations/supabase.ts

+  }
+}
+
+export const instrumentSupabase = (options: { supabaseClient: unknown }): void => {


I would almost vote that we make the signature instrumentSupabaseClient(client: unkown) so we can make it instrumentSupabaseClient(client: unkown, options: Options = {}) in the future if we ever want to do options.

onurtemizkan force-pushed the onur/supabase-integration branch 2 times, most recently from dae5b0f to 80d38ce Compare March 18, 2025 12:54

onurtemizkan changed the title ~~feat(core): Add Supabase Integration~~ feat Mar 18, 2025

onurtemizkan changed the title ~~feat~~ feat: Add Supabase Integration Mar 18, 2025

onurtemizkan force-pushed the onur/supabase-integration branch 5 times, most recently from 7d5968b to 73d5f23 Compare March 20, 2025 12:46

smeubank linked an issue Mar 20, 2025 that may be closed by this pull request

Supabase Support #15436

Open

onurtemizkan force-pushed the onur/supabase-integration branch 5 times, most recently from 927f5ab to aaec090 Compare March 26, 2025 13:18

onurtemizkan marked this pull request as ready for review March 26, 2025 21:27

onurtemizkan force-pushed the onur/supabase-integration branch from dabdf90 to d3a55a1 Compare March 27, 2025 08:57

onurtemizkan marked this pull request as draft March 27, 2025 14:14

onurtemizkan force-pushed the onur/supabase-integration branch from 5dd6723 to 33c2a66 Compare March 27, 2025 19:58

onurtemizkan marked this pull request as ready for review March 28, 2025 10:37

kamilogorek mentioned this pull request Mar 31, 2025

Build for both ESM and CJS supabase-community/sentry-integration-js#19

Closed

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

s1gr1d reviewed Apr 1, 2025

View reviewed changes

s1gr1d requested a review from lforst April 4, 2025 07:38

lforst reviewed Apr 7, 2025

View reviewed changes

onurtemizkan and others added 25 commits April 14, 2025 15:52

Dedupe dependencies.

5123016

Skip tests on non-tracing bundles

0e335bd

Remove test-debug mode

eeaa8a2

Try reducing bundle size

adc5e10

Remove supabaseIntegration from non-Tracing bundles

cad1352

Bring filter-mappings back.

f0d66ce

Export supabase from all tracing bundles

5cb5f58

Add vendor license

16e4a9d

Clean up

5f67b4a

Add auth support

318f0a5

Add auth error capturing

1acde43

Remove signOut from admin operations

e01ce65

Clean up

7535386

Address review comments

0532f8a

Update packages/core/src/integrations/supabase.ts

0ea2cdb

Co-authored-by: Sigrid Huemer <[email protected]>

Remove README.md

af31dcf

Mark SupabaseConstructor objects as instrumented and check for rewrap…

ace4036

…ping

Update packages/core/src/integrations/supabase.ts

116fca5

Co-authored-by: Luca Forstner <[email protected]>

Expose instrumentSupabase

68b04a4

Lint

affaf36

Add db.system attribute

ba7c4e3

Update test dsns and tunnel

2d8ca55

Update auth ops

c6ef16f

Dedupe deps

d61aefe

Fix empty arguments on auth

0c3ff1d

onurtemizkan force-pushed the onur/supabase-integration branch from a559499 to 423397d Compare April 14, 2025 15:18

Mark and check auth as instrumented

556703c

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

lforst approved these changes Apr 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Supabase Integration #15719

feat: Add Supabase Integration #15719

onurtemizkan commented Mar 18, 2025 •

edited

Loading

github-actions bot commented Mar 18, 2025 •

edited

Loading

smeubank commented Mar 28, 2025

onurtemizkan commented Mar 28, 2025

s1gr1d Apr 1, 2025

s1gr1d Apr 1, 2025

s1gr1d Apr 1, 2025

smeubank Apr 1, 2025 •

edited

Loading

s1gr1d Apr 1, 2025

s1gr1d Apr 1, 2025 •

edited

Loading

s1gr1d Apr 1, 2025

s1gr1d Apr 1, 2025

onurtemizkan Apr 3, 2025

lforst left a comment

lforst Apr 7, 2025

lforst Apr 7, 2025

lforst Apr 7, 2025

lforst Apr 7, 2025

lforst Apr 7, 2025

onurtemizkan Apr 14, 2025

lforst Apr 7, 2025

onurtemizkan Apr 14, 2025

smeubank commented Apr 9, 2025

onurtemizkan commented Apr 10, 2025

onurtemizkan commented Apr 14, 2025

lforst left a comment

lforst Apr 15, 2025


		function instrumentSupabaseAuthClient(supabaseClientInstance: SupabaseClientInstance): void {
		const auth = supabaseClientInstance.auth;

		export const supabaseIntegration = defineIntegration((supabaseClient: unknown) => {
		return {

feat: Add Supabase Integration #15719

Are you sure you want to change the base?

feat: Add Supabase Integration #15719

Conversation

onurtemizkan commented Mar 18, 2025 • edited Loading

github-actions bot commented Mar 18, 2025 • edited Loading

size-limit report 📦

smeubank commented Mar 28, 2025

onurtemizkan commented Mar 28, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smeubank Apr 1, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s1gr1d Apr 1, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lforst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smeubank commented Apr 9, 2025

onurtemizkan commented Apr 10, 2025

onurtemizkan commented Apr 14, 2025

lforst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onurtemizkan commented Mar 18, 2025 •

edited

Loading

github-actions bot commented Mar 18, 2025 •

edited

Loading

smeubank Apr 1, 2025 •

edited

Loading

s1gr1d Apr 1, 2025 •

edited

Loading