report: autogenerate components.js from templates.html

build/build-dt-report-resources.js

@@ -32,7 +32,7 @@ fs.mkdirSync(distDir);
 writeFile('report.js', htmlReportAssets.REPORT_JAVASCRIPT);
 writeFile('report.css', htmlReportAssets.REPORT_CSS);
 writeFile('standalone-template.html', htmlReportAssets.REPORT_TEMPLATE);
-writeFile('templates.html', htmlReportAssets.REPORT_TEMPLATES);
+writeFile('templates.html', '<div>Empty file. Remove on next roll to CDT</div>');
 writeFile('report.d.ts', 'export {}');
 writeFile('report-generator.d.ts', 'export {}');
 

build/build-report-components.js

@@ -0,0 +1,212 @@
+/**
+ * @license Copyright 2021 The Lighthouse Authors. 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';
+
+/**
+ * @typedef CompiledComponent
+ * @property {HTMLTemplateElement} tmpEl
+ * @property {string} componentName
+ * @property {string} functionName
+ * @property {string} functionCode
+ */
+
+const fs = require('fs');
+const jsdom = require('jsdom');
+const {LH_ROOT} = require('../root.js');
+
+const html = fs.readFileSync(LH_ROOT + '/report/assets/templates.html', 'utf-8');
+const {window} = new jsdom.JSDOM(html);
+const tmplEls = window.document.querySelectorAll('template');
+
+/**
+ * @param {string} str
+ */
+function upperFirst(str) {
+  return str.charAt(0).toUpperCase() + str.substr(1);
+}
+
+/**
+ * @param {string} functionName
+ * @param {string[]} bodyLines
+ * @param {string[]} parameterNames
+ */
+function createFunctionCode(functionName, bodyLines, parameterNames = []) {
+  const body = bodyLines.map(l => `  ${l}`).join('\n');
+  const functionCode = `function ${functionName}(${parameterNames.join(', ')}) {\n${body}\n}`;
+  return functionCode;
+}
+
+/**
+ * @param {ChildNode} childNode
+ * @return {string|undefined}
+ */
+function normalizeTextNodeText(childNode) {
+  // Just for typescript.
+  if (!childNode.parentElement) return;
+  // Just for typescript. If a text node has no text, it's trivially not significant.
+  if (!childNode.textContent) return;
+
+  let textContent = childNode.textContent || '';
+  // Consecutive whitespace is redundant, unless in certain elements.
+  if (!['PRE', 'STYLE'].includes(childNode.parentElement.tagName)) {
+    textContent = textContent.replace(/\s+/g, ' ');
+  }
+
+  return textContent;
+}
+
+/**
+ * @param {HTMLTemplateElement} tmpEl
+ * @return {CompiledComponent}
+ */
+function compileTemplate(tmpEl) {
+  const elemToVarNames = new Map();
+  const lines = [];
+
+  /**
+   * @param {Element} el
+   * @return {string}
+   */
+  function makeOrGetVarName(el) {
+    const varName = elemToVarNames.get(el) || ('el' + elemToVarNames.size);
+    elemToVarNames.set(el, varName);
+    return varName;
+  }
+
+  /**
+   * @param {Element} el
+   */
+  function process(el) {
+    const isSvg = el.namespaceURI && el.namespaceURI.endsWith('/svg');
+    const namespaceURI = isSvg ? el.namespaceURI : '';
+    const tagName = el.localName;
+    const className = el.classList.toString();
+
+    let createElementFnName = 'createElement';
+    const args = [tagName];
+    if (className) {
+      args.push(className);
+    }
+    if (namespaceURI) {
+      createElementFnName = 'createElementNS';
+      args.unshift(namespaceURI);
+    }
+
+    const varName = makeOrGetVarName(el);
+    const argsSerialzed =
+      args.map(arg => arg === undefined ? 'undefined' : JSON.stringify(arg)).join(', ');
+    lines.push(`const ${varName} = dom.${createElementFnName}(${argsSerialzed});`);
+
+    if (el.getAttributeNames) {
+      for (const attr of el.getAttributeNames() || []) {
+        if (attr === 'class') continue;
+
+        lines.push(`${varName}.setAttribute('${attr}', '${el.getAttribute(attr)}');`);
+      }
+    }
+
+    /** @type {string[]} */
+    const childNodesToAppend = [];
+    for (const childNode of el.childNodes) {
+      if (childNode.nodeType === window.Node.COMMENT_NODE) continue;
+
+      if (childNode.nodeType === window.Node.TEXT_NODE) {
+        if (!childNode.parentElement) continue;
+
+        const textContent = normalizeTextNodeText(childNode);
+        if (!textContent) continue;
+
+        // Escaped string value for JS.
+        childNodesToAppend.push(JSON.stringify(textContent));
+        continue;
+      }
+
+      if (!(childNode instanceof /** @type {typeof Element} */ (window.Element))) {
+        throw new Error(`Expected ${childNode} to be an element`);
+      }
+      process(childNode);
+
+      const childVarName = elemToVarNames.get(childNode);
+      if (childVarName) childNodesToAppend.push(childVarName);
+    }
+
+    if (childNodesToAppend.length) {
+      lines.push(`${varName}.append(${childNodesToAppend.join(',')});`);
+    }
+  }
+
+  const fragmentVarName = makeOrGetVarName(tmpEl);
+  lines.push(`const ${fragmentVarName} = dom.document().createDocumentFragment();`);
+
+  for (const topLevelEl of tmpEl.content.children) {
+    process(topLevelEl);
+    lines.push(`${fragmentVarName}.append(${makeOrGetVarName(topLevelEl)});`);
+  }
+
+  lines.push(`return ${fragmentVarName};`);
+
+  const componentName = tmpEl.id;
+  const functionName = `create${upperFirst(componentName)}Component`;
+  const jsdoc = `
+/**
+ * @param {DOM_} dom
+ */`;
+  const functionCode = jsdoc + '\n' + createFunctionCode(functionName, lines, ['dom']);
+  return {tmpEl, componentName, functionName, functionCode};
+}
+
+/**
+ * @param {CompiledComponent[]} compiledTemplates
+ * @return {string}
+ */
+function makeGenericCreateComponentFunctionCode(compiledTemplates) {
+  const lines = [];
+
+  lines.push('switch (componentName) {');
+  for (const {componentName, functionName} of compiledTemplates) {
+    lines.push(`  case '${componentName}': return ${functionName}(dom);`);
+  }
+  lines.push('}');
+  lines.push('throw new Error(\'unexpected component: \' + componentName)');
+
+  const paramType = compiledTemplates.map(t => `'${t.componentName}'`).join('|');
+  const jsdoc = `
+/** @typedef {${paramType}} ComponentName */
+/**
+ * @param {DOM_} dom
+ * @param {ComponentName} componentName
+ * @return {DocumentFragment}
+ */`;
+  return jsdoc + '\nexport ' +
+    createFunctionCode('createComponent', lines, ['dom', 'componentName']);
+}
+
+async function main() {
+  const compiledTemplates = [...tmplEls].map(compileTemplate);
+  compiledTemplates.sort((a, b) => a.componentName.localeCompare(b.componentName));
+  const code = `
+    'use strict';
+
+    // auto-generated by build/build-report-components.js
+
+    // must import as DOM_ to avoid redeclaring 'DOM' export in bundle.d.ts, otherwise
+    // yarn test-devtools will fail.
+    /** @typedef {import('./dom.js').DOM} DOM_ */
+
+    /* eslint-disable max-len */
+
+    ${compiledTemplates.map(t => t.functionCode).join('\n')}
+
+    ${makeGenericCreateComponentFunctionCode(compiledTemplates)}
+  `.trim();
+  fs.writeFileSync(LH_ROOT + '/report/renderer/components.js', code);
+}
+
+if (require.main === module) {
+  main();
+}
+
+module.exports = {normalizeTextNodeText};

