Changelog for Release server-2021-05-01 (#6447)

* Update Changelog

Co-authored-by: release[bot] <actions@users.noreply.github.com>
Co-authored-by: chris48s <chris48s@users.noreply.github.com>

.circleci/config.yml

@@ -4,20 +4,13 @@ main_steps: &main_steps
   steps:
     - checkout
 
-    - restore_cache:
-        keys:
-          - v2-dependencies-{{ checksum "package-lock.json" }}
-          # https://github.com/badges/shields/issues/1937
-          - v2-dependencies-
-
     - run:
         name: Install dependencies
         command: npm ci
-
-    - save_cache:
-        paths:
-          - node_modules
-        key: v2-dependencies-{{ checksum "package-lock.json" }}
+        environment:
+          # https://docs.cypress.io/guides/getting-started/installing-cypress.html#Skipping-installation
+          # We don't need to install the Cypress binary in jobs that aren't actually running Cypress.
+          CYPRESS_INSTALL_BINARY: 0
 
     - run:
         name: Linter
@@ -52,15 +45,11 @@ integration_steps: &integration_steps
   steps:
     - checkout
 
-    - restore_cache:
-        keys:
-          - v2-dependencies-{{ checksum "package-lock.json" }}
-          # https://github.com/badges/shields/issues/1937
-          - v2-dependencies-
-
     - run:
         name: Install dependencies
         command: npm ci
+        environment:
+          CYPRESS_INSTALL_BINARY: 0
 
     - run:
         name: Integration tests
@@ -77,15 +66,11 @@ services_steps: &services_steps
   steps:
     - checkout
 
-    - restore_cache:
-        keys:
-          - v2-dependencies-{{ checksum "package-lock.json" }}
-          # https://github.com/badges/shields/issues/1937
-          - v2-dependencies-
-
     - run:
         name: Install dependencies
         command: npm ci
+        environment:
+          CYPRESS_INSTALL_BINARY: 0
 
     - run:
         name: Identify services tagged in the PR title
@@ -96,35 +81,17 @@ services_steps: &services_steps
         environment:
           mocha_reporter: mocha-junit-reporter
           MOCHA_FILE: junit/services/results.xml
-        command: npm run test:services:pr:run
+        command: RETRY_COUNT=3 npm run test:services:pr:run
 
     - store_test_results:
         path: junit
 
-run_package_tests: &run_package_tests
-  when: always
-  command: |
-    # https://discuss.circleci.com/t/switch-nodejs-version-on-machine-executor-solved/26675/3
-    set +e
-    export NVM_DIR="/opt/circleci/.nvm"
-    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
-    nvm install $NODE_VERSION
-    nvm use $NODE_VERSION
-    node --version
-    npm run test:package
-
 package_steps: &package_steps
   steps:
     - checkout
 
-    - restore_cache:
-        keys:
-          - v2-dependencies-{{ checksum "package-lock.json" }}
-          # https://github.com/badges/shields/issues/1937
-          - v2-dependencies-
-
     - run:
-        name: Install dependencies
+        name: Install node and npm
         command: |
           set +e
           export NVM_DIR="/opt/circleci/.nvm"
@@ -132,109 +99,79 @@ package_steps: &package_steps
           nvm install v12
           nvm use v12
           npm install -g npm
-          npm ci
 
     # Run the package tests on each currently supported node version. See:
-    # https://github.com/badges/shields/blob/master/gh-badges/README.md#node-version-support
+    # https://github.com/badges/shields/blob/master/badge-maker/README.md#node-version-support
+    # https://nodejs.org/en/about/releases/
 
     - run:
-        <<: *run_package_tests
         environment:
           mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/gh-badges/v8/results.xml
-          NODE_VERSION: v8
-        name: Run package tests on Node 8
-
-    - run:
-        <<: *run_package_tests
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/gh-badges/v10/results.xml
+          MOCHA_FILE: junit/badge-maker/v10/results.xml
           NODE_VERSION: v10
+          CYPRESS_INSTALL_BINARY: 0
         name: Run package tests on Node 10
+        command: scripts/run_package_tests.sh
 
     - run:
-        <<: *run_package_tests
         environment:
           mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/gh-badges/v11/results.xml
-          NODE_VERSION: v11
-        name: Run package tests on Node 11
-
-    - run:
-        <<: *run_package_tests
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/gh-badges/v12/results.xml
+          MOCHA_FILE: junit/badge-maker/v12/results.xml
           NODE_VERSION: v12
+          CYPRESS_INSTALL_BINARY: 0
         name: Run package tests on Node 12
+        command: scripts/run_package_tests.sh
+
+    - run:
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/badge-maker/v14/results.xml
+          NODE_VERSION: v14
+          CYPRESS_INSTALL_BINARY: 0
+        name: Run package tests on Node 14
+        command: scripts/run_package_tests.sh
 
     - store_test_results:
         path: junit
 
 jobs:
-  npm-install:
-    docker:
-      - image: circleci/node:8
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - v2-dependencies-{{ checksum "package-lock.json" }}
-            # fallback to using the latest cache if no exact match is found
-            - v2-dependencies-
-
-      - run:
-          name: Install dependencies
-          command: npm ci
-
-      - save_cache:
-          paths:
-            - node_modules
-          key: v2-dependencies-{{ checksum "package-lock.json" }}
-
   main:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:12
 
     <<: *main_steps
 
-  main@node-latest:
+  main@node-14:
     docker:
-      - image: circleci/node:latest
+      - image: circleci/node:14
 
     <<: *main_steps
 
   integration:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:12
       - image: redis
 
     <<: *integration_steps
 
-  integration@node-latest:
+  integration@node-14:
     docker:
-      - image: circleci/node:latest
+      - image: circleci/node:14
       - image: redis
 
     <<: *integration_steps
 
   danger:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:12
     steps:
       - checkout
 
-      - restore_cache:
-          keys:
-            - v2-dependencies-{{ checksum "package-lock.json" }}
-            # https://github.com/badges/shields/issues/1937
-            - v2-dependencies-
-
       - run:
           name: Install dependencies
           command: npm ci
+          environment:
+            CYPRESS_INSTALL_BINARY: 0
 
       - run:
           name: Danger
@@ -246,29 +183,30 @@ jobs:
 
   frontend:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:12
     steps:
       - checkout
 
-      - restore_cache:
-          keys:
-            - v2-dependencies-{{ checksum "package-lock.json" }}
-            # https://github.com/badges/shields/issues/1937
-            - v2-dependencies-
-
       - run:
           name: Install dependencies
           command: npm ci
+          environment:
+            CYPRESS_INSTALL_BINARY: 0
 
       - run:
           name: Prepare frontend tests
           command: npm run defs && npm run features
 
+      - run:
+          name: Check types
+          command: npm run check-types:frontend
+
       - run:
           name: Frontend unit tests
           environment:
             mocha_reporter: mocha-junit-reporter
             MOCHA_FILE: junit/frontend/results.xml
+          when: always
           command: npm run test:frontend
 
       - store_test_results:
@@ -286,27 +224,26 @@ jobs:
 
   services:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:12
 
     <<: *services_steps
 
-  services@node-latest:
+  services@node-14:
     docker:
-      - image: circleci/node:latest
+      - image: circleci/node:14
 
     <<: *services_steps
 
   e2e:
     docker:
-      - image: cypress/base:8
+      - image: cypress/base:12
     steps:
       - checkout
 
       - restore_cache:
+          name: Restore Cypress binary
           keys:
-            - v2-dependencies-{{ checksum "package-lock.json" }}
-            # https://github.com/badges/shields/issues/1937
-            - v2-dependencies-
+            - v2-cypress-dependencies-{{ checksum "package-lock.json" }}
 
       - run:
           name: Install dependencies
@@ -332,6 +269,13 @@ jobs:
       - store_artifacts:
           path: cypress/screenshots
 
+      - save_cache:
+          name: Cache Cypress binary
+          paths:
+            # https://docs.cypress.io/guides/getting-started/installing-cypress.html#Binary-cache
+            - ~/.cache/Cypress
+          key: v2-cypress-dependencies-{{ checksum "package-lock.json" }}
+
 workflows:
   version: 2
 
@@ -341,11 +285,11 @@ workflows:
           filters:
             branches:
               ignore: gh-pages
-      - main@node-latest:
+      - main@node-14:
           filters:
             branches:
               ignore: gh-pages
-      - integration@node-latest:
+      - integration@node-14:
           filters:
             branches:
               ignore: gh-pages
@@ -363,7 +307,7 @@ workflows:
               ignore:
                 - master
                 - gh-pages
-      - services@node-latest:
+      - services@node-14:
           filters:
             branches:
               ignore:

.dependabot/config.yml

@@ -4,8 +4,35 @@ update_configs:
   - package_manager: 'javascript'
     directory: '/'
     update_schedule: 'weekly'
+    automerged_updates:
+      - match:
+          dependency_name: 'chai*'
+          update_type: 'semver:minor'
+      - match:
+          dependency_name: 'cypress'
+          update_type: 'semver:minor'
+      - match:
+          dependency_name: 'eslint*'
+          update_type: 'semver:minor'
+      - match:
+          dependency_name: 'mocha*'
+          update_type: 'semver:minor'
+      - match:
+          dependency_name: 'sazerac'
+          update_type: 'semver:minor'
+      - match:
+          dependency_name: 'sinon*'
+          update_type: 'semver:minor'
+      - match:
+          dependency_name: 'snap-shot-it'
+          update_type: 'semver:minor'
 
-  # gh-badges package dependencies
+  # badge-maker package dependencies
   - package_manager: 'javascript'
-    directory: '/gh-badges'
+    directory: '/badge-maker'
+    update_schedule: 'weekly'
+
+  # approve-bot package dependencies
+  - package_manager: 'javascript'
+    directory: '.github/actions/approve-bot'
     update_schedule: 'weekly'

.eslintignore

@@ -1,5 +1,7 @@
+/api-docs/
 /build
 /coverage
 /__snapshots__
 /public
-gh-badges/node_modules/
+badge-maker/node_modules/
+!.github/

.eslintrc-frontend.yml

@@ -1,28 +0,0 @@
-env:
-  browser: true
-
-plugins:
-  - import
-  - react-hooks
-
-parser: 'babel-eslint'
-
-parserOptions:
-  sourceType: 'module'
-
-extends:
-  - 'standard-jsx'
-  - 'standard-react'
-  - './.eslintrc.yml'
-
-settings:
-  react:
-    version: '16.4'
-
-rules:
-  no-console: 'error'
-
-  import/extensions: ['error', 'never', { 'json': 'always', 'yml': 'always' }]
-  react/jsx-sort-props: 'error'
-  react-hooks/rules-of-hooks: 'error'
-  react-hooks/exhaustive-deps: 'error'

.eslintrc.yml

@@ -1,21 +1,82 @@
 extends:
   - standard
+  - standard-jsx
+  - standard-react
+  - plugin:@typescript-eslint/recommended
   - prettier
+  - eslint:recommended
 
-env:
-  node: true
-  mocha: true
+globals:
+  JSX: 'readonly'
 
 parserOptions:
   # Override eslint-config-standard, which incorrectly sets this to "module",
   # though that setting is only for ES6 modules, not CommonJS modules.
   sourceType: 'script'
 
+settings:
+  react:
+    version: '16.8'
+  jsdoc:
+    mode: jsdoc
+
+plugins:
+  - chai-friendly
+  - jsdoc
+  - mocha
+  - no-extension-in-require
+  - sort-class-members
+  - import
+  - react-hooks
+  - promise
+
 overrides:
+  # For simplicity's sake, when possible prefer to add rules to the top-level
+  # list of rules, even if they only apply to certain files. That way the
+  # rules listed here are only ones which conflict.
+
   - files:
-      - gatsby-browser.js
+      - '**/*.js'
+      - '!frontend/**/*.js'
+    env:
+      node: true
+      es6: true
+    rules:
+      no-console: 'off'
+      '@typescript-eslint/explicit-module-boundary-types': 'off'
+
+  - files:
+      - '**/*.@(ts|tsx)'
     parserOptions:
       sourceType: 'module'
+    parser: '@typescript-eslint/parser'
+    rules:
+      # Argh.
+      '@typescript-eslint/explicit-function-return-type':
+        ['error', { 'allowExpressions': true }]
+      '@typescript-eslint/no-empty-function': 'error'
+      '@typescript-eslint/no-var-requires': 'error'
+      '@typescript-eslint/no-object-literal-type-assertion': 'off'
+      '@typescript-eslint/no-explicit-any': 'error'
+      '@typescript-eslint/ban-ts-ignore': 'off'
+      '@typescript-eslint/explicit-module-boundary-types': 'off'
+
+  - files:
+      - core/**/*.ts
+    parserOptions:
+      sourceType: 'module'
+    parser: '@typescript-eslint/parser'
+  - files:
+      - gatsby-browser.js
+      - 'frontend/**/*.@(js|ts|tsx)'
+    parserOptions:
+      sourceType: 'module'
+    env:
+      browser: true
+    rules:
+      import/extensions:
+        ['error', 'never', { 'json': 'always', 'yml': 'always' }]
+
   - files:
       - 'core/base-service/**/*.js'
       - 'services/**/*.js'
@@ -30,6 +91,7 @@ overrides:
                 'category',
                 'isDeprecated',
                 'route',
+                'auth',
                 'examples',
                 '_cacheLength',
                 'defaultBadgeData',
@@ -42,24 +104,34 @@ overrides:
           },
         ]
 
-plugins:
-  - mocha
-  - no-extension-in-require
-  - chai-friendly
-  - sort-class-members
+  - files:
+      - '**/*.spec.@(js|ts|tsx)'
+      - '**/*.integration.js'
+      - '**/test-helpers.js'
+      - 'core/service-test-runner/**/*.js'
+    env:
+      mocha: true
+    rules:
+      mocha/no-exclusive-tests: 'error'
+      mocha/no-mocha-arrows: 'error'
+      mocha/prefer-arrow-callback: 'error'
 
 rules:
   # Disable some rules from eslint:recommended.
-  no-console: 'off'
   no-empty: ['error', { 'allowEmptyCatch': true }]
+
   # Allow unused parameters. In callbacks, removing them seems to obscure
   # what the functions are doing.
-  no-unused-vars: ['error', { 'args': 'none' }]
+  '@typescript-eslint/no-unused-vars': ['error', { 'args': 'none' }]
+  no-unused-vars: 'off'
+
+  '@typescript-eslint/no-var-requires': 'off'
+
+  '@typescript-eslint/no-use-before-define': 'error'
+  no-use-before-define: 'off'
 
   # These should be disabled by eslint-config-prettier, but are not.
-  spaced-comment: 'off'
-  standard/object-curly-even-spacing: 'off'
-  one-var: 'off'
+  no-extra-semi: 'off'
 
   # Shields additions.
   no-var: 'error'
@@ -74,11 +146,54 @@ rules:
   new-cap: ['error', { 'capIsNew': true }]
   import/order: ['error', { 'newlines-between': 'never' }]
 
-  # Mocha-related.
-  mocha/no-exclusive-tests: 'error'
-  mocha/no-mocha-arrows: 'error'
-  mocha/prefer-arrow-callback: 'error'
+  # Account for destructuring responses from upstream services,
+  # many of which do not follow camelcase
+  # Based on original rule configuration from eslint-config-standard
+  camelcase:
+    [
+      'error',
+      {
+        ignoreDestructuring: true,
+        properties: 'never',
+        ignoreGlobals: true,
+        allow: ['^UNSAFE_'],
+      },
+    ]
 
   # Chai friendly.
   no-unused-expressions: 'off'
   chai-friendly/no-unused-expressions: 'error'
+
+  # jsdoc plugin:
+  # don't require every class/function to have a docblock
+  jsdoc/require-jsdoc: 'off'
+
+  # allow Joi as an undefined type
+  jsdoc/no-undefined-types: ['error', { definedTypes: ['Joi'] }]
+
+  # all the other recommended rules as errors (not warnings)
+  jsdoc/check-alignment: 'error'
+  jsdoc/check-param-names: 'error'
+  jsdoc/check-tag-names: 'error'
+  jsdoc/check-types: 'error'
+  jsdoc/implements-on-classes: 'error'
+  jsdoc/newline-after-description: 'error'
+  jsdoc/require-param: 'error'
+  jsdoc/require-param-description: 'error'
+  jsdoc/require-param-name: 'error'
+  jsdoc/require-param-type: 'error'
+  jsdoc/require-returns: 'error'
+  jsdoc/require-returns-check: 'error'
+  jsdoc/require-returns-description: 'error'
+  jsdoc/require-returns-type: 'error'
+  jsdoc/valid-types: 'error'
+
+  # Disable some from TypeScript.
+  '@typescript-eslint/camelcase': off
+  '@typescript-eslint/explicit-function-return-type': 'off'
+  '@typescript-eslint/no-empty-function': 'off'
+
+  react/jsx-sort-props: 'error'
+  react-hooks/rules-of-hooks: 'error'
+  react-hooks/exhaustive-deps: 'error'
+  jsx-quotes: ['error', 'prefer-double']

.github/ISSUE_TEMPLATE/1_Bug_report.md

@@ -1,13 +1,14 @@
 ---
 name: 🐛 Bug Report
 about: Report errors and problems
+labels: 'question'
 ---
 
 Are you experiencing an issue with...
 
 - [ ] [shields.io](https://shields.io/#/)
 - [ ] My own instance
-- [ ] [gh-badges NPM package](https://www.npmjs.com/package/gh-badges)
+- [ ] [badge-maker NPM package](https://www.npmjs.com/package/badge-maker)
 
 :beetle: **Description**
 

.github/ISSUE_TEMPLATE/2_Failing_service_test.md

@@ -1,6 +1,7 @@
 ---
 name: 💚 Failing service test
 about: Note failing service tests
+labels: 'keep-service-tests-green'
 ---
 
 :clock11: **When did the problem start?**

.github/ISSUE_TEMPLATE/3_Badge_request.md

@@ -1,6 +1,7 @@
 ---
 name: 💡 Badge Request
 about: Ideas for new badges
+labels: 'service-badge'
 ---
 
 :clipboard: **Description**

.github/ISSUE_TEMPLATE/5_Support_question.md

@@ -1,16 +0,0 @@
----
-name: ❓ Support Question
-about: Ask a question about shields.io
----
-
-:question: **Question**
-
-<!--
-Ask your question clearly and concisely.
-
-#support on our [Discord](https://discordapp.com/invite/HjJCwm5)
-is also a great place to ask questions and get help
--->
-
-<!-- Love Shields? Please consider donating $10 to sustain our activities:
-👉  https://opencollective.com/shields -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: 🎨 Simple Icons
+    url: https://github.com/badges/shields/discussions/5369
+    about: Please read this before posting a question about SimpleIcons
+  - name: ❓ Support Question
+    url: https://github.com/badges/shields/discussions
+    about: Ask a question about Shields.io

.github/actions/approve-bot/action.yml

@@ -0,0 +1,12 @@
+name: 'Auto Approve'
+description: 'Automatically approve/close selected pull requests for shields.io'
+branding:
+  icon: 'check-circle'
+  color: 'green'
+inputs:
+  github-token:
+    description: 'The GITHUB_TOKEN secret'
+    required: true
+runs:
+  using: 'node12'
+  main: 'index.js'

.github/actions/approve-bot/helpers.js

@@ -0,0 +1,65 @@
+'use strict'
+
+function findChangelogStart(lines) {
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i]
+    if (
+      line === '<summary>Changelog</summary>' &&
+      lines[i + 2] === '<blockquote>'
+    ) {
+      return i + 3
+    }
+  }
+  return null
+}
+
+function findChangelogEnd(lines, start) {
+  for (let i = start; i < lines.length; i++) {
+    const line = lines[i]
+    if (line === '</blockquote>') {
+      return i
+    }
+  }
+  return null
+}
+
+function allChangelogLinesAreVersionBump(changelogLines) {
+  return (
+    changelogLines.length > 0 &&
+    changelogLines.length ===
+      changelogLines.filter(line =>
+        line.includes('Version bump only for package')
+      ).length
+  )
+}
+
+function isPointlessGatsbyBump(body) {
+  const lines = body.split(/\r?\n/)
+  if (
+    !lines[0].includes('https://github.com/gatsbyjs/gatsby') // lgtm [js/incomplete-url-substring-sanitization]
+  ) {
+    return false
+  }
+  const start = findChangelogStart(lines)
+  const end = findChangelogEnd(lines, start)
+  if (!start || !end) {
+    return false
+  }
+  const changelogLines = lines
+    .slice(start, end)
+    .filter(line => !line.startsWith('<h'))
+    .filter(line => !line.startsWith('<p>All notable changes'))
+    .filter(
+      line => !line.startsWith('See <a href="https://conventionalcommits.org">')
+    )
+    .filter(line => !line.startsWith('<!--'))
+  return allChangelogLinesAreVersionBump(changelogLines)
+}
+
+function shouldAutoMerge(body) {
+  return body.includes(
+    'If all status checks pass Dependabot will automatically merge this pull request'
+  )
+}
+
+module.exports = { isPointlessGatsbyBump, shouldAutoMerge }

.github/actions/approve-bot/index.js

@@ -0,0 +1,56 @@
+'use strict'
+
+const core = require('@actions/core')
+const github = require('@actions/github')
+const { isPointlessGatsbyBump, shouldAutoMerge } = require('./helpers')
+
+async function run() {
+  try {
+    const token = core.getInput('github-token', { required: true })
+
+    const { pull_request: pr } = github.context.payload
+    if (!pr) {
+      throw new Error('Event payload missing `pull_request`')
+    }
+
+    const client = github.getOctokit(token)
+
+    if (
+      ['dependabot[bot]', 'dependabot-preview[bot]'].includes(pr.user.login)
+    ) {
+      if (isPointlessGatsbyBump(pr.body)) {
+        core.debug(`Closing pull request #${pr.number}`)
+        await client.pulls.update({
+          owner: github.context.repo.owner,
+          repo: github.context.repo.repo,
+          pull_number: pr.number,
+          state: 'closed',
+        })
+
+        core.debug(`Done.`)
+      } else if (shouldAutoMerge(pr.body)) {
+        core.debug(`Adding label to pull request #${pr.number}`)
+        await client.issues.addLabels({
+          owner: github.context.repo.owner,
+          repo: github.context.repo.repo,
+          issue_number: pr.number,
+          labels: ['squash when passing'],
+        })
+
+        core.debug(`Creating approving review for pull request #${pr.number}`)
+        await client.pulls.createReview({
+          owner: github.context.repo.owner,
+          repo: github.context.repo.repo,
+          pull_number: pr.number,
+          event: 'APPROVE',
+        })
+
+        core.debug(`Done.`)
+      }
+    }
+  } catch (error) {
+    core.setFailed(error.message)
+  }
+}
+
+run()

.github/actions/approve-bot/package-lock.json

@@ -0,0 +1,177 @@
+{
+  "name": "approve-bot",
+  "version": "0.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "@actions/core": {
+      "version": "1.2.7",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.7.tgz",
+      "integrity": "sha512-kzLFD5BgEvq6ubcxdgPbRKGD2Qrgya/5j+wh4LZzqT915I0V3rED+MvjH6NXghbvk1MXknpNNQ3uKjXSEN00Ig=="
+    },
+    "@actions/github": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-4.0.0.tgz",
+      "integrity": "sha512-Ej/Y2E+VV6sR9X7pWL5F3VgEWrABaT292DRqRU6R4hnQjPtC/zD3nagxVdXWiRQvYDh8kHXo7IDmG42eJ/dOMA==",
+      "requires": {
+        "@actions/http-client": "^1.0.8",
+        "@octokit/core": "^3.0.0",
+        "@octokit/plugin-paginate-rest": "^2.2.3",
+        "@octokit/plugin-rest-endpoint-methods": "^4.0.0"
+      }
+    },
+    "@actions/http-client": {
+      "version": "1.0.9",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.9.tgz",
+      "integrity": "sha512-0O4SsJ7q+MK0ycvXPl2e6bMXV7dxAXOGjrXS1eTF9s2S401Tp6c/P3c3Joz04QefC1J6Gt942Wl2jbm3f4mLcg==",
+      "requires": {
+        "tunnel": "0.0.6"
+      }
+    },
+    "@octokit/auth-token": {
+      "version": "2.4.5",
+      "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.5.tgz",
+      "integrity": "sha512-BpGYsPgJt05M7/L/5FoE1PiAbdxXFZkX/3kDYcsvd1v6UhlnE5e96dTDr0ezX/EFwciQxf3cNV0loipsURU+WA==",
+      "requires": {
+        "@octokit/types": "^6.0.3"
+      }
+    },
+    "@octokit/core": {
+      "version": "3.2.5",
+      "resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.2.5.tgz",
+      "integrity": "sha512-+DCtPykGnvXKWWQI0E1XD+CCeWSBhB6kwItXqfFmNBlIlhczuDPbg+P6BtLnVBaRJDAjv+1mrUJuRsFSjktopg==",
+      "requires": {
+        "@octokit/auth-token": "^2.4.4",
+        "@octokit/graphql": "^4.5.8",
+        "@octokit/request": "^5.4.12",
+        "@octokit/types": "^6.0.3",
+        "before-after-hook": "^2.1.0",
+        "universal-user-agent": "^6.0.0"
+      }
+    },
+    "@octokit/endpoint": {
+      "version": "6.0.11",
+      "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.11.tgz",
+      "integrity": "sha512-fUIPpx+pZyoLW4GCs3yMnlj2LfoXTWDUVPTC4V3MUEKZm48W+XYpeWSZCv+vYF1ZABUm2CqnDVf1sFtIYrj7KQ==",
+      "requires": {
+        "@octokit/types": "^6.0.3",
+        "is-plain-object": "^5.0.0",
+        "universal-user-agent": "^6.0.0"
+      }
+    },
+    "@octokit/graphql": {
+      "version": "4.5.9",
+      "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.5.9.tgz",
+      "integrity": "sha512-c+0yofIugUNqo+ktrLaBlWSbjSq/UF8ChAyxQzbD3X74k1vAuyLKdDJmPwVExUFSp6+U1FzWe+3OkeRsIqV0vg==",
+      "requires": {
+        "@octokit/request": "^5.3.0",
+        "@octokit/types": "^6.0.3",
+        "universal-user-agent": "^6.0.0"
+      }
+    },
+    "@octokit/openapi-types": {
+      "version": "3.3.0",
+      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-3.3.0.tgz",
+      "integrity": "sha512-s3dd32gagPmKaSLNJ9aPNok7U+tl69YLESf6DgQz5Ml/iipPZtif3GLvWpNXoA6qspFm1LFUZX+C3SqWX/Y/TQ=="
+    },
+    "@octokit/plugin-paginate-rest": {
+      "version": "2.9.0",
+      "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.9.0.tgz",
+      "integrity": "sha512-XxbOg45r2n/2QpU6hnGDxQNDRrJ7gjYpMXeDbUCigWTHECmjoyFLizkFO2jMEtidMkfiELn7AF8GBAJ/cbPTnA==",
+      "requires": {
+        "@octokit/types": "^6.6.0"
+      }
+    },
+    "@octokit/plugin-rest-endpoint-methods": {
+      "version": "4.9.0",
+      "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-4.9.0.tgz",
+      "integrity": "sha512-EAr2epvY8JfXSi/cdMsyyfBctdKkolDH7xSgu3MKBqPRm0WfQ2QvI050jz61XZXoVK3ZgrhdMCyd1GgOFz7CSw==",
+      "requires": {
+        "@octokit/types": "^6.6.0",
+        "deprecation": "^2.3.1"
+      }
+    },
+    "@octokit/request": {
+      "version": "5.4.13",
+      "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.13.tgz",
+      "integrity": "sha512-WcNRH5XPPtg7i1g9Da5U9dvZ6YbTffw9BN2rVezYiE7couoSyaRsw0e+Tl8uk1fArHE7Dn14U7YqUDy59WaqEw==",
+      "requires": {
+        "@octokit/endpoint": "^6.0.1",
+        "@octokit/request-error": "^2.0.0",
+        "@octokit/types": "^6.0.3",
+        "deprecation": "^2.0.0",
+        "is-plain-object": "^5.0.0",
+        "node-fetch": "^2.6.1",
+        "once": "^1.4.0",
+        "universal-user-agent": "^6.0.0"
+      }
+    },
+    "@octokit/request-error": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.5.tgz",
+      "integrity": "sha512-T/2wcCFyM7SkXzNoyVNWjyVlUwBvW3igM3Btr/eKYiPmucXTtkxt2RBsf6gn3LTzaLSLTQtNmvg+dGsOxQrjZg==",
+      "requires": {
+        "@octokit/types": "^6.0.3",
+        "deprecation": "^2.0.0",
+        "once": "^1.4.0"
+      }
+    },
+    "@octokit/types": {
+      "version": "6.6.0",
+      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.6.0.tgz",
+      "integrity": "sha512-nmFoU3HCbw1AmnZU/eto2VvzV06+N7oAqXwMmAHGlNDF+KFykksh/VlAl85xc1P5T7Mw8fKYvXNaImNHCCH/rg==",
+      "requires": {
+        "@octokit/openapi-types": "^3.3.0",
+        "@types/node": ">= 8"
+      }
+    },
+    "@types/node": {
+      "version": "14.14.22",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.22.tgz",
+      "integrity": "sha512-g+f/qj/cNcqKkc3tFqlXOYjrmZA+jNBiDzbP3kH+B+otKFqAdPgVTGP1IeKRdMml/aE69as5S4FqtxAbl+LaMw=="
+    },
+    "before-after-hook": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.1.0.tgz",
+      "integrity": "sha512-IWIbu7pMqyw3EAJHzzHbWa85b6oud/yfKYg5rqB5hNE8CeMi3nX+2C2sj0HswfblST86hpVEOAb9x34NZd6P7A=="
+    },
+    "deprecation": {
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz",
+      "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ=="
+    },
+    "is-plain-object": {
+      "version": "5.0.0",
+      "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-5.0.0.tgz",
+      "integrity": "sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q=="
+    },
+    "node-fetch": {
+      "version": "2.6.1",
+      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz",
+      "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw=="
+    },
+    "once": {
+      "version": "1.4.0",
+      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+      "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
+      "requires": {
+        "wrappy": "1"
+      }
+    },
+    "tunnel": {
+      "version": "0.0.6",
+      "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
+      "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg=="
+    },
+    "universal-user-agent": {
+      "version": "6.0.0",
+      "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.0.tgz",
+      "integrity": "sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w=="
+    },
+    "wrappy": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+      "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8="
+    }
+  }
+}

.github/actions/approve-bot/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "approve-bot",
+  "version": "0.0.0",
+  "description": "",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "chris48s",
+  "license": "CC0",
+  "dependencies": {
+    "@actions/core": "^1.2.7",
+    "@actions/github": "^4.0.0"
+  }
+}

.github/actions/draft-release/Dockerfile

@@ -0,0 +1,8 @@
+FROM node:12-buster
+
+RUN apt-get update
+RUN apt-get install -y jq
+RUN apt-get install -y uuid-runtime
+COPY entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

.github/actions/draft-release/action.yml

@@ -0,0 +1,5 @@
+name: 'draft-release'
+description: 'Generate a changelog and propose a release PR'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

.github/actions/draft-release/entrypoint.sh

@@ -0,0 +1,62 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+# Set up a git user
+git config user.name "release[bot]"
+git config user.email "actions@users.noreply.github.com"
+
+# Find last server-YYYY-MM-DD tag
+git fetch --unshallow --tags
+LAST_TAG=$(git tag | grep server | tail -n 1)
+
+# Find the marker in CHANGELOG.md
+INSERT_POINT=$(grep -n "^\-\-\-$" CHANGELOG.md | cut -f1 -d:)
+INSERT_POINT=$((INSERT_POINT+1))
+
+# Generate a release name
+RELEASE_NAME="server-$(date --rfc-3339=date)"
+
+# Assemble changelog entry
+rm -f temp-changes.txt
+touch temp-changes.txt
+{
+    echo "## $RELEASE_NAME"
+    echo ""
+    git log "$LAST_TAG"..HEAD --no-merges --oneline --pretty="format:- %s" --perl-regexp --author='^((?!dependabot).*)$'
+    echo $'\n- Dependency updates\n'
+} >> temp-changes.txt
+BASE_URL="https:\/\/github.com\/badges\/shields\/issues\/"
+sed -r -i "s/\((\#)([0-9]+)\)$/\[\1\2\]\($BASE_URL\2\)/g" temp-changes.txt
+
+# Write the changelog
+sed -i "${INSERT_POINT} r temp-changes.txt" CHANGELOG.md
+
+# Cleanup
+rm temp-changes.txt
+
+# Run prettier (to ensure the markdown file doesn't fail CI)
+npx prettier@$(cat package.json | jq -r .devDependencies.prettier) --write "CHANGELOG.md"
+
+# Generate a unique branch name
+BRANCH_NAME="$RELEASE_NAME"-$(uuidgen | head -c 8)
+git checkout -b "$BRANCH_NAME"
+
+# Commit + push changelog
+git add CHANGELOG.md
+git commit -m "Update Changelog"
+git push origin "$BRANCH_NAME"
+
+# Submit a PR
+TITLE="Changelog for Release $RELEASE_NAME"
+PR_RESP=$(curl https://api.github.com/repos/"$REPO_NAME"/pulls \
+    -X POST \
+    -H "Authorization: token $GITHUB_TOKEN" \
+    --data '{"title": "'"$TITLE"'", "body": "'"$TITLE"'", "head": "'"$BRANCH_NAME"'", "base": "master"}')
+
+# Add the 'release' label to the PR
+PR_API_URL=$(echo "$PR_RESP" | jq -r ._links.issue.href)
+curl "$PR_API_URL" \
+    -X POST \
+    -H "Authorization: token $GITHUB_TOKEN" \
+    --data '{"labels":["release"]}'

