rsnext/test
Jiachi Liu 00ca8df26c
test: add inline flight response reuse test (#34364)
To collect the requests starting from page load, we need to register event listeners before page loading (`page.goto` API invocation). By default webdriver will wait for hydration, so we need to register events inside `browser.loadPage` to ensure we can collect the requests before hydration is done.

### Changes
* Add `beforePageLoad` for next webdriver
* registry page `'request'` event before loading page
* update related tests for agruments change

### Usage

```js
browser = await webdriver(appPort, '/path', {
   waitHydration, // default true
   retryWaitHydration, // default false
   disableCache, // default false
   beforePageLoad, // default undefined
})

```
2022-02-15 18:53:45 +00:00
..
.stats-app Remove extra config for PR stats (#30478) 2021-10-27 14:30:39 -05:00
development Chore/stable swc compiler options (#34074) 2022-02-10 01:54:28 +00:00
e2e Ensure invalid request to static page is handled correctly (#34346) 2022-02-15 11:28:18 -06:00
integration test: add inline flight response reuse test (#34364) 2022-02-15 18:53:45 +00:00
lib test: add inline flight response reuse test (#34364) 2022-02-15 18:53:45 +00:00
production Enable dynamic HTML in minimal mode (#34222) 2022-02-11 17:43:39 +00:00
unit Babel & next-swc: Fix exporting page config with AsExpression (#32702) 2022-02-05 21:15:49 +00:00
.gitignore Universal Webpack (#3578) 2018-01-30 16:44:44 +01:00
jest-setup-after-env.ts Update azure config (#33999) 2022-02-04 13:42:22 -06:00
readme.md [docs] Fix 404 link for testing example. (#33407) 2022-01-17 19:08:52 +00:00
test-file.txt Add additional file serving tests (#12479) 2020-05-04 11:58:19 -05:00

Writing tests for Next.js

Getting Started

You can set-up a new test using yarn new-test which will start from a template related to the test type.

Test Types in Next.js

  • e2e: These tests will run against next dev and next start
  • development: These tests only run against next dev
  • production: These tests will run against next start.
  • integration: These tests run misc checks and modes and is where tests used to be added before we added more specific folders. Ideally we don't add new test suites here as tests here are not isolated from the monorepo.
  • unit: These are very fast tests that should run without a browser or running next and should be testing a specific utility.

For the e2e, production, and development tests the createNext utility should be used and an example is available here. This creates an isolated Next.js install to ensure nothing in the monorepo is relied on accidentally causing incorrect tests.

All new test suites should be written in TypeScript either .ts (or .tsx for unit tests). This will help ensure we catch smaller issues in tests that could cause flakey or incorrect tests.

If a test suite already exists that relates closely to the item being tested (e.g. hash navigation relates to existing navigation test suites) the new checks can be added in the existing test suite.

Best Practices

  • When checking for a condition that might take time, ensure it is waited for either using the browser waitForElement or using the check util in next-test-utils.
  • When applying a fix, ensure the test fails without the fix. This makes sure the test will properly catch regressions.