# all files / lighthouse-core/report/ report-generator.js

100% Statements 71/71
91.43% Branches 32/35
100% Functions 6/6
100% Lines 71/71

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207

    1×
    1×
    1×
    1×

    7×
    8×
    64×

    8×

    7×
    24×

    7×
    4×

    4×
    4×

    7×
    232×
    164×

    68×

    7×

    7×
    4×

    4×
    4×
    4×

    4×
    4×

    4×

    7×
    232×
    164×

    68×
    68×
    20×

    68×
    20×

    68×

    7×
    8×

    4×

    4×

    4×
    3×

    3×

    1×

    4×

    4×

    12×
    8×

    4×
    32×

    100×
    32×

    100×
    76×

    4×

    4×

    4×
    12×
    40×
    156×
    120×

    36×

    4×

    32×
    32×
    32×
    4×

    32×

    4×
    4×

    1×
     /**
     * @license
     * Copyright 2016 Google Inc. 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';

    /* global Intl */

    const Formatter = require('../formatters/formatter');
    const Handlebars = require('handlebars');
    const fs = require('fs');
    const path = require('path');

    class ReportGenerator {

      constructor() {
        const getTotalScore = aggregation => {
          const totalScore = aggregation.score.reduce((total, s) => {
            return total + s.overall;
          }, 0) / aggregation.score.length;

          return Math.round(totalScore * 100);
        };

        // Converts a name to a link.
        Handlebars.registerHelper('nameToLink', name => {
          return name.toLowerCase().replace(/\s/, '-');
        });

        // Create a handler for the generated by message at the bottom of
        // the HTML report.
        Handlebars.registerHelper('generated', _ => {
          const options = {
            day: 'numeric', month: 'numeric', year: 'numeric',
            hour: 'numeric', minute: 'numeric', second: 'numeric',
            timeZoneName: 'short'
          };
          const formatter = new Intl.DateTimeFormat('en-US', options);
          return formatter.format(new Date());
        });

        // Helper for either saying 'yes' or 'no' for booleans, or simply returning the value if it's
        // of any other type.
        Handlebars.registerHelper('getItemValue', value => {
          if (typeof value === 'boolean') {
            return value ? 'Yes' : 'No';
          }

          return value;
        });

        // Figures out the total score for an aggregation
        Handlebars.registerHelper('getTotalScore', getTotalScore);

        // Converts the total score to a rating that can be used for styling.
        Handlebars.registerHelper('getTotalScoreRating', aggregation => {
          const totalScore = getTotalScore(aggregation);

          let rating = 'poor';
          Eif (totalScore > 45) {
            rating = 'average';
          }
          Eif (totalScore > 75) {
            rating = 'good';
          }

          return rating;
        });

        // Converts a value to a rating string, which can be used inside the report for color styling.
        Handlebars.registerHelper('getItemRating', (value, aggregatorScored) => {
          if (typeof value === 'boolean') {
            return value ? 'good' : 'poor';
          }

          // Limit the rating to average if this is a rating for Best Practices.
          let rating = aggregatorScored ? 'average' : 'poor';
          if (value > 0.33) {
            rating = 'average';
          }
          if (value > 0.66) {
            rating = 'good';
          }

          return rating;
        });

        // Convert numbers to fixed point decimals
        Handlebars.registerHelper('decimal', number => {
          return number.toFixed(2);
        });
      }

      /**
       * Gets the HTML for the report.
       * @return {string}
       */
      getReportHTML() {
        return fs.readFileSync(path.join(__dirname, './templates/report.html'), 'utf8');
      }

      /**
       * Gets the CSS for the report.
       * @return {string}
       */
      getReportCSS() {
        return fs.readFileSync(path.join(__dirname, './styles/report.css'), 'utf8');
      }

      /**
       * Gets the JavaScript for the report.
       * @param  {boolean} inline Whether or not to give the JS back as an inline script vs external.
       * @return {string}
       */
      getReportJS(inline) {
        // If this is for the extension we won't be able to run JS inline to the page so we will
        // return a path to a JS file that will be copied in from ./scripts/report.js by gulp.
        if (inline) {
          const reportScript =
              fs.readFileSync(path.join(__dirname, './scripts/lighthouse-report.js'), 'utf8');
          return `<script>${reportScript}</script>`;
        }
        return '<script src="/pages/scripts/lighthouse-report.js"></script>';
      }

      /**
       * Refactors the PWA audits into their respective tech categories, i.e. offline, manifest, etc
       * because the report itself supports viewing them by user feature (default), or by category.
       */
      _createPWAAuditsByCategory(aggregations) {
        const items = {};

        aggregations.forEach(aggregation => {
          // We only regroup the PWA aggregations so ignore any
          // that don't match that name, i.e. Best Practices, metrics.
          if (!aggregation.categorizable) {
            return;
          }

          aggregation.score.forEach(score => {
            score.subItems.forEach(subItem => {
              // Create a space for the category.
              if (!items[subItem.category]) {
                items[subItem.category] = {};
              }

              // Then use the name to de-dupe the same audit from different aggregations.
              if (!items[subItem.category][subItem.name]) {
                items[subItem.category][subItem.name] = subItem;
              }
            });
          });
        });

        return items;
      }

      generateHTML(results, options) {
        const inline = (options && options.inline) || false;

        // Ensure the formatter for each extendedInfo is registered.
        results.aggregations.forEach(aggregation => {
          aggregation.score.forEach(score => {
            score.subItems.forEach(subItem => {
              if (!subItem.extendedInfo) {
                return;
              }
              if (!subItem.extendedInfo.formatter) {
                // HTML formatter not provided for this subItem
                return;
              }
              const formatter = Formatter.getByName(subItem.extendedInfo.formatter);
              const helpers = formatter.getHelpers();
              if (helpers) {
                Handlebars.registerHelper(helpers);
              }

              Handlebars.registerPartial(subItem.name, formatter.getFormatter('html'));
            });
          });
        });

        const template = Handlebars.compile(this.getReportHTML());
        return template({
          url: results.url,
          css: this.getReportCSS(inline),
          script: this.getReportJS(inline),
          aggregations: results.aggregations,
          auditsByCategory: this._createPWAAuditsByCategory(results.aggregations)
        });
      }
    }

    module.exports = ReportGenerator;