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.

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

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

Merged
merged 11 commits into from
Jun 29, 2019
Next Next commit
misc(build): create error-y LHR for the deploy
  • Loading branch information
paulirish committed Jun 25, 2019
commit efd41c9544efaaa5f2fea26098cfcf090a39dcf7
62 changes: 49 additions & 13 deletions lighthouse-core/scripts/build-report-for-autodeployment.js
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,40 @@ 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
paulirish marked this conversation as resolved.
Show resolved Hide resolved
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?


const TMP = `${DIST}/.tmp/`;
mkdirp(TMP);
fs.writeFileSync(`${TMP}/artifacts.json`, JSON.stringify(artifacts), 'utf-8');
const errorRunnerResult = await lighthouse(url, {auditMode: TMP});
return /** @type {LH.RunnerResult} */ (errorRunnerResult).lhr;
}