.github/probot.js

@@ -1,10 +0,0 @@
-on('pull_request.closed')
-  .filter(context => context.payload.pull_request.merged)
-  .filter(
-    context =>
-      context.payload.pull_request.head.ref.slice(0, 11) !== 'dependabot/'
-  )
-  .filter(context => context.payload.pull_request.base.ref === 'master')
-  .comment(`This pull request was merged to [{{ pull_request.base.ref }}]({{ repository.html_url }}/tree/{{ pull_request.base.ref }}) branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our \`#ops\` channel on [Discord](https://discordapp.com/invite/HjJCwm5)!
-  
-After deployment, changes are copied to [gh-pages]({{ repository.html_url }}/tree/gh-pages) branch: ![](https://img.shields.io/github/commit-status/{{ repository.full_name }}/gh-pages/{{ pull_request.merge_commit_sha }}.svg?label=deploy%20status)`)

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+<!--
+    Be sure to review our Contributing guidelines to help streamline the merging of your PR!
+
+    * PR title conventions - https://github.com/badges/shields/blob/master/CONTRIBUTING.md#running-service-tests-in-pull-requests
+    * Code formatting - https://github.com/badges/shields/blob/master/CONTRIBUTING.md#prettier
+    * Merge processes and reminders - https://github.com/badges/shields/blob/master/CONTRIBUTING.md#pull-requests
+-->

.github/workflows/auto-approve.yml

@@ -0,0 +1,16 @@
+name: Auto approve
+on: pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install action dependencies
+        run: cd .github/actions/approve-bot && npm ci
+
+      - uses: ./.github/actions/approve-bot
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/deploy-docs.yml

@@ -0,0 +1,26 @@
+name: Deploy Documentation
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.1
+        with:
+          persist-credentials: false
+
+      - name: Build
+        run: |
+          npm ci
+          npm run build-docs
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@3.7.1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: api-docs
+          CLEAN: true

.github/workflows/draft-release.yml

@@ -0,0 +1,19 @@
+name: Draft Release
+on:
+  schedule:
+    - cron: '0 1 1 * *'
+    # At 01:00 on the first day of every month
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Draft Release
+        uses: ./.github/actions/draft-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO_NAME: ${{ github.repository }}

.github/workflows/tag-release.yml

@@ -0,0 +1,31 @@
+name: Tag Release
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  tag-release:
+    if: |
+      github.event_name == 'pull_request' &&
+      github.event.action == 'closed' &&
+      github.event.pull_request.merged == true &&
+      contains(github.event.pull_request.labels.*.name, 'release')
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date --rfc-3339=date)"
+
+      - name: Checkout branch "master"
+        uses: actions/checkout@v2
+        with:
+          ref: 'master'
+
+      - name: Tag Release
+        uses: tvdias/github-tagger@v0.0.2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          tag: server-${{ steps.date.outputs.date }}

.gitignore

@@ -7,7 +7,7 @@
 /private
 /index.html
 /shields.env
-gh-badges/package-lock.json
+badge-maker/package-lock.json
 
 # Folder view configuration files
 .DS_Store
@@ -110,3 +110,9 @@ service-definitions.yml
 # Cypress
 /cypress/videos/
 /cypress/screenshots/
+
+# Rendered API docs
+/api-docs/
+
+# Flamebearer
+flamegraph.html

.gitpod.yml

@@ -1,5 +1,27 @@
 ports:
   - port: 8080
+    onOpen: open-preview
 tasks:
   - init: npm ci && npm run build
     command: node server 8080 0.0.0.0
+github:
+  prebuilds:
+    # enable for the master/default branch (defaults to true)
+    master: true
+    # enable for all branches in this repo (defaults to false)
+    branches: false
+    # enable for pull requests coming from this repo (defaults to true)
+    pullRequests: true
+    # enable for pull requests coming from forks (defaults to false)
+    pullRequestsFromForks: true
+    # add a check to pull requests (defaults to true)
+    addCheck: true
+    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
+    addComment: false
+    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
+    addBadge: false
+    # add a label once the prebuild is ready to pull requests (defaults to false)
+    addLabel: false
+vscode:
+  extensions:
+    - esbenp.prettier-vscode@1.7.0:EbyqFvwe32qQBptkOgfQpQ==

.nowignore

@@ -1,30 +0,0 @@
-*
-!frontend/
-!gh-badges/
-!lib/
-!core/
-!logo/
-!pages/
-!public/
-!templates/
-!services/
-!package-lock.json
-!/*.js
-!scripts/export-*.js
-!config/
-config/local*.yml
-*.spec.js
-*~
-.env
-.circleci
-.github
-.vscode
-__snapshots__
-.buildpacks
-.eslint*
-.editorconfig
-.nycrc*
-.gitpod*
-.prettier*
-CONTRIBUTING.md
-Dockerfile

.nycrc.json

@@ -9,9 +9,12 @@
     "**/test-helpers.js",
     "**/*-test-helpers.js",
     "**/*-fixtures.js",
+    "**/mocha-*.js",
+    "**/*.test-d.ts",
     "dangerfile.js",
     "gatsby-*.js",
     "core/service-test-runner",
+    "core/got-test-client.js",
     "services/**/*.tester.js",
     "services/test-validators.js",
     "services/tester.js",

.prettierignore

@@ -3,12 +3,12 @@ package-lock.json
 /__snapshots__
 /.next
 /.cache
+/api-docs
 /build
 /public
 /coverage
 private/*.json
 /.nyc_output
 analytics.json
-gh-badges/templates/default-template.json
 supported-features.json
 service-definitions.yml

.prettierrc.yml

@@ -1,5 +1,5 @@
 semi: false
 singleQuote: true
-trailingComma: es5
 bracketSpacing: true
 endOfLine: lf
+arrowParens: avoid

.vscode/extensions.json

@@ -1,7 +1,3 @@
 {
-  "recommendations": [
-    "esbenp.prettier-vscode",
-    "EditorConfig.EditorConfig",
-    "dbaeumer.vscode-eslint"
-  ]
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
 }

CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+Note: this changelog is for the shields.io server. The changelog for the badge-maker NPM package is at https://github.com/badges/shields/blob/master/badge-maker/CHANGELOG.md
+
+---
+
+## server-2021-05-01
+
+- Add setting which allows setting a timeout on HTTP requests
+  This is configured with the new `REQUEST_TIMEOUT_SECONDS` setting. If a request takes longer
+  than this number of seconds a `408 Request Timeout` response will be returned.
+- Deprecate [Bintray] service [#6423](https://github.com/badges/shields/issues/6423)
+- Support git hash in [nexus] SNAPSHOT version [#6369](https://github.com/badges/shields/issues/6369)
+- Replace 4183C4 with blue [#6366](https://github.com/badges/shields/issues/6366)
+- [Youtube] Added channel view count and subscriber count badges [#6333](https://github.com/badges/shields/issues/6333)
+- Fix Netlify badge by adding new color schema [#6340](https://github.com/badges/shields/issues/6340)
+- [REUSE] Add service badges [#6330](https://github.com/badges/shields/issues/6330)
+- Dependency updates
+
+## server-2021-04-01
+
+- Use NPM packages to provide fonts instead of Google Fonts [#6274](https://github.com/badges/shields/issues/6274)
+- Prevent duplication of parameters in badge examples [#6272](https://github.com/badges/shields/issues/6272)
+- Add docs for all types of releases [#6210](https://github.com/badges/shields/issues/6210)
+- refresh self-hosting docs [#6273](https://github.com/badges/shields/issues/6273)
+- allow missing 'goal' key in [liberapay] badges [#6258](https://github.com/badges/shields/issues/6258)
+- use got to push influx metrics [#6257](https://github.com/badges/shields/issues/6257)
+- Dependency updates
+
+## server-2021-03-01
+
+- ensure redirect target path is correctly encoded [#6229](https://github.com/badges/shields/issues/6229)
+- [SecurityHeaders] Added a possibility for no follow redirects [#6212](https://github.com/badges/shields/issues/6212)
+- catch URL parse error in [endpoint] badge [#6214](https://github.com/badges/shields/issues/6214)
+- [Homebrew] Add homebrew downloads badge [#6209](https://github.com/badges/shields/issues/6209)
+- update [pkgreview] url [#6189](https://github.com/badges/shields/issues/6189)
+- Make [Twitch] a social badge [#6183](https://github.com/badges/shields/issues/6183)
+- update [flathub] error handling [#6185](https://github.com/badges/shields/issues/6185)
+- Add [Testspace] badges [#6162](https://github.com/badges/shields/issues/6162)
+- Dependency updates
+
+## server-2021-02-01
+
+- Docs.rs badge (#6098)
+- Fix feedz service in case the package page gets paginated (#6101)
+- [Bitbucket] Server Adding Auth Tokens and Resolving Pull Request api … (#6076)
+- Dependency updates
+
+## server-2021-01-18
+
+- Gotta start somewhere

CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+![](https://img.shields.io/badge/conduct-%40shields.io-blue) or directly to [@calebcartwright](https://github.com/calebcartwright) ![](https://img.shields.io/badge/caleb-%40shields.io-blue) or [@paulmelnikow](https://github.com/paulmelnikow) ![](https://img.shields.io/badge/paul-%40shields.io-blue)
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -24,10 +24,20 @@ maybe you'd like to open a pull request to address one of them:
 
 You can help by improving the project's usage and developer instructions.
 
+Tutorials are in [/doc](https://github.com/badges/shields/tree/master/doc):
+
 - When you read the documentation, you can fix mistakes and add your own thoughts.
 - When your pull request follows the documentation but the practice changed,
   consider pointing this out and change the documentation for the next person.
 
+API documentation is at [contributing.shields.io](https://contributing.shields.io/):
+
+- This documentation is generated by annotating the code with
+  [JSDoc](https://jsdoc.app/about-getting-started.html) comments.
+  [Example](https://github.com/badges/shields/blob/b3be4d94d5ef570b8daccfd088c343a958988843/core/base-service/base-json.js#L26-L41)
+- Adding a JSDoc comment to some existing code is a great first contribution
+  and a good way to familiarize yourself with the codebase
+
 ### Helping others
 
 You can help with code review, which reduces bugs, and over time has a
@@ -39,8 +49,9 @@ simple changes, like badge additions. These are usually tagged with
 
 Please review [these impeccable guidelines][code review guidelines].
 
-You can monitor [issues][] and the [chat room][], and help other people who
-have questions about contributing to Shields, or using it for their projects.
+You can monitor [issues][], [discussions][] and the [chat room][], and help
+other people who have questions about contributing to Shields, or using it
+for their projects.
 
 Feel free to reach out to one of the [maintainers][]
 if you need help getting started.
@@ -48,6 +59,7 @@ if you need help getting started.
 [service badge pr tag]: https://github.com/badges/shields/pulls?q=is%3Apr+is%3Aopen+label%3Aservice-badge
 [code review guidelines]: https://kickstarter.engineering/a-guide-to-mindful-communication-in-code-reviews-48aab5282e5e
 [issues]: https://github.com/badges/shields/issues
+[discussions]: https://github.com/badges/shields/discussions
 [chat room]: https://discordapp.com/invite/HjJCwm5
 [maintainers]: https://github.com/badges/shields#project-leaders
 
@@ -76,9 +88,9 @@ We're also asking for [one-time \$10 donations](https://opencollective.com/shiel
 There are three places to get help:
 
 1. If you're new to the project, a good place to start is the [tutorial][].
-2. If you need help getting started or implementing a change, [open an issue][]
+2. If you need help getting started or implementing a change, [start a discussion][discussions]
    with your question. We promise it's okay to do that. If there is already an
-   issue open for the feature you're working on, you can post there.
+   issue open for the feature you're working on, you can post there directly.
 3. You can also join the [chat room][] and ask your question there.
 
 [tutorial]: doc/TUTORIAL.md
@@ -86,21 +98,23 @@ There are three places to get help:
 ## Badge guidelines
 
 - Shields.io hosts integrations for services which are primarily
-  used by developers or which are widely used by developers
+  used by developers or which are widely used by developers.
 - The left-hand side of a badge should not advertise. It should be a lowercase _noun_
   succinctly describing the meaning of the right-hand side.
-- Except for badges using the `social` style, logos should be _turned off by
+- Except for badges using the `social` style, logos and links should be _turned off by
   default_.
+- Badges should not obtain data from undocumented or reverse-engineered API endpoints.
+- Badges should not obtain data by scraping web pages - these are likely to break frequently.
+  Whereas API publishers are incentivised to maintain a stable platform for their users,
+  authors of web pages have no such incentive.
+- Badges may require users to specify a token in the badge URL as long it is scoped only to
+  fetching information and doesn't expose any sensitive information. Generating a token with the
+  correct scope must be clearly documented.
 
 ## Badge URLs
 
-- The format of new badges should be of the form
-  `/SERVICE/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
-  `/gitter/room/nwjs/nw.js.svg`. The vendor is gitter, the
-  badge is for rooms, the parameter is nwjs/nw.js, and the format is svg.
-- For services which require a hostname, the badge should be of the form
-  `/SERVICE/SCHEME/HOST/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
-  `/discourse/https/discourse.example.com/topics.svg`.
+- The format of new badges should be of the form `/SERVICE/NOUN/PARAMETERS`.
+- There is further documentation on this in [badge-urls](https://github.com/badges/shields/blob/master/doc/badge-urls.md)
 
 ## Coding guidelines
 
@@ -117,13 +131,7 @@ Prettier before a commit by default.
 
 ### Tests
 
-When adding or changing a service [please write tests][service-tests].
-
-When opening a pull request, include your service name in brackets in the pull
-request title. That way, those service tests will run in CI.
-
-e.g. **[Travis] Fix timeout issues**
-
+When adding or changing a service [please write tests][service-tests], and ensure the [title of your Pull Requests follows the required conventions](#running-service-tests-in-pull-requests) to ensure your tests are executed.
 When changing other code, please add unit tests.
 
 To run the integration tests, you must have redis installed and in your PATH.
@@ -139,3 +147,35 @@ There is a [High-level code walkthrough](doc/code-walkthrough.md) describing the
 ### Logos
 
 We have [documentation for logo usage](doc/logos.md) which includes [contribution guidance](doc/logos.md#contributing-logos)
+
+## Pull Requests
+
+All code changes are incorporated via pull requests, and pull requests are always squashed into a single commit on merging. Therefore there's no requirement to squash commits within your PR, but feel free to squash or restructure the commits on your PR branch if you think it will be helpful. PRs with well structured commits are always easier to review!
+
+Because all changes are pulled into the main branch via squash merges from PRs, we do **not** support overwriting any aspects of the git history once it hits our main branch. Notably this means we do not support amending commit messages, nor adjusting commit author information once merged.
+
+Accordingly, it is the responsibility of contributors to review this type of information and adjust as needed before marking PRs as ready for review and merging.
+
+You can review and modify your local [git configuration][git-config] via `git config`, and also find more information about amending your commit messages [here][amending-commits].
+
+[git-config]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration
+[amending-commits]: https://docs.github.com/en/github/committing-changes-to-your-project/changing-a-commit-message#rewriting-the-most-recent-commit-message
+
+### Running service tests in pull requests
+
+The affected service names must be included in square brackets in the pull request title so that the CI engine will run those service tests. When a pull request affects multiple services, they should be separated with spaces. The test runner is case-insensitive, so they should be capitalized for readability.
+
+For example:
+
+- **[Travis] Fix timeout issues**
+- **[Travis Sonar] Support user token authentication**
+- **Add tests for [CRAN] and [CPAN]**
+
+Note that many services are part of a "family" of related services. Depending on the changes in your PR you may need to run the tests for just a single service, or for _all_ the services within a family.
+
+For example, a PR title of **[GitHubForks] Foo** will only run the service tests specifically for the GitHub Forks badge, whereas a title of **[GitHub] Foo** will run the service tests for all of the GitHub badges.
+
+In the rare case when it's necessary to see the output of a full service-test
+run in a PR (all 2,000+ tests), include `[*****]` in the title. Unless all the tests pass, the build
+will fail, so likely it will be necessary to remove it and re-run the tests
+before merging.

Dockerfile

@@ -1,17 +1,15 @@
-FROM node:8-alpine
-
-RUN apk add --no-cache gettext imagemagick librsvg git
+FROM node:12-alpine
 
 RUN mkdir -p /usr/src/app
 RUN mkdir /usr/src/app/private
 WORKDIR /usr/src/app
 
 COPY package.json package-lock.json /usr/src/app/
-# Without the gh-badges package.json and CLI script in place, `npm ci` will fail.
-COPY gh-badges /usr/src/app/gh-badges/
+# Without the badge-maker package.json and CLI script in place, `npm ci` will fail.
+COPY badge-maker /usr/src/app/badge-maker/
 
-# We need dev deps to build the front end.
-RUN NODE_ENV=development npm ci
+# We need dev deps to build the front end. We don't need Cypress, though.
+RUN NODE_ENV=development CYPRESS_INSTALL_BINARY=0 npm ci
 
 COPY . /usr/src/app
 RUN npm run build

Makefile

@@ -1,70 +0,0 @@
-SHELL:=/bin/bash
-
-SERVER_TMP=${TMPDIR}shields-server-deploy
-FRONTEND_TMP=${TMPDIR}shields-frontend-deploy
-
-# This branch is reserved for the deploy process and should not be used for
-# development. The deploy script will clobber it. To avoid accidentally
-# pushing secrets to GitHub, this branch is configured to reject pushes.
-WORKING_BRANCH=server-deploy-working-branch
-
-all: test
-
-deploy: deploy-s0 deploy-s1 deploy-s2 clean-server-deploy deploy-gh-pages deploy-gh-pages-clean
-
-deploy-s0: prepare-server-deploy push-s0
-deploy-s1: prepare-server-deploy push-s1
-deploy-s2: prepare-server-deploy push-s2
-
-prepare-server-deploy:
-	# Ship a copy of the front end to each server for debugging.
-	# https://github.com/badges/shields/issues/1220
-	INCLUDE_DEV_PAGES=false \
-		npm run build
-	rm -rf ${SERVER_TMP}
-	git worktree prune
-	git worktree add -B ${WORKING_BRANCH} ${SERVER_TMP}
-	cp -r public ${SERVER_TMP}
-	git -C ${SERVER_TMP} add -f public/
-	git -C ${SERVER_TMP} commit --no-verify -m '[DEPLOY] Add frontend for debugging'
-	cp config/local-shields-io-production.yml ${SERVER_TMP}/config/
-	git -C ${SERVER_TMP} add -f config/local-shields-io-production.yml
-	git -C ${SERVER_TMP} commit --no-verify -m '[DEPLOY] MUST NOT BE ON GITHUB'
-
-clean-server-deploy:
-	rm -rf ${SERVER_TMP}
-	git worktree prune
-
-push-s0:
-	git push -f s0 ${WORKING_BRANCH}:master
-
-push-s1:
-	git push -f s1 ${WORKING_BRANCH}:master
-
-push-s2:
-	git push -f s2 ${WORKING_BRANCH}:master
-
-deploy-gh-pages:
-	rm -rf ${FRONTEND_TMP}
-	git worktree prune
-	GATSBY_BASE_URL=https://img.shields.io \
-		INCLUDE_DEV_PAGES=false \
-		npm run build
-	git worktree add -B gh-pages ${FRONTEND_TMP}
-	git -C ${FRONTEND_TMP} ls-files | xargs git -C ${FRONTEND_TMP} rm
-	git -C ${FRONTEND_TMP} commit --no-verify -m '[DEPLOY] Completely clean the index'
-	cp -r public/* ${FRONTEND_TMP}
-	echo shields.io > ${FRONTEND_TMP}/CNAME
-	touch ${FRONTEND_TMP}/.nojekyll
-	git -C ${FRONTEND_TMP} add .
-	git -C ${FRONTEND_TMP} commit --no-verify -m '[DEPLOY] Add built site'
-	git push -f origin gh-pages
-
-deploy-gh-pages-clean:
-	rm -rf ${FRONTEND_TMP}
-	git worktree prune
-
-test:
-	npm test
-
-.PHONY: all deploy prepare-server-deploy clean-server-deploy deploy-s0 deploy-s1 deploy-s2 push-s0 push-s1 push-s2 deploy-gh-pages deploy-gh-pages-clean deploy-heroku setup redis test

README.md

@@ -1,35 +1,32 @@
 <p align="center">
-    <img src="./frontend/images/logo.svg"
+    <img src="https://raw.githubusercontent.com/badges/shields/master/readme-logo.svg?sanitize=true"
         height="130">
 </p>
 <p align="center">
     <a href="https://github.com/badges/shields/graphs/contributors" alt="Contributors">
-        <img src="https://img.shields.io/github/contributors/badges/shields.svg" /></a>
+        <img src="https://img.shields.io/github/contributors/badges/shields" /></a>
     <a href="#backers" alt="Backers on Open Collective">
-        <img src="https://img.shields.io/opencollective/backers/shields.svg" /></a>
+        <img src="https://img.shields.io/opencollective/backers/shields" /></a>
     <a href="#sponsors" alt="Sponsors on Open Collective">
-        <img src="https://img.shields.io/opencollective/sponsors/shields.svg" /></a>
+        <img src="https://img.shields.io/opencollective/sponsors/shields" /></a>
     <a href="https://github.com/badges/shields/pulse" alt="Activity">
-        <img src="https://img.shields.io/github/commit-activity/m/badges/shields.svg" /></a>
+        <img src="https://img.shields.io/github/commit-activity/m/badges/shields" /></a>
     <a href="https://circleci.com/gh/badges/shields/tree/master">
-        <img src="https://img.shields.io/circleci/project/github/badges/shields/master.svg" alt="build status"></a>
+        <img src="https://img.shields.io/circleci/project/github/badges/shields/master" alt="build status"></a>
     <a href="https://circleci.com/gh/badges/daily-tests">
-        <img src="https://img.shields.io/circleci/project/github/badges/daily-tests.svg?label=service%20tests"
+        <img src="https://img.shields.io/circleci/project/github/badges/daily-tests?label=service%20tests"
             alt="service-test status"></a>
     <a href="https://coveralls.io/github/badges/shields">
-        <img src="https://img.shields.io/coveralls/github/badges/shields.svg"
+        <img src="https://img.shields.io/coveralls/github/badges/shields"
             alt="coverage"></a>
     <a href="https://lgtm.com/projects/g/badges/shields/alerts/">
-        <img src="https://img.shields.io/lgtm/alerts/g/badges/shields.svg"
+        <img src="https://img.shields.io/lgtm/alerts/g/badges/shields"
             alt="Total alerts"/></a>
-    <a href="https://github.com/badges/shields/compare/gh-pages...master">
-        <img src="https://img.shields.io/github/commits-since/badges/shields/gh-pages.svg?label=commits%20to%20be%20deployed"
-            alt="commits to be deployed"></a>
     <a href="https://discord.gg/HjJCwm5">
-        <img src="https://img.shields.io/discord/308323056592486420.svg?logo=discord"
+        <img src="https://img.shields.io/discord/308323056592486420?logo=discord"
             alt="chat on Discord"></a>
     <a href="https://twitter.com/intent/follow?screen_name=shields_io">
-        <img src="https://img.shields.io/twitter/follow/shields_io.svg?style=social&logo=twitter"
+        <img src="https://img.shields.io/twitter/follow/shields_io?style=social&logo=twitter"
             alt="follow on Twitter"></a>
 </p>
 
@@ -38,42 +35,52 @@ and legible badges in SVG and raster format, which can easily be included in
 GitHub readmes or any other web page. The service supports dozens of
 continuous integration services, package registries, distributions, app
 stores, social networks, code coverage services, and code analysis services.
-Every month it serves over 470 million images.
+Every month it serves over 770 million images and is used by some of the
+world's most popular open-source projects, [VS Code][vscode], [Vue.js][vue]
+and [Bootstrap][bootstrap] to name a few.
+
+[vscode]: https://github.com/Microsoft/vscode
+[vue]: https://github.com/vuejs/vue
+[bootstrap]: https://github.com/twbs/bootstrap
 
 This repo hosts:
 
 - The [Shields.io][shields.io] frontend and server code
-- An [NPM library for generating badges][gh-badges]
-  - [documentation][gh-badges-docs]
-  - [changelog][gh-badges-changelog]
+- An [NPM library for generating badges][badge-maker]
+  - [documentation][badge-maker-docs]
+  - [changelog][badge-maker-changelog]
 - The [badge design specification][badge-spec]
 
 [shields.io]: https://shields.io/
-[gh-badges]: https://www.npmjs.com/package/gh-badges
+[badge-maker]: https://www.npmjs.com/package/badge-maker
 [badge-spec]: https://github.com/badges/shields/tree/master/spec
-[gh-badges-docs]: https://github.com/badges/shields/tree/master/gh-badges/README.md
-[gh-badges-changelog]: https://github.com/badges/shields/tree/master/gh-badges/CHANGELOG.md
+[badge-maker-docs]: https://github.com/badges/shields/tree/master/badge-maker/README.md
+[badge-maker-changelog]: https://github.com/badges/shields/tree/master/badge-maker/CHANGELOG.md
 
 ## Examples
 
-- code coverage percentage: ![coverage](https://img.shields.io/badge/coverage-80%25-yellowgreen.svg?cacheSeconds=2592000)
-- stable release version: ![version](https://img.shields.io/badge/version-1.2.3-blue.svg?cacheSeconds=2592000)
-- package manager release: ![gem](https://img.shields.io/badge/gem-2.2.0-blue.svg?cacheSeconds=2592000)
-- status of third-party dependencies: ![dependencies](https://img.shields.io/badge/dependencies-out%20of%20date-orange.svg?cacheSeconds=2592000)
-- static code analysis grade: ![codacy](https://img.shields.io/badge/codacy-B-green.svg?cacheSeconds=2592000)
-- [SemVer](https://semver.org/) version observance: ![semver](https://img.shields.io/badge/semver-2.0.0-blue.svg?cacheSeconds=2592000)
-- amount of [Liberapay](https://liberapay.com/) donations per week: ![receives](https://img.shields.io/badge/receives-2.00%20USD%2Fweek-yellow.svg?cacheSeconds=2592000)
-- Python package downloads: ![downloads](https://img.shields.io/badge/downloads-13k%2Fmonth-brightgreen.svg?cacheSeconds=2592000)
-- Chrome Web Store extension rating: ![rating](https://img.shields.io/badge/rating-★★★★☆-brightgreen.svg?cacheSeconds=2592000)
-- [Uptime Robot](https://uptimerobot.com) percentage: ![uptime](https://img.shields.io/badge/uptime-100%25-brightgreen.svg?cacheSeconds=2592000)
+- code coverage percentage: ![coverage](https://img.shields.io/badge/coverage-80%25-yellowgreen)
+- stable release version: ![version](https://img.shields.io/badge/version-1.2.3-blue)
+- package manager release: ![gem](https://img.shields.io/badge/gem-2.2.0-blue)
+- status of third-party dependencies: ![dependencies](https://img.shields.io/badge/dependencies-out%20of%20date-orange)
+- static code analysis grade: ![codacy](https://img.shields.io/badge/codacy-B-green)
+- [SemVer](https://semver.org/) version observance: ![semver](https://img.shields.io/badge/semver-2.0.0-blue)
+- amount of [Liberapay](https://liberapay.com/) donations per week: ![receives](https://img.shields.io/badge/receives-2.00%20USD%2Fweek-yellow)
+- Python package downloads: ![downloads](https://img.shields.io/badge/downloads-13k%2Fmonth-brightgreen)
+- Chrome Web Store extension rating: ![rating](https://img.shields.io/badge/rating-★★★★☆-brightgreen)
+- [Uptime Robot](https://uptimerobot.com) percentage: ![uptime](https://img.shields.io/badge/uptime-100%25-brightgreen)
 
 [Make your own badges!][custom badges]
-(Quick example: `https://img.shields.io/badge/left-right-f39f37.svg`)
-
-Browse a [complete list of badges][shields.io].
+(Quick example: `https://img.shields.io/badge/left-right-f39f37`)
 
 [custom badges]: http://shields.io/#your-badge
 
+### Quickstart
+
+Browse a [complete list of badges][shields.io] and locate a particular badge by using the search bar or by browsing the categories. Click on the badge to fill in required data elements for that badge type (like your username or repo) and optionally customize (label, colors etc.). And it's ready for use!
+
+Use the button at the bottom to copy your badge url or snippet, which can then be added to places like your GitHub readme files or other web pages.
+
 ## Contributing
 
 Shields is a community project. We invite your participation through issues
@@ -82,20 +89,20 @@ and pull requests! You can peruse the [contributing guidelines][contributing].
 When adding or changing a service [please add tests][service-tests].
 
 This project has quite a backlog of suggestions! If you're new to the project,
-maybe you'd like to open a pull request to address one of them:
-
-[![GitHub issues by-label](https://img.shields.io/github/issues/badges/shields/good%20first%20issue.svg)](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+maybe you'd like to open a pull request to address one of them.
 
 You can read a [tutorial on how to add a badge][tutorial].
 
+[![GitHub issues by-label](https://img.shields.io/github/issues/badges/shields/good%20first%20issue)](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+
 [service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
 [tutorial]: doc/TUTORIAL.md
 [contributing]: CONTRIBUTING.md
 
 ## Development
 
-1. Install Node 8 or later. You can use the [package manager][] of your choice.
-   Tests need to pass in Node 8 and 10.
+1. Install Node 12 or later. You can use the [package manager][] of your choice.
+   Tests need to pass in Node 12 and 14.
 2. Clone this repository.
 3. Run `npm ci` to install the dependencies.
 4. Run `npm start` to start the badge server and the frontend dev server.
@@ -107,14 +114,14 @@ server (`gatsby dev`) should also automatically reload. However the badge
 definitions are built only before the server first starts. To regenerate those,
 either run `npm run defs` or manually restart the server.
 
-To debug a badge from the command line, run `npm run badge -- /npm/v/nock.svg`.
+To debug a badge from the command line, run `npm run badge -- /npm/v/nock`.
 It also works with full URLs like
-`npm run badge -- https://img.shields.io/npm/v/nock.svg`.
+`npm run badge -- https://img.shields.io/npm/v/nock`.
 
 Use `npm run debug:server` to start server in debug mode.
 [This recipe][nodemon debug] shows how to debug Node.js application in [VS Code][].
 
-Shields has experimental support for [Gitpod Beta][gitpod], a pre-configured development
+Shields has experimental support for [Gitpod][gitpod], a pre-configured development
 environment that runs in your browser. To use Gitpod, click the button below and
 sign in with GitHub. Gitpod also offers a browser add-on, though it is not required.
 Please report any Gitpod bugs, questions, or suggestions in issue
@@ -124,8 +131,8 @@ Please report any Gitpod bugs, questions, or suggestions in issue
 
 [Snapshot tests][] ensure we don't inadvertently make changes that affect the
 SVG or JSON output. When deliberately changing the output, run
-`SNAPSHOT_DRY=1 npm run test:js:server` to preview changes to the saved
-snapshots, and `SNAPSHOT_UPDATE=1 npm run test:js:server` to update them.
+`SNAPSHOT_DRY=1 npm run test:package` to preview changes to the saved
+snapshots, and `SNAPSHOT_UPDATE=1 npm run test:package` to update them.
 
 The server can be configured to use [Sentry][] ([configuration][sentry configuration]) and [Prometheus][] ([configuration][prometheus configuration]).
 
@@ -183,7 +190,6 @@ Maintainers:
 - [calebcartwright](https://github.com/calebcartwright) (core team)
 - [chris48s](https://github.com/chris48s) (core team)
 - [Daniel15](https://github.com/Daniel15) (core team)
-- [espadrine](https://github.com/espadrine) (core team)
 - [paulmelnikow](https://github.com/paulmelnikow) (core team)
 - [platan](https://github.com/platan) (core team)
 - [PyvesB](https://github.com/PyvesB) (core team)
@@ -191,19 +197,22 @@ Maintainers:
 
 Operations:
 
-- [espadrine](https://github.com/espadrine) (sysadmin)
-- [paulmelnikow](https://github.com/paulmelnikow) (limited access)
+- [calebcartwright](https://github.com/calebcartwright)
+- [chris48s](https://github.com/chris48s)
+- [paulmelnikow](https://github.com/paulmelnikow)
+- [PyvesB](https://github.com/PyvesB)
 
 Alumni:
 
+- [espadrine](https://github.com/espadrine)
 - [olivierlacan](https://github.com/olivierlacan)
 
 ## Related projects
 
-- [badgerbadgerbadger gem][gem]
+- [poser PHP library][poser]
 - [pybadges python library][pybadges]
 
-[gem]: https://github.com/badges/badgerbadgerbadger
+[poser]: https://github.com/badges/poser
 [pybadges]: https://github.com/google/pybadges
 
 ## License
@@ -214,28 +223,6 @@ domain unless specified otherwise.
 The assets in `logo/` are trademarks of their respective companies and are
 under their terms and license.
 
-## Contributors
+## Community
 
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
-<a href="https://github.com/badges/shields/graphs/contributors"><img src="https://opencollective.com/shields/contributors.svg?width=890" /></a>
-
-## Backers
-
-Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/shields#backer)]
-
-<a href="https://opencollective.com/shields#backers" target="_blank"><img src="https://opencollective.com/shields/backers.svg?width=890"></a>
-
-## Sponsors
-
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/shields#sponsor)]
-
-<a href="https://opencollective.com/shields/sponsor/0/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/0/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/1/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/1/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/2/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/2/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/3/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/3/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/4/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/4/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/5/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/5/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/6/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/6/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/7/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/7/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/8/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/8/avatar.svg"></a>
-<a href="https://opencollective.com/shields/sponsor/9/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/9/avatar.svg"></a>
+Thanks to the people and companies who donate money, services or time to keep the project running. [https://shields.io/community](https://shields.io/community)

SECURITY.md

@@ -0,0 +1,25 @@
+# Security Policy
+
+## Supported Projects
+
+Please follow this guidance when reporting security issues affecting:
+
+- [Shields.io](https://shields.io)
+- [Raster.shields.io](https://raster.shields.io)
+- Self-hosted Shields instances
+- The [svg-to-image-proxy](https://www.npmjs.com/package/svg-to-image-proxy) NPM package
+- The [badge-maker](https://www.npmjs.com/package/badge-maker) NPM package
+
+The [gh-badges](https://www.npmjs.com/package/gh-badges) NPM package is now deprecated and will no longer receive fixes for bugs or security issues.
+
+## Reporting a Vulnerability
+
+If you find a security vulnerability affecting any of our supported projects, please email [security@shields.io](mailto:security@shields.io), rather than opening a public issue on GitHub. After receiving the initial report, we will endeavor to keep you informed of the progress towards a fix and full announcement. We may ask you for additional information. You are also welcome to propose a patch or solution.
+
+Report security bugs in third-party modules to the person or team maintaining the module.
+
+## Coordinated Disclosure
+
+We aim to patch confirmed vulnerabilities within 90 days or less, disclosing the details of those vulnerabilities when a patch is published. We ask that you refrain from sharing your report with others while we work on our patch.
+
+We may want to coordinate an advisory with you to be published simultaneously with the patch, but you are also welcome to self-disclose after 90 days if you prefer. We will never publish information about you or our communications with you without your permission.

app.json

@@ -6,6 +6,16 @@
   "repository": "https://github.com/badges/shields",
   "logo": "http://shields.io/favicon.png",
   "env": {
+    "CYPRESS_INSTALL_BINARY": {
+      "description": "Disable the cypress binary installation",
+      "value": "0",
+      "required": false
+    },
+    "HUSKY_SKIP_INSTALL": {
+      "description": "Skip the husky git hook setup",
+      "value": "1",
+      "required": false
+    },
     "WHEELMAP_TOKEN": {
       "description": "Configure the token to be used for the Wheelmap service.",
       "required": false
@@ -13,6 +23,14 @@
     "GH_TOKEN": {
       "description": "Configure the token to be used for the GitHub services.",
       "required": false
+    },
+    "TWITCH_CLIENT_ID": {
+      "description": "Configure the client id to be used for the Twitch service.",
+      "required": false
+    },
+    "TWITCH_CLIENT_SECRET": {
+      "description": "Configure the client secret to be used for the Twitch service.",
+      "required": false
     }
   },
   "formation": {

badge-maker/.npmignore

@@ -1,2 +1,3 @@
 lib/make-badge-test-helpers.js
 lib/**/*.spec.js
