i18n: use IcuMessage objects instead of string IDs

GoogleChrome · Apr 23, 2020 · 8f6a4cc · 8f6a4cc
1 parent 30cc954
commit 8f6a4cc
Show file tree

Hide file tree

Showing 47 changed files with 424 additions and 309 deletions.
diff --git a/clients/test/extension/settings-controller-test.js b/clients/test/extension/settings-controller-test.js
@@ -8,14 +8,18 @@
 /* eslint-env jest */
 
 const SettingsController = require('../../extension/scripts/settings-controller.js');
-const Config = require('../../../lighthouse-core/config/config.js');
 const defaultConfig = require('../../../lighthouse-core/config/default-config.js');
 const i18n = require('../../../lighthouse-core/lib/i18n/i18n.js');
 
 describe('Lighthouse chrome extension SettingsController', () => {
   it('default categories should be correct', () => {
-    const categories = Config.getCategories(defaultConfig);
-    categories.forEach(cat => cat.title = i18n.getFormatted(cat.title, 'en-US'));
+    const categories = Object.entries(defaultConfig.categories)
+      .map(([id, category]) => {
+        return {
+          id,
+          title: i18n.getFormatted(category.title, 'en-US'),
+        };
+      });
     expect(SettingsController.DEFAULT_CATEGORIES).toEqual(categories);
   });
 });
diff --git a/lighthouse-cli/run.js b/lighthouse-cli/run.js
@@ -20,7 +20,7 @@ const assetSaver = require('../lighthouse-core/lib/asset-saver.js');
 
 const open = require('open');
 
-/** @typedef {import('../lighthouse-core/lib/lh-error.js')} LighthouseError */
+/** @typedef {Error & {code: string, friendlyMessage?: string}} ExitError */
 
 const _RUNTIME_ERROR_CODE = 1;
 const _PROTOCOL_TIMEOUT_EXIT_CODE = 67;
