Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(fetch): expose timings by Skn0tt · Pull Request #32647 · microsoft/playwright · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/api/class-apiresponse.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,3 +110,26 @@ Returns the text representation of response body.
- returns: <[string]>

Contains the URL of the response.

## method: APIResponse.timing
* since: v1.48
- returns: <[Object]>
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the client starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the client ends the domain name lookup for the resource.
The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `secureConnectionStart` <[float]> Time immediately before the client starts the handshake process to secure the
current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectEnd` <[float]> Time immediately before the client starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `requestStart` <[float]> Time immediately before the client starts requesting the resource from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseStart` <[float]> Time immediately after the client receives the first byte of the response from the server. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `responseEnd` <[float]> Time immediately after the client receives the last byte of the resource or immediately
before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
`startTime`, -1 if not available.

Returns resource timing information for given response. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
2 changes: 1 addition & 1 deletion docs/src/api/class-request.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,7 +314,7 @@ Returns resource size information for given request.
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
- `domainLookupEnd` <[float]> Time immediately after the browser starts the domain name lookup for the resource.
- `domainLookupEnd` <[float]> Time immediately after the browser ends the domain name lookup for the resource.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a drive-by fix - pretty sure it shouldn't say "start the domain name lookup"

The value is given in milliseconds relative to `startTime`, -1 if not available.
- `connectStart` <[float]> Time immediately before the user agent starts establishing the connection to the server
to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
Expand Down
7 changes: 7 additions & 0 deletions packages/playwright-core/src/client/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -332,6 +332,13 @@ export class APIResponse implements api.APIResponse {
return this._headers.headersArray();
}

timing() {
return {
...this._initializer.timing,
responseEnd: this._initializer.responseEndTiming,
};
}

async body(): Promise<Buffer> {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,6 +224,8 @@ scheme.APIResponse = tObject({
status: tNumber,
statusText: tString,
headers: tArray(tType('NameValue')),
timing: tType('ResourceTiming'),
responseEndTiming: tNumber,
});
scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
scheme.LocalUtilsInitializer = tObject({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,7 +212,9 @@ export class APIRequestContextDispatcher extends Dispatcher<APIRequestContext, c
status: fetchResponse.status,
statusText: fetchResponse.statusText,
headers: fetchResponse.headers,
fetchUid: fetchResponse.fetchUid
fetchUid: fetchResponse.fetchUid,
timing: fetchResponse.timing,
responseEndTiming: fetchResponse.responseEndTiming,
}
};
}
Expand Down
27 changes: 26 additions & 1 deletion packages/playwright-core/src/server/fetch.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,7 @@ export abstract class APIRequestContext extends SdkObject {
const requestOptions = { ...options, agent };

const startAt = monotonicTime();
const startAtWallTime = Date.now();
let dnsLookupAt: number | undefined;
let tcpConnectionAt: number | undefined;
let tlsHandshakeAt: number | undefined;
Expand DownExpand Up@@ -433,14 +434,35 @@ export abstract class APIRequestContext extends SdkObject {

const chunks: Buffer[] = [];
const notifyBodyFinished = () => {
function relativeTime(time: number | undefined): number {
if (!time)
return -1;
return time - startAt;
}
const endAt = monotonicTime();
// spec: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
const timing: channels.ResourceTiming = {
startTime: startAtWallTime,
domainLookupStart: dnsLookupAt ? 0 : -1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why zero and not relativeTime()?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understand is that the browser has some other steps like cache resolution before the DNS lookup, so there might be time between startTime and the DNS lookup start. On Node.js, I don't think there's anything between that - so it's zero, because we know the DNS lookup happens immediately after the request start.

domainLookupEnd: relativeTime(dnsLookupAt),
connectStart: dnsLookupAt ? relativeTime(dnsLookupAt) : 0,
secureConnectionStart: tlsHandshakeAt ? relativeTime(dnsLookupAt) : 0,
connectEnd: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
requestStart: relativeTime(tlsHandshakeAt ?? tcpConnectionAt),
responseStart: relativeTime(responseAt),
};
const responseEndTiming = endAt - startAt;

const body = Buffer.concat(chunks);
notifyRequestFinished(body);
fulfill({
url: response.url || url.toString(),
status: response.statusCode || 0,
statusText: response.statusMessage || '',
headers: toHeadersArray(response.rawHeaders),
body
body,
timing,
responseEndTiming,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have two sets of timings now?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For browser requests, most of the timings are transmitted in the Response type, and then responseEndTiming arrives later in the requestFinished and requestFailed events. I opted to make this similar, so we have a big set of timings in timing and the final timing in responseEndTiming.

I thought about amending the ResourceTiming type instead, but then requestFinished would suddenly have the response end time both in responseEndTiming and in response.timing.responseEnd - that felt confusing.

});
};

Expand DownExpand Up@@ -508,6 +530,9 @@ export abstract class APIRequestContext extends SdkObject {
}
});

