core(fr): limit scope of audits to applicable modes

lighthouse-core/audits/apple-touch-icon.js

@@ -38,6 +38,7 @@ class AppleTouchIcon extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['LinkElements'],
     };
   }

lighthouse-core/audits/dobetterweb/geolocation-on-start.js

@@ -37,6 +37,7 @@ class GeolocationOnStart extends ViolationAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['ConsoleMessages'],
     };
   }

lighthouse-core/audits/dobetterweb/notification-on-start.js

@@ -37,6 +37,7 @@ class NotificationOnStart extends ViolationAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['ConsoleMessages'],
     };
   }

lighthouse-core/audits/final-screenshot.js

@@ -20,7 +20,7 @@ class FinalScreenshot extends Audit {
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
       title: 'Final Screenshot',
       description: 'The last screenshot captured of the pageload.',
-      requiredArtifacts: ['traces'],
+      requiredArtifacts: ['traces', 'GatherContext'],
     };
   }
 
@@ -37,6 +37,10 @@ class FinalScreenshot extends Audit {
     const finalScreenshot = screenshots[screenshots.length - 1];
 
     if (!finalScreenshot) {
+      // If a timespan didn't happen to contain frames, that's fine. Just mark not applicable.
+      if (artifacts.GatherContext.gatherMode === 'timespan') return {notApplicable: true, score: 1};
+
+      // If it was another mode, that's a fatal error.
       throw new LHError(LHError.errors.NO_SCREENSHOTS);
     }
 

lighthouse-core/audits/font-display.js

@@ -48,6 +48,7 @@ class FontDisplay extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['devtoolsLogs', 'CSSUsage', 'URL'],
     };
   }

lighthouse-core/audits/installable-manifest.js

@@ -120,6 +120,7 @@ class InstallableManifest extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['URL', 'WebAppManifest', 'InstallabilityErrors'],
     };
   }

lighthouse-core/audits/maskable-icon.js

@@ -42,6 +42,7 @@ class MaskableIcon extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
     };
   }

lighthouse-core/audits/metrics.js

@@ -28,6 +28,7 @@ class Metrics extends Audit {
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
       title: 'Metrics',
       description: 'Collects all available metrics.',
+      supportedModes: ['navigation'],
       requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext'],
     };
   }

lighthouse-core/audits/performance-budget.js

@@ -39,6 +39,7 @@ class ResourceBudget extends Audit {
       title: str_(UIStrings.title),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
+      supportedModes: ['navigation'],
       requiredArtifacts: ['devtoolsLogs', 'URL'],
     };
   }

lighthouse-core/audits/screenshot-thumbnails.js

@@ -25,7 +25,7 @@ class ScreenshotThumbnails extends Audit {
       scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
       title: 'Screenshot Thumbnails',
       description: 'This is what the load of your site looked like.',
-      requiredArtifacts: ['traces'],
+      requiredArtifacts: ['traces', 'GatherContext'],
     };
   }
 
@@ -70,7 +70,7 @@ class ScreenshotThumbnails extends Audit {
    * @param {LH.Audit.Context} context
    * @return {Promise<LH.Audit.Product>}
    */
-  static async audit(artifacts, context) {
+  static async _audit(artifacts, context) {
     const trace = artifacts.traces[Audit.DEFAULT_PASS];
     /** @type {Map<SpeedlineFrame, string>} */
     const cachedThumbnails = new Map();
@@ -133,6 +133,31 @@ class ScreenshotThumbnails extends Audit {
       },
     };
   }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    try {
+      return await this._audit(artifacts, context);
+    } catch (err) {
+      const noFramesErrors = new Set([
+        LHError.errors.NO_SCREENSHOTS.code,
+        LHError.errors.SPEEDINDEX_OF_ZERO.code,
+        LHError.errors.NO_SPEEDLINE_FRAMES.code,
+        LHError.errors.INVALID_SPEEDLINE.code,
+      ]);
+
+      // If a timespan didn't happen to contain frames, that's fine. Just mark not applicable.
+      if (noFramesErrors.has(err.code) && artifacts.GatherContext.gatherMode === 'timespan') {
+        return {notApplicable: true, score: 1};
+      }
+
+      throw err;
+    }
+  }
 }
 
 module.exports = ScreenshotThumbnails;

lighthouse-core/audits/seo/canonical.js

@@ -68,6 +68,7 @@ class Canonical extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['LinkElements', 'URL', 'devtoolsLogs'],
     };
   }

lighthouse-core/audits/seo/hreflang.js

@@ -79,6 +79,7 @@ class Hreflang extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['LinkElements', 'URL'],
     };
   }

lighthouse-core/audits/seo/http-status-code.js

@@ -6,10 +6,11 @@
 'use strict';
 
 const Audit = require('../audit.js');
