core(runner): rename generatedTime to fetchedAt (#4783)

GoogleChrome · Mar 20, 2018 · 7a1fb93 · 7a1fb93
1 parent 5192079
commit 7a1fb93
Show file tree

Hide file tree

Showing 14 changed files with 20 additions and 18 deletions.
diff --git a/docs/understanding-results.md b/docs/understanding-results.md
@@ -11,7 +11,7 @@ The top-level Lighthouse Results object (LHR) is what the lighthouse node module
 | Name | Description |
 | - | - |
 | lighthouseVersion | The version of Lighthouse with which these results were generated. |
-| generatedTime | The ISO-8601 timestamp of when the results were generated. |
+| fetchedAt | The ISO-8601 timestamp of when the results were generated. |
 | userAgent | The user agent string of the version of Chrome that was used by Lighthouse. |
 | initialUrl | The URL that was supplied to Lighthouse and initially navigated to. |
 | url | The URL that Lighthouse ended up auditing after redirects were followed. |
@@ -26,7 +26,7 @@ The top-level Lighthouse Results object (LHR) is what the lighthouse node module
 ```json
 {
   "lighthouseVersion": "2.4.0",
-  "generatedTime": "2017-10-05T20:50:54.185Z",
+  "fetchedAt": "2017-10-05T20:50:54.185Z",
   "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3233.0 Safari/537.36",
   "initialUrl": "http://example.com",
   "url": "https://www.example.com/",

diff --git a/lighthouse-cli/test/cli/run-test.js b/lighthouse-cli/test/cli/run-test.js
@@ -33,7 +33,7 @@ describe('CLI run', function() {
       assert.equal(results.audits.viewport.rawValue, false);
 
       // passed results match saved results
-      assert.strictEqual(results.generatedTime, passedResults.generatedTime);
+      assert.strictEqual(results.fetchedAt, passedResults.fetchedAt);
       assert.strictEqual(results.url, passedResults.url);
       assert.strictEqual(results.audits.viewport.rawValue, passedResults.audits.viewport.rawValue);
       assert.strictEqual(

diff --git a/lighthouse-core/gather/gather-runner.js b/lighthouse-core/gather/gather-runner.js
@@ -104,6 +104,7 @@ class GatherRunner {
       .then(userAgent => {
         gathererResults.UserAgent = [userAgent];
         GatherRunner.warnOnHeadless(userAgent, gathererResults);
+        gathererResults.fetchedAt = [(new Date()).toJSON()];
       })
       .then(_ => driver.beginEmulation(options.flags))
       .then(_ => driver.enableRuntimeEvents())

diff --git a/lighthouse-core/lib/file-namer.js b/lighthouse-core/lib/file-namer.js
@@ -12,12 +12,12 @@
  * Generate a filenamePrefix of hostname_YYYY-MM-DD_HH-MM-SS
  * Date/time uses the local timezone, however Node has unreliable ICU
  * support, so we must construct a YYYY-MM-DD date format manually. :/
- * @param {{url: string, generatedTime: string}} results
+ * @param {{url: string, fetchedAt: string}} results
  * @return {string}
  */
 function getFilenamePrefix(results) {
   const hostname = new (URLConstructor || URL)(results.url).hostname;
-  const date = (results.generatedTime && new Date(results.generatedTime)) || new Date();
+  const date = (results.fetchedAt && new Date(results.fetchedAt)) || new Date();
 
   const timeStr = date.toLocaleTimeString('en-US', {hour12: false});
   const dateParts = date.toLocaleDateString('en-US', {

diff --git a/lighthouse-core/report/v2/renderer/report-renderer.js b/lighthouse-core/report/v2/renderer/report-renderer.js
@@ -57,7 +57,7 @@ class ReportRenderer {
   _renderReportHeader(report) {
     const header = this._dom.cloneTemplate('#tmpl-lh-heading', this._templateContext);
     this._dom.find('.lh-config__timestamp', header).textContent =
-        Util.formatDateTime(report.generatedTime);
+        Util.formatDateTime(report.fetchedAt);
     const url = this._dom.find('.lh-metadata__url', header);
     url.href = report.url;
     url.textContent = report.url;
@@ -85,7 +85,7 @@ class ReportRenderer {
     const footer = this._dom.cloneTemplate('#tmpl-lh-footer', this._templateContext);
     this._dom.find('.lh-footer__version', footer).textContent = report.lighthouseVersion;
     this._dom.find('.lh-footer__timestamp', footer).textContent =
-        Util.formatDateTime(report.generatedTime);
+        Util.formatDateTime(report.fetchedAt);
     return footer;
   }
 
@@ -252,6 +252,7 @@ ReportRenderer.GroupJSON; // eslint-disable-line no-unused-expressions
  * @typedef {{
  *     lighthouseVersion: string,
  *     userAgent: string,
+ *     fetchedAt: string,
  *     generatedTime: string,
  *     timing: {total: number},
  *     initialUrl: string,

diff --git a/lighthouse-core/report/v2/renderer/report-ui-features.js b/lighthouse-core/report/v2/renderer/report-ui-features.js
@@ -332,7 +332,7 @@ class ReportUIFeatures {
   _saveFile(blob) {
     const filename = getFilenamePrefix({
       url: this.json.url,
-      generatedTime: this.json.generatedTime,
+      fetchedAt: this.json.fetchedAt,
     });
 
     const ext = blob.type.match('json') ? '.json' : '.html';

diff --git a/lighthouse-core/runner.js b/lighthouse-core/runner.js
@@ -105,11 +105,11 @@ class Runner {
         Runner._scoreAndCategorize(opts, resultsById);
         categories = Object.values(opts.config.categories);
       }
-
       return {
         userAgent: runResults.artifacts.UserAgent,
         lighthouseVersion: require('../package').version,
-        generatedTime: (new Date()).toJSON(),
+        fetchedAt: runResults.artifacts.fetchedAt,
+        generatedTime: 'Please use .fetchedAt instead',
         initialUrl: opts.initialUrl,
         url: opts.url,
         runWarnings: lighthouseRunWarnings,

diff --git a/lighthouse-core/test/fixtures/dbw_tester-perf-results.json b/lighthouse-core/test/fixtures/dbw_tester-perf-results.json
@@ -1,7 +1,7 @@
 {
   "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5 Build/MRA58N) AppleWebKit/537.36(KHTML, like Gecko) Chrome/59.0.3033.0 Mobile Safari/537.36",
   "lighthouseVersion": "2.0.0-alpha.4",
-  "generatedTime": "2017-05-11T17:17:14.282Z",
+  "fetchedAt": "2017-05-11T17:17:14.282Z",
   "initialUrl": "http://localhost:10200/dobetterweb/dbw_tester.html",
   "url": "http://localhost:10200/dobetterweb/dbw_tester.html",
   "audits": {

diff --git a/lighthouse-core/test/index-test.js b/lighthouse-core/test/index-test.js
@@ -101,7 +101,7 @@ describe('Module Tests', function() {
       }],
     }).then(results => {
       assert.ok(results.lighthouseVersion);
-      assert.ok(results.generatedTime);
+      assert.ok(results.fetchedAt);
       assert.equal(results.url, exampleUrl);
       assert.equal(results.initialUrl, exampleUrl);
       assert.ok(Array.isArray(results.reportCategories));

diff --git a/lighthouse-core/test/lib/file-namer-test.js b/lighthouse-core/test/lib/file-namer-test.js
@@ -13,7 +13,7 @@ describe('file-namer helper', () => {
   it('generates filename prefixes', () => {
     const results = {
       url: 'https://testexample.com',
-      generatedTime: '2017-01-06T02:34:56.217Z',
+      fetchedAt: '2017-01-06T02:34:56.217Z',
     };
     const str = getFilenamePrefix(results);
     // we want the filename to match user timezone, however these tests will run on multiple TZs

diff --git a/lighthouse-core/test/results/sample_v2.json b/lighthouse-core/test/results/sample_v2.json
@@ -1,7 +1,7 @@
 {
   "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3358.0 Safari/537.36",
   "lighthouseVersion": "2.9.1",
-  "generatedTime": "2018-03-13T00:55:45.840Z",
+  "fetchedAt": "2018-03-13T00:55:45.840Z",
   "initialUrl": "http://localhost:10200/dobetterweb/dbw_tester.html",
   "url": "http://localhost:10200/dobetterweb/dbw_tester.html",
   "runWarnings": [],

diff --git a/lighthouse-core/test/runner-test.js b/lighthouse-core/test/runner-test.js
@@ -422,7 +422,7 @@ describe('Runner', () => {
 
     return Runner.run(null, {url, config, driverMock}).then(results => {
       assert.ok(results.lighthouseVersion);
-      assert.ok(results.generatedTime);
+      assert.ok(results.fetchedAt);
       assert.equal(results.initialUrl, url);
       assert.equal(gatherRunnerRunSpy.called, true, 'GatherRunner.run was not called');
       assert.equal(results.audits['content-width'].name, 'content-width');
@@ -452,7 +452,7 @@ describe('Runner', () => {
 
     return Runner.run(null, {url, config, driverMock}).then(results => {
       assert.ok(results.lighthouseVersion);
-      assert.ok(results.generatedTime);
+      assert.ok(results.fetchedAt);
       assert.equal(results.initialUrl, url);
       assert.equal(gatherRunnerRunSpy.called, true, 'GatherRunner.run was not called');
       assert.equal(results.audits['content-width'].name, 'content-width');

diff --git a/lighthouse-viewer/app/src/github-api.js b/lighthouse-viewer/app/src/github-api.js
@@ -37,7 +37,7 @@ class GithubApi {
       .then(accessToken => {
         const filename = getFilenamePrefix({
           url: jsonFile.url,
-          generatedTime: jsonFile.generatedTime,
+          fetchedAt: jsonFile.fetchedAt,
         });
         const body = {
           description: 'Lighthouse json report',

diff --git a/typings/externs.d.ts b/typings/externs.d.ts
@@ -43,7 +43,7 @@ declare global {
       lighthouseVersion: string;
       artifacts?: Object;
       initialUrl: string;
-      generatedTime: string;
+      fetchedAt: string;
     }
 
     export interface LaunchedChrome {