Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core: use target type instead of session for oopif #15006

Merged
merged 19 commits into from
May 2, 2023
Merged

core: use target type instead of session for oopif #15006

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
49734d8
core: use target type instead of session for oopif
connorjclark Apr 21, 2023
bb84985
update sample json
connorjclark Apr 21, 2023
c6cb860
add back session id
connorjclark Apr 24, 2023
829fe99
send attached events to new listeners
connorjclark Apr 24, 2023
aa04f1b
clear payloads
connorjclark Apr 24, 2023
9406b1c
rename
connorjclark Apr 25, 2023
955dac0
add test for timespan network sources
connorjclark Apr 25, 2023
66a76c1
test name
connorjclark Apr 25, 2023
facc282
expand devtools log
connorjclark Apr 25, 2023
231672a
manually update logs
connorjclark Apr 25, 2023
2702a05
fix target manager test
connorjclark Apr 25, 2023
8d55cf4
support legacy
connorjclark Apr 25, 2023
7483edd
buttons
connorjclark Apr 26, 2023
96d9f3f
Update core/test/scenarios/api-test-pptr.js
connorjclark Apr 26, 2023
dbec910
change param type
connorjclark Apr 26, 2023
3feb432
Merge branch 'rm-sessionid' of github.com:GoogleChrome/lighthouse int…
connorjclark Apr 26, 2023
55234f1
map records to NR
connorjclark Apr 27, 2023
d9f87ad
rename
connorjclark Apr 27, 2023
48da6da
yay
connorjclark Apr 27, 2023
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
8 changes: 8 additions & 0 deletions cli/test/fixtures/oopif-scripts-timespan.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!DOCTYPE html>
<html>
<body style="height: 200vh">
<h1>Hello frames</h1>
<iframe id="iframe-1" src="http://localhost:10200/oopif-simple-page.html?defer" style="position: fixed"></iframe>
<iframe id="iframe-2" src="http://localhost:10503/oopif-simple-page.html?defer" style="position: fixed; top: 50vh"></iframe>
</body>
</html>
27 changes: 19 additions & 8 deletions cli/test/fixtures/oopif-simple-page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,27 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script src="simple-script.js"></script>
<script>
new Worker('simple-worker.mjs', { type: 'module' });
new Worker('simple-worker.js');

