Skip to content

Commit 245eacc

Browse files
onurtemizkanonurtemizkan
committed
Add auth support
1 parent 8bbd106 commit 245eacc

File tree

4 files changed

+214
-55
lines changed

4 files changed

+214
-55
lines changed

‎dev-packages/browser-integration-tests/suites/integrations/supabase/auth/init.js‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import * as Sentry from '@sentry/browser';
2+
3+
import { createClient } from '@supabase/supabase-js';
4+
window.Sentry = Sentry;
5+
6+
const supabase = createClient(
7+
'https://test.supabase.co',
8+
'test-key'
9+
);
10+
11+
Sentry.init({
12+
dsn: 'https://public@dsn.ingest.sentry.io/1337',
13+
integrations: [
14+
Sentry.browserTracingIntegration(),
15+
Sentry.supabaseIntegration(supabase)
16+
],
17+
tracesSampleRate: 1.0,
18+
});
19+
20+
// Simulate authentication operations
21+
async function performAuthenticationOperations() {
22+
try {
23+
await supabase.auth.signInWithPassword({
24+
email: 'test@example.com',
25+
password: 'test-password',
26+
});
27+
28+
await supabase.auth.signOut();
29+
} catch (error) {
30+
Sentry.captureException(error);
31+
}
32+
}
33+
34+
performAuthenticationOperations();

‎dev-packages/browser-integration-tests/suites/integrations/supabase/auth/test.ts‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
import type { Page } from '@playwright/test';
2+
import { expect } from '@playwright/test';
3+
import type { Event } from '@sentry/core';
4+
5+
import { sentryTest } from '../../../../utils/fixtures';
6+
import {
7+
getFirstSentryEnvelopeRequest,
8+
getMultipleSentryEnvelopeRequests,
9+
shouldSkipTracingTest,
10+
} from '../../../../utils/helpers';
11+
12+
async function mockSupabaseAuthRoutes(page: Page) {
13+
await page.route('**/auth/v1/token?grant_type=password**', route => {
14+
return route.fulfill({
15+
status: 200,
16+
body: JSON.stringify({
17+
access_token: 'test-access-token',
18+
refresh_token: 'test-refresh-token',
19+
token_type: 'bearer',
20+
expires_in: 3600,
21+
}),
22+
headers: {
23+
'Content-Type': 'application/json',
24+
},
25+
});
26+
});
27+
28+
await page.route('**/auth/v1/logout**', route => {
29+
return route.fulfill({
30+
status: 200,
31+
body: JSON.stringify({
32+
message: 'Logged out',
33+
}),
34+
headers: {
35+
'Content-Type': 'application/json',
36+
},
37+
});
38+
});
39+
}
40+
41+
sentryTest('should capture Supabase authentication spans', async ({ getLocalTestUrl, page }) => {
42+
if (shouldSkipTracingTest()) {
43+
return;
44+
}
45+
46+
await mockSupabaseAuthRoutes(page);
47+
48+
const url = await getLocalTestUrl({ testDir: __dirname });
49+
50+
const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);
51+
const supabaseSpans = eventData.spans?.filter(({ op }) => op?.startsWith('db.supabase.auth'));
52+
53+
expect(supabaseSpans).toHaveLength(2);
54+
expect(supabaseSpans![0]).toMatchObject({
55+
description: 'signInWithPassword',
56+
parent_span_id: eventData.contexts?.trace?.span_id,
57+
span_id: expect.any(String),
58+
start_timestamp: expect.any(Number),
59+
timestamp: expect.any(Number),
60+
trace_id: eventData.contexts?.trace?.trace_id,
61+
status: 'ok',
62+
data: expect.objectContaining({
63+
'sentry.op': 'db.supabase.auth.signInWithPassword',
64+
'sentry.origin': 'auto.db.supabase',
65+
}),
66+
});
67+
68+
expect(supabaseSpans![1]).toMatchObject({
69+
description: 'signOut',
70+
parent_span_id: eventData.contexts?.trace?.span_id,
71+
span_id: expect.any(String),
72+
start_timestamp: expect.any(Number),
73+
timestamp: expect.any(Number),
74+
trace_id: eventData.contexts?.trace?.trace_id,
75+
status: 'ok',
76+
data: expect.objectContaining({
77+
'sentry.op': 'db.supabase.auth.signOut',
78+
'sentry.origin': 'auto.db.supabase',
79+
}),
80+
});
81+
});

