rm gatherer name

core/config/validation.js

@@ -47,25 +47,24 @@ function assertValidPluginName(config, pluginName) {
 
 /**
  * Throws an error if the provided object does not implement the required Fraggle Rock gatherer interface.
- * @param {LH.Config.AnyFRGathererDefn} gathererDefn
+ * @param {LH.Config.AnyArtifactDefn} artifactDefn
  */
-function assertValidFRGatherer(gathererDefn) {
-  const gatherer = gathererDefn.instance;
-  const gathererName = gatherer.name;
+function assertValidArtifact(artifactDefn) {
+  const gatherer = artifactDefn.gatherer.instance;
 
   if (typeof gatherer.meta !== 'object') {
-    throw new Error(`${gathererName} gatherer did not provide a meta object.`);
+    throw new Error(`Gatherer for ${artifactDefn.id} did not provide a meta object.`);
   }
 
   if (gatherer.meta.supportedModes.length === 0) {
-    throw new Error(`${gathererName} gatherer did not support any gather modes.`);
+    throw new Error(`Gatherer for ${artifactDefn.id} did not support any gather modes.`);
   }
 
   if (
     typeof gatherer.getArtifact !== 'function' ||
     gatherer.getArtifact === BaseFRGatherer.prototype.getArtifact
   ) {
-    throw new Error(`${gathererName} gatherer did not define a "getArtifact" method.`);
+    throw new Error(`Gatherer for ${artifactDefn.id} did not define a "getArtifact" method.`);
   }
 }
 
@@ -258,7 +257,7 @@ function assertValidConfig(resolvedConfig) {
       throw new Error(`Config defined multiple artifacts with id '${artifactDefn.id}'`);
     }
     artifactIds.add(artifactDefn.id);
-    assertValidFRGatherer(artifactDefn.gatherer);
+    assertValidArtifact(artifactDefn);
   }
 
   for (const auditDefn of resolvedConfig.audits || []) {
@@ -303,7 +302,7 @@ function throwInvalidArtifactDependency(artifactId, dependencyKey) {
 export {
   isValidArtifactDependency,
   assertValidPluginName,
-  assertValidFRGatherer,
+  assertValidArtifact,
   assertValidFRNavigations,
   assertValidAudit,
   assertValidCategories,

core/gather/base-gatherer.js

@@ -54,20 +54,6 @@ class FRGatherer {
    * @return {LH.Gatherer.PhaseResult}
    */
   getArtifact(passContext) { }
-
-  /**
-   * Legacy property used to define the artifact ID. In Fraggle Rock, the artifact ID lives on the config.
-   * @return {keyof LH.GathererArtifacts}
-   */
-  get name() {
-    let name = this.constructor.name;
-    // Rollup will mangle class names in an known way–just trim until `$`.
-    if (name.includes('$')) {
-      name = name.substr(0, name.indexOf('$'));
-    }
-    // @ts-expect-error - assume that class name has been added to LH.GathererArtifacts.
-    return name;
-  }
 }
 
 export default FRGatherer;

core/gather/gatherers/css-usage.js

@@ -51,7 +51,7 @@ class CSSUsage extends FRGatherer {
         );
         Sentry.captureException(err, {
           tags: {
-            gatherer: this.name,
+            gatherer: 'CSSUsage',
           },
           extra: {
             url: event.header.sourceURL,

core/gather/gatherers/trace-elements.js

@@ -296,7 +296,7 @@ class TraceElements extends FRGatherer {
           });
         } catch (err) {
           Sentry.captureException(err, {
-            tags: {gatherer: this.name},
+            tags: {gatherer: 'TraceElements'},
             level: 'error',
           });
           continue;

core/test/config/validation-test.js

@@ -84,20 +84,22 @@ describe('Fraggle Rock Config Validation', () => {
     });
   });
 
-  describe('.assertValidFRGatherer', () => {
+  describe('.assertValidArtifact', () => {
     it('should throw if gatherer does not have a meta object', () => {
       const gatherer = new BaseGatherer();
       // @ts-expect-error - We are intentionally creating a malformed input.
       gatherer.meta = undefined;
 
       const gathererDefn = {instance: gatherer};
-      const invocation = () => validation.assertValidFRGatherer(gathererDefn);
+      const artifactDefn = {id: 'NewArtifact', gatherer: gathererDefn};
+      const invocation = () => validation.assertValidArtifact(artifactDefn);
       expect(invocation).toThrow(/did not provide a meta/);
     });
 
     it('should throw if gatherer does not have a supported modes', () => {
       const gathererDefn = {instance: new BaseGatherer()};
-      const invocation = () => validation.assertValidFRGatherer(gathererDefn);
+      const artifactDefn = {id: 'NewArtifact', gatherer: gathererDefn};
+      const invocation = () => validation.assertValidArtifact(artifactDefn);
       expect(invocation).toThrow(/did not support any gather modes/);
     });
 
@@ -106,7 +108,8 @@ describe('Fraggle Rock Config Validation', () => {
       gatherer.meta = {supportedModes: ['navigation']};
 
       const gathererDefn = {instance: gatherer};
-      const invocation = () => validation.assertValidFRGatherer(gathererDefn);
+      const artifactDefn = {id: 'NewArtifact', gatherer: gathererDefn};
+      const invocation = () => validation.assertValidArtifact(artifactDefn);
       expect(invocation).toThrow(/did not define.*getArtifact/);
     });
   });

core/test/gather/mock-driver.js

@@ -97,7 +97,6 @@ function createMockGathererInstance(meta) {
 
     /** @return {LH.Gatherer.AnyFRGathererInstance} */
     asGatherer() {
-      // @ts-expect-error - We'll rely on the tests passing to know this matches.
       return this;
     },
   };

core/test/gather/navigation-runner-test.js

@@ -58,7 +58,6 @@ describe('NavigationRunner', () => {
   function createGathererDefn() {
     return {
       instance: {
-        name: 'Accessibility',
         meta: {supportedModes: []},
         startInstrumentation: fnAny(),
         stopInstrumentation: fnAny(),

types/gatherer.d.ts

@@ -117,7 +117,6 @@ declare module Gatherer {
   type FRGatherPhase = keyof Omit<Gatherer.FRGathererInstance, 'name'|'meta'>
 
   interface FRGathererInstance<TDependencies extends DependencyKey = DefaultDependenciesKey> {
-    name: keyof GathererArtifacts; // temporary COMPAT measure until artifact config support is available
     meta: GathererMeta<TDependencies>;
     startInstrumentation(context: FRTransitionalContext<DefaultDependenciesKey>): Promise<void>|void;
     startSensitiveInstrumentation(context: FRTransitionalContext<DefaultDependenciesKey>): Promise<void>|void;