+index.test-d.ts

badge-maker/CHANGELOG.md

@@ -1,6 +1,86 @@
 # Changelog
 
-## 2.2.1
+## 3.3.0
+
+- Readability improvements: a dark font color is automatically used when the badge's background is too light. For example: ![](https://img.shields.io/badge/hello-world-white)
+- Better CSS color compliance: thanks to a switch from _is-css-color_ to _[css-color-converter](https://www.npmjs.com/package/css-color-converter)_, you can use a wider range of color formats from the latest CSS specification, for example `rgb(0 255 0)`
+- Less dependencies: _badge-maker_ no longer depends on _camelcase_
+
+## 3.2.0
+
+- Accessibility improvements: Help users of assistive technologies to read the badges when used inline
+
+## 3.1.0
+
+- Add TypeScript definitions
+
+## 3.0.1
+
+- Fix missing dependency
+
+## 3.0.0
+
+### Breaking Changes
+
+- Dropped support for node < 10
+- Package name has changed to `badge-maker` and moved to https://www.npmjs.com/package/badge-maker
+- `BadgeFactory` class is removed and replaced by `makeBadge()` function.
+- Deprecated parameters have been removed. In version 2.2.0 the `colorA`, `colorB` and `colorscheme` params were deprecated. In version 3.0.0 these have been removed.
+- Only SVG output format is now provided. JSON format has been dropped and the `format` key has been removed.
+- The `text` array has been replaced by `label` and `message` keys.
+- The `template` key has been renamed `style`.
+  To upgrade from v2.1.1, change your code from:
+  ```js
+  const { BadgeFactory } = require('gh-badges')
+  const bf = new BadgeFactory()
+  const svg = bf.create({
+    text: ['build', 'passed'],
+    format: 'svg',
+    template: 'flat-square',
+  })
+  ```
+  to:
+  ```js
+  const { makeBadge } = require('badge-maker')
+  const svg = makeBadge({
+    label: 'build',
+    message: 'passed',
+    style: 'flat-square',
+  })
+  ```
+- `ValidationError` had been added and inputs are now validated. In previous releases, invalid inputs would be discarded and replaced with defaults. For example, in 2.2.1
+  ```js
+  const { BadgeFactory } = require('gh-badges')
+  const bf = new BadgeFactory()
+  const svg = bf.create({
+    text: ['build', 'passed'],
+    template: 'some invalid value',
+  })
+  ```
+  would generate an SVG badge. In version >=3
+  ```js
+  const { makeBadge } = require('badge-maker')
+  const svg = makeBadge({
+    label: 'build',
+    message: 'passed',
+    style: 'some invalid value',
+  })
+  ```
+  will throw a `ValidationError`.
+- Raster support has been removed from the CLI. It will now only output SVG. On the console, the output of `badge` can be piped to a utility like [imagemagick](https://imagemagick.org/script/command-line-processing.php). If you were previously using
+  ```sh
+  badge build passed :green .gif
+  ```
+  this could be replaced by
+  ```sh
+  badge build passed :green | magick svg:- gif:-
+  ```
+
+### Security
+
+- Removed dependency on doT library which has known vulnerabilities.
+
+## 2.2.1 - 2019-05-30
 
 ### Fixes
 

badge-maker/README.md

@@ -1,12 +1,13 @@
-# gh-badges
+# badge-maker
 
-[![npm version](https://img.shields.io/npm/v/gh-badges.svg)](https://npmjs.org/package/gh-badges)
-[![npm license](https://img.shields.io/npm/l/gh-badges.svg)](https://npmjs.org/package/gh-badges)
+[![npm version](https://img.shields.io/npm/v/badge-maker.svg)](https://npmjs.org/package/badge-maker)
+[![npm license](https://img.shields.io/npm/l/badge-maker.svg)](https://npmjs.org/package/badge-maker)
+[![npm type definitions](https://img.shields.io/npm/types/badge-maker)](https://npmjs.org/package/badge-maker)
 
 ## Installation
 
 ```sh
-npm install gh-badges
+npm install badge-maker
 ```
 
 ## Usage
@@ -14,29 +15,44 @@ npm install gh-badges
 ### On the console
 
 ```sh
-npm install -g gh-badges
-badge build passed :green .png > mybadge.png
+npm install -g badge-maker
+badge build passed :green > mybadge.svg
 ```
 
 ### As a library
 
+With CommonJS in JavaScript,
+
 ```js
-const { BadgeFactory } = require('gh-badges')
+const { makeBadge, ValidationError } = require('badge-maker')
+```
 
-const bf = new BadgeFactory()
+With ESM or TypeScript,
 
+```ts
+import { makeBadge, ValidationError } from 'badge-maker'
+```
+
+```js
 const format = {
-  text: ['build', 'passed'],
+  label: 'build',
+  message: 'passed',
   color: 'green',
-  template: 'flat',
 }
 
-const svg = bf.create(format)
+const svg = makeBadge(format)
+console.log(svg) // <svg...
+
+try {
+  makeBadge({})
+} catch (e) {
+  console.log(e) // ValidationError: Field `message` is required
+}
 ```
 
 ### Node version support
 
-The latest version of gh-badges supports all currently maintained Node
+The latest version of badge-maker supports all currently maintained Node
 versions. See the [Node Release Schedule][].
 
 [node release schedule]: https://github.com/nodejs/Release#release-schedule
@@ -47,28 +63,17 @@ The format is the following:
 
 ```js
 {
-  text: [ 'build', 'passed' ],  // Textual information shown, in order
+  label: 'build',  // (Optional) Badge label
+  message: 'passed',  // (Required) Badge message
+  labelColor: '#555',  // (Optional) Label color
+  color: '#4c1',  // (Optional) Message color
 
-  format: 'svg',  // Also supports json
-
-  color: '#4c1',
-  labelColor: '#555',
-
-  // See templates/ for a list of available templates.
+  // (Optional) One of: 'plastic', 'flat', 'flat-square', 'for-the-badge' or 'social'
   // Each offers a different visual design.
-  template: 'flat',
-
-  // Deprecated attributes:
-  colorscheme: 'green', // Now an alias for `color`.
-  colorB: '#4c1', // Now an alias for `color`.
-  colorA: '#555', // Now an alias for `labelColor`.
+  style: 'flat',
 }
 ```
 
-### See also
-
-- [templates/](./templates) for the `template` option
-
 ## Colors
 
 There are three ways to specify `color` and `labelColor`:
@@ -126,3 +131,12 @@ There are three ways to specify `color` and `labelColor`:
 [lightslategray]: https://img.shields.io/badge/lightslategray-lightslategray.svg
 [css color]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
 [css/svg color]: http://www.w3.org/TR/SVG/types.html#DataTypeColor
+
+## Raster Formats
+
+Conversion to raster formats is no longer directly supported. In javascript
+code, SVG badges can be converted to raster formats using a library like
+[gm](https://www.npmjs.com/package/gm). On the console, the output of `badge`
+can be piped to a utility like
+[imagemagick](https://imagemagick.org/script/command-line-processing.php)
+e.g: `badge build passed :green | magick svg:- gif:-`.

badge-maker/index.d.ts

@@ -0,0 +1,11 @@
+interface Format {
+  label?: string
+  message: string
+  labelColor?: string
+  color?: string
+  style?: 'plastic' | 'flat' | 'flat-square' | 'for-the-badge' | 'social'
+}
+
+export declare class ValidationError extends Error {}
+
+export declare function makeBadge(format: Format): string

badge-maker/index.test-d.ts

@@ -0,0 +1,35 @@
+import { expectType, expectError, expectAssignable } from 'tsd'
+import { makeBadge, ValidationError } from '.'
+
+expectError(makeBadge('string is invalid'))
+expectError(makeBadge({}))
+expectError(
+  makeBadge({
+    message: 'passed',
+    style: 'invalid style',
+  })
+)
+
+expectType<string>(
+  makeBadge({
+    message: 'passed',
+  })
+)
+expectType<string>(
+  makeBadge({
+    label: 'build',
+    message: 'passed',
+  })
+)
+expectType<string>(
+  makeBadge({
+    label: 'build',
+    message: 'passed',
+    labelColor: 'green',
+    color: 'red',
+    style: 'flat',
+  })
+)
+
+const error = new ValidationError()
+expectAssignable<Error>(error)

badge-maker/lib/badge-cli.js

@@ -2,23 +2,18 @@
 
 'use strict'
 
-const makeBadge = require('./make-badge')
-const svg2img = require('./svg-to-img')
 const { namedColors } = require('./color')
+const { makeBadge } = require('./index')
 
 if (process.argv.length < 4) {
-  console.log('Usage: badge subject status [:color] [.output] [@style]')
-  console.log(
-    'Or:    badge subject status color [labelColor] [.output] [@style]'
-  )
+  console.log('Usage: badge label message [:color] [@style]')
+  console.log('Or:    badge label message color [labelColor] [@style]')
   console.log()
   console.log('  color, labelColor:')
   console.log(`    one of ${Object.keys(namedColors).join(', ')}.`)
   console.log('    #xxx (three hex digits)')
   console.log('    #xxxxxx (six hex digits)')
   console.log('    color (CSS color)')
-  console.log('  output:')
-  console.log('    svg, png, jpg, or gif')
   console.log()
   console.log('Eg: badge cactus grown :green @flat')
   console.log()
@@ -26,14 +21,8 @@ if (process.argv.length < 4) {
 }
 
 // Find a format specifier.
-let format = 'svg'
 let style = ''
 for (let i = 4; i < process.argv.length; i++) {
-  if (process.argv[i][0] === '.') {
-    format = process.argv[i].slice(1)
-    process.argv.splice(i, 1)
-    continue
-  }
   if (process.argv[i][0] === '@') {
     style = process.argv[i].slice(1)
     process.argv.splice(i, 1)
@@ -41,14 +30,14 @@ for (let i = 4; i < process.argv.length; i++) {
   }
 }
 
-const subject = process.argv[2]
-const status = process.argv[3]
+const label = process.argv[2]
+const message = process.argv[3]
 let color = process.argv[4] || ':green'
-const colorA = process.argv[5]
+const labelColor = process.argv[5]
 
-const badgeData = { text: [subject, status], format }
+const badgeData = { label, message }
 if (style) {
-  badgeData.template = style
+  badgeData.style = style
 }
 
 if (color[0] === ':') {
@@ -58,28 +47,17 @@ if (color[0] === ':') {
     console.error('Invalid color scheme.')
     process.exit(1)
   }
-  badgeData.colorscheme = color
+  badgeData.color = color
 } else {
-  badgeData.colorB = color
-  if (colorA) {
-    badgeData.colorA = colorA
+  badgeData.color = color
+  if (labelColor) {
+    badgeData.labelColor = labelColor
   }
 }
 
-async function main() {
-  const svg = makeBadge(badgeData)
-
-  if (/png|jpg|gif/.test(format)) {
-    const data = await svg2img(svg, format)
-    process.stdout.write(data)
-  } else {
-    console.log(svg)
-  }
-}
-
-;(async () => {
+;(() => {
   try {
-    await main()
+    console.log(makeBadge(badgeData))
   } catch (e) {
     console.error(e)
     process.exit(1)

badge-maker/lib/badge-cli.spec.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const path = require('path')
-const isPng = require('is-png')
 const isSvg = require('is-svg')
 const { spawn } = require('child-process-promise')
 const { expect, use } = require('chai')
@@ -14,13 +13,13 @@ function runCli(args) {
   })
 }
 
-describe('The CLI', function() {
-  it('should provide a help message', async function() {
+describe('The CLI', function () {
+  it('should provide a help message', async function () {
     const { stdout } = await runCli([])
     expect(stdout).to.startWith('Usage')
   })
 
-  it('should produce default badges', async function() {
+  it('should produce default badges', async function () {
     const { stdout } = await runCli(['cactus', 'grown'])
     expect(stdout)
       .to.satisfy(isSvg)
@@ -28,30 +27,13 @@ describe('The CLI', function() {
       .and.to.include('grown')
   })
 
-  it('should produce colorschemed badges', async function() {
+  it('should produce colorschemed badges', async function () {
     const { stdout } = await runCli(['cactus', 'grown', ':green'])
     expect(stdout).to.satisfy(isSvg)
   })
 
-  it('should produce right-color badges', async function() {
+  it('should produce right-color badges', async function () {
     const { stdout } = await runCli(['cactus', 'grown', '#abcdef'])
-    expect(stdout)
-      .to.satisfy(isSvg)
-      .and.to.include('#abcdef')
-  })
-
-  it('should produce PNG badges', async function() {
-    const child = runCli(['cactus', 'grown', '.png'])
-
-    // The buffering done by `child-process-promise` doesn't seem correctly to
-    // handle binary data.
-    let chunk
-    child.childProcess.stdout.once('data', data => {
-      chunk = data
-    })
-
-    await child
-
-    expect(chunk).to.satisfy(isPng)
+    expect(stdout).to.satisfy(isSvg).and.to.include('#abcdef')
   })
 })

badge-maker/lib/badge-renderers.js

@@ -0,0 +1,708 @@
+'use strict'
+
+const anafanafo = require('anafanafo')
+const { brightness } = require('./color')
+
+const fontFamily = 'font-family="Verdana,Geneva,DejaVu Sans,sans-serif"'
+const socialFontFamily =
+  'font-family="Helvetica Neue,Helvetica,Arial,sans-serif"'
+const brightnessThreshold = 0.69
+
+function capitalize(s) {
+  return `${s.charAt(0).toUpperCase()}${s.slice(1)}`
+}
+
+function colorsForBackground(color) {
+  if (brightness(color) <= brightnessThreshold) {
+    return { textColor: '#fff', shadowColor: '#010101' }
+  } else {
+    return { textColor: '#333', shadowColor: '#ccc' }
+  }
+}
+
+function escapeXml(s) {
+  if (s === undefined || typeof s !== 'string') {
+    return undefined
+  } else {
+    return s
+      .replace(/&/g, '&amp;')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;')
+      .replace(/'/g, '&apos;')
+  }
+}
+
+function roundUpToOdd(val) {
+  return val % 2 === 0 ? val + 1 : val
+}
+
+function preferredWidthOf(str, options) {
+  // Increase chances of pixel grid alignment.
+  return roundUpToOdd(anafanafo(str, options) | 0)
+}
+
+function createAccessibleText({ label, message }) {
+  const labelPrefix = label ? `${label}: ` : ''
+  return labelPrefix + message
+}
+
+function hasLinks({ links }) {
+  const [leftLink, rightLink] = links || []
+  const hasLeftLink = leftLink && leftLink.length
+  const hasRightLink = rightLink && rightLink.length
+  const hasLink = hasLeftLink && hasRightLink
+  return { hasLink, hasLeftLink, hasRightLink }
+}
+
+function shouldWrapBodyWithLink({ links }) {
+  const { hasLeftLink, hasRightLink } = hasLinks({ links })
+  return hasLeftLink && !hasRightLink
+}
+
+function renderAriaAttributes({ accessibleText, links }) {
+  const { hasLink } = hasLinks({ links })
+  return hasLink ? '' : `role="img" aria-label="${escapeXml(accessibleText)}"`
+}
+
+function renderTitle({ accessibleText, links }) {
+  const { hasLink } = hasLinks({ links })
+  return hasLink ? '' : `<title>${escapeXml(accessibleText)}</title>`
+}
+
+function renderLogo({
+  logo,
+  badgeHeight,
+  horizPadding,
+  logoWidth = 14,
+  logoPadding = 0,
+}) {
+  if (logo) {
+    const logoHeight = 14
+    const y = (badgeHeight - logoHeight) / 2
+    const x = horizPadding
+    return {
+      hasLogo: true,
+      totalLogoWidth: logoWidth + logoPadding,
+      renderedLogo: `<image x="${x}" y="${y}" width="${logoWidth}" height="${logoHeight}" xlink:href="${escapeXml(
+        logo
+      )}"/>`,
+    }
+  } else {
+    return { hasLogo: false, totalLogoWidth: 0, renderedLogo: '' }
+  }
+}
+
+function renderLink({
+  link,
+  height,
+  textLength,
+  horizPadding,
+  leftMargin,
+  renderedText,
+}) {
+  const rectHeight = height
+  const rectWidth = textLength + horizPadding * 2
+  const rectX = leftMargin > 1 ? leftMargin + 1 : 0
+  return `<a target="_blank" xlink:href="${escapeXml(link)}">
+    <rect width="${rectWidth}" x="${rectX}" height="${rectHeight}" fill="rgba(0,0,0,0)" />
+    ${renderedText}
+  </a>`
+}
+
+function renderText({
+  leftMargin,
+  horizPadding = 0,
+  content,
+  link,
+  height,
+  verticalMargin = 0,
+  shadow = false,
+  color,
+}) {
+  if (!content.length) {
+    return { renderedText: '', width: 0 }
+  }
+
+  const textLength = preferredWidthOf(content, { font: '11px Verdana' })
+  const escapedContent = escapeXml(content)
+
+  const shadowMargin = 150 + verticalMargin
+  const textMargin = 140 + verticalMargin
+
+  const outTextLength = 10 * textLength
+  const x = 10 * (leftMargin + 0.5 * textLength + horizPadding)
+
+  let renderedText = ''
+  const { textColor, shadowColor } = colorsForBackground(color)
+  if (shadow) {
+    renderedText = `<text aria-hidden="true" x="${x}" y="${shadowMargin}" fill="${shadowColor}" fill-opacity=".3" transform="scale(.1)" textLength="${outTextLength}">${escapedContent}</text>`
+  }
+  renderedText += `<text x="${x}" y="${textMargin}" transform="scale(.1)" fill="${textColor}" textLength="${outTextLength}">${escapedContent}</text>`
+
+  return {
+    renderedText: link
+      ? renderLink({
+          link,
+          height,
+          textLength,
+          horizPadding,
+          leftMargin,
+          renderedText,
+        })
+      : renderedText,
+    width: textLength,
+  }
+}
+
+function renderBadge(
+  { links, leftWidth, rightWidth, height, accessibleText },
+  main
+) {
+  const width = leftWidth + rightWidth
+  const leftLink = escapeXml(links[0])
+
+  return `
+    <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="${width}" height="${height}" ${renderAriaAttributes(
+    { links, accessibleText }
+  )}>
+
+    ${renderTitle({ accessibleText, links })}
+    ${
+      shouldWrapBodyWithLink({ links })
+        ? `<a target="_blank" xlink:href="${leftLink}">${main}</a>`
+        : main
+    }
+    </svg>`
+}
+
+class Badge {
+  static get fontFamily() {
+    throw new Error('Not implemented')
+  }
+
+  static get height() {
+    throw new Error('Not implemented')
+  }
+
+  static get verticalMargin() {
+    throw new Error('Not implemented')
+  }
+
+  static get shadow() {
+    throw new Error('Not implemented')
+  }
+
+  constructor({
+    label,
+    message,
+    links,
+    logo,
+    logoWidth,
+    logoPadding,
+    color = '#4c1',
+    labelColor,
+  }) {
+    const horizPadding = 5
+    const { hasLogo, totalLogoWidth, renderedLogo } = renderLogo({
+      logo,
+      badgeHeight: this.constructor.height,
+      horizPadding,
+      logoWidth,
+      logoPadding,
+    })
+    const hasLabel = label.length || labelColor
+    if (labelColor == null) {
+      labelColor = '#555'
+    }
+
+    const [leftLink, rightLink] = links
+
+    labelColor = hasLabel || hasLogo ? labelColor : color
+    labelColor = escapeXml(labelColor)
+    color = escapeXml(color)
+
+    const labelMargin = totalLogoWidth + 1
+
+    const { renderedText: renderedLabel, width: labelWidth } = renderText({
+      leftMargin: labelMargin,
+      horizPadding,
+      content: label,
+      link: !shouldWrapBodyWithLink({ links }) && leftLink,
+      height: this.constructor.height,
+      verticalMargin: this.constructor.verticalMargin,
+      shadow: this.constructor.shadow,
+      color: labelColor,
+    })
+
+    const leftWidth = hasLabel
+      ? labelWidth + 2 * horizPadding + totalLogoWidth
+      : 0
+
+    let messageMargin = leftWidth - (message.length ? 1 : 0)
+    if (!hasLabel) {
+      if (hasLogo) {
+        messageMargin = messageMargin + totalLogoWidth + horizPadding
+      } else {
+        messageMargin = messageMargin + 1
+      }
+    }
+
+    const { renderedText: renderedMessage, width: messageWidth } = renderText({
+      leftMargin: messageMargin,
+      horizPadding,
+      content: message,
+      link: rightLink,
+      height: this.constructor.height,
+      verticalMargin: this.constructor.verticalMargin,
+      shadow: this.constructor.shadow,
+      color,
+    })
+
+    let rightWidth = messageWidth + 2 * horizPadding
+    if (hasLogo && !hasLabel) {
+      rightWidth += totalLogoWidth + horizPadding - 1
+    }
+
+    const width = leftWidth + rightWidth
+
+    const accessibleText = createAccessibleText({ label, message })
+
+    this.links = links
+    this.leftWidth = leftWidth
+    this.rightWidth = rightWidth
+    this.width = width
+    this.labelColor = labelColor
+    this.color = color
+    this.label = label
+    this.message = message
+    this.accessibleText = accessibleText
+    this.renderedLogo = renderedLogo
+    this.renderedLabel = renderedLabel
+    this.renderedMessage = renderedMessage
+  }
+
+  static render(params) {
+    return new this(params).render()
+  }
+
+  render() {
+    throw new Error('Not implemented')
+  }
+}
+
+class Plastic extends Badge {
+  static get fontFamily() {
+    return fontFamily
+  }
+
+  static get height() {
+    return 18
+  }
+
+  static get verticalMargin() {
+    return -10
+  }
+
+  static get shadow() {
+    return true
+  }
+
+  render() {
+    return renderBadge(
+      {
+        links: this.links,
+        leftWidth: this.leftWidth,
+        rightWidth: this.rightWidth,
+        accessibleText: this.accessibleText,
+        height: this.constructor.height,
+      },
+      `
+      <linearGradient id="s" x2="0" y2="100%">
+        <stop offset="0"  stop-color="#fff" stop-opacity=".7"/>
+        <stop offset=".1" stop-color="#aaa" stop-opacity=".1"/>
+        <stop offset=".9" stop-color="#000" stop-opacity=".3"/>
+        <stop offset="1"  stop-color="#000" stop-opacity=".5"/>
+      </linearGradient>
+
+      <clipPath id="r">
+        <rect width="${this.width}" height="${this.constructor.height}" rx="4" fill="#fff"/>
+      </clipPath>
+
+      <g clip-path="url(#r)">
+        <rect width="${this.leftWidth}" height="${this.constructor.height}" fill="${this.labelColor}"/>
+        <rect x="${this.leftWidth}" width="${this.rightWidth}" height="${this.constructor.height}" fill="${this.color}"/>
+        <rect width="${this.width}" height="${this.constructor.height}" fill="url(#s)"/>
+      </g>
+
+      <g fill="#fff" text-anchor="middle" ${this.constructor.fontFamily} text-rendering="geometricPrecision" font-size="110">
+        ${this.renderedLogo}
+        ${this.renderedLabel}
+        ${this.renderedMessage}
+      </g>`
+    )
+  }
+}
+
+class Flat extends Badge {
+  static get fontFamily() {
+    return fontFamily
+  }
+
+  static get height() {
+    return 20
+  }
+
+  static get verticalMargin() {
+    return 0
+  }
+
+  static get shadow() {
+    return true
+  }
+
+  render() {
+    return renderBadge(
+      {
+        links: this.links,
+        leftWidth: this.leftWidth,
+        rightWidth: this.rightWidth,
+        accessibleText: this.accessibleText,
+        height: this.constructor.height,
+      },
+      `
+      <linearGradient id="s" x2="0" y2="100%">
+        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+        <stop offset="1" stop-opacity=".1"/>
+      </linearGradient>
+
+      <clipPath id="r">
+        <rect width="${this.width}" height="${this.constructor.height}" rx="3" fill="#fff"/>
+      </clipPath>
+
+      <g clip-path="url(#r)">
+        <rect width="${this.leftWidth}" height="${this.constructor.height}" fill="${this.labelColor}"/>
+        <rect x="${this.leftWidth}" width="${this.rightWidth}" height="${this.constructor.height}" fill="${this.color}"/>
+        <rect width="${this.width}" height="${this.constructor.height}" fill="url(#s)"/>
+      </g>
+
+      <g fill="#fff" text-anchor="middle" ${this.constructor.fontFamily} text-rendering="geometricPrecision" font-size="110">
+        ${this.renderedLogo}
+        ${this.renderedLabel}
+        ${this.renderedMessage}
+      </g>`
+    )
+  }
+}
+
+class FlatSquare extends Badge {
+  static get fontFamily() {
+    return fontFamily
+  }
+
+  static get height() {
+    return 20
+  }
+
+  static get verticalMargin() {
+    return 0
+  }
+
+  static get shadow() {
+    return false
+  }
+
+  render() {
+    return renderBadge(
+      {
+        links: this.links,
+        leftWidth: this.leftWidth,
+        rightWidth: this.rightWidth,
+        accessibleText: this.accessibleText,
+        height: this.constructor.height,
+      },
+      `
+      <g shape-rendering="crispEdges">
+        <rect width="${this.leftWidth}" height="${this.constructor.height}" fill="${this.labelColor}"/>
+        <rect x="${this.leftWidth}" width="${this.rightWidth}" height="${this.constructor.height}" fill="${this.color}"/>
+      </g>
+
+      <g fill="#fff" text-anchor="middle" ${this.constructor.fontFamily} text-rendering="geometricPrecision" font-size="110">
+        ${this.renderedLogo}
+        ${this.renderedLabel}
+        ${this.renderedMessage}
+      </g>`
+    )
+  }
+}
+
+function social({
+  label,
+  message,
+  links = [],
+  logo,
+  logoWidth,
+  logoPadding,
+  color = '#4c1',
+  labelColor = '#555',
+}) {
+  // Social label is styled with a leading capital. Convert to caps here so
+  // width can be measured using the correct characters.
+  label = capitalize(label)
+
+  const externalHeight = 20
+  const internalHeight = 19
+  const labelHorizPadding = 5
+  const messageHorizPadding = 4
+  const horizGutter = 6
+  const { totalLogoWidth, renderedLogo } = renderLogo({
+    logo,
+    badgeHeight: externalHeight,
+    horizPadding: labelHorizPadding,
+    logoWidth,
+    logoPadding,
+  })
+  const hasMessage = message.length
+
+  const font = 'bold 11px Helvetica'
+  const labelTextWidth = preferredWidthOf(label, { font })
+  const messageTextWidth = preferredWidthOf(message, { font })
+  const labelRectWidth = labelTextWidth + totalLogoWidth + 2 * labelHorizPadding
+  const messageRectWidth = messageTextWidth + 2 * messageHorizPadding
+
+  let [leftLink, rightLink] = links
+  leftLink = escapeXml(leftLink)
+  rightLink = escapeXml(rightLink)
+  const { hasLeftLink, hasRightLink, hasLink } = hasLinks({ links })
+
+  const accessibleText = createAccessibleText({ label, message })
+
+  function renderMessageBubble() {
+    const messageBubbleMainX = labelRectWidth + horizGutter + 0.5
+    const messageBubbleNotchX = labelRectWidth + horizGutter
+    return `
+      <rect x="${messageBubbleMainX}" y="0.5" width="${messageRectWidth}" height="${internalHeight}" rx="2" fill="#fafafa"/>
+      <rect x="${messageBubbleNotchX}" y="7.5" width="0.5" height="5" stroke="#fafafa"/>
+      <path d="M${messageBubbleMainX} 6.5 l-3 3v1 l3 3" stroke="d5d5d5" fill="#fafafa"/>
+    `
+  }
+
+  function renderLabelText() {
+    const labelTextX =
+      10 * (totalLogoWidth + labelTextWidth / 2 + labelHorizPadding)
+    const labelTextLength = 10 * labelTextWidth
+    const escapedLabel = escapeXml(label)
+    const shouldWrapWithLink = hasLeftLink && !shouldWrapBodyWithLink({ links })
+
+    const rect = `<rect id="llink" stroke="#d5d5d5" fill="url(#a)" x=".5" y=".5" width="${labelRectWidth}" height="${internalHeight}" rx="2" />`
+    const shadow = `<text aria-hidden="true" x="${labelTextX}" y="150" fill="#fff" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
+    const text = `<text x="${labelTextX}" y="140" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
+
+    return shouldWrapWithLink
+      ? `
+        <a target="_blank" xlink:href="${leftLink}">
+          ${shadow}
+          ${text}
+          ${rect}
+        </a>
+      `
+      : `
+      ${rect}
+      ${shadow}
+      ${text}
+    `
+  }
+
+  function renderMessageText() {
+    const messageTextX =
+      10 * (labelRectWidth + horizGutter + messageRectWidth / 2)
+    const messageTextLength = 10 * messageTextWidth
+    const escapedMessage = escapeXml(message)
+
+    const rect = `<rect width="${messageRectWidth + 1}" x="${
+      labelRectWidth + horizGutter
+    }" height="${internalHeight + 1}" fill="rgba(0,0,0,0)" />`
+    const shadow = `<text aria-hidden="true" x="${messageTextX}" y="150" fill="#fff" transform="scale(.1)" textLength="${messageTextLength}">${escapedMessage}</text>`
+    const text = `<text id="rlink" x="${messageTextX}" y="140" transform="scale(.1)" textLength="${messageTextLength}">${escapedMessage}</text>`
+
+    return hasRightLink
+      ? `
+        <a target="_blank" xlink:href="${rightLink}">
+          ${rect}
+          ${shadow}
+          ${text}
+        </a>
+      `
+      : `
+      ${shadow}
+      ${text}
+    `
+  }
+
+  return renderBadge(
+    {
+      links,
+      leftWidth: labelRectWidth + 1,
+      rightWidth: hasMessage ? horizGutter + messageRectWidth : 0,
+      accessibleText,
+      height: externalHeight,
+    },
+    `
+    <style>a:hover #llink{fill:url(#b);stroke:#ccc}a:hover #rlink{fill:#4183c4}</style>
+    <linearGradient id="a" x2="0" y2="100%">
+      <stop offset="0" stop-color="#fcfcfc" stop-opacity="0"/>
+      <stop offset="1" stop-opacity=".1"/>
+    </linearGradient>
+    <linearGradient id="b" x2="0" y2="100%">
+      <stop offset="0" stop-color="#ccc" stop-opacity=".1"/>
+      <stop offset="1" stop-opacity=".1"/>
+    </linearGradient>
+    <g stroke="#d5d5d5">
+      <rect stroke="none" fill="#fcfcfc" x="0.5" y="0.5" width="${labelRectWidth}" height="${internalHeight}" rx="2"/>
+      ${hasMessage ? renderMessageBubble() : ''}
+    </g>
+    ${renderedLogo}
+    <g aria-hidden="${!hasLink}" fill="#333" text-anchor="middle" ${socialFontFamily} text-rendering="geometricPrecision" font-weight="700" font-size="110px" line-height="14px">
+      ${renderLabelText()}
+      ${hasMessage ? renderMessageText() : ''}
+    </g>
+    `
+  )
+}
+
+function forTheBadge({
+  label,
+  message,
+  links,
+  logo,
+  logoWidth,
+  logoPadding,
+  color = '#4c1',
+  labelColor,
+}) {
+  // For the Badge is styled in all caps. Convert to caps here so widths can
+  // be measured using the correct characters.
+  label = label.toUpperCase()
+  message = message.toUpperCase()
+
+  let labelWidth = preferredWidthOf(label, { font: '10px Verdana' }) || 0
+  let messageWidth =
+    preferredWidthOf(message, { font: 'bold 10px Verdana' }) || 0
+  const height = 28
+  const hasLabel = label.length || labelColor
+  if (labelColor == null) {
+    labelColor = '#555'
+  }
+  const horizPadding = 9
+  const { hasLogo, totalLogoWidth, renderedLogo } = renderLogo({
+    logo,
+    badgeHeight: height,
+    horizPadding,
+    logoWidth,
+    logoPadding,
+  })
+
+  labelWidth += 10 + totalLogoWidth
+  if (label.length) {
+    // Add 10 px of padding, plus approximately 1 px of letter spacing per
+    // character.
+    labelWidth += 10 + 2 * label.length
+  } else if (hasLogo) {
+    if (hasLabel) {
+      labelWidth += 7
+    } else {
+      labelWidth -= 7
+    }
+  } else {
+    labelWidth -= 11
+  }
+
+  // Add 20 px of padding, plus approximately 1.5 px of letter spacing per
+  // character.
+  messageWidth += 20 + 1.5 * message.length
+  const leftWidth = hasLogo && !hasLabel ? 0 : labelWidth
+  const rightWidth =
+    hasLogo && !hasLabel ? messageWidth + labelWidth : messageWidth
+
+  labelColor = hasLabel || hasLogo ? labelColor : color
+
+  color = escapeXml(color)
+  labelColor = escapeXml(labelColor)
+
+  let [leftLink, rightLink] = links
+  leftLink = escapeXml(leftLink)
+  rightLink = escapeXml(rightLink)
+  const { hasLeftLink, hasRightLink } = hasLinks({ links })
+
+  const accessibleText = createAccessibleText({ label, message })
+
+  function renderLabelText() {
+    const { textColor } = colorsForBackground(labelColor)
+    const labelTextX = ((labelWidth + totalLogoWidth) / 2) * 10
+    const labelTextLength = (labelWidth - (24 + totalLogoWidth)) * 10
+    const escapedLabel = escapeXml(label)
+
+    const text = `<text fill="${textColor}" x="${labelTextX}" y="175" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
+
+    if (hasLeftLink && !shouldWrapBodyWithLink({ links })) {
+      return `
+        <a target="_blank" xlink:href="${leftLink}">
+          <rect width="${leftWidth}" height="${height}" fill="rgba(0,0,0,0)"/>
+          ${text}
+        </a>
+      `
+    } else {
+      return text
+    }
+  }
+
+  function renderMessageText() {
+    const { textColor } = colorsForBackground(color)
+
+    const text = `<text fill="${textColor}" x="${
+      (labelWidth + messageWidth / 2) * 10
+    }" y="175" font-weight="bold" transform="scale(.1)" textLength="${
+      (messageWidth - 24) * 10
+    }">
+      ${escapeXml(message)}</text>`
+
+    if (hasRightLink) {
+      return `
+        <a target="_blank" xlink:href="${rightLink}">
+          <rect width="${rightWidth}" height="${height}" x="${labelWidth}" fill="rgba(0,0,0,0)"/>
+          ${text}
+        </a>
+      `
+    } else {
+      return text
+    }
+  }
+
+  return renderBadge(
+    {
+      links,
+      leftWidth,
+      rightWidth,
+      accessibleText,
+      height,
+    },
+    `
+    <g shape-rendering="crispEdges">
+      <rect width="${leftWidth}" height="${height}" fill="${labelColor}"/>
+      <rect x="${leftWidth}" width="${rightWidth}" height="${height}" fill="${color}"/>
+    </g>
+    <g fill="#fff" text-anchor="middle" ${fontFamily} text-rendering="geometricPrecision" font-size="100">
+      ${renderedLogo}
+      ${hasLabel ? renderLabelText() : ''}
+      ${renderMessageText()}
+    </g>`
+  )
+}
+
+module.exports = {
+  plastic: params => Plastic.render(params),
+  flat: params => Flat.render(params),
+  'flat-square': params => FlatSquare.render(params),
+  social,
+  'for-the-badge': forTheBadge,
+}

badge-maker/lib/color.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const isCSSColor = require('is-css-color')
+const { fromString } = require('css-color-converter')
 
-// When updating these, be sure also to update the list in `gh-badges/README.md`.
+// When updating these, be sure also to update the list in `badge-maker/README.md`.
 const namedColors = {
   brightgreen: '#4c1',
   green: '#97ca00',
@@ -37,6 +37,10 @@ function isHexColor(s = '') {
   return hexColorRegex.test(s)
 }
 
+function isCSSColor(color) {
+  return typeof color === 'string' && fromString(color.trim())
+}
+
 function normalizeColor(color) {
   if (color === undefined) {
     return undefined
@@ -64,9 +68,21 @@ function toSvgColor(color) {
   }
 }
 
+function brightness(color) {
+  if (color) {
+    const cssColor = fromString(color)
+    if (cssColor) {
+      const rgb = cssColor.toRgbaArray()
+      return +((rgb[0] * 299 + rgb[1] * 587 + rgb[2] * 114) / 255000).toFixed(2)
+    }
+  }
+  return 0
+}
+
 module.exports = {
   namedColors,
   isHexColor,
   normalizeColor,
   toSvgColor,
+  brightness,
 }

badge-maker/lib/color.spec.js

@@ -1,7 +1,12 @@
 'use strict'
 
 const { test, given, forCases } = require('sazerac')
-const { isHexColor, normalizeColor, toSvgColor } = require('./color')
+const {
+  isHexColor,
+  normalizeColor,
+  toSvgColor,
+  brightness,
+} = require('./color')
 
 test(isHexColor, () => {
   forCases([given('f00bae'), given('4c1'), given('ABC123')]).expect(true)
@@ -23,15 +28,35 @@ test(normalizeColor, () => {
   given('4c1').expect('#4c1')
   given('f00f00').expect('#f00f00')
   given('ABC123').expect('#abc123')
+  given('#ccc').expect('#ccc')
+  given('#fffe').expect('#fffe')
+  given('#fffeffff').expect('#fffeffff')
   given('#ABC123').expect('#abc123')
   given('papayawhip').expect('papayawhip')
   given('purple').expect('purple')
+  given('  blue ').expect('  blue ')
+  given('rgb(100%, 200%, 222%)').expect('rgb(100%, 200%, 222%)')
+  given('rgb(122, 200, 222)').expect('rgb(122, 200, 222)')
+  given('rgb(122, 200, 222, 1)').expect('rgb(122, 200, 222, 1)')
+  given('rgba(100, 20, 111, 1)').expect('rgba(100, 20, 111, 1)')
+  given('hsl(122, 200%, 222%)').expect('hsl(122, 200%, 222%)')
+  given('hsla(122, 200%, 222%, 1)').expect('hsla(122, 200%, 222%, 1)')
   forCases([
+    given(),
     given(''),
     given('not-a-color'),
+    given('#ABCFGH'),
+    given('rgb(-100, 20, 111)'),
+    given('rgb(100%, 200, 222)'),
+    given('rgba(-100, 20, 111, 1.1)'),
+    given('hsl(122, 200, 222, 1)'),
+    given('hsl(122, 200, 222)'),
+    given('hsl(122, 200, 222%)'),
     given(undefined),
     given(null),
     given(true),
+    given(1),
+    given(Math),
     given([]),
     given({}),
     given(() => {}),
@@ -55,3 +80,12 @@ test(toSvgColor, () => {
   given('lightgray').expect('#9f9f9f')
   given('informational').expect('#007ec6')
 })
+
+test(brightness, () => {
+  given('white').expect(1)
+  given('black').expect(0)
+  given('#abc123').expect(0.66)
+  given('rgb(10, 5, 128)').expect(0.08)
+  given(undefined).expect(0)
+  given('not-a-color').expect(0)
+})

badge-maker/lib/index.js

@@ -0,0 +1,81 @@
+'use strict'
+/**
+ * @module badge-maker
+ */
+
+const _makeBadge = require('./make-badge')
+
+class ValidationError extends Error {}
+
+function _validate(format) {
+  if (format !== Object(format)) {
+    throw new ValidationError('makeBadge takes an argument of type object')
+  }
+
+  if (!('message' in format)) {
+    throw new ValidationError('Field `message` is required')
+  }
+
+  const stringFields = ['labelColor', 'color', 'message', 'label']
+  stringFields.forEach(function (field) {
+    if (field in format && typeof format[field] !== 'string') {
+      throw new ValidationError(`Field \`${field}\` must be of type string`)
+    }
+  })
+
+  const styleValues = [
+    'plastic',
+    'flat',
+    'flat-square',
+    'for-the-badge',
+    'social',
+  ]
+  if ('style' in format && !styleValues.includes(format.style)) {
+    throw new ValidationError(
+      `Field \`style\` must be one of (${styleValues.toString()})`
+    )
+  }
+}
+
+function _clean(format) {
+  const expectedKeys = ['label', 'message', 'labelColor', 'color', 'style']
+
+  const cleaned = {}
+  Object.keys(format).forEach(key => {
+    if (format[key] != null && expectedKeys.includes(key)) {
+      cleaned[key] = format[key]
+    } else {
+      throw new ValidationError(
+        `Unexpected field '${key}'. Allowed values are (${expectedKeys.toString()})`
+      )
+    }
+  })
+
+  // Legacy.
+  cleaned.label = cleaned.label || ''
+
+  return cleaned
+}
+
+/**
+ * Create a badge
+ *
+ * @param {object} format Object specifying badge data
+ * @param {string} format.label (Optional) Badge label (e.g: 'build')
+ * @param {string} format.message (Required) Badge message (e.g: 'passing')
+ * @param {string} format.labelColor (Optional) Label color
+ * @param {string} format.color (Optional) Message color
+ * @param {string} format.style (Optional) Visual style e.g: 'flat'
+ * @returns {string} Badge in SVG format
+ * @see https://github.com/badges/shields/tree/master/badge-maker/README.md
+ */
+function makeBadge(format) {
+  _validate(format)
+  const cleanedFormat = _clean(format)
+  return _makeBadge(cleanedFormat)
+}
+
+module.exports = {
+  makeBadge,
+  ValidationError,
+}

badge-maker/lib/index.spec.js

@@ -0,0 +1,75 @@
+'use strict'
+
+const { expect } = require('chai')
+const isSvg = require('is-svg')
+const { makeBadge, ValidationError } = require('.')
+
+describe('makeBadge function', function () {
+  it('should produce badge with valid input', function () {
+    expect(
+      makeBadge({
+        label: 'build',
+        message: 'passed',
+      })
+    ).to.satisfy(isSvg)
+    expect(
+      makeBadge({
+        message: 'passed',
+      })
+    ).to.satisfy(isSvg)
+    expect(
+      makeBadge({
+        label: 'build',
+        message: 'passed',
+        color: 'green',
+        style: 'flat',
+      })
+    ).to.satisfy(isSvg)
+  })
+
+  it('should throw a ValidationError with invalid inputs', function () {
+    ;[null, undefined, 7, 'foo', 4.25].forEach(x => {
+      console.log(x)
+      expect(() => makeBadge(x)).to.throw(
+        ValidationError,
+        'makeBadge takes an argument of type object'
+      )
+    })
+    expect(() => makeBadge({})).to.throw(
+      ValidationError,
+      'Field `message` is required'
+    )
+    expect(() => makeBadge({ label: 'build' })).to.throw(
+      ValidationError,
+      'Field `message` is required'
+    )
+    expect(() =>
+      makeBadge({ label: 'build', message: 'passed', labelColor: 7 })
+    ).to.throw(ValidationError, 'Field `labelColor` must be of type string')
+    expect(() =>
+      makeBadge({ label: 'build', message: 'passed', format: 'png' })
+    ).to.throw(ValidationError, "Unexpected field 'format'")
+    expect(() =>
+      makeBadge({ label: 'build', message: 'passed', template: 'flat' })
+    ).to.throw(ValidationError, "Unexpected field 'template'")
+    expect(() =>
+      makeBadge({ label: 'build', message: 'passed', foo: 'bar' })
+    ).to.throw(ValidationError, "Unexpected field 'foo'")
+    expect(() =>
+      makeBadge({
+        label: 'build',
+        message: 'passed',
+        style: 'something else',
+      })
+    ).to.throw(
+      ValidationError,
+      'Field `style` must be one of (plastic,flat,flat-square,for-the-badge,social)'
+    )
+    expect(() =>
+      makeBadge({ label: 'build', message: 'passed', style: 'popout' })
+    ).to.throw(
+      ValidationError,
+      'Field `style` must be one of (plastic,flat,flat-square,for-the-badge,social)'
+    )
+  })
+})

badge-maker/lib/make-badge.js

@@ -0,0 +1,66 @@
+'use strict'
+
+const { normalizeColor, toSvgColor } = require('./color')
+const badgeRenderers = require('./badge-renderers')
+
+function stripXmlWhitespace(xml) {
+  return xml.replace(/>\s+/g, '>').replace(/<\s+/g, '<').trim()
+}
+
+/*
+note: makeBadge() is fairly thinly wrapped so if we are making changes here
+it is likely this will impact on the package's public interface in index.js
+*/
+module.exports = function makeBadge({
+  format,
+  style = 'flat',
+  label,
+  message,
+  color,
+  labelColor,
+  logo,
+  logoPosition,
+  logoWidth,
+  links = ['', ''],
+}) {
+  // String coercion and whitespace removal.
+  label = `${label}`.trim()
+  message = `${message}`.trim()
+
+  // This ought to be the responsibility of the server, not `makeBadge`.
+  if (format === 'json') {
+    return JSON.stringify({
+      label,
+      message,
+      logoWidth,
+      // Only call normalizeColor for the JSON case: this is handled
+      // internally by toSvgColor in the SVG case.
+      color: normalizeColor(color),
+      labelColor: normalizeColor(labelColor),
+      link: links,
+      name: label,
+      value: message,
+    })
+  }
+
+  const render = badgeRenderers[style]
+  if (!render) {
+    throw new Error(`Unknown badge style: '${style}'`)
+  }
+
+  logoWidth = +logoWidth || (logo ? 14 : 0)
+
+  return stripXmlWhitespace(
+    render({
+      label,
+      message,
+      links,
+      logo,
+      logoPosition,
+      logoWidth,
+      logoPadding: logo && label.length ? 3 : 0,
+      color: toSvgColor(color),
+      labelColor: toSvgColor(labelColor),
+    })
+  )
+}

badge-maker/lib/make-badge.spec.js

@@ -0,0 +1,583 @@
+'use strict'
+
+const { test, given, forCases } = require('sazerac')
+const { expect } = require('chai')
+const snapshot = require('snap-shot-it')
+const isSvg = require('is-svg')
+const prettier = require('prettier')
+const makeBadge = require('./make-badge')
+
+function expectBadgeToMatchSnapshot(format) {
+  snapshot(prettier.format(makeBadge(format), { parser: 'html' }))
+}
+
+function testColor(color = '', colorAttr = 'color') {
+  return JSON.parse(
+    makeBadge({
+      label: 'name',
+      message: 'Bob',
+      [colorAttr]: color,
+      format: 'json',
+    })
+  ).color
+}
+
+describe('The badge generator', function () {
+  describe('color test', function () {
+    test(testColor, () => {
+      // valid hex
+      forCases([
+        given('#4c1'),
+        given('#4C1'),
+        given('4C1'),
+        given('4c1'),
+      ]).expect('#4c1')
+      forCases([
+        given('#abc123'),
+        given('#ABC123'),
+        given('abc123'),
+        given('ABC123'),
+      ]).expect('#abc123')
+      // valid rgb(a)
+      given('rgb(0,128,255)').expect('rgb(0,128,255)')
+      given('rgb(220,128,255,0.5)').expect('rgb(220,128,255,0.5)')
+      given('rgba(0,0,255)').expect('rgba(0,0,255)')
+      given('rgba(0,128,255,0)').expect('rgba(0,128,255,0)')
+      // valid hsl(a)
+      given('hsl(100, 56%, 10%)').expect('hsl(100, 56%, 10%)')
+      given('hsl(360,50%,50%,0.5)').expect('hsl(360,50%,50%,0.5)')
+      given('hsla(25,20%,0%,0.1)').expect('hsla(25,20%,0%,0.1)')
+      given('hsla(0,50%,101%)').expect('hsla(0,50%,101%)')
+      // CSS named color.
+      given('papayawhip').expect('papayawhip')
+      // Shields named color.
+      given('red').expect('red')
+      given('green').expect('green')
+      given('blue').expect('blue')
+      given('yellow').expect('yellow')
+      // Semantic color alias
+      given('success').expect('brightgreen')
+      given('informational').expect('blue')
+
+      forCases(
+        // invalid hex
+        given('#123red'), // contains letter above F
+        given('#red'), // contains letter above F
+        // neither a css named color nor colorscheme
+        given('notacolor'),
+        given('bluish'),
+        given('almostred'),
+        given('brightmaroon'),
+        given('cactus')
+      ).expect(undefined)
+    })
+  })
+
+  describe('color aliases', function () {
+    test(testColor, () => {
+      forCases([given('#4c1', 'color')]).expect('#4c1')
+    })
+  })
+
+  describe('SVG', function () {
+    it('should produce SVG', function () {
+      expect(makeBadge({ label: 'cactus', message: 'grown', format: 'svg' }))
+        .to.satisfy(isSvg)
+        .and.to.include('cactus')
+        .and.to.include('grown')
+    })
+
+    it('should match snapshot', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+      })
+    })
+  })
+
+  describe('JSON', function () {
+    it('should produce the expected JSON', function () {
+      const json = makeBadge({
+        label: 'cactus',
+        message: 'grown',
+        format: 'json',
+        links: ['https://example.com/', 'https://other.example.com/'],
+      })
+      expect(JSON.parse(json)).to.deep.equal({
+        name: 'cactus',
+        label: 'cactus',
+        value: 'grown',
+        message: 'grown',
+        link: ['https://example.com/', 'https://other.example.com/'],
+      })
+    })
+
+    it('should replace undefined svg badge style with "flat"', function () {
+      const jsonBadgeWithUnknownStyle = makeBadge({
+        label: 'name',
+        message: 'Bob',
+        format: 'svg',
+      })
+      const jsonBadgeWithDefaultStyle = makeBadge({
+        label: 'name',
+        message: 'Bob',
+        format: 'svg',
+        style: 'flat',
+      })
+      expect(jsonBadgeWithUnknownStyle)
+        .to.equal(jsonBadgeWithDefaultStyle)
+        .and.to.satisfy(isSvg)
+    })
+
+    it('should fail with unknown svg badge style', function () {
+      expect(() =>
+        makeBadge({
+          label: 'name',
+          message: 'Bob',
+          format: 'svg',
+          style: 'unknown_style',
+        })
+      ).to.throw(Error, "Unknown badge style: 'unknown_style'")
+    })
+  })
+
+  describe('"flat" template badge generation', function () {
+    it('should match snapshots: message/label, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
+    })
+
+    it('should match snapshots: message/label, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+      })
+    })
+
+    it('should match snapshots: message only, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, with logo and labelColor', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message/label, with links', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
+    })
+  })
+
+  describe('"flat-square" template badge generation', function () {
+    it('should match snapshots: message/label, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
+    })
+
+    it('should match snapshots: message/label, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+      })
+    })
+
+    it('should match snapshots: message only, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, with logo and labelColor', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message/label, with links', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
+    })
+  })
+
+  describe('"plastic" template badge generation', function () {
+    it('should match snapshots: message/label, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
+    })
+
+    it('should match snapshots: message/label, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+      })
+    })
+
+    it('should match snapshots: message only, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, with logo and labelColor', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message/label, with links', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
+    })
+  })
+
+  describe('"for-the-badge" template badge generation', function () {
+    // https://github.com/badges/shields/issues/1280
+    it('numbers should produce a string', function () {
+      expect(
+        makeBadge({
+          label: 1998,
+          message: 1999,
+          format: 'svg',
+          style: 'for-the-badge',
+        })
+      )
+        .to.include('1998')
+        .and.to.include('1999')
+    })
+
+    it('lowercase/mixedcase string should produce uppercase string', function () {
+      expect(
+        makeBadge({
+          label: 'Label',
+          message: '1 string',
+          format: 'svg',
+          style: 'for-the-badge',
+        })
+      )
+        .to.include('LABEL')
+        .and.to.include('1 STRING')
+    })
+
+    it('should match snapshots: message/label, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
+    })
+
+    it('should match snapshots: message/label, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+      })
+    })
+
+    it('should match snapshots: message only, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, with logo and labelColor', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message/label, with links', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
+    })
+  })
+
+  describe('"social" template badge generation', function () {
+    it('should produce capitalized string for badge key', function () {
+      expect(
+        makeBadge({
+          label: 'some-key',
+          message: 'some-value',
+          format: 'svg',
+          style: 'social',
+        })
+      )
+        .to.include('Some-key')
+        .and.to.include('some-value')
+    })
+
+    // https://github.com/badges/shields/issues/1606
+    it('should handle empty strings used as badge keys', function () {
+      expect(
+        makeBadge({
+          label: '',
+          message: 'some-value',
+          format: 'json',
+          style: 'social',
+        })
+      )
+        .to.include('""')
+        .and.to.include('some-value')
+    })
+
+    it('should match snapshots: message/label, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
+    })
+
+    it('should match snapshots: message/label, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, no logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+      })
+    })
+
+    it('should match snapshots: message only, with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message only, with logo and labelColor', function () {
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+
+    it('should match snapshots: message/label, with links', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
+    })
+  })
+
+  describe('badges with logos should always produce the same badge', function () {
+    it('badge with logo', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'label',
+        message: 'message',
+        format: 'svg',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
+    })
+  })
+
+  describe('text colors', function () {
+    it('should use black text when the label color is light', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#000',
+        labelColor: '#f3f3f3',
+      })
+    })
+
+    it('should use black text when the message color is light', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#e2ffe1',
+        labelColor: '#000',
+      })
+    })
+  })
+})

badge-maker/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "gh-badges",
-  "version": "2.2.1",
+  "name": "badge-maker",
+  "version": "3.3.0",
   "description": "Shields.io badge library",
   "keywords": [
     "GitHub",
@@ -9,11 +9,12 @@
     "image",
     "shields.io"
   ],
+  "types": "index.d.ts",
   "main": "lib/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/badges/shields.git",
-    "directory": "gh-badges"
+    "directory": "badge-maker"
   },
   "author": "Thaddée Tyl <thaddee.tyl@gmail.com>",
   "license": "CC0-1.0",
@@ -25,7 +26,7 @@
     "badge": "lib/badge-cli.js"
   },
   "engines": {
-    "node": ">= 8",
+    "node": ">= 10",
     "npm": ">= 5"
   },
   "collective": {
@@ -34,11 +35,8 @@
     "logo": "https://opencollective.com/opencollective/logo.txt"
   },
   "dependencies": {
-    "anafanafo": "^1.0.0",
-    "dot": "^1.1.2",
-    "gm": "^1.23.0",
-    "is-css-color": "^1.0.0",
-    "svgo": "^1.1.1"
+    "anafanafo": "2.0.0",
+    "css-color-converter": "^2.0.0"
   },
   "scripts": {
     "test": "echo 'Run tests from parent dir'; false"

config/custom-environment-variables.yml

@@ -6,34 +6,54 @@ public:
   metrics:
     prometheus:
       enabled: 'METRICS_PROMETHEUS_ENABLED'
+      endpointEnabled: 'METRICS_PROMETHEUS_ENDPOINT_ENABLED'
+    influx:
+      enabled: 'METRICS_INFLUX_ENABLED'
+      url: 'METRICS_INFLUX_URL'
+      timeoutMilliseconds: 'METRICS_INFLUX_TIMEOUT_MILLISECONDS'
+      intervalSeconds: 'METRICS_INFLUX_INTERVAL_SECONDS'
+      instanceIdFrom: 'METRICS_INFLUX_INSTANCE_ID_FROM'
+      instanceIdEnvVarName: 'METRICS_INFLUX_INSTANCE_ID_ENV_VAR_NAME'
+      envLabel: 'METRICS_INFLUX_ENV_LABEL'
 
   ssl:
     isSecure: 'HTTPS'
     key: 'HTTPS_KEY'
     cert: 'HTTPS_CRT'
 
-  redirectUri: 'REDIRECT_URI'
+  redirectUrl: 'REDIRECT_URI'
+
+  rasterUrl: 'RASTER_URL'
 
   cors:
     allowedOrigin:
       __name: 'ALLOWED_ORIGIN'
       __format: 'json'
 
-  persistence:
-    dir: 'PERSISTENCE_DIR'
-    redisUrl: 'REDIS_URL'
-
   services:
+    bitbucketServer:
+      authorizedOrigins: 'BITBUCKET_SERVER_ORIGINS'
+    drone:
+      authorizedOrigins: 'DRONE_ORIGINS'
     github:
       baseUri: 'GITHUB_URL'
       debug:
         enabled: 'GITHUB_DEBUG_ENABLED'
         intervalSeconds: 'GITHUB_DEBUG_INTERVAL_SECONDS'
+    jenkins:
+      authorizedOrigins: 'JENKINS_ORIGINS'
+    jira:
+      authorizedOrigins: 'JIRA_ORIGINS'
+    nexus:
+      authorizedOrigins: 'NEXUS_ORIGINS'
+    npm:
+      authorizedOrigins: 'NPM_ORIGINS'
+    sonar:
+      authorizedOrigins: 'SONAR_ORIGINS'
+    teamcity:
+      authorizedOrigins: 'TEAMCITY_ORIGINS'
     trace: 'TRACE_SERVICES'
 
-  profiling:
-    makeBadge: 'PROFILE_MAKE_BADGE'
-
   cacheHeaders:
     defaultCacheLengthSeconds: 'BADGE_MAX_AGE_SECONDS'
 
@@ -41,10 +61,18 @@ public:
 
   fetchLimit: 'FETCH_LIMIT'
 
+  requestTimeoutSeconds: 'REQUEST_TIMEOUT_SECONDS'
+  requestTimeoutMaxAgeSeconds: 'REQUEST_TIMEOUT_MAX_AGE_SECONDS'
+
+  requireCloudflare: 'REQUIRE_CLOUDFLARE'
+
 private:
   azure_devops_token: 'AZURE_DEVOPS_TOKEN'
-  bintray_user: 'BINTRAY_USER'
-  bintray_apikey: 'BINTRAY_API_KEY'
+  bitbucket_username: 'BITBUCKET_USER'
+  bitbucket_password: 'BITBUCKET_PASS'
+  bitbucket_server_username: 'BITBUCKET_SERVER_USER'
+  bitbucket_server_password: 'BITBUCKET_SERVER_PASS'
+  discord_bot_token: 'DISCORD_BOT_TOKEN'
   drone_token: 'DRONE_TOKEN'
   gh_client_id: 'GH_CLIENT_ID'
   gh_client_secret: 'GH_CLIENT_SECRET'
@@ -56,9 +84,17 @@ private:
   nexus_user: 'NEXUS_USER'
   nexus_pass: 'NEXUS_PASS'
   npm_token: 'NPM_TOKEN'
+  redis_url: 'REDIS_URL'
   sentry_dsn: 'SENTRY_DSN'
   shields_secret: 'SHIELDS_SECRET'
   sl_insight_userUuid: 'SL_INSIGHT_USER_UUID'
   sl_insight_apiToken: 'SL_INSIGHT_API_TOKEN'
   sonarqube_token: 'SONARQUBE_TOKEN'
+  teamcity_user: 'TEAMCITY_USER'
+  teamcity_pass: 'TEAMCITY_PASS'
+  twitch_client_id: 'TWITCH_CLIENT_ID'
+  twitch_client_secret: 'TWITCH_CLIENT_SECRET'
   wheelmap_token: 'WHEELMAP_TOKEN'
+  influx_username: 'INFLUX_USERNAME'
+  influx_password: 'INFLUX_PASSWORD'
+  youtube_api_key: 'YOUTUBE_API_KEY'

config/default.yml

@@ -5,16 +5,17 @@ public:
   metrics:
     prometheus:
       enabled: false
-
+      endpointEnabled: false
+    influx:
+      enabled: false
+      timeoutMilliseconds: 1000
+      intervalSeconds: 15
   ssl:
     isSecure: false
 
   cors:
     allowedOrigin: []
 
-  persistence:
-    dir: './private'
-
   services:
     github:
       baseUri: 'https://api.github.com/'
@@ -23,9 +24,6 @@ public:
         intervalSeconds: 200
     trace: false
 
-  profiling:
-    makeBadge: false
-
   cacheHeaders:
     defaultCacheLengthSeconds: 120
 
@@ -35,4 +33,9 @@ public:
 
   fetchLimit: '10MB'
 
+  requestTimeoutSeconds: 120
+  requestTimeoutMaxAgeSeconds: 30
+
+  requireCloudflare: false
+
 private: {}

config/local-shields-io-production.template.yml

@@ -1,10 +1,14 @@
 private:
-  bintray_user: ...
-  bintray_apikey: ...
+  # These are the keys which are set on the production servers.
+  discord_bot_token: ...
   gh_client_id: ...
   gh_client_secret: ...
+  redis_url: ...
   sentry_dsn: ...
   shields_secret: ...
   sl_insight_userUuid: ...
   sl_insight_apiToken: ...
+  twitch_client_id: ...
+  twitch_client_secret: ...
   wheelmap_token: ...
+  youtube_api_key: ...

config/local.template.yml

@@ -5,4 +5,7 @@ private:
   # you can also set these values through environment variables, which may be
   # preferable for self hosting.
   gh_token: '...'
+  twitch_client_id: '...'
+  twitch_client_secret: '...'
   wheelmap_token: '...'
+  youtube_api_key: '...'

config/shields-io-production.yml

@@ -2,6 +2,12 @@ public:
   metrics:
     prometheus:
       enabled: true
+    influx:
+      enabled: true
+      url: https://metrics.shields.io/telegraf
+      instanceIdFrom: env-var
+      instanceIdEnvVarName: HEROKU_DYNO_ID
+      envLabel: shields-production
 
   ssl:
     isSecure: true
@@ -9,8 +15,4 @@ public:
   cors:
     allowedOrigin: ['http://shields.io', 'https://shields.io']
 
-  redirectUrl: 'https://shields.io/'
-
-private:
-  # These are not really private; they should be moved to `public`.
-  shields_ips: ['192.99.59.72', '51.254.114.150', '149.56.96.133']
+  rasterUrl: 'https://raster.shields.io'

config/test.yml

@@ -5,6 +5,8 @@ public:
 
   rateLimit: false
 
-  redirectUrl: 'http://badge-server.example.com'
+  redirectUrl: 'http://frontend.example.test'
+
+  rasterUrl: 'http://raster.example.test'
 
   handleInternalErrors: false

core/badge-urls/make-badge-url.d.ts

@@ -0,0 +1,112 @@
+export function badgeUrlFromPath({
+  baseUrl,
+  path,
+  queryParams,
+  style,
+  format,
+  longCache,
+}: {
+  baseUrl?: string
+  path: string
+  queryParams: { [k: string]: string | number | boolean }
+  style?: string
+  format?: string
+  longCache?: boolean
+}): string
+
+export function badgeUrlFromPattern({
+  baseUrl,
+  pattern,
+  namedParams,
+  queryParams,
+  style,
+  format,
+  longCache,
+}: {
+  baseUrl?: string
+  pattern: string
+  namedParams: { [k: string]: string }
+  queryParams: { [k: string]: string | number | boolean }
+  style?: string
+  format?: string
+  longCache?: boolean
+}): string
+
+export function encodeField(s: string): string
+
+export function staticBadgeUrl({
+  baseUrl,
+  label,
+  message,
+  labelColor,
+  color,
+  style,
+  namedLogo,
+  format,
+  links,
+}: {
+  baseUrl?: string
+  label: string
+  message: string
+  labelColor?: string
+  color?: string
+  style?: string
+  namedLogo?: string
+  format?: string
+  links?: string[]
+}): string
+
+export function queryStringStaticBadgeUrl({
+  baseUrl,
+  label,
+  message,
+  color,
+  labelColor,
+  style,
+  namedLogo,
+  logoColor,
+  logoWidth,
+  logoPosition,
+  format,
+}: {
+  baseUrl?: string
+  label: string
+  message: string
+  color?: string
+  labelColor?: string
+  style?: string
+  namedLogo?: string
+  logoColor?: string
+  logoWidth?: number
+  logoPosition?: number
+  format?: string
+}): string
+
+export function dynamicBadgeUrl({
+  baseUrl,
+  datatype,
+  label,
+  dataUrl,
+  query,
+  prefix,
+  suffix,
+  color,
+  style,
+  format,
+}: {
+  baseUrl?: string
+  datatype: string
+  label: string
+  dataUrl: string
+  query: string
+  prefix: string
+  suffix: string
+  color?: string
+  style?: string
+  format?: string
+}): string
+
+export function rasterRedirectUrl(
+  { rasterUrl }: { rasterUrl: string },
+  badgeUrl: string
+): string

core/badge-urls/make-badge-url.js

@@ -1,14 +1,15 @@
 'use strict'
 
+const { URL } = require('url')
 const queryString = require('query-string')
-const pathToRegexp = require('path-to-regexp')
+const { compile } = require('path-to-regexp')
 
 function badgeUrlFromPath({
   baseUrl = '',
   path,
   queryParams,
   style,
-  format = 'svg',
+  format = '',
   longCache = false,
 }) {
   const outExt = format.length ? `.${format}` : ''
@@ -29,12 +30,13 @@ function badgeUrlFromPattern({
   namedParams,
   queryParams,
   style,
-  format = 'svg',
+  format = '',
   longCache = false,
 }) {
-  const toPath = pathToRegexp.compile(pattern, {
+  const toPath = compile(pattern, {
     strict: true,
     sensitive: true,
+    encode: encodeURIComponent,
   })
 
   const path = toPath(namedParams)
@@ -57,18 +59,23 @@ function staticBadgeUrl({
   baseUrl = '',
   label,
   message,
+  labelColor,
   color = 'lightgray',
   style,
   namedLogo,
-  format = 'svg',
+  format = '',
+  links = [],
 }) {
   const path = [label, message, color].map(encodeField).join('-')
   const outQueryString = queryString.stringify({
+    labelColor,
     style,
     logo: namedLogo,
+    link: links,
   })
+  const outExt = format.length ? `.${format}` : ''
   const suffix = outQueryString ? `?${outQueryString}` : ''
-  return `${baseUrl}/badge/${path}.${format}${suffix}`
+  return `${baseUrl}/badge/${path}${outExt}${suffix}`
 }
 
 function queryStringStaticBadgeUrl({
@@ -82,7 +89,7 @@ function queryStringStaticBadgeUrl({
   logoColor,
   logoWidth,
   logoPosition,
-  format = 'svg',
+  format = '',
 }) {
   // schemaVersion could be a parameter if we iterate on it,
   // for now it's hardcoded to the only supported version.
@@ -98,7 +105,8 @@ function queryStringStaticBadgeUrl({
     logoWidth,
     logoPosition,
   })}`
-  return `${baseUrl}/static/v${schemaVersion}.${format}${suffix}`
+  const outExt = format.length ? `.${format}` : ''
+  return `${baseUrl}/static/v${schemaVersion}${outExt}${suffix}`
 }
 
 function dynamicBadgeUrl({
@@ -111,8 +119,10 @@ function dynamicBadgeUrl({
   suffix,
   color,
   style,
-  format = 'svg',
+  format = '',
 }) {
+  const outExt = format.length ? `.${format}` : ''
+
   const queryParams = {
     label,
     url: dataUrl,
@@ -131,7 +141,16 @@ function dynamicBadgeUrl({
   }
 
   const outQueryString = queryString.stringify(queryParams)
-  return `${baseUrl}/badge/dynamic/${datatype}.${format}?${outQueryString}`
+  return `${baseUrl}/badge/dynamic/${datatype}${outExt}?${outQueryString}`
+}
+
+function rasterRedirectUrl({ rasterUrl }, badgeUrl) {
+  // Ensure we're always using the `rasterUrl` by using just the path from
+  // the request URL.
+  const { pathname, search } = new URL(badgeUrl, 'https://bogus.test')
+  const result = new URL(pathname, rasterUrl)
+  result.search = search
+  return result
 }
 
 module.exports = {
@@ -141,4 +160,5 @@ module.exports = {
   staticBadgeUrl,
   queryStringStaticBadgeUrl,
   dynamicBadgeUrl,
+  rasterRedirectUrl,
 }

core/badge-urls/make-badge-url.spec.js

@@ -10,7 +10,7 @@ const {
   dynamicBadgeUrl,
 } = require('./make-badge-url')
 
-describe('Badge URL generation functions', function() {
+describe('Badge URL generation functions', function () {
   test(badgeUrlFromPath, () => {
     given({
       baseUrl: 'http://example.com',
@@ -18,7 +18,7 @@ describe('Badge URL generation functions', function() {
       style: 'flat-square',
       longCache: true,
     }).expect(
-      'http://example.com/npm/v/gh-badges.svg?cacheSeconds=2592000&style=flat-square'
+      'http://example.com/npm/v/gh-badges?cacheSeconds=2592000&style=flat-square'
     )
   })
 
@@ -30,7 +30,7 @@ describe('Badge URL generation functions', function() {
       style: 'flat-square',
       longCache: true,
     }).expect(
-      'http://example.com/npm/v/gh-badges.svg?cacheSeconds=2592000&style=flat-square'
+      'http://example.com/npm/v/gh-badges?cacheSeconds=2592000&style=flat-square'
     )
   })
 
@@ -48,7 +48,7 @@ describe('Badge URL generation functions', function() {
       message: 'bar',
       color: 'blue',
       style: 'flat-square',
-    }).expect('/badge/foo-bar-blue.svg?style=flat-square')
+    }).expect('/badge/foo-bar-blue?style=flat-square')
     given({
       label: 'foo',
       message: 'bar',
@@ -62,24 +62,24 @@ describe('Badge URL generation functions', function() {
       message: 'Привет Мир',
       color: '#aabbcc',
     }).expect(
-      '/badge/Hello%20World-%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80-%23aabbcc.svg'
+      '/badge/Hello%20World-%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80-%23aabbcc'
     )
     given({
       label: '123-123',
       message: 'abc-abc',
       color: 'blue',
-    }).expect('/badge/123--123-abc--abc-blue.svg')
+    }).expect('/badge/123--123-abc--abc-blue')
     given({
       label: '123-123',
       message: '',
       color: 'blue',
       style: 'social',
-    }).expect('/badge/123--123--blue.svg?style=social')
+    }).expect('/badge/123--123--blue?style=social')
     given({
       label: '',
       message: 'blue',
       color: 'blue',
-    }).expect('/badge/-blue-blue.svg')
+    }).expect('/badge/-blue-blue')
   })
 
   test(queryStringStaticBadgeUrl, () => {
@@ -89,9 +89,7 @@ describe('Badge URL generation functions', function() {
       message: 'bar',
       color: 'blue',
       style: 'flat-square',
-    }).expect(
-      '/static/v1.svg?color=blue&label=foo&message=bar&style=flat-square'
-    )
+    }).expect('/static/v1?color=blue&label=foo&message=bar&style=flat-square')
     given({
       label: 'foo Bar',
       message: 'bar Baz',
@@ -107,7 +105,7 @@ describe('Badge URL generation functions', function() {
       message: 'Привет Мир',
       color: '#aabbcc',
     }).expect(
-      '/static/v1.svg?color=%23aabbcc&label=Hello%20World&message=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80'
+      '/static/v1?color=%23aabbcc&label=Hello%20World&message=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80'
     )
   })
 
@@ -125,7 +123,7 @@ describe('Badge URL generation functions', function() {
       style: 'plastic',
     }).expect(
       [
-        'http://img.example.com/badge/dynamic/json.svg',
+        'http://img.example.com/badge/dynamic/json',
         '?label=foo',
         `&prefix=${encodeURIComponent(prefix)}`,
         `&query=${encodeURIComponent(query)}`,
@@ -146,7 +144,7 @@ describe('Badge URL generation functions', function() {
       style: 'plastic',
     }).expect(
       [
-        'http://img.example.com/badge/dynamic/json.svg',
+        'http://img.example.com/badge/dynamic/json',
         '?color=blue',
         '&label=foo',
         `&query=${encodeURIComponent(query)}`,

core/badge-urls/path-helpers.js

@@ -5,11 +5,8 @@
 function escapeFormat(t) {
   return (
     t
-      // Inline single underscore.
-      .replace(/([^_])_([^_])/g, '$1 $2')
-      // Leading or trailing underscore.
-      .replace(/([^_])_$/, '$1 ')
-      .replace(/^_([^_])/, ' $1')
+      // Single underscore.
+      .replace(/(^|[^_])((?:__)*)_(?!_)/g, '$1$2 ')
       // Double underscore and double dash.
       .replace(/__/g, '_')
       .replace(/--/g, '-')

core/badge-urls/path-helpers.spec.js

@@ -0,0 +1,21 @@
+'use strict'
+
+const { test, given } = require('sazerac')
+const { escapeFormat } = require('./path-helpers')
+
+describe('Badge URL helper functions', function () {
+  test(escapeFormat, () => {
+    given('_single leading underscore').expect(' single leading underscore')
+    given('single trailing underscore_').expect('single trailing underscore ')
+    given('__double leading underscores').expect('_double leading underscores')
+    given('double trailing underscores__').expect(
+      'double trailing underscores_'
+    )
+    given('treble___underscores').expect('treble_ underscores')
+    given('fourfold____underscores').expect('fourfold__underscores')
+    given('double--dashes').expect('double-dashes')
+    given('treble---dashes').expect('treble--dashes')
+    given('fourfold----dashes').expect('fourfold--dashes')
+    given('once_in_a_blue--moon').expect('once in a blue-moon')
+  })
+})

core/base-service/auth-helper.js

@@ -0,0 +1,212 @@
+'use strict'
+
+const { URL } = require('url')
+const { InvalidParameter } = require('./errors')
+
+class AuthHelper {
+  constructor(
+    {
+      userKey,
+      passKey,
+      authorizedOrigins,
+      serviceKey,
+      isRequired = false,
+      defaultToEmptyStringForUser = false,
+    },
+    config
+  ) {
+    if (!userKey && !passKey) {
+      throw Error('Expected userKey or passKey to be set')
+    }
+
+    if (!authorizedOrigins && !serviceKey) {
+      throw Error('Expected authorizedOrigins or serviceKey to be set')
+    }
+
+    this._userKey = userKey
+    this._passKey = passKey
+    if (userKey) {
+      this._user = config.private[userKey]
+    } else {
+      this._user = defaultToEmptyStringForUser ? '' : undefined
+    }
+    this._pass = passKey ? config.private[passKey] : undefined
+    this.isRequired = isRequired
+
+    if (serviceKey !== undefined && !(serviceKey in config.public.services)) {
+      // Keep this as its own error, as it's useful to the programmer as they're
+      // getting auth set up.
+      throw Error(`Service key ${serviceKey} was missing from config schema`)
+    }
+
+    let requireStrictSsl, requireStrictSslToAuthenticate
+    if (serviceKey === undefined) {
+      requireStrictSsl = true
+      requireStrictSslToAuthenticate = true
+    } else {
+      ;({
+        authorizedOrigins,
+        requireStrictSsl = true,
+        requireStrictSslToAuthenticate = true,
+      } = config.public.services[serviceKey])
+    }
+    if (!Array.isArray(authorizedOrigins)) {
+      throw Error('Expected authorizedOrigins to be an array of origins')
+    }
+    this._authorizedOrigins = authorizedOrigins
+    this._requireStrictSsl = requireStrictSsl
+    this._requireStrictSslToAuthenticate = requireStrictSslToAuthenticate
+  }
+
+  get isConfigured() {
+    return (
+      this._authorizedOrigins.length > 0 &&
+      (this._userKey ? Boolean(this._user) : true) &&
+      (this._passKey ? Boolean(this._pass) : true)
+    )
+  }
+
+  get isValid() {
+    if (this.isRequired) {
+      return this.isConfigured
+    } else {
+      const configIsEmpty = !this._user && !this._pass
+      return this.isConfigured || configIsEmpty
+    }
+  }
+
+  static _isInsecureSslRequest({ options = {} }) {
+    const { strictSSL = true } = options
+    return strictSSL !== true
+  }
+
+  enforceStrictSsl({ options = {} }) {
+    if (
+      this._requireStrictSsl &&
+      this.constructor._isInsecureSslRequest({ options })
+    ) {
+      throw new InvalidParameter({ prettyMessage: 'strict ssl is required' })
+    }
+  }
+
+  shouldAuthenticateRequest({ url, options = {} }) {
+    let parsed
+    try {
+      parsed = new URL(url)
+    } catch (e) {
+      throw new InvalidParameter({ prettyMessage: 'invalid url parameter' })
+    }
+
+    const { protocol, host } = parsed
+    const origin = `${protocol}//${host}`
+    const originViolation = !this._authorizedOrigins.includes(origin)
+
+    const strictSslCheckViolation =
+      this._requireStrictSslToAuthenticate &&
+      this.constructor._isInsecureSslRequest({ options })
+
+    return this.isConfigured && !originViolation && !strictSslCheckViolation
+  }
+
+  get _basicAuth() {
+    const { _user: user, _pass: pass } = this
+    return this.isConfigured ? { user, pass } : undefined
+  }
+
+  /*
+   * Helper function for `withBasicAuth()` and friends.
+   */
+  _withAnyAuth(requestParams, mergeAuthFn) {
+    this.enforceStrictSsl(requestParams)
+
+    const shouldAuthenticate = this.shouldAuthenticateRequest(requestParams)
+    if (this.isRequired && !shouldAuthenticate) {
+      throw new InvalidParameter({
+        prettyMessage: 'requested origin not authorized',
+      })
+    }
+
+    return shouldAuthenticate ? mergeAuthFn(requestParams) : requestParams
+  }
+
+  static _mergeAuth(requestParams, auth) {
+    const { options, ...rest } = requestParams
+    return {
+      options: {
+        auth,
+        ...options,
+      },
+      ...rest,
+    }
+  }
+
+  withBasicAuth(requestParams) {
+    return this._withAnyAuth(requestParams, requestParams =>
+      this.constructor._mergeAuth(requestParams, this._basicAuth)
+    )
+  }
+
+  _bearerAuthHeader(bearerKey) {
+    const { _pass: pass } = this
+    return this.isConfigured
+      ? { Authorization: `${bearerKey} ${pass}` }
+      : undefined
+  }
+
+  static _mergeHeaders(requestParams, headers) {
+    const {
+      options: { headers: existingHeaders, ...restOptions } = {},
+      ...rest
+    } = requestParams
+    return {
+      options: {
+        headers: {
+          ...existingHeaders,
+          ...headers,
+        },
+        ...restOptions,
+      },
+      ...rest,
+    }
+  }
+
+  withBearerAuthHeader(
+    requestParams,
+    bearerKey = 'Bearer' // lgtm [js/hardcoded-credentials]
+  ) {
+    return this._withAnyAuth(requestParams, requestParams =>
+      this.constructor._mergeHeaders(
+        requestParams,
+        this._bearerAuthHeader(bearerKey)
+      )
+    )
+  }
+
+  static _mergeQueryParams(requestParams, query) {
+    const {
+      options: { qs: existingQuery, ...restOptions } = {},
+      ...rest
+    } = requestParams
+    return {
+      options: {
+        qs: {
+          ...existingQuery,
+          ...query,
+        },
+        ...restOptions,
+      },
+      ...rest,
+    }
+  }
+
+  withQueryStringAuth({ userKey, passKey }, requestParams) {
+    return this._withAnyAuth(requestParams, requestParams =>
+      this.constructor._mergeQueryParams(requestParams, {
+        ...(userKey ? { [userKey]: this._user } : undefined),
+        ...(passKey ? { [passKey]: this._pass } : undefined),
+      })
+    )
+  }
+}
+
+module.exports = { AuthHelper }

core/base-service/auth-helper.spec.js

@@ -0,0 +1,376 @@
+'use strict'
+
+const { expect } = require('chai')
+const { test, given, forCases } = require('sazerac')
+const { AuthHelper } = require('./auth-helper')
+const { InvalidParameter } = require('./errors')
+
+describe('AuthHelper', function () {
+  describe('constructor checks', function () {
+    it('throws without userKey or passKey', function () {
+      expect(() => new AuthHelper({}, {})).to.throw(
+        Error,
+        'Expected userKey or passKey to be set'
+      )
+    })
+    it('throws without serviceKey or authorizedOrigins', function () {
+      expect(
+        () => new AuthHelper({ userKey: 'myci_user', passKey: 'myci_pass' }, {})
+      ).to.throw(Error, 'Expected authorizedOrigins or serviceKey to be set')
+    })
+    it('throws when authorizedOrigins is not an array', function () {
+      expect(
+        () =>
+          new AuthHelper(
+            {
+              userKey: 'myci_user',
+              passKey: 'myci_pass',
+              authorizedOrigins: true,
+            },
+            { private: {} }
+          )
+      ).to.throw(Error, 'Expected authorizedOrigins to be an array of origins')
+    })
+  })
+
+  describe('isValid', function () {
+    function validate(config, privateConfig) {
+      return new AuthHelper(
+        { authorizedOrigins: ['https://example.test'], ...config },
+        { private: privateConfig }
+      ).isValid
+    }
+    test(validate, () => {
+      forCases([
+        // Fully configured user + pass.
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
+          { myci_user: 'admin', myci_pass: 'abc123' }
+        ),
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass' },
+          { myci_user: 'admin', myci_pass: 'abc123' }
+        ),
+        // Fully configured user or pass.
+        given(
+          { userKey: 'myci_user', isRequired: true },
+          { myci_user: 'admin' }
+        ),
+        given(
+          { passKey: 'myci_pass', isRequired: true },
+          { myci_pass: 'abc123' }
+        ),
+        given({ userKey: 'myci_user' }, { myci_user: 'admin' }),
+        given({ passKey: 'myci_pass' }, { myci_pass: 'abc123' }),
+        // Empty config.
+        given({ userKey: 'myci_user', passKey: 'myci_pass' }, {}),
+        given({ userKey: 'myci_user' }, {}),
+        given({ passKey: 'myci_pass' }, {}),
+      ]).expect(true)
+
+      forCases([
+        // Partly configured.
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
+          { myci_user: 'admin' }
+        ),
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass' },
+          { myci_user: 'admin' }
+        ),
+        // Missing required config.
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
+          {}
+        ),
+        given({ userKey: 'myci_user', isRequired: true }, {}),
+        given({ passKey: 'myci_pass', isRequired: true }, {}),
+      ]).expect(false)
+    })
+  })
+
+  describe('_basicAuth', function () {
+    function validate(config, privateConfig) {
+      return new AuthHelper(
+        { authorizedOrigins: ['https://example.test'], ...config },
+        { private: privateConfig }
+      )._basicAuth
+    }
+    test(validate, () => {
+      forCases([
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
+          { myci_user: 'admin', myci_pass: 'abc123' }
+        ),
+        given(
+          { userKey: 'myci_user', passKey: 'myci_pass' },
+          { myci_user: 'admin', myci_pass: 'abc123' }
+        ),
+      ]).expect({ user: 'admin', pass: 'abc123' })
+      given({ userKey: 'myci_user' }, { myci_user: 'admin' }).expect({
+        user: 'admin',
+        pass: undefined,
+      })
+      given({ passKey: 'myci_pass' }, { myci_pass: 'abc123' }).expect({
+        user: undefined,
+        pass: 'abc123',
+      })
+      given({ userKey: 'myci_user', passKey: 'myci_pass' }, {}).expect(
+        undefined
+      )
+      given(
+        { passKey: 'myci_pass', defaultToEmptyStringForUser: true },
+        { myci_pass: 'abc123' }
+      ).expect({
+        user: '',
+        pass: 'abc123',
+      })
+    })
+  })
+
+  describe('_isInsecureSslRequest', function () {
+    test(AuthHelper._isInsecureSslRequest, () => {
+      forCases([
+        given({ url: 'http://example.test' }),
+        given({ url: 'http://example.test', options: {} }),
+        given({ url: 'http://example.test', options: { strictSSL: true } }),
+        given({
+          url: 'http://example.test',
+          options: { strictSSL: undefined },
+        }),
+      ]).expect(false)
+      given({
+        url: 'http://example.test',
+        options: { strictSSL: false },
+      }).expect(true)
+    })
+  })
+
+  describe('enforceStrictSsl', function () {
+    const authConfig = {
+      userKey: 'myci_user',
+      passKey: 'myci_pass',
+      serviceKey: 'myci',
+    }
+
+    context('by default', function () {
+      const authHelper = new AuthHelper(authConfig, {
+        public: {
+          services: { myci: { authorizedOrigins: ['http://myci.test'] } },
+        },
+        private: { myci_user: 'admin', myci_pass: 'abc123' },
+      })
+      it('does not throw for secure requests', function () {
+        expect(() => authHelper.enforceStrictSsl({})).not.to.throw()
+      })
+      it('throws for insecure requests', function () {
+        expect(() =>
+          authHelper.enforceStrictSsl({ options: { strictSSL: false } })
+        ).to.throw(InvalidParameter)
+      })
+    })
+
+    context("when strict SSL isn't required", function () {
+      const authHelper = new AuthHelper(authConfig, {
+        public: {
+          services: {
+            myci: {
+              authorizedOrigins: ['http://myci.test'],
+              requireStrictSsl: false,
+            },
+          },
+        },
+        private: { myci_user: 'admin', myci_pass: 'abc123' },
+      })
+      it('does not throw for secure requests', function () {
+        expect(() => authHelper.enforceStrictSsl({})).not.to.throw()
+      })
+      it('does not throw for insecure requests', function () {
+        expect(() =>
+          authHelper.enforceStrictSsl({ options: { strictSSL: false } })
+        ).not.to.throw()
+      })
+    })
+  })
+
+  describe('shouldAuthenticateRequest', function () {
+    const authConfig = {
+      userKey: 'myci_user',
+      passKey: 'myci_pass',
+      serviceKey: 'myci',
+    }
+
+    context('by default', function () {
+      const authHelper = new AuthHelper(authConfig, {
+        public: {
+          services: {
+            myci: {
+              authorizedOrigins: ['https://myci.test'],
+            },
+          },
+        },
+        private: { myci_user: 'admin', myci_pass: 'abc123' },
+      })
+      const shouldAuthenticateRequest = requestOptions =>
+        authHelper.shouldAuthenticateRequest(requestOptions)
+      describe('a secure request to an authorized origin', function () {
+        test(shouldAuthenticateRequest, () => {
+          given({ url: 'https://myci.test/api' }).expect(true)
+        })
+      })
+      describe('an insecure request', function () {
+        test(shouldAuthenticateRequest, () => {
+          given({
+            url: 'https://myci.test/api',
+            options: { strictSSL: false },
+          }).expect(false)
+        })
+      })
+      describe('a request to an unauthorized origin', function () {
+        test(shouldAuthenticateRequest, () => {
+          forCases([
+            given({ url: 'http://myci.test/api' }),
+            given({ url: 'https://myci.test:12345/api' }),
+            given({ url: 'https://other.test/api' }),
+          ]).expect(false)
+        })
+      })
+    })
+
+    context('when auth over insecure SSL is allowed', function () {
+      const authHelper = new AuthHelper(authConfig, {
+        public: {
+          services: {
+            myci: {
+              authorizedOrigins: ['https://myci.test'],
+              requireStrictSslToAuthenticate: false,
+            },
+          },
+        },
+        private: { myci_user: 'admin', myci_pass: 'abc123' },
+      })
+      const shouldAuthenticateRequest = requestOptions =>
+        authHelper.shouldAuthenticateRequest(requestOptions)
+      describe('a secure request to an authorized origin', function () {
+        test(shouldAuthenticateRequest, () => {
+          given({ url: 'https://myci.test' }).expect(true)
+        })
+      })
+      describe('an insecure request', function () {
+        test(shouldAuthenticateRequest, () => {
+          given({
+            url: 'https://myci.test',
+            options: { strictSSL: false },
+          }).expect(true)
+        })
+      })
+      describe('a request to an unauthorized origin', function () {
+        test(shouldAuthenticateRequest, () => {
+          forCases([
+            given({ url: 'http://myci.test' }),
+            given({ url: 'https://myci.test:12345/' }),
+            given({ url: 'https://other.test' }),
+          ]).expect(false)
+        })
+      })
+    })
+
+    context('when the service is partly configured', function () {
+      const authHelper = new AuthHelper(authConfig, {
+        public: {
+          services: {
+            myci: {
+              authorizedOrigins: ['https://myci.test'],
+              requireStrictSslToAuthenticate: false,
+            },
+          },
+        },
+        private: { myci_user: 'admin' },
+      })
+      const shouldAuthenticateRequest = requestOptions =>
+        authHelper.shouldAuthenticateRequest(requestOptions)
+      describe('a secure request to an authorized origin', function () {
+        test(shouldAuthenticateRequest, () => {
+          given({ url: 'https://myci.test' }).expect(false)
+        })
+      })
+    })
+  })
+
+  describe('withBasicAuth', function () {
+    const authHelper = new AuthHelper(
+      {
+        userKey: 'myci_user',
+        passKey: 'myci_pass',
+        serviceKey: 'myci',
+      },
+      {
+        public: {
+          services: {
+            myci: {
+              authorizedOrigins: ['https://myci.test'],
+            },
+          },
+        },
+        private: { myci_user: 'admin', myci_pass: 'abc123' },
+      }
+    )
+    const withBasicAuth = requestOptions =>
+      authHelper.withBasicAuth(requestOptions)
+
+    describe('authenticates a secure request to an authorized origin', function () {
+      test(withBasicAuth, () => {
+        given({
+          url: 'https://myci.test/api',
+        }).expect({
+          url: 'https://myci.test/api',
+          options: {
+            auth: { user: 'admin', pass: 'abc123' },
+          },
+        })
+        given({
+          url: 'https://myci.test/api',
+          options: {
+            headers: { Accept: 'application/json' },
+          },
+        }).expect({
+          url: 'https://myci.test/api',
+          options: {
+            headers: { Accept: 'application/json' },
+            auth: { user: 'admin', pass: 'abc123' },
+          },
+        })
+      })
+    })
+
+    describe('does not authenticate a request to an unauthorized origin', function () {
+      test(withBasicAuth, () => {
+        given({
+          url: 'https://other.test/api',
+        }).expect({
+          url: 'https://other.test/api',
+        })
+        given({
+          url: 'https://other.test/api',
+          options: {
+            headers: { Accept: 'application/json' },
+          },
+        }).expect({
+          url: 'https://other.test/api',
+          options: {
+            headers: { Accept: 'application/json' },
+          },
+        })
+      })
+    })
+
+    describe('throws on an insecure SSL request', function () {
+      expect(() =>
+        withBasicAuth({
+          url: 'https://myci.test/api',
+          options: { strictSSL: false },
+        })
+      ).to.throw(InvalidParameter)
+    })
+  })
+})

core/base-service/base-graphql.js

@@ -0,0 +1,96 @@
+/**
+ * @module
+ */
+
+'use strict'
+
+const { print } = require('graphql/language/printer')
+const BaseService = require('./base')
+const { InvalidResponse, ShieldsRuntimeError } = require('./errors')
+const { parseJson } = require('./json')
+
+function defaultTransformErrors(errors) {
+  return new InvalidResponse({ prettyMessage: errors[0].message })
+}
+
+/**
+ * Services which query a GraphQL endpoint should extend BaseGraphqlService
+ *
+ * @abstract
+ */
+class BaseGraphqlService extends BaseService {
+  /**
+   * Parse data from JSON endpoint
+   *
+   * @param {string} buffer JSON repsonse from upstream API
+   * @returns {object} Parsed response
+   */
+  _parseJson(buffer) {
+    return parseJson(buffer)
+  }
+
+  /**
+   * Request data from an upstream GraphQL API,
+   * parse it and validate against a schema
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {Joi} attrs.schema Joi schema to validate the response against
+   * @param {string} attrs.url URL to request
+   * @param {object} attrs.query Parsed GraphQL object
+   *    representing the query clause of GraphQL POST body
+   *    e.g. gql`{ query { ... } }`
+   * @param {object} attrs.variables Variables clause of GraphQL POST body
+   * @param {object} [attrs.options={}] Options to pass to request. See
+   *    [documentation](https://github.com/request/request#requestoptions-callback)
+   * @param {object} [attrs.httpErrorMessages={}] Key-value map of HTTP status codes
+   *    and custom error messages e.g: `{ 404: 'package not found' }`.
+   *    This can be used to extend or override the
+   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {Function} [attrs.transformJson=data => data] Function which takes the raw json and transforms it before
+   * further procesing. In case of multiple query in a single graphql call and few of them
+   * throw error, partial data might be used ignoring the error.
+   * @param {Function} [attrs.transformErrors=defaultTransformErrors]
+   *    Function which takes an errors object from a GraphQL
+   *    response and returns an instance of ShieldsRuntimeError.
+   *    The default is to return the first entry of the `errors` array as
+   *    an InvalidResponse.
+   * @returns {object} Parsed response
+   * @see https://github.com/request/request#requestoptions-callback
+   */
+  async _requestGraphql({
+    schema,
+    url,
+    query,
+    variables = {},
+    options = {},
+    httpErrorMessages = {},
+    transformJson = data => data,
+    transformErrors = defaultTransformErrors,
+  }) {
+    const mergedOptions = {
+      ...{ headers: { Accept: 'application/json' } },
+      ...options,
+    }
+    mergedOptions.method = 'POST'
+    mergedOptions.body = JSON.stringify({ query: print(query), variables })
+    const { buffer } = await this._request({
+      url,
+      options: mergedOptions,
+      errorMessages: httpErrorMessages,
+    })
+    const json = transformJson(this._parseJson(buffer))
+    if (json.errors) {
+      const exception = transformErrors(json.errors)
+      if (exception instanceof ShieldsRuntimeError) {
+        throw exception
+      } else {
+        throw Error(
+          `transformErrors() must return a ShieldsRuntimeError; got ${exception}`
+        )
+      }
+    }
+    return this.constructor._validate(json, schema)
+  }
+}
+
+module.exports = BaseGraphqlService

core/base-service/base-graphql.spec.js

@@ -0,0 +1,202 @@
+'use strict'
+
+const Joi = require('joi')
+const { expect } = require('chai')
+const gql = require('graphql-tag')
+const sinon = require('sinon')
+const BaseGraphqlService = require('./base-graphql')
+const { InvalidResponse } = require('./errors')
+
+const dummySchema = Joi.object({
+  requiredString: Joi.string().required(),
+}).required()
+
+class DummyGraphqlService extends BaseGraphqlService {
+  static category = 'cat'
+  static route = { base: 'foo' }
+
+  async handle() {
+    const { requiredString } = await this._requestGraphql({
+      schema: dummySchema,
+      url: 'http://example.com/graphql',
+      query: gql`
+        query {
+          requiredString
+        }
+      `,
+    })
+    return { message: requiredString }
+  }
+}
+
+describe('BaseGraphqlService', function () {
+  describe('Making requests', function () {
+    let sendAndCacheRequest
+    beforeEach(function () {
+      sendAndCacheRequest = sinon.stub().returns(
+        Promise.resolve({
+          buffer: '{"some": "json"}',
+          res: { statusCode: 200 },
+        })
+      )
+    })
+
+    it('invokes _sendAndCacheRequest', async function () {
+      await DummyGraphqlService.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/graphql',
+        {
+          body: '{"query":"{\\n  requiredString\\n}\\n","variables":{}}',
+          headers: { Accept: 'application/json' },
+          method: 'POST',
+        }
+      )
+    })
+
+    it('forwards options to _sendAndCacheRequest', async function () {
+      class WithOptions extends DummyGraphqlService {
+        async handle() {
+          const { value } = await this._requestGraphql({
+            schema: dummySchema,
+            url: 'http://example.com/graphql',
+            query: gql`
+              query {
+                requiredString
+              }
+            `,
+            options: { qs: { queryParam: 123 } },
+          })
+          return { message: value }
+        }
+      }
+
+      await WithOptions.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/graphql',
+        {
+          body: '{"query":"{\\n  requiredString\\n}\\n","variables":{}}',
+          headers: { Accept: 'application/json' },
+          method: 'POST',
+          qs: { queryParam: 123 },
+        }
+      )
+    })
+  })
+
+  describe('Making badges', function () {
+    it('handles valid json responses', async function () {
+      const sendAndCacheRequest = async () => ({
+        buffer: '{"requiredString": "some-string"}',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyGraphqlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: 'some-string',
+      })
+    })
+
+    it('handles json responses which do not match the schema', async function () {
+      const sendAndCacheRequest = async () => ({
+        buffer: '{"unexpectedKey": "some-string"}',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyGraphqlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'invalid response data',
+      })
+    })
+
+    it('handles unparseable json responses', async function () {
+      const sendAndCacheRequest = async () => ({
+        buffer: 'not json',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyGraphqlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'unparseable json response',
+      })
+    })
+  })
+
+  describe('Error handling', function () {
+    it('handles generic error', async function () {
+      const sendAndCacheRequest = async () => ({
+        buffer: '{ "errors": [ { "message": "oh noes!!" } ] }',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyGraphqlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'oh noes!!',
+      })
+    })
+
+    it('handles custom error', async function () {
+      class WithErrorHandler extends DummyGraphqlService {
+        async handle() {
+          const { requiredString } = await this._requestGraphql({
+            schema: dummySchema,
+            url: 'http://example.com/graphql',
+            query: gql`
+              query {
+                requiredString
+              }
+            `,
+            transformErrors: function (errors) {
+              if (errors[0].message === 'oh noes!!') {
+                return new InvalidResponse({
+                  prettyMessage: 'a terrible thing has happened',
+                })
+              }
+            },
+          })
+          return { message: requiredString }
+        }
+      }
+
+      const sendAndCacheRequest = async () => ({
+        buffer: '{ "errors": [ { "message": "oh noes!!" } ] }',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await WithErrorHandler.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'a terrible thing has happened',
+      })
+    })
+  })
+})

core/base-service/base-json.js

@@ -1,30 +1,44 @@
+/**
+ * @module
+ */
+
 'use strict'
 
-// See available emoji at http://emoji.muan.co/
-const emojic = require('emojic')
 const BaseService = require('./base')
-const trace = require('./trace')
-const { InvalidResponse } = require('./errors')
+const { parseJson } = require('./json')
 
+/**
+ * Services which query a JSON endpoint should extend BaseJsonService
+ *
+ * @abstract
+ */
 class BaseJsonService extends BaseService {
+  /**
+   * Parse data from JSON endpoint
+   *
+   * @param {string} buffer JSON repsonse from upstream API
+   * @returns {object} Parsed response
+   */
   _parseJson(buffer) {
-    const logTrace = (...args) => trace.logTrace('fetch', ...args)
-    let json
-    try {
-      json = JSON.parse(buffer)
-    } catch (err) {
-      logTrace(emojic.dart, 'Response JSON (unparseable)', buffer)
-      throw new InvalidResponse({
-        prettyMessage: 'unparseable json response',
-        underlyingError: err,
-      })
-    }
-    logTrace(emojic.dart, 'Response JSON (before validation)', json, {
-      deep: true,
-    })
-    return json
+    return parseJson(buffer)
   }
 
+  /**
+   * Request data from an upstream API serving JSON,
+   * parse it and validate against a schema
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {Joi} attrs.schema Joi schema to validate the response against
+   * @param {string} attrs.url URL to request
+   * @param {object} [attrs.options={}] Options to pass to request. See
+   *    [documentation](https://github.com/request/request#requestoptions-callback)
+   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   *    and custom error messages e.g: `{ 404: 'package not found' }`.
+   *    This can be used to extend or override the
+   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @returns {object} Parsed response
+   * @see https://github.com/request/request#requestoptions-callback
+   */
   async _requestJson({ schema, url, options = {}, errorMessages = {} }) {
     const mergedOptions = {
       ...{ headers: { Accept: 'application/json' } },

core/base-service/base-json.spec.js

@@ -10,15 +10,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyJsonService extends BaseJsonService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestJson({
@@ -29,10 +22,10 @@ class DummyJsonService extends BaseJsonService {
   }
 }
 
-describe('BaseJsonService', function() {
-  describe('Making requests', function() {
+describe('BaseJsonService', function () {
+  describe('Making requests', function () {
     let sendAndCacheRequest
-    beforeEach(function() {
+    beforeEach(function () {
       sendAndCacheRequest = sinon.stub().returns(
         Promise.resolve({
           buffer: '{"some": "json"}',
@@ -41,7 +34,7 @@ describe('BaseJsonService', function() {
       )
     })
 
-    it('invokes _sendAndCacheRequest', async function() {
+    it('invokes _sendAndCacheRequest', async function () {
       await DummyJsonService.invoke(
         { sendAndCacheRequest },
         { handleInternalErrors: false }
@@ -49,11 +42,13 @@ describe('BaseJsonService', function() {
 
       expect(sendAndCacheRequest).to.have.been.calledOnceWith(
         'http://example.com/foo.json',
-        { headers: { Accept: 'application/json' } }
+        {
+          headers: { Accept: 'application/json' },
+        }
       )
     })
 
-    it('forwards options to _sendAndCacheRequest', async function() {
+    it('forwards options to _sendAndCacheRequest', async function () {
       class WithOptions extends DummyJsonService {
         async handle() {
           const { value } = await this._requestJson({
@@ -81,8 +76,8 @@ describe('BaseJsonService', function() {
     })
   })
 
-  describe('Making badges', function() {
-    it('handles valid json responses', async function() {
+  describe('Making badges', function () {
+    it('handles valid json responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: '{"requiredString": "some-string"}',
         res: { statusCode: 200 },
@@ -97,7 +92,7 @@ describe('BaseJsonService', function() {
       })
     })
 
-    it('handles json responses which do not match the schema', async function() {
+    it('handles json responses which do not match the schema', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: '{"unexpectedKey": "some-string"}',
         res: { statusCode: 200 },
@@ -114,7 +109,7 @@ describe('BaseJsonService', function() {
       })
     })
 
-    it('handles unparseable json responses', async function() {
+    it('handles unparseable json responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: 'not json',
         res: { statusCode: 200 },

core/base-service/base-non-memory-caching.js

@@ -1,70 +0,0 @@
-'use strict'
-
-const makeBadge = require('../../gh-badges/lib/make-badge')
-const BaseService = require('./base')
-const { setCacheHeaders } = require('./cache-headers')
-const { makeSend } = require('./legacy-result-sender')
-const coalesceBadge = require('./coalesce-badge')
-const { prepareRoute, namedParamsForMatch } = require('./route')
-
-// Badges are subject to two independent types of caching: in-memory and
-// downstream.
-//
-// Services deriving from `NonMemoryCachingBaseService` are not cached in
-// memory on the server. This means that each request that hits the server
-// triggers another call to the handler. When using badges for server
-// diagnostics, that's useful!
-//
-// In contrast, The `handle()` function of most other `BaseService`
-// subclasses is wrapped in onboard, in-memory caching. See `lib /request-
-// handler.js` and `BaseService.prototype.register()`.
-//
-// All services, including those extending NonMemoryCachingBaseServices, may
-// be cached _downstream_. This is governed by cache headers, which are
-// configured by the service, the user's request, and the server's default
-// cache length.
-module.exports = class NonMemoryCachingBaseService extends BaseService {
-  static register({ camp, requestCounter }, serviceConfig) {
-    const { cacheHeaders: cacheHeaderConfig } = serviceConfig
-    const { _cacheLength: serviceDefaultCacheLengthSeconds } = this
-    const { regex, captureNames } = prepareRoute(this.route)
-
-    const serviceRequestCounter = this._createServiceRequestCounter({
-      requestCounter,
-    })
-
-    camp.route(regex, async (queryParams, match, end, ask) => {
-      const namedParams = namedParamsForMatch(captureNames, match, this)
-      const serviceData = await this.invoke(
-        {},
-        serviceConfig,
-        namedParams,
-        queryParams
-      )
-
-      const badgeData = coalesceBadge(
-        queryParams,
-        serviceData,
-        this.defaultBadgeData,
-        this
-      )
-
-      // The final capture group is the extension.
-      const format = match.slice(-1)[0]
-      badgeData.format = format
-
-      const svg = makeBadge(badgeData)
-
-      setCacheHeaders({
-        cacheHeaderConfig,
-        serviceDefaultCacheLengthSeconds,
-        queryParams,
-        res: ask.res,
-      })
-
-      makeSend(format, ask.res, end)(svg)
-
-      serviceRequestCounter.inc()
-    })
-  }
-}

core/base-service/base-static.js

@@ -1,24 +1,23 @@
 'use strict'
 
-const makeBadge = require('../../gh-badges/lib/make-badge')
+const makeBadge = require('../../badge-maker/lib/make-badge')
 const BaseService = require('./base')
 const {
   serverHasBeenUpSinceResourceCached,
   setCacheHeadersForStaticResource,
 } = require('./cache-headers')
 const { makeSend } = require('./legacy-result-sender')
+const { MetricHelper } = require('./metric-helper')
 const coalesceBadge = require('./coalesce-badge')
 const { prepareRoute, namedParamsForMatch } = require('./route')
 
 module.exports = class BaseStaticService extends BaseService {
-  static register({ camp, requestCounter }, serviceConfig) {
-    const {
-      profiling: { makeBadge: shouldProfileMakeBadge },
-    } = serviceConfig
+  static register({ camp, metricInstance }, serviceConfig) {
     const { regex, captureNames } = prepareRoute(this.route)
 
-    const serviceRequestCounter = this._createServiceRequestCounter({
-      requestCounter,
+    const metricHelper = MetricHelper.create({
+      metricInstance,
+      ServiceClass: this,
     })
 
     camp.route(regex, async (queryParams, match, end, ask) => {
@@ -29,6 +28,8 @@ module.exports = class BaseStaticService extends BaseService {
         return
       }
 
+      const metricHandle = metricHelper.startRequest()
+
       const namedParams = namedParamsForMatch(captureNames, match, this)
       const serviceData = await this.invoke(
         {},
@@ -45,22 +46,15 @@ module.exports = class BaseStaticService extends BaseService {
       )
 
       // The final capture group is the extension.
-      const format = match.slice(-1)[0]
+      const format = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
       badgeData.format = format
 
-      if (shouldProfileMakeBadge) {
-        console.time('makeBadge total')
-      }
-      const svg = makeBadge(badgeData)
-      if (shouldProfileMakeBadge) {
-        console.timeEnd('makeBadge total')
-      }
-
       setCacheHeadersForStaticResource(ask.res)
 
+      const svg = makeBadge(badgeData)
       makeSend(format, ask.res, end)(svg)
 
-      serviceRequestCounter.inc()
+      metricHandle.noteResponseSent()
     })
   }
 }

core/base-service/base-svg-scraping.js

@@ -1,3 +1,7 @@
+/**
+ * @module
+ */
+
 'use strict'
 
 // See available emoji at http://emoji.muan.co/
@@ -9,7 +13,21 @@ const { InvalidResponse } = require('./errors')
 const defaultValueMatcher = />([^<>]+)<\/text><\/g>/
 const leadingWhitespace = /(?:\r\n\s*|\r\s*|\n\s*)/g
 
+/**
+ * Services which scrape data from another SVG badge
+ * should extend BaseSvgScrapingService
+ *
+ * @abstract
+ */
 class BaseSvgScrapingService extends BaseService {
+  /**
+   * Extract a value from SVG
+   *
+   * @param {string} svg SVG to parse
+   * @param {RegExp} [valueMatcher=defaultValueMatcher]
+   *    RegExp to match the value we want to parse from the SVG
+   * @returns {string} Matched value
+   */
   static valueFromSvgBadge(svg, valueMatcher = defaultValueMatcher) {
     if (typeof svg !== 'string') {
       throw new TypeError('Parameter should be a string')
@@ -26,6 +44,24 @@ class BaseSvgScrapingService extends BaseService {
     }
   }
 
+  /**
+   * Request data from an endpoint serving SVG,
+   * parse a value from it and validate against a schema
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {Joi} attrs.schema Joi schema to validate the response against
+   * @param {RegExp} attrs.valueMatcher
+   *    RegExp to match the value we want to parse from the SVG
+   * @param {string} attrs.url URL to request
+   * @param {object} [attrs.options={}] Options to pass to request. See
+   *    [documentation](https://github.com/request/request#requestoptions-callback)
+   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   *    and custom error messages e.g: `{ 404: 'package not found' }`.
+   *    This can be used to extend or override the
+   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @returns {object} Parsed response
+   * @see https://github.com/request/request#requestoptions-callback
+   */
   async _requestSvg({
     schema,
     valueMatcher,

core/base-service/base-svg-scraping.spec.js

@@ -3,27 +3,16 @@
 const { expect } = require('chai')
 const sinon = require('sinon')
 const Joi = require('joi')
-const makeBadge = require('../../gh-badges/lib/make-badge')
+const makeBadge = require('../../badge-maker/lib/make-badge')
 const BaseSvgScrapingService = require('./base-svg-scraping')
 
-function makeExampleSvg({ label, message }) {
-  return makeBadge({ text: ['this is the label', 'this is the result!'] })
-}
-
 const schema = Joi.object({
   message: Joi.string().required(),
 }).required()
 
 class DummySvgScrapingService extends BaseSvgScrapingService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     return this._requestSvg({
@@ -33,25 +22,22 @@ class DummySvgScrapingService extends BaseSvgScrapingService {
   }
 }
 
-describe('BaseSvgScrapingService', function() {
+describe('BaseSvgScrapingService', function () {
   const exampleLabel = 'this is the label'
   const exampleMessage = 'this is the result!'
-  const exampleSvg = makeExampleSvg({
-    label: exampleLabel,
-    message: exampleMessage,
-  })
+  const exampleSvg = makeBadge({ label: exampleLabel, message: exampleMessage })
 
-  describe('valueFromSvgBadge', function() {
-    it('should find the correct value', function() {
+  describe('valueFromSvgBadge', function () {
+    it('should find the correct value', function () {
       expect(BaseSvgScrapingService.valueFromSvgBadge(exampleSvg)).to.equal(
         exampleMessage
       )
     })
   })
 
-  describe('Making requests', function() {
+  describe('Making requests', function () {
     let sendAndCacheRequest
-    beforeEach(function() {
+    beforeEach(function () {
       sendAndCacheRequest = sinon.stub().returns(
         Promise.resolve({
           buffer: exampleSvg,
@@ -60,7 +46,7 @@ describe('BaseSvgScrapingService', function() {
       )
     })
 
-    it('invokes _sendAndCacheRequest with the expected header', async function() {
+    it('invokes _sendAndCacheRequest with the expected header', async function () {
       await DummySvgScrapingService.invoke(
         { sendAndCacheRequest },
         { handleInternalErrors: false }
@@ -68,11 +54,13 @@ describe('BaseSvgScrapingService', function() {
 
       expect(sendAndCacheRequest).to.have.been.calledOnceWith(
         'http://example.com/foo.svg',
-        { headers: { Accept: 'image/svg+xml' } }
+        {
+          headers: { Accept: 'image/svg+xml' },
+        }
       )
     })
 
-    it('forwards options to _sendAndCacheRequest', async function() {
+    it('forwards options to _sendAndCacheRequest', async function () {
       class WithCustomOptions extends DummySvgScrapingService {
         async handle() {
           const { message } = await this._requestSvg({
@@ -103,8 +91,8 @@ describe('BaseSvgScrapingService', function() {
     })
   })
 
-  describe('Making badges', function() {
-    it('handles valid svg responses', async function() {
+  describe('Making badges', function () {
+    it('handles valid svg responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: exampleSvg,
         res: { statusCode: 200 },
@@ -119,11 +107,9 @@ describe('BaseSvgScrapingService', function() {
       })
     })
 
-    it('allows overriding the valueMatcher', async function() {
+    it('allows overriding the valueMatcher', async function () {
       class WithValueMatcher extends BaseSvgScrapingService {
-        static get route() {
-          return {}
-        }
+        static route = {}
 
         async handle() {
           return this._requestSvg({
@@ -147,7 +133,7 @@ describe('BaseSvgScrapingService', function() {
       })
     })
 
-    it('handles unparseable svg responses', async function() {
+    it('handles unparseable svg responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: 'not svg yo',
         res: { statusCode: 200 },

core/base-service/base-xml.js

@@ -1,3 +1,7 @@
+/**
+ * @module
+ */
+
 'use strict'
 
 // See available emoji at http://emoji.muan.co/
@@ -7,7 +11,31 @@ const BaseService = require('./base')
 const trace = require('./trace')
 const { InvalidResponse } = require('./errors')
 
+/**
+ * Services which query a XML endpoint should extend BaseXmlService
+ *
+ * @abstract
+ */
 class BaseXmlService extends BaseService {
+  /**
+   * Request data from an upstream API serving XML,
+   * parse it and validate against a schema
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {Joi} attrs.schema Joi schema to validate the response against
+   * @param {string} attrs.url URL to request
+   * @param {object} [attrs.options={}] Options to pass to request. See
+   *    [documentation](https://github.com/request/request#requestoptions-callback)
+   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   *    and custom error messages e.g: `{ 404: 'package not found' }`.
+   *    This can be used to extend or override the
+   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.parserOptions={}] Options to pass to fast-xml-parser. See
+   *    [documentation](https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json)
+   * @returns {object} Parsed response
+   * @see https://github.com/request/request#requestoptions-callback
+   * @see https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json
+   */
   async _requestXml({
     schema,
     url,

core/base-service/base-xml.spec.js

@@ -10,15 +10,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyXmlService extends BaseXmlService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestXml({
@@ -29,10 +22,10 @@ class DummyXmlService extends BaseXmlService {
   }
 }
 
-describe('BaseXmlService', function() {
-  describe('Making requests', function() {
+describe('BaseXmlService', function () {
+  describe('Making requests', function () {
     let sendAndCacheRequest
-    beforeEach(function() {
+    beforeEach(function () {
       sendAndCacheRequest = sinon.stub().returns(
         Promise.resolve({
           buffer: '<requiredString>some-string</requiredString>',
@@ -41,7 +34,7 @@ describe('BaseXmlService', function() {
       )
     })
 
-    it('invokes _sendAndCacheRequest', async function() {
+    it('invokes _sendAndCacheRequest', async function () {
       await DummyXmlService.invoke(
         { sendAndCacheRequest },
         { handleInternalErrors: false }
@@ -49,15 +42,15 @@ describe('BaseXmlService', function() {
 
       expect(sendAndCacheRequest).to.have.been.calledOnceWith(
         'http://example.com/foo.xml',
-        { headers: { Accept: 'application/xml, text/xml' } }
+        {
+          headers: { Accept: 'application/xml, text/xml' },
+        }
       )
     })
 
-    it('forwards options to _sendAndCacheRequest', async function() {
+    it('forwards options to _sendAndCacheRequest', async function () {
       class WithCustomOptions extends BaseXmlService {
-        static get route() {
-          return {}
-        }
+        static route = {}
 
         async handle() {
           const { requiredString } = await this._requestXml({
@@ -85,8 +78,8 @@ describe('BaseXmlService', function() {
     })
   })
 
-  describe('Making badges', function() {
-    it('handles valid xml responses', async function() {
+  describe('Making badges', function () {
+    it('handles valid xml responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: '<requiredString>some-string</requiredString>',
         res: { statusCode: 200 },
@@ -101,7 +94,7 @@ describe('BaseXmlService', function() {
       })
     })
 
-    it('parses XML response with custom parser options', async function() {
+    it('parses XML response with custom parser options', async function () {
       const customParserOption = { trimValues: false }
       class DummyXmlServiceWithParserOption extends DummyXmlService {
         async handle() {
@@ -128,7 +121,7 @@ describe('BaseXmlService', function() {
       })
     })
 
-    it('handles xml responses which do not match the schema', async function() {
+    it('handles xml responses which do not match the schema', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: '<unexpectedAttribute>some-string</unexpectedAttribute>',
         res: { statusCode: 200 },
@@ -145,7 +138,7 @@ describe('BaseXmlService', function() {
       })
     })
 
-    it('handles unparseable xml responses', async function() {
+    it('handles unparseable xml responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: 'not xml',
         res: { statusCode: 200 },

core/base-service/base-yaml.js

@@ -1,3 +1,7 @@
+/**
+ * @module
+ */
+
 'use strict'
 
 const emojic = require('emojic')
@@ -6,7 +10,29 @@ const BaseService = require('./base')
 const { InvalidResponse } = require('./errors')
 const trace = require('./trace')
 
+/**
+ * Services which query a YAML endpoint should extend BaseYamlService
+ *
+ * @abstract
+ */
 class BaseYamlService extends BaseService {
+  /**
+   * Request data from an upstream API serving YAML,
+   * parse it and validate against a schema
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {Joi} attrs.schema Joi schema to validate the response against
+   * @param {string} attrs.url URL to request
+   * @param {object} [attrs.options={}] Options to pass to request. See
+   *    [documentation](https://github.com/request/request#requestoptions-callback)
+   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   *    and custom error messages e.g: `{ 404: 'package not found' }`.
+   *    This can be used to extend or override the
+   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.encoding='utf8'] Character encoding
+   * @returns {object} Parsed response
+   * @see https://github.com/request/request#requestoptions-callback
+   */
   async _requestYaml({
     schema,
     url,
@@ -31,7 +57,7 @@ class BaseYamlService extends BaseService {
     })
     let parsed
     try {
-      parsed = yaml.safeLoad(buffer.toString(), encoding)
+      parsed = yaml.load(buffer.toString(), encoding)
     } catch (err) {
       logTrace(emojic.dart, 'Response YAML (unparseable)', buffer)
       throw new InvalidResponse({

core/base-service/base-yaml.spec.js

@@ -10,15 +10,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyYamlService extends BaseYamlService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestYaml({
@@ -45,10 +38,10 @@ foo: bar
 foo: baz
 `
 
-describe('BaseYamlService', function() {
-  describe('Making requests', function() {
+describe('BaseYamlService', function () {
+  describe('Making requests', function () {
     let sendAndCacheRequest
-    beforeEach(function() {
+    beforeEach(function () {
       sendAndCacheRequest = sinon.stub().returns(
         Promise.resolve({
           buffer: expectedYaml,
@@ -57,7 +50,7 @@ describe('BaseYamlService', function() {
       )
     })
 
-    it('invokes _sendAndCacheRequest', async function() {
+    it('invokes _sendAndCacheRequest', async function () {
       await DummyYamlService.invoke(
         { sendAndCacheRequest },
         { handleInternalErrors: false }
@@ -74,7 +67,7 @@ describe('BaseYamlService', function() {
       )
     })
 
-    it('forwards options to _sendAndCacheRequest', async function() {
+    it('forwards options to _sendAndCacheRequest', async function () {
       class WithOptions extends DummyYamlService {
         async handle() {
           const { requiredString } = await this._requestYaml({
@@ -105,8 +98,8 @@ describe('BaseYamlService', function() {
     })
   })
 
-  describe('Making badges', function() {
-    it('handles valid yaml responses', async function() {
+  describe('Making badges', function () {
+    it('handles valid yaml responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: expectedYaml,
         res: { statusCode: 200 },
@@ -121,7 +114,7 @@ describe('BaseYamlService', function() {
       })
     })
 
-    it('handles yaml responses which do not match the schema', async function() {
+    it('handles yaml responses which do not match the schema', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: unexpectedYaml,
         res: { statusCode: 200 },
@@ -138,7 +131,7 @@ describe('BaseYamlService', function() {
       })
     })
 
-    it('handles unparseable yaml responses', async function() {
+    it('handles unparseable yaml responses', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: invalidYaml,
         res: { statusCode: 200 },

core/base-service/base.js

@@ -1,9 +1,14 @@
 'use strict'
+/**
+ * @module
+ */
 
-const decamelize = require('decamelize')
 // See available emoji at http://emoji.muan.co/
 const emojic = require('emojic')
 const Joi = require('joi')
+const log = require('../server/log')
+const { AuthHelper } = require('./auth-helper')
+const { MetricHelper, MetricNames } = require('./metric-helper')
 const { assertValidCategory } = require('./categories')
 const checkErrorResponse = require('./check-error-response')
 const coalesceBadge = require('./coalesce-badge')
@@ -11,6 +16,7 @@ const {
   NotFound,
   InvalidResponse,
   Inaccessible,
+  ImproperlyConfigured,
   InvalidParameter,
   Deprecated,
 } = require('./errors')
@@ -33,14 +39,17 @@ const defaultBadgeDataSchema = Joi.object({
   namedLogo: Joi.string(),
 }).required()
 
-const optionalStringWhenNamedLogoPrsent = Joi.alternatives().when('namedLogo', {
-  is: Joi.string().required(),
-  then: Joi.string(),
-})
+const optionalStringWhenNamedLogoPresent = Joi.alternatives().conditional(
+  'namedLogo',
+  {
+    is: Joi.string().required(),
+    then: Joi.string(),
+  }
+)
 
 const optionalNumberWhenAnyLogoPresent = Joi.alternatives()
-  .when('namedLogo', { is: Joi.string().required(), then: Joi.number() })
-  .when('logoSvg', { is: Joi.string().required(), then: Joi.number() })
+  .conditional('namedLogo', { is: Joi.string().required(), then: Joi.number() })
+  .conditional('logoSvg', { is: Joi.string().required(), then: Joi.number() })
 
 const serviceDataSchema = Joi.object({
   isError: Joi.boolean(),
@@ -49,72 +58,71 @@ const serviceDataSchema = Joi.object({
   // `render()` to always return a string.
   message: Joi.alternatives(Joi.string().allow(''), Joi.number()).required(),
   color: Joi.string(),
-  link: Joi.array()
-    .items(Joi.string().uri())
-    .single()
-    .max(2),
+  link: Joi.array().items(Joi.string().uri()).single().max(2),
   // Generally services should not use these options, which are provided to
   // support the Endpoint badge.
   labelColor: Joi.string(),
   namedLogo: Joi.string(),
   logoSvg: Joi.string(),
-  logoColor: optionalStringWhenNamedLogoPrsent,
+  logoColor: optionalStringWhenNamedLogoPresent,
   logoWidth: optionalNumberWhenAnyLogoPresent,
   logoPosition: optionalNumberWhenAnyLogoPresent,
-  cacheSeconds: Joi.number()
-    .integer()
-    .min(0),
+  cacheSeconds: Joi.number().integer().min(0),
   style: Joi.string(),
 })
   .oxor('namedLogo', 'logoSvg')
   .required()
 
-module.exports = class BaseService {
+/**
+ * Abstract base class which all service classes inherit from.
+ * Concrete implementations of BaseService must implement the methods
+ * category(), route() and handle(namedParams, queryParams)
+ */
+class BaseService {
   /**
    * Name of the category to sort this badge into (eg. "build"). Used to sort
    * the badges on the main shields.io website.
+   *
+   * @abstract
+   * @type {string}
    */
   static get category() {
     throw new Error(`Category not set for ${this.name}`)
   }
 
-  static get isDeprecated() {
-    return false
-  }
+  static isDeprecated = false
 
   /**
-   * Returns an object:
-   *  - base: (Optional) The base path of the routes for this service. This is
-   *    used as a prefix.
-   *  - format: Regular expression to use for routes for this service's badges
-   *  - capture: Array of names for the capture groups in the regular
-   *             expression. The handler will be passed an object containing
-   *             the matches.
-   *  - queryParamSchema: (Optional) A Joi schema (`Joi.object({ ... }).required()`)
-   *                      for the query param object. If you know a parameter
-   *                      will never receive a numeric string, you can use
-   *                      `Joi.string()`. Because of quirks in Scoutcamp and Joi,
-   *                      alphanumeric strings should be declared using
-   *                      `Joi.alternatives().try(Joi.string(), Joi.number())`,
-   *                      otherwise a value like `?success_color=999` will fail.
-   *                      A parameter requiring a numeric string can use
-   *                      `Joi.number()`. A parameter that receives only non-numeric
-   *                      strings can use `Joi.string()`. A parameter that never
-   *                      receives numeric can use `Joi.string()`. A boolean
-   *                      parameter should use `Joi.equal('')` and will receive an
-   *                      empty string on e.g. `?compact_message` and undefined
-   *                      when the parameter is absent. (Note that in,
-   *                      `examples.queryParams` boolean query params should be given
-   *                      `null` values.)
+   * Route to mount this service on
+   *
+   * @abstract
+   * @type {module:core/base-service/base~Route}
    */
   static get route() {
     throw new Error(`Route not defined for ${this.name}`)
   }
 
   /**
-   * Example URLs for this service. These should use the format
-   * specified in `route`, and can be used to demonstrate how to use badges for
-   * this service.
+   * Configuration for the authentication helper that prepares credentials
+   * for upstream requests.
+   *
+   * See also the config schema in `./server.js` and `doc/server-secrets.md`.
+   *
+   * To use the configured auth in the handler or fetch method, pass the
+   * credentials to the request. For example:
+   * - `{ options: { auth: this.authHelper.basicAuth } }`
+   * - `{ options: { headers: this.authHelper.bearerAuthHeader } }`
+   * - `{ options: { qs: { token: this.authHelper._pass } } }`
+   *
+   * @abstract
+   * @type {module:core/base-service/base~Auth}
+   */
+  static auth = undefined
+
+  /**
+   * Array of Example objects describing example URLs for this service.
+   * These should use the format specified in `route`,
+   * and can be used to demonstrate how to use badges for this service.
    *
    * The preferred way to specify an example is with `namedParams` which are
    * substituted into the service's compiled route pattern. The rendered badge
@@ -123,25 +131,11 @@ module.exports = class BaseService {
    * For services which use a route `format`, the `pattern` can be specified as
    * part of the example.
    *
-   * title: Descriptive text that will be shown next to the badge. The default
-   *   is to use the service class name, which probably is not what you want.
-   * namedParams: An object containing the values of named parameters to
-   *   substitute into the compiled route pattern.
-   * queryParams: An object containing query parameters to include in the
-   *   example URLs. For alphanumeric query parameters, specify a string value.
-   *   For boolean query parameters, specify `null`.
-   * pattern: The route pattern to compile. Defaults to `this.route.pattern`.
-   * staticPreview: A rendered badge of the sort returned by `handle()` or
-   *   `render()`: an object containing `message` and optional `label` and
-   *   `color`. This is usually generated by invoking `this.render()` with some
-   *   explicit props.
-   * keywords: Additional keywords, other than words in the title. This helps
-   *   users locate relevant badges.
-   * documentation: An HTML string that is included in the badge popup.
+   * @see {@link module:core/base-service/base~Example}
+   * @abstract
+   * @type {module:core/base-service/base~Example[]}
    */
-  static get examples() {
-    return []
-  }
+  static examples = []
 
   static get _cacheLength() {
     const cacheLengths = {
@@ -154,13 +148,13 @@ module.exports = class BaseService {
   }
 
   /**
-   * Default data for the badge. Can include label, logo, and color. These
-   * defaults are used if the value is neither included in the service data
+   * Default data for the badge.
+   * These defaults are used if the value is neither included in the service data
    * from the handler nor overridden by the user via query parameters.
+   *
+   * @type {module:core/base-service/base~DefaultBadgeData}
    */
-  static get defaultBadgeData() {
-    return {}
-  }
+  static defaultBadgeData = {}
 
   static render(props) {
     throw new Error(`render() function not implemented for ${this.name}`)
@@ -207,19 +201,52 @@ module.exports = class BaseService {
     return result
   }
 
-  constructor({ sendAndCacheRequest }, { handleInternalErrors }) {
+  constructor(
+    { sendAndCacheRequest, authHelper, metricHelper },
+    { handleInternalErrors }
+  ) {
     this._requestFetcher = sendAndCacheRequest
+    this.authHelper = authHelper
     this._handleInternalErrors = handleInternalErrors
+    this._metricHelper = metricHelper
   }
 
   async _request({ url, options = {}, errorMessages = {} }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
-    logTrace(emojic.bowAndArrow, 'Request', url, '\n', options)
+    let logUrl = url
+    const logOptions = Object.assign({}, options)
+    if ('qs' in options) {
+      const params = new URLSearchParams(options.qs)
+      logUrl = `${url}?${params.toString()}`
+      delete logOptions.qs
+    }
+    logTrace(
+      emojic.bowAndArrow,
+      'Request',
+      `${logUrl}\n${JSON.stringify(logOptions, null, 2)}`
+    )
     const { res, buffer } = await this._requestFetcher(url, options)
+    await this._meterResponse(res, buffer)
     logTrace(emojic.dart, 'Response status code', res.statusCode)
     return checkErrorResponse(errorMessages)({ buffer, res })
   }
 
+  static enabledMetrics = []
+
+  static isMetricEnabled(metricName) {
+    return this.enabledMetrics.includes(metricName)
+  }
+
+  async _meterResponse(res, buffer) {
+    if (
+      this._metricHelper &&
+      this.constructor.isMetricEnabled(MetricNames.SERVICE_RESPONSE_SIZE) &&
+      res.statusCode === 200
+    ) {
+      this._metricHelper.noteServiceResponseSize(buffer.length)
+    }
+  }
+
   static _validate(
     data,
     schema,
@@ -247,11 +274,24 @@ module.exports = class BaseService {
    * Asynchronous function to handle requests for this service. Take the route
    * parameters (as defined in the `route` property), perform a request using
    * `this._sendAndCacheRequest`, and return the badge data.
+   *
+   * @abstract
+   * @param {object} namedParams Params parsed from route pattern
+   *    defined in this.route.pattern or this.route.capture
+   * @param {object} queryParams Params parsed from the query string
+   * @returns {module:core/base-service/base~Badge}
+   *    badge Object validated against serviceDataSchema
    */
   async handle(namedParams, queryParams) {
     throw new Error(`Handler not implemented for ${this.constructor.name}`)
   }
 
+  // Making this an instance method ensures debuggability.
+  // https://github.com/badges/shields/issues/3784
+  _validateServiceData(serviceData) {
+    Joi.assert(serviceData, serviceDataSchema)
+  }
+
   _handleError(error) {
     if (error instanceof NotFound || error instanceof InvalidParameter) {
       trace.logTrace('outbound', emojic.noGoodWoman, 'Handled error', error)
@@ -261,6 +301,7 @@ module.exports = class BaseService {
         color: 'red',
       }
     } else if (
+      error instanceof ImproperlyConfigured ||
       error instanceof InvalidResponse ||
       error instanceof Inaccessible ||
       error instanceof Deprecated
@@ -281,8 +322,8 @@ module.exports = class BaseService {
         )
       ) {
         // This is where we end up if an unhandled exception is thrown in
-        // production. Send the error to the logs.
-        console.log(error)
+        // production. Send the error to Sentry and the logs.
+        log.error(error)
       }
       return {
         isError: true,
@@ -311,12 +352,24 @@ module.exports = class BaseService {
     trace.logTrace('inbound', emojic.ticket, 'Named params', namedParams)
     trace.logTrace('inbound', emojic.crayon, 'Query params', queryParams)
 
-    const serviceInstance = new this(context, config)
+    // Like the service instance, the auth helper could be reused for each request.
+    // However, moving its instantiation to `register()` makes `invoke()` harder
+    // to test.
+    const authHelper = this.auth ? new AuthHelper(this.auth, config) : undefined
+
+    const serviceInstance = new this({ ...context, authHelper }, config)
 
     let serviceError
+    if (authHelper && !authHelper.isValid) {
+      const prettyMessage = authHelper.isRequired
+        ? 'credentials have not been configured'
+        : 'credentials are misconfigured'
+      serviceError = new ImproperlyConfigured({ prettyMessage })
+    }
+
     const { queryParamSchema } = this.route
     let transformedQueryParams
-    if (queryParamSchema) {
+    if (!serviceError && queryParamSchema) {
       try {
         transformedQueryParams = validate(
           {
@@ -349,7 +402,7 @@ module.exports = class BaseService {
           namedParams,
           transformedQueryParams
         )
-        Joi.assert(serviceData, serviceDataSchema)
+        serviceInstance._validateServiceData(serviceData)
       } catch (error) {
         serviceError = error
       }
@@ -364,27 +417,17 @@ module.exports = class BaseService {
     return serviceData
   }
 
-  static _createServiceRequestCounter({ requestCounter }) {
-    if (requestCounter) {
-      const { category, serviceFamily, name } = this
-      const service = decamelize(name)
-      return requestCounter.labels(category, serviceFamily, service)
-    } else {
-      // When metrics are disabled, return a mock counter.
-      return { inc: () => {} }
-    }
-  }
-
   static register(
-    { camp, handleRequest, githubApiProvider, requestCounter },
+    { camp, handleRequest, githubApiProvider, metricInstance },
     serviceConfig
   ) {
     const { cacheHeaders: cacheHeaderConfig, fetchLimitBytes } = serviceConfig
     const { regex, captureNames } = prepareRoute(this.route)
     const queryParams = getQueryParamNames(this.route)
 
-    const serviceRequestCounter = this._createServiceRequestCounter({
-      requestCounter,
+    const metricHelper = MetricHelper.create({
+      metricInstance,
+      ServiceClass: this,
     })
 
     camp.route(
@@ -392,12 +435,15 @@ module.exports = class BaseService {
       handleRequest(cacheHeaderConfig, {
         queryParams,
         handler: async (queryParams, match, sendBadge, request) => {
+          const metricHandle = metricHelper.startRequest()
+
           const namedParams = namedParamsForMatch(captureNames, match, this)
           const serviceData = await this.invoke(
             {
               sendAndCacheRequest: request.asPromise,
               sendAndCacheRequestWithCallbacks: request,
               githubApiProvider,
+              metricHelper,
             },
             serviceConfig,
             namedParams,
@@ -411,10 +457,10 @@ module.exports = class BaseService {
             this
           )
           // The final capture group is the extension.
-          const format = match.slice(-1)[0]
+          const format = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
           sendBadge(format, badgeData)
 
-          serviceRequestCounter.inc()
+          metricHandle.noteResponseSent()
         },
         cacheLength: this._cacheLength,
         fetchLimitBytes,
@@ -422,3 +468,99 @@ module.exports = class BaseService {
     )
   }
 }
+
+/**
+ * Default badge properties, validated against defaultBadgeDataSchema
+ *
+ * @typedef {object} DefaultBadgeData
+ * @property {string} label (Optional)
+ * @property {string} color (Optional)
+ * @property {string} labelColor (Optional)
+ * @property {string} namedLogo (Optional)
+ */
+
+/**
+ * Badge Object, validated against serviceDataSchema
+ *
+ * @typedef {object} Badge
+ * @property {boolean} isError (Optional)
+ * @property {string} label (Optional)
+ * @property {(string|number)} message
+ * @property {string} color (Optional)
+ * @property {string[]} link (Optional)
+ */
+
+/**
+ * @typedef {object} Route
+ * @property {string} base
+ *    (Optional) The base path of the routes for this service.
+ *    This is used as a prefix.
+ * @property {string} pattern
+ *    A path-to-regexp pattern defining the route pattern and param names
+ *    See {@link https://www.npmjs.com/package/path-to-regexp}
+ * @property {RegExp} format
+ *    Deprecated: Regular expression to use for routes for this service's badges
+ *    Use `pattern` instead
+ * @property {string[]} capture
+ *    Deprecated: Array of names for the capture groups in the regular
+ *    expression. The handler will be passed an object containing
+ *    the matches.
+ *    Use `pattern` instead
+ * @property {Joi.object} queryParamSchema
+ *    (Optional) A Joi schema (`Joi.object({ ... }).required()`)
+ *    for the query param object. If you know a parameter
+ *    will never receive a numeric string, you can use
+ *    `Joi.string()`. Because of quirks in Scoutcamp and Joi,
+ *    alphanumeric strings should be declared using
+ *    `Joi.alternatives().try(Joi.string(), Joi.number())`,
+ *    otherwise a value like `?success_color=999` will fail.
+ *    A parameter requiring a numeric string can use
+ *    `Joi.number()`. A parameter that receives only non-numeric
+ *    strings can use `Joi.string()`. A parameter that never
+ *    receives numeric can use `Joi.string()`. A boolean
+ *    parameter should use `Joi.equal('')` and will receive an
+ *    empty string on e.g. `?compact_message` and undefined
+ *    when the parameter is absent. (Note that in,
+ *    `examples.queryParams` boolean query params should be given
+ *    `null` values.)
+ */
+
+/**
+ * @typedef {object} Auth
+ * @property {string} userKey
+ *    (Optional) The key from `privateConfig` to use as the username.
+ * @property {string} passKey
+ *    (Optional) The key from `privateConfig` to use as the password.
+ *    If auth is configured, either `userKey` or `passKey` is required.
+ * @property {string} isRequired
+ *    (Optional) If `true`, the service will return `NotFound` unless the
+ *    configured credentials are present.
+ */
+
+/**
+ * @typedef {object} Example
+ * @property {string} title
+ *    Descriptive text that will be shown next to the badge. The default
+ *    is to use the service class name, which probably is not what you want.
+ * @property {object} namedParams
+ *    An object containing the values of named parameters to
+ *    substitute into the compiled route pattern.
+ * @property {object} queryParams
+ *    An object containing query parameters to include in the
+ *    example URLs. For alphanumeric query parameters, specify a string value.
+ *    For boolean query parameters, specify `null`.
+ * @property {string} pattern
+ *    The route pattern to compile. Defaults to `this.route.pattern`.
+ * @property {object} staticPreview
+ *    A rendered badge of the sort returned by `handle()` or
+ *    `render()`: an object containing `message` and optional `label` and
+ *    `color`. This is usually generated by invoking `this.render()` with some
+ *    explicit props.
+ * @property {string[]} keywords
+ *    Additional keywords, other than words in the title. This helps
+ *    users locate relevant badges.
+ * @property {string} documentation
+ *    An HTML string that is included in the badge popup.
+ */
+
+module.exports = BaseService

core/base-service/base.spec.js

@@ -1,8 +1,11 @@
 'use strict'
 
 const Joi = require('joi')
-const { expect } = require('chai')
+const chai = require('chai')
+const { expect } = chai
 const sinon = require('sinon')
+const prometheus = require('prom-client')
+const PrometheusMetrics = require('../server/prometheus-metrics')
 const trace = require('./trace')
 const {
   NotFound,
@@ -12,8 +15,9 @@ const {
   Deprecated,
 } = require('./errors')
 const BaseService = require('./base')
-
+const { MetricHelper, MetricNames } = require('./metric-helper')
 require('../register-chai-plugins.spec')
+chai.use(require('chai-as-promised'))
 
 const queryParamSchema = Joi.object({
   queryParamA: Joi.string(),
@@ -25,32 +29,19 @@ const queryParamSchema = Joi.object({
   .required()
 
 class DummyService extends BaseService {
-  static get category() {
-    return 'other'
-  }
+  static category = 'other'
+  static route = { base: 'foo', pattern: ':namedParamA', queryParamSchema }
 
-  static get route() {
-    return {
-      base: 'foo',
-      pattern: ':namedParamA',
-      queryParamSchema,
-    }
-  }
+  static examples = [
+    {
+      pattern: ':world',
+      namedParams: { world: 'World' },
+      staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
+      keywords: ['hello'],
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        pattern: ':world',
-        namedParams: { world: 'World' },
-        staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
-        keywords: ['hello'],
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'cat', namedLogo: 'appveyor' }
-  }
+  static defaultBadgeData = { label: 'cat', namedLogo: 'appveyor' }
 
   static render({ namedParamA, queryParamA }) {
     return {
@@ -63,10 +54,20 @@ class DummyService extends BaseService {
   }
 }
 
-describe('BaseService', function() {
-  const defaultConfig = { handleInternalErrors: false }
+class DummyServiceWithServiceResponseSizeMetricEnabled extends DummyService {
+  static enabledMetrics = [MetricNames.SERVICE_RESPONSE_SIZE]
+}
 
-  it('Invokes the handler as expected', async function() {
+describe('BaseService', function () {
+  const defaultConfig = {
+    public: {
+      handleInternalErrors: false,
+      services: {},
+    },
+    private: {},
+  }
+
+  it('Invokes the handler as expected', async function () {
     expect(
       await DummyService.invoke(
         {},
@@ -79,7 +80,7 @@ describe('BaseService', function() {
     })
   })
 
-  it('Validates query params', async function() {
+  it('Validates query params', async function () {
     expect(
       await DummyService.invoke(
         {},
@@ -94,55 +95,47 @@ describe('BaseService', function() {
     })
   })
 
-  describe('Required overrides', function() {
-    it('Should throw if render() is not overridden', function() {
+  describe('Required overrides', function () {
+    it('Should throw if render() is not overridden', function () {
       expect(() => BaseService.render()).to.throw(
-        'render() function not implemented for BaseService'
+        /^render\(\) function not implemented for BaseService$/
       )
     })
 
-    it('Should throw if route is not overridden', async function() {
-      try {
-        await BaseService.invoke({}, {}, {})
-        expect.fail('Expected to throw')
-      } catch (e) {
-        expect(e.message).to.equal('Route not defined for BaseService')
-      }
+    it('Should throw if route is not overridden', function () {
+      return expect(BaseService.invoke({}, {}, {})).to.be.rejectedWith(
+        /^Route not defined for BaseService$/
+      )
     })
 
     class WithRoute extends BaseService {
-      static get route() {
-        return {}
-      }
+      static route = {}
     }
-    it('Should throw if handle() is not overridden', async function() {
-      try {
-        await WithRoute.invoke({}, {}, {})
-        expect.fail('Expected to throw')
-      } catch (e) {
-        expect(e.message).to.equal('Handler not implemented for WithRoute')
-      }
+    it('Should throw if handle() is not overridden', function () {
+      return expect(WithRoute.invoke({}, {}, {})).to.be.rejectedWith(
+        /^Handler not implemented for WithRoute$/
+      )
     })
 
-    it('Should throw if category is not overridden', function() {
+    it('Should throw if category is not overridden', function () {
       expect(() => BaseService.category).to.throw(
-        'Category not set for BaseService'
+        /^Category not set for BaseService$/
       )
     })
   })
 
-  describe('Logging', function() {
+  describe('Logging', function () {
     let sandbox
-    beforeEach(function() {
+    beforeEach(function () {
       sandbox = sinon.createSandbox()
     })
-    afterEach(function() {
+    afterEach(function () {
       sandbox.restore()
     })
-    beforeEach(function() {
+    beforeEach(function () {
       sandbox.stub(trace, 'logTrace')
     })
-    it('Invokes the logger as expected', async function() {
+    it('Invokes the logger as expected', async function () {
       await DummyService.invoke(
         {},
         defaultConfig,
@@ -170,8 +163,8 @@ describe('BaseService', function() {
     })
   })
 
-  describe('Service data validation', function() {
-    it('Allows a link array', async function() {
+  describe('Service data validation', function () {
+    it('Allows a link array', async function () {
       const message = 'hello'
       const link = ['https://example.com/', 'https://other.example.com/']
       class LinkService extends DummyService {
@@ -192,7 +185,7 @@ describe('BaseService', function() {
       })
     })
 
-    it('Throws a validation error on invalid data', async function() {
+    context('On invalid data', function () {
       class ThrowingService extends DummyService {
         async handle() {
           return {
@@ -200,24 +193,42 @@ describe('BaseService', function() {
           }
         }
       }
-      try {
-        await ThrowingService.invoke(
-          {},
-          { handleInternalErrors: false },
-          { namedParamA: 'bar.bar.bar' }
-        )
-        expect.fail('Expected to throw')
-      } catch (e) {
-        expect(e.name).to.equal('ValidationError')
-        expect(e.details.map(({ message }) => message)).to.deep.equal([
-          '"message" is required',
-        ])
-      }
+
+      it('Throws a validation error on invalid data', async function () {
+        try {
+          await ThrowingService.invoke(
+            {},
+            { handleInternalErrors: false },
+            { namedParamA: 'bar.bar.bar' }
+          )
+          expect.fail('Expected to throw')
+        } catch (e) {
+          expect(e.name).to.equal('ValidationError')
+          expect(e.details.map(({ message }) => message)).to.deep.equal([
+            '"message" is required',
+          ])
+        }
+      })
+
+      // Ensure debuggabillity.
+      // https://github.com/badges/shields/issues/3784
+      it('Includes the service class in the stack trace', async function () {
+        try {
+          await ThrowingService.invoke(
+            {},
+            { handleInternalErrors: false },
+            { namedParamA: 'bar.bar.bar' }
+          )
+          expect.fail('Expected to throw')
+        } catch (e) {
+          expect(e.stack).to.include('ThrowingService._validateServiceData')
+        }
+      })
     })
   })
 
-  describe('Error handling', function() {
-    it('Handles internal errors', async function() {
+  describe('Error handling', function () {
+    it('Handles internal errors', async function () {
       class ThrowingService extends DummyService {
         async handle() {
           throw Error("I've made a huge mistake")
@@ -237,8 +248,8 @@ describe('BaseService', function() {
       })
     })
 
-    describe('Handles known subtypes of ShieldsInternalError', function() {
-      it('handles NotFound errors', async function() {
+    describe('Handles known subtypes of ShieldsInternalError', function () {
+      it('handles NotFound errors', async function () {
         class ThrowingService extends DummyService {
           async handle() {
             throw new NotFound()
@@ -253,7 +264,7 @@ describe('BaseService', function() {
         })
       })
 
-      it('handles Inaccessible errors', async function() {
+      it('handles Inaccessible errors', async function () {
         class ThrowingService extends DummyService {
           async handle() {
             throw new Inaccessible()
@@ -268,7 +279,7 @@ describe('BaseService', function() {
         })
       })
 
-      it('handles InvalidResponse errors', async function() {
+      it('handles InvalidResponse errors', async function () {
         class ThrowingService extends DummyService {
           async handle() {
             throw new InvalidResponse()
@@ -283,7 +294,7 @@ describe('BaseService', function() {
         })
       })
 
-      it('handles Deprecated', async function() {
+      it('handles Deprecated', async function () {
         class ThrowingService extends DummyService {
           async handle() {
             throw new Deprecated()
@@ -298,7 +309,7 @@ describe('BaseService', function() {
         })
       })
 
-      it('handles InvalidParameter errors', async function() {
+      it('handles InvalidParameter errors', async function () {
         class ThrowingService extends DummyService {
           async handle() {
             throw new InvalidParameter()
@@ -315,13 +326,15 @@ describe('BaseService', function() {
     })
   })
 
-  describe('ScoutCamp integration', function() {
-    const expectedRouteRegex = /^\/foo\/([^/]+?)\.(svg|png|gif|jpg|json)$/
+  describe('ScoutCamp integration', function () {
+    // TODO Strangly, without the useless escape the regexes do not match in Node 12.
+    // eslint-disable-next-line no-useless-escape
+    const expectedRouteRegex = /^\/foo(?:\/([^\/#\?]+?))(|\.svg|\.json)$/
 
     let mockCamp
     let mockHandleRequest
 
-    beforeEach(function() {
+    beforeEach(function () {
       mockCamp = {
         route: sinon.spy(),
       }
@@ -332,12 +345,12 @@ describe('BaseService', function() {
       )
     })
 
-    it('registers the service', function() {
+    it('registers the service', function () {
       expect(mockCamp.route).to.have.been.calledOnce
       expect(mockCamp.route).to.have.been.calledWith(expectedRouteRegex)
     })
 
-    it('handles the request', async function() {
+    it('handles the request', async function () {
       expect(mockHandleRequest).to.have.been.calledOnce
 
       const {
@@ -360,9 +373,10 @@ describe('BaseService', function() {
       const expectedFormat = 'svg'
       expect(mockSendBadge).to.have.been.calledOnce
       expect(mockSendBadge).to.have.been.calledWith(expectedFormat, {
-        text: ['cat', 'Hello namedParamA: bar with queryParamA: ?'],
+        label: 'cat',
+        message: 'Hello namedParamA: bar with queryParamA: ?',
         color: 'lightgrey',
-        template: undefined,
+        style: 'flat',
         namedLogo: undefined,
         logo: undefined,
         logoWidth: undefined,
@@ -374,8 +388,8 @@ describe('BaseService', function() {
     })
   })
 
-  describe('getDefinition', function() {
-    it('returns the expected result', function() {
+  describe('getDefinition', function () {
+    it('returns the expected result', function () {
       const {
         category,
         name,
@@ -402,37 +416,36 @@ describe('BaseService', function() {
     })
   })
 
-  describe('validate', function() {
+  describe('validate', function () {
     const dummySchema = Joi.object({
       requiredString: Joi.string().required(),
     }).required()
 
-    it('throws error for invalid responses', async function() {
-      try {
+    it('throws error for invalid responses', function () {
+      expect(() =>
         DummyService._validate(
           { requiredString: ['this', "shouldn't", 'work'] },
           dummySchema
         )
-        expect.fail('Expected to throw')
-      } catch (e) {
-        expect(e).to.be.an.instanceof(InvalidResponse)
-      }
+      )
+        .to.throw()
+        .instanceof(InvalidResponse)
     })
   })
 
-  describe('request', function() {
+  describe('request', function () {
     let sandbox
-    beforeEach(function() {
+    beforeEach(function () {
       sandbox = sinon.createSandbox()
     })
-    afterEach(function() {
+    afterEach(function () {
       sandbox.restore()
     })
-    beforeEach(function() {
+    beforeEach(function () {
       sandbox.stub(trace, 'logTrace')
     })
 
-    it('logs appropriate information', async function() {
+    it('logs appropriate information', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: '',
         res: { statusCode: 200 },
@@ -450,9 +463,7 @@ describe('BaseService', function() {
         'fetch',
         sinon.match.string,
         'Request',
-        url,
-        '\n',
-        options
+        `${url}\n${JSON.stringify(options, null, 2)}`
       )
       expect(trace.logTrace).to.be.calledWithMatch(
         'fetch',
@@ -462,7 +473,7 @@ describe('BaseService', function() {
       )
     })
 
-    it('handles errors', async function() {
+    it('handles errors', async function () {
       const sendAndCacheRequest = async () => ({
         buffer: '',
         res: { statusCode: 404 },
@@ -482,4 +493,111 @@ describe('BaseService', function() {
       }
     })
   })
+
+  describe('Metrics', function () {
+    let register
+    beforeEach(function () {
+      register = new prometheus.Registry()
+    })
+    const url = 'some-url'
+
+    it('service response size metric is optional', async function () {
+      const metricHelper = MetricHelper.create({
+        metricInstance: new PrometheusMetrics({ register }),
+        ServiceClass: DummyServiceWithServiceResponseSizeMetricEnabled,
+      })
+      const sendAndCacheRequest = async () => ({
+        buffer: 'x'.repeat(65536 + 1),
+        res: { statusCode: 200 },
+      })
+      const serviceInstance = new DummyServiceWithServiceResponseSizeMetricEnabled(
+        { sendAndCacheRequest, metricHelper },
+        defaultConfig
+      )
+
+      await serviceInstance._request({ url })
+
+      expect(await register.getSingleMetricAsString('service_response_bytes'))
+        .to.contain(
+          'service_response_bytes_bucket{le="65536",category="other",family="undefined",service="dummy_service_with_service_response_size_metric_enabled"} 0\n'
+        )
+        .and.to.contain(
+          'service_response_bytes_bucket{le="131072",category="other",family="undefined",service="dummy_service_with_service_response_size_metric_enabled"} 1\n'
+        )
+    })
+
+    it('service response size metric is disabled by default', async function () {
+      const metricHelper = MetricHelper.create({
+        metricInstance: new PrometheusMetrics({ register }),
+        ServiceClass: DummyService,
+      })
+      const sendAndCacheRequest = async () => ({
+        buffer: 'x',
+        res: { statusCode: 200 },
+      })
+      const serviceInstance = new DummyService(
+        { sendAndCacheRequest, metricHelper },
+        defaultConfig
+      )
+
+      await serviceInstance._request({ url })
+
+      expect(
+        await register.getSingleMetricAsString('service_response_bytes')
+      ).to.not.contain('service_response_bytes_bucket')
+    })
+  })
+  describe('auth', function () {
+    class AuthService extends DummyService {
+      static auth = {
+        passKey: 'myci_pass',
+        serviceKey: 'myci',
+        isRequired: true,
+      }
+
+      async handle() {
+        return {
+          message: `The CI password is ${this.authHelper._pass}`,
+        }
+      }
+    }
+
+    it('when auth is configured properly, invoke() sets authHelper', async function () {
+      expect(
+        await AuthService.invoke(
+          {},
+          {
+            public: {
+              ...defaultConfig.public,
+              services: { myci: { authorizedOrigins: ['https://myci.test'] } },
+            },
+            private: { myci_pass: 'abc123' },
+          },
+          { namedParamA: 'bar.bar.bar' }
+        )
+      ).to.deep.equal({ message: 'The CI password is abc123' })
+    })
+
+    it('when auth is not configured properly, invoke() returns inacessible', async function () {
+      expect(
+        await AuthService.invoke(
+          {},
+          {
+            public: {
+              ...defaultConfig.public,
+              services: { myci: { authorizedOrigins: ['https://myci.test'] } },
+            },
+            private: {},
+          },
+          {
+            namedParamA: 'bar.bar.bar',
+          }
+        )
+      ).to.deep.equal({
+        color: 'lightgray',
+        isError: true,
+        message: 'credentials have not been configured',
+      })
+    })
+  })
 })

core/base-service/cache-headers.js

@@ -7,9 +7,7 @@ const coalesce = require('./coalesce')
 const serverStartTimeGMTString = new Date().toGMTString()
 const serverStartTimestamp = Date.now()
 
-const isOptionalNonNegativeInteger = Joi.number()
-  .integer()
-  .min(0)
+const isOptionalNonNegativeInteger = Joi.number().integer().min(0)
 
 const queryParamSchema = Joi.object({
   cacheSeconds: isOptionalNonNegativeInteger,
@@ -69,7 +67,7 @@ function setHeadersForCacheLength(res, cacheLengthSeconds) {
     cacheControl = 'no-cache, no-store, must-revalidate'
     expires = nowGMTString
   } else {
-    cacheControl = `max-age=${cacheLengthSeconds}`
+    cacheControl = `max-age=${cacheLengthSeconds}, s-maxage=${cacheLengthSeconds}`
     expires = new Date(now.getTime() + cacheLengthSeconds * 1000).toGMTString()
   }
 
@@ -94,7 +92,7 @@ function setCacheHeaders({
   setHeadersForCacheLength(res, cacheLengthSeconds)
 }
 
-const staticCacheControlHeader = `max-age=${24 * 3600}` // 1 day.
+const staticCacheControlHeader = `max-age=${24 * 3600}, s-maxage=${24 * 3600}` // 1 day.
 function setCacheHeadersForStaticResource(res) {
   res.setHeader('Cache-Control', staticCacheControlHeader)
   res.setHeader('Last-Modified', serverStartTimeGMTString)

core/base-service/cache-headers.spec.js

@@ -15,13 +15,13 @@ const {
 
 chai.use(require('chai-datetime'))
 
-describe('Cache header functions', function() {
+describe('Cache header functions', function () {
   let res
-  beforeEach(function() {
+  beforeEach(function () {
     res = httpMocks.createResponse()
   })
 
-  describe('coalesceCacheLength', function() {
+  describe('coalesceCacheLength', function () {
     const cacheHeaderConfig = { defaultCacheLengthSeconds: 777 }
     test(coalesceCacheLength, () => {
       given({ cacheHeaderConfig, queryParams: {} }).expect(777)
@@ -101,18 +101,18 @@ describe('Cache header functions', function() {
     })
   })
 
-  describe('setHeadersForCacheLength', function() {
+  describe('setHeadersForCacheLength', function () {
     let sandbox
-    beforeEach(function() {
+    beforeEach(function () {
       sandbox = sinon.createSandbox()
       sandbox.useFakeTimers()
     })
-    afterEach(function() {
+    afterEach(function () {
       sandbox.restore()
       sandbox = undefined
     })
 
-    it('should set the correct Date header', function() {
+    it('should set the correct Date header', function () {
       // Confidence check.
       expect(res._headers.date).to.equal(undefined)
 
@@ -124,40 +124,42 @@ describe('Cache header functions', function() {
       expect(res._headers.date).to.equal(now)
     })
 
-    context('cacheLengthSeconds is zero', function() {
-      beforeEach(function() {
+    context('cacheLengthSeconds is zero', function () {
+      beforeEach(function () {
         setHeadersForCacheLength(res, 0)
       })
 
-      it('should set the expected Cache-Control header', function() {
+      it('should set the expected Cache-Control header', function () {
         expect(res._headers['cache-control']).to.equal(
           'no-cache, no-store, must-revalidate'
         )
       })
 
-      it('should set the expected Expires header', function() {
+      it('should set the expected Expires header', function () {
         expect(res._headers.expires).to.equal(new Date().toGMTString())
       })
     })
 
-    context('cacheLengthSeconds is nonzero', function() {
-      beforeEach(function() {
+    context('cacheLengthSeconds is nonzero', function () {
+      beforeEach(function () {
         setHeadersForCacheLength(res, 123)
       })
 
-      it('should set the expected Cache-Control header', function() {
-        expect(res._headers['cache-control']).to.equal('max-age=123')
+      it('should set the expected Cache-Control header', function () {
+        expect(res._headers['cache-control']).to.equal(
+          'max-age=123, s-maxage=123'
+        )
       })
 
-      it('should set the expected Expires header', function() {
+      it('should set the expected Expires header', function () {
         const expires = new Date(Date.now() + 123 * 1000).toGMTString()
         expect(res._headers.expires).to.equal(expires)
       })
     })
   })
 
-  describe('setCacheHeaders', function() {
-    it('sets the expected fields', function() {
+  describe('setCacheHeaders', function () {
+    it('sets the expected fields', function () {
       const expectedFields = ['date', 'cache-control', 'expires']
       expectedFields.forEach(field =>
         expect(res._headers[field]).to.equal(undefined)
@@ -178,16 +180,18 @@ describe('Cache header functions', function() {
     })
   })
 
-  describe('setCacheHeadersForStaticResource', function() {
-    beforeEach(function() {
+  describe('setCacheHeadersForStaticResource', function () {
+    beforeEach(function () {
       setCacheHeadersForStaticResource(res)
     })
 
-    it('should set the expected Cache-Control header', function() {
-      expect(res._headers['cache-control']).to.equal(`max-age=${24 * 3600}`)
+    it('should set the expected Cache-Control header', function () {
+      expect(res._headers['cache-control']).to.equal(
+        `max-age=${24 * 3600}, s-maxage=${24 * 3600}`
+      )
     })
 
-    it('should set the expected Last-Modified header', function() {
+    it('should set the expected Last-Modified header', function () {
       const lastModified = res._headers['last-modified']
       expect(new Date(lastModified)).to.be.withinTime(
         // Within the last 60 seconds.
@@ -197,17 +201,17 @@ describe('Cache header functions', function() {
     })
   })
 
-  describe('serverHasBeenUpSinceResourceCached', function() {
+  describe('serverHasBeenUpSinceResourceCached', function () {
     // The stringified req's are hard to understand. I thought Sazerac
     // provided a way to override the describe message, though I can't find it.
-    context('when there is no If-Modified-Since header', function() {
-      it('returns false', function() {
+    context('when there is no If-Modified-Since header', function () {
+      it('returns false', function () {
         const req = httpMocks.createRequest()
         expect(serverHasBeenUpSinceResourceCached(req)).to.equal(false)
       })
     })
-    context('when the If-Modified-Since header is invalid', function() {
-      it('returns false', function() {
+    context('when the If-Modified-Since header is invalid', function () {
+      it('returns false', function () {
         const req = httpMocks.createRequest({
           headers: { 'If-Modified-Since': 'this-is-not-a-date' },
         })
@@ -216,8 +220,8 @@ describe('Cache header functions', function() {
     })
     context(
       'when the If-Modified-Since header is before the process started',
-      function() {
-        it('returns false', function() {
+      function () {
+        it('returns false', function () {
           const req = httpMocks.createRequest({
             headers: { 'If-Modified-Since': '2018-02-01T05:00:00.000Z' },
           })
@@ -227,8 +231,8 @@ describe('Cache header functions', function() {
     )
     context(
       'when the If-Modified-Since header is after the process started',
-      function() {
-        it('returns true', function() {
+      function () {
+        it('returns true', function () {
           const modifiedTimeStamp = new Date(Date.now() + 1800000)
           const req = httpMocks.createRequest({
             headers: { 'If-Modified-Since': modifiedTimeStamp.toISOString() },

core/base-service/categories.js

@@ -3,7 +3,7 @@
 const Joi = require('joi')
 const categories = require('../../services/categories')
 
-const isRealCategory = Joi.equal(categories.map(({ id }) => id)).required()
+const isRealCategory = Joi.equal(...categories.map(({ id }) => id)).required()
 
 const isValidCategory = Joi.alternatives()
   .try(isRealCategory, Joi.equal('debug', 'dynamic', 'static').required())

core/base-service/check-error-response.js

@@ -7,7 +7,7 @@ const defaultErrorMessages = {
 }
 
 module.exports = function checkErrorResponse(errorMessages = {}) {
-  return async function({ buffer, res }) {
+  return async function ({ buffer, res }) {
     let error
     errorMessages = { ...defaultErrorMessages, ...errorMessages }
     if (res.statusCode === 404) {

core/base-service/check-error-response.spec.js

@@ -4,11 +4,11 @@ const { expect } = require('chai')
 const { NotFound, InvalidResponse, Inaccessible } = require('./errors')
 const checkErrorResponse = require('./check-error-response')
 
-describe('async error handler', function() {
+describe('async error handler', function () {
   const buffer = Buffer.from('some stuff')
 
-  context('when status is 200', function() {
-    it('passes through the inputs', async function() {
+  context('when status is 200', function () {
+    it('passes through the inputs', async function () {
       const res = { statusCode: 200 }
       expect(await checkErrorResponse()({ res, buffer })).to.deep.equal({
         res,
@@ -17,11 +17,11 @@ describe('async error handler', function() {
     })
   })
 
-  context('when status is 404', function() {
+  context('when status is 404', function () {
     const buffer = Buffer.from('some stuff')
     const res = { statusCode: 404 }
 
-    it('throws NotFound', async function() {
+    it('throws NotFound', async function () {
       try {
         await checkErrorResponse()({ res, buffer })
         expect.fail('Expected to throw')
@@ -34,7 +34,7 @@ describe('async error handler', function() {
       }
     })
 
-    it('displays the custom not found message', async function() {
+    it('displays the custom not found message', async function () {
       const notFoundMessage = 'no goblins found'
       try {
         await checkErrorResponse({ 404: notFoundMessage })({ res, buffer })
@@ -47,8 +47,8 @@ describe('async error handler', function() {
     })
   })
 
-  context('when status is 4xx', function() {
-    it('throws InvalidResponse', async function() {
+  context('when status is 4xx', function () {
+    it('throws InvalidResponse', async function () {
       const res = { statusCode: 499 }
       try {
         await checkErrorResponse()({ res, buffer })
@@ -64,7 +64,7 @@ describe('async error handler', function() {
       }
     })
 
-    it('displays the custom error message', async function() {
+    it('displays the custom error message', async function () {
       const res = { statusCode: 403 }
       try {
         await checkErrorResponse({ 403: 'access denied' })({ res })
@@ -79,8 +79,8 @@ describe('async error handler', function() {
     })
   })
 
-  context('when status is 5xx', function() {
-    it('throws Inaccessible', async function() {
+  context('when status is 5xx', function () {
+    it('throws Inaccessible', async function () {
       const res = { statusCode: 503 }
       try {
         await checkErrorResponse()({ res, buffer })
@@ -96,7 +96,7 @@ describe('async error handler', function() {
       }
     })
 
-    it('displays the custom error message', async function() {
+    it('displays the custom error message', async function () {
       const res = { statusCode: 500 }
       try {
         await checkErrorResponse({ 500: 'server overloaded' })({ res, buffer })

core/base-service/coalesce-badge.js

@@ -104,7 +104,23 @@ module.exports = function coalesceBadge(
     labelColor: defaultLabelColor,
   } = defaultBadgeData
 
-  const style = coalesce(overrideStyle, serviceStyle)
+  let style = coalesce(overrideStyle, serviceStyle)
+  if (typeof style !== 'string') {
+    style = 'flat'
+  }
+  if (style.startsWith('popout')) {
+    style = style.replace('popout', 'flat')
+  }
+  const styleValues = [
+    'plastic',
+    'flat',
+    'flat-square',
+    'for-the-badge',
+    'social',
+  ]
+  if (!styleValues.includes(style)) {
+    style = 'flat'
+  }
 
   let namedLogo, namedLogoColor, logoWidth, logoPosition, logoSvgBase64
   if (overrideLogo) {
@@ -144,12 +160,10 @@ module.exports = function coalesceBadge(
   }
 
   return {
-    text: [
-      // Use `coalesce()` to support empty labels and messages, as in the
-      // static badge.
-      coalesce(overrideLabel, serviceLabel, defaultLabel, category),
-      coalesce(serviceMessage, 'n/a'),
-    ],
+    // Use `coalesce()` to support empty labels and messages, as in the static
+    // badge.
+    label: coalesce(overrideLabel, serviceLabel, defaultLabel, category),
+    message: coalesce(serviceMessage, 'n/a'),
     color: coalesce(
       // In case of an error, disregard user's color override.
       isError ? undefined : overrideColor,
@@ -163,7 +177,7 @@ module.exports = function coalesceBadge(
       serviceLabelColor,
       defaultLabelColor
     ),
-    template: style,
+    style,
     namedLogo,
     logo: logoSvgBase64,
     logoWidth,

core/base-service/coalesce-badge.spec.js

@@ -4,124 +4,123 @@ const { expect } = require('chai')
 const { getShieldsIcon, getSimpleIcon } = require('../../lib/logos')
 const coalesceBadge = require('./coalesce-badge')
 
-describe('coalesceBadge', function() {
-  describe('Label', function() {
-    it('uses the default label', function() {
-      expect(coalesceBadge({}, {}, { label: 'heyo' }).text).to.deep.equal([
-        'heyo',
-        'n/a',
-      ])
+describe('coalesceBadge', function () {
+  describe('Label', function () {
+    it('uses the default label', function () {
+      expect(coalesceBadge({}, {}, { label: 'heyo' })).to.include({
+        label: 'heyo',
+      })
     })
 
     // This behavior isn't great and we might want to remove it.
-    it('uses the category as a default label', function() {
-      expect(coalesceBadge({}, {}, {}, { category: 'cat' }).text).to.deep.equal(
-        ['cat', 'n/a']
-      )
+    it('uses the category as a default label', function () {
+      expect(coalesceBadge({}, {}, {}, { category: 'cat' })).to.include({
+        label: 'cat',
+      })
     })
 
-    it('preserves an empty label', function() {
-      expect(
-        coalesceBadge({}, { label: '', message: '10k' }, {}).text
-      ).to.deep.equal(['', '10k'])
+    it('preserves an empty label', function () {
+      expect(coalesceBadge({}, { label: '', message: '10k' }, {})).to.include({
+        label: '',
+      })
     })
 
-    it('overrides the label', function() {
+    it('overrides the label', function () {
       expect(
-        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {}).text
-      ).to.deep.equal(['purr count', 'n/a'])
+        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {})
+      ).to.include({ label: 'purr count' })
     })
   })
 
-  describe('Message', function() {
-    it('applies the service message', function() {
-      expect(coalesceBadge({}, { message: '10k' }, {}).text).to.deep.equal([
-        undefined,
-        '10k',
-      ])
+  describe('Message', function () {
+    it('applies the service message', function () {
+      expect(coalesceBadge({}, { message: '10k' }, {})).to.include({
+        message: '10k',
+      })
     })
 
-    it('applies a numeric service message', function() {
+    // https://github.com/badges/shields/issues/1280
+    it('converts a number to a string', function () {
       // While a number of badges use this, in the long run we may want
       // `render()` to always return a string.
-      expect(coalesceBadge({}, { message: 10 }, {}).text).to.deep.equal([
-        undefined,
-        10,
-      ])
+      expect(coalesceBadge({}, { message: 10 }, {})).to.include({
+        message: 10,
+      })
     })
   })
 
-  describe('Right color', function() {
-    it('uses the default color', function() {
-      expect(coalesceBadge({}, {}, {}).color).to.equal('lightgrey')
+  describe('Right color', function () {
+    it('uses the default color', function () {
+      expect(coalesceBadge({}, {}, {})).to.include({ color: 'lightgrey' })
     })
 
-    it('overrides the color', function() {
+    it('overrides the color', function () {
       expect(
-        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {}).color
-      ).to.equal('10ADED')
+        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {})
+      ).to.include({ color: '10ADED' })
       // also expected for legacy name
       expect(
-        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {}).color
-      ).to.equal('B0ADED')
+        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {})
+      ).to.include({ color: 'B0ADED' })
     })
 
-    context('In case of an error', function() {
-      it('does not override the color', function() {
+    context('In case of an error', function () {
+      it('does not override the color', function () {
         expect(
           coalesceBadge(
             { color: '10ADED' },
             { isError: true, color: 'lightgray' },
             {}
-          ).color
-        ).to.equal('lightgray')
+          )
+        ).to.include({ color: 'lightgray' })
         // also expected for legacy name
         expect(
           coalesceBadge(
             { colorB: 'B0ADED' },
             { isError: true, color: 'lightgray' },
             {}
-          ).color
-        ).to.equal('lightgray')
+          )
+        ).to.include({ color: 'lightgray' })
       })
     })
 
-    it('applies the service color', function() {
-      expect(coalesceBadge({}, { color: 'red' }, {}).color).to.equal('red')
+    it('applies the service color', function () {
+      expect(coalesceBadge({}, { color: 'red' }, {})).to.include({
+        color: 'red',
+      })
     })
   })
 
-  describe('Left color', function() {
-    it('provides no default label color', function() {
+  describe('Left color', function () {
+    it('provides no default label color', function () {
       expect(coalesceBadge({}, {}, {}).labelColor).to.be.undefined
     })
 
-    it('applies the service label color', function() {
-      expect(coalesceBadge({}, { labelColor: 'red' }, {}).labelColor).to.equal(
-        'red'
-      )
+    it('applies the service label color', function () {
+      expect(coalesceBadge({}, { labelColor: 'red' }, {})).to.include({
+        labelColor: 'red',
+      })
     })
 
-    it('overrides the label color', function() {
+    it('overrides the label color', function () {
       expect(
         coalesceBadge({ labelColor: '42f483' }, { color: 'green' }, {})
-          .labelColor
-      ).to.equal('42f483')
+      ).to.include({ labelColor: '42f483' })
       // also expected for legacy name
       expect(
-        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {}).labelColor
-      ).to.equal('B2f483')
+        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {})
+      ).to.include({ labelColor: 'B2f483' })
     })
 
-    it('converts a query-string numeric color to a string', function() {
+    it('converts a query-string numeric color to a string', function () {
       expect(
         coalesceBadge(
           // Scoutcamp converts numeric query params to numbers.
           { color: 123 },
           { color: 'green' },
           {}
-        ).color
-      ).to.equal('123')
+        )
+      ).to.include({ color: '123' })
       // also expected for legacy name
       expect(
         coalesceBadge(
@@ -129,47 +128,47 @@ describe('coalesceBadge', function() {
           { colorB: 123 },
           { color: 'green' },
           {}
-        ).color
-      ).to.equal('123')
+        )
+      ).to.include({ color: '123' })
     })
   })
 
-  describe('Named logos', function() {
-    it('when not a social badge, ignores the default named logo', function() {
+  describe('Named logos', function () {
+    it('when not a social badge, ignores the default named logo', function () {
       expect(coalesceBadge({}, {}, { namedLogo: 'appveyor' }).logo).to.be
         .undefined
     })
 
-    it('when a social badge, uses the default named logo', function() {
+    it('when a social badge, uses the default named logo', function () {
       // .not.be.empty for confidence that nothing has changed with `getShieldsIcon()`.
       expect(
         coalesceBadge({ style: 'social' }, {}, { namedLogo: 'appveyor' }).logo
       ).to.equal(getSimpleIcon({ name: 'appveyor' })).and.not.be.empty
     })
 
-    it('applies the named logo', function() {
-      expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).namedLogo).to.equal(
-        'npm'
-      )
+    it('applies the named logo', function () {
+      expect(coalesceBadge({}, { namedLogo: 'npm' }, {})).to.include({
+        namedLogo: 'npm',
+      })
       expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).logo).to.equal(
         getShieldsIcon({ name: 'npm' })
       ).and.not.to.be.empty
     })
 
-    it('applies the named logo with color', function() {
+    it('applies the named logo with color', function () {
       expect(
         coalesceBadge({}, { namedLogo: 'npm', logoColor: 'blue' }, {}).logo
       ).to.equal(getShieldsIcon({ name: 'npm', color: 'blue' })).and.not.to.be
         .empty
     })
 
-    it('overrides the logo', function() {
+    it('overrides the logo', function () {
       expect(
         coalesceBadge({ logo: 'npm' }, { namedLogo: 'appveyor' }, {}).logo
       ).to.equal(getShieldsIcon({ name: 'npm' })).and.not.be.empty
     })
 
-    it('overrides the logo with a color', function() {
+    it('overrides the logo with a color', function () {
       expect(
         coalesceBadge(
           { logo: 'npm', logoColor: 'blue' },
@@ -180,7 +179,7 @@ describe('coalesceBadge', function() {
         .empty
     })
 
-    it("when the logo is overridden, it ignores the service's logo color, position, and width", function() {
+    it("when the logo is overridden, it ignores the service's logo color, position, and width", function () {
       expect(
         coalesceBadge(
           { logo: 'npm' },
@@ -195,7 +194,7 @@ describe('coalesceBadge', function() {
       ).to.equal(getShieldsIcon({ name: 'npm' })).and.not.be.empty
     })
 
-    it("overrides the service logo's color", function() {
+    it("overrides the service logo's color", function () {
       expect(
         coalesceBadge(
           { logoColor: 'blue' },
@@ -207,7 +206,7 @@ describe('coalesceBadge', function() {
     })
 
     // https://github.com/badges/shields/issues/2998
-    it('overrides logoSvg', function() {
+    it('overrides logoSvg', function () {
       const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
       expect(coalesceBadge({ logo: 'npm' }, { logoSvg }, {}).logo).to.equal(
         getShieldsIcon({ name: 'npm' })
@@ -215,55 +214,56 @@ describe('coalesceBadge', function() {
     })
   })
 
-  describe('Custom logos', function() {
-    it('overrides the logo with custom svg', function() {
+  describe('Custom logos', function () {
+    it('overrides the logo with custom svg', function () {
       const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
       expect(
-        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {}).logo
-      ).to.equal(logoSvg)
+        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {})
+      ).to.include({ logo: logoSvg })
     })
 
-    it('ignores the color when custom svg is provided', function() {
+    it('ignores the color when custom svg is provided', function () {
       const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
       expect(
         coalesceBadge(
           { logo: logoSvg, logoColor: 'brightgreen' },
           { namedLogo: 'appveyor' },
           {}
-        ).logo
-      ).to.equal(logoSvg)
+        )
+      ).to.include({ logo: logoSvg })
     })
   })
 
-  describe('Logo width', function() {
-    it('overrides the logoWidth', function() {
-      expect(coalesceBadge({ logoWidth: 20 }, {}, {}).logoWidth).to.equal(20)
+  describe('Logo width', function () {
+    it('overrides the logoWidth', function () {
+      expect(coalesceBadge({ logoWidth: 20 }, {}, {})).to.include({
+        logoWidth: 20,
+      })
     })
 
-    it('applies the logo width', function() {
+    it('applies the logo width', function () {
       expect(
-        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {}).logoWidth
-      ).to.equal(275)
+        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {})
+      ).to.include({ logoWidth: 275 })
     })
   })
 
-  describe('Logo position', function() {
-    it('overrides the logoPosition', function() {
-      expect(
-        coalesceBadge({ logoPosition: -10 }, {}, {}).logoPosition
-      ).to.equal(-10)
+  describe('Logo position', function () {
+    it('overrides the logoPosition', function () {
+      expect(coalesceBadge({ logoPosition: -10 }, {}, {})).to.include({
+        logoPosition: -10,
+      })
     })
 
-    it('applies the logo position', function() {
+    it('applies the logo position', function () {
       expect(
         coalesceBadge({}, { namedLogo: 'npm', logoPosition: -10 }, {})
-          .logoPosition
-      ).to.equal(-10)
+      ).to.include({ logoPosition: -10 })
     })
   })
 
-  describe('Links', function() {
-    it('overrides the links', function() {
+  describe('Links', function () {
+    it('overrides the links', function () {
       expect(
         coalesceBadge(
           { link: 'https://circleci.com/gh/badges/daily-tests' },
@@ -277,18 +277,34 @@ describe('coalesceBadge', function() {
     })
   })
 
-  describe('Style', function() {
-    it('overrides the template', function() {
-      expect(coalesceBadge({ style: 'pill' }, {}, {}).template).to.equal('pill')
+  describe('Style', function () {
+    it('falls back to flat with invalid style', function () {
+      expect(coalesceBadge({ style: 'pill' }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: 7 }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: undefined }, {}, {})).to.include({
+        style: 'flat',
+      })
+    })
+
+    it('replaces legacy popout styles', function () {
+      expect(coalesceBadge({ style: 'popout' }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: 'popout-square' }, {}, {})).to.include({
+        style: 'flat-square',
+      })
     })
   })
 
-  describe('Cache length', function() {
-    it('overrides the cache length', function() {
+  describe('Cache length', function () {
+    it('overrides the cache length', function () {
       expect(
         coalesceBadge({ style: 'pill' }, { cacheSeconds: 123 }, {})
-          .cacheLengthSeconds
-      ).to.equal(123)
+      ).to.include({ cacheLengthSeconds: 123 })
     })
   })
 })

core/base-service/coalesce.spec.js

@@ -7,16 +7,16 @@ const coalesce = require('./coalesce')
 // `undefined` instead of `null`, though h/t to
 // https://github.com/royriojas/coalescy for these tests!
 
-describe('coalesce', function() {
-  test(coalesce, function() {
+describe('coalesce', function () {
+  test(coalesce, function () {
     given().expect(undefined)
     given(null, []).expect([])
     given(null, [], {}).expect([])
     given(null, undefined, 0, {}).expect(0)
 
-    const a = null,
-      c = 0,
-      d = 1
+    const a = null
+    const c = 0
+    const d = 1
     let b
     given(a, b, c, d).expect(0)
   })

core/base-service/deprecated-service.js

@@ -26,33 +26,17 @@ function deprecatedService(attrs) {
   )
 
   return class DeprecatedService extends BaseService {
-    static get name() {
-      return name
-        ? `Deprecated${name}`
-        : `Deprecated${camelcase(route.base.replace(/\//g, '_'), {
-            pascalCase: true,
-          })}`
-    }
+    static name = name
+      ? `Deprecated${name}`
+      : `Deprecated${camelcase(route.base.replace(/\//g, '_'), {
+          pascalCase: true,
+        })}`
 
-    static get category() {
-      return category
-    }
-
-    static get isDeprecated() {
-      return true
-    }
-
-    static get route() {
-      return route
-    }
-
-    static get examples() {
-      return examples
-    }
-
-    static get defaultBadgeData() {
-      return { label }
-    }
+    static category = category
+    static isDeprecated = true
+    static route = route
+    static examples = examples
+    static defaultBadgeData = { label }
 
     async handle() {
       throw new Deprecated({ prettyMessage: message })

core/base-service/deprecated-service.spec.js

@@ -3,7 +3,7 @@
 const { expect } = require('chai')
 const deprecatedService = require('./deprecated-service')
 
-describe('DeprecatedService', function() {
+describe('DeprecatedService', function () {
   const route = {
     base: 'service/that/no/longer/exists',
     format: '(?:.+)',
@@ -12,33 +12,33 @@ describe('DeprecatedService', function() {
   const dateAdded = new Date()
   const commonAttrs = { route, category, dateAdded }
 
-  it('returns true on isDeprecated', function() {
+  it('returns true on isDeprecated', function () {
     const service = deprecatedService({ ...commonAttrs })
     expect(service.isDeprecated).to.be.true
   })
 
-  it('has the expected name', function() {
+  it('has the expected name', function () {
     const service = deprecatedService({ ...commonAttrs })
     expect(service.name).to.equal('DeprecatedServiceThatNoLongerExists')
   })
 
-  it('sets specified route', function() {
+  it('sets specified route', function () {
     const service = deprecatedService({ ...commonAttrs })
     expect(service.route).to.deep.equal(route)
   })
 
-  it('sets specified label', function() {
+  it('sets specified label', function () {
     const label = 'coverity'
     const service = deprecatedService({ ...commonAttrs, label })
     expect(service.defaultBadgeData.label).to.equal(label)
   })
 
-  it('sets specified category', function() {
+  it('sets specified category', function () {
     const service = deprecatedService({ ...commonAttrs })
     expect(service.category).to.equal(category)
   })
 
-  it('sets specified examples', function() {
+  it('sets specified examples', function () {
     const examples = [
       {
         title: 'Not sure we would have examples',
@@ -48,7 +48,7 @@ describe('DeprecatedService', function() {
     expect(service.examples).to.deep.equal(examples)
   })
 
-  it('uses default deprecation message when no message specified', async function() {
+  it('uses default deprecation message when no message specified', async function () {
     const service = deprecatedService({ ...commonAttrs })
     expect(await service.invoke()).to.deep.equal({
       isError: true,
@@ -57,7 +57,7 @@ describe('DeprecatedService', function() {
     })
   })
 
-  it('uses custom deprecation message when specified', async function() {
+  it('uses custom deprecation message when specified', async function () {
     const message = 'extended outage'
     const service = deprecatedService({ ...commonAttrs, message })
     expect(await service.invoke()).to.deep.equal({

core/base-service/errors.js

@@ -1,13 +1,43 @@
+/**
+ * Standard exceptions for handling error cases
+ *
+ * @module
+ */
+
 'use strict'
 
+/**
+ * Base error class
+ *
+ * @abstract
+ */
 class ShieldsRuntimeError extends Error {
+  /**
+   * Name of the class. Implementations of ShieldsRuntimeError
+   * should override this method.
+   *
+   * @type {string}
+   */
   get name() {
     return 'ShieldsRuntimeError'
   }
+
+  /**
+   * Default message for this exception if none is specified.
+   * Implementations of ShieldsRuntimeError should implement this method.
+   *
+   * @abstract
+   * @type {string}
+   */
   get defaultPrettyMessage() {
     throw new Error('Must implement abstract method')
   }
 
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   * @param {string} message Exception message for debug purposes
+   */
   constructor(props = {}, message) {
     super(message)
     this.prettyMessage = props.prettyMessage || this.defaultPrettyMessage
@@ -19,14 +49,22 @@ class ShieldsRuntimeError extends Error {
 
 const defaultNotFoundError = 'not found'
 
+/**
+ * Throw this to wrap a 404 or other 'not found' response from an upstream API
+ */
 class NotFound extends ShieldsRuntimeError {
   get name() {
     return 'NotFound'
   }
+
   get defaultPrettyMessage() {
     return defaultNotFoundError
   }
 
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   */
   constructor(props = {}) {
     const prettyMessage = props.prettyMessage || defaultNotFoundError
     const message =
@@ -38,14 +76,22 @@ class NotFound extends ShieldsRuntimeError {
   }
 }
 
+/**
+ * Throw this to wrap an invalid or unexpected response from an upstream API
+ */
 class InvalidResponse extends ShieldsRuntimeError {
   get name() {
     return 'InvalidResponse'
   }
+
   get defaultPrettyMessage() {
     return 'invalid'
   }
 
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   */
   constructor(props = {}) {
     const message = props.underlyingError
       ? `Invalid Response: ${props.underlyingError.message}`
@@ -55,14 +101,23 @@ class InvalidResponse extends ShieldsRuntimeError {
   }
 }
 
+/**
+ * Throw this if we can't contact an upstream API
+ * or to wrap a 5XX response
+ */
 class Inaccessible extends ShieldsRuntimeError {
   get name() {
     return 'Inaccessible'
   }
+
   get defaultPrettyMessage() {
     return 'inaccessible'
   }
 
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   */
   constructor(props = {}) {
     const message = props.underlyingError
       ? `Inaccessible: ${props.underlyingError.message}`
@@ -72,14 +127,48 @@ class Inaccessible extends ShieldsRuntimeError {
   }
 }
 
+/**
+ * Throw this error when required credentials are missing
+ */
+class ImproperlyConfigured extends ShieldsRuntimeError {
+  get name() {
+    return 'ImproperlyConfigured'
+  }
+
+  get defaultPrettyMessage() {
+    return 'improperly configured'
+  }
+
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   */
+  constructor(props = {}) {
+    const message = props.underlyingError
+      ? `ImproperlyConfigured: ${props.underlyingError.message}`
+      : 'ImproperlyConfigured'
+    super(props, message)
+    this.response = props.response
+  }
+}
+
+/**
+ * Throw this error when a user supplied input or parameter
+ * is invalid or unexpected
+ */
 class InvalidParameter extends ShieldsRuntimeError {
   get name() {
     return 'InvalidParameter'
   }
+
   get defaultPrettyMessage() {
     return 'invalid parameter'
   }
 
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   */
   constructor(props = {}) {
     const message = props.underlyingError
       ? `Invalid Parameter: ${props.underlyingError.message}`
@@ -89,23 +178,42 @@ class InvalidParameter extends ShieldsRuntimeError {
   }
 }
 
+/**
+ * Throw this error to indicate that a service is deprecated or removed
+ */
 class Deprecated extends ShieldsRuntimeError {
   get name() {
     return 'Deprecated'
   }
+
   get defaultPrettyMessage() {
     return 'no longer available'
   }
 
+  /**
+   * @param {module:core/base-service/errors~RuntimeErrorProps} props
+   * Refer to individual attrs
+   */
   constructor(props) {
     const message = 'Deprecated'
     super(props, message)
   }
 }
 
+/**
+ * @typedef {object} RuntimeErrorProps
+ * @property {Error} underlyingError Exception we are wrapping (Optional)
+ * @property {object} response Response from an upstream API to provide
+ * context for the error (Optional)
+ * @property {string} prettyMessage User-facing error message to override the
+ * value of `defaultPrettyMessage()`. This is the text that will appear on the
+ * badge when we catch and render the exception (Optional)
+ */
+
 module.exports = {
   ShieldsRuntimeError,
   NotFound,
+  ImproperlyConfigured,
   InvalidResponse,
   Inaccessible,
   InvalidParameter,

core/base-service/examples.js

@@ -1,7 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
-const pathToRegexp = require('path-to-regexp')
+const { pathToRegexp, compile } = require('path-to-regexp')
+const categories = require('../../services/categories')
 const coalesceBadge = require('./coalesce-badge')
 const { makeFullUrl } = require('./route')
 
@@ -20,19 +21,12 @@ const schema = Joi.object({
   staticPreview: Joi.object({
     label: Joi.string(),
     message: Joi.alternatives()
-      .try(
-        Joi.string()
-          .allow('')
-          .required(),
-        Joi.number()
-      )
+      .try(Joi.string().allow('').required(), Joi.number())
       .required(),
     color: Joi.string(),
     style: Joi.string(),
   }).required(),
-  keywords: Joi.array()
-    .items(Joi.string())
-    .default([]),
+  keywords: Joi.array().items(Joi.string()).default([]),
   documentation: Joi.string(), // Valid HTML.
 }).required()
 
@@ -47,22 +41,20 @@ function validateExample(example, index, ServiceClass) {
 
   if (!pattern && !ServiceClass.route.pattern) {
     throw new Error(
-      `Example for ${
-        ServiceClass.name
-      } at index ${index} does not declare a pattern`
+      `Example for ${ServiceClass.name} at index ${index} does not declare a pattern`
     )
   }
   if (pattern === ServiceClass.route.pattern) {
     throw new Error(
-      `Example for ${
-        ServiceClass.name
-      } at index ${index} declares a redundant pattern which should be removed`
+      `Example for ${ServiceClass.name} at index ${index} declares a redundant pattern which should be removed`
     )
   }
 
   // Make sure we can build the full URL using these patterns.
   try {
-    pathToRegexp.compile(pattern || ServiceClass.route.pattern)(namedParams)
+    compile(pattern || ServiceClass.route.pattern, {
+      encode: encodeURIComponent,
+    })(namedParams)
   } catch (e) {
     throw Error(
       `In example for ${
@@ -72,7 +64,10 @@ function validateExample(example, index, ServiceClass) {
   }
   // Make sure there are no extra keys.
   let keys = []
-  pathToRegexp(pattern || ServiceClass.route.pattern, keys)
+  pathToRegexp(pattern || ServiceClass.route.pattern, keys, {
+    strict: true,
+    sensitive: true,
+  })
   keys = keys.map(({ name }) => name)
   const extraKeys = Object.keys(namedParams).filter(k => !keys.includes(k))
   if (extraKeys.length) {
@@ -129,12 +124,7 @@ function transformExample(inExample, index, ServiceClass) {
     documentation,
   } = validateExample(inExample, index, ServiceClass)
 
-  const {
-    text: [label, message],
-    color,
-    template: style,
-    namedLogo,
-  } = coalesceBadge(
+  const { label, message, color, style, namedLogo } = coalesceBadge(
     {},
     staticPreview,
     ServiceClass.defaultBadgeData,
@@ -158,7 +148,9 @@ function transformExample(inExample, index, ServiceClass) {
       style: style === 'flat' ? undefined : style,
       namedLogo,
     },
-    keywords,
+    keywords: keywords.concat(
+      categories.find(c => c.id === ServiceClass.category).keywords
+    ),
     documentation: documentation ? { __html: documentation } : undefined,
   }
 }

core/base-service/examples.spec.js

@@ -4,8 +4,8 @@ const { expect } = require('chai')
 const { test, given } = require('sazerac')
 const { validateExample, transformExample } = require('./examples')
 
-describe('validateExample function', function() {
-  it('passes valid examples', function() {
+describe('validateExample function', function () {
+  it('passes valid examples', function () {
     const validExamples = [
       {
         title: 'Package manager versioning badge',
@@ -23,7 +23,7 @@ describe('validateExample function', function() {
     })
   })
 
-  it('rejects invalid examples', function() {
+  it('rejects invalid examples', function () {
     const invalidExamples = [
       {},
       { staticPreview: { message: '123' } },
@@ -74,7 +74,7 @@ describe('validateExample function', function() {
   })
 })
 
-test(transformExample, function() {
+test(transformExample, function () {
   const ExampleService = {
     name: 'ExampleService',
     route: {
@@ -84,6 +84,7 @@ test(transformExample, function() {
     defaultBadgeData: {
       label: 'downloads',
     },
+    category: 'platform-support',
   }
 
   given(
@@ -109,7 +110,7 @@ test(transformExample, function() {
       namedLogo: undefined,
       style: undefined,
     },
-    keywords: ['hello'],
+    keywords: ['hello', 'platform'],
     documentation: undefined,
   })
 
@@ -135,7 +136,7 @@ test(transformExample, function() {
       namedLogo: undefined,
       style: undefined,
     },
-    keywords: ['hello'],
+    keywords: ['hello', 'platform'],
     documentation: undefined,
   })
 
@@ -162,7 +163,7 @@ test(transformExample, function() {
       namedLogo: undefined,
       style: undefined,
     },
-    keywords: ['hello'],
+    keywords: ['hello', 'platform'],
     documentation: undefined,
   })
 })

core/base-service/graphql.js

@@ -0,0 +1,52 @@
+'use strict'
+/**
+ * @module
+ */
+
+/**
+ * Utility function to merge two graphql queries together
+ * This is basically copied from
+ * [graphql-query-merge](https://www.npmjs.com/package/graphql-query-merge)
+ * but can't use that due to incorrect packaging.
+ *
+ * @param {...object} queries queries to merge
+ * @returns {object} merged query
+ */
+function mergeQueries(...queries) {
+  const merged = {
+    kind: 'Document',
+    definitions: [
+      {
+        directives: [],
+        operation: 'query',
+        variableDefinitions: [],
+        kind: 'OperationDefinition',
+        selectionSet: { kind: 'SelectionSet', selections: [] },
+      },
+    ],
+  }
+
+  queries.forEach(query => {
+    const parsedQuery = query
+    parsedQuery.definitions.forEach(definition => {
+      merged.definitions[0].directives = [
+        ...merged.definitions[0].directives,
+        ...definition.directives,
+      ]
+
+      merged.definitions[0].variableDefinitions = [
+        ...merged.definitions[0].variableDefinitions,
+        ...definition.variableDefinitions,
+      ]
+
+      merged.definitions[0].selectionSet.selections = [
+        ...merged.definitions[0].selectionSet.selections,
+        ...definition.selectionSet.selections,
+      ]
+    })
+  })
+
+  return merged
+}
+
+module.exports = { mergeQueries }

core/base-service/graphql.spec.js

@@ -0,0 +1,94 @@
+'use strict'
+
+const { expect } = require('chai')
+const gql = require('graphql-tag')
+const { print } = require('graphql/language/printer')
+const { mergeQueries } = require('./graphql')
+
+require('../register-chai-plugins.spec')
+
+describe('mergeQueries function', function () {
+  it('merges valid gql queries', function () {
+    expect(
+      print(
+        mergeQueries(
+          gql`
+            query($param: String!) {
+              foo(param: $param) {
+                bar
+              }
+            }
+          `
+        )
+      )
+    ).to.equalIgnoreSpaces(
+      'query ($param: String!) { foo(param: $param) { bar } }'
+    )
+
+    expect(
+      print(
+        mergeQueries(
+          gql`
+            query($param: String!) {
+              foo(param: $param) {
+                bar
+              }
+            }
+          `,
+          gql`
+            query {
+              baz
+            }
+          `
+        )
+      )
+    ).to.equalIgnoreSpaces(
+      'query ($param: String!) { foo(param: $param) { bar } baz }'
+    )
+
+    expect(
+      print(
+        mergeQueries(
+          gql`
+            query {
+              foo
+            }
+          `,
+          gql`
+            query {
+              bar
+            }
+          `,
+          gql`
+            query {
+              baz
+            }
+          `
+        )
+      )
+    ).to.equalIgnoreSpaces('{ foo bar baz }')
+
+    expect(
+      print(
+        mergeQueries(
+          gql`
+            {
+              foo
+            }
+          `,
+          gql`
+            {
+              bar
+            }
+          `
+        )
+      )
+    ).to.equalIgnoreSpaces('{ foo bar }')
+  })
+
+  it('throws an error when passed invalid params', function () {
+    expect(() => mergeQueries('', '')).to.throw(Error)
+    expect(() => mergeQueries(undefined, 17, true)).to.throw(Error)
+    expect(() => mergeQueries(gql``, gql`foo`)).to.throw(Error)
+  })
+})

core/base-service/index.js

@@ -2,7 +2,7 @@
 
 const BaseService = require('./base')
 const BaseJsonService = require('./base-json')
-const NonMemoryCachingBaseService = require('./base-non-memory-caching')
+const BaseGraphqlService = require('./base-graphql')
 const BaseStaticService = require('./base-static')
 const BaseSvgScrapingService = require('./base-svg-scraping')
 const BaseXmlService = require('./base-xml')
@@ -20,7 +20,7 @@ const {
 module.exports = {
   BaseService,
   BaseJsonService,
-  NonMemoryCachingBaseService,
+  BaseGraphqlService,
   BaseStaticService,
   BaseSvgScrapingService,
   BaseXmlService,

core/base-service/json.js

@@ -0,0 +1,28 @@
+'use strict'
+
+// See available emoji at http://emoji.muan.co/
+const emojic = require('emojic')
+const { InvalidResponse } = require('./errors')
+const trace = require('./trace')
+
+function parseJson(buffer) {
+  const logTrace = (...args) => trace.logTrace('fetch', ...args)
+  let json
+  try {
+    json = JSON.parse(buffer)
+  } catch (err) {
+    logTrace(emojic.dart, 'Response JSON (unparseable)', buffer)
+    throw new InvalidResponse({
+      prettyMessage: 'unparseable json response',
+      underlyingError: err,
+    })
+  }
+  logTrace(emojic.dart, 'Response JSON (before validation)', json, {
+    deep: true,
+  })
+  return json
+}
+
+module.exports = {
+  parseJson,
+}