fix: retry failed performance scans

harlan-zw · Mar 1, 2024 · 745f8fe · 745f8fe
1 parent ed32bed
commit 745f8fe
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/packages/core/src/puppeteer/tasks/lighthouse.ts b/packages/core/src/puppeteer/tasks/lighthouse.ts
@@ -138,7 +138,7 @@ export const runLighthouseTask: PuppeteerTask = async (props) => {
  }
  }
 
- let report = samples[0]
+ let report: LH.Result = samples[0]
  if (samples.length > 1) {
  try {
  report = computeMedianRun(samples)
@@ -153,6 +153,12 @@ export const runLighthouseTask: PuppeteerTask = async (props) => {
  routeReport.tasks.runLighthouseTask = 'failed'
  }
 
+ if (report.categories.performance && !report.categories.performance.score) {
+ logger.warn(`Lighthouse failed to performance checks for "${routeReport.route.path}", adding back to queue.`)
+ routeReport.tasks.runLighthouseTask = 'failed-retry'
+ return routeReport
+ }
+
  // we need to export all base64 data to improve the stability of the client
  if (report.audits?.['final-screenshot']?.details?.data)
  await fs.writeFile(join(routeReport.artifactPath, ReportArtifacts.screenshot), base64ToBuffer(report.audits['final-screenshot'].details.data))

diff --git a/packages/core/src/puppeteer/worker.ts b/packages/core/src/puppeteer/worker.ts
@@ -34,6 +34,7 @@ export async function createUnlighthouseWorker(tasks: Record<UnlighthouseTask, T
 
  const routeReports = new Map<string, UnlighthouseRouteReport>()
  const ignoredRoutes = new Set<string>()
+ const retriedRoutes = new Set<string>()
 
  const monitor: () => UnlighthouseWorkerStats = () => {
  const now = Date.now()
@@ -166,6 +167,16 @@ export async function createUnlighthouseWorker(tasks: Record<UnlighthouseTask, T
  }
  if (response.tasks[taskName] === 'failed')
  return
+ if (response.tasks[taskName] === 'failed-retry') {
+ // only requeue each report once
+ if (!retriedRoutes.has(id)) {
+ retriedRoutes.add(id)
+ routeReports.delete(id)
+ queueRoute(routeReport.route)
+ }
+ return
+ }
+
 
  response.tasks[taskName] = 'completed'
  routeReports.set(id, response)

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -81,7 +81,7 @@ export type UnlighthouseTask = 'inspectHtmlTask' | 'runLighthouseTask'
 /**
  * Each task ran by unlighthouse (extractHtmlPayload, runLighthouseTask) has a specific status which we can expose.
  */
-export type UnlighthouseTaskStatus = 'waiting' | 'in-progress' | 'completed' | 'failed' | 'ignore'
+export type UnlighthouseTaskStatus = 'waiting' | 'in-progress' | 'completed' | 'failed' | 'ignore' | 'failed-retry'
 
 /**
  * A fairly rigid representation of the puppeteer cluster task results (extractHtmlPayload, runLighthouseTask), combined