-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
test(e2e): Add Vue 3 E2E tests #10476
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
This file contains 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
This file contains 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,30 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
lerna-debug.log* | ||
|
||
node_modules | ||
.DS_Store | ||
dist | ||
dist-ssr | ||
coverage | ||
*.local | ||
|
||
/cypress/videos/ | ||
/cypress/screenshots/ | ||
|
||
# Editor directories and files | ||
.vscode/* | ||
!.vscode/extensions.json | ||
.idea | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? | ||
|
||
*.tsbuildinfo |
This file contains 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,2 @@ | ||
@sentry:registry=http://127.0.0.1:4873 | ||
@sentry-internal:registry=http://127.0.0.1:4873 |
This file contains 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,3 @@ | ||
# Vue 3 E2E Test App | ||
|
||
E2E test app for Vue 3 and `@sentry/vue`. |
This file contains 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="vite/client" /> |
253 changes: 253 additions & 0 deletions
253
dev-packages/e2e-tests/test-applications/vue-3/event-proxy-server.ts
This file contains 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,253 @@ | ||
import * as fs from 'fs'; | ||
import * as http from 'http'; | ||
import * as https from 'https'; | ||
import type { AddressInfo } from 'net'; | ||
import * as os from 'os'; | ||
import * as path from 'path'; | ||
import * as util from 'util'; | ||
import * as zlib from 'zlib'; | ||
import type { Envelope, EnvelopeItem, SerializedEvent } from '@sentry/types'; | ||
import { parseEnvelope } from '@sentry/utils'; | ||
|
||
const readFile = util.promisify(fs.readFile); | ||
const writeFile = util.promisify(fs.writeFile); | ||
|
||
interface EventProxyServerOptions { | ||
/** Port to start the event proxy server at. */ | ||
port: number; | ||
/** The name for the proxy server used for referencing it with listener functions */ | ||
proxyServerName: string; | ||
} | ||
|
||
interface SentryRequestCallbackData { | ||
envelope: Envelope; | ||
rawProxyRequestBody: string; | ||
rawSentryResponseBody: string; | ||
sentryResponseStatusCode?: number; | ||
} | ||
|
||
/** | ||
* Starts an event proxy server that will proxy events to sentry when the `tunnel` option is used. Point the `tunnel` | ||
* option to this server (like this `tunnel: http://localhost:${port option}/`). | ||
*/ | ||
export async function startEventProxyServer(options: EventProxyServerOptions): Promise<void> { | ||
const eventCallbackListeners: Set<(data: string) => void> = new Set(); | ||
|
||
const proxyServer = http.createServer((proxyRequest, proxyResponse) => { | ||
const proxyRequestChunks: Uint8Array[] = []; | ||
|
||
proxyRequest.addListener('data', (chunk: Buffer) => { | ||
proxyRequestChunks.push(chunk); | ||
}); | ||
|
||
proxyRequest.addListener('error', err => { | ||
throw err; | ||
}); | ||
|
||
proxyRequest.addListener('end', () => { | ||
const proxyRequestBody = | ||
proxyRequest.headers['content-encoding'] === 'gzip' | ||
? zlib.gunzipSync(Buffer.concat(proxyRequestChunks)).toString() | ||
: Buffer.concat(proxyRequestChunks).toString(); | ||
|
||
let envelopeHeader = JSON.parse(proxyRequestBody.split('\n')[0]); | ||
|
||
if (!envelopeHeader.dsn) { | ||
throw new Error('[event-proxy-server] No dsn on envelope header. Please set tunnel option.'); | ||
} | ||
|
||
const { origin, pathname, host } = new URL(envelopeHeader.dsn); | ||
|
||
const projectId = pathname.substring(1); | ||
const sentryIngestUrl = `${origin}/api/${projectId}/envelope/`; | ||
|
||
proxyRequest.headers.host = host; | ||
|
||
const sentryResponseChunks: Uint8Array[] = []; | ||
|
||
const sentryRequest = https.request( | ||
sentryIngestUrl, | ||
{ headers: proxyRequest.headers, method: proxyRequest.method }, | ||
sentryResponse => { | ||
sentryResponse.addListener('data', (chunk: Buffer) => { | ||
proxyResponse.write(chunk, 'binary'); | ||
sentryResponseChunks.push(chunk); | ||
}); | ||
|
||
sentryResponse.addListener('end', () => { | ||
eventCallbackListeners.forEach(listener => { | ||
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString(); | ||
|
||
const data: SentryRequestCallbackData = { | ||
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()), | ||
rawProxyRequestBody: proxyRequestBody, | ||
rawSentryResponseBody, | ||
sentryResponseStatusCode: sentryResponse.statusCode, | ||
}; | ||
|
||
listener(Buffer.from(JSON.stringify(data)).toString('base64')); | ||
}); | ||
proxyResponse.end(); | ||
}); | ||
|
||
sentryResponse.addListener('error', err => { | ||
throw err; | ||
}); | ||
|
||
proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers); | ||
}, | ||
); | ||
|
||
|
||
sentryRequest.write(Buffer.concat(proxyRequestChunks), 'binary'); | ||
sentryRequest.end(); | ||
}); | ||
}); | ||
|
||
const proxyServerStartupPromise = new Promise<void>(resolve => { | ||
proxyServer.listen(options.port, () => { | ||
resolve(); | ||
}); | ||
}); | ||
|
||
const eventCallbackServer = http.createServer((eventCallbackRequest, eventCallbackResponse) => { | ||
eventCallbackResponse.statusCode = 200; | ||
eventCallbackResponse.setHeader('connection', 'keep-alive'); | ||
|
||
const callbackListener = (data: string): void => { | ||
eventCallbackResponse.write(data.concat('\n'), 'utf8'); | ||
}; | ||
|
||
eventCallbackListeners.add(callbackListener); | ||
|
||
eventCallbackRequest.on('close', () => { | ||
eventCallbackListeners.delete(callbackListener); | ||
}); | ||
|
||
eventCallbackRequest.on('error', () => { | ||
eventCallbackListeners.delete(callbackListener); | ||
}); | ||
}); | ||
|
||
const eventCallbackServerStartupPromise = new Promise<void>(resolve => { | ||
eventCallbackServer.listen(0, () => { | ||
const port = String((eventCallbackServer.address() as AddressInfo).port); | ||
void registerCallbackServerPort(options.proxyServerName, port).then(resolve); | ||
}); | ||
}); | ||
|
||
await eventCallbackServerStartupPromise; | ||
await proxyServerStartupPromise; | ||
return; | ||
} | ||
|
||
export async function waitForRequest( | ||
proxyServerName: string, | ||
callback: (eventData: SentryRequestCallbackData) => Promise<boolean> | boolean, | ||
): Promise<SentryRequestCallbackData> { | ||
const eventCallbackServerPort = await retrieveCallbackServerPort(proxyServerName); | ||
|
||
return new Promise<SentryRequestCallbackData>((resolve, reject) => { | ||
const request = http.request(`http://localhost:${eventCallbackServerPort}/`, {}, response => { | ||
let eventContents = ''; | ||
|
||
response.on('error', err => { | ||
reject(err); | ||
}); | ||
|
||
response.on('data', (chunk: Buffer) => { | ||
const chunkString = chunk.toString('utf8'); | ||
chunkString.split('').forEach(char => { | ||
if (char === '\n') { | ||
const eventCallbackData: SentryRequestCallbackData = JSON.parse( | ||
Buffer.from(eventContents, 'base64').toString('utf8'), | ||
); | ||
const callbackResult = callback(eventCallbackData); | ||
if (typeof callbackResult !== 'boolean') { | ||
callbackResult.then( | ||
match => { | ||
if (match) { | ||
response.destroy(); | ||
resolve(eventCallbackData); | ||
} | ||
}, | ||
err => { | ||
throw err; | ||
}, | ||
); | ||
} else if (callbackResult) { | ||
response.destroy(); | ||
resolve(eventCallbackData); | ||
} | ||
eventContents = ''; | ||
} else { | ||
eventContents = eventContents.concat(char); | ||
} | ||
}); | ||
}); | ||
}); | ||
|
||
request.end(); | ||
}); | ||
} | ||
|
||
export function waitForEnvelopeItem( | ||
proxyServerName: string, | ||
callback: (envelopeItem: EnvelopeItem) => Promise<boolean> | boolean, | ||
): Promise<EnvelopeItem> { | ||
return new Promise((resolve, reject) => { | ||
waitForRequest(proxyServerName, async eventData => { | ||
const envelopeItems = eventData.envelope[1]; | ||
for (const envelopeItem of envelopeItems) { | ||
if (await callback(envelopeItem)) { | ||
resolve(envelopeItem); | ||
return true; | ||
} | ||
} | ||
return false; | ||
}).catch(reject); | ||
}); | ||
} | ||
|
||
export function waitForError( | ||
proxyServerName: string, | ||
callback: (transactionEvent: SerializedEvent) => Promise<boolean> | boolean, | ||
): Promise<SerializedEvent> { | ||
return new Promise((resolve, reject) => { | ||
waitForEnvelopeItem(proxyServerName, async envelopeItem => { | ||
const [envelopeItemHeader, envelopeItemBody] = envelopeItem; | ||
if (envelopeItemHeader.type === 'event' && (await callback(envelopeItemBody as SerializedEvent))) { | ||
resolve(envelopeItemBody as SerializedEvent); | ||
return true; | ||
} | ||
return false; | ||
}).catch(reject); | ||
}); | ||
} | ||
|
||
export function waitForTransaction( | ||
proxyServerName: string, | ||
callback: (transactionEvent: SerializedEvent) => Promise<boolean> | boolean, | ||
): Promise<SerializedEvent> { | ||
return new Promise((resolve, reject) => { | ||
waitForEnvelopeItem(proxyServerName, async envelopeItem => { | ||
const [envelopeItemHeader, envelopeItemBody] = envelopeItem; | ||
if (envelopeItemHeader.type === 'transaction' && (await callback(envelopeItemBody as SerializedEvent))) { | ||
resolve(envelopeItemBody as SerializedEvent); | ||
return true; | ||
} | ||
return false; | ||
}).catch(reject); | ||
}); | ||
} | ||
|
||
const TEMP_FILE_PREFIX = 'event-proxy-server-'; | ||
|
||
async function registerCallbackServerPort(serverName: string, port: string): Promise<void> { | ||
const tmpFilePath = path.join(os.tmpdir(), `${TEMP_FILE_PREFIX}${serverName}`); | ||
await writeFile(tmpFilePath, port, { encoding: 'utf8' }); | ||
} | ||
|
||
function retrieveCallbackServerPort(serverName: string): Promise<string> { | ||
const tmpFilePath = path.join(os.tmpdir(), `${TEMP_FILE_PREFIX}${serverName}`); | ||
return readFile(tmpFilePath, 'utf8'); | ||
} |
This file contains 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,13 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="UTF-8"> | ||
<link rel="icon" href="/favicon.ico"> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
<title>Vite App</title> | ||
</head> | ||
<body> | ||
<div id="app"></div> | ||
<script type="module" src="/src/main.ts"></script> | ||
</body> | ||
</html> |
42 changes: 42 additions & 0 deletions
42
dev-packages/e2e-tests/test-applications/vue-3/package.json
This file contains 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,42 @@ | ||
{ | ||
"name": "vue-3-tmp", | ||
"version": "0.0.0", | ||
"private": true, | ||
"type": "module", | ||
"scripts": { | ||
"clean": "npx rimraf node_modules,pnpm-lock.yaml,dist", | ||
"dev": "vite", | ||
"build": "run-p type-check \"build-only {@}\" --", | ||
"preview": "vite preview", | ||
"build-only": "vite build", | ||
"type-check": "vue-tsc --build --force", | ||
"test": "playwright test", | ||
"test:build": "pnpm install && npx playwright install && pnpm build", | ||
"test:assert": "playwright test" | ||
}, | ||
"dependencies": { | ||
"@sentry/vue": "latest || *", | ||
"vue": "^3.4.15", | ||
"vue-router": "^4.2.5" | ||
}, | ||
"devDependencies": { | ||
"@playwright/test": "^1.41.1", | ||
"@sentry/types": "^7.99.0", | ||
"@sentry/utils": "^7.99.0", | ||
"@tsconfig/node20": "^20.1.2", | ||
"@types/node": "^20.11.10", | ||
"@vitejs/plugin-vue": "^5.0.3", | ||
"@vitejs/plugin-vue-jsx": "^3.1.0", | ||
"@vue/tsconfig": "^0.5.1", | ||
"http-server": "^14.1.1", | ||
"npm-run-all2": "^6.1.1", | ||
"ts-node": "10.9.1", | ||
"typescript": "~5.3.0", | ||
"vite": "^5.0.11", | ||
"vue-tsc": "^1.8.27", | ||
"wait-port": "1.0.4" | ||
}, | ||
"volta": { | ||
"extends": "../../package.json" | ||
} | ||
} |
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.
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.
had some biome errors for ember files. decided to ignore these for now