feat: add scoringMode to AuditResult (#1967)

* feat: add scoringMode to AuditResult * switch to enum-style * caps-ify
GoogleChrome · Apr 5, 2017 · 17046b3 · 17046b3
1 parent 907d21a
commit 17046b3
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 0 deletions.
diff --git a/lighthouse-cli/types/types.ts b/lighthouse-cli/types/types.ts
@@ -19,6 +19,7 @@ interface AuditFullResult {
   displayValue: string;
   debugString?: string;
   score: boolean|number;
+  scoringMode: string;
   error?: boolean;
   description: string;
   name: string;

diff --git a/lighthouse-core/audits/audit.js b/lighthouse-core/audits/audit.js
@@ -26,6 +26,16 @@ class Audit {
     return DEFAULT_PASS;
   }
 
+  /**
+   * @return {{NUMERIC: string, BINARY: string}}
+   */
+  static get SCORING_MODES() {
+    return {
+      NUMERIC: 'numeric',
+      BINARY: 'binary',
+    };
+  }
+
   /**
    * @throws {Error}
    */
@@ -75,6 +85,7 @@ class Audit {
       debugString: result.debugString,
       optimalValue: result.optimalValue,
       extendedInfo: result.extendedInfo,
+      scoringMode: audit.meta.scoringMode || Audit.SCORING_MODES.BINARY,
       informative: audit.meta.informative,
       name: audit.meta.name,
       category: audit.meta.category,

diff --git a/lighthouse-core/audits/byte-efficiency/total-byte-weight.js b/lighthouse-core/audits/byte-efficiency/total-byte-weight.js
@@ -45,6 +45,7 @@ class TotalByteWeight extends Audit {
           'Network transfer size [costs users real dollars](https://whatdoesmysitecost.com/) ' +
           'and is [highly correlated](http://httparchive.org/interesting.php#onLoad) with long load times. ' +
           'Try to find ways to reduce the size of required files.',
+      scoringMode: Audit.SCORING_MODES.NUMERIC,
       requiredArtifacts: ['networkRecords']
     };
   }

diff --git a/lighthouse-core/audits/dobetterweb/dom-size.js b/lighthouse-core/audits/dobetterweb/dom-size.js
@@ -55,6 +55,7 @@ class DOMSize extends Audit {
         'children/parent element. A large DOM can increase memory, cause longer ' +
         '[style calculations](https://developers.google.com/web/fundamentals/performance/rendering/reduce-the-scope-and-complexity-of-style-calculations), ' +
         'and produce costly [layout reflows](https://developers.google.com/speed/articles/reflow). [Learn more](https://developers.google.com/web/fundamentals/performance/rendering/).',
+      scoringMode: Audit.SCORING_MODES.NUMERIC,
       requiredArtifacts: ['DOMStats']
     };
   }

diff --git a/lighthouse-core/audits/estimated-input-latency.js b/lighthouse-core/audits/estimated-input-latency.js
@@ -40,6 +40,7 @@ class EstimatedInputLatency extends Audit {
           'of latency, or less. 10% of the time a user can expect additional latency. If your ' +
           'score is higher than Lighthouse\'s target score, users may perceive your app as ' +
           'laggy. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/estimated-input-latency).',
+      scoringMode: Audit.SCORING_MODES.NUMERIC,
       requiredArtifacts: ['traces']
     };
   }

diff --git a/lighthouse-core/audits/first-meaningful-paint.js b/lighthouse-core/audits/first-meaningful-paint.js
@@ -39,6 +39,7 @@ class FirstMeaningfulPaint extends Audit {
       optimalValue: SCORING_POINT_OF_DIMINISHING_RETURNS.toLocaleString() + 'ms',
       helpText: 'First meaningful paint measures when the primary content of a page is visible. ' +
           '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/first-meaningful-paint).',
+      scoringMode: Audit.SCORING_MODES.NUMERIC,
       requiredArtifacts: ['traces']
     };
   }

diff --git a/lighthouse-core/audits/speed-index-metric.js b/lighthouse-core/audits/speed-index-metric.js
@@ -38,6 +38,7 @@ class SpeedIndexMetric extends Audit {
       helpText: 'Speed Index shows how quickly the contents of a page are visibly populated. ' +
           '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/speed-index).',
       optimalValue: SCORING_POINT_OF_DIMINISHING_RETURNS.toLocaleString(),
+      scoringMode: Audit.SCORING_MODES.NUMERIC,
       requiredArtifacts: ['traces']
     };
   }

diff --git a/lighthouse-core/audits/time-to-interactive.js b/lighthouse-core/audits/time-to-interactive.js
@@ -32,6 +32,7 @@ class TTIMetric extends Audit {
           'enough to interact with. ' +
           '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/time-to-interactive).',
       optimalValue: SCORING_TARGET.toLocaleString() + 'ms',
+      scoringMode: Audit.SCORING_MODES.NUMERIC,
       requiredArtifacts: ['traces']
     };
   }

diff --git a/lighthouse-core/closure/typedefs/AuditResult.js b/lighthouse-core/closure/typedefs/AuditResult.js
@@ -65,6 +65,9 @@ function AuditFullResult() {}
 /** @type {(boolean|number)} */
 AuditFullResult.prototype.score;
 
+/** @type {string} */
+AuditFullResult.prototype.scoringMode;
+
 /** @type {string} */
 AuditFullResult.prototype.displayValue;