-
Notifications
You must be signed in to change notification settings - Fork 886
test(site): improve E2E framework #9438
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
Show all changes
6 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 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
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,53 @@ | ||
import { Page } from "@playwright/test" | ||
|
||
export const beforeCoderTest = async (page: Page) => { | ||
// eslint-disable-next-line no-console -- Show everything that was printed with console.log() | ||
page.on("console", (msg) => console.log("[onConsole] " + msg.text())) | ||
|
||
page.on("request", (request) => { | ||
if (!isApiCall(request.url())) { | ||
return | ||
} | ||
|
||
// eslint-disable-next-line no-console -- Log HTTP requests for debugging purposes | ||
console.log( | ||
`[onRequest] method=${request.method()} url=${request.url()} postData=${ | ||
request.postData() ? request.postData() : "" | ||
}`, | ||
) | ||
}) | ||
page.on("response", async (response) => { | ||
if (!isApiCall(response.url())) { | ||
return | ||
} | ||
|
||
const shouldLogResponse = | ||
!response.url().endsWith("/api/v2/deployment/config") && | ||
!response.url().endsWith("/api/v2/debug/health") | ||
|
||
let responseText = "" | ||
try { | ||
if (shouldLogResponse) { | ||
const buffer = await response.body() | ||
responseText = buffer.toString("utf-8") | ||
responseText = responseText.replace(/\n$/g, "") | ||
} else { | ||
responseText = "skipped..." | ||
} | ||
} catch (error) { | ||
responseText = "not_available" | ||
} | ||
|
||
// eslint-disable-next-line no-console -- Log HTTP requests for debugging purposes | ||
console.log( | ||
`[onResponse] url=${response.url()} status=${response.status()} body=${responseText}`, | ||
) | ||
}) | ||
} | ||
|
||
const isApiCall = (urlString: string): boolean => { | ||
const url = new URL(urlString) | ||
const apiPath = "/api/v2" | ||
|
||
return url.pathname.startsWith(apiPath) | ||
} |
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
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,53 @@ | ||
import type { | ||
FullConfig, | ||
Suite, | ||
TestCase, | ||
TestResult, | ||
FullResult, | ||
Reporter, | ||
} from "@playwright/test/reporter" | ||
|
||
class CoderReporter implements Reporter { | ||
onBegin(config: FullConfig, suite: Suite) { | ||
// eslint-disable-next-line no-console -- Helpful for debugging | ||
console.log(`Starting the run with ${suite.allTests().length} tests`) | ||
} | ||
|
||
onTestBegin(test: TestCase) { | ||
// eslint-disable-next-line no-console -- Helpful for debugging | ||
console.log(`Starting test ${test.title}`) | ||
} | ||
|
||
onStdOut(chunk: string, test: TestCase, _: TestResult): void { | ||
// eslint-disable-next-line no-console -- Helpful for debugging | ||
console.log( | ||
`[stdout] [${test ? test.title : "unknown"}]: ${chunk.replace( | ||
/\n$/g, | ||
"", | ||
)}`, | ||
) | ||
} | ||
|
||
onStdErr(chunk: string, test: TestCase, _: TestResult): void { | ||
// eslint-disable-next-line no-console -- Helpful for debugging | ||
console.log( | ||
`[stderr] [${test ? test.title : "unknown"}]: ${chunk.replace( | ||
/\n$/g, | ||
"", | ||
)}`, | ||
) | ||
} | ||
|
||
onTestEnd(test: TestCase, result: TestResult) { | ||
// eslint-disable-next-line no-console -- Helpful for debugging | ||
console.log(`Finished test ${test.title}: ${result.status}`) | ||
} | ||
|
||
onEnd(result: FullResult) { | ||
// eslint-disable-next-line no-console -- Helpful for debugging | ||
console.log(`Finished the run: ${result.status}`) | ||
} | ||
} | ||
|
||
// eslint-disable-next-line no-unused-vars -- Playwright config uses it | ||
export default CoderReporter |
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
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
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
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
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
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
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
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
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.
Why are we setting workers to
1
?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.
If you delete this, playwright will run tests in parallel, and it may cause the Coder backend overloaded.
I want to reduce the amount of points that can break e2e tests. Additionally, our e2e tests are relatively quick, so if it isn't a problem I would disable parallelism for now.