core: remove last debugString references

lighthouse-core/audits/webapp-install-banner.js

@@ -104,14 +104,13 @@ class WebappInstallBanner extends MultiCheckAudit {
 
     if (!hasOfflineStartUrl) {
       failures.push('Service worker does not successfully serve the manifest\'s start_url');
-      // TODO(phulce): align gatherer `debugString` with `explanation`
-      if (artifacts.StartUrl.debugString) {
-        failures.push(artifacts.StartUrl.debugString);
+      if (artifacts.StartUrl.explanation) {
+        failures.push(artifacts.StartUrl.explanation);
       }
     }
 
-    if (artifacts.StartUrl.debugString) {
-      warnings.push(artifacts.StartUrl.debugString);
+    if (artifacts.StartUrl.explanation) {
+      warnings.push(artifacts.StartUrl.explanation);
     }
 
     return {failures, warnings};

lighthouse-core/gather/gatherers/manifest.js

@@ -19,7 +19,7 @@ const BOM_FIRSTCHAR = 65279;
 class Manifest extends Gatherer {
   /**
    * Returns the parsed manifest or null if the page had no manifest. If the manifest
-   * was unparseable as JSON, manifest.value will be undefined and manifest.debugString
+   * was unparseable as JSON, manifest.value will be undefined and manifest.explanation
    * will have the reason. See manifest-parser.js for more information.
    * @param {LH.Gatherer.PassContext} passContext
    * @return {Promise<LH.Artifacts['Manifest']>}

lighthouse-core/gather/gatherers/start-url.js

@@ -24,23 +24,23 @@ class StartUrl extends Gatherer {
       .then(manifest => {
         const startUrlInfo = this._readManifestStartUrl(manifest);
         if (startUrlInfo.isReadFailure) {
-          return {statusCode: -1, debugString: startUrlInfo.reason};
+          return {statusCode: -1, explanation: startUrlInfo.reason};
         }
 
         return this._attemptManifestFetch(passContext.driver, startUrlInfo.startUrl);
       }).catch(() => {
-        return {statusCode: -1, debugString: 'Unable to fetch start URL via service worker'};
+        return {statusCode: -1, explanation: 'Unable to fetch start URL via service worker'};
       });
   }
 
   /**
    * Read the parsed manifest and return failure reasons or the startUrl
-   * @param {?{value?: {start_url: {value?: string, debugString?: string}}, debugString?: string}} manifest
+   * @param {?{value?: {start_url: {value?: string, explanation?: string}}, explanation?: string}} manifest
    * @return {{isReadFailure: true, reason: string}|{isReadFailure: false, startUrl: string}}
    */
   _readManifestStartUrl(manifest) {
     if (!manifest || !manifest.value) {
-      const detailedMsg = manifest && manifest.debugString;
+      const detailedMsg = manifest && manifest.explanation;
 
       if (detailedMsg) {
         return {isReadFailure: true, reason: `Error fetching web app manifest: ${detailedMsg}`};
@@ -50,12 +50,12 @@ class StartUrl extends Gatherer {
     }
 
     // Even if the start URL had an error, the browser will still supply a fallback URL.
-    // Therefore, we only set the debugString here and continue with the fetch.
-    if (manifest.value.start_url.debugString) {
-      return {isReadFailure: true, reason: manifest.value.start_url.debugString};
+    // Therefore, we only set the explanation here and continue with the fetch.
+    if (manifest.value.start_url.explanation) {
+      return {isReadFailure: true, reason: manifest.value.start_url.explanation};
     }
 
-    // @ts-ignore - TODO(bckenny): should actually be testing value above, not debugString
+    // @ts-ignore - TODO(bckenny): should actually be testing value above, not explanation
     return {isReadFailure: false, startUrl: manifest.value.start_url.value};
   }
 
@@ -64,13 +64,13 @@ class StartUrl extends Gatherer {
    * Resolves when we have a matched network request
    * @param {Driver} driver
    * @param {string} startUrl
-   * @return {Promise<{statusCode: number, debugString: string}>}
+   * @return {Promise<{statusCode: number, explanation: string}>}
    */
   _attemptManifestFetch(driver, startUrl) {
     // Wait up to 3s to get a matched network request from the fetch() to work
     const timeoutPromise = new Promise(resolve =>
       setTimeout(
-        () => resolve({statusCode: -1, debugString: 'Timed out waiting for fetched start_url'}),
+        () => resolve({statusCode: -1, explanation: 'Timed out waiting for fetched start_url'}),
         3000
       )
     );
@@ -88,7 +88,7 @@ class StartUrl extends Gatherer {
         if (!response.fromServiceWorker) {
           return resolve({
             statusCode: -1,
-            debugString: 'Unable to fetch start URL via service worker',
+            explanation: 'Unable to fetch start URL via service worker',
           });
         }
         // Successful SW-served fetch of the start_URL

lighthouse-core/lib/manifest-parser.js

@@ -37,21 +37,21 @@ const ALLOWED_ORIENTATION_VALUES = [
  */
 function parseString(raw, trim) {
   let value;
-  let debugString;
+  let explanation;
 
   if (typeof raw === 'string') {
     value = trim ? raw.trim() : raw;
   } else {
     if (raw !== undefined) {
-      debugString = 'ERROR: expected a string.';
+      explanation = 'ERROR: expected a string.';
     }
     value = undefined;
   }
 
   return {
     raw,
     value,
-    debugString,
+    explanation,
   };
 }
 
@@ -70,7 +70,7 @@ function parseColor(raw) {
   const validatedColor = validateColor(color.raw);
   if (!validatedColor) {
     color.value = undefined;
-    color.debugString = 'ERROR: color parsing failed.';
+    color.explanation = 'ERROR: color parsing failed.';
   }
 
   return color;
@@ -117,7 +117,7 @@ function parseStartUrl(jsonInput, manifestUrl, documentUrl) {
     return {
       raw,
       value: documentUrl,
-      debugString: 'ERROR: start_url string empty',
+      explanation: 'ERROR: start_url string empty',
     };
   }
   const parsedAsString = parseString(raw);
@@ -135,7 +135,7 @@ function parseStartUrl(jsonInput, manifestUrl, documentUrl) {
     return {
       raw,
       value: documentUrl,
-      debugString: 'ERROR: invalid start_url relative to ${manifestUrl}',
+      explanation: 'ERROR: invalid start_url relative to ${manifestUrl}',
     };
   }
 
@@ -144,7 +144,7 @@ function parseStartUrl(jsonInput, manifestUrl, documentUrl) {
     return {
       raw,
       value: documentUrl,
-      debugString: 'ERROR: start_url must be same-origin as document',
+      explanation: 'ERROR: start_url must be same-origin as document',
     };
   }
 
@@ -165,7 +165,7 @@ function parseDisplay(jsonInput) {
     return {
       raw: jsonInput,
       value: DEFAULT_DISPLAY_MODE,
-      debugString: parsedString.debugString,
+      explanation: parsedString.explanation,
     };
   }
 
@@ -174,15 +174,15 @@ function parseDisplay(jsonInput) {
     return {
       raw: jsonInput,
       value: DEFAULT_DISPLAY_MODE,
-      debugString: 'ERROR: \'display\' has invalid value ' + displayValue +
+      explanation: 'ERROR: \'display\' has invalid value ' + displayValue +
         `. will fall back to ${DEFAULT_DISPLAY_MODE}.`,
     };
   }
 
   return {
     raw: jsonInput,
     value: displayValue,
-    debugString: undefined,
+    explanation: undefined,
   };
 }
 
@@ -195,7 +195,7 @@ function parseOrientation(jsonInput) {
   if (orientation.value &&
       !ALLOWED_ORIENTATION_VALUES.includes(orientation.value.toLowerCase())) {
     orientation.value = undefined;
-    orientation.debugString = 'ERROR: \'orientation\' has an invalid value, will be ignored.';
+    orientation.explanation = 'ERROR: \'orientation\' has an invalid value, will be ignored.';
   }
 
   return orientation;
@@ -223,13 +223,13 @@ function parseIcon(raw, manifestUrl) {
     raw: raw.density,
     value: 1,
     /** @type {string|undefined} */
-    debugString: undefined,
+    explanation: undefined,
   };
   if (density.raw !== undefined) {
     density.value = parseFloat(density.raw);
     if (isNaN(density.value) || !isFinite(density.value) || density.value <= 0) {
       density.value = 1;
-      density.debugString = 'ERROR: icon density cannot be NaN, +∞, or less than or equal to +0.';
+      density.explanation = 'ERROR: icon density cannot be NaN, +∞, or less than or equal to +0.';
     }
   }
 
@@ -242,7 +242,7 @@ function parseIcon(raw, manifestUrl) {
     sizes = {
       raw: raw.sizes,
       value: set.size > 0 ? Array.from(set) : undefined,
-      debugString: undefined,
+      explanation: undefined,
     };
   } else {
     sizes = {...parsedSizes, value: undefined};
@@ -256,7 +256,7 @@ function parseIcon(raw, manifestUrl) {
       density,
       sizes,
     },
-    debugString: undefined,
+    explanation: undefined,
   };
 }
 
@@ -272,7 +272,7 @@ function parseIcons(jsonInput, manifestUrl) {
       raw,
       /** @type {Array<ReturnType<typeof parseIcon>>} */
       value: [],
-      debugString: undefined,
+      explanation: undefined,
     };
   }
 
@@ -281,7 +281,7 @@ function parseIcons(jsonInput, manifestUrl) {
       raw,
       /** @type {Array<ReturnType<typeof parseIcon>>} */
       value: [],
-      debugString: 'ERROR: \'icons\' expected to be an array but is not.',
+      explanation: 'ERROR: \'icons\' expected to be an array but is not.',
     };
   }
 
@@ -298,7 +298,7 @@ function parseIcons(jsonInput, manifestUrl) {
   return {
     raw,
     value,
-    debugString: undefined,
+    explanation: undefined,
   };
 }
 
@@ -317,7 +317,7 @@ function parseApplication(raw) {
       appUrl.value = new URL(appUrl.value).href;
     } catch (e) {
       appUrl.value = undefined;
-      appUrl.debugString = 'ERROR: invalid application URL ${raw.url}';
+      appUrl.explanation = 'ERROR: invalid application URL ${raw.url}';
     }
   }
 
@@ -328,7 +328,7 @@ function parseApplication(raw) {
       id,
       url: appUrl,
     },
-    debugString: undefined,
+    explanation: undefined,
   };
 }
 
@@ -342,15 +342,15 @@ function parseRelatedApplications(jsonInput) {
     return {
       raw,
       value: undefined,
-      debugString: undefined,
+      explanation: undefined,
     };
   }
 
   if (!Array.isArray(raw)) {
     return {
       raw,
       value: undefined,
-      debugString: 'ERROR: \'related_applications\' expected to be an array but is not.',
+      explanation: 'ERROR: \'related_applications\' expected to be an array but is not.',
     };
   }
 
@@ -364,7 +364,7 @@ function parseRelatedApplications(jsonInput) {
   return {
     raw,
     value,
-    debugString: undefined,
+    explanation: undefined,
   };
 }
 
@@ -374,21 +374,21 @@ function parseRelatedApplications(jsonInput) {
 function parsePreferRelatedApplications(jsonInput) {
   const raw = jsonInput.prefer_related_applications;
   let value;
-  let debugString;
+  let explanation;
 
   if (typeof raw === 'boolean') {
     value = raw;
   } else {
     if (raw !== undefined) {
-      debugString = 'ERROR: \'prefer_related_applications\' expected to be a boolean.';
+      explanation = 'ERROR: \'prefer_related_applications\' expected to be a boolean.';
     }
     value = undefined;
   }
 
   return {
     raw,
     value,
-    debugString,
+    explanation,
   };
 }
 
@@ -425,7 +425,7 @@ function parse(string, manifestUrl, documentUrl) {
     return {
       raw: string,
       value: undefined,
-      debugString: 'ERROR: file isn\'t valid JSON: ' + e,
+      explanation: 'ERROR: file isn\'t valid JSON: ' + e,
     };
   }
 
@@ -447,7 +447,7 @@ function parse(string, manifestUrl, documentUrl) {
   return {
     raw: string,
     value: manifest,
-    debugString: undefined,
+    explanation: undefined,
   };
 }
 

lighthouse-core/test/audits/webapp-install-banner-test.js

@@ -152,7 +152,7 @@ describe('PWA: webapp install banner audit', () => {
 
   it('includes warning from start_url', () => {
     const artifacts = generateMockArtifacts();
-    artifacts.StartUrl = {statusCode: 200, debugString: 'Warning!'};
+    artifacts.StartUrl = {statusCode: 200, explanation: 'Warning!'};
 
     return WebappInstallBannerAudit.audit(artifacts).then(result => {
       assert.strictEqual(result.rawValue, true);

lighthouse-core/test/gather/gatherers/manifest-test.js

@@ -122,7 +122,7 @@ describe('Manifest gatherer', () => {
       url: EXAMPLE_DOC_URL,
     }).then(artifact => {
       assert.ok(typeof artifact.value === 'object');
-      assert.strictEqual(artifact.debugString, undefined);
+      assert.strictEqual(artifact.explanation, undefined);
     });
   });
 });