[go: nahoru, domu]
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

Jump to bottom

misc(build): create error-y LHR for the deploy #9283

Merged
merged 11 commits into from
Jun 29, 2019
Merged

misc(build): create error-y LHR for the deploy #9283

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
efd41c9
misc(build): create error-y LHR for the deploy
paulirish Jun 25, 2019
10d1e03
add runwarning
paulirish Jun 26, 2019
f36c343
Update lighthouse-core/scripts/build-report-for-autodeployment.js
paulirish Jun 26, 2019
fbf2c9f
add in audit warnings, too
paulirish Jun 26, 2019
9245c3e
less obj.assign for stronger typing
paulirish Jun 26, 2019
3bc962f
some feedback
paulirish Jun 26, 2019
1e28415
cast the driver instead
paulirish Jun 27, 2019
68f6736
lint
paulirish Jun 27, 2019
de55da5
Merge branch 'master' into deployvariant-error
paulirish Jun 27, 2019
aa1b39b
drop other cast
paulirish Jun 27, 2019
76920df
feedback
paulirish Jun 28, 2019
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
2 changes: 2 additions & 0 deletions lighthouse-core/report/html/renderer/performance-category-renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,8 @@ class PerformanceCategoryRenderer extends CategoryRenderer {
element.appendChild(groupEl);
}

// TODO: Handle passed w/ warnings in a unique clump like non-perf categories do
Copy link
Member

Choose a reason for hiding this comment

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

This is chicken nuggets an issue

Copy link
Member Author

Choose a reason for hiding this comment

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

ayup #9288

Copy link
Member

Choose a reason for hiding this comment

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

delete then? it doesn't really have anything to do with this PR and is redundant with that PR


