fix(nuxt): Detect pageload by adding flag in Vue router#13171

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
s1gr1d merged 11 commits into from
Aug 5, 2024
Merged

fix(nuxt): Detect pageload by adding flag in Vue router #13171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b6e6634
fix(nuxt): Detect pageload by adding flag in Vue
s1gr1d Aug 2, 2024
e31e6c9
make vue unit tests running again
s1gr1d Aug 2, 2024
1877074
fix comment
s1gr1d Aug 2, 2024
dce66f5
review comments
s1gr1d Aug 2, 2024
1d920a1
Merge branch 'develop' into sig/vue-router-pageload
s1gr1d Aug 2, 2024
8fb974b
fix vue unit tests
s1gr1d Aug 2, 2024
704b0c3
Merge branch 'develop' into sig/vue-router-pageload
s1gr1d Aug 2, 2024
f0736c3
Merge branch 'refs/heads/develop' into sig/vue-router-pageload
s1gr1d Aug 5, 2024
af14d4f
change variable name in comment
s1gr1d Aug 5, 2024
90ef6e1
fix tests; change to logger
s1gr1d Aug 5, 2024
acb3e10
Merge branch 'refs/heads/develop' into sig/vue-router-pageload
s1gr1d Aug 5, 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
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
},
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
* Like this: import { expect, test } from '@nuxt/test-utils/playwright' */

Comment on lines +11 to +13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.

const config = getPlaywrightConfig({
startCommand: `pnpm preview`,
use: { ...nuxtConfigOptions },
Expand Down
31 changes: 31 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
return transactionEvent.transaction === '/test-param/:param()';
});

await page.goto(`/test-param/1234`);

const rootSpan = await transactionPromise;

expect(rootSpan).toMatchObject({
contexts: {
trace: {
data: {
'sentry.source': 'route',
'sentry.origin': 'auto.pageload.vue',
'sentry.op': 'pageload',
'params.param': '1234',
},
op: 'pageload',
origin: 'auto.pageload.vue',
},
},
transaction: '/test-param/:param()',
transaction_info: {
source: 'route',
},
});
});
6 changes: 4 additions & 2 deletions packages/nuxt/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
// todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
if (event.transaction?.match(/^GET \/_nuxt\//)) {
options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&

@mydeamydeaAug 5, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🙏 good change!

logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
return null;
}

Expand Down
14 changes: 12 additions & 2 deletions packages/vue/src/router.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
},
startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
let isFirstPageLoad = true;

router.onError(error => captureException(error, { mechanism: { handled: false } }));

router.beforeEach((to, from, next) => {
// According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
// According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
// https://router.vuejs.org/api/#router-start-location
// https://next.router.vuejs.org/api/#start-location
// Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
// Therefore, a flag was added to track the page-load: isFirstPageLoad

// from.name:
// - Vue 2: null
// - Vue 3: undefined
// - Nuxt: undefined
// hence only '==' instead of '===', because `undefined == null` evaluates to `true`
const isPageLoadNavigation = from.name == null && from.matched.length === 0;
const isPageLoadNavigation =
(from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

if (isFirstPageLoad) {
isFirstPageLoad = false;
}

const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down
7 changes: 6 additions & 1 deletion packages/vue/test/router.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

const from = testRoutes[fromKey]!;
const to = testRoutes[toKey]!;
beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
beforeEachCallback(to, from, mockNext);

expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
op: 'navigation',
});

expect(mockNext).toHaveBeenCalledTimes(1);
expect(mockNext).toHaveBeenCalledTimes(2);
},
);

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

const from = testRoutes.normalRoute1!;
const to = testRoutes.namedRoute!;
beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
beforeEachCallback(to, from, mockNext);

// first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

const from = testRoutes.normalRoute1!;
const to = testRoutes.namedRoute!;
beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
beforeEachCallback(to, from, mockNext);

// first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

const from = testRoutes.normalRoute1!;
const to = testRoutes.namedRoute!;
beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
beforeEachCallback(to, from, undefined);

// first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
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(nuxt): Detect pageload by adding flag in Vue router#13171

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

s1gr1d
merged 11 commits into

from

Aug 5, 2024
 Merged


fix(nuxt): Detect pageload by adding flag in Vue router
#13171
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b6e6634

fix(nuxt): Detect pageload by adding flag in Vue


s1gr1d Aug 2, 2024
e31e6c9

make vue unit tests running again


s1gr1d Aug 2, 2024
1877074

fix comment


s1gr1d Aug 2, 2024
dce66f5

review comments


s1gr1d Aug 2, 2024
1d920a1

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
8fb974b

fix vue unit tests


s1gr1d Aug 2, 2024
704b0c3

Merge branch 'develop' into sig/vue-router-pageload


s1gr1d Aug 2, 2024
f0736c3

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 2024
af14d4f

change variable name in comment


s1gr1d Aug 5, 2024
90ef6e1

fix tests; change to logger


s1gr1d Aug 5, 2024
acb3e10

