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
chore: normalize resource types (#38480)
Pavel Feldman73f6cf9a2101
diff --git a/packages/playwright-core/src/server/agent/context.ts b/packages/playwright-core/src/server/agent/context.tsindex 0a96a46c72..0e3526c57a 100644--- a/packages/playwright-core/src/server/agent/context.ts+++ b/packages/playwright-core/src/server/agent/context.ts@@ -58,6 +58,7 @@ export class Context {const disposeListeners = () => {this.page.browserContext.off(BrowserContext.Events.Request, requestListener);};+ this.page.browserContext.on(BrowserContext.Events.Request, requestListener);let result: R;try {@@ -69,17 +70,21 @@ export class Context {const requestedNavigation = requests.some(request => request.isNavigationRequest());if (requestedNavigation) {- await this.page.performActionPreChecks(this.progress);+ await this.page.mainFrame().waitForLoadState(this.progress, 'load');return result;}- const fiveSeconds = new Promise<void>(resolve => setTimeout(resolve, 1000));+ const promises: Promise<any>[] = [];for (const request of requests) {- if (request.failure())- continue;- const response = Promise.race([request.response(), fiveSeconds]);- await this.progress.race(response);+ if (['document', 'stylesheet', 'script', 'xhr', 'fetch'].includes(request.resourceType()))+ promises.push(request.response().then(r => r?.finished()));+ else+ promises.push(request.response());}+ await this.progress.race(promises, { timeout: 5000 });+ if (requests.length)+ await this.progress.wait(500);+return result;}diff --git a/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts b/packages/playwright-core/src/server/bidi/bidiNetworkManager.tsindex b6807e731d..8581808560 100644--- a/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts+++ b/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts@@ -361,7 +361,7 @@ function toBidiSameSite(sameSite?: 'Strict' | 'Lax' | 'None'): bidi.Network.Samereturn bidi.Network.SameSite.None;}-function resourceTypeFromBidi(requestDestination: string, requestInitiatorType: string | null, eventInitiatorType: string | undefined): string {+function resourceTypeFromBidi(requestDestination: string, requestInitiatorType: string | null, eventInitiatorType: string | undefined): network.ResourceType {switch (requestDestination) {case 'audio': return 'media';case 'audioworklet': return 'script';@@ -370,7 +370,7 @@ function resourceTypeFromBidi(requestDestination: string, requestInitiatorType:case 'frame': return 'document';case 'iframe': return 'document';case 'image': return 'image';- case 'object': return 'object';+ case 'object': return 'other';case 'paintworklet': return 'script';case 'script': return 'script';case 'serviceworker': return 'script';diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.tsindex 9edfd3a43f..060faa0a34 100644--- a/packages/playwright-core/src/server/browserContext.ts+++ b/packages/playwright-core/src/server/browserContext.ts@@ -405,7 +405,7 @@ export abstract class BrowserContext extends SdkObject {const pageOrError = await progress.race(page.waitForInitializedOrError());if (pageOrError instanceof Error)throw pageOrError;- await page.mainFrame()._waitForLoadState(progress, 'load');+ await page.mainFrame().waitForLoadState(progress, 'load');return page;}diff --git a/packages/playwright-core/src/server/chromium/crNetworkManager.ts b/packages/playwright-core/src/server/chromium/crNetworkManager.tsindex 27a4cba97f..9ded7210f1 100644--- a/packages/playwright-core/src/server/chromium/crNetworkManager.ts+++ b/packages/playwright-core/src/server/chromium/crNetworkManager.ts@@ -596,13 +596,12 @@ class InterceptableRequest {url,postDataEntries = null,} = requestPausedEvent ? requestPausedEvent.request : requestWillBeSentEvent.request;- const type = (requestWillBeSentEvent.type || '').toLowerCase();let postDataBuffer = null;const entries = postDataEntries?.filter(entry => entry.bytes);if (entries && entries.length)postDataBuffer = Buffer.concat(entries.map(entry => Buffer.from(entry.bytes!, 'base64')));- this.request = new network.Request(context, frame, serviceWorker, redirectedFrom?.request || null, documentId, url, type, method, postDataBuffer, headersOverride || headersObjectToArray(headers));+ this.request = new network.Request(context, frame, serviceWorker, redirectedFrom?.request || null, documentId, url, toResourceType(requestWillBeSentEvent.type || 'Other'), method, postDataBuffer, headersOverride || headersObjectToArray(headers));}}@@ -837,3 +836,42 @@ class ResponseExtraInfoTracker {this._requests.delete(requestId);}}++function toResourceType(type: Protocol.Network.ResourceType): network.ResourceType {+ switch (type) {+ case 'Document':+ return 'document';+ case 'Stylesheet':+ return 'stylesheet';+ case 'Image':+ return 'image';+ case 'Media':+ return 'media';+ case 'Font':+ return 'font';+ case 'Script':+ return 'script';+ case 'TextTrack':+ return 'texttrack';+ case 'XHR':+ return 'xhr';+ case 'Fetch':+ return 'fetch';+ case 'EventSource':+ return 'eventsource';+ case 'WebSocket':+ return 'websocket';+ case 'Manifest':+ return 'manifest';+ case 'Ping':+ return 'ping';+ case 'CSPViolationReport':+ return 'cspreport';+ case 'Prefetch':+ case 'SignedExchange':+ case 'Preflight':+ case 'FedCM':+ default:+ return 'other';+ }+}diff --git a/packages/playwright-core/src/server/firefox/ffNetworkManager.ts b/packages/playwright-core/src/server/firefox/ffNetworkManager.tsindex 50bb3017a3..bebe6670dd 100644--- a/packages/playwright-core/src/server/firefox/ffNetworkManager.ts+++ b/packages/playwright-core/src/server/firefox/ffNetworkManager.ts@@ -165,7 +165,7 @@ export class FFNetworkManager {}}-const causeToResourceType: {[key: string]: string} = {+const causeToResourceType: {[key: string]: network.ResourceType} = {TYPE_INVALID: 'other',TYPE_OTHER: 'other',TYPE_SCRIPT: 'script',@@ -183,15 +183,15 @@ const causeToResourceType: {[key: string]: string} = {TYPE_FONT: 'font',TYPE_MEDIA: 'media',TYPE_WEBSOCKET: 'websocket',- TYPE_CSP_REPORT: 'other',+ TYPE_CSP_REPORT: 'cspreport',TYPE_XSLT: 'other',- TYPE_BEACON: 'other',+ TYPE_BEACON: 'beacon',TYPE_FETCH: 'fetch',TYPE_IMAGESET: 'image',TYPE_WEB_MANIFEST: 'manifest',};-const internalCauseToResourceType: {[key: string]: string} = {+const internalCauseToResourceType: {[key: string]: network.ResourceType} = {TYPE_INTERNAL_EVENTSOURCE: 'eventsource',};diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex 7fc9dd0527..22e53e750b 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -704,7 +704,7 @@ export class Frame extends SdkObject {return request ? progress.race(request._finalRequest().response()) : null;}- async _waitForLoadState(progress: Progress, state: types.LifecycleEvent): Promise<void> {+ async waitForLoadState(progress: Progress, state: types.LifecycleEvent): Promise<void> {const waitUntil = verifyLifecycle('state', state);if (!this._firedLifecycleEvents.has(waitUntil))await helper.waitForEvent(progress, this, Frame.Events.AddLifecycle, (e: types.LifecycleEvent) => e === waitUntil).promise;@@ -890,7 +890,7 @@ export class Frame extends SdkObject {this._onClearLifecycle();tagPromise.resolve();});- const lifecyclePromise = progress.race(tagPromise).then(() => this._waitForLoadState(progress, waitUntil));+ const lifecyclePromise = progress.race(tagPromise).then(() => this.waitForLoadState(progress, waitUntil));const contentPromise = progress.race(context.evaluate(({ html, tag }) => {document.open();console.debug(tag); // eslint-disable-line no-consolediff --git a/packages/playwright-core/src/server/network.ts b/packages/playwright-core/src/server/network.tsindex f9ad37aa6c..e004f4353f 100644--- a/packages/playwright-core/src/server/network.ts+++ b/packages/playwright-core/src/server/network.ts@@ -94,6 +94,24 @@ export function stripFragmentFromUrl(url: string): string {return url.substring(0, url.indexOf('#'));}+export type ResourceType = 'document'+| 'stylesheet'+| 'image'+| 'media'+| 'font'+| 'script'+| 'fetch'+| 'xhr'+| 'websocket'+| 'eventsource'+| 'manifest'+| 'texttrack'+| 'beacon'+| 'ping'+| 'cspreport'+// 'prefetch', 'signedexchange', 'preflight', 'fedcm'+| 'other';+export class Request extends SdkObject {private _response: Response | null = null;private _redirectedFrom: Request | null;@@ -102,7 +120,7 @@ export class Request extends SdkObject {readonly _isFavicon: boolean;_failureText: string | null = null;private _url: string;- private _resourceType: string;+ private _resourceType: ResourceType;private _method: string;private _postData: Buffer | null;readonly _headers: HeadersArray;@@ -122,7 +140,7 @@ export class Request extends SdkObject {};constructor(context: contexts.BrowserContext, frame: frames.Frame | null, serviceWorker: pages.Worker | null, redirectedFrom: Request | null, documentId: string | undefined,- url: string, resourceType: string, method: string, postData: Buffer | null, headers: HeadersArray) {+ url: string, resourceType: ResourceType, method: string, postData: Buffer | null, headers: HeadersArray) {super(frame || context, 'request');assert(!url.startsWith('data:'), 'Data urls should not fire requests');this._context = context;@@ -165,7 +183,7 @@ export class Request extends SdkObject {return this._overrides?.url || this._url;}- resourceType(): string {+ resourceType(): ResourceType {return this._resourceType;}@@ -431,7 +449,7 @@ export type SecurityDetails = {export class Response extends SdkObject {private _request: Request;private _contentPromise: Promise<Buffer> | null = null;- _finishedPromise = new ManualPromise<void>();+ private _finishedPromise = new ManualPromise<void>();private _status: number;private _statusText: string;private _url: string;@@ -557,6 +575,10 @@ export class Response extends SdkObject {return this._request;}+ finished(): Promise<void> {+ return this._finishedPromise;+ }+frame(): frames.Frame | null {return this._request.frame();}diff --git a/packages/playwright-core/src/server/progress.ts b/packages/playwright-core/src/server/progress.tsindex 5e9ef3db00..56b10b865b 100644--- a/packages/playwright-core/src/server/progress.ts+++ b/packages/playwright-core/src/server/progress.ts@@ -58,9 +58,10 @@ export class ProgressController {this._onCallLog?.(message);},metadata: this.metadata,- race: <T>(promise: Promise<T> | Promise<T>[]) => {+ race: <T>(promise: Promise<T> | Promise<T>[], options?: { timeout?: number }) => {const promises = Array.isArray(promise) ? promise : [promise];- return Promise.race([...promises, this._forceAbortPromise]);+ const timerPromise = options?.timeout ? new Promise<void>(f => setTimeout(f, options.timeout)) : null;+ return Promise.race([...promises, ...(timerPromise ? [timerPromise] : []), this._forceAbortPromise]);},wait: async (timeout: number) => {let timer: NodeJS.Timeout;diff --git a/packages/playwright-core/src/server/webkit/wkInterceptableRequest.ts b/packages/playwright-core/src/server/webkit/wkInterceptableRequest.tsindex e4cd9a78f0..180348fda1 100644--- a/packages/playwright-core/src/server/webkit/wkInterceptableRequest.ts+++ b/packages/playwright-core/src/server/webkit/wkInterceptableRequest.ts@@ -51,7 +51,7 @@ export class WKInterceptableRequest {constructor(session: WKSession, frame: frames.Frame, event: Protocol.Network.requestWillBeSentPayload, redirectedFrom: WKInterceptableRequest | null, documentId: string | undefined) {this._session = session;this._requestId = event.requestId;- const resourceType = event.type ? event.type.toLowerCase() : (redirectedFrom ? redirectedFrom.request.resourceType() : 'other');+ const resourceType = event.type ? toResourceType(event.type) : (redirectedFrom ? redirectedFrom.request.resourceType() : 'other');let postDataBuffer = null;this._timestamp = event.timestamp;this._wallTime = event.walltime * 1000;@@ -169,3 +169,20 @@ function wkMillisToRoundishMillis(value: number): number {return ((value * 1000) | 0) / 1000;}++function toResourceType(type: Protocol.Page.ResourceType): network.ResourceType {+ switch (type) {+ case 'Document': return 'document';+ case 'StyleSheet': return 'stylesheet';+ case 'Image': return 'image';+ case 'Font': return 'font';+ case 'Script': return 'script';+ case 'XHR': return 'xhr';+ case 'Fetch': return 'fetch';+ case 'Ping': return 'ping';+ case 'Beacon': return 'beacon';+ case 'WebSocket': return 'websocket';+ case 'EventSource': return 'eventsource';+ default: return 'other';+ }+}diff --git a/packages/protocol/src/progress.d.ts b/packages/protocol/src/progress.d.tsindex 6e8001629b..7f1734627b 100644--- a/packages/protocol/src/progress.d.ts+++ b/packages/protocol/src/progress.d.ts@@ -36,7 +36,7 @@ import type { CallMetadata } from './callMetadata';// For the trickiest cases, look at `raceUncancellableOperationWithCleanup()` helper method.export interface Progress {log(message: string): void;- race<T>(promise: Promise<T> | Promise<T>[]): Promise<T>;+ race<T>(promise: Promise<T> | Promise<T>[], options?: { timeout?: number }): Promise<T>;wait(timeout: number): Promise<void>;metadata: CallMetadata;}