@@ -91,7 +91,7 @@ function printProtocolTimeoutErrorAndExit() {
 }
 
 /**
- * @param {LighthouseError} err
+ * @param {ExitError} err
  * @return {never}
  */
 function printRuntimeErrorAndExit(err) {
@@ -103,7 +103,7 @@ function printRuntimeErrorAndExit(err) {
 }
 
 /**
- * @param {LighthouseError} err
+ * @param {ExitError} err
  * @return {never}
  */
 function printErrorAndExit(err) {
@@ -224,7 +224,6 @@ async function runLighthouse(url, flags, config) {
       return printErrorAndExit({
         name: 'LHError',
         friendlyMessage: runtimeError.message,
-        lhrRuntimeError: true,
         code: runtimeError.code,
         message: runtimeError.message,
       });

diff --git a/lighthouse-core/audits/audit.js b/lighthouse-core/audits/audit.js
@@ -222,8 +222,8 @@ class Audit {
 
   /**
    * @param {typeof Audit} audit
-   * @param {string} errorMessage
-   * @return {LH.Audit.Result}
+   * @param {string | LH.IcuMessage} errorMessage
+   * @return {LH.Icu<LH.Audit.Result>}
    */
   static generateErrorAuditResult(audit, errorMessage) {
     return Audit.generateAuditResult(audit, {
@@ -235,7 +235,7 @@ class Audit {
   /**
    * @param {typeof Audit} audit
    * @param {LH.Audit.Product} product
-   * @return {LH.Audit.Result}
+   * @return {LH.Icu<LH.Audit.Result>}
    */
   static generateAuditResult(audit, product) {
     if (product.score === undefined) {

diff --git a/lighthouse-core/audits/byte-efficiency/byte-efficiency-audit.js b/lighthouse-core/audits/byte-efficiency/byte-efficiency-audit.js
@@ -29,9 +29,9 @@ const WASTED_MS_FOR_SCORE_OF_ZERO = 5000;
  * @property {Array<LH.Audit.ByteEfficiencyItem>} items
  * @property {Map<string, number>=} wastedBytesByUrl
  * @property {LH.Audit.Details.Opportunity['headings']} headings
- * @property {string} [displayValue]
- * @property {string} [explanation]
- * @property {Array<string>} [warnings]
+ * @property {LH.IcuMessage} [displayValue]
+ * @property {LH.IcuMessage} [explanation]
+ * @property {Array<string | LH.IcuMessage>} [warnings]
  */
 
 /**

diff --git a/lighthouse-core/audits/byte-efficiency/render-blocking-resources.js b/lighthouse-core/audits/byte-efficiency/render-blocking-resources.js
@@ -208,7 +208,7 @@ class RenderBlockingResources extends Audit {
   static async audit(artifacts, context) {
     const {results, wastedMs} = await RenderBlockingResources.computeResults(artifacts, context);
 
-    let displayValue = '';
+    let displayValue;
     if (results.length > 0) {
       displayValue = str_(i18n.UIStrings.displayValueMsSavings, {wastedMs});
     }

diff --git a/lighthouse-core/audits/content-width.js b/lighthouse-core/audits/content-width.js
@@ -59,7 +59,7 @@ class ContentWidth extends Audit {
       };
     }
 
-    let explanation = '';
+    let explanation;
     if (!widthsMatch) {
       explanation = str_(UIStrings.explanation,
         {innerWidth: artifacts.ViewportDimensions.innerWidth,

diff --git a/lighthouse-core/audits/deprecations.js b/lighthouse-core/audits/deprecations.js
@@ -87,7 +87,7 @@ class Deprecations extends Audit {
     ];
     const details = Audit.makeTableDetails(headings, deprecations);
 
-    let displayValue = '';
+    let displayValue;
     if (deprecations.length > 0) {
       displayValue = str_(UIStrings.displayValue, {itemCount: deprecations.length});
     }

diff --git a/lighthouse-core/audits/dobetterweb/external-anchors-use-rel-noopener.js b/lighthouse-core/audits/dobetterweb/external-anchors-use-rel-noopener.js
@@ -49,7 +49,7 @@ class ExternalAnchorsUseRelNoopenerAudit extends Audit {
    * @return {LH.Audit.Product}
    */
   static audit(artifacts) {
-    /** @type {string[]} */
+    /** @type {LH.IcuMessage[]} */
     const warnings = [];
     const pageHost = new URL(artifacts.URL.finalUrl).host;
     const failingAnchors = artifacts.AnchorElements

diff --git a/lighthouse-core/audits/dobetterweb/no-vulnerable-libraries.js b/lighthouse-core/audits/dobetterweb/no-vulnerable-libraries.js
@@ -52,15 +52,15 @@ const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 const SEMVER_REGEX = /^(\d+\.\d+\.\d+)[^-0-9]+/;
 
-/** @type {Object<string, string>} */
+/** @type {Record<string, LH.IcuMessage>} */
 const rowMap = {
   'low': str_(UIStrings.rowSeverityLow),
   'medium': str_(UIStrings.rowSeverityMedium),
   'high': str_(UIStrings.rowSeverityHigh),
 };
 
 /** @typedef {{npm: Object<string, Array<{id: string, severity: string, semver: {vulnerable: Array<string>}}>>}} SnykDB */
-/** @typedef {{severity: string, numericSeverity: number, library: string, url: string}} Vulnerability */
+/** @typedef {{severity: LH.IcuMessage, numericSeverity: number, library: string, url: string}} Vulnerability */
 
 class NoVulnerableLibrariesAudit extends Audit {
   /**
@@ -158,7 +158,7 @@ class NoVulnerableLibrariesAudit extends Audit {
 
   /**
    * @param {Array<Vulnerability>} vulnerabilities
-   * @return {string}
+   * @return {LH.IcuMessage}
    */
   static highestSeverity(vulnerabilities) {
     const sortedVulns = vulnerabilities
@@ -181,7 +181,7 @@ class NoVulnerableLibrariesAudit extends Audit {
     }
 
     let totalVulns = 0;
-    /** @type {Array<{highestSeverity: string, vulnCount: number, detectedLib: LH.Audit.Details.LinkValue}>} */
+    /** @type {Array<{highestSeverity: LH.IcuMessage, vulnCount: number, detectedLib: LH.Audit.Details.LinkValue}>} */
     const vulnerabilityResults = [];
 
     const libraryVulns = foundLibraries.map(lib => {
@@ -214,7 +214,7 @@ class NoVulnerableLibrariesAudit extends Audit {
       };
     });
 
-    let displayValue = '';
+    let displayValue;
     if (totalVulns > 0) {
       displayValue = str_(UIStrings.displayValue, {itemCount: totalVulns});
     }

diff --git a/lighthouse-core/audits/dobetterweb/uses-http2.js b/lighthouse-core/audits/dobetterweb/uses-http2.js
@@ -81,7 +81,7 @@ class UsesHTTP2Audit extends Audit {
         return true;
       });
 
-      let displayValue = '';
+      let displayValue;
       if (resources.length > 0) {
         displayValue = str_(UIStrings.displayValue, {itemCount: resources.length});
       }

diff --git a/lighthouse-core/audits/image-aspect-ratio.js b/lighthouse-core/audits/image-aspect-ratio.js
@@ -56,7 +56,7 @@ class ImageAspectRatio extends Audit {
 
   /**
    * @param {WellDefinedImage} image
-   * @return {Error|{url: string, displayedAspectRatio: string, actualAspectRatio: string, doRatiosMatch: boolean}}
+   * @return {LH.IcuMessage|{url: string, displayedAspectRatio: string, actualAspectRatio: string, doRatiosMatch: boolean}}
    */
   static computeAspectRatios(image) {
     const url = URL.elideDataURI(image.src);
@@ -68,7 +68,7 @@ class ImageAspectRatio extends Audit {
 
     if (!Number.isFinite(actualAspectRatio) ||
       !Number.isFinite(displayedAspectRatio)) {
-      return new Error(str_(UIStrings.warningCompute, {url}));
+      return str_(UIStrings.warningCompute, {url});
     }
 
     return {
@@ -88,7 +88,7 @@ class ImageAspectRatio extends Audit {
   static audit(artifacts) {
     const images = artifacts.ImageElements;
 
-    /** @type {string[]} */
+    /** @type {LH.IcuMessage[]} */
     const warnings = [];
     /** @type {Array<{url: string, displayedAspectRatio: string, actualAspectRatio: string, doRatiosMatch: boolean}>} */
     const results = [];
@@ -109,8 +109,8 @@ class ImageAspectRatio extends Audit {
     }).forEach(image => {
       const wellDefinedImage = /** @type {WellDefinedImage} */ (image);
       const processed = ImageAspectRatio.computeAspectRatios(wellDefinedImage);
-      if (processed instanceof Error) {
-        warnings.push(processed.message);
+      if (i18n.isIcuMessage(processed)) {
+        warnings.push(processed);
         return;
       }
 

diff --git a/lighthouse-core/audits/is-on-https.js b/lighthouse-core/audits/is-on-https.js
@@ -74,7 +74,7 @@ class HTTPS extends Audit {
 
       const items = Array.from(new Set(insecureURLs)).map(url => ({url}));
 
-      let displayValue = '';
+      let displayValue;
       if (items.length > 0) {
         displayValue = str_(UIStrings.displayValue, {itemCount: items.length});
       }

diff --git a/lighthouse-core/audits/load-fast-enough-for-pwa.js b/lighthouse-core/audits/load-fast-enough-for-pwa.js
@@ -84,9 +84,7 @@ class LoadFastEnough4Pwa extends Audit {
 
     const score = Number(tti.timing < MAXIMUM_TTI);
 
-    /** @type {string|undefined} */
     let displayValue;
-    /** @type {string|undefined} */
     let explanation;
     if (!score) {
       displayValue = str_(displayValueTemplate, {timeInMs: tti.timing});

diff --git a/lighthouse-core/audits/offline-start-url.js b/lighthouse-core/audits/offline-start-url.js
@@ -65,6 +65,7 @@ class OfflineStartUrl extends Audit {
     // The StartUrl artifact provides no explanation if a response was received from a service
     // worker with a non-200 status code. In that case, this audit provides its own explanation.
     // In all other cases it defers to the artifact explanation.
+    /** @type {string|LH.IcuMessage|undefined} */
     let explanation = artifacts.StartUrl.explanation;
     if (!explanation && artifacts.StartUrl.statusCode !== -1 && !hasOfflineStartUrl) {
       explanation = str_(UIStrings.errorLoading, {

diff --git a/lighthouse-core/audits/performance-budget.js b/lighthouse-core/audits/performance-budget.js
@@ -27,7 +27,7 @@ const UIStrings = {
 const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 /** @typedef {{count: number, size: number}} ResourceEntry */
-/** @typedef {{resourceType: LH.Budget.ResourceType, label: string, requestCount: number, size: number, sizeOverBudget: number | undefined, countOverBudget: string | undefined}} BudgetItem */
+/** @typedef {{resourceType: LH.Budget.ResourceType, label: LH.IcuMessage, requestCount: number, size: number, sizeOverBudget: number | undefined, countOverBudget: LH.IcuMessage | undefined}} BudgetItem */
 
 class ResourceBudget extends Audit {
   /**

diff --git a/lighthouse-core/audits/resource-summary.js b/lighthouse-core/audits/resource-summary.js
@@ -55,7 +55,7 @@ class ResourceSummary extends Audit {
     ];
 
 
-    /** @type {Record<LH.Budget.ResourceType,string>} */
+    /** @type {Record<LH.Budget.ResourceType, LH.IcuMessage>} */
     const strMappings = {
       'total': str_(i18n.UIStrings.totalResourceType),
       'document': str_(i18n.UIStrings.documentResourceType),

diff --git a/lighthouse-core/audits/service-worker.js b/lighthouse-core/audits/service-worker.js
@@ -97,7 +97,7 @@ class ServiceWorker extends Audit {
    * contolled by the scopeUrl.
    * @param {LH.Artifacts['WebAppManifest']} WebAppManifest
    * @param {string} scopeUrl
-   * @return {string|undefined}
+   * @return {LH.IcuMessage|undefined}
    */
   static checkStartUrl(WebAppManifest, scopeUrl) {
     if (!WebAppManifest) {

diff --git a/lighthouse-core/audits/timing-budget.js b/lighthouse-core/audits/timing-budget.js
@@ -24,7 +24,7 @@ const UIStrings = {
 
 const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
-/** @typedef {{metric: LH.Budget.TimingMetric, label: string, measurement?: number, overBudget?: number}} BudgetItem */
+/** @typedef {{metric: LH.Budget.TimingMetric, label: LH.IcuMessage, measurement?: number, overBudget?: number}} BudgetItem */
 
 class TimingBudget extends Audit {
   /**
@@ -42,7 +42,7 @@ class TimingBudget extends Audit {
 
   /**
    * @param {LH.Budget.TimingMetric} timingMetric
-   * @return {string}
+   * @return {LH.IcuMessage}
    */
   static getRowLabel(timingMetric) {
     /** @type {Record<LH.Budget.TimingMetric, string>} */

diff --git a/lighthouse-core/audits/user-timings.js b/lighthouse-core/audits/user-timings.js
@@ -103,7 +103,6 @@ class UserTimings extends Audit {
 
       const details = Audit.makeTableDetails(headings, tableRows);
 
-      /** @type {string|undefined} */
       let displayValue;
       if (userTimings.length) {
         displayValue = str_(UIStrings.displayValue, {itemCount: userTimings.length});

diff --git a/lighthouse-core/audits/uses-rel-preconnect.js b/lighthouse-core/audits/uses-rel-preconnect.js
@@ -97,7 +97,7 @@ class UsesRelPreconnectAudit extends Audit {
     const devtoolsLog = artifacts.devtoolsLogs[UsesRelPreconnectAudit.DEFAULT_PASS];
     const settings = context.settings;
     let maxWasted = 0;
-    /** @type {string[]} */
+    /** @type {Array<LH.IcuMessage>} */
     const warnings = [];
 
     const [networkRecords, mainResource, loadSimulator] = await Promise.all([

diff --git a/lighthouse-core/audits/uses-rel-preload.js b/lighthouse-core/audits/uses-rel-preload.js
@@ -208,7 +208,7 @@ class UsesRelPreloadAudit extends Audit {
     // sort results by wastedTime DESC
     results.sort((a, b) => b.wastedMs - a.wastedMs);
 
-    /** @type {Array<string>|undefined} */
+    /** @type {Array<LH.IcuMessage>|undefined} */
     let warnings;
     const failedURLs = UsesRelPreloadAudit.getURLsFailedToPreload(graph);
     if (failedURLs.size) {

diff --git a/lighthouse-core/config/config-helpers.js b/lighthouse-core/config/config-helpers.js
@@ -8,6 +8,7 @@
 const path = require('path');
 const Audit = require('../audits/audit.js');
 const Runner = require('../runner.js');
+const i18n = require('../lib/i18n/i18n.js');
 
 /**
  * If any items with identical `path` properties are found in the input array,
@@ -34,6 +35,14 @@ const mergeOptionsOfItems = function(items) {
   return mergedItems;
 };
 
+/**
+ * @param {unknown} value
+ * @return {value is string|LH.IcuMessage}
+ */
+function isStringOrIcuMessage(value) {
+  return typeof value === 'string' || i18n.isIcuMessage(value);
+}
+
 /**
  * Throws an error if the provided object does not implement the required properties of an audit
  * definition.
@@ -53,19 +62,19 @@ function assertValidAudit(auditDefinition) {
     throw new Error(`${auditName} has no meta.id property, or the property is not a string.`);
   }
 
-  if (typeof implementation.meta.title !== 'string') {
+  if (!isStringOrIcuMessage(implementation.meta.title)) {
     throw new Error(`${auditName} has no meta.title property, or the property is not a string.`);
   }
 
   // If it'll have a ✔ or ✖ displayed alongside the result, it should have failureTitle
   if (
-    typeof implementation.meta.failureTitle !== 'string' &&
+    !isStringOrIcuMessage(implementation.meta.failureTitle) &&
     implementation.meta.scoreDisplayMode === Audit.SCORING_MODES.BINARY
   ) {
     throw new Error(`${auditName} has no failureTitle and should.`);
   }
 
-  if (typeof implementation.meta.description !== 'string') {
+  if (!isStringOrIcuMessage(implementation.meta.description)) {
     throw new Error(
       `${auditName} has no meta.description property, or the property is not a string.`
     );

diff --git a/lighthouse-core/config/config.js b/lighthouse-core/config/config.js
@@ -395,7 +395,7 @@ class Config {
     }
 
     // Printed config is more useful with localized strings.
-    i18n.replaceIcuMessageInstanceIds(jsonConfig, jsonConfig.settings.locale);
+    i18n.replaceIcuMessages(jsonConfig, jsonConfig.settings.locale);
 
     return JSON.stringify(jsonConfig, null, 2);
   }
@@ -664,22 +664,6 @@ class Config {
     return {categories, requestedAuditNames: includedAudits};
   }
 
-  /**
-   * @param {LH.Config.Json} config
-   * @return {Array<{id: string, title: string}>}
-   */
-  static getCategories(config) {
-    const categories = config.categories;
-    if (!categories) {
-      return [];
-    }
-
-    return Object.keys(categories).map(id => {
-      const title = categories[id].title;
-      return {id, title};
-    });
-  }
-
   /**
    * From some requested audits, return names of all required and optional artifacts
    * @param {Config['audits']} audits