-const MainResource = require('../../computed/main-resource.js');
+const NetworkRecords = require('../../computed/network-records.js');
 const HTTP_UNSUCCESSFUL_CODE_LOW = 400;
 const HTTP_UNSUCCESSFUL_CODE_HIGH = 599;
 const i18n = require('../../lib/i18n/i18n.js');
+const NetworkAnalyzer = require('../../lib/dependency-graph/simulator/network-analyzer.js');
 
 const UIStrings = {
   /** Title of a Lighthouse audit that provides detail on the HTTP status code a page responds with. This descriptive title is shown when the page has responded with a valid HTTP status code. */
@@ -33,7 +34,7 @@ class HTTPStatusCode extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
-      requiredArtifacts: ['devtoolsLogs', 'URL'],
+      requiredArtifacts: ['devtoolsLogs', 'URL', 'GatherContext'],
     };
   }
 
@@ -42,26 +43,30 @@ class HTTPStatusCode extends Audit {
    * @param {LH.Audit.Context} context
    * @return {Promise<LH.Audit.Product>}
    */
-  static audit(artifacts, context) {
+  static async audit(artifacts, context) {
     const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
     const URL = artifacts.URL;
+    const networkRecords = await NetworkRecords.request(devtoolsLog, context);
+    const mainResource = NetworkAnalyzer.findOptionalMainDocument(networkRecords, URL.finalUrl);
 
-    return MainResource.request({devtoolsLog, URL}, context)
-      .then(mainResource => {
-        const statusCode = mainResource.statusCode;
+    if (!mainResource) {
+      if (artifacts.GatherContext.gatherMode === 'timespan') return {notApplicable: true, score: 1};
+      throw new Error(`Unable to locate main resource`);
+    }
 
-        if (statusCode >= HTTP_UNSUCCESSFUL_CODE_LOW &&
+    const statusCode = mainResource.statusCode;
+
+    if (statusCode >= HTTP_UNSUCCESSFUL_CODE_LOW &&
           statusCode <= HTTP_UNSUCCESSFUL_CODE_HIGH) {
-          return {
-            score: 0,
-            displayValue: `${statusCode}`,
-          };
-        }
+      return {
+        score: 0,
+        displayValue: `${statusCode}`,
+      };
+    }
 
-        return {
-          score: 1,
-        };
-      });
+    return {
+      score: 1,
+    };
   }
 }
 

lighthouse-core/audits/seo/is-crawlable.js

@@ -80,6 +80,7 @@ class IsCrawlable extends Audit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['MetaElements', 'RobotsTxt', 'URL', 'devtoolsLogs'],
     };
   }

lighthouse-core/audits/splash-screen.js

@@ -45,6 +45,7 @@ class SplashScreen extends MultiCheckAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
     };
   }

lighthouse-core/audits/themed-omnibox.js

@@ -42,6 +42,7 @@ class ThemedOmnibox extends MultiCheckAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
+      supportedModes: ['navigation'],
       requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors', 'MetaElements'],
     };
   }

lighthouse-core/computed/resource-summary.js

@@ -9,7 +9,6 @@ const makeComputedArtifact = require('./computed-artifact.js');
 const NetworkRecords = require('./network-records.js');
 const URL = require('../lib/url-shim.js');
 const NetworkRequest = require('../lib/network-request.js');
-const MainResource = require('./main-resource.js');
 const Budget = require('../config/budget.js');
 const Util = require('../../report/renderer/util.js');
 
@@ -107,11 +106,8 @@ class ResourceSummary {
    * @return {Promise<Record<LH.Budget.ResourceType,ResourceEntry>>}
    */
   static async compute_(data, context) {
-    const [networkRecords, mainResource] = await Promise.all([
-      NetworkRecords.request(data.devtoolsLog, context),
-      MainResource.request({devtoolsLog: data.devtoolsLog, URL: data.URL}, context),
-    ]);
-    return ResourceSummary.summarize(networkRecords, mainResource.url, data.budgets);
+    const networkRecords = await NetworkRecords.request(data.devtoolsLog, context);
+    return ResourceSummary.summarize(networkRecords, data.URL.finalUrl, data.budgets);
   }
 }
 

lighthouse-core/gather/gatherers/script-elements.js

