Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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
8 changes: 8 additions & 0 deletions packages/core/src/types/datacollection.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,14 @@ export interface DataCollection {
outputs?: boolean;
};

/**
* Include data associated with database queries. This controls collection of query parameters, inline literal values within query text, mutation/request bodies, and returned result data.
*
* Sanitized or parameterized DB statements (`db.query.text`) are **not** controlled by this property. Structural metadata such as the database system, query summary, operation name, or the table being acted upon is also **always** collected.
* @default true
*/
databaseQueryData?: boolean;

/**
* Capture local variable values in stack frames.
* @default true
Expand Down
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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