checkErrorResponse documented in the tutorial #1675
Conversation
Generated by 🚫 dangerJS |
| if (is_automated) { | ||
| badgeData.text[1] = 'automated'; // (9) | ||
| badgeData.colorscheme = 'blue'; // (9) | ||
| } else { | ||
| badgeData.text[1] = 'manual'; // (9) | ||
| badgeData.colorscheme = 'yellow'; // (9) | ||
| } | ||
| badgeData.colorB = '#008bb8'; // (9) | ||
| badgeData.colorB = data.colorB || '#008bb8'; // (9) |
There was a problem hiding this comment.
Probably a good idea, didn't even realise this was an option, it's currently only used in 5 places.
There was a problem hiding this comment.
This is actually a bug in my opinion. I wanted to update an example with code from server.js and fix this bug in a separate PR.
colorB query param can be used to override badge value color.
This is how it works (000000 is black, it works out of the box):
https://img.shields.io/github/downloads/atom/atom/total.svg?colorB=000000
But it does not work for docker automated badge:
https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg?colorB=000000
https://img.shields.io/docker/automated/_/ubuntu.svg?colorB=000000
Actually this line:
badgeData.colorB = data.colorB || '#008bb8';overrides colorscheme defined few lines above.
Overriding is implemented here:
Line 128 in 3518b64
And docker badge always has color
#008bb8https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg
https://img.shields.io/docker/automated/_/ubuntu.svg
There was a problem hiding this comment.
Hmmm. Okay, let's deal with this separately.
doc/TUTORIAL.md
Outdated
| In some cases the API may return an error or a HTTP status code indicating | ||
| a client error or a server error e.g. if the query was invalid. The error response | ||
| is handled by the [checkErrorResponse](https://github.com/badges/shields/blob/8fcc13d5bced23f53c9f075e51b419060f6cc124/lib/error-helper.js#L8) | ||
| function and a badge with a appropriate status is returned: "inaccessible" |
| sendBadge(format, badgeData); // (7) | ||
| return; // (7) | ||
| } | ||
| try { | ||
| var data = JSON.parse(buffer); // (8) | ||
| var is_automated = data.is_automated; // (8) | ||
| var parsedData = JSON.parse(buffer); // (8) |
There was a problem hiding this comment.
Should we use let and const instead of var in this tutorial?
There was a problem hiding this comment.
It's good idea to have let and const instead of var in this tutorial and in other (like https://github.com/badges/shields/blob/master/doc/service-tests.md) places. I just wanted to update a code example in this tutorial to show checkErrorResponse. Let's change var -> let and const in reference services and documentation in a separate changes. Is it OK for you?
This is a follow-up to #1670
This change contains:
server.jscheckErrorResponsefunction mentioned in tutorialserver.js