Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
feat: page.requests() (#37490)
Dmitry Gozman78977d88a446
diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.mdindex 541aebce3c..2a17c0b1ce 100644--- a/docs/src/api/class-page.md+++ b/docs/src/api/class-page.md@@ -3137,6 +3137,13 @@ return value resolves to `[]`.* since: v1.9+## async method: Page.requests+* since: v1.56+- returns: <[Array]<[Request]>>++Returns up to 100 last network request from this page. See [`event: Page.request`] for more details.++## async method: Page.addLocatorHandler* since: v1.42diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 867dfd391c..32c68fbc77 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -3926,6 +3926,12 @@ export interface Page {*/requestGC(): Promise<void>;+ /**+ * Returns up to 100 last network request from this page. See+ * [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request) for more details.+ */+ requests(): Promise<Array<Request>>;+/*** Routing provides the capability to modify network requests that are made by a page.*diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.tsindex d838311f14..61394f9979 100644--- a/packages/playwright-core/src/client/page.ts+++ b/packages/playwright-core/src/client/page.ts@@ -29,7 +29,7 @@ import { Frame, verifyLoadState } from './frame';import { HarRouter } from './harRouter';import { Keyboard, Mouse, Touchscreen } from './input';import { JSHandle, assertMaxArguments, parseResult, serializeArgument } from './jsHandle';-import { Response, Route, RouteHandler, WebSocket, WebSocketRoute, WebSocketRouteHandler, validateHeaders } from './network';+import { Request, Response, Route, RouteHandler, WebSocket, WebSocketRoute, WebSocketRouteHandler, validateHeaders } from './network';import { Video } from './video';import { Waiter } from './waiter';import { Worker } from './worker';@@ -48,7 +48,7 @@ import type { Clock } from './clock';import type { APIRequestContext } from './fetch';import type { WaitForNavigationOptions } from './frame';import type { FrameLocator, Locator, LocatorOptions } from './locator';-import type { Request, RouteHandlerCallback, WebSocketRouteHandlerCallback } from './network';+import type { RouteHandlerCallback, WebSocketRouteHandlerCallback } from './network';import type { FilePayload, Headers, LifecycleEvent, SelectOption, SelectOptionOptions, Size, TimeoutOptions, WaitForEventOptions, WaitForFunctionOptions } from './types';import type * as structs from '../../types/structs';import type * as api from '../../types/types';@@ -804,6 +804,11 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Pagereturn await this._mainFrame.waitForFunction(pageFunction, arg, options);}+ async requests() {+ const { requests } = await this._channel.requests();+ return requests.map(request => Request.from(request));+ }+workers(): Worker[] {return [...this._workers];}diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex f5cb173a42..f68ee39bc4 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -1481,6 +1481,10 @@ scheme.PagePdfParams = tObject({scheme.PagePdfResult = tObject({pdf: tBinary,});+scheme.PageRequestsParams = tOptional(tObject({}));+scheme.PageRequestsResult = tObject({+ requests: tArray(tChannel(['Request'])),+});scheme.PageSnapshotForAIParams = tObject({timeout: tFloat,});diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.tsindex 1866e05a21..e9b36e61c6 100644--- a/packages/playwright-core/src/server/browserContext.ts+++ b/packages/playwright-core/src/server/browserContext.ts@@ -62,6 +62,7 @@ export abstract class BrowserContext extends SdkObject {RequestAborted: 'requestaborted',RequestFulfilled: 'requestfulfilled',RequestContinued: 'requestcontinued',+ RequestCollected: 'requestcollected',BeforeClose: 'beforeclose',VideoStarted: 'videostarted',RecorderEvent: 'recorderevent',diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.tsindex 8208655bc2..f06787b812 100644--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts@@ -154,6 +154,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelif (!redirectFromDispatcher && !this._shouldDispatchNetworkEvent(request, 'request') && !request.isNavigationRequest())return;const requestDispatcher = RequestDispatcher.from(this, request);+ requestDispatcher.reportedThroughEvent = true;this._dispatchEvent('request', {request: requestDispatcher,page: PageDispatcher.fromNullable(this, request.frame()?._page.initializedOrUndefined())@@ -190,6 +191,11 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelpage: PageDispatcher.fromNullable(this, request.frame()?._page.initializedOrUndefined()),});});+ this.addObjectListener(BrowserContext.Events.RequestCollected, (request: Request) => {+ const requestDispatcher = this.connection.existingDispatcher<RequestDispatcher>(request);+ if (requestDispatcher && !requestDispatcher.reportedThroughEvent)+ requestDispatcher._dispose('gc');+ });this.addObjectListener(BrowserContext.Events.RecorderEvent, ({ event, data, page, code }: { event: 'actionAdded' | 'actionUpdated' | 'signalAdded', data: any, page: Page, code: string }) => {this._dispatchEvent('recorderEvent', { event, data, code, page: PageDispatcher.from(this, page) });});diff --git a/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts b/packages/playwright-core/src/server/dispatchers/networkDispatchers.tsindex 1e406f15a0..671f2996ed 100644--- a/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts+++ b/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts@@ -32,6 +32,7 @@ import type { Progress } from '@protocol/progress';export class RequestDispatcher extends Dispatcher<Request, channels.RequestChannel, BrowserContextDispatcher | PageDispatcher | FrameDispatcher> implements channels.RequestChannel {_type_Request: boolean;private _browserContextDispatcher: BrowserContextDispatcher;+ reportedThroughEvent = false;static from(scope: BrowserContextDispatcher, request: Request): RequestDispatcher {const result = scope.connection.existingDispatcher<RequestDispatcher>(request);@@ -48,9 +49,9 @@ export class RequestDispatcher extends Dispatcher<Request, channels.RequestChannconst frame = request.frame();const page = request.frame()?._page;const pageDispatcher = page ? scope.connection.existingDispatcher<PageDispatcher>(page) : null;- const frameDispatcher = frame ? FrameDispatcher.from(scope, frame) : null;+ const frameDispatcher = FrameDispatcher.fromNullable(scope, frame);super(pageDispatcher || frameDispatcher || scope, request, 'Request', {- frame: FrameDispatcher.fromNullable(scope, request.frame()),+ frame: frameDispatcher,serviceWorker: WorkerDispatcher.fromNullable(scope, request.serviceWorker()),url: request.url(),resourceType: request.resourceType(),diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.tsindex f975bad360..b1585017b5 100644--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts@@ -339,6 +339,10 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Browsreturn { pdf: buffer };}+ async requests(params: channels.PageRequestsParams, progress: Progress): Promise<channels.PageRequestsResult> {+ return { requests: this._page.networkRequests().map(request => RequestDispatcher.from(this.parentScope(), request)) };+ }+async snapshotForAI(params: channels.PageSnapshotForAIParams, progress: Progress): Promise<channels.PageSnapshotForAIResult> {return { snapshot: await this._page.snapshotForAI(progress) };}diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex 4fd2e7368b..c705cef563 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -302,6 +302,7 @@ export class FrameManager {route?.abort('aborted').catch(() => {});return;}+ this._page.addNetworkRequest(request);this._page.emitOnContext(BrowserContext.Events.Request, request);if (route)new network.Route(request, route).handle([...this._page.requestInterceptors, ...this._page.browserContext.requestInterceptors]);diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.tsindex b36b062fe3..d17c0ce762 100644--- a/packages/playwright-core/src/server/page.ts+++ b/packages/playwright-core/src/server/page.ts@@ -166,6 +166,7 @@ export class Page extends SdkObject {private _locatorHandlers = new Map<number, { selector: string, noWaitAfter?: boolean, resolved?: ManualPromise<void> }>();private _lastLocatorHandlerUid = 0;private _locatorHandlerRunningCounter = 0;+ private _networkRequests: network.Request[] = [];// Aiming at 25 fps by default - each frame is 40ms, but we give some slack with 35ms.// When throttling for tracing, 200ms between frames, except for 10 frames around the action.@@ -350,6 +351,16 @@ export class Page extends SdkObject {return this._extraHTTPHeaders;}+ addNetworkRequest(request: network.Request) {+ this._networkRequests.push(request);+ for (const collected of ensureArrayLimit(this._networkRequests, 100))+ this.emitOnContext(BrowserContext.Events.RequestCollected, collected);+ }++ networkRequests() {+ return this._networkRequests;+ }+async onBindingCalled(payload: string, context: dom.FrameExecutionContext) {if (this._closedState === 'closed')return;@@ -1078,7 +1089,8 @@ async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, framereturn result;}-function ensureArrayLimit(array: any[], limit: number) {+function ensureArrayLimit<T>(array: T[], limit: number): T[] {if (array.length > limit)- array.splice(0, limit / 10);+ return array.splice(0, limit / 10);+ return [];}diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.tsindex 76f231b300..5e4ede100e 100644--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts@@ -131,6 +131,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri['Page.accessibilitySnapshot', { title: 'Accessibility snapshot', group: 'getter', }],['Page.pageErrors', { title: 'Get page errors', group: 'getter', }],['Page.pdf', { title: 'PDF', }],+ ['Page.requests', { title: 'Get network requests', group: 'getter', }],['Page.snapshotForAI', { internal: true, }],['Page.startJSCoverage', { title: 'Start JS coverage', group: 'configuration', }],['Page.stopJSCoverage', { title: 'Stop JS coverage', group: 'configuration', }],diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 867dfd391c..32c68fbc77 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -3926,6 +3926,12 @@ export interface Page {*/requestGC(): Promise<void>;+ /**+ * Returns up to 100 last network request from this page. See+ * [page.on('request')](https://playwright.dev/docs/api/class-page#page-event-request) for more details.+ */+ requests(): Promise<Array<Request>>;+/*** Routing provides the capability to modify network requests that are made by a page.*diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex fe346de7f1..e772163e13 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -2121,6 +2121,7 @@ export interface PageChannel extends PageEventTarget, EventTargetChannel {accessibilitySnapshot(params: PageAccessibilitySnapshotParams, progress?: Progress): Promise<PageAccessibilitySnapshotResult>;pageErrors(params?: PagePageErrorsParams, progress?: Progress): Promise<PagePageErrorsResult>;pdf(params: PagePdfParams, progress?: Progress): Promise<PagePdfResult>;+ requests(params?: PageRequestsParams, progress?: Progress): Promise<PageRequestsResult>;snapshotForAI(params: PageSnapshotForAIParams, progress?: Progress): Promise<PageSnapshotForAIResult>;startJSCoverage(params: PageStartJSCoverageParams, progress?: Progress): Promise<PageStartJSCoverageResult>;stopJSCoverage(params?: PageStopJSCoverageParams, progress?: Progress): Promise<PageStopJSCoverageResult>;@@ -2569,6 +2570,11 @@ export type PagePdfOptions = {export type PagePdfResult = {pdf: Binary,};+export type PageRequestsParams = {};+export type PageRequestsOptions = {};+export type PageRequestsResult = {+ requests: RequestChannel[],+};export type PageSnapshotForAIParams = {timeout: number,};diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex ef04a9d3a8..b7658a2013 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -1998,6 +1998,14 @@ Page:returns:pdf: binary+ requests:+ title: Get network requests+ group: getter+ returns:+ requests:+ type: array+ items: Request+snapshotForAI:internal: trueparameters:diff --git a/tests/page/page-event-request.spec.ts b/tests/page/page-event-request.spec.tsindex 028ddcca54..4bf4df5410 100644--- a/tests/page/page-event-request.spec.ts+++ b/tests/page/page-event-request.spec.ts@@ -376,3 +376,45 @@ it('should not expose preflight OPTIONS request with network interception', {`POST ${server.CROSS_PROCESS_PREFIX}/cors`,]);});++it('should return last requests', async ({ page, server }) => {+ await page.goto(server.PREFIX + '/title.html');+ for (let i = 0; i < 200; ++i)+ server.setRoute('/fetch?' + i, (req, res) => res.end('url:' + server.PREFIX + req.url));++ // #0 is the navigation request, so start with #1.+ for (let i = 1; i < 50; ++i)+ await page.evaluate(url => fetch(url), server.PREFIX + '/fetch?' + i);+ const first50Requests = await page.requests();+ const firstReponse = await first50Requests[1].response();+ expect(await firstReponse.text()).toBe('url:' + server.PREFIX + '/fetch?1');++ page.on('request', () => {});+ for (let i = 50; i < 100; ++i)+ await page.evaluate(url => fetch(url), server.PREFIX + '/fetch?' + i);+ const first100Requests = await page.requests();++ for (let i = 100; i < 200; ++i)+ await page.evaluate(url => fetch(url), server.PREFIX + '/fetch?' + i);+ const last100Requests = await page.requests();++ // Last 100 requests are fully functional.+ const received = await Promise.all(last100Requests.map(async request => {+ const response = await request.response();+ return { text: await response.text(), url: request.url() };+ }));+ const expected = [];+ for (let i = 100; i < 200; ++i) {+ const url = server.PREFIX + '/fetch?' + i;+ expected.push({ url, text: 'url:' + url });+ }+ expect(received).toEqual(expected);++ // First 50 requests were collected.+ const error = await first50Requests[1].response().catch(e => e);+ expect(error.message).toContain('request.response: The object has been collected to prevent unbounded heap growth.');++ // Second 50 requests are functional, because they were reported through the event and not collected.+ const reponse50 = await first100Requests[50].response();+ expect(await reponse50.text()).toBe('url:' + server.PREFIX + '/fetch?50');+});diff --git a/tests/stress/heap.spec.ts b/tests/stress/heap.spec.tsindex d07edddab7..d3d6f41a1d 100644--- a/tests/stress/heap.spec.ts+++ b/tests/stress/heap.spec.ts@@ -81,6 +81,18 @@ test('should not leak dispatchers after closing page', async ({ context, serverexpect(await queryObjectCount(require('../../packages/playwright-core/lib/client/network').Response)).toBe(0);});+test('should not leak requests over 100', async ({ context, server }) => {+ const page = await context.newPage();+ await page.goto(server.PREFIX + '/title.html');+ for (let i = 0; i < 100; ++i)+ await page.evaluate(url => fetch(url), server.EMPTY_PAGE);+ await page.requests();+ for (let i = 0; i < 200; ++i)+ await page.evaluate(url => fetch(url), server.EMPTY_PAGE);+ await page.requests();+ expect(await queryObjectCount(require('../../packages/playwright-core/lib/server/dispatchers/networkDispatchers').RequestDispatcher)).toBeLessThanOrEqual(100);+});+test.describe(() => {test.beforeEach(() => {require('../../packages/playwright-core/lib/server/dispatchers/dispatcher').setMaxDispatchersForTest(100);