Repository navigation
test(nuxt): cover the client plugin's pages-router instrumentation #25348
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.
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
Open
61465
wants to merge
4
commits into
getsentry:develop
Choose a base branch
from
61465:fix/nuxt-client-plugin-tests
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+260
−34
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
be38a35
test(nuxt): cover the client plugin's pages-router instrumentation
61465 1b26458
test(nuxt): close coverage gaps flagged by Cursor Bugbot on #25348
61465 29e7fce
test(nuxt): tighten client plugin assertions per review
61465 bc8a3ff
test(nuxt): normalize line endings + cover both isNuxtError status fi…
61465 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,284 @@ | ||
| import { beforeEach, describe, expect, it, vi } from 'vitest'; | ||
| import { reportNuxtError } from '../../../src/runtime/utils'; | ||
| import type { Client } from '@sentry/core'; | ||
| import { afterEach, describe, expect, it, vi } from 'vitest'; | ||
| import clientPlugin from '../../../src/runtime/plugins/sentry.client'; | ||
| import * as utils from '../../../src/runtime/utils'; | ||
|
|
||
| vi.mock('nuxt/app', () => ({ | ||
| defineNuxtPlugin: (plugin: unknown) => plugin, | ||
| isNuxtError: (error: unknown) => !!error && typeof error === 'object' && '__nuxt_error' in error, | ||
| const getClient = vi.hoisted(() => vi.fn<() => Client | undefined>()); | ||
| const browserTracingIntegration = vi.hoisted(() => vi.fn()); | ||
| const vueIntegration = vi.hoisted(() => vi.fn()); | ||
| const createVueRouteProvider = vi.hoisted(() => vi.fn()); | ||
| const getRouteProvider = vi.hoisted(() => vi.fn()); | ||
| const setRouteProvider = vi.hoisted(() => vi.fn()); | ||
|
|
||
| const nuxtVueOptions = vi.hoisted(() => ({ | ||
| trackComponents: ['NuxtApp'], | ||
| attachProps: false, | ||
| })); | ||
| const globalObj = vi.hoisted(() => ({ | ||
| _sentryNuxtVueIntegrationOptions: nuxtVueOptions, | ||
| })); | ||
|
|
||
| vi.mock('../../../src/runtime/utils', () => ({ | ||
| reportNuxtError: vi.fn(), | ||
| vi.mock(import('@sentry/core'), async importOriginal => { | ||
| const mod = await importOriginal(); | ||
| return { ...mod, getClient, GLOBAL_OBJ: globalObj as never }; | ||
| }); | ||
|
|
||
| vi.mock(import('@sentry/vue'), async importOriginal => { | ||
| const mod = await importOriginal(); | ||
| return { | ||
| ...mod, | ||
| browserTracingIntegration, | ||
| vueIntegration, | ||
| _INTERNAL_createVueRouteProvider: createVueRouteProvider, | ||
| getRouteProvider, | ||
| setRouteProvider, | ||
| }; | ||
| }); | ||
|
|
||
| vi.mock(import('nuxt/app'), () => ({ | ||
| defineNuxtPlugin: vi.fn(plugin => plugin), | ||
| isNuxtError: vi.fn(() => false), | ||
| })); | ||
|
|
||
| type Hook = (...args: unknown[]) => void; | ||
| type PluginSetup = (nuxtApp: { | ||
| $router?: unknown; | ||
| hook: ReturnType<typeof vi.fn>; | ||
| }) => Promise<void>; | ||
|
|
||
| async function setupHook(hookName: string): Promise<Hook> { | ||
| const { default: plugin } = await import('../../../src/runtime/plugins/sentry.client'); | ||
| const hooks: Record<string, Hook> = {}; | ||
| const nuxtApp = { hook: (name: string, hook: Hook) => (hooks[name] = hook) }; | ||
| await (plugin as unknown as { setup: (app: unknown) => Promise<void> }).setup(nuxtApp); | ||
| expect(hooks).toHaveProperty(hookName); | ||
| return hooks[hookName]!; | ||
| type NuxtPluginShape = { setup: PluginSetup }; | ||
|
|
||
| function makeClient(overrides: Partial<Client> = {}): Client { | ||
| return { | ||
| addIntegration: vi.fn(), | ||
| getOptions: vi.fn(() => ({ attachProps: true })), | ||
| ...overrides, | ||
| } as unknown as Client; | ||
| } | ||
|
|
||
| function nuxtError(statusCode: number): Error { | ||
| return Object.assign(new Error(`status ${statusCode}`), { __nuxt_error: true, statusCode }); | ||
| function makeNuxtApp(router?: unknown): { $router?: unknown; hook: ReturnType<typeof vi.fn> } { | ||
| return router === undefined ? { hook: vi.fn() } : { $router: router, hook: vi.fn() }; | ||
| } | ||
|
|
||
| describe('sentry client plugin error hooks', () => { | ||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| describe('Sentry Nuxt client plugin', () => { | ||
| afterEach(() => { | ||
| vi.resetAllMocks(); | ||
| }); | ||
|
|
||
| it.each(['app:error', 'vue:error'])('does not report 3xx/4xx Nuxt errors from %s', async hookName => { | ||
| const hook = await setupHook(hookName); | ||
| describe('route provider setup', () => { | ||
| it('installs a Vue route provider when a Nuxt router is present and none is set', async () => { | ||
| const router = { beforeEach: vi.fn(), onError: vi.fn() }; | ||
| const client = makeClient(); | ||
| const provider = { resolveRoute: vi.fn(), resolveCurrentRoute: vi.fn() }; | ||
| getClient.mockReturnValue(client); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
| createVueRouteProvider.mockReturnValue(provider); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp(router)); | ||
|
|
||
| expect(createVueRouteProvider).toHaveBeenCalledWith(expect.any(Function)); | ||
| expect(setRouteProvider).toHaveBeenCalledWith(provider, client); | ||
| }); | ||
|
|
||
| it('does not override a user-supplied route provider', async () => { | ||
| const client = makeClient(); | ||
| getClient.mockReturnValue(client); | ||
| getRouteProvider.mockReturnValue({ resolveRoute: () => '/u', resolveCurrentRoute: () => '/u' }); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp({})); | ||
|
|
||
| hook(nuxtError(404)); | ||
| hook(nuxtError(301)); | ||
| expect(createVueRouteProvider).not.toHaveBeenCalled(); | ||
| expect(setRouteProvider).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| expect(reportNuxtError).not.toHaveBeenCalled(); | ||
| it('skips route provider setup without an initialized client', async () => { | ||
| getClient.mockReturnValue(undefined); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp({})); | ||
|
|
||
| expect(createVueRouteProvider).not.toHaveBeenCalled(); | ||
| expect(setRouteProvider).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('skips route provider setup without a $router on the Nuxt app', async () => { | ||
| const client = makeClient(); | ||
| getClient.mockReturnValue(client); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp()); | ||
|
|
||
| expect(createVueRouteProvider).not.toHaveBeenCalled(); | ||
| expect(setRouteProvider).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| it.each(['app:error', 'vue:error'])('reports 5xx Nuxt errors from %s', async hookName => { | ||
| const hook = await setupHook(hookName); | ||
| describe('browser tracing integration', () => { | ||
| it('adds browserTracingIntegration with the Nuxt router and path-based labels', async () => { | ||
| const router = { beforeEach: vi.fn(), onError: vi.fn() }; | ||
| const integration = { name: 'BrowserTracing' }; | ||
| const client = makeClient(); | ||
| getClient.mockReturnValue(client); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
| browserTracingIntegration.mockReturnValue(integration); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp(router)); | ||
|
|
||
| expect(browserTracingIntegration).toHaveBeenCalledWith({ router, routeLabel: 'path' }); | ||
| expect(client.addIntegration).toHaveBeenCalledWith(integration); | ||
| }); | ||
|
|
||
| it('does not add browserTracingIntegration without an initialized client', async () => { | ||
| getClient.mockReturnValue(undefined); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp({ beforeEach: vi.fn() })); | ||
|
|
||
| expect(browserTracingIntegration).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('does not add browserTracingIntegration when the Nuxt app has no router', async () => { | ||
| const client = makeClient(); | ||
| getClient.mockReturnValue(client); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| await (clientPlugin as NuxtPluginShape).setup(makeNuxtApp()); | ||
|
|
||
| expect(browserTracingIntegration).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('app:created hook — Vue integration', () => { | ||
| it('adds the Nuxt-specific Vue integration with attachErrorHandler disabled and merges GLOBAL_OBJ-provided options', async () => { | ||
| const client = makeClient(); | ||
| const integration = { name: 'NuxtVueIntegration' }; | ||
| const vueApp = { Symbol: 'app' }; | ||
| getClient.mockReturnValue(client); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
| vueIntegration.mockReturnValue(integration); | ||
|
|
||
| const nuxtApp = makeNuxtApp(); | ||
| await (clientPlugin as NuxtPluginShape).setup(nuxtApp); | ||
| const appCreatedCall = nuxtApp.hook.mock.calls.find(c => c[0] === 'app:created'); | ||
| expect(appCreatedCall).toBeTruthy(); | ||
| const appCreatedCb = appCreatedCall![1] as (app: unknown) => void; | ||
| appCreatedCb(vueApp); | ||
|
|
||
| // Nuxt-specific: _sentryNuxtVueIntegrationOptions from GLOBAL_OBJ must | ||
| // flow into vueIntegration alongside the fixed Nuxt options. | ||
| expect(vueIntegration).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| app: vueApp, | ||
| attachErrorHandler: false, | ||
| trackComponents: nuxtVueOptions.trackComponents, | ||
| attachProps: nuxtVueOptions.attachProps, | ||
| }), | ||
| ); | ||
| expect(client.addIntegration).toHaveBeenCalledWith(integration); | ||
| }); | ||
|
|
||
| it('does not add the Vue integration when the client is gone by the time the hook fires', async () => { | ||
| const client = makeClient(); | ||
| getClient.mockReturnValueOnce(client); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| const nuxtApp = makeNuxtApp(); | ||
| await (clientPlugin as NuxtPluginShape).setup(nuxtApp); | ||
|
|
||
| // Second getClient call (inside the hook) returns undefined — simulates teardown. | ||
| getClient.mockReturnValueOnce(undefined); | ||
| const appCreatedCb = nuxtApp.hook.mock.calls.find(c => c[0] === 'app:created')?.[1] as (app: unknown) => void; | ||
| appCreatedCb({}); | ||
|
|
||
| expect(vueIntegration).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| describe.each(['app:error', 'vue:error'] as const)('%s hook — status-code filtering', hookName => { | ||
| const fireHook = ( | ||
| nuxtApp: { hook: ReturnType<typeof vi.fn> }, | ||
| error: unknown, | ||
| ) => { | ||
| const cb = nuxtApp.hook.mock.calls.find(c => c[0] === hookName)?.[1] as ( | ||
| e: unknown, | ||
| instance?: unknown, | ||
| info?: string, | ||
| ) => void; | ||
| // vue:error carries (error, instance, info); app:error only (error). The | ||
| // plugin passes the extra args through for vue:error, so include them | ||
| // uniformly here and rely on expect.objectContaining({ error }) below. | ||
| cb(error, undefined, 'setup'); | ||
| }; | ||
|
|
||
| // The plugin's skip guard reads `error.status || error.statusCode`, so both | ||
| // field names in the 3xx/4xx range must be covered. | ||
| it.each([ | ||
| { status: 404 }, | ||
| { status: 301 }, | ||
| { statusCode: 404 }, | ||
| { statusCode: 301 }, | ||
| ])('skips reporting when a Nuxt error carries %o', async errorShape => { | ||
| const { isNuxtError } = await import('nuxt/app'); | ||
| const reportSpy = vi.spyOn(utils, 'reportNuxtError').mockImplementation(() => {}); | ||
| vi.mocked(isNuxtError).mockReturnValue(true); | ||
| getClient.mockReturnValue(makeClient()); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| const nuxtApp = makeNuxtApp(); | ||
| await (clientPlugin as NuxtPluginShape).setup(nuxtApp); | ||
| fireHook(nuxtApp, errorShape); | ||
|
|
||
| expect(reportSpy).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('reports a Nuxt error when the status code is 5xx', async () => { | ||
| const { isNuxtError } = await import('nuxt/app'); | ||
| const reportSpy = vi.spyOn(utils, 'reportNuxtError').mockImplementation(() => {}); | ||
| vi.mocked(isNuxtError).mockReturnValue(true); | ||
| getClient.mockReturnValue(makeClient()); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| const nuxtApp = makeNuxtApp(); | ||
| await (clientPlugin as NuxtPluginShape).setup(nuxtApp); | ||
| const err = { statusCode: 503, message: 'bad gateway' }; | ||
| fireHook(nuxtApp, err); | ||
|
|
||
| expect(reportSpy).toHaveBeenCalledWith(expect.objectContaining({ error: err })); | ||
| }); | ||
|
|
||
| // Non-Nuxt error carrying a 4xx statusCode exercises the `isNuxtError` | ||
| // guard directly — without the guard this would be skipped as 4xx. | ||
| it('reports a non-Nuxt error even when it carries a 4xx statusCode', async () => { | ||
| const { isNuxtError } = await import('nuxt/app'); | ||
| const reportSpy = vi.spyOn(utils, 'reportNuxtError').mockImplementation(() => {}); | ||
| vi.mocked(isNuxtError).mockReturnValue(false); | ||
| getClient.mockReturnValue(makeClient()); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| hook(nuxtError(503)); | ||
| const nuxtApp = makeNuxtApp(); | ||
| await (clientPlugin as NuxtPluginShape).setup(nuxtApp); | ||
| const err = Object.assign(new Error('boom'), { statusCode: 404 }); | ||
| fireHook(nuxtApp, err); | ||
|
|
||
| expect(reportNuxtError).toHaveBeenCalledTimes(1); | ||
| expect(reportSpy).toHaveBeenCalledWith(expect.objectContaining({ error: err })); | ||
| }); | ||
| }); | ||
|
|
||
| it('reports errors that are not Nuxt errors from vue:error', async () => { | ||
| const hook = await setupHook('vue:error'); | ||
| const error = Object.assign(new Error('boom'), { statusCode: 404 }); | ||
| describe('vue:error hook — component instance passthrough', () => { | ||
| it('forwards the error, component instance and info to reportNuxtError', async () => { | ||
| const reportSpy = vi.spyOn(utils, 'reportNuxtError').mockImplementation(() => {}); | ||
| getClient.mockReturnValue(makeClient()); | ||
| getRouteProvider.mockReturnValue(undefined); | ||
|
|
||
| hook(error, undefined, 'setup function'); | ||
| const nuxtApp = makeNuxtApp(); | ||
| await (clientPlugin as NuxtPluginShape).setup(nuxtApp); | ||
| const vueErrorCb = nuxtApp.hook.mock.calls.find(c => c[0] === 'vue:error')?.[1] as ( | ||
| e: unknown, | ||
| instance: unknown, | ||
| info: string, | ||
| ) => void; | ||
| const err = new Error('vue boom'); | ||
| const instance = { $props: { foo: 1 } }; | ||
| vueErrorCb(err, instance, 'render'); | ||
|
|
||
| expect(reportNuxtError).toHaveBeenCalledWith({ error, instance: undefined, info: 'setup function' }); | ||
| expect(reportSpy).toHaveBeenCalledWith({ error: err, instance, info: 'render' }); | ||
| }); | ||
| }); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file has CRLF line endings, please format the PR first (also fails in CI).