‎dev-packages/browser-integration-tests/suites/integrations/supabase/db-operations/test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { Page} from '@playwright/test';
1+
import type { Page } from '@playwright/test';
22
import { expect } from '@playwright/test';
33
import type { Event } from '@sentry/core';
44

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

Lines changed: 98 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,56 @@
1-
// Ported from Kamil Ogórek's work on:
1+
// Based on Kamil Ogórek's work on:
22
// https://github.com/supabase-community/sentry-integration-js
33

4-
// MIT License
5-
6-
// Copyright (c) 2024 Supabase
7-
8-
// Permission is hereby granted, free of charge, to any person obtaining a copy
9-
// of this software and associated documentation files (the "Software"), to deal
10-
// in the Software without restriction, including without limitation the rights
11-
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12-
// copies of the Software, and to permit persons to whom the Software is
13-
// furnished to do so, subject to the following conditions:
14-
15-
// The above copyright notice and this permission notice shall be included in all
16-
// copies or substantial portions of the Software.
17-
18-
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19-
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20-
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21-
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22-
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23-
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24-
// SOFTWARE.
25-
264
/* eslint-disable max-lines */
275
import { logger, isPlainObject } from '../utils-hoist';
286

297
import type { IntegrationFn } from '../types-hoist';
30-
import { setHttpStatus, startInactiveSpan } from '../tracing';
8+
import { setHttpStatus, startInactiveSpan, startSpan } from '../tracing';
319
import { addBreadcrumb } from '../breadcrumbs';
3210
import { defineIntegration } from '../integration';
3311
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../semanticAttributes';
3412
import { captureException } from '../exports';
13+
import { SPAN_STATUS_ERROR, SPAN_STATUS_OK } from '../tracing';
3514

