refactor: standardize undefined handling for categories

Author: hanna-skryl

packages/ci/src/lib/issues.ts

@@ -1,6 +1,7 @@
 import type {
   Audit,
   AuditReport,
+  CategoryRef,
   Issue,
   PluginMeta,
   Report,
@@ -151,6 +152,9 @@ export function getAuditImpactValue(
   { audit, plugin }: IssueContext,
   report: Report,
 ): number {
+  if (!report.categories) {
+    return 0;
+  }
   return report.categories
     .map((category): number => {
       const weights = category.refs.map((ref): number => {
@@ -163,16 +167,7 @@ export function getAuditImpactValue(
             return ref.slug === audit.slug ? ref.weight : 0;
 
           case 'group':
-            const group = report.plugins
-              .find(({ slug }) => slug === ref.plugin)
-              ?.groups?.find(({ slug }) => slug === ref.slug);
-            if (!group?.refs.length) {
-              return 0;
-            }
-            const groupRatio =
-              (group.refs.find(({ slug }) => slug === audit.slug)?.weight ??
-                0) / group.refs.reduce((acc, { weight }) => acc + weight, 0);
-            return ref.weight * groupRatio;
+            return calculateGroupImpact(ref, audit, report);
         }
       });
 
@@ -183,3 +178,20 @@ export function getAuditImpactValue(
     })
     .reduce((acc, value) => acc + value, 0);
 }
+
+export function calculateGroupImpact(
+  ref: CategoryRef,
+  audit: Audit,
+  report: Report,
+): number {
+  const group = report.plugins
+    .find(({ slug }) => slug === ref.plugin)
+    ?.groups?.find(({ slug }) => slug === ref.slug);
+  if (!group?.refs.length) {
+    return 0;
+  }
+  const groupRatio =
+    (group.refs.find(({ slug }) => slug === audit.slug)?.weight ?? 0) /
+    group.refs.reduce((acc, { weight }) => acc + weight, 0);
+  return ref.weight * groupRatio;
+}

packages/ci/src/lib/issues.unit.test.ts

@@ -1,5 +1,9 @@
-import type { Report } from '@code-pushup/models';
-import { getAuditImpactValue, issuesMatch } from './issues';
+import type { CategoryRef, Report } from '@code-pushup/models';
+import {
+  calculateGroupImpact,
+  getAuditImpactValue,
+  issuesMatch,
+} from './issues';
 
 describe('issues comparison', () => {
   it('should match issues with exact same metadata', () => {
@@ -271,4 +275,70 @@ describe('issues sorting', () => {
       ),
     ).toBe(0.09); // 1% + 8% = 9%
   });
+
+  it('should return 0 when there are no categories', () => {
+    expect(
+      getAuditImpactValue(
+        {
+          audit: {
+            slug: 'react-jsx-key',
+            title: 'Disallow missing `key` props in iterators',
+          },
+          plugin: { slug: 'eslint', title: 'ESLint' },
+        },
+        {
+          plugins: [
+            {
+              slug: 'eslint',
+              groups: [
+                {
+                  slug: 'suggestions',
+                  refs: [{ slug: 'mock-rule', weight: 1 }],
+                },
+              ],
+            },
+          ],
+        } as Report,
+      ),
+    ).toBe(0);
+  });
+});
+
+describe('calculateGroupImpact', () => {
+  const mockAudit = {
+    slug: 'react-jsx-key',
+    title: 'Disallow missing `key` props in iterators',
+  };
+  const mockCategoryRef = {
+    type: 'group',
+    plugin: 'eslint',
+    slug: 'suggestions',
+    weight: 1,
+  } as CategoryRef;
+
+  const mockReport = {
+    plugins: [
+      {
+        slug: 'eslint',
+        groups: [
+          {
+            slug: 'suggestions',
+            refs: [
+              ...Array.from({ length: 9 }).map((_, i) => ({
+                slug: `mock-rule-${i}`,
+                weight: 1,
+              })),
+              { slug: 'react-jsx-key', weight: 1 },
+            ],
+          },
+        ],
+      },
+    ],
+  } as Report;
+
+  it('should calculate correct impact for audit in group', () => {
+    expect(calculateGroupImpact(mockCategoryRef, mockAudit, mockReport)).toBe(
+      0.1,
+    );
+  });
 });

packages/cli/src/lib/autorun/autorun-command.ts

@@ -41,7 +41,7 @@ export function yargsAutorunCommandObject() {
       await collectAndPersistReports(optionsWithFormat);
       collectSuccessfulLog();
 
-      if (options.categories.length === 0) {
+      if (!options.categories || options.categories.length === 0) {
         renderConfigureCategoriesHint();
       }
 

packages/cli/src/lib/collect/collect-command.ts

@@ -24,7 +24,7 @@ export function yargsCollectCommandObject(): CommandModule {
       await collectAndPersistReports(options);
       collectSuccessfulLog();
 
-      if (options.categories.length === 0) {
+      if (!options.categories || options.categories.length === 0) {
         renderConfigureCategoriesHint();
       }
 

packages/cli/src/lib/implementation/core-config.integration.test.ts

@@ -144,7 +144,7 @@ describe('parsing values from CLI and middleware', () => {
     });
   });
 
-  it('should set empty array for categories if not given in config file', async () => {
+  it('should keep categories undefined if not given in config file', async () => {
     const { categories } = await yargsCli<CoreConfig>(
       ['--config=./no-category.config.ts'],
       {
@@ -153,7 +153,7 @@ describe('parsing values from CLI and middleware', () => {
       },
     ).parseAsync();
 
-    expect(categories).toEqual([]);
+    expect(categories).toBeUndefined();
   });
 
   it('should accept an upload configuration with CLI overrides', async () => {

packages/cli/src/lib/implementation/core-config.middleware.ts

@@ -32,7 +32,6 @@ export async function coreConfigMiddleware<
   const {
     persist: rcPersist,
     upload: rcUpload,
-    categories: rcCategories,
     ...remainingRcConfig
   } = importedRc;
   const upload =
@@ -56,7 +55,6 @@ export async function coreConfigMiddleware<
       ),
     },
     ...(upload != null && { upload }),
-    categories: rcCategories ?? [],
     ...remainingRcConfig,
     ...remainingCliOptions,
   };

packages/cli/src/lib/implementation/filter.middleware.ts

@@ -1,4 +1,4 @@
-import type { CategoryConfig, PluginConfig } from '@code-pushup/models';
+import type { CoreConfig } from '@code-pushup/models';
 import { filterItemRefsBy } from '@code-pushup/utils';
 import type { FilterOptions, Filterables } from './filter.model';
 import {
@@ -12,7 +12,7 @@ export function filterMiddleware<T extends FilterOptions>(
 ): T {
   const {
     plugins,
-    categories = [],
+    categories,
     skipCategories = [],
     onlyCategories = [],
     skipPlugins = [],
@@ -26,7 +26,7 @@ export function filterMiddleware<T extends FilterOptions>(
     skipPlugins.length === 0 &&
     onlyPlugins.length === 0
   ) {
-    return { ...originalProcessArgs, categories };
+    return originalProcessArgs;
   }
 
   handleConflictingOptions('categories', onlyCategories, skipCategories);
@@ -44,9 +44,11 @@ export function filterMiddleware<T extends FilterOptions>(
     onlyPlugins,
     verbose,
   );
-  const finalCategories = filterItemRefsBy(filteredCategories, ref =>
-    filteredPlugins.some(plugin => plugin.slug === ref.plugin),
-  );
+  const finalCategories = filteredCategories
+    ? filterItemRefsBy(filteredCategories, ref =>
+        filteredPlugins.some(plugin => plugin.slug === ref.plugin),
+      )
+    : filteredCategories;
 
   validateFinalState(
     { categories: finalCategories, plugins: filteredPlugins },
@@ -80,8 +82,12 @@ function applyCategoryFilters(
   skipCategories: string[],
   onlyCategories: string[],
   verbose: boolean,
-): CategoryConfig[] {
-  if (skipCategories.length === 0 && onlyCategories.length === 0) {
+): CoreConfig['categories'] {
+  if (
+    (skipCategories.length === 0 && onlyCategories.length === 0) ||
+    !categories ||
+    categories.length === 0
+  ) {
     return categories;
   }
   validateFilterOption(
@@ -102,7 +108,7 @@ function applyPluginFilters(
   skipPlugins: string[],
   onlyPlugins: string[],
   verbose: boolean,
-): PluginConfig[] {
+): CoreConfig['plugins'] {
   const filteredPlugins = filterPluginsFromCategories({
     categories,
     plugins,
@@ -126,11 +132,12 @@ function applyPluginFilters(
 function filterPluginsFromCategories({
   categories,
   plugins,
-}: Filterables): PluginConfig[] {
+}: Filterables): CoreConfig['plugins'] {
+  if (!categories || categories.length === 0) {
+    return plugins;
+  }
   const validPluginSlugs = new Set(
     categories.flatMap(category => category.refs.map(ref => ref.plugin)),
   );
-  return categories.length > 0
-    ? plugins.filter(plugin => validPluginSlugs.has(plugin.slug))
-    : plugins;
+  return plugins.filter(plugin => validPluginSlugs.has(plugin.slug));
 }

packages/cli/src/lib/implementation/filter.middleware.unit.test.ts

@@ -22,7 +22,6 @@ describe('filterMiddleware', () => {
       }),
     ).toStrictEqual({
       plugins: [{ slug: 'p1', audits: [{ slug: 'a1-p1' }] }],
-      categories: [],
     });
   });
 
@@ -89,7 +88,6 @@ describe('filterMiddleware', () => {
       const { plugins } = filterMiddleware({
         ...option,
         plugins: [{ slug: 'p1' }, { slug: 'p2' }] as PluginConfig[],
-        categories: [],
       });
       expect(plugins).toStrictEqual([expect.objectContaining(expected)]);
     },

packages/cli/src/lib/implementation/filter.model.ts

@@ -1,9 +1,5 @@
 import type { GlobalOptions } from '@code-pushup/core';
-import type {
-  CategoryConfig,
-  CoreConfig,
-  PluginConfig,
-} from '@code-pushup/models';
+import type { CoreConfig } from '@code-pushup/models';
 
 export type FilterOptions = Partial<GlobalOptions> &
   Pick<CoreConfig, 'categories' | 'plugins'> &
@@ -17,7 +13,4 @@ export type FilterOptionType =
   | 'skipPlugins'
   | 'onlyPlugins';
 
-export type Filterables = {
-  categories: CategoryConfig[];
-  plugins: PluginConfig[];
-};
+export type Filterables = Pick<CoreConfig, 'plugins' | 'categories'>;

packages/cli/src/lib/implementation/validate-filter-options.utils.ts

@@ -11,7 +11,7 @@ export class OptionValidationError extends Error {}
 
 export function validateFilterOption(
   option: FilterOptionType,
-  { plugins, categories }: Filterables,
+  { plugins, categories = [] }: Filterables,
   { itemsToFilter, verbose }: { itemsToFilter: string[]; verbose: boolean },
 ): void {
   const itemsToFilterSet = new Set(itemsToFilter);
@@ -59,9 +59,9 @@ export function validateFinalState(
   filteredItems: Filterables,
   originalItems: Filterables,
 ): void {
-  const { categories: filteredCategories, plugins: filteredPlugins } =
+  const { categories: filteredCategories = [], plugins: filteredPlugins } =
     filteredItems;
-  const { categories: originalCategories, plugins: originalPlugins } =
+  const { categories: originalCategories = [], plugins: originalPlugins } =
     originalItems;
   if (
     filteredCategories.length === 0 &&