Reorganize a couple of the legacy helpers [npm node jenkinsplugin dynamic] (#3163)

core/base-service/coalesce-badge.js

@@ -4,9 +4,9 @@ const {
   decodeDataUrlFromQueryParam,
   prepareNamedLogo,
 } = require('../../lib/logos')
-const { toArray } = require('../../lib/badge-data')
 const { svg2base64 } = require('../../lib/svg-helpers')
 const coalesce = require('./coalesce')
+const toArray = require('./to-array')
 
 // Translate modern badge data to the legacy schema understood by the badge
 // maker. Allow the user to override the label, color, logo, etc. through the

core/base-service/to-array.js

@@ -0,0 +1,11 @@
+'use strict'
+
+module.exports = function toArray(val) {
+  if (val === undefined) {
+    return []
+  } else if (Object(val) instanceof Array) {
+    return val
+  } else {
+    return [val]
+  }
+}

core/legacy/regular-update.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { Inaccessible, InvalidResponse } = require('../core/base-service/errors')
+const { Inaccessible, InvalidResponse } = require('../base-service/errors')
 
 // Map from URL to { timestamp: last fetch time, data: data }.
 let regularUpdateCache = Object.create(null)
@@ -12,7 +12,7 @@ let regularUpdateCache = Object.create(null)
 // To use this from a service:
 //
 // const { promisify } = require('util')
-// const { regularUpdate } = require('../../lib/regular-update')
+// const { regularUpdate } = require('../../core/legacy/regular-update')
 //
 // function getThing() {
 //   return promisify(regularUpdate)({

core/server/server.js

@@ -16,7 +16,7 @@ const {
   handleRequest,
   clearRequestCache,
 } = require('../base-service/legacy-request-handler')
-const { clearRegularUpdateCache } = require('../../lib/regular-update')
+const { clearRegularUpdateCache } = require('../legacy/regular-update')
 const { staticBadgeUrl } = require('../badge-urls/make-badge-url')
 const analytics = require('./analytics')
 const log = require('./log')

doc/production-hosting.md

@@ -74,7 +74,7 @@ Shields has mercifully little persistent state:
 
 [github auth admin endpoint]: https://github.com/badges/shields/blob/master/services/github/auth/admin.js
 [request cache]: https://github.com/badges/shields/blob/master/core/base-service/legacy-request-handler.js#L29-L30
-[regular-update cache]: https://github.com/badges/shields/blob/master/lib/regular-update.js
+[regular-update cache]: https://github.com/badges/shields/blob/master/core/legacy/regular-update.js
 [raster cache]: https://github.com/badges/shields/blob/master/gh-badges/lib/svg-to-img.js#L9-L10
 [oauth transfer]: https://developer.github.com/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app/
 

lib/badge-data.js

@@ -1,18 +1,9 @@
 'use strict'
 
 const coalesce = require('../core/base-service/coalesce')
+const toArray = require('../core/base-service/to-array')
 const { makeLogo } = require('./logos')
 
-function toArray(val) {
-  if (val === undefined) {
-    return []
-  } else if (Object(val) instanceof Array) {
-    return val
-  } else {
-    return [val]
-  }
-}
-
 function makeLabel(defaultLabel, overrides) {
   return `${
     overrides.label === undefined

services/dynamic-common.js

@@ -1,8 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const toArray = require('../core/base-service/to-array')
 const validate = require('../core/base-service/validate')
-const { toArray } = require('../lib/badge-data')
 const { InvalidResponse } = require('.')
 
 const errorMessages = {

services/jenkins/jenkins-plugin-version.service.js

@@ -2,7 +2,7 @@
 
 const LegacyService = require('../legacy-service')
 const { makeBadgeData: getBadgeData } = require('../../lib/badge-data')
-const { regularUpdate } = require('../../lib/regular-update')
+const { regularUpdate } = require('../../core/legacy/regular-update')
 const { addv: versionText } = require('../text-formatters')
 const { version: versionColor } = require('../color-formatters')
 

services/licenses.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { toArray } = require('../lib/badge-data')
+const toArray = require('../core/base-service/to-array')
 
 const licenseTypes = {
   // permissive licenses - not public domain and not copyleft

services/node/node-version-color.js

@@ -2,7 +2,7 @@
 
 const { promisify } = require('util')
 const semver = require('semver')
-const { regularUpdate } = require('../../lib/regular-update')
+const { regularUpdate } = require('../../core/legacy/regular-update')
 
 function getLatestVersion() {
   return promisify(regularUpdate)({

services/npm/npm-license.service.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { renderLicenseBadge } = require('../licenses')
-const { toArray } = require('../../lib/badge-data')
+const toArray = require('../../core/base-service/to-array')
 const NpmBase = require('./npm-base')
 
 module.exports = class NpmLicense extends NpmBase {

services/nuget/nuget-v3-service-family.js

@@ -2,7 +2,7 @@
 
 const { promisify } = require('util')
 const Joi = require('joi')
-const { regularUpdate } = require('../../lib/regular-update')
+const { regularUpdate } = require('../../core/legacy/regular-update')
 const RouteBuilder = require('../route-builder')
 const { BaseJsonService, NotFound } = require('..')
 const { renderVersionBadge, renderDownloadBadge } = require('./nuget-helpers')

services/php-version.js

@@ -7,7 +7,7 @@
 
 const { promisify } = require('util')
 const request = require('request')
-const { regularUpdate } = require('../lib/regular-update')
+const { regularUpdate } = require('../core/legacy/regular-update')
 const { listCompare } = require('./version')
 const { omitv } = require('./text-formatters')
 

services/route-builder.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { toArray } = require('../lib/badge-data')
+const toArray = require('../core/base-service/to-array')
 
 /*
  * Factory class for building a BaseService `route` object. This class is useful