feat(cli): write HTML reports to .lighthouseci (#139)

patrickhulce · web-flow · commit adfbd102aeba · 2019-12-04T14:55:05.000-06:00
diff --git a/packages/cli/test/test-utils.js b/packages/cli/test/test-utils.js
@@ -5,8 +5,10 @@
  */
 'use strict';
 
+const os = require('os');
 const fs = require('fs');
 const path = require('path');
+const rimraf = require('rimraf');
 const {spawn, spawnSync} = require('child_process');
 const testingLibrary = require('@testing-library/dom');
 
@@ -42,6 +44,12 @@ async function safeDeleteFile(filePath) {
   }
 }
 
+async function withTmpDir(fn) {
+  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'lighthouse-ci-'));
+  await fn(tmpDir);
+  rimraf.sync(tmpDir);
+}
+
 async function startServer(sqlFile) {
   if (!sqlFile) {
     sqlFile = getSqlFilePath();
@@ -106,4 +114,5 @@ module.exports = {
   waitForCondition,
   getSqlFilePath,
   safeDeleteFile,
+  withTmpDir,
 };
diff --git a/packages/utils/src/saved-reports.js b/packages/utils/src/saved-reports.js
@@ -36,11 +36,12 @@ function loadSavedLHRs() {
 /**
  * @param {string} lhr
  */
-function saveLHR(lhr) {
-  const filename = `lhr-${Date.now()}.json`;
-  const filePath = path.join(LHCI_DIR, filename);
+function saveLHR(lhr, baseDir = LHCI_DIR) {
+  const baseFilename = `lhr-${Date.now()}`;
+  const basePath = path.join(baseDir, baseFilename);
   ensureDirectoryExists();
-  fs.writeFileSync(filePath, lhr);
+  fs.writeFileSync(`${basePath}.json`, lhr);
+  fs.writeFileSync(`${basePath}.html`, getHTMLReportForLHR(JSON.parse(lhr)));
 }
 
 /**
diff --git a/packages/utils/test/saved-reports.test.js b/packages/utils/test/saved-reports.test.js
@@ -7,9 +7,12 @@
 
 /* eslint-env jest */
 
-const {replaceUrlPatterns} = require('@lhci/utils/src/saved-reports.js');
+const fs = require('fs');
+const path = require('path');
+const {withTmpDir} = require('../../cli/test/test-utils.js');
+const {replaceUrlPatterns, saveLHR} = require('@lhci/utils/src/saved-reports.js');
 
-describe('replaceUrlPatterns', () => {
+describe('#replaceUrlPatterns', () => {
   it('should replace basic patterns', () => {
     const patterns = ['s/foo/bar/'];
     expect(replaceUrlPatterns('https://foo.com', patterns)).toEqual('https://bar.com');
@@ -45,3 +48,30 @@ describe('replaceUrlPatterns', () => {
     expect(() => replaceUrlPatterns('foo', ['nothing'])).toThrow();
   });
 });
+
+describe('#saveLHR', () => {
+  it('should save the lhr to json', async () => {
+    await withTmpDir(dir => {
+      saveLHR(JSON.stringify({lighthouseVersion: '5.6.0'}), dir);
+      const files = fs.readdirSync(dir);
+      expect(files.map(name => name.replace(/-\d+/, '-XXX'))).toContain('lhr-XXX.json');
+
+      const jsonFilePath = path.join(dir, files.find(f => f.endsWith('.json')));
+      const contents = fs.readFileSync(jsonFilePath, 'utf8');
+      expect(contents).toEqual(`{"lighthouseVersion":"5.6.0"}`);
+    });
+  });
+
+  it('should save the lhr to html', async () => {
+    await withTmpDir(dir => {
+      saveLHR(JSON.stringify({lighthouseVersion: '5.6.0'}), dir);
+      const files = fs.readdirSync(dir);
+      expect(files.map(name => name.replace(/-\d+/, '-XXX'))).toContain('lhr-XXX.html');
+
+      const jsonFilePath = path.join(dir, files.find(f => f.endsWith('.html')));
+      const contents = fs.readFileSync(jsonFilePath, 'utf8');
+      expect(contents).toMatch(/<!DOCTYPE html>/i);
+      expect(contents).toMatch(/__LIGHTHOUSE_JSON__ = /);
+    });
+  });
+});
