Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/astro/test/server/middleware.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ describe('sentryMiddleware', () => {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: false, outputs: false },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
}),
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/integrations/supabase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,8 @@ function instrumentPostgRESTFilterBuilder(
}

const client = getClient();
const shouldSendData = _options.sendOperationData ?? client?.getDataCollectionOptions().userInfo === true;
const shouldSendData =
_options.sendOperationData ?? client?.getDataCollectionOptions().databaseQueryData === true;
const bodyPayload = getMutationBodyPayloadForTelemetry(typedThis.body, body);

// Adding operation to the beginning of the description if it's not a `select` operation
Expand Down Expand Up @@ -563,7 +564,7 @@ interface SupabaseIntegrationOptions {
* Whether to attach PostgREST query filters and mutation body payloads
* to Sentry telemetry.
*
* Falls back to `dataCollection.userInfo` when not set.
* Falls back to `dataCollection.databaseQueryData` when not set.
* @default undefined
*/
sendOperationData?: boolean;
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries, such as parameters provided to a query, statement values, or returned results.
* Structural metadata (database system, query summary, table) is always collected regardless of this setting.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export function defaultPiiToCollectionOptions(sendDefaultPii?: boolean): Resolve
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 7, // default should be 5, but ContextLines integration uses 7
}
Expand All @@ -31,6 +32,9 @@ export function defaultPiiToCollectionOptions(sendDefaultPii?: boolean): Resolve
// always attached regardless of `sendDefaultPii`; keep it on to preserve that behavior.
graphQL: { document: true, variables: true },
genAI: { inputs: false, outputs: false },
// Database query values were only sent with `sendDefaultPii: true` (e.g. Supabase gated on it),
// so map the legacy "off" state to `false`.
databaseQueryData: false,
stackFrameVariables: true,
frameContextLines: 7, // default should be 5, but ContextLines integration uses 7
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const DEFAULTS: ResolvedDataCollection = {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
};
Expand Down Expand Up @@ -52,6 +53,7 @@ export function resolveDataCollectionOptions(options: {
inputs: dc.genAI?.inputs ?? base.genAI.inputs,
outputs: dc.genAI?.outputs ?? base.genAI.outputs,
},
databaseQueryData: dc.databaseQueryData ?? base.databaseQueryData,
stackFrameVariables: dc.stackFrameVariables ?? base.stackFrameVariables,
frameContextLines: dc.frameContextLines ?? base.frameContextLines,
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export function createMockClient(userInfo = true, genAI?: { inputs: boolean; out
queryParams: true,
graphQL: { document: true, variables: true },
genAI: genAIOptions,
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
}),
Expand Down
30 changes: 15 additions & 15 deletions packages/core/test/lib/integrations/supabase.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ type CreateMockSupabaseClientOptions = {
method?: string;
url?: URL | string;
body?: unknown;
/** When set, configures the mocked Sentry client's `dataCollection.userInfo`. Omit to leave `getClient` to the test file `beforeEach`. */
dataCollectionUserInfo?: boolean;
/** When set, configures the mocked Sentry client's `dataCollection.databaseQueryData`. Omit to leave `getClient` to the test file `beforeEach`. */
dataCollectionDatabaseQueryData?: boolean;
};

const DEFAULT_MOCK_SUPABASE_REST_URL = 'https://example.supabase.co/rest/v1/todos';
Expand All @@ -53,9 +53,9 @@ const MOCK_SUPABASE_PII_SCENARIO: Pick<CreateMockSupabaseClientOptions, 'method'
};

