Rename to instrumentSupabaseClient with separate options

onurtemizkan · onurtemizkan · commit 5776eb7e1c8f · 2025-04-16T09:02:50.000Z
diff --git a/dev-packages/browser-integration-tests/suites/integrations/supabase/auth/init.js b/dev-packages/browser-integration-tests/suites/integrations/supabase/auth/init.js
@@ -7,9 +7,7 @@ const supabaseClient = createClient('https://test.supabase.co', 'test-key');
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
-  integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration({
-    supabaseClient
-  })],
+  integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration(supabaseClient)],
   tracesSampleRate: 1.0,
 });
 
diff --git a/dev-packages/browser-integration-tests/suites/integrations/supabase/db-operations/init.js b/dev-packages/browser-integration-tests/suites/integrations/supabase/db-operations/init.js
@@ -7,7 +7,7 @@ const supabaseClient = createClient('https://test.supabase.co', 'test-key');
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
-  integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration({ supabaseClient })],
+  integrations: [Sentry.browserTracingIntegration(), Sentry.supabaseIntegration(supabaseClient)],
   tracesSampleRate: 1.0,
 });
 
diff --git a/dev-packages/e2e-tests/test-applications/supabase-nextjs/lib/initSupabaseAdmin.ts b/dev-packages/e2e-tests/test-applications/supabase-nextjs/lib/initSupabaseAdmin.ts
@@ -15,7 +15,7 @@ export const getSupabaseClient = () => {
     },
   });
 
-  Sentry.instrumentSupabase({ supabaseClient });
+  Sentry.instrumentSupabaseClient(supabaseClient);
 
   return supabaseClient;
 };
diff --git a/dev-packages/e2e-tests/test-applications/supabase-nextjs/lib/initSupabaseAnon.ts b/dev-packages/e2e-tests/test-applications/supabase-nextjs/lib/initSupabaseAnon.ts
@@ -9,7 +9,7 @@ const NEXT_PUBLIC_SUPABASE_ANON_KEY =
 export const getSupabaseClient = () => {
   const supabaseClient = createClient(NEXT_PUBLIC_SUPABASE_URL, NEXT_PUBLIC_SUPABASE_ANON_KEY);
 
-  Sentry.instrumentSupabase({ supabaseClient });
+  Sentry.instrumentSupabaseClient(supabaseClient);
 
   return supabaseClient;
 };
