Skip to content
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

Jump to bottom

fix(utils): Keep logger on carrier #13570

Merged
merged 5 commits into from
Sep 4, 2024
Merged

fix(utils): Keep logger on carrier #13570

Show file tree
Hide file tree
Changes from 1 commit
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
20 changes: 20 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/attachTo/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
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://[email protected]/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 number Diff line number Diff 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 number Diff line number Diff 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('[email protected]');
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: '[email protected]',
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',
});
});
22 changes: 22 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/logger/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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://[email protected]/1337',
debug: true,
integrations: [
feedback,
],
});

// This should log an error!
feedback.attachTo('#does-not-exist');
35 changes: 35 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/logger/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
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 }) => {
if (shouldSkipFeedbackTest()) {
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 number Diff line number Diff 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://[email protected]/1337',
sampleRate: 0,
replaysSessionSampleRate: 1.0,
replaysOnErrorSampleRate: 0.0,
debug: true,

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

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

sentryTest('should output logger messages', async ({ getLocalTestPath, page }) => {
if (shouldSkipReplayTest()) {
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 number Diff line number Diff 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',
Copy link
Member Author

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
17 changes: 15 additions & 2 deletions packages/utils/src/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff 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 Down Expand Up @@ -97,4 +97,17 @@ 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: Logger = new Proxy(
mydea marked this conversation as resolved.
Show resolved Hide resolved
{},
{
get: (_target, prop: ConsoleLevel) => {
const logger = getGlobalSingleton('logger', makeLogger);

return logger[prop];
},
},
) as Logger;
2 changes: 2 additions & 0 deletions packages/utils/src/worldwide.ts
View file
Open in desktop
Original file line number Diff line number Diff 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 `[email protected]` and older */
encodePolyfill?: (input: string) => Uint8Array;
Expand Down
Loading