Add new metrics and handle errors gracefully

lowlighter · lowlighter · commit d76b7e29ff64 · 2020-10-12T19:12:35.000+02:00
- Handle plugins errors gracefully
- Add issue comments and organization metrics
diff --git a/README.md b/README.md
@@ -138,11 +138,10 @@ Assuming your username is `my-github-user`, you can embed your metrics in your p
 <summary>💬 Restrictions and fair use</summary>
 
 Since GitHub API has rate limitations and to avoid abuse, the shared instance has the following limitations :
-  * Images are cached for 2 hours
+  * Images are cached for 1 hour
     * Your generated metrics **won't** be updated during this amount of time
-    * If you enable or disable plugins by changing the url parameters, you'll need to wait before changes are applied
-  * You're limited to 3 requests per 2 hours
-    * Restriction **does not** apply to already cached users metrics, including your own
+    * If you enable or disable plugins in url parameters, you'll need to wait for cache expiration before these changes are applied
+  * A rate limiter prevents new metrics generation when reached, but it **does not** affect already cached users metrics, including your own
   * Most of plugins are not available
     * PageSpeed plugin can be enabled by passing `?pagespeed=1`, but metrics generation can take up some time
 
diff --git a/action/dist/index.js b/action/dist/index.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/plugins/lines/index.mjs b/src/plugins/lines/index.mjs
@@ -16,28 +16,33 @@
       console.debug(`metrics/plugins/lines/${login} > started`)
 
     //Plugin execution
