clients(psi): add LH.Result object support to prepareLabData (#6432)

GoogleChrome · Oct 31, 2018 · 5a113dc · 5a113dc
1 parent 9615070
commit 5a113dc
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 9 deletions.
diff --git a/lighthouse-core/report/html/renderer/psi.js b/lighthouse-core/report/html/renderer/psi.js
@@ -29,12 +29,14 @@
  *      document
  *   );
  *
- * @param {string} LHResultJsonString The stringified version of {LH.Result}
+ * @param {LH.Result | string} LHResult The stringified version of {LH.Result}
  * @param {Document} document The host page's window.document
  * @return {{scoreGaugeEl: Element, perfCategoryEl: Element, finalScreenshotDataUri: string|null}}
  */
-function prepareLabData(LHResultJsonString, document) {
-  const lhResult = /** @type {LH.Result} */ (JSON.parse(LHResultJsonString));
+function prepareLabData(LHResult, document) {
+  const lhResult = (typeof LHResult === 'string') ?
+    /** @type {LH.Result} */ (JSON.parse(LHResult)) : LHResult;
+
   const dom = new DOM(document);
 
   // Assume fresh styles needed on every call, so mark all template styles as unused.

diff --git a/lighthouse-core/test/report/html/renderer/psi-test.js b/lighthouse-core/test/report/html/renderer/psi-test.js
@@ -20,8 +20,11 @@ const CriticalRequestChainRenderer =
     require('../../../../report/html/renderer/crc-details-renderer');
 
 const sampleResultsStr = fs.readFileSync(__dirname + '/../../../results/sample_v2.json', 'utf-8');
-const sampleResults = JSON.parse(sampleResultsStr)
-;
+const sampleResultsRoundtripStr = fs.readFileSync(
+  __dirname + '/../../../../../proto/sample_v2_round_trip.json',
+  'utf-8'
+);
+
 const TEMPLATE_FILE = fs.readFileSync(
   __dirname + '/../../../../report/html/templates.html',
   'utf8'
@@ -60,7 +63,22 @@ describe('DOM', () => {
 
   describe('psi prepareLabData helpers', () => {
     describe('prepareLabData', () => {
-      it('reports expected data', () => {
+      it('succeeds with LHResult object (roundtrip) input', () => {
+        const roundTripLHResult = /** @type {LH.Result} */ JSON.parse(sampleResultsRoundtripStr);
+        const result = prepareLabData(roundTripLHResult, document);
+
+        // sanity check that the report exists and has some content
+        assert.ok(result.perfCategoryEl instanceof document.defaultView.Element);
+        assert.ok(result.perfCategoryEl.outerHTML.length > 50000, 'perfCategory HTML is populated');
+        assert.ok(!result.perfCategoryEl.outerHTML.includes('lh-permalink'),
+            'PSI\'s perfCategory HTML doesn\'t include a lh-permalink element');
+        // Assume using default locale.
+        const titleEl = result.perfCategoryEl.querySelector('.lh-audit-group--metrics')
+          .querySelector('.lh-audit-group__header');
+        assert.equal(titleEl.textContent, Util.UIStrings.labDataTitle);
+      });
+
+      it('succeeds with stringified LHResult input', () => {
         const result = prepareLabData(sampleResultsStr, document);
         assert.ok(result.scoreGaugeEl instanceof document.defaultView.Element);
         assert.equal(result.scoreGaugeEl.querySelector('.lh-gauge__wrapper').href, '');
@@ -115,14 +133,13 @@ describe('DOM', () => {
 
   describe('_getFinalScreenshot', () => {
     it('gets a datauri as a string', () => {
-      const LHResultJsonString = JSON.stringify(sampleResults);
-      const datauri = prepareLabData(LHResultJsonString, document).finalScreenshotDataUri;
+      const datauri = prepareLabData(sampleResultsStr, document).finalScreenshotDataUri;
       assert.equal(typeof datauri, 'string');
       assert.ok(datauri.startsWith('data:image/jpeg;base64,'));
     });
 
     it('returns null if there is no final-screenshot audit', () => {
-      const clonedResults = JSON.parse(JSON.stringify(sampleResults));
+      const clonedResults = JSON.parse(sampleResultsStr);
       delete clonedResults.audits['final-screenshot'];
       const LHResultJsonString = JSON.stringify(clonedResults);
       const datauri = prepareLabData(LHResultJsonString, document).finalScreenshotDataUri;