window.addEventListener('load', () => {
fetch('simple-script.js').then(r => r.text()).then(eval);
});
</script>
</head>
<body>
<h1>Just a simple page</h1>
<script>
const shouldDeferStuff = location.search === '?defer';
if (shouldDeferStuff) {
const el = document.createElement('button');
el.textContent = 'Click to load scripts';
el.addEventListener('click', () => {
new Worker('simple-worker.mjs', { type: 'module' });
new Worker('simple-worker.js');
fetch('simple-script.js').then(r => r.text()).then(eval);
});
document.body.append(el);
} else {
new Worker('simple-worker.mjs', { type: 'module' });
new Worker('simple-worker.js');
window.addEventListener('load', () => {
fetch('simple-script.js').then(r => r.text()).then(eval);
});
}
</script>
</body>
</html>
1 change: 1 addition & 0 deletions core/audits/network-requests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ class NetworkRequests extends Audit {

return {
url: UrlUtils.elideDataURI(record.url),
sessionTargetType: record.sessionTargetType,
protocol: record.protocol,
rendererStartTime: normalizeTime(record.rendererStartTime),
networkRequestTime: normalizeTime(record.networkRequestTime),
Expand Down
8 changes: 5 additions & 3 deletions core/gather/driver/target-manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ class TargetManager extends ProtocolEventEmitter {
const targetName = target.targetInfo.url || target.targetInfo.targetId;
log.verbose('target-manager', `target ${targetName} attached`);

const trueProtocolListener = this._getProtocolEventListener(newSession.id());
const trueProtocolListener = this._getProtocolEventListener(targetType, newSession.id());
/** @type {(event: unknown) => void} */
// @ts-expect-error - pptr currently typed only for single arg emits.
const protocolListener = trueProtocolListener;
Expand Down Expand Up @@ -156,17 +156,19 @@ class TargetManager extends ProtocolEventEmitter {
/**
* Returns a listener for all protocol events from session, and augments the
* event with the sessionId.
* @param {string} targetType
connorjclark marked this conversation as resolved.
Show resolved Hide resolved
* @param {string} sessionId
*/
_getProtocolEventListener(sessionId) {
_getProtocolEventListener(targetType, sessionId) {
/**
* @template {keyof LH.Protocol.RawEventMessageRecord} EventName
* @param {EventName} method
* @param {LH.Protocol.RawEventMessageRecord[EventName]['params']} params
*/
const onProtocolEvent = (method, params) => {
// Cast because tsc 4.7 still can't quite track the dependent parameters.
const payload = /** @type {LH.Protocol.RawEventMessage} */ ({method, params, sessionId});
const payload = /** @type {LH.Protocol.RawEventMessage} */ (
{method, params, targetType, sessionId});
this.emit('protocolevent', payload);
};

Expand Down
2 changes: 1 addition & 1 deletion core/gather/gatherers/dobetterweb/optimized-images.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class OptimizedImages extends FRGatherer {
const seenUrls = new Set();
return networkRecords.reduce((prev, record) => {
// Skip records that we've seen before, never finished, or came from child targets (OOPIFS).
if (seenUrls.has(record.url) || !record.finished || record.sessionId) {
if (seenUrls.has(record.url) || !record.finished || record.oopif) {
return prev;
}

Expand Down
2 changes: 1 addition & 1 deletion core/gather/gatherers/dobetterweb/response-compression.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class ResponseCompression extends FRGatherer {

networkRecords.forEach(record => {
// Ignore records from child targets (OOPIFS).
if (record.sessionId) return;
if (record.oopif) return;

const mimeType = record.mimeType;
const resourceType = record.resourceType || NetworkRequest.TYPES.Other;
Expand Down
3 changes: 1 addition & 2 deletions core/gather/gatherers/script-elements.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,7 @@ class ScriptElements extends FRGatherer {

const scriptRecords = networkRecords
.filter(record => record.resourceType === NetworkRequest.TYPES.Script)
// Ignore records from OOPIFs
.filter(record => !record.sessionId);
.filter(record => !record.oopif);

for (let i = 0; i < scriptRecords.length; i++) {
const record = scriptRecords[i];
Expand Down
3 changes: 0 additions & 3 deletions core/gather/gatherers/scripts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,6 @@ class Scripts extends FRGatherer {
/** @type {Array<string | undefined>} */
_scriptContents = [];

/** @type {string|null|undefined} */
_mainSessionId = null;

constructor() {
super();
this.onScriptParsed = this.onScriptParsed.bind(this);
Expand Down
15 changes: 15 additions & 0 deletions core/legacy/gather/connections/connection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ class Connection {
this._lastCommandId = 0;
/** @type {Map<number, CommandCallback>} */
this._callbacks = new Map();
/** @type {Map<string, LH.Protocol.TargetType>} */
this._sessionIdToTargetType = new Map();

this._eventEmitter = /** @type {?CrdpEventMessageEmitter} */ (new EventEmitter());
}
Expand Down Expand Up @@ -129,6 +131,18 @@ class Connection {
if (!('id' in object)) {
log.formatProtocol('<= event',
{method: object.method, params: object.params}, 'verbose');
if (object.method === 'Target.attachedToTarget') {
const type = object.params.targetInfo.type;
if (type === 'page' || type === 'iframe') {
this._sessionIdToTargetType.set(object.params.sessionId, type);
}
}
if (object.sessionId) {
const type = this._sessionIdToTargetType.get(object.sessionId);
if (type) {
object.targetType = type;
}
}
this.emitProtocolEvent(object);
return;
}
Expand Down Expand Up @@ -175,6 +189,7 @@ class Connection {
this._eventEmitter.removeAllListeners();
this._eventEmitter = null;
}
this._sessionIdToTargetType.clear();
}
}

Expand Down
55 changes: 24 additions & 31 deletions core/lib/network-recorder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ class NetworkRecorder extends RequestEventEmitter {
this._records = [];
/** @type {Map<string, NetworkRequest>} */
this._recordsById = new Map();
/** @type {string|null|undefined} */
this._mainSessionId = null;
}

/**
Expand Down Expand Up @@ -71,11 +69,12 @@ class NetworkRecorder extends RequestEventEmitter {
// DevTools SDK network layer.

/**
* @param {{params: LH.Crdp.Network.RequestWillBeSentEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.RequestWillBeSentEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onRequestWillBeSent(event) {
const data = event.params;
const originalRequest = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const originalRequest = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
// This is a simple new request, create the NetworkRequest object and finish.
if (!originalRequest) {
const request = new NetworkRequest();
Expand Down Expand Up @@ -114,68 +113,74 @@ class NetworkRecorder extends RequestEventEmitter {
}

/**
* @param {{params: LH.Crdp.Network.RequestServedFromCacheEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.RequestServedFromCacheEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onRequestServedFromCache(event) {
const data = event.params;
const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const request = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
if (!request) return;
log.verbose('network', `${request.url} served from cache`);
request.onRequestServedFromCache();
}

/**
* @param {{params: LH.Crdp.Network.ResponseReceivedEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.ResponseReceivedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onResponseReceived(event) {
const data = event.params;
const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const request = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
if (!request) return;
log.verbose('network', `${request.url} response received`);
request.onResponseReceived(data);
}

/**
* @param {{params: LH.Crdp.Network.DataReceivedEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.DataReceivedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onDataReceived(event) {
const data = event.params;
const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const request = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
if (!request) return;
log.verbose('network', `${request.url} data received`);
request.onDataReceived(data);
}

/**
* @param {{params: LH.Crdp.Network.LoadingFinishedEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.LoadingFinishedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onLoadingFinished(event) {
const data = event.params;
const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const request = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
if (!request) return;
log.verbose('network', `${request.url} loading finished`);
request.onLoadingFinished(data);
this.onRequestFinished(request);
}

/**
* @param {{params: LH.Crdp.Network.LoadingFailedEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.LoadingFailedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onLoadingFailed(event) {
const data = event.params;
const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const request = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
if (!request) return;
log.verbose('network', `${request.url} loading failed`);
request.onLoadingFailed(data);
this.onRequestFinished(request);
}

/**
* @param {{params: LH.Crdp.Network.ResourceChangedPriorityEvent, sessionId?: string}} event
* @param {{params: LH.Crdp.Network.ResourceChangedPriorityEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
*/
onResourceChangedPriority(event) {
const data = event.params;
const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
const request = this._findRealRequestAndSetSession(
data.requestId, event.targetType, event.sessionId);
if (!request) return;
request.onResourceChangedPriority(data);
}
Expand Down Expand Up @@ -204,24 +209,11 @@ class NetworkRecorder extends RequestEventEmitter {
* message is referring.
*
* @param {string} requestId
* @param {LH.Protocol.TargetType} targetType
* @param {string|undefined} sessionId
* @return {NetworkRequest|undefined}
*/
_findRealRequestAndSetSession(requestId, sessionId) {
// The very first sessionId processed is always the main sessionId. In all but DevTools,
// this sessionId is undefined. However, in DevTools the main Lighthouse protocol connection
// does send events with sessionId set to a string, because of how DevTools routes the protocol
// to Lighthouse.
// Many places in Lighthouse use `record.sessionId === undefined` to mean that the session is not
// an OOPIF. To maintain this property, we intercept sessionId here and set it to undefined if
// it matches the first value seen.
if (this._mainSessionId === null) {
this._mainSessionId = sessionId;
}
if (this._mainSessionId === sessionId) {
sessionId = undefined;
}

_findRealRequestAndSetSession(requestId, targetType, sessionId) {
let request = this._recordsById.get(requestId);
if (!request || !request.isValid) return undefined;

Expand All @@ -230,6 +222,7 @@ class NetworkRecorder extends RequestEventEmitter {
}

request.setSession(sessionId);
request.sessionTargetType = targetType;

return request;
}
Expand Down
14 changes: 8 additions & 6 deletions core/lib/network-request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,10 @@ class NetworkRequest {
this.fetchedViaServiceWorker = false;
/** @type {string|undefined} */
this.frameId = '';
/**
* @type {string|undefined}
* Only set for child targets (OOPIFs). This is the sessionId of the protocol connection on
* which this request was discovered. `undefined` means it came from the root.
*/
/** @type {string|undefined} */
this.sessionId = undefined;
/** @type {LH.Protocol.TargetType|undefined} */
this.sessionTargetType = undefined;
this.isLinkPreload = false;
}

Expand Down Expand Up @@ -320,12 +318,16 @@ class NetworkRequest {
}

/**
* @param {string=} sessionId
* @param {string|undefined} sessionId
*/
setSession(sessionId) {
this.sessionId = sessionId;
}

get oopif() {
Copy link
Member

Choose a reason for hiding this comment

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

isOopif to match e.g. isLinkPreload?

Any reason to make it a getter and not a function?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Mostly I didn't want to convert some of tests that use raw network objects in this PR.

Copy link
Collaborator Author

@connorjclark connorjclark Apr 27, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

isLinkPreload

Oof, I assumed this was a method, so my previous comment didn't make much sense.

I think having two properties here that need to sync up will make it possible to mess up in a test or elsewhere. Renaming to isOutOfProcessIframe seems good though.

return this.sessionTargetType === 'iframe';
}

/**
* @param {LH.Crdp.Network.Response} response
* @param {number} timestamp in seconds
Expand Down
Loading