github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: resolve navigation flakiness (#8768)

Browse Source 
Two main sources of flakiness addressed: 

1) we should dispose the lifecycle watcher after we waited for the navigation response (bad API? we need to refactor but I think it'd be valuable to stabilize tests first without too many changes).
2) we should wait for the navigation request's response if there is a navigation request in the watcher.

Closes #8644
This commit is contained in:
Alex Rudenko 2022-08-10 17:59:58 +02:00 committed by GitHub
parent c23cdb73a7
commit 2580347b50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 502 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/common/FrameManager.ts
View File

@ -227,11 +227,15 @@ export class FrameManager extends EventEmitter {
: watcher.sameDocumentNavigationPromise(),
]);
}
watcher.dispose();
if (error) {
throw error;
try {
if (error) {
throw error;
}
return await watcher.navigationResponse();
} finally {
watcher.dispose();
}
return await watcher.navigationResponse();
async function navigate(
client: CDPSession,
@ -276,11 +280,14 @@ export class FrameManager extends EventEmitter {
watcher.sameDocumentNavigationPromise(),
watcher.newDocumentNavigationPromise(),
]);
watcher.dispose();
if (error) {
throw error;
try {
if (error) {
throw error;
}
return await watcher.navigationResponse();
} finally {
watcher.dispose();
}
return await watcher.navigationResponse();
}
async onAttachedToTarget(target: Target): Promise<void> {

26
src/common/LifecycleWatcher.ts
View File

@ -19,6 +19,8 @@ import {
addEventListener,
PuppeteerEventListener,
removeEventListeners,
DeferredPromise,
createDeferredPromise,
} from './util.js';
import {TimeoutError} from './Errors.js';
import {
@ -100,6 +102,8 @@ export class LifecycleWatcher {
#hasSameDocumentNavigation?: boolean;
#swapped?: boolean;
#navigationResponseReceived?: DeferredPromise<void>;
constructor(
frameManager: FrameManager,
frame: Frame,
@ -160,6 +164,11 @@ export class LifecycleWatcher {
NetworkManagerEmittedEvents.Request,
this.#onRequest.bind(this)
),
addEventListener(
this.#frameManager.networkManager(),
NetworkManagerEmittedEvents.Response,
this.#onResponse.bind(this)
),
];
this.#timeoutPromise = this.#createTimeoutPromise();
@ -171,6 +180,20 @@ export class LifecycleWatcher {
return;
}
this.#navigationRequest = request;
this.#navigationResponseReceived?.reject(
new Error('New navigation request was received')
);
this.#navigationResponseReceived = createDeferredPromise();
if (request.response() !== null) {
this.#navigationResponseReceived?.resolve();
}
}
#onResponse(response: HTTPResponse): void {
if (this.#navigationRequest?._requestId !== response.request()._requestId) {
return;
}
this.#navigationResponseReceived?.resolve();
}
#onFrameDetached(frame: Frame): void {
@ -185,7 +208,8 @@ export class LifecycleWatcher {
}
async navigationResponse(): Promise<HTTPResponse | null> {
// We may need to wait for ExtraInfo events before the request is complete.
// Continue with a possibly null response.
await this.#navigationResponseReceived?.catch(() => {});
return this.#navigationRequest ? this.#navigationRequest.response() : null;
}

462
test/src/NetworkManager.spec.ts
View File

@ -24,6 +24,7 @@ import {
import {HTTPRequest} from '../../lib/cjs/puppeteer/common/HTTPRequest.js';
import {EventEmitter} from '../../lib/cjs/puppeteer/common/EventEmitter.js';
import {Frame} from '../../lib/cjs/puppeteer/common/FrameManager.js';
import {HTTPResponse} from '../../lib/cjs/puppeteer/common/HTTPResponse.js';
class MockCDPSession extends EventEmitter {
async send(): Promise<any> {}
@ -660,4 +661,465 @@ describeChromeOnly('NetworkManager', () => {
expect(requests.length).toBe(1);
});
it(`should resolve the response once the late responseReceivedExtraInfo event arrives`, async () => {
const mockCDPSession = new MockCDPSession();
const manager = new NetworkManager(mockCDPSession, true, {
frame(): Frame | null {
return null;
},
});
const finishedRequests: HTTPRequest[] = [];
const pendingRequests: HTTPRequest[] = [];
manager.on(
NetworkManagerEmittedEvents.RequestFinished,
(request: HTTPRequest) => {
finishedRequests.push(request);
}
);
manager.on(NetworkManagerEmittedEvents.Request, (request: HTTPRequest) => {
pendingRequests.push(request);
});
mockCDPSession.emit('Network.requestWillBeSent', {
requestId: 'LOADERID',
loaderId: 'LOADERID',
documentURL: 'http://10.1.0.39:42915/empty.html',
request: {
url: 'http://10.1.0.39:42915/empty.html',
method: 'GET',
headers: {
'Upgrade-Insecure-Requests': '1',
'User-Agent':
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36',
},
mixedContentType: 'none',
initialPriority: 'VeryHigh',
referrerPolicy: 'strict-origin-when-cross-origin',
isSameSite: true,
},
timestamp: 671.229856,
wallTime: 1660121157.913774,
initiator: {type: 'other'},
redirectHasExtraInfo: false,
type: 'Document',
frameId: 'FRAMEID',
hasUserGesture: false,
});
mockCDPSession.emit('Network.responseReceived', {
requestId: 'LOADERID',
loaderId: 'LOADERID',
timestamp: 671.236025,
type: 'Document',
response: {
url: 'http://10.1.0.39:42915/empty.html',
status: 200,
statusText: 'OK',
headers: {
'Cache-Control': 'no-cache, no-store',
Connection: 'keep-alive',
'Content-Length': '0',
'Content-Type': 'text/html; charset=utf-8',
Date: 'Wed, 10 Aug 2022 08:45:57 GMT',
'Keep-Alive': 'timeout=5',
},
mimeType: 'text/html',
connectionReused: true,
connectionId: 18,
remoteIPAddress: '10.1.0.39',
remotePort: 42915,
fromDiskCache: false,
fromServiceWorker: false,
fromPrefetchCache: false,
encodedDataLength: 197,
timing: {
requestTime: 671.232585,
proxyStart: -1,
proxyEnd: -1,
dnsStart: -1,
dnsEnd: -1,
connectStart: -1,
connectEnd: -1,
sslStart: -1,
sslEnd: -1,
workerStart: -1,
workerReady: -1,
workerFetchStart: -1,
workerRespondWithSettled: -1,
sendStart: 0.308,
sendEnd: 0.364,
pushStart: 0,
pushEnd: 0,
receiveHeadersEnd: 1.554,
},
responseTime: 1.660121157917951e12,
protocol: 'http/1.1',
securityState: 'insecure',
},
hasExtraInfo: true,
frameId: 'FRAMEID',
});
mockCDPSession.emit('Network.requestWillBeSentExtraInfo', {
requestId: 'LOADERID',
associatedCookies: [],
headers: {
Accept:
'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9',
'Accept-Encoding': 'gzip, deflate',
'Accept-Language': 'en-US,en;q=0.9',
Connection: 'keep-alive',
Host: '10.1.0.39:42915',
'Upgrade-Insecure-Requests': '1',
'User-Agent':
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36',
},
connectTiming: {requestTime: 671.232585},
});
mockCDPSession.emit('Network.loadingFinished', {
requestId: 'LOADERID',
timestamp: 671.234448,
encodedDataLength: 197,
shouldReportCorbBlocking: false,
});
expect(pendingRequests.length).toBe(1);
expect(finishedRequests.length).toBe(0);
expect(pendingRequests[0]!.response()).toEqual(null);
// The extra info might arrive late.
mockCDPSession.emit('Network.responseReceivedExtraInfo', {
requestId: 'LOADERID',
blockedCookies: [],
headers: {
'Cache-Control': 'no-cache, no-store',
Connection: 'keep-alive',
'Content-Length': '0',
'Content-Type': 'text/html; charset=utf-8',
Date: 'Wed, 10 Aug 2022 09:04:39 GMT',
'Keep-Alive': 'timeout=5',
},
resourceIPAddressSpace: 'Private',
statusCode: 200,
headersText:
'HTTP/1.1 200 OK\\r\\nCache-Control: no-cache, no-store\\r\\nContent-Type: text/html; charset=utf-8\\r\\nDate: Wed, 10 Aug 2022 09:04:39 GMT\\r\\nConnection: keep-alive\\r\\nKeep-Alive: timeout=5\\r\\nContent-Length: 0\\r\\n\\r\\n',
});
expect(pendingRequests.length).toBe(1);
expect(finishedRequests.length).toBe(1);
expect(pendingRequests[0]!.response()).not.toEqual(null);
});
it(`should send responses for iframe that don't receive loadingFinished event`, async () => {
const mockCDPSession = new MockCDPSession();
const manager = new NetworkManager(mockCDPSession, true, {
frame(): Frame | null {
return null;
},
});
const responses: HTTPResponse[] = [];
const requests: HTTPRequest[] = [];
manager.on(
NetworkManagerEmittedEvents.Response,
(response: HTTPResponse) => {
responses.push(response);
}
);
manager.on(NetworkManagerEmittedEvents.Request, (request: HTTPRequest) => {
requests.push(request);
});
mockCDPSession.emit('Network.requestWillBeSent', {
requestId: '94051D839ACF29E53A3D1273FB20B4C4',
loaderId: '94051D839ACF29E53A3D1273FB20B4C4',
documentURL: 'http://127.0.0.1:54590/empty.html',
request: {
url: 'http://127.0.0.1:54590/empty.html',
method: 'GET',
headers: {
Referer: 'http://localhost:54590/',
'Upgrade-Insecure-Requests': '1',
'User-Agent':
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/105.0.5173.0 Safari/537.36',
},
mixedContentType: 'none',
initialPriority: 'VeryHigh',
referrerPolicy: 'strict-origin-when-cross-origin',
isSameSite: false,
},
timestamp: 504903.99901,
wallTime: 1660125092.026021,
initiator: {
type: 'script',
stack: {
callFrames: [
{
functionName: 'navigateFrame',
scriptId: '8',
url: 'pptr://__puppeteer_evaluation_script__',
lineNumber: 2,
columnNumber: 18,
},
],
},
},
redirectHasExtraInfo: false,
type: 'Document',
frameId: '07D18B8630A8161C72B6079B74123D60',
hasUserGesture: true,
});
mockCDPSession.emit('Network.requestWillBeSentExtraInfo', {
requestId: '94051D839ACF29E53A3D1273FB20B4C4',
associatedCookies: [],
headers: {
Accept:
'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9',
'Accept-Encoding': 'gzip, deflate, br',
Connection: 'keep-alive',
Host: '127.0.0.1:54590',
Referer: 'http://localhost:54590/',
'Sec-Fetch-Dest': 'iframe',
'Sec-Fetch-Mode': 'navigate',
'Sec-Fetch-Site': 'cross-site',
'Sec-Fetch-User': '?1',
'Upgrade-Insecure-Requests': '1',
'User-Agent':
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/105.0.5173.0 Safari/537.36',
},
connectTiming: {requestTime: 504904.000422},
clientSecurityState: {
initiatorIsSecureContext: true,
initiatorIPAddressSpace: 'Local',
privateNetworkRequestPolicy: 'Allow',
},
});
mockCDPSession.emit('Network.responseReceivedExtraInfo', {
requestId: '94051D839ACF29E53A3D1273FB20B4C4',
blockedCookies: [],
headers: {
'Cache-Control': 'no-cache, no-store',
Connection: 'keep-alive',
'Content-Length': '0',
'Content-Type': 'text/html; charset=utf-8',
Date: 'Wed, 10 Aug 2022 09:51:32 GMT',
'Keep-Alive': 'timeout=5',
},
resourceIPAddressSpace: 'Local',
statusCode: 200,
headersText:
'HTTP/1.1 200 OK\r\nCache-Control: no-cache, no-store\r\nContent-Type: text/html; charset=utf-8\r\nDate: Wed, 10 Aug 2022 09:51:32 GMT\r\nConnection: keep-alive\r\nKeep-Alive: timeout=5\r\nContent-Length: 0\r\n\r\n',
});
mockCDPSession.emit('Network.responseReceived', {
requestId: '94051D839ACF29E53A3D1273FB20B4C4',
loaderId: '94051D839ACF29E53A3D1273FB20B4C4',
timestamp: 504904.00338,
type: 'Document',
response: {
url: 'http://127.0.0.1:54590/empty.html',
status: 200,
statusText: 'OK',
headers: {
'Cache-Control': 'no-cache, no-store',
Connection: 'keep-alive',
'Content-Length': '0',
'Content-Type': 'text/html; charset=utf-8',
Date: 'Wed, 10 Aug 2022 09:51:32 GMT',
'Keep-Alive': 'timeout=5',
},
mimeType: 'text/html',
connectionReused: true,
connectionId: 13,
remoteIPAddress: '127.0.0.1',
remotePort: 54590,
fromDiskCache: false,
fromServiceWorker: false,
fromPrefetchCache: false,
encodedDataLength: 197,
timing: {
requestTime: 504904.000422,
proxyStart: -1,
proxyEnd: -1,
dnsStart: -1,
dnsEnd: -1,
connectStart: -1,
connectEnd: -1,
sslStart: -1,
sslEnd: -1,
workerStart: -1,
workerReady: -1,
workerFetchStart: -1,
workerRespondWithSettled: -1,
sendStart: 0.338,
sendEnd: 0.413,
pushStart: 0,
pushEnd: 0,
receiveHeadersEnd: 1.877,
},
responseTime: 1.660125092029241e12,
protocol: 'http/1.1',
securityState: 'secure',
},
hasExtraInfo: true,
frameId: '07D18B8630A8161C72B6079B74123D60',
});
expect(requests.length).toBe(1);
expect(responses.length).toBe(1);
expect(requests[0]!.response()).not.toEqual(null);
});
it(`should send responses for iframe that don't receive loadingFinished event`, async () => {
const mockCDPSession = new MockCDPSession();
const manager = new NetworkManager(mockCDPSession, true, {
frame(): Frame | null {
return null;
},
});
const responses: HTTPResponse[] = [];
const requests: HTTPRequest[] = [];
manager.on(
NetworkManagerEmittedEvents.Response,
(response: HTTPResponse) => {
responses.push(response);
}
);
manager.on(NetworkManagerEmittedEvents.Request, (request: HTTPRequest) => {
requests.push(request);
});
mockCDPSession.emit('Network.requestWillBeSent', {
requestId: 'E18BEB94B486CA8771F9AFA2030FEA37',
loaderId: 'E18BEB94B486CA8771F9AFA2030FEA37',
documentURL: 'http://localhost:56295/empty.html',
request: {
url: 'http://localhost:56295/empty.html',
method: 'GET',
headers: {
'Upgrade-Insecure-Requests': '1',
'User-Agent':
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/105.0.5173.0 Safari/537.36',
},
mixedContentType: 'none',
initialPriority: 'VeryHigh',
referrerPolicy: 'strict-origin-when-cross-origin',
isSameSite: true,
},
timestamp: 510294.105656,
wallTime: 1660130482.230591,
initiator: {type: 'other'},
redirectHasExtraInfo: false,
type: 'Document',
frameId: 'F9C89A517341F1EFFE63310141630189',
hasUserGesture: false,
});
mockCDPSession.emit('Network.responseReceived', {
requestId: 'E18BEB94B486CA8771F9AFA2030FEA37',
loaderId: 'E18BEB94B486CA8771F9AFA2030FEA37',
timestamp: 510294.119816,
type: 'Document',
response: {
url: 'http://localhost:56295/empty.html',
status: 200,
statusText: 'OK',
headers: {
'Cache-Control': 'no-cache, no-store',
Connection: 'keep-alive',
'Content-Length': '0',
'Content-Type': 'text/html; charset=utf-8',
Date: 'Wed, 10 Aug 2022 11:21:22 GMT',
'Keep-Alive': 'timeout=5',
},
mimeType: 'text/html',
connectionReused: true,
connectionId: 13,
remoteIPAddress: '[::1]',
remotePort: 56295,
fromDiskCache: false,
fromServiceWorker: false,
fromPrefetchCache: false,
encodedDataLength: 197,
timing: {
requestTime: 510294.106734,
proxyStart: -1,
proxyEnd: -1,
dnsStart: -1,
dnsEnd: -1,
connectStart: -1,
connectEnd: -1,
sslStart: -1,
sslEnd: -1,
workerStart: -1,
workerReady: -1,
workerFetchStart: -1,
workerRespondWithSettled: -1,
sendStart: 2.195,
sendEnd: 2.29,
pushStart: 0,
pushEnd: 0,
receiveHeadersEnd: 6.493,
},
responseTime: 1.660130482238109e12,
protocol: 'http/1.1',
securityState: 'secure',
},
hasExtraInfo: true,
frameId: 'F9C89A517341F1EFFE63310141630189',
});
mockCDPSession.emit('Network.requestWillBeSentExtraInfo', {
requestId: 'E18BEB94B486CA8771F9AFA2030FEA37',
associatedCookies: [],
headers: {
Accept:
'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9',
'Accept-Encoding': 'gzip, deflate, br',
Connection: 'keep-alive',
Host: 'localhost:56295',
'Sec-Fetch-Dest': 'document',
'Sec-Fetch-Mode': 'navigate',
'Sec-Fetch-Site': 'none',
'Sec-Fetch-User': '?1',
'Upgrade-Insecure-Requests': '1',
'User-Agent':
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/105.0.5173.0 Safari/537.36',
},
connectTiming: {requestTime: 510294.106734},
});
mockCDPSession.emit('Network.loadingFinished', {
requestId: 'E18BEB94B486CA8771F9AFA2030FEA37',
timestamp: 510294.113383,
encodedDataLength: 197,
shouldReportCorbBlocking: false,
});
mockCDPSession.emit('Network.responseReceivedExtraInfo', {
requestId: 'E18BEB94B486CA8771F9AFA2030FEA37',
blockedCookies: [],
headers: {
'Cache-Control': 'no-cache, no-store',
Connection: 'keep-alive',
'Content-Length': '0',
'Content-Type': 'text/html; charset=utf-8',
Date: 'Wed, 10 Aug 2022 11:21:22 GMT',
'Keep-Alive': 'timeout=5',
},
resourceIPAddressSpace: 'Local',
statusCode: 200,
headersText:
'HTTP/1.1 200 OK\r\nCache-Control: no-cache, no-store\r\nContent-Type: text/html; charset=utf-8\r\nDate: Wed, 10 Aug 2022 11:21:22 GMT\r\nConnection: keep-alive\r\nKeep-Alive: timeout=5\r\nContent-Length: 0\r\n\r\n',
});
expect(requests.length).toBe(1);
expect(responses.length).toBe(1);
expect(requests[0]!.response()).not.toEqual(null);
});
});