Move [StaticBadge] to own service & add test; also affects [gitter] #2284
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| 'use strict' | ||
|
|
||
| const { makeMakeBadgeFn } = require('../lib/make-badge') | ||
| const { makeSend } = require('../lib/result-sender') | ||
| const analytics = require('../lib/analytics') | ||
| const BaseService = require('./base') | ||
|
|
||
| const serverStartTime = new Date(new Date().toGMTString()) | ||
|
There was a problem hiding this comment. There's no point in passing this down from |
||
|
|
||
| module.exports = class BaseStaticService extends BaseService { | ||
| // Note: Since this is a static service, it is not `async`. | ||
| handle(namedParams, queryParams) { | ||
| throw new Error(`Handler not implemented for ${this.constructor.name}`) | ||
| } | ||
|
|
||
| static register({ camp, measurer }, serviceConfig) { | ||
| const makeBadge = makeMakeBadgeFn(measurer) | ||
|
|
||
| camp.route(this._regex, (queryParams, match, end, ask) => { | ||
| analytics.noteRequest(queryParams, match) | ||
|
|
||
| if (+new Date(ask.req.headers['if-modified-since']) >= +serverStartTime) { | ||
| // Send Not Modified. | ||
| ask.res.statusCode = 304 | ||
| ask.res.end() | ||
| return | ||
| } | ||
|
There was a problem hiding this comment. Currently this behavior is not tested. |
||
|
|
||
| const serviceInstance = new this({}, serviceConfig) | ||
| const namedParams = this._namedParamsForMatch(match) | ||
| let serviceData | ||
| try { | ||
| // Note: no `await`. | ||
| serviceData = serviceInstance.handle(namedParams, queryParams) | ||
| } catch (error) { | ||
| serviceData = serviceInstance._handleError(error) | ||
| } | ||
|
|
||
| const badgeData = this._makeBadgeData(queryParams, serviceData) | ||
|
|
||
| // The final capture group is the extension. | ||
| const format = match.slice(-1)[0] | ||
| badgeData.format = format | ||
|
|
||
| if (serviceConfig.profiling.makeBadge) { | ||
| console.time('makeBadge total') | ||
| } | ||
| const svg = makeBadge(badgeData) | ||
| if (serviceConfig.profiling.makeBadge) { | ||
| console.timeEnd('makeBadge total') | ||
| } | ||
|
|
||
| const cacheDuration = 3600 * 24 * 1 // 1 day. | ||
| ask.res.setHeader('Cache-Control', `max-age=${cacheDuration}`) | ||
| ask.res.setHeader('Last-Modified', serverStartTime.toGMTString()) | ||
|
There was a problem hiding this comment. Currently this behavior is not tested. |
||
|
|
||
| makeSend(format, ask.res, end)(svg) | ||
| }) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,10 @@ const { | |
| const { staticBadgeUrl } = require('../lib/make-badge-url') | ||
| const trace = require('./trace') | ||
|
|
||
| function coalesce(...candidates) { | ||
| return candidates.find(c => typeof c === 'string') | ||
| } | ||
|
|
||
| class BaseService { | ||
| constructor({ sendAndCacheRequest }, { handleInternalErrors }) { | ||
| this._requestFetcher = sendAndCacheRequest | ||
|
|
@@ -248,6 +252,52 @@ class BaseService { | |
| return result | ||
| } | ||
|
|
||
| _handleError(error) { | ||
|
There was a problem hiding this comment. Extract into a method so |
||
| if (error instanceof NotFound || error instanceof InvalidParameter) { | ||
| trace.logTrace('outbound', emojic.noGoodWoman, 'Handled error', error) | ||
| return { | ||
| message: error.prettyMessage, | ||
| color: 'red', | ||
| } | ||
| } else if ( | ||
| error instanceof InvalidResponse || | ||
| error instanceof Inaccessible || | ||
| error instanceof Deprecated | ||
| ) { | ||
| trace.logTrace('outbound', emojic.noGoodWoman, 'Handled error', error) | ||
| return { | ||
| message: error.prettyMessage, | ||
| color: 'lightgray', | ||
| } | ||
| } else if (this._handleInternalErrors) { | ||
| if ( | ||
| !trace.logTrace( | ||
| 'unhandledError', | ||
| emojic.boom, | ||
| 'Unhandled internal error', | ||
| error | ||
| ) | ||
| ) { | ||
| // This is where we end up if an unhandled exception is thrown in | ||
| // production. Send the error to the logs. | ||
| console.log(error) | ||
| } | ||
| return { | ||
| label: 'shields', | ||
| message: 'internal error', | ||
| color: 'lightgray', | ||
| } | ||
| } else { | ||
| trace.logTrace( | ||
| 'unhandledError', | ||
| emojic.boom, | ||
| 'Unhandled internal error', | ||
| error | ||
| ) | ||
| throw error | ||
| } | ||
| } | ||
|
|
||
| async invokeHandler(namedParams, queryParams) { | ||
| trace.logTrace( | ||
| 'inbound', | ||
|
|
@@ -260,49 +310,7 @@ class BaseService { | |
| try { | ||
| return await this.handle(namedParams, queryParams) | ||
| } catch (error) { | ||
| return this._handleError(error) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -333,8 +341,10 @@ class BaseService { | |
|
|
||
| const badgeData = { | ||
| text: [ | ||
| // Use `coalesce()` to support empty labels and messages, as in the | ||
| // static badge. | ||
| coalesce(overrideLabel, serviceLabel, defaultLabel, this.category), | ||
| coalesce(serviceMessage, 'n/a'), | ||
|
There was a problem hiding this comment. This is covered by the static badge tests @RedSparr0w wrote. |
||
| ], | ||
| template: style, | ||
| logo: makeLogo(style === 'social' ? defaultLogo : undefined, { | ||
|
|
@@ -352,30 +362,28 @@ class BaseService { | |
| } | ||
|
|
||
| static register({ camp, handleRequest, githubApiProvider }, serviceConfig) { | ||
|
There was a problem hiding this comment. Some references use |
||
| camp.route( | ||
| this._regex, | ||
| handleRequest({ | ||
| queryParams: this.route.queryParams, | ||
| handler: async (queryParams, match, sendBadge, request) => { | ||
| const serviceInstance = new this( | ||
| { | ||
| sendAndCacheRequest: request.asPromise, | ||
| sendAndCacheRequestWithCallbacks: request, | ||
| githubApiProvider, | ||
| }, | ||
| serviceConfig | ||
| ) | ||
| const namedParams = this._namedParamsForMatch(match) | ||
| const serviceData = await serviceInstance.invokeHandler( | ||
| namedParams, | ||
| queryParams | ||
| ) | ||
| trace.logTrace('outbound', emojic.shield, 'Service data', serviceData) | ||
| const badgeData = this._makeBadgeData(queryParams, serviceData) | ||
|
|
||
| // The final capture group is the extension. | ||
| const format = match.slice(-1)[0] | ||
| sendBadge(format, badgeData) | ||
| }, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,39 @@ | ||
| 'use strict' | ||
|
|
||
| const BaseStaticService = require('../base-static') | ||
|
|
||
| module.exports = class Gitter extends BaseStaticService { | ||
| static get category() { | ||
| return 'chat' | ||
| } | ||
|
|
||
| static get route() { | ||
| return { | ||
| base: 'gitter/room', | ||
| pattern: ':user/:repo', | ||
| } | ||
| } | ||
|
|
||
| static get examples() { | ||
| return [ | ||
| { | ||
| title: 'Gitter', | ||
| urlPattern: ':user/:repo', | ||
| staticExample: this.render(), | ||
| exampleUrl: 'nwjs/nw.js', | ||
| }, | ||
| ] | ||
| } | ||
|
|
||
| static get defaultBadgeData() { | ||
| return { label: 'chat' } | ||
| } | ||
|
|
||
| static render() { | ||
| return { message: 'on gitter', color: 'brightgreen' } | ||
| } | ||
|
|
||
| handle() { | ||
| return this.constructor.render() | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically unrelated, as in the current implementation the static badge does not call this function.
There's no need for
parseIntsince we're passing numbers, not strings.