diff --git a/packages/astro/src/index.server.ts b/packages/astro/src/index.server.ts
@@ -126,7 +126,7 @@ export {
   withMonitor,
   withScope,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   profiler,
   logger,
diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -110,7 +110,7 @@ export {
   trpcMiddleware,
   updateSpanName,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   profiler,
   amqplibIntegration,
diff --git a/packages/browser/src/index.bundle.tracing.replay.feedback.ts b/packages/browser/src/index.bundle.tracing.replay.feedback.ts
@@ -16,7 +16,7 @@ export {
   setMeasurement,
   captureFeedback,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
 } from '@sentry/core';
 
 export {
diff --git a/packages/browser/src/index.bundle.tracing.replay.ts b/packages/browser/src/index.bundle.tracing.replay.ts
@@ -15,7 +15,7 @@ export {
   getSpanDescendants,
   setMeasurement,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
 } from '@sentry/core';
 
 export {
diff --git a/packages/browser/src/index.bundle.tracing.ts b/packages/browser/src/index.bundle.tracing.ts
@@ -16,7 +16,7 @@ export {
   getSpanDescendants,
   setMeasurement,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
 } from '@sentry/core';
 
 export {
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -60,7 +60,7 @@ export {
   makeMultiplexedTransport,
   moduleMetadataIntegration,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   thirdPartyErrorFilterIntegration,
 } from '@sentry/core';
diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -129,7 +129,7 @@ export {
   trpcMiddleware,
   updateSpanName,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   profiler,
   amqplibIntegration,
diff --git a/packages/cloudflare/src/index.ts b/packages/cloudflare/src/index.ts
@@ -76,7 +76,7 @@ export {
   captureConsoleIntegration,
   moduleMetadataIntegration,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   consoleIntegration,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -106,7 +106,7 @@ export { captureConsoleIntegration } from './integrations/captureconsole';
 export { dedupeIntegration } from './integrations/dedupe';
 export { extraErrorDataIntegration } from './integrations/extraerrordata';
 export { rewriteFramesIntegration } from './integrations/rewriteframes';
-export { supabaseIntegration, instrumentSupabase } from './integrations/supabase';
+export { supabaseIntegration, instrumentSupabaseClient } from './integrations/supabase';
 export { zodErrorsIntegration } from './integrations/zoderrors';
 export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
 export { consoleIntegration } from './integrations/console';
diff --git a/packages/core/src/integrations/supabase.ts b/packages/core/src/integrations/supabase.ts
@@ -67,6 +67,10 @@ export const FILTER_MAPPINGS = {
 
 export const DB_OPERATIONS_TO_INSTRUMENT = ['select', 'insert', 'upsert', 'update', 'delete'];
 
+// We may need options in the future, for now it's empty
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface SupabaseInstrumentationOptions {}
+
 type AuthOperationFn = (...args: unknown[]) => Promise<unknown>;
 type AuthOperationName = (typeof AUTH_OPERATIONS_TO_INSTRUMENT)[number];
 type AuthAdminOperationName = (typeof AUTH_ADMIN_OPERATIONS_TO_INSTRUMENT)[number];
@@ -488,29 +492,36 @@ function instrumentPostgRESTQueryBuilder(PostgRESTQueryBuilder: new () => PostgR
   }
 }
 
-export const instrumentSupabase = (options: { supabaseClient: unknown }): void => {
-  if (!options?.supabaseClient) {
+export const instrumentSupabaseClient = (
+  supabaseClient: unknown,
+  // In future, we may need options. For now it's unused.
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  options: SupabaseInstrumentationOptions = {},
+): void => {
+  if (!supabaseClient) {
     DEBUG_BUILD && logger.warn('Supabase integration was not installed because no Supabase client was provided.');
     return;
   }
   const SupabaseClientConstructor =
-    options.supabaseClient.constructor === Function ? options.supabaseClient : options.supabaseClient.constructor;
+    supabaseClient.constructor === Function ? supabaseClient : supabaseClient.constructor;
 
   instrumentSupabaseClientConstructor(SupabaseClientConstructor);
-  instrumentSupabaseAuthClient(options.supabaseClient as SupabaseClientInstance);
+  instrumentSupabaseAuthClient(supabaseClient as SupabaseClientInstance);
 };
 
 const INTEGRATION_NAME = 'Supabase';
 
-const _supabaseIntegration = ((options: { supabaseClient: unknown }) => {
+const _supabaseIntegration = ((supabaseClient: unknown, options: SupabaseInstrumentationOptions) => {
   return {
     setupOnce() {
-      instrumentSupabase(options);
+      instrumentSupabaseClient(supabaseClient, options);
     },
     name: INTEGRATION_NAME,
   };
 }) satisfies IntegrationFn;
 
-export const supabaseIntegration = defineIntegration((options: { supabaseClient: unknown }) => {
-  return _supabaseIntegration(options);
-}) satisfies IntegrationFn;
+export const supabaseIntegration = defineIntegration(
+  (supabaseClient: unknown, options: SupabaseInstrumentationOptions) => {
+    return _supabaseIntegration(supabaseClient, options);
+  },
+) satisfies IntegrationFn;
diff --git a/packages/deno/src/index.ts b/packages/deno/src/index.ts
@@ -72,7 +72,7 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -109,7 +109,7 @@ export {
   trpcMiddleware,
   updateSpanName,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   profiler,
   amqplibIntegration,
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -128,7 +128,7 @@ export {
   trpcMiddleware,
   updateSpanName,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   profiler,
   consoleLoggingIntegration,
diff --git a/packages/remix/src/cloudflare/index.ts b/packages/remix/src/cloudflare/index.ts
@@ -96,7 +96,7 @@ export {
   captureConsoleIntegration,
   moduleMetadataIntegration,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
diff --git a/packages/remix/src/server/index.ts b/packages/remix/src/server/index.ts
@@ -112,7 +112,7 @@ export {
   withMonitor,
   withScope,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   logger,
   consoleLoggingIntegration,
diff --git a/packages/solidstart/src/server/index.ts b/packages/solidstart/src/server/index.ts
@@ -115,7 +115,7 @@ export {
   withMonitor,
   withScope,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   logger,
   consoleLoggingIntegration,
diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -117,7 +117,7 @@ export {
   withMonitor,
   withScope,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   logger,
   consoleLoggingIntegration,
diff --git a/packages/sveltekit/src/worker/index.ts b/packages/sveltekit/src/worker/index.ts
@@ -79,7 +79,7 @@ export {
   withMonitor,
   withScope,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
 } from '@sentry/cloudflare';
 
diff --git a/packages/vercel-edge/src/index.ts b/packages/vercel-edge/src/index.ts
@@ -76,7 +76,7 @@ export {
   captureConsoleIntegration,
   moduleMetadataIntegration,
   supabaseIntegration,
-  instrumentSupabase,
+  instrumentSupabaseClient,
   zodErrorsIntegration,
   consoleIntegration,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