function createMockSupabaseClient(resolveWith: unknown, options?: CreateMockSupabaseClientOptions): unknown {
if (options?.dataCollectionUserInfo !== undefined) {
if (options?.dataCollectionDatabaseQueryData !== undefined) {
currentScopesMocks.getClient.mockReturnValue({
getDataCollectionOptions: () => ({ userInfo: options.dataCollectionUserInfo }),
getDataCollectionOptions: () => ({ databaseQueryData: options.dataCollectionDatabaseQueryData }),
} as any);
}

Expand Down Expand Up @@ -237,10 +237,10 @@ describe('Supabase Integration', () => {
vi.restoreAllMocks();
});

it('omits db.query, db.body, and breadcrumb query/body when dataCollection.userInfo is false', async () => {
it('omits db.query, db.body, and breadcrumb query/body when dataCollection.databaseQueryData is false', async () => {
const client = createMockSupabaseClient(
{ status: 200 },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionUserInfo: false },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionDatabaseQueryData: false },
);
instrumentSupabaseClient(client);

Expand All @@ -259,10 +259,10 @@ describe('Supabase Integration', () => {
expect(breadcrumb).not.toHaveProperty('data');
});

it('includes db.query, db.body, and breadcrumb query/body when dataCollection.userInfo is true', async () => {
it('includes db.query, db.body, and breadcrumb query/body when dataCollection.databaseQueryData is true', async () => {
const client = createMockSupabaseClient(
{ status: 200 },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionUserInfo: true },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionDatabaseQueryData: true },
);
instrumentSupabaseClient(client);

Expand Down Expand Up @@ -290,10 +290,10 @@ describe('Supabase Integration', () => {
);
});

it('includes data when sendOperationData option is set, regardless of dataCollection.userInfo', async () => {
it('includes data when sendOperationData option is set, regardless of dataCollection.databaseQueryData', async () => {
const client = createMockSupabaseClient(
{ status: 200 },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionUserInfo: false },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionDatabaseQueryData: false },
);
instrumentSupabaseClient(client, { sendOperationData: true });

Expand All @@ -312,10 +312,10 @@ describe('Supabase Integration', () => {
);
});

it('sendOperationData: false takes precedence over dataCollection.userInfo: true', async () => {
it('sendOperationData: false takes precedence over dataCollection.databaseQueryData: true', async () => {
const client = createMockSupabaseClient(
{ status: 200 },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionUserInfo: true },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionDatabaseQueryData: true },
);
instrumentSupabaseClient(client, { sendOperationData: false });

Expand All @@ -330,7 +330,7 @@ describe('Supabase Integration', () => {
expect(spanOptions.attributes['db.body']).toBeUndefined();
});

it('includes data when legacy sendDefaultPii: true is bridged to dataCollection.userInfo', async () => {
it('includes data when legacy sendDefaultPii: true is bridged to dataCollection.databaseQueryData', async () => {
const resolved = resolveDataCollectionOptions({ sendDefaultPii: true });
currentScopesMocks.getClient.mockReturnValue({
getDataCollectionOptions: () => resolved,
Expand Down Expand Up @@ -378,7 +378,7 @@ describe('Supabase Integration', () => {
it('omits supabase error context query/body when data collection is off', async () => {
const client = createMockSupabaseClient(
{ status: 400, error: { message: 'Bad request', code: '400' } },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionUserInfo: false },
{ ...MOCK_SUPABASE_PII_SCENARIO, dataCollectionDatabaseQueryData: false },
);
instrumentSupabaseClient(client);

Expand Down Expand Up @@ -417,7 +417,7 @@ describe('Supabase Integration', () => {
method: 'POST',
url: 'https://example.supabase.co/rest/v1/todos?columns=',
body: [{ title: 'Test Todo' }],
dataCollectionUserInfo: true,
dataCollectionDatabaseQueryData: true,
},
);
instrumentSupabaseClient(client);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 7,
});
Expand All @@ -28,6 +29,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: { deny: ['forwarded', '-ip', 'remote-', 'via', '-user'] },
graphQL: { document: true, variables: true },
genAI: { inputs: false, outputs: false },
databaseQueryData: false,
stackFrameVariables: true,
frameContextLines: 7,
});
Expand All @@ -45,6 +47,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: { deny: ['forwarded', '-ip', 'remote-', 'via', '-user'] },
graphQL: { document: true, variables: true },
genAI: { inputs: false, outputs: false },
databaseQueryData: false,
stackFrameVariables: true,
frameContextLines: 7,
});
Expand All @@ -62,6 +65,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: { deny: ['forwarded', '-ip', 'remote-', 'via', '-user'] },
graphQL: { document: true, variables: true },
genAI: { inputs: false, outputs: false },
databaseQueryData: false,
stackFrameVariables: true,
frameContextLines: 7,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ describe('resolveDataCollectionOptions', () => {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
};
Expand All @@ -24,6 +25,7 @@ describe('resolveDataCollectionOptions', () => {
expect(result.genAI).toEqual({ inputs: false, outputs: false });
// GraphQL documents are redacted at collection time, so they stay on to preserve legacy behavior.
expect(result.graphQL).toEqual({ document: true, variables: true });
expect(result.databaseQueryData).toBe(false);
expect(result.stackFrameVariables).toBe(true);
expect(result.frameContextLines).toBe(7);
});
Expand All @@ -50,6 +52,7 @@ describe('resolveDataCollectionOptions', () => {
expect(result.queryParams).toBe(true);
expect(result.graphQL).toEqual({ document: true, variables: true });
expect(result.genAI).toEqual({ inputs: true, outputs: true });
expect(result.databaseQueryData).toBe(true);
});

it('bridges sendDefaultPii: false to restrictive config', () => {
Expand All @@ -59,6 +62,7 @@ describe('resolveDataCollectionOptions', () => {
expect(result.httpBodies).toEqual([]);
expect(result.genAI).toEqual({ inputs: false, outputs: false });
expect(result.graphQL).toEqual({ document: true, variables: true });
expect(result.databaseQueryData).toBe(false);
});
});

Expand All @@ -74,6 +78,7 @@ describe('resolveDataCollectionOptions', () => {
// Remaining fields use spec defaults (not sendDefaultPii bridge)
expect(result.httpBodies).toEqual(['incomingRequest', 'outgoingRequest', 'incomingResponse', 'outgoingResponse']);
expect(result.genAI).toEqual({ inputs: true, outputs: true });
expect(result.databaseQueryData).toBe(true);
});
});

Expand All @@ -94,6 +99,7 @@ describe('resolveDataCollectionOptions', () => {
expect(result.queryParams).toBe(true);
expect(result.graphQL).toEqual({ document: true, variables: true });
expect(result.genAI).toEqual({ inputs: true, outputs: true });
expect(result.databaseQueryData).toBe(true);
expect(result.stackFrameVariables).toBe(true);
expect(result.frameContextLines).toBe(5);
});
Expand Down Expand Up @@ -150,13 +156,23 @@ describe('resolveDataCollectionOptions', () => {

expect(result.queryParams).toBe(false);
});

it('supports turning off database query data', () => {
const result = resolveDataCollectionOptions({
dataCollection: {
databaseQueryData: false,
},
});

expect(result.databaseQueryData).toBe(false);
});
});

describe('return type completeness', () => {
it('always returns all fields', () => {
const result = resolveDataCollectionOptions({});

expect(Object.keys(result)).toHaveLength(9);
expect(Object.keys(result)).toHaveLength(10);
expect(result).toHaveProperty('userInfo');
expect(result).toHaveProperty('cookies');
expect(result).toHaveProperty('httpHeaders');
Expand All @@ -170,6 +186,7 @@ describe('resolveDataCollectionOptions', () => {
expect(result).toHaveProperty('genAI');
expect(result).toHaveProperty('genAI.inputs');
expect(result).toHaveProperty('genAI.outputs');
expect(result).toHaveProperty('databaseQueryData');
expect(result).toHaveProperty('stackFrameVariables');
expect(result).toHaveProperty('frameContextLines');
});
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/utils/request.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -876,6 +876,7 @@ describe('request utils', () => {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ describe('wrapMiddlewareHandlerWithSentry', () => {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: false, outputs: false },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
}),
Expand Down
1 change: 1 addition & 0 deletions packages/remix/test/server/errors.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ function createMockClient(httpBodies: string[] = []): Client {
queryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
}),
Expand Down
Loading