// Passed audits
const passedAudits = category.auditRefs
.filter(audit => (audit.group === 'load-opportunities' || audit.group === 'diagnostics') &&
Expand Down
90 changes: 77 additions & 13 deletions lighthouse-core/scripts/build-report-for-autodeployment.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,31 @@ const mkdirp = require('mkdirp').sync;
const swapLocale = require('../lib/i18n/swap-locale.js');

const ReportGenerator = require('../../lighthouse-core/report/report-generator.js');
const GatherRunner = require('../gather/gather-runner.js');
const {defaultSettings} = require('../config/constants.js');
const lighthouse = require('../index.js');
const lhr = /** @type {LH.Result} */ (require('../../lighthouse-core/test/results/sample_v2.json'));

const DIST = path.join(__dirname, `../../dist`);

// Add a plugin to demo plugin rendering.
lhr.categories['lighthouse-plugin-someplugin'] = {
id: 'lighthouse-plugin-someplugin',
title: 'Plugin',
score: 0.5,
auditRefs: [],
};

(async function() {
addPluginCategory(lhr);
const errorLhr = await generateErrorLHR();

const filenameToLhr = {
'english': lhr,
'espanol': swapLocale(lhr, 'es').lhr,
'arabic': swapLocale(lhr, 'ar').lhr,
english: lhr,
espanol: swapLocale(lhr, 'es').lhr,
arabic: swapLocale(lhr, 'ar').lhr,
error: errorLhr,
brendankenny marked this conversation as resolved.
Show resolved Hide resolved
};

mkdirp(DIST);

// Generate and write reports
Object.entries(filenameToLhr).forEach(([filename, lhr]) => {
let html = ReportGenerator.generateReportHtml(lhr);
// TODO: PSI is another variant to consider
for (const variant of ['', '-devtools']) {
if (variant === '-devtools') {
// TODO: Make the DevTools Audits panel "emulation" more comprehensive
brendankenny marked this conversation as resolved.
Show resolved Hide resolved
html = html.replace(`"lh-root lh-vars"`, `"lh-root lh-vars lh-devtools"`);
}
const filepath = `${DIST}/${filename}${variant}/index.html`;
Expand All @@ -49,3 +48,68 @@ lhr.categories['lighthouse-plugin-someplugin'] = {
}
});
})();

/**
* Add a plugin to demo plugin rendering.
* @param {LH.Result} lhr
*/
function addPluginCategory(lhr) {
lhr.categories['lighthouse-plugin-someplugin'] = {
id: 'lighthouse-plugin-someplugin',
title: 'Plugin',
score: 0.5,
auditRefs: [],
};
}

/**
* Generate an LHR with errors for the renderer to display
* We'll write an "empty" artifacts file to disk, only to use it in auditMode
Copy link
Member

Choose a reason for hiding this comment

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

Needs periods

* @return {Promise<LH.Result>}
*/
async function generateErrorLHR() {
const url = 'http://fakeurl.com';
const options = {
requestedUrl: url,
settings: defaultSettings,
driver: {
getBrowserVersion: () => ({userAgent: 'Mozilla/5.0 ErrorUserAgent Chrome/66'}),
},
};
// @ts-ignore driver isn't mocked out completely
const artifacts = await GatherRunner.initializeBaseArtifacts(options);
Copy link
Member

Choose a reason for hiding this comment

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

One downside here is that ts-ignore is going to make this invisible to any breaking changes made to initializeBaseArtifacts, and since it's an internal method that could pretty easily happen

Copy link
Collaborator

Choose a reason for hiding this comment

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

how about throwing a ts-ignore/cast on the driver object instead?

// Add in a global runWarning
artifacts.LighthouseRunWarnings.push(`Something went wrong with recording the trace over your
page load. Please run Lighthouse again. (NO_FCP)`);
Copy link
Member
@brendankenny brendankenny Jun 27, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

What do you think about checking in error artifacts? If the pageLoadError-defaultPass trace and devtoolsLog are deleted, they should be quite small.

could just replace all of the above with

/** @type {LH.BaseArtifacts} */
const artifacts = {
  fetchTime: '2019-06-26T23:56:58.381Z',
  LighthouseRunWarnings: [
    `Something went wrong with recording the trace over your page load. Please run Lighthouse again. (NO_FCP)`, // eslint-disable-line max-len
  ],
  TestedAsMobileDevice: true,
  HostUserAgent: 'Mozilla/5.0 ErrorUserAgent Chrome/66',
  NetworkUserAgent: 'Mozilla/5.0 ErrorUserAgent Chrome/66',
  BenchmarkIndex: 1000,
  WebAppManifest: null,
  Stacks: [],
  settings: defaultSettings,
  URL: {
    requestedUrl: 'http://fakeurl.com',
    finalUrl: 'http://fakeurl.com',
  },
  Timing: [],
  PageLoadError: null,
  devtoolsLogs: {},
  traces: {},
};

and then continue as below. Only a little bit longer and the type assertion keeps everything in sync.


// Save artifacts to disk then run `lighthouse -G` with them
const TMP = `${DIST}/.tmp/`;
mkdirp(TMP);
fs.writeFileSync(`${TMP}/artifacts.json`, JSON.stringify(artifacts), 'utf-8');
const errorRunnerResult = await lighthouse(url, {auditMode: TMP});
const errorLhr = /** @type {LH.RunnerResult} */ (errorRunnerResult).lhr;
Copy link
Member

Choose a reason for hiding this comment

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

Why does this need a cast?

Copy link
Member Author

Choose a reason for hiding this comment

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

because lighthouse can return RunnerResult | undefined (i think because of -G?)

Copy link
Member

Choose a reason for hiding this comment

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

because lighthouse can return RunnerResult | undefined (i think because of -G?)

ah, oh right. I prefer the real undefined check over the cast personally, but not a big deal in this case


// Add audit warnings to font-display
errorLhr.audits['font-display'].warnings = [
'Lighthouse was unable to automatically check the font-display value for the following URL: https://secure-ds.serving-sys.com/resources/PROD/html5/105657/20190307/1074580285/43862346571980472/fonts/IBMPlexSans-Light-Latin1.woff.',
'Lighthouse was unable to automatically check the font-display value for the following URL: https://secure-ds.serving-sys.com/resources/PROD/html5/105657/20190307/1074580285/43862346571980472/fonts/IBMPlexSans-Bold-Latin1.woff.',
];
// perf/offscreen-images - set as passing but with a warning
const offscreenImagesAudit = errorLhr.audits['offscreen-images'];
offscreenImagesAudit.warnings = [
'Invalid image sizing information: https://cdn.cnn.com/cnn/.e1mo/img/4.0/vr/vr_new_asset.png',
];
offscreenImagesAudit.errorMessage = undefined;
offscreenImagesAudit.scoreDisplayMode = 'binary';
offscreenImagesAudit.score = 1;
// pwa-apple-touch-icon - set as passing but with a warning
const appleTouchIconAudit = errorLhr.audits['apple-touch-icon'];
appleTouchIconAudit.warnings = [
'`apple-touch-icon-precomposed` is out of date; `apple-touch-icon` is preferred.',
];
appleTouchIconAudit.errorMessage = undefined;
appleTouchIconAudit.scoreDisplayMode = 'binary';
appleTouchIconAudit.score = 1;

return errorLhr;
}