fix(utils): Keep logger on carrier#13570

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
mydea merged 5 commits into from
Sep 4, 2024
Merged

fix(utils): Keep logger on carrier #13570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
feca47c
fix(utils): Keep logger on carrier
mydea Sep 3, 2024
a225a43
user singleton directly
mydea Sep 3, 2024
52ab4bd
add new size limits
mydea Sep 3, 2024
4386e42
remove size limit
mydea Sep 3, 2024
3fd1ec5
skip in debug tests
mydea Sep 3, 2024
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
17 changes: 17 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
</head>
<body>
<button type="button" id="custom-feedback-buttom">Show feedback!</button>
</body>
</html>
82 changes: 82 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
if (shouldSkipFeedbackTest()) {
sentryTest.skip();
}

const feedbackRequestPromise = page.waitForResponse(res => {
const req = res.request();

const postData = req.postData();
if (!postData) {
return false;
}

try {
return getEnvelopeType(req) === 'feedback';
} catch (err) {
return false;
}
});

await page.route('https://dsn.ingest.sentry.io/**/*', route => {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ id: 'test-id' }),
});
});

const url = await getLocalTestUrl({ testDir: __dirname });

await page.goto(url);
await page.locator('#custom-feedback-buttom').click();
await page.waitForSelector(':visible:text-is("Report a Bug")');

expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
await page.locator('[name="name"]').fill('Jane Doe');
await page.locator('[name="email"]').fill('janedoe@example.org');
await page.locator('[name="message"]').fill('my example feedback');
await page.locator('[data-sentry-feedback] .btn--primary').click();

const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
expect(feedbackEvent).toEqual({
type: 'feedback',
breadcrumbs: expect.any(Array),
contexts: {
feedback: {
contact_email: 'janedoe@example.org',
message: 'my example feedback',
name: 'Jane Doe',
source: 'widget',
url: `${TEST_HOST}/index.html`,
},
trace: {
trace_id: expect.stringMatching(/\w{32}/),
span_id: expect.stringMatching(/\w{16}/),
},
},
level: 'info',
timestamp: expect.any(Number),
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
tags: {},
sdk: {
integrations: expect.arrayContaining(['Feedback']),
version: expect.any(String),
name: 'sentry.javascript.browser',
packages: expect.anything(),
},
request: {
url: `${TEST_HOST}/index.html`,
headers: {
'User-Agent': expect.stringContaining(''),
},
},
platform: 'javascript',
});
});
19 changes: 19 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
debug: true,
integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');
36 changes: 36 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/logger/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
* This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
* Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
*/
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
// In minified bundles we do not have logger messages, so we skip the test
if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
sentryTest.skip();
}

const messages: string[] = [];

page.on('console', message => {
messages.push(message.text());
});

await page.route('https://dsn.ingest.sentry.io/**/*', route => {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ id: 'test-id' }),
});
});

const url = await getLocalTestUrl({ testDir: __dirname });

await page.goto(url);

expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});
11 changes: 0 additions & 11 deletions ...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions ...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js
View file
Open in desktop

This file was deleted.

64 changes: 0 additions & 64 deletions ...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts
View file
Open in desktop

This file was deleted.

18 changes: 18 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
flushMinDelay: 200,
flushMaxDelay: 200,
minReplayDuration: 0,
});

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
sampleRate: 0,
replaysSessionSampleRate: 1.0,
replaysOnErrorSampleRate: 0.0,
debug: true,

integrations: [window.Replay],
});
36 changes: 36 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/logger/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
// In minified bundles we do not have logger messages, so we skip the test
if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
sentryTest.skip();
}

const messages: string[] = [];

page.on('console', message => {
messages.push(message.text());
});

await page.route('https://dsn.ingest.sentry.io/**/*', route => {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ id: 'test-id' }),
});
});

const reqPromise0 = waitForReplayRequest(page, 0);

const url = await getLocalTestPath({ testDir: __dirname });

await Promise.all([page.goto(url), reqPromise0]);

expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});
1 change: 0 additions & 1 deletion dev-packages/browser-integration-tests/utils/generatePlugin.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
httpClientIntegration: 'httpclient',
captureConsoleIntegration: 'captureconsole',
CaptureConsole: 'captureconsole',

@mydeamydeaSep 3, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7

debugIntegration: 'debug',
rewriteFramesIntegration: 'rewriteframes',
contextLinesIntegration: 'contextlines',
Expand Down
8 changes: 6 additions & 2 deletions packages/utils/src/logger.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
return logger as Logger;
}

export const logger = makeLogger();
/**
* This is a logger singleton which either logs things or no-ops if logging is not enabled.
* The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
*/
export const logger = getGlobalSingleton('logger', makeLogger);
2 changes: 2 additions & 0 deletions packages/utils/src/worldwide.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
defaultIsolationScope?: Scope;
defaultCurrentScope?: Scope;
globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
logger?: typeof logger;

/** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
encodePolyfill?: (input: string) => Uint8Array;
Expand Down
, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down

, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down

, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down

, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down

, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down

, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down

, '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
fix(utils): Keep logger on carrier#13570

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

mydea
merged 5 commits into

from

Sep 4, 2024
 Merged


fix(utils): Keep logger on carrier
#13570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
feca47c

fix(utils): Keep logger on carrier


mydea Sep 3, 2024
a225a43

user singleton directly


mydea Sep 3, 2024
52ab4bd

add new size limits


mydea Sep 3, 2024
4386e42

remove size limit


mydea Sep 3, 2024
3fd1ec5

skip in debug tests


mydea Sep 3, 2024

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


17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [feedback],
});

feedback.attachTo('#custom-feedback-buttom');

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button type="button" id="custom-feedback-buttom">Show feedback!</button>
 </body>
</html>

82 changes: 82 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import { expect } from '@playwright/test';

import { TEST_HOST, sentryTest } from '../../../utils/fixtures';
import { envelopeRequestParser, getEnvelopeType, shouldSkipFeedbackTest } from '../../../utils/helpers';

sentryTest('should capture feedback with custom button', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeedbackTest()) {
 sentryTest.skip();
 }

 const feedbackRequestPromise = page.waitForResponse(res => {
 const req = res.request();

 const postData = req.postData();
 if (!postData) {
 return false;
 }

 try {
 return getEnvelopeType(req) === 'feedback';
 } catch (err) {
 return false;
 }
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);
 await page.locator('#custom-feedback-buttom').click();
 await page.waitForSelector(':visible:text-is("Report a Bug")');

 expect(await page.locator(':visible:text-is("Report a Bug")').count()).toEqual(1);
 await page.locator('[name="name"]').fill('Jane Doe');
 await page.locator('[name="email"]').fill('janedoe@example.org');
 await page.locator('[name="message"]').fill('my example feedback');
 await page.locator('[data-sentry-feedback] .btn--primary').click();

 const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
 expect(feedbackEvent).toEqual({
 type: 'feedback',
 breadcrumbs: expect.any(Array),
 contexts: {
 feedback: {
 contact_email: 'janedoe@example.org',
 message: 'my example feedback',
 name: 'Jane Doe',
 source: 'widget',
 url: `${TEST_HOST}/index.html`,
 },
 trace: {
 trace_id: expect.stringMatching(/\w{32}/),
 span_id: expect.stringMatching(/\w{16}/),
 },
 },
 level: 'info',
 timestamp: expect.any(Number),
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
 name: 'sentry.javascript.browser',
 packages: expect.anything(),
 },
 request: {
 url: `${TEST_HOST}/index.html`,
 headers: {
 'User-Agent': expect.stringContaining(''),
 },
 },
 platform: 'javascript',
 });
});

19 changes: 19 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/browser';
// Import this separately so that generatePlugin can handle it for CDN scenarios
import { feedbackIntegration } from '@sentry/browser';

const feedback = feedbackIntegration({
 autoInject: false,
});

window.Sentry = Sentry;
window.feedback = feedback;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 debug: true,
 integrations: [feedback],
});

// This should log an error!
feedback.attachTo('#does-not-exist');

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipFeedbackTest } from '../../../utils/helpers';

/**
 * This test is mostly relevant for ensuring that the logger works in all combinations of CDN bundles.
 * Even if feedback is included via the CDN, this test ensures that the logger is working correctly.
 */
