# all files / lighthouse-core/lib/ asset-saver.js

100% Statements 31/31
100% Branches 4/4
100% Functions 6/6
100% Lines 30/30
3 statements, 1 function, 2 branches Ignored

    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

    1×
    1×
    1×

    1×
    6×
    6×

    6×
    6×
    6×

    1×
    11035×

    1×
    2×

    1×
    1×
    1×
    1×

    1×
    2×
    2×
    2×

    1×
    1×

    1×
    1×
    1×

    1×
    1×
    1×

    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';

    const fs = require('fs');
    const log = require('../../lighthouse-core/lib/log.js');
    const stringify = require('json-stringify-safe');

    function getFilenamePrefix(options) {
      const date = options.date || new Date();
      const url = options.url;

      const hostname = url.match(/^.*?\/\/(.*?)(:?\/|$)/)[1];
      const filenamePrefix = hostname + '_' + date.toISOString();
      return (filenamePrefix).replace(/[\/\?<>\\:\*\|":]/g, '-');
    }

    // Some trace events are particularly large, and not only consume a LOT of disk
    // space, but also cause problems for the JSON stringifier. For simplicity, we exclude them
    function filterForSize(traceData) {
      return traceData.filter(e => e.name !== 'LayoutTree');
    }

    function screenshotDump(options, screenshots) {
      return `
      <!doctype html>
      <title>screenshots ${getFilenamePrefix(options)}</title>
      <style>
    html {
        overflow-x: scroll;
        overflow-y: hidden;
        height: 100%;
        background: linear-gradient(to left, #4CA1AF , #C4E0E5);
        background-attachment: fixed;
        padding: 10px;
    }
    body {
        white-space: nowrap;
        background: linear-gradient(to left, #4CA1AF , #C4E0E5);
        width: 100%;
        margin: 0;
    }
    img {
        margin: 4px;
    }
    </style>
      <body>
        <script>
          var shots = ${JSON.stringify(screenshots)};

      shots.forEach(s => {
        var i = document.createElement('img');
        i.src = s.datauri;
        i.title = s.timestamp;
        document.body.appendChild(i);
      });
      </script>
      `;
    }

    // Set to ignore because testing it would imply testing fs, which isn't strictly necessary.
    /* istanbul ignore next */
    function saveArtifacts(artifacts, filename) {
      const artifactsFilename = filename || 'artifacts.log';
      fs.writeFileSync(artifactsFilename, stringify(artifacts));
      log.log('info', 'artifacts file saved to disk', artifactsFilename);
    }

    function prepareAssets(options, artifacts) {
      const traceData = filterForSize(artifacts.traceContents);
      const html = screenshotDump(options, artifacts.screenshots);
      return {traceData, html};
    }

    function saveAssets(options, artifacts) {
      const assets = prepareAssets(options, artifacts);

      const traceFilename = getFilenamePrefix(options);
      fs.writeFileSync(traceFilename + '.trace.json', stringify(assets.traceData, null, 2));
      log.log('info', 'trace file saved to disk', traceFilename);

      const screenshotsFilename = getFilenamePrefix(options);
      fs.writeFileSync(screenshotsFilename + '.screenshots.html', assets.html);
      log.log('info', 'screenshots saved to disk', screenshotsFilename);
    }

    module.exports = {
      saveArtifacts,
      saveAssets,
      getFilenamePrefix,
      prepareAssets
    };