yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: recommend localhost over 127.0.0.1 (#34918)

Browse Source
This commit is contained in:
Simon Knott 2025-02-25 15:40:38 +01:00 committed by GitHub
parent 9e38473309
commit a9bbf4b56d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/test-api/class-testconfig.md
View File

@ -680,7 +680,7 @@ import { defineConfig } from '@playwright/test';
export default defineConfig({ export default defineConfig({
webServer: { webServer: {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
timeout: 120 * 1000, timeout: 120 * 1000,
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
}, },
@ -709,19 +709,19 @@ export default defineConfig({
webServer: [ webServer: [
{ {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
timeout: 120 * 1000, timeout: 120 * 1000,
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
}, },
{ {
command: 'npm run backend', command: 'npm run backend',
url: 'http://127.0.0.1:3333', url: 'http://localhost:3333',
timeout: 120 * 1000, timeout: 120 * 1000,
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
} }
], ],
use: { use: {
baseURL: 'http://127.0.0.1:3000', baseURL: 'http://localhost:3000',
}, },
}); });
``` ```

4
docs/src/test-configuration-js.md
View File

@ -35,7 +35,7 @@ export default defineConfig({
use: { use: {
// Base URL to use in actions like `await page.goto('/')`. // Base URL to use in actions like `await page.goto('/')`.
baseURL: 'http://127.0.0.1:3000', baseURL: 'http://localhost:3000',
// Collect trace when retrying the failed test. // Collect trace when retrying the failed test.
trace: 'on-first-retry', trace: 'on-first-retry',
@ -50,7 +50,7 @@ export default defineConfig({
// Run your local dev server before starting the tests. // Run your local dev server before starting the tests.
webServer: { webServer: {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
}, },
}); });

2
docs/src/test-use-options-js.md
View File

@ -17,7 +17,7 @@ import { defineConfig } from '@playwright/test';
export default defineConfig({ export default defineConfig({
use: { use: {
// Base URL to use in actions like `await page.goto('/')`. // Base URL to use in actions like `await page.goto('/')`.
baseURL: 'http://127.0.0.1:3000', baseURL: 'http://localhost:3000',
// Populates context with given storage state. // Populates context with given storage state.
storageState: 'state.json', storageState: 'state.json',

18
docs/src/test-webserver-js.md
View File

@ -18,7 +18,7 @@ export default defineConfig({
// Run your local dev server before starting the tests // Run your local dev server before starting the tests
webServer: { webServer: {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
stdout: 'ignore', stdout: 'ignore',
stderr: 'pipe', stderr: 'pipe',
@ -52,7 +52,7 @@ export default defineConfig({
// Run your local dev server before starting the tests // Run your local dev server before starting the tests
webServer: { webServer: {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
timeout: 120 * 1000, timeout: 120 * 1000,
}, },
@ -63,7 +63,7 @@ export default defineConfig({
It is also recommended to specify the `baseURL` in the `use: {}` section of your config, so that tests can use relative urls and you don't have to specify the full URL over and over again. It is also recommended to specify the `baseURL` in the `use: {}` section of your config, so that tests can use relative urls and you don't have to specify the full URL over and over again.
When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL. For Example, by setting the baseURL to `http://127.0.0.1:3000` and navigating to `/login` in your tests, Playwright will run the test using `http://127.0.0.1:3000/login`. When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitForURL`], [`method: Page.waitForRequest`], or [`method: Page.waitForResponse`] it takes the base URL in consideration by using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL. For Example, by setting the baseURL to `http://localhost:3000` and navigating to `/login` in your tests, Playwright will run the test using `http://localhost:3000/login`.
```js title="playwright.config.ts" ```js title="playwright.config.ts"
import { defineConfig } from '@playwright/test'; import { defineConfig } from '@playwright/test';
@ -74,11 +74,11 @@ export default defineConfig({
// Run your local dev server before starting the tests // Run your local dev server before starting the tests
webServer: { webServer: {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
}, },
use: { use: {
baseURL: 'http://127.0.0.1:3000', baseURL: 'http://localhost:3000',
}, },
}); });
``` ```
@ -89,7 +89,7 @@ Now you can use a relative path when navigating the page:
import { test } from '@playwright/test'; import { test } from '@playwright/test';
test('test', async ({ page }) => { test('test', async ({ page }) => {
// This will navigate to http://127.0.0.1:3000/login // This will navigate to http://localhost:3000/login
await page.goto('./login'); await page.goto('./login');
}); });
``` ```
@ -106,19 +106,19 @@ export default defineConfig({
webServer: [ webServer: [
{ {
command: 'npm run start', command: 'npm run start',
url: 'http://127.0.0.1:3000', url: 'http://localhost:3000',
timeout: 120 * 1000, timeout: 120 * 1000,
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
}, },
{ {
command: 'npm run backend', command: 'npm run backend',
url: 'http://127.0.0.1:3333', url: 'http://localhost:3333',
timeout: 120 * 1000, timeout: 120 * 1000,
reuseExistingServer: !process.env.CI, reuseExistingServer: !process.env.CI,
} }
], ],
use: { use: {
baseURL: 'http://127.0.0.1:3000', baseURL: 'http://localhost:3000',
}, },
}); });
``` ```

8
packages/playwright/types/test.d.ts vendored
View File

@ -884,7 +884,7 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
* export default defineConfig({ * export default defineConfig({
* webServer: { * webServer: {
* command: 'npm run start', * command: 'npm run start',
* url: 'http://127.0.0.1:3000', * url: 'http://localhost:3000',
* timeout: 120 * 1000, * timeout: 120 * 1000,
* reuseExistingServer: !process.env.CI, * reuseExistingServer: !process.env.CI,
* }, * },
@ -915,19 +915,19 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
* webServer: [ * webServer: [
* { * {
* command: 'npm run start', * command: 'npm run start',
* url: 'http://127.0.0.1:3000', * url: 'http://localhost:3000',
* timeout: 120 * 1000, * timeout: 120 * 1000,
* reuseExistingServer: !process.env.CI, * reuseExistingServer: !process.env.CI,
* }, * },
* { * {
* command: 'npm run backend', * command: 'npm run backend',
* url: 'http://127.0.0.1:3333', * url: 'http://localhost:3333',
* timeout: 120 * 1000, * timeout: 120 * 1000,
* reuseExistingServer: !process.env.CI, * reuseExistingServer: !process.env.CI,
* } * }
* ], * ],
* use: { * use: {
* baseURL: 'http://127.0.0.1:3000', * baseURL: 'http://localhost:3000',
* }, * },
* }); * });
* ``` * ```