fix(ci): filter failed scans when creating report

Fixes #204
harlan-zw · Apr 13, 2024 · 7b9eeea · 7b9eeea
1 parent 80ca6c8
commit 7b9eeea
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 12 deletions.
diff --git a/packages/cli/src/reporters/index.ts b/packages/cli/src/reporters/index.ts
@@ -13,22 +13,29 @@ export function generateReportPayload(reporter: 'jsonExpanded', reports: Unlight
 export function generateReportPayload(reporter: 'jsonSimple' | 'json', reports: UnlighthouseRouteReport[]): ReportJsonSimple
 export function generateReportPayload(reporter: 'csvSimple' | 'csv', reports: UnlighthouseRouteReport[]): string
 export function generateReportPayload(reporter: 'csvExpanded', reports: UnlighthouseRouteReport[], config?: ReporterConfig): string
-export function generateReportPayload(reporter: string, reports: UnlighthouseRouteReport[], config?: ReporterConfig): any {
- const sortedReporters = reports.sort((a, b) => a.route.path.localeCompare(b.route.path))
+export function generateReportPayload(reporter: string, _reports: UnlighthouseRouteReport[], config?: ReporterConfig): any {
+ const reports = _reports
+ .sort((a, b) => a.route.path.localeCompare(b.route.path))
+ .filter((r) => {
+ if (!r.report?.categories)
+ return false
+ return r.report.audits
+ })
+
  if (reporter.startsWith('json')) {
  if (reporter === 'jsonSimple' || reporter === 'json')
- return reportJsonSimple(sortedReporters)
+ return reportJsonSimple(reports)
  if (reporter === 'jsonExpanded')
- return reportJsonExpanded(sortedReporters)
+ return reportJsonExpanded(reports)
  }
  if (reporter.startsWith('csv')) {
  if (reporter === 'csvSimple' || reporter === 'csv')
- return reportCSVSimple(sortedReporters)
+ return reportCSVSimple(reports)
  if (reporter === 'csvExpanded')
- return reportCSVExpanded(sortedReporters, config)
+ return reportCSVExpanded(reports, config)
  }
  if (reporter === 'lighthouseServer')
- return reportLighthouseServer(sortedReporters, config)
+ return reportLighthouseServer(reports, config)
 
  throw new Error(`Unsupported reporter: ${reporter}.`)
 }

diff --git a/packages/cli/src/reporters/jsonExpanded.ts b/packages/cli/src/reporters/jsonExpanded.ts
@@ -1,3 +1,4 @@
+import type { UnlighthouseRouteReport } from '@unlighthouse/core/src'
 import type { CategoryAverageScore, CategoryScore, ExpandedRouteReport, MetricAverageScore, MetricScore, ReportJsonExpanded } from './types'
 
 const relevantMetrics = [
@@ -9,12 +10,12 @@ const relevantMetrics = [
  'interactive',
 ]
 
-export function reportJsonExpanded(unlighthouseRouteReports): ReportJsonExpanded {
+export function reportJsonExpanded(reports: UnlighthouseRouteReport[]): ReportJsonExpanded {
  let metadata = {
  metrics: {},
  categories: {},
  }
- const routes = unlighthouseRouteReports
+ const routes = reports
  .map((report) => {
  const categories = Object.values(report.report?.categories ?? {}).reduce(
  (prev: { [key: string]: CategoryScore }, category: any): any => {

diff --git a/packages/cli/src/reporters/jsonSimple.ts b/packages/cli/src/reporters/jsonSimple.ts
@@ -1,5 +1,5 @@
 import type { UnlighthouseRouteReport } from '../types'
-import type { ReportJsonSimple } from './types'
+import type { ReportJsonSimple, SimpleRouteReport } from './types'
 
 export function reportJsonSimple(reports: UnlighthouseRouteReport[]): ReportJsonSimple {
  return reports
@@ -9,7 +9,7 @@ export function reportJsonSimple(reports: UnlighthouseRouteReport[]): ReportJson
  // @ts-expect-error untyped
  scores[category.key] = category.score
  })
- return {
+ return <SimpleRouteReport> {
  path: report.route.path,
  score: report.report?.score,
  ...scores,

diff --git a/packages/cli/src/reporters/types.ts b/packages/cli/src/reporters/types.ts
@@ -14,7 +14,8 @@ export interface MetricScore {
 
 export interface SimpleRouteReport {
  path: string
- score?: string
+ score?: number | string | null
+ [key: string]: string | number | null
 }
 
 export interface ExpandedRouteReport extends SimpleRouteReport {