Merge 747ffa5 into 14c93db

Author: csabapalfi

README.md

@@ -7,23 +7,19 @@ Google PageSpeed Insights (PSI) score and metrics CLI
 
 ```
 $ npx pagespeed-score --runs 3 https://www.google.com
-fetchTime	score	FCP	FMP	SI	FCI	TTI
-00:15:25	96	0.9	1.0	1.0	3.1	3.7
-00:15:31	95	0.9	1.0	1.1	3.4	3.9
-00:15:38	96	0.9	1.0	1.0	3.2	3.7
-
-median  	96	0.9	1.0	1.0	3.2	3.7
-stddev  	0.6	0.0	0.0	0.1	0.2	0.1
-min     	95	0.9	1.0	1.0	3.1	3.7
-max     	96	0.9	1.0	1.1	3.4	3.9
+name  	score	FCP	FMP	SI	FCI	TTI
+run 1 	96	0.9	1.0	1.2	3.1	3.9
+run 2 	96	0.9	1.0	1.0	3.1	3.7
+run 3 	95	0.9	1.0	1.2	3.5	4.0
+
+median	96	0.9	1.0	1.2	3.1	3.9
+stddev	0.6	0.0	0.0	0.1	0.2	0.2
+min   	95	0.9	1.0	1.0	3.1	3.7
+max   	96	0.9	1.0	1.2	3.5	4.0
 ```
 
-Note: most pages have much higher variability in their score.
-
 ## Metrics
 
-* `fetchTime` is simply the time of the day (in UTC) when the run completed.
-
 * `score` is the PageSpeed score based on [LightHouse perfomance scoring](https://github.com/GoogleChrome/lighthouse/blob/master/docs/scoring.md) calculated using FCP, FMP, SI, FCI and TTI.
 
 * `FCP` is [First Contentful Paint](https://github.com/csabapalfi/awesome-web-performance-metrics#first-contentful-paint-fcp)
@@ -55,6 +51,8 @@ Output:
                                                       [boolean] [default: false]
   --saveAssets, --output.saveAssets  Save reports and traces
                                                       [boolean] [default: false]
+  --filePrefix, --output.filePrefix  Saved asset file prefix
+                                                          [string] [default: ""]
 
 Lighthouse:
   --local, --lighthouse.enabled             Switch to local Lighthouse

lib/cli-options.js

@@ -58,6 +58,13 @@ const options = {
     default: false,
     alias: 'output.saveAssets',
   },
+  filePrefix: {
+    type: 'string',
+    describe: 'Saved asset file prefix',
+    group: 'Output:',
+    default: '',
+    alias: 'output.filePrefix',
+  },
   local: {
     type: 'boolean',
     describe: 'Switch to local Lighthouse',

lib/counter.js

@@ -8,7 +8,8 @@ class Counter {
   next() {
     const run = ++this.run;
     return {
-      value: { 
+      value: {
+        index: run - this.warmupRuns,
         first: run === 1,
         warmup: run <= this.warmupRuns,
         last: run === this.maxRuns,

lib/fetcher.js

@@ -4,22 +4,22 @@ const {assetSaver} = require('./save-assets');
 const {resultMapper} = require('./map-result');
 
 class Fetcher {
-  constructor(url, metrics, lighthouse, saveAssets) {
+  constructor(url, metrics, lighthouse, output) {
     this.mapResult = resultMapper(metrics);
     this.getLighthouseResult = lighthouse.enabled ? 
       runLighthouse.bind(null, lighthouse, url) :
       runPagespeed.bind(null, url);
-    if (saveAssets) {
-      this.saveAssets = assetSaver(lighthouse.modulePath);
+    if (output.saveAssets) {
+      this.saveAssets = assetSaver(lighthouse.modulePath, output.filePrefix);
     }
   }
 
-  async getResult() {
+  async getResult(index) {
     const {result, artifacts} = await this.getLighthouseResult();
     if (this.saveAssets) {
-      await this.saveAssets(result, artifacts);
+      await this.saveAssets(index, result, artifacts);
     }
-    return this.mapResult(result);
+    return this.mapResult(index, result);
   }
 }
 

lib/formatter.js

@@ -1,13 +1,11 @@
 const {keys, entries} = Object;
 
-const identity = (x) => x;
 const precision = (digits) => (n) => n.toFixed(digits);
 
 const skip = ['type'];
 
 const formats = {
-  fetchTime: identity,
-  name: s => s.padEnd(8),
+  name: s => s.padEnd(6),
   score: precision(0),
   score_stddev: precision(1),
   FCP: precision(1),
@@ -21,7 +19,10 @@ const formats = {
 };
 
 function tableHeading(result) {
-  return keys(result).filter(k => !skip.includes(k)).join('\t');
+  return keys(result)
+    .filter(k => !skip.includes(k))
+    .map((k, index) => index === 0 ? k.padEnd(6) : k)
+    .join('\t');
 }
 
 function tsvFormatEntry(result) {

lib/get-stats.js

@@ -3,7 +3,7 @@ const {median, sampleStandardDeviation, min, max} =
 
 const {keys, entries} = Object;
 
-const noStats = ['type', 'fetchTime'];
+const noStats = ['type', 'name'];
 
 const statistics = {
   'median': median,

lib/main.js

@@ -6,11 +6,11 @@ const {Runner} = require('./runner');
 function main({
   runs, warmupRuns,
   url, metrics, lighthouse,
-  output: {saveAssets, jsonl}, 
+  output, 
 }) {
   const counter = new Counter(runs, warmupRuns);
-  const fetcher = new Fetcher(url, metrics, lighthouse, saveAssets);
-  const formatter = new Formatter(jsonl);
+  const fetcher = new Fetcher(url, metrics, lighthouse, output);
+  const formatter = new Formatter(output.jsonl);
   return new Runner(counter, fetcher, formatter);
 }
 

lib/map-result.js

@@ -1,4 +1,3 @@
-const {parse, format} = require('date-fns');
 const {round} = Math;
 const {entries} = Object;
 
@@ -14,10 +13,6 @@ const TTFB = {
   TTFB: 'time-to-first-byte',
 };
 
-function formatTime(value) {
-  return format(parse(value), 'HH:mm:ss');
-}
-
 function formatScore(value) {
   return parseInt(round(value * 100), 10);
 }
@@ -65,9 +60,9 @@ function mapMarkValue(mark) {
 function resultMapper(metrics) {
   const {userTimingMarks, ttfb, benchmark} = metrics;
 
-  return ({fetchTime, categories, environment, audits}) => ({
+  return (index, {categories, environment, audits}) => ({
     type: 'result',
-    fetchTime: formatTime(fetchTime),
+    name: `run ${index < 1 ? index - 1 : index}`,
     score: formatScore(categories.performance.score),
     ...mapAudits(audits, DEFAULT_METRICS, mapMetricValue),
     ...ttfb && mapAudits(audits, TTFB, mapTTFB),

lib/run-lighthouse.js

@@ -11,7 +11,7 @@ const getConfig = (modulePath) => ({
       'first-cpu-idle',
       'interactive',
       'time-to-first-byte',
-      'user-timings'
+      'user-timings',
     ]
   }
 });

lib/runner.js

@@ -15,7 +15,7 @@ class Runner {
       return Promise.resolve({done});
     }
 
-    const result = await fetcher.getResult();
+    const result = await fetcher.getResult(run.index);
 
     if (!run.warmup) {
       samples.push(result);