new_audit: add third party entity summary #9067
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,151 @@ | ||||||
| /** | ||||||
| * @license Copyright 2019 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 thirdPartyWeb = require('third-party-web/httparchive-nostats-subset'); | ||||||
|
|
||||||
| const Audit = require('./audit.js'); | ||||||
| const BootupTime = require('./bootup-time.js'); | ||||||
| const i18n = require('../lib/i18n/i18n.js'); | ||||||
| const NetworkRecords = require('../computed/network-records.js'); | ||||||
| const MainThreadTasks = require('../computed/main-thread-tasks.js'); | ||||||
|
|
||||||
| const UIStrings = { | ||||||
| /** Title of a Lighthouse audit that identifies the code on the page that the user doesn't control. This is shown in a list of audits that Lighthouse generates. */ | ||||||
| title: 'Third-Party Usage', | ||||||
| /** Description of a Lighthouse audit that identifies the code on the page that the user doesn't control. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */ | ||||||
| description: 'Third-party code can significantly impact load performance. ' + | ||||||
| 'Limit the number of redundant third-party providers and only load third-party code after ' + | ||||||
| 'your page has primarily finished loading. [Learn more](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/loading-third-party-javascript/).', | ||||||
| /** Label for a table column that displays how much time each row spent executing on the main thread, entries will be the number of milliseconds spent. */ | ||||||
| columnMainThreadTime: 'Main Thread Time', | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. source? it's mixed at best in our repo too but in https://github.com/WICG/main-thread-scheduling the only thing that has There was a problem hiding this comment.
I mean, I didn't think about it very hard, but it's a phrasal adjective so generally the rule is hyphenate. If it's a known phrase then that's also fine. 馃し鈥嶁檧 There was a problem hiding this comment. @patrickhulce The hyphen is needed to disambiguate that the word main is part of main thread and not a general adjective that describes thread time. For comparison, in main soccer game, main describes soccer game. |
||||||
| }; | ||||||
|
|
||||||
| const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings); | ||||||
|
|
||||||
| /** @typedef {import("third-party-web").IEntity} ThirdPartyEntity */ | ||||||
|
|
||||||
| class ThirdPartySummary extends Audit { | ||||||
| /** | ||||||
| * @return {LH.Audit.Meta} | ||||||
| */ | ||||||
| static get meta() { | ||||||
| return { | ||||||
| id: 'third-party-summary', | ||||||
| title: str_(UIStrings.title), | ||||||
| description: str_(UIStrings.description), | ||||||
| scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE, | ||||||
| requiredArtifacts: ['traces', 'devtoolsLogs'], | ||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * `third-party-web` throws when the passed in string doesn't appear to have any domain whatsoever. | ||||||
| * We pass in some not-so-url-like things, so make the dependent-code simpler by making this call safe. | ||||||
| * @param {string} url | ||||||
| * @return {ThirdPartyEntity|undefined} | ||||||
| */ | ||||||
| static getEntitySafe(url) { | ||||||
| try { | ||||||
| return thirdPartyWeb.getEntity(url); | ||||||
| } catch (_) { | ||||||
| return undefined; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
|
|
||||||
| /** | ||||||
| * | ||||||
| * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords | ||||||
| * @param {Array<LH.Artifacts.TaskNode>} mainThreadTasks | ||||||
| * @param {number} cpuMultiplier | ||||||
| * @return {Map<ThirdPartyEntity, {mainThreadTime: number, transferSize: number}>} | ||||||
| */ | ||||||
| static getSummaryByEntity(networkRecords, mainThreadTasks, cpuMultiplier) { | ||||||
| /** @type {Map<ThirdPartyEntity, {mainThreadTime: number, transferSize: number}>} */ | ||||||
| const entities = new Map(); | ||||||
|
|
||||||
| for (const request of networkRecords) { | ||||||
| const entity = ThirdPartySummary.getEntitySafe(request.url); | ||||||
| if (!entity) continue; | ||||||
|
|
||||||
| const entityStats = entities.get(entity) || {mainThreadTime: 0, transferSize: 0}; | ||||||
| entityStats.transferSize += request.transferSize; | ||||||
| entities.set(entity, entityStats); | ||||||
| } | ||||||
|
|
||||||
| const jsURLs = BootupTime.getJavaScriptURLs(networkRecords); | ||||||
|
|
||||||
| for (const task of mainThreadTasks) { | ||||||
| const attributeableURL = BootupTime.getAttributableURLForTask(task, jsURLs); | ||||||
| const entity = ThirdPartySummary.getEntitySafe(attributeableURL); | ||||||
| if (!entity) continue; | ||||||
|
|
||||||
| const entityStats = entities.get(entity) || {mainThreadTime: 0, transferSize: 0}; | ||||||
| entityStats.mainThreadTime += task.selfTime * cpuMultiplier; | ||||||
| entities.set(entity, entityStats); | ||||||
| } | ||||||
|
|
||||||
| return entities; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @param {LH.Artifacts} artifacts | ||||||
| * @param {LH.Audit.Context} context | ||||||
| * @return {Promise<LH.Audit.Product>} | ||||||
| */ | ||||||
| static async audit(artifacts, context) { | ||||||
| const settings = context.settings || {}; | ||||||
| const trace = artifacts.traces[Audit.DEFAULT_PASS]; | ||||||
| const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS]; | ||||||
| const networkRecords = await NetworkRecords.request(devtoolsLog, context); | ||||||
| const tasks = await MainThreadTasks.request(trace, context); | ||||||
| const multiplier = settings.throttlingMethod === 'simulate' ? | ||||||
| settings.throttling.cpuSlowdownMultiplier : 1; | ||||||
|
|
||||||
| const summaryByEntity = ThirdPartySummary.getSummaryByEntity(networkRecords, tasks, multiplier); | ||||||
|
|
||||||
| const summary = {wastedBytes: 0, wastedMs: 0}; | ||||||
|
|
||||||
| // Sort by a combined measure of bytes + main thread time. | ||||||
| // 1KB ~= 1 ms | ||||||
| /** @param {{transferSize: number, mainThreadTime: number}} stats */ | ||||||
| const computeSortValue = stats => stats.transferSize / 1024 + stats.mainThreadTime; | ||||||
|
|
||||||
| const results = Array.from(summaryByEntity.entries()) | ||||||
| .map(([entity, stats]) => { | ||||||
| summary.wastedBytes += stats.transferSize; | ||||||
| summary.wastedMs += stats.mainThreadTime; | ||||||
|
|
||||||
| return { | ||||||
| entity: /** @type {LH.Audit.Details.LinkValue} */ ({ | ||||||
| type: 'link', | ||||||
| text: entity.name, | ||||||
| url: entity.homepage || '', | ||||||
patrickhulce marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| }), | ||||||
| transferSize: stats.transferSize, | ||||||
| mainThreadTime: stats.mainThreadTime, | ||||||
| }; | ||||||
| }) | ||||||
| .sort((a, b) => computeSortValue(b) - computeSortValue(a)); | ||||||
|
|
||||||
| /** @type {LH.Audit.Details.Table['headings']} */ | ||||||
| const headings = [ | ||||||
| {key: 'entity', itemType: 'link', text: str_(i18n.UIStrings.columnURL)}, | ||||||
|
There was a problem hiding this comment. "URL" doesnt make sense as the column header.. perhaps "Third party" ? |
||||||
| {key: 'transferSize', granularity: 1, itemType: 'bytes', | ||||||
| text: str_(i18n.UIStrings.columnSize)}, | ||||||
| {key: 'mainThreadTime', granularity: 1, itemType: 'ms', | ||||||
| text: str_(UIStrings.columnMainThreadTime)}, | ||||||
| ]; | ||||||
|
|
||||||
| return { | ||||||
| score: Number(results.length === 0), | ||||||
| details: Audit.makeTableDetails(headings, results, summary), | ||||||
| }; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| module.exports = ThirdPartySummary; | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /** | ||
| * @license Copyright 2017 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 ThirdPartySummary = require('../../audits/third-party-summary.js'); | ||
|
|
||
| const pwaTrace = require('../fixtures/traces/progressive-app-m60.json'); | ||
| const pwaDevtoolsLog = require('../fixtures/traces/progressive-app-m60.devtools.log.json'); | ||
|
|
||
| /* eslint-env jest */ | ||
| describe('Third party summary', () => { | ||
| it('surface the discovered third parties', async () => { | ||
| const artifacts = { | ||
| devtoolsLogs: {defaultPass: pwaDevtoolsLog}, | ||
| traces: {defaultPass: pwaTrace}, | ||
| }; | ||
|
|
||
| const results = await ThirdPartySummary.audit(artifacts, {computedCache: new Map()}); | ||
|
|
||
| expect(results.details.items).toEqual([ | ||
| { | ||
| entity: { | ||
| text: 'Google Tag Manager', | ||
| type: 'link', | ||
| url: 'https://marketingplatform.google.com/about/tag-manager/', | ||
| }, | ||
| mainThreadTime: 104.70300000000002, | ||
| transferSize: 30827, | ||
| }, | ||
| { | ||
| entity: { | ||
| text: 'Google Analytics', | ||
| type: 'link', | ||
| url: 'https://www.google.com/analytics/analytics/', | ||
| }, | ||
| mainThreadTime: 87.576, | ||
| transferSize: 20913, | ||
| }, | ||
| ]); | ||
| }); | ||
|
|
||
| it('account for simulated throttling', async () => { | ||
| const artifacts = { | ||
| devtoolsLogs: {defaultPass: pwaDevtoolsLog}, | ||
| traces: {defaultPass: pwaTrace}, | ||
| }; | ||
|
|
||
| const settings = {throttlingMethod: 'simulate', throttling: {cpuSlowdownMultiplier: 4}}; | ||
| const results = await ThirdPartySummary.audit(artifacts, {computedCache: new Map(), settings}); | ||
|
|
||
| expect(results.details.items).toHaveLength(2); | ||
| expect(Math.round(results.details.items[0].mainThreadTime)).toEqual(419); | ||
| expect(Math.round(results.details.items[1].mainThreadTime)).toEqual(350); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems kind of strongly worded?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/only/try to/?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sg