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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/nextjs';

// Only `test` is prerendered at build time. `exception` and `message` are generated
// on-demand at request time.
export function generateStaticParams() {
return [{ id: 'test' }];
}

export default async function Page({ params }: { params: Promise<{ id: string }> }) {
const { id } = await params;

if (id === 'exception') {
Sentry.captureException(new Error('Test error from cache components page'));
return <p id="result">Error captured for id exception</p>;
}

if (id === 'message') {
Sentry.captureMessage('Test message from cache components page');
return <p id="result">Message captured for id message</p>;
}

return <p id="result">Hello, {id}!</p>;
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';

test('Should render cached component', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
Expand DownExpand Up@@ -40,6 +40,34 @@ test('Should generate metadata', async ({ page }) => {
await expect(page).toHaveTitle('Cache Components Metadata Test');
});

// Capturing an event inside a Server Component that is (re)generated at request time must not
// trip Next.js Cache Components prerender guards (`new Date()` / `crypto`).
test('Should capture an exception from an on-demand generated Server Component', async ({ page }) => {
const errorPromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.exception?.values?.[0]?.value === 'Test error from cache components page';
});

await page.goto('/exception');

await expect(page.locator('#result')).toHaveText('Error captured for id exception');

const error = await errorPromise;
expect(error.exception?.values?.[0]?.value).toBe('Test error from cache components page');
});

test('Should capture a message from an on-demand generated Server Component', async ({ page }) => {
const messagePromise = waitForError('nextjs-16-cacheComponents', errorEvent => {
return errorEvent.message === 'Test message from cache components page';
});

await page.goto('/message');

await expect(page.locator('#result')).toHaveText('Message captured for id message');

const message = await messagePromise;
expect(message.message).toBe('Test message from cache components page');
});