sentryTest('should log error correctly', async ({ getLocalTestUrl, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipFeedbackTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Feedback');
 expect(messages).toContain('Sentry Logger [error]: [Feedback] Unable to attach to target element');
});

11 changes: 0 additions & 11 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/init.js

View file


Open in desktop


This file was deleted.


8 changes: 0 additions & 8 deletions
...browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/subject.js

View file


Open in desktop


This file was deleted.


64 changes: 0 additions & 64 deletions
...es/browser-integration-tests/suites/integrations/httpclient/httpClientIntegration/test.ts

View file


Open in desktop


This file was deleted.


18 changes: 18 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 0,
 replaysSessionSampleRate: 1.0,
 replaysOnErrorSampleRate: 0.0,
 debug: true,

 integrations: [window.Replay],
});

36 changes: 36 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/logger/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
 // In minified bundles we do not have logger messages, so we skip the test
 if (shouldSkipReplayTest() || (process.env.PW_BUNDLE || '').includes('_min')) {
 sentryTest.skip();
 }

 const messages: string[] = [];

 page.on('console', message => {
 messages.push(message.text());
 });

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const reqPromise0 = waitForReplayRequest(page, 0);

 const url = await getLocalTestPath({ testDir: __dirname });

 await Promise.all([page.goto(url), reqPromise0]);

 expect(messages).toContain('Sentry Logger [log]: Integration installed: Replay');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Creating new session');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Starting replay in session mode');
 expect(messages).toContain('Sentry Logger [info]: [Replay] Using compression worker');
});

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ const useLoader = bundleKey.startsWith('loader');
const IMPORTED_INTEGRATION_CDN_BUNDLE_PATHS: Record<string, string> = {
 httpClientIntegration: 'httpclient',
 captureConsoleIntegration: 'captureconsole',
 CaptureConsole: 'captureconsole',
@mydeamydeaSep 3, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a forgotten leftover from v7
 debugIntegration: 'debug',
 rewriteFramesIntegration: 'rewriteframes',
 contextLinesIntegration: 'contextlines',
Expand Down

8 changes: 6 additions & 2 deletions
packages/utils/src/logger.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { ConsoleLevel } from '@sentry/types';

import { DEBUG_BUILD } from './debug-build';
import { GLOBAL_OBJ } from './worldwide';
import { GLOBAL_OBJ, getGlobalSingleton } from './worldwide';

/** Prefix for logging strings */
const PREFIX = 'Sentry Logger ';
Expand DownExpand Up@@ -97,4 +97,8 @@ function makeLogger(): Logger {
 return logger as Logger;
}

export const logger = makeLogger();
/**
 * This is a logger singleton which either logs things or no-ops if logging is not enabled.
 * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
 */
export const logger = getGlobalSingleton('logger', makeLogger);

2 changes: 2 additions & 0 deletions
packages/utils/src/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
import type { Client, MetricsAggregator, Scope } from '@sentry/types';

import type { SdkSource } from './env';
import type { logger } from './logger';
import { SDK_VERSION } from './version';

interface SentryCarrier {
Expand All@@ -25,6 +26,7 @@ interface SentryCarrier {
 defaultIsolationScope?: Scope;
 defaultCurrentScope?: Scope;
 globalMetricsAggregators?: WeakMap<Client, MetricsAggregator> | undefined;
 logger?: typeof logger;

 /** Overwrites TextEncoder used in `@sentry/utils`, need for `react-native@0.73` and older */
 encodePolyfill?: (input: string) => Uint8Array;
Expand Down