@@ -82,7 +82,7 @@ class ScriptElements extends FRGatherer {
   async _getArtifact(context, networkRecords, formFactor) {
     const session = context.driver.defaultSession;
     const executionContext = context.driver.executionContext;
-    const mainResource = NetworkAnalyzer.findMainDocument(networkRecords, context.url);
+    const mainResource = NetworkAnalyzer.findOptionalMainDocument(networkRecords, context.url);
 
     const scripts = await executionContext.evaluate(collectAllScriptElements, {
       args: [],
@@ -94,7 +94,7 @@ class ScriptElements extends FRGatherer {
     });
 
     for (const script of scripts) {
-      if (script.content) script.requestId = mainResource.requestId;
+      if (mainResource && script.content) script.requestId = mainResource.requestId;
     }
 
     const scriptRecords = networkRecords

lighthouse-core/gather/gatherers/seo/tap-targets.js

@@ -285,6 +285,18 @@ function gatherTapTargets(tapTargetsSelector, className) {
 /* c8 ignore stop */
 
 class TapTargets extends FRGatherer {
+  constructor() {
+    super();
+    /**
+     * This needs to be in the constructor.
+     * https://github.com/GoogleChrome/lighthouse/issues/12134
+     * @type {LH.Gatherer.GathererMeta}
+     */
+    this.meta = {
+      supportedModes: ['snapshot', 'navigation'],
+    };
+  }
+
   /**
    * @param {LH.Gatherer.FRProtocolSession} session
    * @param {string} className

lighthouse-core/gather/gatherers/trace-elements.js

@@ -21,6 +21,7 @@ const Sentry = require('../../lib/sentry.js');
 const Trace = require('./trace.js');
 const ProcessedTrace = require('../../computed/processed-trace.js');
 const ProcessedNavigation = require('../../computed/processed-navigation.js');
+const LighthouseError = require('../../lib/lh-error.js');
 
 /** @typedef {{nodeId: number, score?: number, animations?: {name?: string, failureReasonsMask?: number, unsupportedProperties?: string[]}[]}} TraceElementData */
 
@@ -257,7 +258,16 @@ class TraceElements extends FRGatherer {
     }
 
     const processedTrace = await ProcessedTrace.request(trace, context);
-    const {largestContentfulPaintEvt} = await ProcessedNavigation.request(processedTrace, context);
+    const {largestContentfulPaintEvt} = await ProcessedNavigation
+      .request(processedTrace, context)
+      .catch(err => {
+        // If we were running in timespan mode and there was no paint, treat LCP as missing.
+        if (context.gatherMode === 'timespan' && err.code === LighthouseError.errors.NO_FCP.code) {
+          return {largestContentfulPaintEvt: undefined};
+        }
+
+        throw err;
+      });
     const {mainThreadEvents} = processedTrace;
 
     const lcpNodeId = TraceElements.getNodeIDFromTraceEvent(largestContentfulPaintEvt);

lighthouse-core/test/audits/final-screenshot-test.js

@@ -5,23 +5,48 @@
  */
 'use strict';
 
-const assert = require('assert').strict;
-
 const FinalScreenshotAudit = require('../../audits/final-screenshot.js');
 const pwaTrace = require('../fixtures/traces/progressive-app-m60.json');
+const noScreenshotsTrace = {traceEvents: pwaTrace.traceEvents.filter(e => e.name !== 'Screenshot')};
 
 /* eslint-env jest */
 
 describe('Final screenshot', () => {
+  let context;
+
+  beforeEach(() => {
+    context = {computedCache: new Map()};
+  });
+
   it('should extract a final screenshot from a trace', async () => {
     const artifacts = Object.assign({
       traces: {defaultPass: pwaTrace},
+      GatherContext: {gatherMode: 'timespan'},
     });
-    const results = await FinalScreenshotAudit.audit(artifacts, {computedCache: new Map()});
+    const results = await FinalScreenshotAudit.audit(artifacts, context);
+
+    expect(results.score).toEqual(1);
+    expect(results.details.timing).toEqual(818);
+    expect(results.details.timestamp).toEqual(225414990064);
+    expect(results.details.data).toContain('data:image/jpeg;base64,/9j/4AAQSkZJRgABA');
+  });
+
+  it('should returns not applicable for missing screenshots in timespan mode', async () => {
+    const artifacts = {
+      traces: {defaultPass: noScreenshotsTrace},
+      GatherContext: {gatherMode: 'timespan'},
+    };
+
+    const results = await FinalScreenshotAudit.audit(artifacts, context);
+    expect(results.notApplicable).toEqual(true);
+  });
+
+  it('should throws for missing screenshots in navigation mode', async () => {
+    const artifacts = {
+      traces: {defaultPass: noScreenshotsTrace},
+      GatherContext: {gatherMode: 'navigation'},
+    };
 
-    assert.equal(results.score, 1);
-    assert.equal(results.details.timing, 818);
-    assert.equal(results.details.timestamp, 225414990064);
-    assert.ok(results.details.data.startsWith('data:image/jpeg;base64,/9j/4AAQSkZJRgABA'));
+    await expect(FinalScreenshotAudit.audit(artifacts, context)).rejects.toThrow();
   });
 });