Modifications in response to change requests [WIP]

Strip out uneeded changes from prior commits on this branch.

Add `configIsSubmitAndUpload()` to lib/index.ts
Pass that fn to Sheets class.

Add null value `viwerUrl` to Metrics class return object to prevent undefined type errors in Sheets

#131

Author: David Benson

lib/index.ts

@@ -96,8 +96,8 @@ class PWMetrics {
         console.log(messages.getMessage('MEDIAN_RUN'));
         this.displayOutput(results.median);
       } else if (this.flags.submit) {
-        const sheets = new Sheets(this.sheets, this.clientSecret);
-        await sheets.appendResults(results.runs, this.flags.upload);
+        const sheets = new Sheets(this.sheets, this.clientSecret, this.configIsSubmitAndUpload);
+        await sheets.appendResults(results.runs);
       }
     }
 
@@ -207,7 +207,6 @@ class PWMetrics {
         const driveResponse = await upload(data, this.clientSecret);
 
         preparedData.fileId = driveResponse.id;
-        preparedData.fileName = driveResponse.name;
 
         this.view(driveResponse.id);
       }
@@ -235,6 +234,14 @@ class PWMetrics {
     return data;
   }
 
+  configIsSubmitAndUpload = (data: MetricsResults) => {
+    if(this.flags.submit && this.flags.upload) {
+      data.viewerUrl = getTimelineViewerUrl(data.fileId);
+    }
+
+    return data;
+  }
+
   showChart(data: MetricsResults) {
     // reverse to preserve the order, because cli-chart.
     let timings = data.timings;

lib/metrics.ts

@@ -90,12 +90,12 @@ function prepareData(res: LighthouseResults): MetricsResults {
 
   return {
     fileId: '',
-    fileName: '',
     timings,
     timestamps,
     generatedTime: res.generatedTime,
     lighthouseVersion: res.lighthouseVersion,
     initialUrl: res.initialUrl,
-    url: res.url
+    url: res.url,
+    viewerUrl: null
   };
 }

lib/sheets/index.ts

@@ -13,10 +13,9 @@ const metricsIds = require('../metrics').ids;
 const SHEET_TYPES = {
   'GOOGLE_SHEETS': 'GOOGLE_SHEETS'
 };
-const VIEWER_URL_PREFIX = 'https://chromedevtools.github.io/timeline-viewer/?loadTimelineFromURL=drive://';
 
 class Sheets {
-  constructor(public config: SheetsConfig, public clientSecret: AuthorizeCredentials) {
+  constructor(public config: SheetsConfig, public clientSecret: AuthorizeCredentials, public configIsSubmitAndUpload: Function) {
     this.validateOptions(config, clientSecret);
   }
 
@@ -39,23 +38,20 @@ class Sheets {
     }
   }
 
-  appendResults(results: Array<MetricsResults>, upload: boolean) {
+  appendResults(results: Array<MetricsResults>) {
     switch (this.config.type) {
       case SHEET_TYPES.GOOGLE_SHEETS:
-        return this.appendResultsToGSheets(results, upload);
+        return this.appendResultsToGSheets(results);
     }
   }
 
-  async appendResultsToGSheets(results: Array<MetricsResults>, upload: boolean) {
+  async appendResultsToGSheets(results: Array<MetricsResults>) {
     let valuesToAppend: Array<GSheetsValuesToAppend> = [];
     results.forEach(data => {
       const getTiming = (key: string) => data.timings.find(t => t.id === key).timing;
       const dateObj = new Date(data.generatedTime);
-      let viewerUrl = '';
 
-      if(upload && typeof data.fileId !== 'undefined') {
-          viewerUrl = VIEWER_URL_PREFIX + data.fileId;
-      }
+      data = this.configIsSubmitAndUpload(data);
 
       // order matters
       valuesToAppend.push([
@@ -70,7 +66,7 @@ class Sheets {
         getTiming(metricsIds.TTFI),
         getTiming(metricsIds.TTCI),
         getTiming(metricsIds.VC85),
-        viewerUrl
+        data.viewerUrl
       ]);
     });
 

types/types.ts

@@ -31,19 +31,19 @@ interface FeatureFlags {
   expectations: Boolean;
   output: Boolean;
   chromeFlags: Array<string>;
-  chromePath?: string
+  chromePath?: string;
   port?: number;
 }
 
 interface MetricsResults {
-  fileName: string,
   fileId: string,
   timestamps: Timestamp[];
   timings: Timing[];
   generatedTime: string;
   lighthouseVersion: string;
   url: string;
   initialUrl: string;
+  viewerUrl?: string;
 }
 
 interface PWMetricsResults {