test('Should generate metadata async', async ({ page }) => {
const serverTxPromise = waitForTransaction('nextjs-16-cacheComponents', async transactionEvent => {
return transactionEvent.contexts?.trace?.op === 'http.server';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/checkin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { CheckInEnvelope, CheckInItem, DynamicSamplingContext } from './typ
import type { SdkMetadata } from './types/sdkmetadata';
import { dsnToString } from './utils/dsn';
import { createEnvelope } from './utils/envelope';
import { safeDateNow } from './utils/randomSafeContext';

/**
* Create envelope from check in item.
Expand All@@ -16,7 +17,7 @@ export function createCheckInEnvelope(
dsn?: DsnComponents,
): CheckInEnvelope {
const headers: CheckInEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
};

if (metadata?.sdk) {
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import {
getSdkMetadataForEnvelopeHeader,
} from './utils/envelope';
import { uuid4 } from './utils/misc';
import { safeDateNow } from './utils/randomSafeContext';
import { shouldIgnoreSpan } from './utils/should-ignore-span';
import { showSpanDropWarning, spanToJSON } from './utils/spanUtils';

Expand DownExpand Up@@ -70,7 +71,7 @@ export function createSessionEnvelope(
): SessionEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand DownExpand Up@@ -134,7 +135,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
const tunnel = client?.getOptions().tunnel;

const headers: SpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { Scope } from '../../scope';
import type { HttpServerResponse } from './types';
import type { AggregationCounts } from '../../types/session';
import { safeDateNow } from '../../utils/randomSafeContext';
import { safeUnref } from '../../utils/timer';

const clientToRequestSessionAggregatesMap = new WeakMap<
Expand DownExpand Up@@ -42,7 +43,7 @@ export function recordRequestSession(
if (client && requestSession) {
DEBUG_BUILD && debug.log(`Recorded request session with status: ${requestSession.status}`);

const roundedDate = new Date();
const roundedDate = new Date(safeDateNow());
roundedDate.setSeconds(0, 0);
const dateBucketKey = roundedDate.toISOString();

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/tracing/spans/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { SerializedStreamedSpan } from '../../types/span';
import { dsnToString } from '../../utils/dsn';
import { createEnvelope, getSdkMetadataForEnvelopeHeader } from '../../utils/envelope';
import { isBrowser } from '../../utils/isBrowser';
import { safeDateNow } from '../../utils/randomSafeContext';

/**
* Creates a span v2 span streaming envelope
Expand All@@ -19,7 +20,7 @@ export function createStreamedSpanEnvelope(
const sdk = getSdkMetadataForEnvelopeHeader(options._metadata);

const headers: StreamedSpanEnvelope[0] = {
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(dscHasRequiredProps(dsc) && { trace: dsc }),
...(sdk && { sdk }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/transports/offline.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Envelope } from '../types/envelope';
import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types/transport';
import { debug } from '../utils/debug-logger';
import { envelopeContainsItemType } from '../utils/envelope';
import { safeDateNow } from '../utils/randomSafeContext';
import { parseRetryAfterHeader } from '../utils/ratelimit';
import { safeUnref } from '../utils/timer';

Expand DownExpand Up@@ -108,7 +109,7 @@ export function makeOfflineTransport<TO>(
log('Attempting to send previously queued event');

// We should to update the sent_at timestamp to the current time.
found[0].sent_at = new Date().toISOString();
found[0].sent_at = new Date(safeDateNow()).toISOString();

void send(found, true).catch(e => {
log('Failed to retry sending', e);
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/utils/envelope.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type { SdkMetadata } from '../types/sdkmetadata';
import type { SpanJSON } from '../types/span';
import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { safeDateNow } from './randomSafeContext';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -255,7 +256,7 @@ export function createEventEnvelopeHeaders(
const dynamicSamplingContext = event.sdkProcessingMetadata?.dynamicSamplingContext;
return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
sent_at: new Date(safeDateNow()).toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
...(dynamicSamplingContext && {
Expand Down
88 changes: 88 additions & 0 deletions packages/core/test/lib/envelope-safe-timestamp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
import { beforeEach, describe, expect, it } from 'vitest';
import { createCheckInEnvelope } from '../../src/checkin';
import { createEventEnvelope, createSessionEnvelope, createSpanEnvelope } from '../../src/envelope';
import { SentrySpan } from '../../src/tracing/sentrySpan';
import type { Event } from '../../src/types/event';
import { GLOBAL_OBJ } from '../../src/utils/worldwide';

/**
* Envelope `sent_at` headers must derive their timestamp from `safeDateNow()` rather than
* reading the ambient clock via a bare `new Date()`. Reading the clock directly is disallowed
* in some restricted execution contexts (e.g. React Server Component prerendering); the SDK
* lets host SDKs install a runner via the `__SENTRY_SAFE_RANDOM_ID_WRAPPER__` global symbol
* (see `utils/randomSafeContext`) so that wrapped clock/random reads happen in a permitted
* context. These tests assert the envelope creators route their timestamp through that runner.
*/

const SAFE_RANDOM_SYMBOL = Symbol.for('__SENTRY_SAFE_RANDOM_ID_WRAPPER__');

let inSafeContext = false;

// Install a runner like a host SDK would. Set at module scope so it is resolved by
// `withRandomSafeContext` before the first call.
(GLOBAL_OBJ as unknown as Record<symbol, unknown>)[SAFE_RANDOM_SYMBOL] = <T>(cb: () => T): T => {
const previous = inSafeContext;
inSafeContext = true;
try {
return cb();
} finally {
inSafeContext = previous;
}
};

const RealDate = Date;

/**
* Runs `fn` with a guarded clock that throws on a bare `new Date()` / `Date.now()` unless the
* read happens inside the safe-context runner - mimicking a restricted prerender environment.
*/
function runWithGuardedClock<T>(fn: () => T): T {
const GuardedDate = class extends RealDate {
public constructor(...args: unknown[]) {
if (args.length === 0 && !inSafeContext) {
throw new Error('Read the ambient clock via `new Date()` outside the safe context');
}
super(...(args as [number | string | Date]));
}

public static now(): number {
if (!inSafeContext) {
throw new Error('Read the ambient clock via `Date.now()` outside the safe context');
}
return RealDate.now();
}
};

(globalThis as { Date: DateConstructor }).Date = GuardedDate as unknown as DateConstructor;
try {
return fn();
} finally {
(globalThis as { Date: DateConstructor }).Date = RealDate;
}
}

describe('envelope sent_at uses the safe time context', () => {
beforeEach(() => {
inSafeContext = false;
});

it('createEventEnvelope does not read the ambient clock directly', () => {
const event: Event = { event_id: 'abc123', message: 'Test message' };
expect(() => runWithGuardedClock(() => createEventEnvelope(event))).not.toThrow();
});

it('createSessionEnvelope does not read the ambient clock directly', () => {
expect(() => runWithGuardedClock(() => createSessionEnvelope({ aggregates: [] }))).not.toThrow();
});

it('createSpanEnvelope does not read the ambient clock directly', () => {
const span = new SentrySpan({ name: 'test-span', sampled: true });
expect(() => runWithGuardedClock(() => createSpanEnvelope([span]))).not.toThrow();
});

it('createCheckInEnvelope does not read the ambient clock directly', () => {
expect(() =>
runWithGuardedClock(() => createCheckInEnvelope({ check_in_id: 'check-in', monitor_slug: 'slug', status: 'ok' })),
).not.toThrow();
});
});
21 changes: 21 additions & 0 deletions packages/eslint-plugin-sdk/src/rules/no-unsafe-random-apis.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,8 @@ module.exports = {
'`crypto.randomUUID()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.randomUUID())`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeCryptoGetRandomValues:
'`crypto.getRandomValues()` should be wrapped with `withRandomSafeContext()` to ensure safe random value generation. Use: `withRandomSafeContext(() => crypto.getRandomValues(...))`. You can disable this rule with an eslint-disable comment if this usage is intentional.',
unsafeDateConstructor:
'`new Date()` reads the ambient clock and should be replaced with `new Date(safeDateNow())` (with `safeDateNow()` from `@sentry/core`) to ensure safe time value generation. You can disable this rule with an eslint-disable comment if this usage is intentional.',
},
},
create: function (context) {
Expand DownExpand Up@@ -142,6 +144,25 @@ module.exports = {
}
}
},
// Flag the `new Date()` constructor with no arguments, which reads the ambient clock.
// `new Date(<number>)` is safe because it does not read the current time.
NewExpression(node) {
if (isInSafeRandomGeneratorRunner(node)) {
return;
}

if (
node.callee.type === 'Identifier' &&
node.callee.name === 'Date' &&
node.arguments.length === 0 &&
!isInsidewithRandomSafeContext(node)
) {
context.report({
node,
messageId: 'unsafeDateConstructor',
});
}
},
};
},
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,19 @@ describe('no-unsafe-random-apis', () => {
{
code: 'const x = performance.mark("test")',
},
// `new Date(<value>)` does not read the ambient clock and is safe
{
code: 'const d = new Date(safeDateNow())',
},
{
code: 'const d = new Date(1234567890)',
},
{
code: 'const d = new Date("2021-01-01")',
},
{
code: 'withRandomSafeContext(() => new Date())',
},
],
invalid: [
// Direct Date.now() calls
Expand DownExpand Up@@ -140,6 +153,31 @@ describe('no-unsafe-random-apis', () => {
},
],
},
// Bare `new Date()` constructor reads the ambient clock
{
code: 'const now = new Date()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'const iso = new Date().toISOString()',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
{
code: 'someOtherWrapper(() => new Date())',
errors: [
{
messageId: 'unsafeDateConstructor',
},
],
},
],
});
});
Expand Down
Loading