Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: address some of the 1.56 api review feedback (#37542)

Dmitry Gozmanced088c1f899
diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md
index 2a17c0b1ce..82965993c3 100644
--- a/docs/src/api/class-page.md
+++ b/docs/src/api/class-page.md
@@ -2682,14 +2682,14 @@ Returns whether the element is [visible](../actionability.md#visible). [`param:
* since: v1.56
- returns: <[Array]<[ConsoleMessage]>>
-Returns up to 200 last console messages from this page. See [`event: Page.console`] for more details.
+Returns up to (currently) 200 last console messages from this page. See [`event: Page.console`] for more details.
## async method: Page.pageErrors
* since: v1.56
- returns: <[Array]<[Error]>>
-Returns up to 200 last page errors from this page. See [`event: Page.pageError`] for more details.
+Returns up to (currently) 200 last page errors from this page. See [`event: Page.pageError`] for more details.
## method: Page.locator
@@ -3141,7 +3141,11 @@ return value resolves to `[]`.
* since: v1.56
- returns: <[Array]<[Request]>>
-Returns up to 100 last network request from this page. See [`event: Page.request`] for more details.
+Returns up to (currently) 100 last network request from this page. See [`event: Page.request`] for more details.
+
+Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory growth as new requests come in. Once collected, retrieving most information about the request is impossible.
+
+Note that requests reported through the [`event: Page.request`] request are not collected, so there is a trade off between efficient memory usage with [`method: Page.requests`] and the amount of available information reported through [`event: Page.request`].
## async method: Page.addLocatorHandler
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index 86cd33384e..a7aa4d7d6f 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -2285,7 +2285,7 @@ export interface Page {
}): Promise<void>;
/**
- * Returns up to 200 last console messages from this page. See
+ * Returns up to (currently) 200 last console messages from this page. See
* [page.on('console')](https://playwright.dev/docs/api/class-page#page-event-console) for more details.
*/
consoleMessages(): Promise<Array<ConsoleMessage>>;
@@ -3605,7 +3605,7 @@ export interface Page {
opener(): Promise<null|Page>;
/**
- * Returns up to 200 last page errors from this page. See
+ * Returns up to (currently) 200 last page errors from this page. See
* [page.on('pageerror')](https://playwright.dev/docs/api/class-page#page-event-page-error) for more details.
*/
pageErrors(): Promise<Array<Error>>;
@@ -3927,8 +3927,17 @@ export interface Page {
requestGC(): Promise<void>;
/**
- * Returns up to 100 last network request from this page. See
+ * Returns up to (currently) 100 last network request from this page. See
* [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request) for more details.
+ *
+ * Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory
+ * growth as new requests come in. Once collected, retrieving most information about the request is impossible.
+ *
+ * Note that requests reported through the
+ * [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request) request are not collected, so
+ * there is a trade off between efficient memory usage with
+ * [page.requests()](https://playwright.dev/docs/api/class-page#page-requests) and the amount of available information
+ * reported through [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request).
*/
requests(): Promise<Array<Request>>;
diff --git a/packages/playwright-core/src/server/chromium/chromiumSwitches.ts b/packages/playwright-core/src/server/chromium/chromiumSwitches.ts
index 3a4550a271..5f2526c655 100644
--- a/packages/playwright-core/src/server/chromium/chromiumSwitches.ts
+++ b/packages/playwright-core/src/server/chromium/chromiumSwitches.ts
@@ -58,7 +58,7 @@ export const chromiumSwitches = (assistantMode?: boolean, channel?: string) => [
'--disable-dev-shm-usage',
'--disable-extensions',
'--disable-features=' + disabledFeatures(assistantMode).join(','),
- '--enable-features=CDPScreenshotNewSurface',
+ process.env.PLAYWRIGHT_LEGACY_SCREENSHOT ? '' : '--enable-features=CDPScreenshotNewSurface',
'--allow-pre-commit-input',
'--disable-hang-monitor',
'--disable-ipc-flooding-protection',
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index 86cd33384e..a7aa4d7d6f 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -2285,7 +2285,7 @@ export interface Page {
}): Promise<void>;
/**
- * Returns up to 200 last console messages from this page. See
+ * Returns up to (currently) 200 last console messages from this page. See
* [page.on('console')](https://playwright.dev/docs/api/class-page#page-event-console) for more details.
*/
consoleMessages(): Promise<Array<ConsoleMessage>>;
@@ -3605,7 +3605,7 @@ export interface Page {
opener(): Promise<null|Page>;
/**
- * Returns up to 200 last page errors from this page. See
+ * Returns up to (currently) 200 last page errors from this page. See
* [page.on('pageerror')](https://playwright.dev/docs/api/class-page#page-event-page-error) for more details.
*/
pageErrors(): Promise<Array<Error>>;
@@ -3927,8 +3927,17 @@ export interface Page {
requestGC(): Promise<void>;
/**
- * Returns up to 100 last network request from this page. See
+ * Returns up to (currently) 100 last network request from this page. See
* [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request) for more details.
+ *
+ * Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory
+ * growth as new requests come in. Once collected, retrieving most information about the request is impossible.
+ *
+ * Note that requests reported through the
+ * [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request) request are not collected, so
+ * there is a trade off between efficient memory usage with
+ * [page.requests()](https://playwright.dev/docs/api/class-page#page-requests) and the amount of available information
+ * reported through [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request).
*/
requests(): Promise<Array<Request>>;