misc(proto): add i18n.icuMessagePaths (#13068)

GoogleChrome · Sep 15, 2021 · fa69d24 · fa69d24
1 parent 06bdf13
commit fa69d24
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/lighthouse-core/lib/proto-preprocessor.js b/lighthouse-core/lib/proto-preprocessor.js
@@ -16,10 +16,10 @@ const fs = require('fs');
  */
 
 /**
-  * Transform an LHR into a proto-friendly, mostly-compatible LHR.
-  * @param {LH.Result} lhr
-  * @return {LH.Result}
-  */
+ * Transform an LHR into a proto-friendly, mostly-compatible LHR.
+ * @param {LH.Result} lhr
+ * @return {LH.Result}
+ */
 function processForProto(lhr) {
   /** @type {LH.Result} */
   const reportJson = JSON.parse(JSON.stringify(lhr));
@@ -68,13 +68,8 @@ function processForProto(lhr) {
     });
   }
 
-  // Drop the i18n icuMessagePaths. Painful in proto, and low priority to expose currently.
-  if (reportJson.i18n && reportJson.i18n.icuMessagePaths) {
-    delete reportJson.i18n.icuMessagePaths;
-  }
-
-  // Remove any found empty strings, as they are dropped after round-tripping anyway
   /**
+   * Remove any found empty strings, as they are dropped after round-tripping anyway
    * @param {any} obj
    */
   function removeStrings(obj) {

diff --git a/proto/lighthouse-result.proto b/proto/lighthouse-result.proto
@@ -505,8 +505,13 @@ message I18n {
     string show_relevant_audits = 48;
   }
 
-  // The message holding all formatted strings
+  // The message holding all formatted strings used in the renderer.
   RendererFormattedStrings renderer_formatted_strings = 1;
+
+  // Holds all message paths used. The locale of the report has already be used to translated
+  // the strings in this LighthouseResult, but this field can be used to translate into another
+  // language.
+  map<string, google.protobuf.ListValue> icu_message_paths = 2;
 }
 
 // Message containing Stack Pack information.

diff --git a/types/lhr/lhr.d.ts b/types/lhr/lhr.d.ts
@@ -41,7 +41,11 @@ interface Result {
   /** Execution timings for the Lighthouse run */
   timing: Result.Timing;
   /** Strings for the report and the record of all formatted string locations in the LHR and their corresponding source values. */
-  i18n: {rendererFormattedStrings: Record<string, string>, icuMessagePaths?: Result.IcuMessagePaths};
+  i18n: {
+    rendererFormattedStrings: Record<string, string>;
+    /** Optional because LR has many old LHRs that return nothing for this property. */
+    icuMessagePaths?: Result.IcuMessagePaths;
+  };
   /** An array containing the result of all stack packs. */
   stackPacks?: Result.StackPack[];
 }