core(fr): convert service-worker gatherer (#12662)

GoogleChrome · Jun 19, 2021 · 0be8d52 · 0be8d52
1 parent 13d7ebc
commit 0be8d52
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 8 deletions.
diff --git a/lighthouse-core/fraggle-rock/config/default-config.js b/lighthouse-core/fraggle-rock/config/default-config.js
@@ -41,6 +41,7 @@ const artifacts = {
   PasswordInputsWithPreventedPaste: '',
   ResponseCompression: '',
   RobotsTxt: '',
+  ServiceWorker: '',
   ScriptElements: '',
   SourceMaps: '',
   Stacks: '',
@@ -94,6 +95,7 @@ const defaultConfig = {
     {id: artifacts.PasswordInputsWithPreventedPaste, gatherer: 'dobetterweb/password-inputs-with-prevented-paste'},
     {id: artifacts.ResponseCompression, gatherer: 'dobetterweb/response-compression'},
     {id: artifacts.RobotsTxt, gatherer: 'seo/robots-txt'},
+    {id: artifacts.ServiceWorker, gatherer: 'service-worker'},
     {id: artifacts.ScriptElements, gatherer: 'script-elements'},
     {id: artifacts.SourceMaps, gatherer: 'source-maps'},
     {id: artifacts.Stacks, gatherer: 'stacks'},
@@ -149,6 +151,7 @@ const defaultConfig = {
         artifacts.PasswordInputsWithPreventedPaste,
         artifacts.ResponseCompression,
         artifacts.RobotsTxt,
+        artifacts.ServiceWorker,
         artifacts.ScriptElements,
         artifacts.SourceMaps,
         artifacts.Stacks,

diff --git a/lighthouse-core/gather/gatherers/service-worker.js b/lighthouse-core/gather/gatherers/service-worker.js
@@ -5,16 +5,33 @@
  */
 'use strict';
 
-const Gatherer = require('./gatherer.js');
+const FRGatherer = require('../../fraggle-rock/gather/base-gatherer.js');
 const serviceWorkers = require('../driver/service-workers.js');
 
-class ServiceWorker extends Gatherer {
+class ServiceWorker extends FRGatherer {
+  /** @type {LH.Gatherer.GathererMeta} */
+  meta = {
+    supportedModes: ['navigation'],
+  }
+
   /**
    * @param {LH.Gatherer.PassContext} passContext
    * @return {Promise<LH.Artifacts['ServiceWorker']>}
    */
   async beforePass(passContext) {
-    const session = passContext.driver.defaultSession;
+    return this.getArtifact({...passContext, dependencies: {}});
+  }
+
+  // This gatherer is run in a separate pass for legacy mode.
+  // Legacy compat code is in `beforePass`.
+  async afterPass() { }
+
+  /**
+   * @param {LH.Gatherer.FRTransitionalContext} context
+   * @return {Promise<LH.Artifacts['ServiceWorker']>}
+   */
+  async getArtifact(context) {
+    const session = context.driver.defaultSession;
     const {versions} = await serviceWorkers.getServiceWorkerVersions(session);
     const {registrations} = await serviceWorkers.getServiceWorkerRegistrations(session);
 

diff --git a/lighthouse-core/test/fraggle-rock/api-test-pptr.js b/lighthouse-core/test/fraggle-rock/api-test-pptr.js
@@ -159,7 +159,7 @@ describe('Fraggle Rock API', () => {
       const {lhr} = result;
       const {auditResults, failedAudits, erroredAudits} = getAuditsBreakdown(lhr);
       // TODO(FR-COMPAT): This assertion can be removed when full compatibility is reached.
-      expect(auditResults.length).toMatchInlineSnapshot(`151`);
+      expect(auditResults.length).toMatchInlineSnapshot(`152`);
       expect(erroredAudits).toHaveLength(0);
 
       const failedAuditIds = failedAudits.map(audit => audit.id);

diff --git a/lighthouse-core/test/fraggle-rock/config/config-test.js b/lighthouse-core/test/fraggle-rock/config/config-test.js
@@ -63,8 +63,8 @@ describe('Fraggle Rock Config', () => {
   });
 
   it('should throw on invalid artifact definitions', () => {
-    const configJson = {artifacts: [{id: 'ServiceWorker', gatherer: 'service-worker'}]};
-    expect(() => initializeConfig(configJson, {gatherMode})).toThrow(/ServiceWorker gatherer/);
+    const configJson = {artifacts: [{id: 'HTTPRedirect', gatherer: 'http-redirect'}]};
+    expect(() => initializeConfig(configJson, {gatherMode})).toThrow(/HTTPRedirect gatherer/);
   });
 
   it('should resolve navigation definitions', () => {

diff --git a/lighthouse-core/test/gather/gatherers/service-worker-test.js b/lighthouse-core/test/gather/gatherers/service-worker-test.js
@@ -34,7 +34,7 @@ describe('service worker gatherer', () => {
     getServiceWorkerRegistrations.mockResolvedValue({registrations});
 
     const serviceWorkerGatherer = new ServiceWorkerGather();
-    const artifact = await serviceWorkerGatherer.beforePass({
+    const artifact = await serviceWorkerGatherer.getArtifact({
       driver: {},
       url,
     });

diff --git a/types/artifacts.d.ts b/types/artifacts.d.ts
@@ -24,7 +24,6 @@ declare global {
       | 'HTTPRedirect'
       | 'Manifest'
       | 'MixedContent'
-      | 'ServiceWorker'
       | keyof FRBaseArtifacts
     >;