-      pending.push(new Promise(async solve => {
-        //Get contributors stats from repositories
-          const lines = {added:0, deleted:0}
-          const response = await Promise.all(repositories.map(async repo => await rest.repos.getContributorsStats({owner:login, repo})))
-        //Compute changed lines
-          response.map(({data:repository}) => {
-            //Check if data are available
-              if (!Array.isArray(repository))
-                return
-            //Extract author
-              const [contributor] = repository.filter(({author}) => author.login === login)
-            //Compute editions
-              if (contributor)
-                contributor.weeks.forEach(({a, d}) => (lines.added += a, lines.deleted += d))
-          })
-        //Format values
-          lines.added = format(lines.added)
-          lines.deleted = format(lines.deleted)
-        //Save results
-          computed.plugins.lines = {...lines}
-          console.debug(`metrics/plugins/lines/${login} > ${JSON.stringify(computed.plugins.lines)}`)
-          solve()
+      pending.push(new Promise(async (solve, reject) => {
+        try {
+          //Get contributors stats from repositories
+            const lines = {added:0, deleted:0}
+            const response = await Promise.all(repositories.map(async repo => await rest.repos.getContributorsStats({owner:login, repo})))
+          //Compute changed lines
+            response.map(({data:repository}) => {
+              //Check if data are available
+                if (!Array.isArray(repository))
+                  return
+              //Extract author
+                const [contributor] = repository.filter(({author}) => author.login === login)
+              //Compute editions
+                if (contributor)
+                  contributor.weeks.forEach(({a, d}) => (lines.added += a, lines.deleted += d))
+            })
+          //Format values
+            lines.added = format(lines.added)
+            lines.deleted = format(lines.deleted)
+          //Save results
+            computed.plugins.lines = {...lines}
+            console.debug(`metrics/plugins/lines/${login} > ${JSON.stringify(computed.plugins.lines)}`)
+            solve()
+        }
+        catch (error) {
+          reject(error)
+        }
       }))
   }
 
diff --git a/src/plugins/pagespeed/index.mjs b/src/plugins/pagespeed/index.mjs
@@ -15,19 +15,32 @@
       console.debug(`metrics/plugins/pagespeed/${login} > started`)
 
     //Plugin execution
-      pending.push(new Promise(async solve => {
-        //Format url if needed
-          if (!/^https?:[/][/]/.test(url))
-            url = `https://${url}`
-        //Load scores from API
-          const scores = new Map()
-          await Promise.all(["performance", "accessibility", "best-practices", "seo"].map(async category => {
-            const {score, title} = (await axios.get(`https://www.googleapis.com/pagespeedonline/v5/runPagespeed?category=${category}&url=${url}&key=${token}`)).data.lighthouseResult.categories[category]
-            scores.set(category, {score, title})
-          }))
-        //Save results
-          computed.plugins.pagespeed = {url, scores:[scores.get("performance"), scores.get("accessibility"), scores.get("best-practices"), scores.get("seo")]}
-          console.debug(`metrics/plugins/pagespeed/${login} > ${JSON.stringify(computed.plugins.pagespeed)}`)
-          solve()
+      pending.push(new Promise(async (solve, reject) => {
+        try {
+          //Format url if needed
+            if (!/^https?:[/][/]/.test(url))
+              url = `https://${url}`
+          //Load scores from API
+            const scores = new Map()
+            await Promise.all(["performance", "accessibility", "best-practices", "seo"].map(async category => {
+              const {score, title} = (await axios.get(`https://www.googleapis.com/pagespeedonline/v5/runPagespeed?category=${category}&url=${url}&key=${token}`)).data.lighthouseResult.categories[category]
+              scores.set(category, {score, title})
+            }))
+          //Save results
+            computed.plugins.pagespeed = {url, scores:[scores.get("performance"), scores.get("accessibility"), scores.get("best-practices"), scores.get("seo")]}
+            console.debug(`metrics/plugins/pagespeed/${login} > ${JSON.stringify(computed.plugins.pagespeed)}`)
+            solve()
+        }
+        catch (error) {
+          //Thrown when token is incorrect
+            if ((error.response)&&(error.response.status)) {
+              computed.plugins.pagespeed = {url, error:`PageSpeed token error (code ${error.response.status})`}
+              console.debug(`metrics/plugins/traffic/${login} > ${error.response.status}`)
+              solve()
+              return
+            }
+          console.log(error)
+          reject(error)
+        }
       }))
   }
diff --git a/src/plugins/traffic/index.mjs b/src/plugins/traffic/index.mjs
@@ -16,18 +16,30 @@
       console.debug(`metrics/plugins/traffic/${login} > started`)
 
     //Plugin execution
-      pending.push(new Promise(async solve => {
-        //Get views stats from repositories
-          const views = {count:0, uniques:0}
-          const response = await Promise.all(repositories.map(async repo => await rest.repos.getViews({owner:login, repo})))
-        //Compute views
-          response.filter(({data}) => data).map(({data:{count, uniques}}) => (views.count += count, views.uniques += uniques))
-        //Format values
-          views.count = format(views.count)
-          views.uniques = format(views.uniques)
-        //Save results
-          computed.plugins.traffic = {views}
-          console.debug(`metrics/plugins/traffic/${login} > ${JSON.stringify(computed.plugins.traffic)}`)
-          solve()
+      pending.push(new Promise(async (solve, reject) => {
+        try {
+          //Get views stats from repositories
+            const views = {count:0, uniques:0}
+            const response = await Promise.all(repositories.map(async repo => await rest.repos.getViews({owner:login, repo})))
+          //Compute views
+            response.filter(({data}) => data).map(({data:{count, uniques}}) => (views.count += count, views.uniques += uniques))
+          //Format values
+            views.count = format(views.count)
+            views.uniques = format(views.uniques)
+          //Save results
+            computed.plugins.traffic = {views}
+            console.debug(`metrics/plugins/traffic/${login} > ${JSON.stringify(computed.plugins.traffic)}`)
+            solve()
+        } 
+        catch (error) {
+          //Thrown when token has unsufficient permissions
+            if (error.status === 403) {
+              computed.plugins.traffic = {error:`Insufficient token rights`}
+              console.debug(`metrics/plugins/traffic/${login} > ${error.status}`)
+              solve()
+              return
+            }
+          reject(error)
+        }
       }))
   }
diff --git a/src/query.graphql b/src/query.graphql
@@ -86,5 +86,11 @@ query Metrics {
     following {
       totalCount
     }
+    issueComments {
+      totalCount
+    }
+    organizations {
+      totalCount
+    }
   }
 }
diff --git a/src/style.css b/src/style.css
@@ -40,6 +40,13 @@
     margin: 0 8px;
     fill: #959da5;
   }
+  .field.error {
+    color: #cb2431;
+  }
+  .field.error svg {
+    fill: #cb2431;
+
+  }
 
 /* Displays */
   .row {
diff --git a/src/template.svg b/src/template.svg

Original file line number	Diff line number	Diff line change
`@@ -86,5 +86,11 @@ query Metrics {`
`86`	`86`	`following {`
`87`	`87`	`totalCount`
`88`	`88`	`}`
	`89`	`+ issueComments {`
	`90`	`+ totalCount`
	`91`	`+ }`
	`92`	`+ organizations {`
	`93`	`+ totalCount`
	`94`	`+ }`
`89`	`95`	`}`
`90`	`96`	`}`