build/build-viewer.js

@@ -38,9 +38,6 @@ async function run() {
     name: 'viewer',
     appDir: `${LH_ROOT}/lighthouse-viewer/app`,
     html: {path: 'index.html'},
-    htmlReplacements: {
-      '%%LIGHTHOUSE_TEMPLATES%%': htmlReportAssets.REPORT_TEMPLATES,
-    },
     stylesheets: [
       htmlReportAssets.REPORT_CSS,
       {path: 'styles/*'},

clients/devtools-report-assets.js

@@ -30,7 +30,4 @@ module.exports = {
   get REPORT_TEMPLATE() {
     return cachedResources.get('third_party/lighthouse/report-assets/standalone-template.html');
   },
-  get REPORT_TEMPLATES() {
-    return cachedResources.get('third_party/lighthouse/report-assets/templates.html');
-  },
 };

lighthouse-viewer/app/src/lighthouse-report-viewer.js

@@ -231,7 +231,6 @@ class LighthouseReportViewer {
       features.initFeatures(json);
     } catch (e) {
       logger.error(`Error rendering report: ${e.message}`);
-      dom.resetTemplates(); // TODO(bckenny): hack
       container.textContent = '';
       throw e;
     } finally {

package.json

@@ -23,7 +23,7 @@
     "build-smokehouse-bundle": "node ./build/build-smokehouse-bundle.js",
     "build-lr": "yarn reset-link && node ./build/build-lightrider-bundles.js",
     "build-pack": "bash build/build-pack.sh",
-    "build-report": "node build/build-report.js",
+    "build-report": "node build/build-report-components.js && yarn eslint --fix report/renderer/components.js && node build/build-report.js",
     "build-treemap": "node ./build/build-treemap.js",
     "build-viewer": "node ./build/build-viewer.js",
     "reset-link": "(yarn unlink || true) && yarn link && yarn link lighthouse",
@@ -105,6 +105,7 @@
     "@types/google.analytics": "0.0.39",
     "@types/jest": "^24.0.9",
     "@types/jpeg-js": "^0.3.0",
+    "@types/jsdom": "^16.2.13",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.get": "^4.4.6",
     "@types/lodash.isequal": "^4.5.2",