coach-core/lib/har/performance/cacheHeaders.js

Core package for the Coach.

'use strict';

let util = require('../util');

const SKIPPABLE_DOMAINS = [
  'www.google-analytics.com',
  'ssl.google-analytics.com',
  'analytics.twitter.com'
];

module.exports = {
  id: 'cacheHeaders',
  title: 'Avoid extra requests by setting cache headers',
  description:
    "The easiest way to make your page fast is to avoid doing requests to the server. Setting a cache header on your server response will tell the browser that it doesn't need to download the asset again during the configured cache time! Always try to set a cache time if the content doesn't change for every request.",
  weight: 30,
  tags: ['performance', 'server'],

  processPage: function (page) {
    let score = 100;
    let offending = [];
    let saveSize = 0;
    page.assets.forEach(function (asset) {
      // Don't check the main page/document since it is common to not
      // cache that
      if (asset.url === page.finalUrl) {
        return;
      }

      if (
        SKIPPABLE_DOMAINS.indexOf(util.getHostname(asset.url)) === -1 &&
        asset.expires <= 0 &&
        asset.method === 'GET'
      ) {
        // TODO we should check if the asset is set private, think the most logical would be to exclude them
        score -= 10;
        saveSize += asset.transferSize;
        offending.push(asset.url);
      }
    });

    return {
      score: Math.max(0, score),
      offending: offending,
      advice:
        score < 100
          ? 'The page has ' +
            util.plural(offending.length, 'request') +
            " that are missing a cache time. Configure a cache time so the browser doesn't need to download them every time. It will save " +
            util.formatBytes(saveSize) +
            ' the next access.'
          : ''
    };
  }
};