Skip to content

test(nuxt): Add E2E test with NuxtErrorBoundary #14754

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
merged 3 commits into from
Dec 18, 2024
Merged

test(nuxt): Add E2E test with NuxtErrorBoundary #14754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2935bee
test(nuxt): Add E2E test with NuxtErrorBoundary
s1gr1d Dec 17, 2024
e58f079
review suggestions
s1gr1d Dec 17, 2024
d8461cc
Merge branch 'develop' into sig/nuxt-error-boundary
s1gr1d Dec 18, 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
11 changes: 8 additions & 3 deletions dev-packages/e2e-tests/test-applications/nuxt-3/pages/client-error.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
<script setup>
import ErrorButton from '../components/ErrorButton.vue';

const catchErr = () => {
console.log('Additional functionality in NuxtErrorBoundary');
}
</script>

<template>
<ErrorButton id="errorBtn" error-text="Error thrown from Nuxt-3 E2E test app"/>
<ErrorButton id="errorBtn2" error-text="Another Error thrown from Nuxt-3 E2E test app"/>
</template>



<NuxtErrorBoundary @error="catchErr">
<ErrorButton id="error-in-error-boundary" error-text="Error thrown in Error Boundary"/>
</NuxtErrorBoundary>
</template>
41 changes: 41 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/tests/errors.client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,47 @@ test.describe('client-side errors', async () => {
});
});

test('captures error thrown in NuxtErrorBoundary', async ({ page }) => {
const errorPromise = waitForError('nuxt-3', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown in Error Boundary';
});

await page.goto(`/client-error`);
await page.locator('#error-in-error-boundary').click();

const error = await errorPromise;

const expectedBreadcrumb = {
category: 'console',
message: 'Additional functionality in NuxtErrorBoundary',
};

const matchingBreadcrumb = error.breadcrumbs.find(
(breadcrumb: { category: string; message: string }) =>
breadcrumb.category === expectedBreadcrumb.category && breadcrumb.message === expectedBreadcrumb.message,
);

expect(matchingBreadcrumb).toBeTruthy();
expect(matchingBreadcrumb?.category).toBe(expectedBreadcrumb.category);
expect(matchingBreadcrumb?.message).toBe(expectedBreadcrumb.message);

expect(error.transaction).toEqual('/client-error');
expect(error.sdk.name).toEqual('sentry.javascript.nuxt');
expect(error).toMatchObject({
exception: {
values: [
{
type: 'Error',
value: 'Error thrown in Error Boundary',
mechanism: {
handled: false,
},
},
],
},
});
});

test('shows parametrized route on button error', async ({ page }) => {
const errorPromise = waitForError('nuxt-3', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Param Route Button';
Expand Down
11 changes: 8 additions & 3 deletions dev-packages/e2e-tests/test-applications/nuxt-4/app/pages/client-error.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
<script setup>
import ErrorButton from '../components/ErrorButton.vue';

const catchErr = () => {
console.log('Additional functionality in NuxtErrorBoundary');
}
</script>

<template>
<ErrorButton id="errorBtn" error-text="Error thrown from Nuxt-4 E2E test app"/>
<ErrorButton id="errorBtn2" error-text="Another Error thrown from Nuxt-4 E2E test app"/>
</template>



<NuxtErrorBoundary @error="catchErr">
<ErrorButton id="error-in-error-boundary" error-text="Error thrown in Error Boundary"/>
</NuxtErrorBoundary>
</template>
41 changes: 41 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-4/tests/errors.client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,47 @@ test.describe('client-side errors', async () => {
});
});

test('captures error thrown in NuxtErrorBoundary', async ({ page }) => {
const errorPromise = waitForError('nuxt-4', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown in Error Boundary';
});

await page.goto(`/client-error`);
await page.locator('#error-in-error-boundary').click();

const error = await errorPromise;

const expectedBreadcrumb = {
category: 'console',
message: 'Additional functionality in NuxtErrorBoundary',
};

const matchingBreadcrumb = error.breadcrumbs.find(
(breadcrumb: { category: string; message: string }) =>
breadcrumb.category === expectedBreadcrumb.category && breadcrumb.message === expectedBreadcrumb.message,
);

expect(matchingBreadcrumb).toBeTruthy();
expect(matchingBreadcrumb?.category).toBe(expectedBreadcrumb.category);
expect(matchingBreadcrumb?.message).toBe(expectedBreadcrumb.message);

expect(error.transaction).toEqual('/client-error');
expect(error.sdk.name).toEqual('sentry.javascript.nuxt');
expect(error).toMatchObject({
exception: {
values: [
{
type: 'Error',
value: 'Error thrown in Error Boundary',
mechanism: {
handled: false,
},
},
],
},
});
});

test('shows parametrized route on button error', async ({ page }) => {
const errorPromise = waitForError('nuxt-4', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Param Route Button';
Expand Down
Loading