Merge branch 'refs/heads/develop' into sig/vue-router-pageload


s1gr1d Aug 5, 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


3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const nuxtConfigOptions: ConfigOptions = {
 },
};

/* Make sure to import from '@nuxt/test-utils/playwright' in the tests
 * Like this: import { expect, test } from '@nuxt/test-utils/playwright' */


Comment on lines

+11
 to 
+13

@s1gr1ds1gr1dAug 2, 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.

Added this just as a heads-up in case someone adds new tests later on.
const config = getPlaywrightConfig({
 startCommand: `pnpm preview`,
 use: { ...nuxtConfigOptions },
Expand Down

31 changes: 31 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/tests/performance.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
import { expect, test } from '@nuxt/test-utils/playwright';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload root span with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('nuxt-3', async transactionEvent => {
 return transactionEvent.transaction === '/test-param/:param()';
 });

 await page.goto(`/test-param/1234`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 data: {
 'sentry.source': 'route',
 'sentry.origin': 'auto.pageload.vue',
 'sentry.op': 'pageload',
 'params.param': '1234',
 },
 op: 'pageload',
 origin: 'auto.pageload.vue',
 },
 },
 transaction: '/test-param/:param()',
 transaction_info: {
 source: 'route',
 },
 });
});

6 changes: 4 additions & 2 deletions
packages/nuxt/src/server/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { applySdkMetadata, getGlobalScope } from '@sentry/core';
import { init as initNode } from '@sentry/node';
import type { Client, EventProcessor } from '@sentry/types';
import { logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../common/debug-build';
import type { SentryNuxtOptions } from '../common/types';

/**
Expand All@@ -26,8 +28,8 @@ export function init(options: SentryNuxtOptions): Client | undefined {
 // todo: the buildAssetDir could be changed in the nuxt config - change this to a more generic solution
 if (event.transaction?.match(/^GET \/_nuxt\//)) {
 options.debug &&
// eslint-disable-next-line no-console
console.log('[Sentry] NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
DEBUG_BUILD &&
@mydeamydeaAug 5, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

🙏 good change!
logger.log('NuxtLowQualityTransactionsFilter filtered transaction: ', event.transaction);
 return null;
 }

Expand Down

14 changes: 12 additions & 2 deletions
packages/vue/src/router.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,18 +50,28 @@ export function instrumentVueRouter(
 },
 startNavigationSpanFn: (context: StartSpanOptions) => void,
): void {
 let isFirstPageLoad = true;

 router.onError(error => captureException(error, { mechanism: { handled: false } }));

 router.beforeEach((to, from, next) => {
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldnt get it working for Vue 2
 // According to docs we could use `from === VueRouter.START_LOCATION` but I couldn't get it working for Vue 2
 // https://router.vuejs.org/api/#router-start-location
 // https://next.router.vuejs.org/api/#start-location
 // Additionally, Nuxt does not provide the possibility to check for `from.matched.length === 0` (this is never 0).
 // Therefore, a flag was added to track the page-load: isFirstPageLoad

 // from.name:
 // - Vue 2: null
 // - Vue 3: undefined
 // - Nuxt: undefined
 // hence only '==' instead of '===', because `undefined == null` evaluates to `true`
 const isPageLoadNavigation = from.name == null && from.matched.length === 0;
 const isPageLoadNavigation =
 (from.name == null && from.matched.length === 0) || (from.name === undefined && isFirstPageLoad);

 if (isFirstPageLoad) {
 isFirstPageLoad = false;
 }

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.vue',
Expand Down

7 changes: 6 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,6 +114,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes[fromKey]!;
 const to = testRoutes[toKey]!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(1);
Expand All@@ -127,7 +128,7 @@ describe('instrumentVueRouter()', () => {
 op: 'navigation',
 });

 expect(mockNext).toHaveBeenCalledTimes(1);
 expect(mockNext).toHaveBeenCalledTimes(2);
 },
 );

Expand DownExpand Up@@ -192,6 +193,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -219,6 +221,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, mockNext);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand DownExpand Up@@ -373,6 +376,7 @@ describe('instrumentVueRouter()', () => {
 expect(mockVueRouter.beforeEach).toHaveBeenCalledTimes(1);

 const beforeEachCallback = mockVueRouter.beforeEach.mock.calls[0]![0]!;
 beforeEachCallback(testRoutes['normalRoute1']!, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(testRoutes['normalRoute2']!, testRoutes['normalRoute1']!, mockNext);

 expect(mockStartSpan).toHaveBeenCalledTimes(expectedCallsAmount);
Expand All@@ -391,6 +395,7 @@ describe('instrumentVueRouter()', () => {

 const from = testRoutes.normalRoute1!;
 const to = testRoutes.namedRoute!;
 beforeEachCallback(to, testRoutes['initialPageloadRoute']!, mockNext); // fake initial pageload
 beforeEachCallback(to, from, undefined);

 // first startTx call happens when the instrumentation is initialized (for pageloads)
Expand Down