-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
driver.js
1586 lines (1398 loc) · 54.2 KB
/
driver.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @license Copyright 2016 Google Inc. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
*/
'use strict';
const NetworkRecorder = require('../lib/network-recorder');
const emulation = require('../lib/emulation');
const Element = require('../lib/element');
const LHError = require('../lib/lh-error');
const NetworkRequest = require('../lib/network-request');
const EventEmitter = require('events').EventEmitter;
const URL = require('../lib/url-shim');
const constants = require('../config/constants');
const log = require('lighthouse-logger');
const DevtoolsLog = require('./devtools-log');
const pageFunctions = require('../lib/page-functions.js');
// Pulled in for Connection type checking.
// eslint-disable-next-line no-unused-vars
const Connection = require('./connections/connection.js');
// Controls how long to wait after onLoad before continuing
const DEFAULT_PAUSE_AFTER_LOAD = 0;
// Controls how long to wait between network requests before determining the network is quiet
const DEFAULT_NETWORK_QUIET_THRESHOLD = 5000;
// Controls how long to wait between longtasks before determining the CPU is idle, off by default
const DEFAULT_CPU_QUIET_THRESHOLD = 0;
// Controls how long to wait for a response after sending a DevTools protocol command.
const DEFAULT_PROTOCOL_TIMEOUT = 30000;
/**
* @typedef {LH.Protocol.StrictEventEmitter<LH.CrdpEvents>} CrdpEventEmitter
*/
class Driver {
/**
* @param {Connection} connection
*/
constructor(connection) {
this._traceCategories = Driver.traceCategories;
/**
* An event emitter that enforces mapping between Crdp event names and payload types.
*/
this._eventEmitter = /** @type {CrdpEventEmitter} */ (new EventEmitter());
this._connection = connection;
// Used to save network and lifecycle protocol traffic. Just Page and Network are needed.
this._devtoolsLog = new DevtoolsLog(/^(Page|Network)\./);
this.online = true;
/** @type {Map<string, number>} */
this._domainEnabledCounts = new Map();
/** @type {number|undefined} */
this._isolatedExecutionContextId = undefined;
/**
* Used for monitoring network status events during gotoURL.
* @type {?NetworkRecorder}
* @private
*/
this._networkStatusMonitor = null;
/**
* Used for monitoring url redirects during gotoURL.
* @type {?string}
* @private
*/
this._monitoredUrl = null;
/**
* Used for sending messages to subtargets. Each message needs a unique ID even if we don't bother
* reading back the result of each command.
*
* @type {number}
* @private
*/
this._targetProxyMessageId = 0;
this.on('Target.attachedToTarget', event => {
this._handleTargetAttached(event, []).catch(this._handleEventError);
});
this.on('Target.receivedMessageFromTarget', event => {
this._handleReceivedMessageFromTarget(event, []).catch(this._handleEventError);
});
connection.on('protocolevent', this._handleProtocolEvent.bind(this));
/**
* @type {number}
* @private
*/
this._nextProtocolTimeout = DEFAULT_PROTOCOL_TIMEOUT;
}
static get traceCategories() {
return [
// Exclude default categories. We'll be selective to minimize trace size
'-*',
// Used instead of 'toplevel' in Chrome 71+
'disabled-by-default-lighthouse',
// All compile/execute events are captured by parent events in devtools.timeline..
// But the v8 category provides some nice context for only <0.5% of the trace size
'v8',
// Same situation here. This category is there for RunMicrotasks only, but with other teams
// accidentally excluding microtasks, we don't want to assume a parent event will always exist
'v8.execute',
// For extracting UserTiming marks/measures
'blink.user_timing',
// Not mandatory but not used much
'blink.console',
// Most the events we need come in on these two
'devtools.timeline',
'disabled-by-default-devtools.timeline',
// Up to 450 (https://goo.gl/rBfhn4) JPGs added to the trace
'disabled-by-default-devtools.screenshot',
// This doesn't add its own events, but adds a `stackTrace` property to devtools.timeline events
'disabled-by-default-devtools.timeline.stack',
// CPU sampling profiler data only enabled for debugging purposes
// 'disabled-by-default-v8.cpu_profiler',
// 'disabled-by-default-v8.cpu_profiler.hires',
];
}
/**
* @return {Promise<LH.Crdp.Browser.GetVersionResponse & {milestone: number}>}
*/
async getBrowserVersion() {
const status = {msg: 'Getting browser version', id: 'lh:gather:getVersion'};
log.time(status, 'verbose');
const version = await this.sendCommand('Browser.getVersion');
const match = version.product.match(/\/(\d+)/); // eg 'Chrome/71.0.3577.0'
const milestone = match ? parseInt(match[1]) : 0;
log.timeEnd(status);
return Object.assign(version, {milestone});
}
/**
* Computes the ULTRADUMB™ benchmark index to get a rough estimate of device class.
* @return {Promise<number>}
*/
async getBenchmarkIndex() {
const status = {msg: 'Benchmarking machine', id: 'lh:gather:getBenchmarkIndex'};
log.time(status);
const indexVal = await this.evaluateAsync(`(${pageFunctions.ultradumbBenchmarkString})()`);
log.timeEnd(status);
return indexVal;
}
/**
* @return {Promise<void>}
*/
async connect() {
const status = {msg: 'Connecting to browser', id: 'lh:init:connect'};
log.time(status);
await this._connection.connect();
log.timeEnd(status);
}
/**
* @return {Promise<void>}
*/
disconnect() {
return this._connection.disconnect();
}
/**
* Get the browser WebSocket endpoint for devtools protocol clients like Puppeteer.
* Only works with WebSocket connection, not extension or devtools.
* @return {Promise<string>}
*/
wsEndpoint() {
return this._connection.wsEndpoint();
}
/**
* Bind listeners for protocol events.
* @template {keyof LH.CrdpEvents} E
* @param {E} eventName
* @param {(...args: LH.CrdpEvents[E]) => void} cb
*/
on(eventName, cb) {
if (this._eventEmitter === null) {
throw new Error('connect() must be called before attempting to listen to events.');
}
// log event listeners being bound
log.formatProtocol('listen for event =>', {method: eventName}, 'verbose');
this._eventEmitter.on(eventName, cb);
}
/**
* Bind a one-time listener for protocol events. Listener is removed once it
* has been called.
* @template {keyof LH.CrdpEvents} E
* @param {E} eventName
* @param {(...args: LH.CrdpEvents[E]) => void} cb
*/
once(eventName, cb) {
if (this._eventEmitter === null) {
throw new Error('connect() must be called before attempting to listen to events.');
}
// log event listeners being bound
log.formatProtocol('listen once for event =>', {method: eventName}, 'verbose');
this._eventEmitter.once(eventName, cb);
}
/**
* Unbind event listener.
* @template {keyof LH.CrdpEvents} E
* @param {E} eventName
* @param {Function} cb
*/
off(eventName, cb) {
if (this._eventEmitter === null) {
throw new Error('connect() must be called before attempting to remove an event listener.');
}
this._eventEmitter.removeListener(eventName, cb);
}
/**
* Debounce enabling or disabling domains to prevent driver users from
* stomping on each other. Maintains an internal count of the times a domain
* has been enabled. Returns false if the command would have no effect (domain
* is already enabled or disabled), or if command would interfere with another
* user of that domain (e.g. two gatherers have enabled a domain, both need to
* disable it for it to be disabled). Returns true otherwise.
* @param {string} domain
* @param {boolean} enable
* @return {boolean}
* @private
*/
_shouldToggleDomain(domain, enable) {
const enabledCount = this._domainEnabledCounts.get(domain) || 0;
const newCount = enabledCount + (enable ? 1 : -1);
this._domainEnabledCounts.set(domain, Math.max(0, newCount));
// Switching to enabled or disabled, respectively.
if ((enable && newCount === 1) || (!enable && newCount === 0)) {
log.verbose('Driver', `${domain}.${enable ? 'enable' : 'disable'}`);
return true;
} else {
if (newCount < 0) {
log.error('Driver', `Attempted to disable domain '${domain}' when already disabled.`);
}
return false;
}
}
/**
* timeout is used for the next call to 'sendCommand'.
* NOTE: This can eventually be replaced when TypeScript
* resolves https://github.com/Microsoft/TypeScript/issues/5453.
* @param {number} timeout
*/
setNextProtocolTimeout(timeout) {
this._nextProtocolTimeout = timeout;
}
/**
* @param {LH.Protocol.RawEventMessage} event
*/
_handleProtocolEvent(event) {
this._devtoolsLog.record(event);
if (this._networkStatusMonitor) {
this._networkStatusMonitor.dispatch(event);
}
// @ts-ignore TODO(bckenny): tsc can't type event.params correctly yet,
// typing as property of union instead of narrowing from union of
// properties. See https://github.com/Microsoft/TypeScript/pull/22348.
this._eventEmitter.emit(event.method, event.params);
}
/**
* @param {Error} error
*/
_handleEventError(error) {
log.error('Driver', 'Unhandled event error', error.message);
}
/**
* @param {LH.Crdp.Target.ReceivedMessageFromTargetEvent} event
* @param {string[]} parentSessionIds The list of session ids of the parents from youngest to oldest.
*/
async _handleReceivedMessageFromTarget(event, parentSessionIds) {
const {targetId, sessionId, message} = event;
/** @type {LH.Protocol.RawMessage} */
const protocolMessage = JSON.parse(message);
// Message was a response to some command, not an event, so we'll ignore it.
if ('id' in protocolMessage) return;
// We receive messages from the outermost subtarget which wraps the messages from the inner subtargets.
// We are recursively processing them from outside in, so build the list of parentSessionIds accordingly.
const sessionIdPath = [sessionId, ...parentSessionIds];
if (protocolMessage.method === 'Target.receivedMessageFromTarget') {
// Unravel any messages from subtargets by recursively processing
await this._handleReceivedMessageFromTarget(protocolMessage.params, sessionIdPath);
}
if (protocolMessage.method === 'Target.attachedToTarget') {
// Process any attachedToTarget messages from subtargets
await this._handleTargetAttached(protocolMessage.params, sessionIdPath);
}
if (protocolMessage.method.startsWith('Network')) {
this._handleProtocolEvent({...protocolMessage, source: {targetId, sessionId}});
}
}
/**
* @param {LH.Crdp.Target.AttachedToTargetEvent} event
* @param {string[]} parentSessionIds The list of session ids of the parents from youngest to oldest.
*/
async _handleTargetAttached(event, parentSessionIds) {
const sessionIdPath = [event.sessionId, ...parentSessionIds];
// We're only interested in network requests from iframes for now as those are "part of the page".
// If it's not an iframe, just resume it and move on.
if (event.targetInfo.type !== 'iframe') {
// We suspended the target when we auto-attached, so make sure it goes back to being normal.
await this.sendMessageToTarget(sessionIdPath, 'Runtime.runIfWaitingForDebugger');
return;
}
// Events from subtargets will be stringified and sent back on `Target.receivedMessageFromTarget`.
// We want to receive information about network requests from iframes, so enable the Network domain.
await this.sendMessageToTarget(sessionIdPath, 'Network.enable');
// We also want to receive information about subtargets of subtargets, so make sure we autoattach recursively.
await this.sendMessageToTarget(sessionIdPath, 'Target.setAutoAttach', {
autoAttach: true,
// Pause targets on startup so we don't miss anything
waitForDebuggerOnStart: true,
});
// We suspended the target when we auto-attached, so make sure it goes back to being normal.
await this.sendMessageToTarget(sessionIdPath, 'Runtime.runIfWaitingForDebugger');
}
/**
* Send protocol commands to a subtarget, wraps the message in as many `Target.sendMessageToTarget`
* commands as necessary.
*
* @template {keyof LH.CrdpCommands} C
* @param {string[]} sessionIdPath List of session ids to send to, from youngest-oldest/inside-out.
* @param {C} method
* @param {LH.CrdpCommands[C]['paramsType']} params
* @return {Promise<LH.CrdpCommands[C]['returnType']>}
*/
sendMessageToTarget(sessionIdPath, method, ...params) {
this._targetProxyMessageId++;
/** @type {LH.Crdp.Target.SendMessageToTargetRequest} */
let payload = {
sessionId: sessionIdPath[0],
message: JSON.stringify({id: this._targetProxyMessageId, method, params: params[0]}),
};
for (const sessionId of sessionIdPath.slice(1)) {
this._targetProxyMessageId++;
payload = {
sessionId,
message: JSON.stringify({
id: this._targetProxyMessageId,
method: 'Target.sendMessageToTarget',
params: payload,
}),
};
}
return this.sendCommand('Target.sendMessageToTarget', payload);
}
/**
* Call protocol methods, with a timeout.
* To configure the timeout for the next call, use 'setNextProtocolTimeout'.
* @template {keyof LH.CrdpCommands} C
* @param {C} method
* @param {LH.CrdpCommands[C]['paramsType']} params
* @return {Promise<LH.CrdpCommands[C]['returnType']>}
*/
sendCommand(method, ...params) {
const timeout = this._nextProtocolTimeout;
this._nextProtocolTimeout = DEFAULT_PROTOCOL_TIMEOUT;
return new Promise(async (resolve, reject) => {
const asyncTimeout = setTimeout((() => {
const err = new LHError(
LHError.errors.PROTOCOL_TIMEOUT,
{protocolMethod: method}
);
reject(err);
}), timeout);
try {
const result = await this._innerSendCommand(method, ...params);
resolve(result);
} catch (err) {
reject(err);
} finally {
clearTimeout(asyncTimeout);
}
});
}
/**
* Call protocol methods.
* @private
* @template {keyof LH.CrdpCommands} C
* @param {C} method
* @param {LH.CrdpCommands[C]['paramsType']} params
* @return {Promise<LH.CrdpCommands[C]['returnType']>}
*/
_innerSendCommand(method, ...params) {
const domainCommand = /^(\w+)\.(enable|disable)$/.exec(method);
if (domainCommand) {
const enable = domainCommand[2] === 'enable';
if (!this._shouldToggleDomain(domainCommand[1], enable)) {
return Promise.resolve();
}
}
return this._connection.sendCommand(method, ...params);
}
/**
* Returns whether a domain is currently enabled.
* @param {string} domain
* @return {boolean}
*/
isDomainEnabled(domain) {
// Defined, non-zero elements of the domains map are enabled.
return !!this._domainEnabledCounts.get(domain);
}
/**
* Add a script to run at load time of all future page loads.
* @param {string} scriptSource
* @return {Promise<LH.Crdp.Page.AddScriptToEvaluateOnLoadResponse>} Identifier of the added script.
*/
evaluateScriptOnNewDocument(scriptSource) {
return this.sendCommand('Page.addScriptToEvaluateOnLoad', {
scriptSource,
});
}
/**
* Evaluate an expression in the context of the current page. If useIsolation is true, the expression
* will be evaluated in a content script that has access to the page's DOM but whose JavaScript state
* is completely separate.
* Returns a promise that resolves on the expression's value.
* @param {string} expression
* @param {{useIsolation?: boolean}=} options
* @return {Promise<*>}
*/
async evaluateAsync(expression, options = {}) {
const contextId = options.useIsolation ? await this._getOrCreateIsolatedContextId() : undefined;
return this._evaluateInContext(expression, contextId);
}
/**
* Evaluate an expression in the given execution context; an undefined contextId implies the main
* page without isolation.
* @param {string} expression
* @param {number|undefined} contextId
* @return {Promise<*>}
*/
async _evaluateInContext(expression, contextId) {
// Use a higher than default timeout if the user hasn't specified a specific timeout.
// Otherwise, use whatever was requested.
const timeout = this._nextProtocolTimeout === DEFAULT_PROTOCOL_TIMEOUT ?
60000 : this._nextProtocolTimeout;
const evaluationParams = {
// We need to explicitly wrap the raw expression for several purposes:
// 1. Ensure that the expression will be a native Promise and not a polyfill/non-Promise.
// 2. Ensure that errors in the expression are captured by the Promise.
// 3. Ensure that errors captured in the Promise are converted into plain-old JS Objects
// so that they can be serialized properly b/c JSON.stringify(new Error('foo')) === '{}'
expression: `(function wrapInNativePromise() {
const __nativePromise = window.__nativePromise || Promise;
const URL = window.__nativeURL || window.URL;
return new __nativePromise(function (resolve) {
return __nativePromise.resolve()
.then(_ => ${expression})
.catch(${pageFunctions.wrapRuntimeEvalErrorInBrowserString})
.then(resolve);
});
}())`,
includeCommandLineAPI: true,
awaitPromise: true,
returnByValue: true,
timeout,
contextId,
};
this.setNextProtocolTimeout(timeout);
const response = await this.sendCommand('Runtime.evaluate', evaluationParams);
if (response.exceptionDetails) {
// An error occurred before we could even create a Promise, should be *very* rare
return Promise.reject(new Error(`Evaluation exception: ${response.exceptionDetails.text}`));
}
// Protocol should always return a 'result' object, but it is sometimes undefined. See #6026.
if (response.result === undefined) {
return Promise.reject(
new Error('Runtime.evaluate response did not contain a "result" object'));
}
const value = response.result.value;
if (value && value.__failedInBrowser) {
return Promise.reject(Object.assign(new Error(), value));
} else {
return value;
}
}
/**
* @return {Promise<{url: string, data: string}|null>}
*/
async getAppManifest() {
// In all environments but LR, Page.getAppManifest finishes very quickly.
// In LR, there is a bug that causes this command to hang until outgoing
// requests finish. This has been seen in long polling (where it will never
// return) and when other requests take a long time to finish. We allow 10 seconds
// for outgoing requests to finish. Anything more, and we continue the run without
// a manifest.
// Googlers, see: http://b/124008171
this.setNextProtocolTimeout(10000);
let response;
try {
response = await this.sendCommand('Page.getAppManifest');
} catch (err) {
if (err.code === 'PROTOCOL_TIMEOUT') {
// LR will timeout fetching the app manifest in some cases, move on without one.
// https://github.com/GoogleChrome/lighthouse/issues/7147#issuecomment-461210921
log.error('Driver', 'Failed fetching manifest', err);
return null;
}
throw err;
}
let data = response.data;
// We're not reading `response.errors` however it may contain critical and noncritical
// errors from Blink's manifest parser:
// https://chromedevtools.github.io/debugger-protocol-viewer/tot/Page/#type-AppManifestError
if (!data) {
// If the data is empty, the page had no manifest.
return null;
}
const BOM_LENGTH = 3;
const BOM_FIRSTCHAR = 65279;
const isBomEncoded = data.charCodeAt(0) === BOM_FIRSTCHAR;
if (isBomEncoded) {
data = Buffer.from(data).slice(BOM_LENGTH).toString();
}
return {...response, data};
}
/**
* @return {Promise<LH.Crdp.ServiceWorker.WorkerVersionUpdatedEvent>}
*/
getServiceWorkerVersions() {
return new Promise((resolve, reject) => {
/**
* @param {LH.Crdp.ServiceWorker.WorkerVersionUpdatedEvent} data
*/
const versionUpdatedListener = data => {
// find a service worker with runningStatus that looks like active
// on slow connections the serviceworker might still be installing
const activateCandidates = data.versions.filter(sw => {
return sw.status !== 'redundant';
});
const hasActiveServiceWorker = activateCandidates.find(sw => {
return sw.status === 'activated';
});
if (!activateCandidates.length || hasActiveServiceWorker) {
this.off('ServiceWorker.workerVersionUpdated', versionUpdatedListener);
this.sendCommand('ServiceWorker.disable')
.then(_ => resolve(data), reject);
}
};
this.on('ServiceWorker.workerVersionUpdated', versionUpdatedListener);
this.sendCommand('ServiceWorker.enable').catch(reject);
});
}
/**
* @return {Promise<LH.Crdp.ServiceWorker.WorkerRegistrationUpdatedEvent>}
*/
getServiceWorkerRegistrations() {
return new Promise((resolve, reject) => {
this.once('ServiceWorker.workerRegistrationUpdated', data => {
this.sendCommand('ServiceWorker.disable')
.then(_ => resolve(data), reject);
});
this.sendCommand('ServiceWorker.enable').catch(reject);
});
}
/**
* Rejects if any open tabs would share a service worker with the target URL.
* This includes the target tab, so navigation to something like about:blank
* should be done before calling.
* @param {string} pageUrl
* @return {Promise<void>}
*/
assertNoSameOriginServiceWorkerClients(pageUrl) {
/** @type {Array<LH.Crdp.ServiceWorker.ServiceWorkerRegistration>} */
let registrations;
/** @type {Array<LH.Crdp.ServiceWorker.ServiceWorkerVersion>} */
let versions;
return this.getServiceWorkerRegistrations().then(data => {
registrations = data.registrations;
}).then(_ => this.getServiceWorkerVersions()).then(data => {
versions = data.versions;
}).then(_ => {
const origin = new URL(pageUrl).origin;
registrations
.filter(reg => {
const swOrigin = new URL(reg.scopeURL).origin;
return origin === swOrigin;
})
.forEach(reg => {
versions.forEach(ver => {
// Ignore workers unaffiliated with this registration
if (ver.registrationId !== reg.registrationId) {
return;
}
// Throw if service worker for this origin has active controlledClients.
if (ver.controlledClients && ver.controlledClients.length > 0) {
throw new Error('You probably have multiple tabs open to the same origin.');
}
});
});
});
}
/**
* Returns a promise that resolves immediately.
* Used for placeholder conditions that we don't want to start waiting for just yet, but still want
* to satisfy the same interface.
* @return {{promise: Promise<void>, cancel: function(): void}}
*/
_waitForNothing() {
return {promise: Promise.resolve(), cancel() {}};
}
/**
* Returns a promise that resolve when a frame has been navigated.
* Used for detecting that our about:blank reset has been completed.
*/
_waitForFrameNavigated() {
return new Promise(resolve => {
this.once('Page.frameNavigated', resolve);
});
}
/**
* Returns a promise that resolve when a frame has a FCP.
* @param {number} maxWaitForFCPMs
* @return {{promise: Promise<void>, cancel: function(): void}}
*/
_waitForFCP(maxWaitForFCPMs) {
/** @type {(() => void)} */
let cancel = () => {
throw new Error('_waitForFCP.cancel() called before it was defined');
};
const promise = new Promise((resolve, reject) => {
const maxWaitTimeout = setTimeout(() => {
reject(new LHError(LHError.errors.NO_FCP));
}, maxWaitForFCPMs);
/** @param {LH.Crdp.Page.LifecycleEventEvent} e */
const lifecycleListener = e => {
if (e.name === 'firstContentfulPaint') {
resolve();
cancel();
}
};
this.on('Page.lifecycleEvent', lifecycleListener);
let canceled = false;
cancel = () => {
if (canceled) return;
canceled = true;
this.off('Page.lifecycleEvent', lifecycleListener);
maxWaitTimeout && clearTimeout(maxWaitTimeout);
reject(new Error('Wait for FCP canceled'));
};
});
return {
promise,
cancel,
};
}
/**
* Returns a promise that resolves when the network has been idle (after DCL) for
* `networkQuietThresholdMs` ms and a method to cancel internal network listeners/timeout.
* @param {number} networkQuietThresholdMs
* @return {{promise: Promise<void>, cancel: function(): void}}
* @private
*/
_waitForNetworkIdle(networkQuietThresholdMs) {
let hasDCLFired = false;
/** @type {NodeJS.Timer|undefined} */
let idleTimeout;
/** @type {(() => void)} */
let cancel = () => {
throw new Error('_waitForNetworkIdle.cancel() called before it was defined');
};
// Check here for _networkStatusMonitor to satisfy type checker. Any further race condition
// will be caught at runtime on calls to it.
if (!this._networkStatusMonitor) {
throw new Error('Driver._waitForNetworkIdle called with no networkStatusMonitor');
}
const networkStatusMonitor = this._networkStatusMonitor;
const promise = new Promise((resolve, reject) => {
const onIdle = () => {
// eslint-disable-next-line no-use-before-define
networkStatusMonitor.once('network-2-busy', onBusy);
idleTimeout = setTimeout(_ => {
cancel();
resolve();
}, networkQuietThresholdMs);
};
const onBusy = () => {
networkStatusMonitor.once('network-2-idle', onIdle);
idleTimeout && clearTimeout(idleTimeout);
};
const domContentLoadedListener = () => {
hasDCLFired = true;
if (networkStatusMonitor.is2Idle()) {
onIdle();
} else {
onBusy();
}
};
// We frequently need to debug why LH is still waiting for the page.
// This listener is added to all network events to verbosely log what URLs we're waiting on.
const logStatus = () => {
if (!hasDCLFired) {
log.verbose('Driver', 'Waiting on DomContentLoaded');
return;
}
const inflightRecords = networkStatusMonitor.getInflightRecords();
// If there are more than 20 inflight requests, load is still in full swing.
// Wait until it calms down a bit to be a little less spammy.
if (inflightRecords.length < 20) {
for (const record of inflightRecords) {
log.verbose('Driver', `Waiting on ${record.url.slice(0, 120)} to finish`);
}
}
};
networkStatusMonitor.on('requeststarted', logStatus);
networkStatusMonitor.on('requestloaded', logStatus);
networkStatusMonitor.on('network-2-busy', logStatus);
this.once('Page.domContentEventFired', domContentLoadedListener);
let canceled = false;
cancel = () => {
if (canceled) return;
canceled = true;
idleTimeout && clearTimeout(idleTimeout);
this.off('Page.domContentEventFired', domContentLoadedListener);
networkStatusMonitor.removeListener('network-2-busy', onBusy);
networkStatusMonitor.removeListener('network-2-idle', onIdle);
networkStatusMonitor.removeListener('requeststarted', logStatus);
networkStatusMonitor.removeListener('requestloaded', logStatus);
networkStatusMonitor.removeListener('network-2-busy', logStatus);
};
});
return {
promise,
cancel,
};
}
/**
* Resolves when there have been no long tasks for at least waitForCPUQuiet ms.
* @param {number} waitForCPUQuiet
* @return {{promise: Promise<void>, cancel: function(): void}}
*/
_waitForCPUIdle(waitForCPUQuiet) {
if (!waitForCPUQuiet) {
return {
promise: Promise.resolve(),
cancel: () => undefined,
};
}
/** @type {NodeJS.Timer|undefined} */
let lastTimeout;
let canceled = false;
const checkForQuietExpression = `(${pageFunctions.checkTimeSinceLastLongTaskString})()`;
/**
* @param {Driver} driver
* @param {() => void} resolve
* @return {Promise<void>}
*/
async function checkForQuiet(driver, resolve) {
if (canceled) return;
const timeSinceLongTask = await driver.evaluateAsync(checkForQuietExpression);
if (canceled) return;
if (typeof timeSinceLongTask === 'number') {
if (timeSinceLongTask >= waitForCPUQuiet) {
log.verbose('Driver', `CPU has been idle for ${timeSinceLongTask} ms`);
resolve();
} else {
log.verbose('Driver', `CPU has been idle for ${timeSinceLongTask} ms`);
const timeToWait = waitForCPUQuiet - timeSinceLongTask;
lastTimeout = setTimeout(() => checkForQuiet(driver, resolve), timeToWait);
}
}
}
/** @type {(() => void)} */
let cancel = () => {
throw new Error('_waitForCPUIdle.cancel() called before it was defined');
};
const promise = new Promise((resolve, reject) => {
checkForQuiet(this, resolve).catch(reject);
cancel = () => {
if (canceled) return;
canceled = true;
if (lastTimeout) clearTimeout(lastTimeout);
reject(new Error('Wait for CPU idle canceled'));
};
});
return {
promise,
cancel,
};
}
/**
* Return a promise that resolves `pauseAfterLoadMs` after the load event
* fires and a method to cancel internal listeners and timeout.
* @param {number} pauseAfterLoadMs
* @return {{promise: Promise<void>, cancel: function(): void}}
* @private
*/
_waitForLoadEvent(pauseAfterLoadMs) {
/** @type {(() => void)} */
let cancel = () => {
throw new Error('_waitForLoadEvent.cancel() called before it was defined');
};
const promise = new Promise((resolve, reject) => {
/** @type {NodeJS.Timer|undefined} */
let loadTimeout;
const loadListener = function() {
loadTimeout = setTimeout(resolve, pauseAfterLoadMs);
};
this.once('Page.loadEventFired', loadListener);
let canceled = false;
cancel = () => {
if (canceled) return;
canceled = true;
this.off('Page.loadEventFired', loadListener);
loadTimeout && clearTimeout(loadTimeout);
};
});
return {
promise,
cancel,
};
}
/**
* Return a promise that resolves when an insecure security state is encountered
* and a method to cancel internal listeners.
* @return {{promise: Promise<string>, cancel: function(): void}}
* @private
*/
_monitorForInsecureState() {
/** @type {(() => void)} */
let cancel = () => {
throw new Error('_monitorForInsecureState.cancel() called before it was defined');
};
const promise = new Promise((resolve, reject) => {
/**
* @param {LH.Crdp.Security.SecurityStateChangedEvent} event
*/
const securityStateChangedListener = ({
securityState,
explanations,
schemeIsCryptographic,
}) => {
if (securityState === 'insecure' && schemeIsCryptographic) {
cancel();
const insecureDescriptions = explanations
.filter(exp => exp.securityState === 'insecure')
.map(exp => exp.description);
resolve(insecureDescriptions.join(' '));
}
};
let canceled = false;
cancel = () => {
if (canceled) return;
canceled = true;
this.off('Security.securityStateChanged', securityStateChangedListener);
// TODO(@patrickhulce): cancel() should really be a promise itself to handle things like this
this.sendCommand('Security.disable').catch(() => {});
};
this.on('Security.securityStateChanged', securityStateChangedListener);
this.sendCommand('Security.enable').catch(() => {});
});
return {
promise,
cancel,
};
}
/**
* Returns whether the page appears to be hung.
* @return {Promise<boolean>}
*/
async isPageHung() {
try {
this.setNextProtocolTimeout(1000);
await this.sendCommand('Runtime.evaluate', {
expression: '"ping"',
returnByValue: true,
timeout: 1000,
});
return false;
} catch (err) {
return true;
}
}
/**
* Returns a promise that resolves when:
* - All of the following conditions have been met:
* - page has no security issues
* - pauseAfterLoadMs milliseconds have passed since the load event.
* - networkQuietThresholdMs milliseconds have passed since the last network request that exceeded
* 2 inflight requests (network-2-quiet has been reached).
* - cpuQuietThresholdMs have passed since the last long task after network-2-quiet.
* - maxWaitForLoadedMs milliseconds have passed.
* See https://github.com/GoogleChrome/lighthouse/issues/627 for more.
* @param {number} pauseAfterLoadMs
* @param {number} networkQuietThresholdMs
* @param {number} cpuQuietThresholdMs
* @param {number} maxWaitForLoadedMs
* @param {number=} maxWaitForFCPMs
* @return {Promise<void>}
* @private
*/
async _waitForFullyLoaded(pauseAfterLoadMs, networkQuietThresholdMs, cpuQuietThresholdMs,
maxWaitForLoadedMs, maxWaitForFCPMs) {
/** @type {NodeJS.Timer|undefined} */
let maxTimeoutHandle;
// Listener for onload. Resolves on first FCP event.
const waitForFCP = maxWaitForFCPMs ? this._waitForFCP(maxWaitForFCPMs) : this._waitForNothing();
// Listener for onload. Resolves pauseAfterLoadMs ms after load.
const waitForLoadEvent = this._waitForLoadEvent(pauseAfterLoadMs);
// Network listener. Resolves when the network has been idle for networkQuietThresholdMs.
const waitForNetworkIdle = this._waitForNetworkIdle(networkQuietThresholdMs);