-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
test(e2e): Add a static trace lifecycle React E2E app #23848
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
Merged
Merged
Changes from all commits
Commits
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
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
dev-packages/e2e-tests/test-applications/react-17-static/.gitignore
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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| /test-results/ | ||
| /playwright-report/ | ||
| /playwright/.cache/ | ||
|
|
||
| !*.d.ts |
51 changes: 51 additions & 0 deletions
51
dev-packages/e2e-tests/test-applications/react-17-static/package.json
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 |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| { | ||
| "name": "react-17-static", | ||
| "version": "0.1.0", | ||
| "private": true, | ||
| "dependencies": { | ||
| "@sentry/react": "file:../../packed/sentry-react-packed.tgz", | ||
| "@types/react": "17.0.2", | ||
| "@types/react-dom": "17.0.2", | ||
| "react": "17.0.2", | ||
| "react-dom": "17.0.2", | ||
| "react-router-dom": "~6.3.0", | ||
| "react-scripts": "5.0.1", | ||
| "typescript": "~5.0.0" | ||
| }, | ||
| "scripts": { | ||
| "build": "react-scripts build", | ||
| "dev": "react-scripts start", | ||
| "start": "serve -s build", | ||
| "test": "playwright test", | ||
| "clean": "npx rimraf node_modules pnpm-lock.yaml", | ||
| "test:build": "pnpm install && pnpm build", | ||
| "test:build-canary": "pnpm install && pnpm add react@canary react-dom@canary && pnpm build", | ||
| "test:assert": "pnpm test" | ||
| }, | ||
| "eslintConfig": { | ||
| "extends": [ | ||
| "react-app", | ||
| "react-app/jest" | ||
| ] | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| }, | ||
| "devDependencies": { | ||
| "@playwright/test": "~1.56.0", | ||
| "@sentry-internal/test-utils": "link:../../../test-utils", | ||
| "serve": "14.0.1" | ||
| }, | ||
| "volta": { | ||
| "extends": "../../package.json" | ||
| } | ||
| } |
7 changes: 7 additions & 0 deletions
7
dev-packages/e2e-tests/test-applications/react-17-static/playwright.config.mjs
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import { getPlaywrightConfig } from '@sentry-internal/test-utils'; | ||
|
|
||
| const config = getPlaywrightConfig({ | ||
| startCommand: `pnpm start`, | ||
| }); | ||
|
|
||
| export default config; |
24 changes: 24 additions & 0 deletions
24
dev-packages/e2e-tests/test-applications/react-17-static/public/index.html
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 |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <meta name="theme-color" content="#000000" /> | ||
| <meta name="description" content="Web site created using create-react-app" /> | ||
| <title>React App</title> | ||
| </head> | ||
| <body> | ||
| <noscript>You need to enable JavaScript to run this app.</noscript> | ||
| <div id="root"></div> | ||
| <!-- | ||
| This HTML file is a template. | ||
| If you open it directly in the browser, you will see an empty page. | ||
|
|
||
| You can add webfonts, meta tags, or analytics to this file. | ||
| The build step will place the bundled scripts into the <body> tag. | ||
|
|
||
| To begin the development, run `npm start` or `yarn start`. | ||
| To create a production bundle, use `npm run build` or `yarn build`. | ||
| --> | ||
| </body> | ||
| </html> |
59 changes: 59 additions & 0 deletions
59
dev-packages/e2e-tests/test-applications/react-17-static/src/index.tsx
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 |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| import * as Sentry from '@sentry/react'; | ||
| import React from 'react'; | ||
| import ReactDOM from 'react-dom'; | ||
| import { | ||
| BrowserRouter, | ||
| Route, | ||
| Routes, | ||
| createRoutesFromChildren, | ||
| matchRoutes, | ||
| useLocation, | ||
| useNavigationType, | ||
| } from 'react-router-dom'; | ||
| import Index from './pages/Index'; | ||
| import User from './pages/User'; | ||
|
|
||
| const replay = Sentry.replayIntegration(); | ||
|
|
||
| Sentry.init({ | ||
| traceLifecycle: 'static', | ||
| environment: 'qa', // dynamic sampling bias to keep transactions | ||
| dsn: process.env.REACT_APP_E2E_TEST_DSN, | ||
| integrations: [ | ||
| Sentry.reactRouterV6BrowserTracingIntegration({ | ||
| useEffect: React.useEffect, | ||
| useLocation, | ||
| useNavigationType, | ||
| createRoutesFromChildren, | ||
| matchRoutes, | ||
| }), | ||
| replay, | ||
| ], | ||
| // We recommend adjusting this value in production, or using tracesSampler | ||
| // for finer control | ||
| tracesSampleRate: 1.0, | ||
| release: 'e2e-test', | ||
|
|
||
| // Always capture replays, so we can test this properly | ||
| replaysSessionSampleRate: 1.0, | ||
| replaysOnErrorSampleRate: 0.0, | ||
|
|
||
| tunnel: 'http://localhost:3031', | ||
| }); | ||
|
|
||
| const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes); | ||
|
|
||
| function App() { | ||
| return ( | ||
| <Sentry.ErrorBoundary> | ||
| <BrowserRouter> | ||
| <SentryRoutes> | ||
| <Route path="/" element={<Index />} /> | ||
| <Route path="/user/:id" element={<User />} /> | ||
| </SentryRoutes> | ||
| </BrowserRouter> | ||
| </Sentry.ErrorBoundary> | ||
| ); | ||
| } | ||
|
|
||
| ReactDOM.render(<App />, document.getElementById('root')); | ||
22 changes: 22 additions & 0 deletions
22
dev-packages/e2e-tests/test-applications/react-17-static/src/pages/Index.tsx
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 |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import * as React from 'react'; | ||
| import { Link } from 'react-router-dom'; | ||
|
|
||
| const Index = () => { | ||
| return ( | ||
| <> | ||
| <input | ||
| type="button" | ||
| value="Capture Exception" | ||
| id="exception-button" | ||
| onClick={() => { | ||
| throw new Error('I am an error!'); | ||
| }} | ||
| /> | ||
| <Link to="/user/5" id="navigation"> | ||
| navigate to user | ||
| </Link> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default Index; |
7 changes: 7 additions & 0 deletions
7
dev-packages/e2e-tests/test-applications/react-17-static/src/pages/User.tsx
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import * as React from 'react'; | ||
|
|
||
| const User = () => { | ||
| return <p>I am a blank page :)</p>; | ||
| }; | ||
|
|
||
| export default User; |
1 change: 1 addition & 0 deletions
1
dev-packages/e2e-tests/test-applications/react-17-static/src/react-app-env.d.ts
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 |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /// <reference types="react-scripts" /> |
6 changes: 6 additions & 0 deletions
6
dev-packages/e2e-tests/test-applications/react-17-static/start-event-proxy.mjs
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 |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { startEventProxyServer } from '@sentry-internal/test-utils'; | ||
|
|
||
| startEventProxyServer({ | ||
| port: 3031, | ||
| proxyServerName: 'react-17-static', | ||
| }); |
59 changes: 59 additions & 0 deletions
59
dev-packages/e2e-tests/test-applications/react-17-static/tests/errors.test.ts
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 |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| import { expect, test } from '@playwright/test'; | ||
| import { waitForError, waitForTransaction } from '@sentry-internal/test-utils'; | ||
|
|
||
| test('Sends correct error event', async ({ page }) => { | ||
| const errorEventPromise = waitForError('react-17-static', event => { | ||
| return !event.type && event.exception?.values?.[0]?.value === 'I am an error!'; | ||
| }); | ||
|
|
||
| await page.goto('/'); | ||
|
|
||
| const exceptionButton = page.locator('id=exception-button'); | ||
| await exceptionButton.click(); | ||
|
|
||
| const errorEvent = await errorEventPromise; | ||
|
|
||
| expect(errorEvent.exception?.values).toHaveLength(1); | ||
| expect(errorEvent.exception?.values?.[0]?.value).toBe('I am an error!'); | ||
|
|
||
| expect(errorEvent.request).toEqual({ | ||
| headers: expect.any(Object), | ||
| url: 'http://localhost:3030/', | ||
| }); | ||
|
|
||
| expect(errorEvent.transaction).toEqual('/'); | ||
|
|
||
| expect(errorEvent.contexts?.trace).toEqual({ | ||
| trace_id: expect.stringMatching(/[a-f0-9]{32}/), | ||
| span_id: expect.stringMatching(/[a-f0-9]{16}/), | ||
| }); | ||
| }); | ||
|
|
||
| test('Sets correct transactionName', async ({ page }) => { | ||
| const transactionPromise = waitForTransaction('react-17-static', async transactionEvent => { | ||
| return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload'; | ||
| }); | ||
|
|
||
| const errorEventPromise = waitForError('react-17-static', event => { | ||
| return !event.type && event.exception?.values?.[0]?.value === 'I am an error!'; | ||
| }); | ||
|
|
||
| await page.goto('/'); | ||
| const transactionEvent = await transactionPromise; | ||
|
|
||
| // Only capture error once transaction was sent | ||
| const exceptionButton = page.locator('id=exception-button'); | ||
| await exceptionButton.click(); | ||
|
|
||
| const errorEvent = await errorEventPromise; | ||
|
|
||
| expect(errorEvent.exception?.values).toHaveLength(1); | ||
| expect(errorEvent.exception?.values?.[0]?.value).toBe('I am an error!'); | ||
|
|
||
| expect(errorEvent.transaction).toEqual('/'); | ||
|
|
||
| expect(errorEvent.contexts?.trace).toEqual({ | ||
| trace_id: transactionEvent.contexts?.trace?.trace_id, | ||
| span_id: expect.not.stringContaining(transactionEvent.contexts?.trace?.span_id || ''), | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.