ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
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 \u003e 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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
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

ref(browser/core): Move all log flushing logic into clients#15831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Mar 28, 2025
Merged

ref(browser/core): Move all log flushing logic into clients #15831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cfa782
ref(browser/core): Move all flushing logic into clients
AbhiPrasad Mar 26, 2025
f83e008
fix test in test
AbhiPrasad Mar 26, 2025
097bcc6
Merge branch 'develop' into abhi-move-into-client-logs
AbhiPrasad Mar 27, 2025
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
34 changes: 31 additions & 3 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,11 +15,14 @@ import {
addAutoIpAddressToUser,
applySdkMetadata,
getSDKSource,
_INTERNAL_flushLogsBuffer,
} from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
import { WINDOW } from './helpers';
import type { BrowserTransportOptions } from './transports/types';

const DEFAULT_FLUSH_INTERVAL = 5000;

/**
* Configuration options for the Sentry Browser SDK.
* @see @sentry/core Options for more information.
Expand DownExpand Up@@ -65,6 +68,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
* @see SentryClient for usage documentation.
*/
export class BrowserClient extends Client<BrowserClientOptions> {
private _logFlushIdleTimeout: ReturnType<typeof setTimeout> | undefined;
/**
* Creates a new Browser SDK instance.
*
Expand All@@ -81,17 +85,41 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
const { sendDefaultPii, _experiments } = client._options;
const enableLogs = _experiments?.enableLogs;

if (opts.sendClientReports && WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
this._flushOutcomes();
if (enableLogs) {
_INTERNAL_flushLogsBuffer(client);
}
}
});
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
if (enableLogs) {
client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

client.on('afterCaptureLog', () => {
if (client._logFlushIdleTimeout) {
clearTimeout(client._logFlushIdleTimeout);
}

client._logFlushIdleTimeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
});
}

if (sendDefaultPii) {
client.on('postprocessEvent', addAutoIpAddressToUser);
client.on('beforeSendSession', addAutoIpAddressToSession);
}
}

Expand Down
61 changes: 3 additions & 58 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
import type { LogSeverityLevel, Log, Client, ParameterizedString } from '@sentry/core';
import { getClient, _INTERNAL_captureLog, _INTERNAL_flushLogsBuffer } from '@sentry/core';

import { WINDOW } from './helpers';

/**
* TODO: Make this configurable
*/
const DEFAULT_FLUSH_INTERVAL = 5000;

let timeout: ReturnType<typeof setTimeout> | undefined;

/**
* This is a global timeout that is used to flush the logs buffer.
* It is used to ensure that logs are flushed even if the client is not flushed.
*/
function startFlushTimeout(client: Client): void {
if (timeout) {
clearTimeout(timeout);
}

timeout = setTimeout(() => {
_INTERNAL_flushLogsBuffer(client);
}, DEFAULT_FLUSH_INTERVAL);
}

let isClientListenerAdded = false;
/**
* This is a function that is used to add a flush listener to the client.
* It is used to ensure that the logger buffer is flushed when the client is flushed.
*/
function addFlushingListeners(client: Client): void {
if (isClientListenerAdded || !client.getOptions()._experiments?.enableLogs) {
return;
}

isClientListenerAdded = true;

if (WINDOW.document) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
_INTERNAL_flushLogsBuffer(client);
}
});
}

client.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});
}
import type { LogSeverityLevel, Log, ParameterizedString } from '@sentry/core';
import { _INTERNAL_captureLog } from '@sentry/core';

/**
* Capture a log with the given level.
Expand All@@ -63,14 +15,7 @@ function captureLog(
attributes?: Log['attributes'],
severityNumber?: Log['severityNumber'],
): void {
const client = getClient();
if (client) {
addFlushingListeners(client);

startFlushTimeout(client);
}

_INTERNAL_captureLog({ level, message, attributes, severityNumber }, client, undefined);
_INTERNAL_captureLog({ level, message, attributes, severityNumber });
}

/**
Expand Down
120 changes: 120 additions & 0 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
/**
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import * as sentryCore from '@sentry/core';
import { BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
import { getDefaultBrowserClientOptions } from './helper/browser-client-options';

vi.mock('@sentry/core', async requireActual => {
return {
...((await requireActual()) as any),
_INTERNAL_flushLogsBuffer: vi.fn(),
};
});

describe('BrowserClient', () => {
let client: BrowserClient;
const DEFAULT_FLUSH_INTERVAL = 5000;

afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});

it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();
});

describe('log flushing', () => {
beforeEach(() => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
sendClientReports: true,
}),
);
});

it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Simulate visibility change to hidden
if (WINDOW.document) {
Object.defineProperty(WINDOW.document, 'visibilityState', { value: 'hidden' });
WINDOW.document.dispatchEvent(new Event('visibilitychange'));
}

expect(flushOutcomesSpy).toHaveBeenCalled();
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs on flush event', () => {
// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Trigger flush event
client.emit('flush');

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('flushes logs after idle timeout', () => {
// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});

it('resets idle timeout when new logs are captured', () => {
// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Should not have flushed yet since timeout was reset
expect(sentryCore._INTERNAL_flushLogsBuffer).not.toHaveBeenCalled();

// Fast forward the full timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);

// Now should have flushed both logs
expect(sentryCore._INTERNAL_flushLogsBuffer).toHaveBeenCalledWith(client);
});
});
});
Loading