// socks / http proxy
socket.on('proxyConnect', () => { tcpConnectionAt = monotonicTime(); });

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding timings to the protocol uncovered that tcpConnectionAt was undefined for requests over SOCKS and HTTPS Proxy. Turns out that the library we use for that doesn't emit the connect event, but the proxyConnect event instead.


serverIPAddress = socket.remoteAddress;
serverPort = socket.remotePort;
});
Expand Down
64 changes: 62 additions & 2 deletions packages/playwright-core/types/types.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17366,6 +17366,66 @@ export interface APIResponse {
*/
text(): Promise<string>;

/**
* Returns resource timing information for given response. Find more information at
* [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
*/
timing(): {
/**
* Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
*/
startTime: number;

/**
* Time immediately before the client starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
domainLookupStart: number;

/**
* Time immediately after the client ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectStart: number;

/**
* Time immediately before the client starts the handshake process to secure the current connection. The value is
* given in milliseconds relative to `startTime`, -1 if not available.
*/
secureConnectionStart: number;

/**
* Time immediately before the client starts establishing the connection to the server to retrieve the resource. The
* value is given in milliseconds relative to `startTime`, -1 if not available.
*/
connectEnd: number;

/**
* Time immediately before the client starts requesting the resource from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
requestStart: number;

/**
* Time immediately after the client receives the first byte of the response from the server. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
*/
responseStart: number;

/**
* Time immediately after the client receives the last byte of the resource or immediately before the transport
* connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not
* available.
*/
responseEnd: number;
};

/**
* Contains the URL of the response.
*/
Expand DownExpand Up@@ -19307,8 +19367,8 @@ export interface Request {
domainLookupStart: number;

/**
* Time immediately after the browser starts the domain name lookup for the resource. The value is given in
* milliseconds relative to `startTime`, -1 if not available.
* Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds
* relative to `startTime`, -1 if not available.
*/
domainLookupEnd: number;

Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ export type APIResponse = {
status: number,
statusText: string,
headers: NameValue[],
timing: ResourceTiming,
responseEndTiming: number,
};

export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
Expand Down
2 changes: 2 additions & 0 deletions packages/protocol/src/protocol.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -353,6 +353,8 @@ APIResponse:
headers:
type: array
items: NameValue
timing: ResourceTiming
responseEndTiming: number


LifecycleEvent:
Expand Down
12 changes: 12 additions & 0 deletions tests/library/browsercontext-fetch.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,18 @@ it('fetch should work', async ({ context, server }) => {
expect(response.ok()).toBeTruthy();
expect(response.headers()['content-type']).toBe('application/json; charset=utf-8');
expect(response.headersArray()).toContainEqual({ name: 'Content-Type', value: 'application/json; charset=utf-8' });
expect(response.timing()).toEqual({
connectEnd: expect.any(Number),
connectStart: expect.any(Number),
domainLookupEnd: expect.any(Number),
domainLookupStart: expect.any(Number),
requestStart: expect.any(Number),
responseStart: expect.any(Number),
responseEnd: expect.any(Number),
secureConnectionStart: expect.any(Number),
startTime: expect.any(Number),
});
expect(response.timing().startTime, 'is right order of magnitude').toBeCloseTo(Date.now(), -3);
expect(await response.text()).toBe('{"foo": "bar"}\n');
});

Expand Down