36-
export interface SupabaseClient {
15+
export interface SupabaseClientConstructor {
3716
prototype: {
3817
from: (table: string) => PostgrestQueryBuilder;
3918
};
4019
}
4120

21+
const AUTH_OPERATIONS_TO_INSTRUMENT = [
22+
'reauthenticate',
23+
'signInAnonymously',
24+
'signInWithOAuth',
25+
'signInWithIdToken',
26+
'signInWithOtp',
27+
'signInWithPassword',
28+
'signInWithSSO',
29+
'signOut',
30+
'signUp',
31+
'verifyOtp',
32+
];
33+
34+
const AUTH_ADMIN_OPERATIONS_TO_INSTRUMENT = [
35+
'createUser',
36+
'deleteUser',
37+
'listUsers',
38+
'getUserById',
39+
'updateUserById',
40+
'inviteUserByEmail',
41+
'signOut',
42+
];
43+
44+
type AuthOperationFn = (...args: unknown[]) => Promise<unknown>;
45+
type AuthOperationName = (typeof AUTH_OPERATIONS_TO_INSTRUMENT)[number];
46+
type AuthAdminOperationName = (typeof AUTH_ADMIN_OPERATIONS_TO_INSTRUMENT)[number];
47+
48+
export interface SupabaseClientInstance {
49+
auth: {
50+
admin: Record<AuthAdminOperationName, AuthOperationFn>;
51+
} & Record<AuthOperationName, AuthOperationFn>;
52+
}
53+
4254
export interface PostgrestQueryBuilder {
4355
select: (...args: unknown[]) => PostgrestFilterBuilder;
4456
insert: (...args: unknown[]) => PostgrestFilterBuilder;
@@ -181,17 +193,65 @@ export function translateFiltersIntoMethods(key: string, query: string): string
181193
return `${method}(${key}, ${value.join('.')})`;
182194
}
183195

184-
function instrumentSupabaseClient(SupabaseClient: unknown): void {
185-
if (instrumented.has(SupabaseClient)) {
196+
function instrumentAuthOperation(operation: AuthOperationFn, isAdmin = false): AuthOperationFn {
197+
return new Proxy(operation, {
198+
apply(target, thisArg, argumentsList) {
199+
startSpan(
200+
{
201+
name: operation.name,
202+
attributes: {
203+
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.supabase',
204+
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `db.supabase.auth.${isAdmin ? 'admin.' : ''}${operation.name}`,
205+
},
206+
},
207+
span => {
208+
return Reflect.apply(target, thisArg, argumentsList).then((res: unknown) => {
209+
debugger;
210+
if (res && typeof res === 'object' && 'error' in res && res.error) {
211+
span.setStatus({ code: SPAN_STATUS_ERROR });
212+
} else {
213+
span.setStatus({ code: SPAN_STATUS_OK });
214+
}
215+
216+
span.end();
217+
debugger;
218+
return res;
219+
});
220+
},
221+
);
222+
},
223+
});
224+
}
225+
226+
function instrumentSupabaseAuthClient(supabaseClientInstance: SupabaseClientInstance): void {
227+
const auth = supabaseClientInstance.auth;
228+
229+
if (!auth) {
186230
return;
187231
}
188232

189-
instrumented.set(SupabaseClient, {
190-
from: (SupabaseClient as unknown as SupabaseClient).prototype.from,
233+
AUTH_OPERATIONS_TO_INSTRUMENT.forEach((operation: AuthOperationName) => {
234+
const authOperation = auth[operation];
235+
if (typeof authOperation === 'function') {
236+
auth[operation] = instrumentAuthOperation(authOperation);
237+
}
191238
});
192239

193-
(SupabaseClient as unknown as SupabaseClient).prototype.from = new Proxy(
194-
(SupabaseClient as unknown as SupabaseClient).prototype.from,
240+
AUTH_ADMIN_OPERATIONS_TO_INSTRUMENT.forEach((operation: AuthAdminOperationName) => {
241+
const authAdminOperation = auth.admin[operation];
242+
if (typeof authAdminOperation === 'function') {
243+
auth.admin[operation] = instrumentAuthOperation(authAdminOperation);
244+
}
245+
});
246+
}
247+
248+
function instrumentSupabaseClientConstructor(SupabaseClient: unknown): void {
249+
if (instrumented.has(SupabaseClient)) {
250+
return;
251+
}
252+
253+
(SupabaseClient as unknown as SupabaseClientConstructor).prototype.from = new Proxy(
254+
(SupabaseClient as unknown as SupabaseClientConstructor).prototype.from,
195255
{
196256
apply(target, thisArg, argumentsList) {
197257
const rv = Reflect.apply(target, thisArg, argumentsList);
@@ -398,31 +458,15 @@ function instrumentPostgrestQueryBuilder(PostgrestQueryBuilder: new () => Postgr
398458
}
399459
}
400460

401-
export const patchCreateClient = (moduleExports: { createClient?: (...args: unknown[]) => unknown }): void => {
402-
const originalCreateClient = moduleExports.createClient;
403-
if (!originalCreateClient) {
404-
return;
405-
}
406-
407-
moduleExports.createClient = function wrappedCreateClient(...args: any[]) {
408-
const client = originalCreateClient.apply(this, args);
409-
410-
instrumentSupabaseClient(client);
411-
412-
return client;
413-
};
414-
};
415-
416-
const instrumentSupabase = (supabaseClient: unknown): void => {
417-
if (!supabaseClient) {
418-
throw new Error('SupabaseClient class constructor is required');
461+
const instrumentSupabase = (supabaseClientInstance: unknown): void => {
462+
if (!supabaseClientInstance) {
463+
throw new Error('Supabase client instance is not defined.');
419464
}
465+
const SupabaseClientConstructor =
466+
supabaseClientInstance.constructor === Function ? supabaseClientInstance : supabaseClientInstance.constructor;
420467

421-
// We want to allow passing either `SupabaseClient` constructor
422-
// or an instance returned from `createClient()`.
423-
const SupabaseClient = supabaseClient.constructor === Function ? supabaseClient : supabaseClient.constructor;
424-
425-
instrumentSupabaseClient(SupabaseClient);
468+
instrumentSupabaseClientConstructor(SupabaseClientConstructor);
469+
instrumentSupabaseAuthClient(supabaseClientInstance as SupabaseClientInstance);
426470
};
427471

428472
const INTEGRATION_NAME = 'Supabase';

0 commit comments

Comments
 (0)