move [static-badge] to own service & add test

[RedSparr0w]

Move the static badge to its own service module,
Add tests.

I'm unsure how to add the custom headers back such as these though:

ask.res.setHeader('Cache-Control', 'max-age=' + cacheDuration);
ask.res.setHeader('Last-Modified', serverStartTime.toGMTString());

[shields-ci]

	Messages
📖	✨ Thanks for your contribution to Shields, @RedSparr0w!

Generated by 🚫 dangerJS

[RedSparr0w]

I can't set it so the label/message accepts being empty,
I've tried the following:

    return {
      label: label || '',
      message: message || '',
      color
    };

  static get defaultBadgeData() {
    return { label: '', message: '' };
  }

And those do not seem to help.

Any ideas?

[paulmelnikow]

Phew, thanks for taking this on!

Re the custom headers and the caching:

Because the static badge is one-of-a-kind, I think we should deal with the differences in the static badge's service class rather than building a bunch of extra features into BaseService.

So I'd suggest we give StaticBadge its own implementation of register(). That method is responsible for invoking camp.route. When you invoke it you can provide your own callback like we do in server.js and then you'll have access to the ask parameter. Plus it'll allow us to maintain the same cache behavior. The handleRequest call in the second argument to camp.route is the same as cache in server.js. You'll notice there's no call to cache in for the static badge; another reason to override register().

shields/services/base.js

Line 206 in f5fe85c

camp.route(this._regex, handleRequest({

This code translates from named params + query params to serviceData:

shields/services/base.js

Lines 209 to 214 in f5fe85c

	const namedParams = this._namedParamsForMatch(match);
	const serviceInstance = new ServiceClass({
	sendAndCacheRequest: request.asPromise,
	}, { handleInternalErrors });
	const serviceData = await serviceInstance.invokeHandler(namedParams, queryParams);
	const badgeData = this._makeBadgeData(queryParams, serviceData);

Since you don't need sendAndCacheRequest you could pass {} for context.

Re the empty message, I'd suggest we replace this code:

shields/services/base.js

Lines 187 to 190 in f5fe85c

	text: [
	overrideLabel || serviceLabel || defaultLabel || this.category,
	serviceMessage || 'n/a',
	],

with a function like this:

function coalesce(...candidates) {
  return candidates.find(c => typeof c === 'string');
}

console.log(coalesce('', 'foo', ''));
console.log(coalesce('asdf', 'foo', ''));
console.log(coalesce(null, '', 'bar'));
console.log(coalesce(undefined, '', 'bar'));

I'm pretty sure accepting an empty string anywhere along that chain will do the right thing. We aren't in the habit of returning an empty string as a kind of null.

[paulmelnikow]

@RedSparr0w Would you like me to pick up the changes to register()? I'm happy to hold off if you'd like to do it. 😁

[RedSparr0w]

If you could that would be great! 👍

[paulmelnikow]

Mind merging master into this branch when you have a moment? I wrote some steps here: #1866 (comment)

[paulmelnikow]

Reopened as #2284!