feat: implement scoreTarget for categories

hanna-skryl · hanna-skryl · commit 94cbbff8099c · 2025-08-18T17:08:25.000-04:00
diff --git a/packages/ci/src/lib/portal/__snapshots__/transform.unit.test.ts.snap b/packages/ci/src/lib/portal/__snapshots__/transform.unit.test.ts.snap
@@ -4,7 +4,6 @@ exports[`transformGQLReport > should convert full GraphQL report to valid report
 {
   "categories": [
     {
-      "isBinary": false,
       "refs": [
         {
           "plugin": "eslint",
@@ -13,11 +12,11 @@ exports[`transformGQLReport > should convert full GraphQL report to valid report
           "weight": 1,
         },
       ],
+      "scoreTarget": undefined,
       "slug": "code-style",
       "title": "Code style",
     },
     {
-      "isBinary": false,
       "refs": [
         {
           "plugin": "bundle-stats",
@@ -26,6 +25,7 @@ exports[`transformGQLReport > should convert full GraphQL report to valid report
           "weight": 1,
         },
       ],
+      "scoreTarget": undefined,
       "slug": "bundle-size",
       "title": "Bundle size",
     },
diff --git a/packages/ci/src/lib/portal/transform.ts b/packages/ci/src/lib/portal/transform.ts
@@ -61,7 +61,6 @@ function transformGQLCategory(category: CategoryFragment): CategoryConfig {
   return {
     slug: category.slug,
     title: category.title,
-    isBinary: category.isBinary,
     ...(category.description && { description: category.description }),
     refs: category.refs.map(
       ({ target, weight }): CategoryRef => ({
@@ -71,6 +70,9 @@ function transformGQLCategory(category: CategoryFragment): CategoryConfig {
         weight,
       }),
     ),
+    // TODO: Portal API migration - convert isBinary to scoreTarget for backward compatibility
+    // Remove this conversion when Portal API supports scoreTarget (#713)
+    scoreTarget: category.isBinary ? 1 : undefined,
   };
 }
 
diff --git a/packages/core/src/lib/implementation/report-to-gql.ts b/packages/core/src/lib/implementation/report-to-gql.ts
@@ -199,7 +199,9 @@ function categoryToGQL(category: CategoryConfig): PortalCategory {
     slug: category.slug,
     title: category.title,
     description: category.description,
-    isBinary: category.isBinary,
+    // TODO: Portal API migration - convert scoreTarget to isBinary for backward compatibility
+    // Remove this conversion when Portal API supports scoreTarget (#713)
+    isBinary: category.scoreTarget === 1,
     refs: category.refs.map(ref => ({
       plugin: ref.plugin,
       type: categoryRefTypeToGQL(ref.type),
diff --git a/packages/models/docs/models-reference.md b/packages/models/docs/models-reference.md
@@ -167,15 +167,15 @@ _Boolean._
 
 _Object containing the following properties:_
 
-| Property         | Description                                                                | Type                                                              |
-| :--------------- | :------------------------------------------------------------------------- | :---------------------------------------------------------------- |
-| **`slug`** (\*)  | Human-readable unique ID, e.g. "performance"                               | `string` (_regex: `/^[a-z\d]+(?:-[a-z\d]+)*$/`, max length: 128_) |
-| **`refs`** (\*)  |                                                                            | _Array of at least 1 [CategoryRef](#categoryref) items_           |
-| **`title`** (\*) | Category Title                                                             | `string` (_max length: 256_)                                      |
-| `description`    | Category description                                                       | `string` (_max length: 65536_)                                    |
-| `docsUrl`        | Category docs URL                                                          | `string` (_url_) (_optional_) _or_ `''`                           |
-| `isSkipped`      |                                                                            | `boolean`                                                         |
-| `isBinary`       | Is this a binary category (i.e. only a perfect score considered a "pass")? | `boolean`                                                         |
+| Property         | Description                                  | Type                                                              |
+| :--------------- | :------------------------------------------- | :---------------------------------------------------------------- |
+| **`slug`** (\*)  | Human-readable unique ID, e.g. "performance" | `string` (_regex: `/^[a-z\d]+(?:-[a-z\d]+)*$/`, max length: 128_) |
+| **`refs`** (\*)  |                                              | _Array of at least 1 [CategoryRef](#categoryref) items_           |
+| **`title`** (\*) | Category Title                               | `string` (_max length: 256_)                                      |
+| `description`    | Category description                         | `string` (_max length: 65536_)                                    |
+| `docsUrl`        | Category docs URL                            | `string` (_url_) (_optional_) _or_ `''`                           |
+| `isSkipped`      |                                              | `boolean`                                                         |
+| `scoreTarget`    | Pass/fail score threshold (0-1)              | `number` (_≥0, ≤1_)                                               |
 
 _(\*) Required._
 
diff --git a/packages/models/src/lib/category-config.ts b/packages/models/src/lib/category-config.ts
@@ -5,6 +5,7 @@ import {
 } from './implementation/checks.js';
 import {
   metaSchema,
+  nonnegativeNumberSchema,
   scorableSchema,
   slugSchema,
   weightedRefSchema,
@@ -44,11 +45,9 @@ export const categoryConfigSchema = scorableSchema(
     }).shape,
   )
   .extend({
-    isBinary: z
-      .boolean()
-      .describe(
-        'Is this a binary category (i.e. only a perfect score considered a "pass")?',
-      )
+    scoreTarget: nonnegativeNumberSchema
+      .max(1)
+      .describe('Pass/fail score threshold (0-1)')
       .optional(),
   });
 
diff --git a/packages/models/src/lib/category-config.unit.test.ts b/packages/models/src/lib/category-config.unit.test.ts
@@ -92,7 +92,6 @@ describe('categoryConfigSchema', () => {
         title: 'Test results',
         description: 'This category collects test results.',
         docsUrl: 'https://www.cypress.io/',
-        isBinary: false,
         refs: [
           {
             plugin: 'cypress',
diff --git a/packages/plugin-lighthouse/README.md b/packages/plugin-lighthouse/README.md
@@ -88,8 +88,8 @@ export default {
     },
     {
       slug: 'pwa',
+      scoreTarget: 1,
       title: 'PWA',
-      isBinary: true,
       refs: [lighthouseGroupRef('pwa')],
     },
   ],
@@ -109,8 +109,8 @@ export default {
   categories: [
     {
       slug: 'pwa',
+      scoreTarget: 1,
       title: 'PWA',
-      isBinary: true,
       refs: [lighthouseAuditRef('installable-manifest', 2), lighthouseAuditRef('splash-screen', 1), lighthouseAuditRef('themed-omnibox', 1), lighthouseAuditRef('content-width', 1), lighthouseAuditRef('themed-omnibox', 2), lighthouseAuditRef('viewport', 2), lighthouseAuditRef('maskable-icon', 1), lighthouseAuditRef('pwa-cross-browser', 0), lighthouseAuditRef('pwa-page-transitions', 0), lighthouseAuditRef('pwa-each-page-has-url', 0)],
     },
   ],
diff --git a/packages/plugin-lighthouse/src/lib/merge-categories.unit.test.ts b/packages/plugin-lighthouse/src/lib/merge-categories.unit.test.ts
@@ -327,7 +327,6 @@ describe('mergeLighthouseCategories', () => {
             title: 'Performance',
             description: 'Website performance metrics',
             docsUrl: 'https://docs.example.com/performance',
-            isBinary: true,
             refs: [
               {
                 type: 'group',
@@ -336,14 +335,14 @@ describe('mergeLighthouseCategories', () => {
                 weight: 1,
               },
             ],
+            scoreTarget: 1,
           },
         ])[0],
       ).toEqual({
         slug: 'performance',
         title: 'Performance',
         description: 'Website performance metrics',
         docsUrl: 'https://docs.example.com/performance',
-        isBinary: true,
         refs: [
           {
             type: 'group',
@@ -358,6 +357,7 @@ describe('mergeLighthouseCategories', () => {
             weight: 1,
           },
         ],
+        scoreTarget: 1,
       });
     });
   });
@@ -689,7 +689,6 @@ describe('expandAggregatedCategory', () => {
       title: 'Performance',
       description: 'Website performance metrics',
       docsUrl: 'https://docs.example.com',
-      isBinary: true,
       refs: [
         {
           type: 'group',
@@ -698,6 +697,7 @@ describe('expandAggregatedCategory', () => {
           weight: 1,
         },
       ],
+      scoreTarget: 1,
     };
     expect(
       expandAggregatedCategory(category, { urlCount: 1, weights: { 1: 1 } }),
diff --git a/packages/utils/perf/score-report/index.ts b/packages/utils/perf/score-report/index.ts
@@ -154,7 +154,6 @@ function minimalReport(opt?: MinimalReportOptions): Report {
           slug: `${AUDIT_P1_PREFIX}${idx}`,
           weight: 1,
         })),
-        isBinary: false,
       },
       {
         slug: 'c2_',
@@ -165,7 +164,6 @@ function minimalReport(opt?: MinimalReportOptions): Report {
           slug: `${AUDIT_P2_PREFIX}${idx}`,
           weight: 1,
         })),
-        isBinary: false,
       },
     ],
     plugins: [
diff --git a/packages/utils/src/lib/reports/__snapshots__/generate-md-report-category-section.unit.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/generate-md-report-category-section.unit.test.ts.snap
@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`categoriesDetailsSection > should render categories details and add "✅" when isBinary is passing 1`] = `
+exports[`categoriesDetailsSection > should render categories details and add "✅" when score >= scoreTarget 1`] = `
 "## 🏷 Categories
 
 ### Bug Prevention
@@ -11,7 +11,7 @@ exports[`categoriesDetailsSection > should render categories details and add "
 "
 `;
 
-exports[`categoriesDetailsSection > should render categories details and add "❌" when isBinary is failing 1`] = `
+exports[`categoriesDetailsSection > should render categories details and add "❌" when score < scoreTarget 1`] = `
 "## 🏷 Categories
 
 ### Bug Prevention
diff --git a/packages/utils/src/lib/reports/generate-md-report-category-section.ts b/packages/utils/src/lib/reports/generate-md-report-category-section.ts
@@ -27,13 +27,12 @@ export function categoriesOverviewSection(
     ],
     categories
       .filter(scoreFilter(options))
-      .map(({ title, refs, score, isBinary }) => [
-        // @TODO refactor `isBinary: boolean` to `scoreTarget: number` #713
+      .map(({ title, refs, score, scoreTarget }) => [
         // The heading "ID" is inferred from the heading text in Markdown.
         md.link(`#${slugify(title)}`, title),
         md`${scoreMarker(score)} ${md.bold(
           formatReportScore(score),
-        )}${binaryIconSuffix(score, isBinary)}`,
+        )}${binaryIconSuffix(score, scoreTarget)}`,
         countCategoryAudits(refs, plugins).toString(),
       ]),
   );
@@ -54,7 +53,7 @@ export function categoriesDetailsSection(
         .paragraph(
           md`${scoreMarker(category.score)} Score: ${md.bold(
             formatReportScore(category.score),
-          )}${binaryIconSuffix(category.score, category.isBinary)}`,
+          )}${binaryIconSuffix(category.score, category.scoreTarget)}`,
         )
         .list(
           category.refs.map(ref => {
@@ -128,8 +127,7 @@ export function categoryGroupItem(
 
 export function binaryIconSuffix(
   score: number,
-  isBinary: boolean | undefined,
+  scoreTarget: number | undefined,
 ): string {
-  // @TODO refactor `isBinary: boolean` to `scoreTarget: number` #713
-  return scoreTargetIcon(score, isBinary ? 1 : undefined, { prefix: ' ' });
+  return scoreTargetIcon(score, scoreTarget, { prefix: ' ' });
 }
diff --git a/packages/utils/src/lib/reports/generate-md-report-category-section.unit.test.ts b/packages/utils/src/lib/reports/generate-md-report-category-section.unit.test.ts
@@ -105,7 +105,7 @@ describe('categoriesOverviewSection', () => {
             slug: 'bug-prevention',
             title: 'Bug Prevention',
             score: 0.98,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [{ slug: 'no-let', type: 'audit' }],
           },
         ],
@@ -230,7 +230,7 @@ describe('categoriesDetailsSection', () => {
             slug: 'bug-prevention',
             title: 'Bug Prevention',
             score: 1,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [{ slug: 'no-let', type: 'audit', plugin: 'eslint' }],
           },
           {
@@ -249,7 +249,7 @@ describe('categoriesDetailsSection', () => {
             slug: 'typescript',
             title: 'Typescript',
             score: 0.14,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [{ slug: 'no-any', type: 'audit', plugin: 'eslint' }],
           },
         ],
@@ -288,7 +288,7 @@ describe('categoriesDetailsSection', () => {
               slug: 'bug-prevention',
               title: 'Bug Prevention',
               score: 1,
-              isBinary: true,
+              scoreTarget: 1,
               refs: [{ slug: 'no-let', type: 'audit', plugin: 'eslint' }],
             },
             {
@@ -307,7 +307,7 @@ describe('categoriesDetailsSection', () => {
               slug: 'typescript',
               title: 'Typescript',
               score: 0.14,
-              isBinary: true,
+              scoreTarget: 1,
               refs: [{ slug: 'no-any', type: 'audit', plugin: 'eslint' }],
             },
           ],
@@ -319,7 +319,7 @@ describe('categoriesDetailsSection', () => {
     ).toMatchSnapshot('filtered');
   });
 
-  it('should render categories details and add "❌" when isBinary is failing', () => {
+  it('should render categories details and add "❌" when score < scoreTarget', () => {
     expect(
       categoriesDetailsSection({
         plugins: [
@@ -334,15 +334,15 @@ describe('categoriesDetailsSection', () => {
             slug: 'bug-prevention',
             title: 'Bug Prevention',
             score: 0.98,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [{ slug: 'no-let', type: 'audit', plugin: 'eslint' }],
           },
         ],
       } as Required<Pick<ScoredReport, 'plugins' | 'categories'>>).toString(),
     ).toMatchSnapshot();
   });
 
-  it('should render categories details and add "✅" when isBinary is passing', () => {
+  it('should render categories details and add "✅" when score >= scoreTarget', () => {
     expect(
       categoriesDetailsSection({
         plugins: [
@@ -357,7 +357,7 @@ describe('categoriesDetailsSection', () => {
             slug: 'bug-prevention',
             title: 'Bug Prevention',
             score: 1,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [{ slug: 'no-let', type: 'audit', plugin: 'eslint' }],
           },
         ],
@@ -367,15 +367,15 @@ describe('categoriesDetailsSection', () => {
 });
 
 describe('binaryIconSuffix', () => {
-  it('should return passing binarySuffix if score is 1 and isBinary is true', () => {
-    expect(binaryIconSuffix(1, true)).toBe(' ✅');
+  it('should return passing binarySuffix when score >= scoreTarget', () => {
+    expect(binaryIconSuffix(1, 1)).toBe(' ✅');
   });
 
-  it('should return failing binarySuffix if score is < then 1 and isBinary is true', () => {
-    expect(binaryIconSuffix(0, true)).toBe(' ❌');
+  it('should return failing binarySuffix when score < scoreTarget', () => {
+    expect(binaryIconSuffix(0, 1)).toBe(' ❌');
   });
 
-  it('should return NO binarySuffix if score is 1 and isBinary is false', () => {
-    expect(binaryIconSuffix(1, false)).toBe('');
+  it('should return NO binarySuffix when scoreTarget is undefined', () => {
+    expect(binaryIconSuffix(1, undefined)).toBe('');
   });
 });
diff --git a/packages/utils/src/lib/reports/generate-md-report.unit.test.ts b/packages/utils/src/lib/reports/generate-md-report.unit.test.ts
@@ -902,7 +902,7 @@ module.exports = {
             title: 'SEO',
             slug: 'seo',
             score: 1,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [
               {
                 slug: 'is-crawlable',
@@ -916,7 +916,7 @@ module.exports = {
             title: 'PWA',
             slug: 'pwa',
             score: 0,
-            isBinary: true,
+            scoreTarget: 1,
             refs: [
               {
                 slug: 'splash-screen',
diff --git a/packages/utils/src/lib/reports/log-stdout-summary.ts b/packages/utils/src/lib/reports/log-stdout-summary.ts
@@ -101,9 +101,9 @@ export function logCategories({
 }: Required<Pick<ScoredReport, 'plugins' | 'categories'>>): void {
   const hAlign = (idx: number) => (idx === 0 ? 'left' : 'right');
 
-  const rows = categories.map(({ title, score, refs, isBinary }) => [
+  const rows = categories.map(({ title, score, scoreTarget, refs }) => [
     title,
-    `${binaryIconPrefix(score, isBinary)}${applyScoreColor({ score })}`,
+    `${binaryIconPrefix(score, scoreTarget)}${applyScoreColor({ score })}`,
     countCategoryAudits(refs, plugins),
   ]);
   const table = ui().table();
@@ -130,12 +130,11 @@ export function logCategories({
   log();
 }
 
-// @TODO refactor `isBinary: boolean` to `scoreTarget: number` #713
 export function binaryIconPrefix(
   score: number,
-  isBinary: boolean | undefined,
+  scoreTarget: number | undefined,
 ): string {
-  return scoreTargetIcon(score, isBinary ? 1 : undefined, {
+  return scoreTargetIcon(score, scoreTarget, {
     passIcon: bold(green('✓')),
     failIcon: bold(red('✗')),
     postfix: ' ',
diff --git a/packages/utils/src/lib/reports/log-stdout-summary.unit.test.ts b/packages/utils/src/lib/reports/log-stdout-summary.unit.test.ts

Original file line number	Diff line number	Diff line change
@@ -4,7 +4,6 @@ exports[`transformGQLReport > should convert full GraphQL report to valid report
`4`	`4`	`{`
`5`	`5`	`"categories": [`
`6`	`6`	`{`
`7`		`- "isBinary": false,`
`8`	`7`	`"refs": [`
`9`	`8`	`{`
`10`	`9`	`"plugin": "eslint",`
@@ -13,11 +12,11 @@ exports[`transformGQLReport > should convert full GraphQL report to valid report
`13`	`12`	`"weight": 1,`
`14`	`13`	`},`
`15`	`14`	`],`
	`15`	`+ "scoreTarget": undefined,`
`16`	`16`	`"slug": "code-style",`
`17`	`17`	`"title": "Code style",`
`18`	`18`	`},`
`19`	`19`	`{`
`20`		`- "isBinary": false,`
`21`	`20`	`"refs": [`
`22`	`21`	`{`
`23`	`22`	`"plugin": "bundle-stats",`
@@ -26,6 +25,7 @@ exports[`transformGQLReport > should convert full GraphQL report to valid report
`26`	`25`	`"weight": 1,`
`27`	`26`	`},`
`28`	`27`	`],`
	`28`	`+ "scoreTarget": undefined,`
`29`	`29`	`"slug": "bundle-size",`
`30`	`30`	`"title": "Bundle size",`
`31`	`31`	`},`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,6 @@ describe('categoryConfigSchema', () => {`
`92`	`92`	`title: 'Test results',`
`93`	`93`	`description: 'This category collects test results.',`
`94`	`94`	`docsUrl: 'https://www.cypress.io/',`
`95`		`- isBinary: false,`
`96`	`95`	`refs: [`
`97`	`96`	`{`
`98`	`97`	`plugin: 'cypress',`