Merge pull request #42 from wicksipedia/add-retry-logic

💪 Add retry logic

action.yml

@@ -16,6 +16,14 @@ inputs:
     description: "Strategy to use when analyzing the page (mobile/desktop)."
     required: false
     default: mobile
+  maximumNumberOfRetries:
+    description: Maximum number of times to call API before failing the action
+    required: false
+    default: 3
+  delayBetweenRetries:
+    description: Duration in ms to wait before retrying
+    required: false
+    default: 3000
 outputs:
   accessibility:
     description: accessibility output

src/lighthouseResultScore.ts

@@ -0,0 +1,5 @@
+/* eslint-disable filenames/match-regex */
+export interface LighthouseResultScore {
+  title: string
+  score: number
+}

src/main.ts

@@ -1,35 +1,39 @@
 import * as core from '@actions/core'
 import fetch from 'node-fetch'
+import {LighthouseResultScore} from './lighthouseResultScore'
 
 async function run(): Promise<void> {
   try {
-    const queryParams = {
-      key: core.getInput('key', {required: true}),
-      url: core.getInput('url', {required: true}),
-      strategy: core.getInput('strategy'),
-      categories: core.getMultilineInput('categories').map(x => x.toUpperCase())
-    }
-    core.debug(`Query params: ${JSON.stringify(queryParams, null, 2)}`)
-
-    const url = new URL(
-      'https://www.googleapis.com/pagespeedonline/v5/runPagespeed'
-    )
-    url.searchParams.append('key', core.getInput('key', {required: true}))
-    url.searchParams.append('url', core.getInput('url', {required: true}))
-    url.searchParams.append('strategy', core.getInput('strategy'))
-    for (const category of core.getMultilineInput('categories')) {
-      url.searchParams.append('category', category.toUpperCase())
-    }
-    core.debug(`URL: ${url.toString()}`)
+    const url = getPagespeedInsightAPIUrl()
 
-    core.info(`Running Page Speed Insights for ${queryParams.url}`)
-    const response = await fetch(url.toString())
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const data: any = await response.json()
+    const maximumNumberOfRetries = +core.getInput('maximumNumberOfRetries')
+    const delayBetweenRetries = +core.getInput('delayBetweenRetries')
+    let retryCount = 0
 
-    const lighthouseResult = data.lighthouseResult
-    for (const category of Object.values(lighthouseResult.categories)) {
-      processCategory(category)
+    while (retryCount < maximumNumberOfRetries) {
+      if (await getLighthouseResult(url)) {
+        core.info(
+          `✅ PageSpeed Insights - Website has been analayzed successfully!`
+        )
+        break
+      }
+
+      core.info(
+        `⚠️ Something went wrong! Retry ${
+          retryCount + 1
+        }/${maximumNumberOfRetries} - Reattempting it in ${
+          delayBetweenRetries / 1000
+        } secs`
+      )
+      retryCount++
+
+      if (retryCount < maximumNumberOfRetries) {
+        await new Promise(resolve => setTimeout(resolve, delayBetweenRetries))
+      } else {
+        throw new Error(
+          '❌ PageSpeed Insights - failed to analayze the Website'
+        )
+      }
     }
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)
@@ -38,17 +42,57 @@ async function run(): Promise<void> {
 
 run()
 
+type PagespeedUrl = URL
+
+function getPagespeedInsightAPIUrl(): PagespeedUrl {
+  const queryParams = {
+    key: core.getInput('key', {required: true}),
+    url: core.getInput('url', {required: true}),
+    strategy: core.getInput('strategy'),
+    categories: core.getMultilineInput('categories').map(x => x.toUpperCase())
+  }
+
+  core.debug(`Query params: ${JSON.stringify(queryParams, null, 2)}`)
+
+  const url = new URL(
+    'https://www.googleapis.com/pagespeedonline/v5/runPagespeed'
+  )
+  url.searchParams.append('key', core.getInput('key', {required: true}))
+  url.searchParams.append('url', core.getInput('url', {required: true}))
+  url.searchParams.append('strategy', core.getInput('strategy'))
+  for (const category of core.getMultilineInput('categories')) {
+    url.searchParams.append('category', category.toUpperCase())
+  }
+  core.debug(`URL: ${url.toString()}`)
+
+  return url
+}
+
+async function getLighthouseResult(url: URL): Promise<boolean> {
+  const response = await fetch(url.toString())
+  if (response.ok) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const data: any = await response.json()
+
+    const lighthouseResult = data.lighthouseResult
+    for (const category of Object.values(
+      lighthouseResult?.categories as LighthouseResultScore[]
+    )) {
+      const title = snakeCase(category.title)
+      const score = category.score * 100
+      core.debug(`${title}: ${score}`)
+      core.setOutput(title, score)
+    }
+
+    return true
+  }
+
+  return false
+}
+
 function snakeCase(s: string): string {
   return s
     .replace(/([a-z])([A-Z])/g, '$1_$2')
     .replace(/\s+/g, '_')
     .toLowerCase()
 }
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function processCategory(category: any): void {
-  const title = snakeCase(category.title)
-  const score = category.score * 100
-  core.debug(`${title}: ${score}`)
-  core.setOutput(title, score)
-}