Changelog for Release server-2021-06-01 (#6565)

* Update Changelog

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

.circleci/config.yml

@@ -86,33 +86,6 @@ services_steps: &services_steps
     - 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
-
-    # install the shields.io dependencies
-    npm ci
-
-    # run the package tests
-    npm run test:package
-    npm run check-types:package
-
-    # delete the sheilds.io dependencies
-    rm -rf node_modules/
-
-    # run a smoke test (render a badge with the CLI)
-    # with only the package dependencies installed
-    cd badge-maker
-    npm link
-    badge cactus grown :green @flat
-
 package_steps: &package_steps
   steps:
     - checkout
@@ -129,79 +102,68 @@ package_steps: &package_steps
 
     # Run the package tests on each currently supported node version. See:
     # 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/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/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:
-        <<: *run_package_tests
         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:10
-    steps:
-      - checkout
-
-      - run:
-          name: Install dependencies
-          command: npm ci
-          environment:
-            CYPRESS_INSTALL_BINARY: 0
-
   main:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
 
     <<: *main_steps
 
-  main@node-12:
+  main@node-14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
 
     <<: *main_steps
 
   integration:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
       - image: redis
 
     <<: *integration_steps
 
-  integration@node-12:
+  integration@node-14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
       - image: redis
 
     <<: *integration_steps
 
   danger:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
     steps:
       - checkout
 
@@ -221,7 +183,7 @@ jobs:
 
   frontend:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
     steps:
       - checkout
 
@@ -262,13 +224,13 @@ jobs:
 
   services:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
 
     <<: *services_steps
 
-  services@node-12:
+  services@node-14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
 
     <<: *services_steps
 
@@ -323,11 +285,11 @@ workflows:
           filters:
             branches:
               ignore: gh-pages
-      - main@node-12:
+      - main@node-14:
           filters:
             branches:
               ignore: gh-pages
-      - integration@node-12:
+      - integration@node-14:
           filters:
             branches:
               ignore: gh-pages
@@ -345,7 +307,7 @@ workflows:
               ignore:
                 - master
                 - gh-pages
-      - services@node-12:
+      - services@node-14:
           filters:
             branches:
               ignore:

.dependabot/config.yml

@@ -14,9 +14,6 @@ update_configs:
       - match:
           dependency_name: 'eslint*'
           update_type: 'semver:minor'
-      - match:
-          dependency_name: 'enzyme*'
-          update_type: 'semver:minor'
       - match:
           dependency_name: 'mocha*'
           update_type: 'semver:minor'
@@ -34,3 +31,8 @@ update_configs:
   - package_manager: 'javascript'
     directory: '/badge-maker'
     update_schedule: 'weekly'
+
+  # approve-bot package dependencies
+  - package_manager: 'javascript'
+    directory: '.github/actions/approve-bot'
+    update_schedule: 'weekly'

.eslintignore

@@ -4,3 +4,4 @@
 /__snapshots__
 /public
 badge-maker/node_modules/
+!.github/

.eslintrc.yml

@@ -1,13 +1,14 @@
 extends:
   - standard
+  - standard-jsx
   - standard-react
   - plugin:@typescript-eslint/recommended
   - prettier
-  - prettier/@typescript-eslint
-  - prettier/standard
-  - prettier/react
   - eslint:recommended
 
+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.
@@ -42,6 +43,7 @@ overrides:
       es6: true
     rules:
       no-console: 'off'
+      '@typescript-eslint/explicit-module-boundary-types': 'off'
 
   - files:
       - '**/*.@(ts|tsx)'
@@ -57,6 +59,7 @@ overrides:
       '@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
@@ -124,6 +127,9 @@ rules:
 
   '@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.
   no-extra-semi: 'off'
 
@@ -140,6 +146,20 @@ rules:
   new-cap: ['error', { 'capIsNew': true }]
   import/order: ['error', { 'newlines-between': 'never' }]
 
+  # 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'

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,7 @@
 contact_links:
-  - name: Support Question
+  - 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,68 @@
+'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 isPointlessVersionBump(body) {
+  const pointlessBumpLinks = [
+    'https://github.com/gatsbyjs/gatsby',
+    'https://github.com/typescript-eslint/typescript-eslint',
+  ]
+
+  const lines = body.split(/\r?\n/)
+  if (!pointlessBumpLinks.some(link => lines[0].includes(link))) {
+    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 = { isPointlessVersionBump, shouldAutoMerge }

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

@@ -0,0 +1,56 @@
+'use strict'
+
+const core = require('@actions/core')
+const github = require('@actions/github')
+const { isPointlessVersionBump, 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 (isPointlessVersionBump(pr.body)) {
+        core.debug(`Closing pull request #${pr.number}`)
+        await client.rest.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.rest.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.rest.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,170 @@
+{
+  "name": "approve-bot",
+  "version": "0.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "@actions/core": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.3.0.tgz",
+      "integrity": "sha512-xxtX0Cwdhb8LcgatfJkokqT8KzPvcIbwL9xpLU09nOwBzaStbfm0dNncsP0M4us+EpoPdWy7vbzU5vSOH7K6pg=="
+    },
+    "@actions/github": {
+      "version": "5.0.0",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.0.tgz",
+      "integrity": "sha512-QvE9eAAfEsS+yOOk0cylLBIO/d6WyWIOvsxxzdrPFaud39G6BOkUwScXZn1iBzQzHyu9SBkkLSWlohDWdsasAQ==",
+      "requires": {
+        "@actions/http-client": "^1.0.11",
+        "@octokit/core": "^3.4.0",
+        "@octokit/plugin-paginate-rest": "^2.13.3",
+        "@octokit/plugin-rest-endpoint-methods": "^5.1.1"
+      }
+    },
+    "@actions/http-client": {
+      "version": "1.0.11",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
+      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
+      "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.4.0",
+      "resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.4.0.tgz",
+      "integrity": "sha512-6/vlKPP8NF17cgYXqucdshWqmMZGXkuvtcrWCgU5NOI0Pl2GjlmZyWgBMrU8zJ3v2MJlM6++CiB45VKYmhiWWg==",
+      "requires": {
+        "@octokit/auth-token": "^2.4.4",
+        "@octokit/graphql": "^4.5.8",
+        "@octokit/request": "^5.4.12",
+        "@octokit/request-error": "^2.0.5",
+        "@octokit/types": "^6.0.3",
+        "before-after-hook": "^2.2.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.6.2",
+      "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.6.2.tgz",
+      "integrity": "sha512-WmsIR1OzOr/3IqfG9JIczI8gMJUMzzyx5j0XXQ4YihHtKlQc+u35VpVoOXhlKAlaBntvry1WpAzPl/a+s3n89Q==",
+      "requires": {
+        "@octokit/request": "^5.3.0",
+        "@octokit/types": "^6.0.3",
+        "universal-user-agent": "^6.0.0"
+      }
+    },
+    "@octokit/openapi-types": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.0.0.tgz",
+      "integrity": "sha512-gV/8DJhAL/04zjTI95a7FhQwS6jlEE0W/7xeYAzuArD0KVAVWDLP2f3vi98hs3HLTczxXdRK/mF0tRoQPpolEw=="
+    },
+    "@octokit/plugin-paginate-rest": {
+      "version": "2.13.3",
+      "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.13.3.tgz",
+      "integrity": "sha512-46lptzM9lTeSmIBt/sVP/FLSTPGx6DCzAdSX3PfeJ3mTf4h9sGC26WpaQzMEq/Z44cOcmx8VsOhO+uEgE3cjYg==",
+      "requires": {
+        "@octokit/types": "^6.11.0"
+      }
+    },
+    "@octokit/plugin-rest-endpoint-methods": {
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.1.1.tgz",
+      "integrity": "sha512-u4zy0rVA8darm/AYsIeWkRalhQR99qPL1D/EXHejV2yaECMdHfxXiTXtba8NMBSajOJe8+C9g+EqMKSvysx0dg==",
+      "requires": {
+        "@octokit/types": "^6.14.1",
+        "deprecation": "^2.3.1"
+      }
+    },
+    "@octokit/request": {
+      "version": "5.4.15",
+      "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.15.tgz",
+      "integrity": "sha512-6UnZfZzLwNhdLRreOtTkT9n57ZwulCve8q3IT/Z477vThu6snfdkBuhxnChpOKNGxcQ71ow561Qoa6uqLdPtag==",
+      "requires": {
+        "@octokit/endpoint": "^6.0.1",
+        "@octokit/request-error": "^2.0.0",
+        "@octokit/types": "^6.7.1",
+        "is-plain-object": "^5.0.0",
+        "node-fetch": "^2.6.1",
+        "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.14.2",
+      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.14.2.tgz",
+      "integrity": "sha512-wiQtW9ZSy4OvgQ09iQOdyXYNN60GqjCL/UdMsepDr1Gr0QzpW6irIKbH3REuAHXAhxkEk9/F2a3Gcs1P6kW5jA==",
+      "requires": {
+        "@octokit/openapi-types": "^7.0.0"
+      }
+    },
+    "before-after-hook": {
+      "version": "2.2.1",
+      "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.1.tgz",
+      "integrity": "sha512-/6FKxSTWoJdbsLDF8tdIjaRiFXiE6UHsEHE3OPI/cwPURCVi1ukP0gmLn7XWEiFk5TcwQjjY5PWsU+j+tgXgmw=="
+    },
+    "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.3.0",
+    "@actions/github": "^5.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

@@ -5,6 +5,12 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: chris48s/approve-bot@1.0.0
+      - 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 }}

.nycrc.json

@@ -10,6 +10,7 @@
     "**/*-test-helpers.js",
     "**/*-fixtures.js",
     "**/mocha-*.js",
+    "**/*.test-d.ts",
     "dangerfile.js",
     "gatsby-*.js",
     "core/service-test-runner",

.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,63 @@
+# 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-06-01
+
+- Changed creating badges to open a new Window/Tab [#6536](https://github.com/badges/shields/issues/6536)
+- Make for-the-badge letter spacing more predictable, and rewrite layout logic [#5754](https://github.com/badges/shields/issues/5754)
+- deprecate DockerBuild service [#6529](https://github.com/badges/shields/issues/6529)
+- Remove rate limiting functionality [#6513](https://github.com/badges/shields/issues/6513)
+- [GitHub] Move to 'funding' category [#5846](https://github.com/badges/shields/issues/5846)
+- Add GitHub discussions total badge [GithubTotalDiscussions] [#6472](https://github.com/badges/shields/issues/6472)
+- Add optional query parameter (include_prereleases) to [GemVersion] [#6451](https://github.com/badges/shields/issues/6451)
+- Add [PingPong] Service [#6327](https://github.com/badges/shields/issues/6327)
+- Dependency updates
+
+## 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

@@ -98,11 +98,18 @@ 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
 
@@ -124,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.
@@ -146,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,4 +1,4 @@
-FROM node:10-alpine
+FROM node:12-alpine
 
 RUN mkdir -p /usr/src/app
 RUN mkdir /usr/src/app/private

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,5 +1,5 @@
 <p align="center">
-    <img src="https://raw.githubusercontent.com/badges/shields/master/frontend/images/logo.svg?sanitize=true"
+    <img src="https://raw.githubusercontent.com/badges/shields/master/readme-logo.svg?sanitize=true"
         height="130">
 </p>
 <p align="center">
@@ -22,9 +22,6 @@
     <a href="https://lgtm.com/projects/g/badges/shields/alerts/">
         <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?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?logo=discord"
             alt="chat on Discord"></a>
@@ -38,7 +35,13 @@ 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:
 
@@ -70,10 +73,14 @@ This repo hosts:
 [Make your own badges!][custom badges]
 (Quick example: `https://img.shields.io/badge/left-right-f39f37`)
 
-Browse a [complete list of badges][shields.io].
-
 [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)](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.
@@ -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]).
 
@@ -202,10 +209,10 @@ Alumni:
 
 ## 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

badge-maker/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 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

badge-maker/lib/badge-renderers.js

@@ -1,42 +1,38 @@
 'use strict'
 
 const anafanafo = require('anafanafo')
+const { brightness } = require('./color')
+const { XmlElement, escapeXml } = require('./xml')
 
-const fontFamily = 'font-family="Verdana,Geneva,DejaVu Sans,sans-serif"'
+// https://github.com/badges/shields/pull/1132
+const FONT_SCALE_UP_FACTOR = 10
+const FONT_SCALE_DOWN_VALUE = 'scale(.1)'
+
+const FONT_FAMILY = 'Verdana,Geneva,DejaVu Sans,sans-serif'
+const fontFamily = `font-family="${FONT_FAMILY}"`
 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 escapeXml(s) {
-  if (s === undefined || typeof s !== 'string') {
-    return undefined
+function colorsForBackground(color) {
+  if (brightness(color) <= brightnessThreshold) {
+    return { textColor: '#fff', shadowColor: '#010101' }
   } else {
-    return s
-      .replace(/&/g, '&amp;')
-      .replace(/</g, '&lt;')
-      .replace(/>/g, '&gt;')
-      .replace(/"/g, '&quot;')
-      .replace(/'/g, '&apos;')
+    return { textColor: '#333', shadowColor: '#ccc' }
   }
 }
 
 function roundUpToOdd(val) {
-  // Increase chances of pixel grid alignment.
   return val % 2 === 0 ? val + 1 : val
 }
 
-function preferredWidthOf(str) {
-  return roundUpToOdd((anafanafo(str) / 10) | 0)
-}
-
-function computeWidths({ label, message }) {
-  return {
-    labelWidth: preferredWidthOf(label),
-    messageWidth: preferredWidthOf(message),
-  }
+function preferredWidthOf(str, options) {
+  // Increase chances of pixel grid alignment.
+  return roundUpToOdd(anafanafo(str, options) | 0)
 }
 
 function createAccessibleText({ label, message }) {
@@ -74,22 +70,19 @@ function renderLogo({
   logoWidth = 14,
   logoPadding = 0,
 }) {
-  if (!logo) {
+  if (logo) {
+    const logoHeight = 14
+    const y = (badgeHeight - logoHeight) / 2
+    const x = horizPadding
     return {
-      hasLogo: false,
-      totalLogoWidth: 0,
-      renderedLogo: '',
+      hasLogo: true,
+      totalLogoWidth: logoWidth + logoPadding,
+      renderedLogo: `<image x="${x}" y="${y}" width="${logoWidth}" height="${logoHeight}" xlink:href="${escapeXml(
+        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="14" xlink:href="${escapeXml(
-      logo
-    )}"/>`,
+  } else {
+    return { hasLogo: false, totalLogoWidth: 0, renderedLogo: '' }
   }
 }
 
@@ -118,12 +111,13 @@ function renderText({
   height,
   verticalMargin = 0,
   shadow = false,
+  color,
 }) {
   if (!content.length) {
     return { renderedText: '', width: 0 }
   }
 
-  const textLength = preferredWidthOf(content)
+  const textLength = preferredWidthOf(content, { font: '11px Verdana' })
   const escapedContent = escapeXml(content)
 
   const shadowMargin = 150 + verticalMargin
@@ -133,10 +127,11 @@ function renderText({
   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="#010101" fill-opacity=".3" transform="scale(.1)" textLength="${outTextLength}">${escapedContent}</text>`
+    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="#fff" textLength="${outTextLength}">${escapedContent}</text>`
+  renderedText += `<text x="${x}" y="${textMargin}" transform="scale(.1)" fill="${textColor}" textLength="${outTextLength}">${escapedContent}</text>`
 
   return {
     renderedText: link
@@ -174,10 +169,6 @@ function renderBadge(
     </svg>`
 }
 
-function stripXmlWhitespace(xml) {
-  return xml.replace(/>\s+/g, '>').replace(/<\s+/g, '<').trim()
-}
-
 class Badge {
   static get fontFamily() {
     throw new Error('Not implemented')
@@ -234,6 +225,7 @@ class Badge {
       height: this.constructor.height,
       verticalMargin: this.constructor.verticalMargin,
       shadow: this.constructor.shadow,
+      color: labelColor,
     })
 
     const leftWidth = hasLabel
@@ -257,6 +249,7 @@ class Badge {
       height: this.constructor.height,
       verticalMargin: this.constructor.verticalMargin,
       shadow: this.constructor.shadow,
+      color,
     })
 
     let rightWidth = messageWidth + 2 * horizPadding
@@ -282,6 +275,10 @@ class Badge {
     this.renderedMessage = renderedMessage
   }
 
+  static render(params) {
+    return new this(params).render()
+  }
+
   render() {
     throw new Error('Not implemented')
   }
@@ -432,30 +429,6 @@ class FlatSquare extends Badge {
   }
 }
 
-function plastic(params) {
-  const badge = new Plastic(params)
-  if (params.minify) {
-    return stripXmlWhitespace(badge.render())
-  }
-  return badge.render()
-}
-
-function flat(params) {
-  const badge = new Flat(params)
-  if (params.minify) {
-    return stripXmlWhitespace(badge.render())
-  }
-  return badge.render()
-}
-
-function flatSquare(params) {
-  const badge = new FlatSquare(params)
-  if (params.minify) {
-    return stripXmlWhitespace(badge.render())
-  }
-  return badge.render()
-}
-
 function social({
   label,
   message,
@@ -465,7 +438,6 @@ function social({
   logoPadding,
   color = '#4c1',
   labelColor = '#555',
-  minify,
 }) {
   // Social label is styled with a leading capital. Convert to caps here so
   // width can be measured using the correct characters.
@@ -473,24 +445,23 @@ function social({
 
   const externalHeight = 20
   const internalHeight = 19
-  const horizPadding = 5
+  const labelHorizPadding = 5
+  const messageHorizPadding = 4
+  const horizGutter = 6
   const { totalLogoWidth, renderedLogo } = renderLogo({
     logo,
     badgeHeight: externalHeight,
-    horizPadding,
+    horizPadding: labelHorizPadding,
     logoWidth,
     logoPadding,
   })
   const hasMessage = message.length
 
-  let { labelWidth, messageWidth } = computeWidths({ label, message })
-  labelWidth += 10 + totalLogoWidth
-  messageWidth += 10
-  messageWidth -= 4
-
-  const labelTextX = ((labelWidth + totalLogoWidth) / 2) * 10
-  const labelTextLength = (labelWidth - (10 + totalLogoWidth)) * 10
-  const escapedLabel = escapeXml(label)
+  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)
@@ -500,29 +471,35 @@ function social({
   const accessibleText = createAccessibleText({ label, message })
 
   function renderMessageBubble() {
-    const messageBubbleMainX = labelWidth + 6.5
-    const messageBubbleNotchX = labelWidth + 6
+    const messageBubbleMainX = labelRectWidth + horizGutter + 0.5
+    const messageBubbleNotchX = labelRectWidth + horizGutter
     return `
-      <rect x="${messageBubbleMainX}" y="0.5" width="${messageWidth}" height="${internalHeight}" rx="2" fill="#fafafa"/>
+      <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 rect = `<rect id="llink" stroke="#d5d5d5" fill="url(#a)" x=".5" y=".5" width="${labelWidth}" height="${internalHeight}" rx="2" />`
+    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>`
-    if (hasLeftLink && !shouldWrapBodyWithLink({ links })) {
-      return `
+
+    return shouldWrapWithLink
+      ? `
         <a target="_blank" xlink:href="${leftLink}">
           ${shadow}
           ${text}
           ${rect}
         </a>
       `
-    }
-    return `
+      : `
       ${rect}
       ${shadow}
       ${text}
@@ -530,34 +507,36 @@ function social({
   }
 
   function renderMessageText() {
-    const messageTextX = (labelWidth + messageWidth / 2 + 6) * 10
-    const messageTextLength = (messageWidth - 8) * 10
+    const messageTextX =
+      10 * (labelRectWidth + horizGutter + messageRectWidth / 2)
+    const messageTextLength = 10 * messageTextWidth
     const escapedMessage = escapeXml(message)
-    const rect = `<rect width="${messageWidth + 1}" x="${
-      labelWidth + 6
+
+    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>`
-    if (hasRightLink) {
-      return `
+
+    return hasRightLink
+      ? `
         <a target="_blank" xlink:href="${rightLink}">
           ${rect}
           ${shadow}
           ${text}
         </a>
       `
-    }
-    return `
+      : `
       ${shadow}
       ${text}
     `
   }
 
-  const badge = renderBadge(
+  return renderBadge(
     {
       links,
-      leftWidth: labelWidth + 1,
-      rightWidth: hasMessage ? messageWidth + 6 : 0,
+      leftWidth: labelRectWidth + 1,
+      rightWidth: hasMessage ? horizGutter + messageRectWidth : 0,
       accessibleText,
       height: externalHeight,
     },
@@ -572,7 +551,7 @@ function social({
       <stop offset="1" stop-opacity=".1"/>
     </linearGradient>
     <g stroke="#d5d5d5">
-      <rect stroke="none" fill="#fcfcfc" x="0.5" y="0.5" width="${labelWidth}" height="${internalHeight}" rx="2"/>
+      <rect stroke="none" fill="#fcfcfc" x="0.5" y="0.5" width="${labelRectWidth}" height="${internalHeight}" rx="2"/>
       ${hasMessage ? renderMessageBubble() : ''}
     </g>
     ${renderedLogo}
@@ -582,11 +561,6 @@ function social({
     </g>
     `
   )
-
-  if (minify) {
-    return stripXmlWhitespace(badge)
-  }
-  return badge
 }
 
 function forTheBadge({
@@ -595,120 +569,239 @@ function forTheBadge({
   links,
   logo,
   logoWidth,
-  logoPadding,
   color = '#4c1',
   labelColor,
-  minify,
 }) {
-  // For the Badge is styled in all caps. Convert to caps here so widths can
-  // be measured using the correct characters.
+  const FONT_SIZE = 10
+  const BADGE_HEIGHT = 28
+  const LOGO_HEIGHT = 14
+  const TEXT_MARGIN = 12
+  const LOGO_MARGIN = 9
+  const LOGO_TEXT_GUTTER = 6
+  const LETTER_SPACING = 1.25
+
+  // Prepare content. For the Badge is styled in all caps. It's important to to
+  // convert to uppercase first so the widths can be measured using the correct
+  // symbols.
   label = label.toUpperCase()
   message = message.toUpperCase()
 
-  let { labelWidth, messageWidth } = computeWidths({ label, message })
-  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) {
-    labelWidth += 10 + label.length * 1.5
-  } else if (hasLogo) {
-    if (hasLabel) {
-      labelWidth += 7
-    } else {
-      labelWidth -= 7
-    }
-  } else {
-    labelWidth -= 11
-  }
-
-  messageWidth += 10
-  messageWidth += 10 + message.length * 2
-  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 [leftLink, rightLink] = links
   const { hasLeftLink, hasRightLink } = hasLinks({ links })
 
-  const accessibleText = createAccessibleText({ label, message })
+  const outLabelColor = labelColor || '#555'
+
+  // Compute text width.
+  // TODO: This really should count the symbols rather than just using `.length`.
+  // https://mathiasbynens.be/notes/javascript-unicode
+  // This is not using `preferredWidthOf()` as it tends to produce larger
+  // inconsistencies in the letter spacing. The badges look fine, however if you
+  // replace `textLength` with `letterSpacing` in the rendered SVG, you can see
+  // the discrepancy. Ideally, swapping out `textLength` for `letterSpacing`
+  // should not affect the appearance.
+  const labelTextWidth = label.length
+    ? (anafanafo(label, { font: `${FONT_SIZE}px Verdana` }) | 0) +
+      LETTER_SPACING * label.length
+    : 0
+  const messageTextWidth = message.length
+    ? (anafanafo(message, { font: `bold ${FONT_SIZE}px Verdana` }) | 0) +
+      LETTER_SPACING * message.length
+    : 0
+
+  // Compute horizontal layout.
+  // If a `labelColor` is set, the logo is always set against it, even when
+  // there is no label. When `needsLabelRect` is true, render a label rect and a
+  // message rect; when false, only a message rect.
+  const hasLabel = Boolean(label.length)
+  const needsLabelRect = hasLabel || (logo && labelColor)
+  let logoMinX, labelTextMinX
+  if (logo) {
+    logoMinX = LOGO_MARGIN
+    labelTextMinX = logoMinX + logoWidth + LOGO_TEXT_GUTTER
+  } else {
+    labelTextMinX = TEXT_MARGIN
+  }
+  let labelRectWidth, messageTextMinX, messageRectWidth
+  if (needsLabelRect) {
+    if (hasLabel) {
+      labelRectWidth = labelTextMinX + labelTextWidth + TEXT_MARGIN
+    } else {
+      labelRectWidth = 2 * LOGO_MARGIN + logoWidth
+    }
+    messageTextMinX = labelRectWidth + TEXT_MARGIN
+    messageRectWidth = 2 * TEXT_MARGIN + messageTextWidth
+  } else {
+    if (logo) {
+      messageTextMinX = TEXT_MARGIN + logoWidth + LOGO_TEXT_GUTTER
+      messageRectWidth =
+        2 * TEXT_MARGIN + logoWidth + LOGO_TEXT_GUTTER + messageTextWidth
+    } else {
+      messageTextMinX = TEXT_MARGIN
+      messageRectWidth = 2 * TEXT_MARGIN + messageTextWidth
+    }
+  }
+
+  const logoElement = new XmlElement({
+    name: 'image',
+    attrs: {
+      x: logoMinX,
+      y: 0.5 * (BADGE_HEIGHT - LOGO_HEIGHT),
+      width: logoWidth,
+      height: LOGO_HEIGHT,
+      'xlink:href': logo,
+    },
+  })
+
+  function getLabelElement() {
+    const { textColor } = colorsForBackground(outLabelColor)
+    const midX = labelTextMinX + 0.5 * labelTextWidth
+    const text = new XmlElement({
+      name: 'text',
+      content: [label],
+      attrs: {
+        transform: FONT_SCALE_DOWN_VALUE,
+        x: FONT_SCALE_UP_FACTOR * midX,
+        y: 175,
+        textLength: FONT_SCALE_UP_FACTOR * labelTextWidth,
+        fill: textColor,
+      },
+    })
 
-  function renderLabelText() {
-    const labelTextX = ((labelWidth + totalLogoWidth) / 2) * 10
-    const labelTextLength = (labelWidth - (24 + totalLogoWidth)) * 10
-    const escapedLabel = escapeXml(label)
-    const text = `<text fill="#fff" 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>
-      `
+      const rect = new XmlElement({
+        name: 'rect',
+        attrs: {
+          width: labelRectWidth,
+          height: BADGE_HEIGHT,
+          fill: 'rgba(0,0,0,0)',
+        },
+      })
+      return new XmlElement({
+        name: 'a',
+        content: [rect, text],
+        attrs: {
+          target: '_blank',
+          'xlink:href': leftLink,
+        },
+      })
+    } else {
+      return text
     }
-    return text
   }
 
-  function renderMessageText() {
-    const text = `<text fill="#fff" x="${
-      (labelWidth + messageWidth / 2) * 10
-    }" y="175" font-weight="bold" transform="scale(.1)" textLength="${
-      (messageWidth - 24) * 10
-    }">
-      ${escapeXml(message)}</text>`
+  function getMessageElement() {
+    const { textColor } = colorsForBackground(color)
+    const midX = messageTextMinX + 0.5 * messageTextWidth
+    const text = new XmlElement({
+      name: 'text',
+      content: [message],
+      attrs: {
+        transform: FONT_SCALE_DOWN_VALUE,
+        x: FONT_SCALE_UP_FACTOR * midX,
+        y: 175,
+        textLength: FONT_SCALE_UP_FACTOR * messageTextWidth,
+        fill: textColor,
+        'font-weight': 'bold',
+      },
+    })
+
     if (hasRightLink) {
-      return `
-        <a target="_blank" xlink:href="${rightLink}">
-          <rect width="${rightWidth}" height="${height}" x="${labelWidth}" fill="rgba(0,0,0,0)"/>
-          ${text}
-        </a>
-      `
+      const rect = new XmlElement({
+        name: 'rect',
+        attrs: {
+          width: messageRectWidth,
+          height: BADGE_HEIGHT,
+          x: labelRectWidth || 0,
+          fill: 'rgba(0,0,0,0)',
+        },
+      })
+      return new XmlElement({
+        name: 'a',
+        content: [rect, text],
+        attrs: {
+          target: '_blank',
+          'xlink:href': rightLink,
+        },
+      })
+    } else {
+      return text
     }
-    return text
   }
 
-  const badge = renderBadge(
+  let backgroundContent
+  if (needsLabelRect) {
+    backgroundContent = [
+      new XmlElement({
+        name: 'rect',
+        attrs: {
+          width: labelRectWidth,
+          height: BADGE_HEIGHT,
+          fill: outLabelColor,
+        },
+      }),
+      new XmlElement({
+        name: 'rect',
+        attrs: {
+          x: labelRectWidth,
+          width: messageRectWidth,
+          height: BADGE_HEIGHT,
+          fill: color,
+        },
+      }),
+    ]
+  } else {
+    backgroundContent = [
+      new XmlElement({
+        name: 'rect',
+        attrs: {
+          width: messageRectWidth,
+          height: BADGE_HEIGHT,
+          fill: color,
+        },
+      }),
+    ]
+  }
+
+  const backgroundGroup = new XmlElement({
+    name: 'g',
+    content: backgroundContent,
+    attrs: {
+      'shape-rendering': 'crispEdges',
+    },
+  })
+  const foregroundGroup = new XmlElement({
+    name: 'g',
+    content: [
+      logo ? logoElement : '',
+      hasLabel ? getLabelElement() : '',
+      getMessageElement(),
+    ],
+    attrs: {
+      fill: '#fff',
+      'text-anchor': 'middle',
+      'font-family': FONT_FAMILY,
+      'text-rendering': 'geometricPrecision',
+      'font-size': FONT_SCALE_UP_FACTOR * FONT_SIZE,
+    },
+  })
+
+  // Render.
+  return renderBadge(
     {
       links,
-      leftWidth,
-      rightWidth,
-      accessibleText,
-      height,
+      leftWidth: labelRectWidth || 0,
+      rightWidth: messageRectWidth,
+      accessibleText: createAccessibleText({ label, message }),
+      height: BADGE_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>`
+    [backgroundGroup.render(), foregroundGroup.render()].join('')
   )
-
-  if (minify) {
-    return stripXmlWhitespace(badge)
-  }
-  return badge
 }
 
-module.exports = { plastic, flat, flatSquare, social, forTheBadge }
+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,6 +1,6 @@
 '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 `badge-maker/README.md`.
 const namedColors = {
@@ -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

@@ -51,14 +51,8 @@ function _clean(format) {
     }
   })
 
-  // convert "public" format to "internal" format
-  cleaned.text = [cleaned.label || '', cleaned.message]
-  delete cleaned.label
-  delete cleaned.message
-  if ('style' in cleaned) {
-    cleaned.template = cleaned.style
-    delete cleaned.style
-  }
+  // Legacy.
+  cleaned.label = cleaned.label || ''
 
   return cleaned
 }

badge-maker/lib/make-badge.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const camelcase = require('camelcase')
 const { normalizeColor, toSvgColor } = require('./color')
 const badgeRenderers = require('./badge-renderers')
+const { stripXmlWhitespace } = require('./xml')
 
 /*
 note: makeBadge() is fairly thinly wrapped so if we are making changes here
@@ -10,8 +10,9 @@ it is likely this will impact on the package's public interface in index.js
 */
 module.exports = function makeBadge({
   format,
-  template = 'flat',
-  text,
+  style = 'flat',
+  label,
+  message,
   color,
   labelColor,
   logo,
@@ -20,12 +21,8 @@ module.exports = function makeBadge({
   links = ['', ''],
 }) {
   // String coercion and whitespace removal.
-  text = text.map(value => `${value}`.trim())
-
-  const [label, message] = text
-
-  color = normalizeColor(color)
-  labelColor = normalizeColor(labelColor)
+  label = `${label}`.trim()
+  message = `${message}`.trim()
 
   // This ought to be the responsibility of the server, not `makeBadge`.
   if (format === 'json') {
@@ -33,32 +30,34 @@ module.exports = function makeBadge({
       label,
       message,
       logoWidth,
-      color,
-      labelColor,
+      // 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 methodName = camelcase(template)
-  if (!(methodName in badgeRenderers)) {
-    throw new Error(`Unknown template: '${template}'`)
+  const render = badgeRenderers[style]
+  if (!render) {
+    throw new Error(`Unknown badge style: '${style}'`)
   }
-  const render = badgeRenderers[methodName]
 
   logoWidth = +logoWidth || (logo ? 14 : 0)
 
-  return render({
-    label,
-    message,
-    links,
-    logo,
-    logoPosition,
-    logoWidth,
-    logoPadding: logo && label.length ? 3 : 0,
-    color: toSvgColor(color),
-    labelColor: toSvgColor(labelColor),
-    minify: true,
-  })
+  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

@@ -4,12 +4,18 @@ 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({
-      text: ['name', 'Bob'],
+      label: 'name',
+      message: 'Bob',
       [colorAttr]: color,
       format: 'json',
     })
@@ -34,10 +40,14 @@ describe('The badge generator', function () {
       ]).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.
@@ -53,12 +63,6 @@ describe('The badge generator', function () {
         // invalid hex
         given('#123red'), // contains letter above F
         given('#red'), // contains letter above F
-        // invalid rgb(a)
-        given('rgb(220,128,255,0.5)'), // has alpha
-        given('rgba(0,0,255)'), // no alpha
-        // invalid hsl(a)
-        given('hsl(360,50%,50%,0.5)'), // has alpha
-        given('hsla(0,50%,101%)'), // no alpha
         // neither a css named color nor colorscheme
         given('notacolor'),
         given('bluish'),
@@ -77,23 +81,26 @@ describe('The badge generator', function () {
 
   describe('SVG', function () {
     it('should produce SVG', function () {
-      const svg = makeBadge({ text: ['cactus', 'grown'], format: 'svg' })
-      expect(svg)
+      expect(makeBadge({ label: 'cactus', message: 'grown', format: 'svg' }))
         .to.satisfy(isSvg)
         .and.to.include('cactus')
         .and.to.include('grown')
     })
 
     it('should match snapshot', function () {
-      const svg = makeBadge({ text: ['cactus', 'grown'], format: 'svg' })
-      snapshot(svg)
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+      })
     })
   })
 
   describe('JSON', function () {
     it('should produce the expected JSON', function () {
       const json = makeBadge({
-        text: ['cactus', 'grown'],
+        label: 'cactus',
+        message: 'grown',
         format: 'json',
         links: ['https://example.com/', 'https://other.example.com/'],
       })
@@ -106,458 +113,471 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should replace undefined svg template with "flat"', function () {
+    it('should replace undefined svg badge style with "flat"', function () {
       const jsonBadgeWithUnknownStyle = makeBadge({
-        text: ['name', 'Bob'],
+        label: 'name',
+        message: 'Bob',
         format: 'svg',
       })
       const jsonBadgeWithDefaultStyle = makeBadge({
-        text: ['name', 'Bob'],
+        label: 'name',
+        message: 'Bob',
         format: 'svg',
-        template: 'flat',
+        style: 'flat',
       })
       expect(jsonBadgeWithUnknownStyle)
         .to.equal(jsonBadgeWithDefaultStyle)
         .and.to.satisfy(isSvg)
     })
 
-    it('should fail with unknown svg template', function () {
+    it('should fail with unknown svg badge style', function () {
       expect(() =>
         makeBadge({
-          text: ['name', 'Bob'],
+          label: 'name',
+          message: 'Bob',
           format: 'svg',
-          template: 'unknown_style',
+          style: 'unknown_style',
         })
-      ).to.throw(Error, "Unknown template: '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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      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 () {
-      const svg = makeBadge({
-        text: [1998, 1999],
-        format: 'svg',
-        template: 'for-the-badge',
-      })
-      expect(svg).to.include('1998').and.to.include('1999')
+      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 () {
-      const svg = makeBadge({
-        text: ['Label', '1 string'],
-        format: 'svg',
-        template: 'for-the-badge',
-      })
-      expect(svg).to.include('LABEL').and.to.include('1 STRING')
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      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 () {
-      const svg = makeBadge({
-        text: ['some-key', 'some-value'],
-        format: 'svg',
-        template: 'social',
-      })
-      expect(svg).to.include('Some-key').and.to.include('some-value')
+      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 () {
-      const svg = makeBadge({
-        text: ['', 'some-value'],
-        format: 'json',
-        template: 'social',
-      })
-      expect(svg).to.include('""').and.to.include('some-value')
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      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 () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      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 () {
-      const svg = makeBadge({
-        text: ['label', 'message'],
+      expectBadgeToMatchSnapshot({
+        label: 'label',
+        message: 'message',
         format: 'svg',
         logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
       })
-      snapshot(svg)
+    })
+  })
+
+  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/lib/xml.js

@@ -0,0 +1,76 @@
+/**
+ * @module
+ */
+
+'use strict'
+
+function stripXmlWhitespace(xml) {
+  return xml.replace(/>\s+/g, '>').replace(/<\s+/g, '<').trim()
+}
+
+function escapeXml(s) {
+  if (typeof s === 'number') {
+    return s
+  } else 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;')
+  }
+}
+
+/**
+ * Representation of an XML element
+ */
+class XmlElement {
+  /**
+   * Xml Element Constructor
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {string} attrs.name
+   *    Name of the XML tag
+   * @param {Array.<string|module:badge-maker/lib/xml-element~XmlElement>} [attrs.content=[]]
+   *    Array of objects to render inside the tag. content may contain a mix of
+   *    string and XmlElement objects. If content is `[]` or ommitted the
+   *    element will be rendered as a self-closing element.
+   * @param {object} [attrs.attrs={}]
+   *    Object representing the tag's attributes as name/value pairs
+   */
+  constructor({ name, content = [], attrs = {} }) {
+    this.name = name
+    this.content = content
+    this.attrs = attrs
+  }
+
+  /**
+   * Render the XML element to a string, applying appropriate escaping
+   *
+   * @returns {string} String representation of the XML element
+   */
+  render() {
+    const attrsStr = Object.entries(this.attrs)
+      .map(([k, v]) => ` ${k}="${escapeXml(v)}"`)
+      .join('')
+    if (this.content.length > 0) {
+      const content = this.content
+        .map(function (el) {
+          if (el instanceof XmlElement) {
+            return el.render()
+          } else {
+            return escapeXml(el)
+          }
+        })
+        .join(' ')
+      return stripXmlWhitespace(
+        `<${this.name}${attrsStr}>${content}</${this.name}>`
+      )
+    }
+    return stripXmlWhitespace(`<${this.name}${attrsStr}/>`)
+  }
+}
+
+module.exports = { escapeXml, stripXmlWhitespace, XmlElement }

badge-maker/lib/xml.spec.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const { test, given } = require('sazerac')
+const { XmlElement } = require('./xml')
+
+function testRender(params) {
+  return new XmlElement(params).render()
+}
+
+describe('XmlElement class', function () {
+  test(testRender, () => {
+    given({ name: 'tag' }).expect('<tag/>')
+
+    given({ name: 'tag', content: ['text'] }).expect('<tag>text</tag>')
+
+    given({
+      name: 'tag',
+      content: ['not xml>>>', 'text', new XmlElement({ name: 'xml' })],
+    }).expect('<tag>not xml&gt;&gt;&gt; text <xml/></tag>')
+
+    given({
+      name: 'nested1',
+      content: [
+        new XmlElement({
+          name: 'nested2',
+          content: [new XmlElement({ name: 'nested3' })],
+        }),
+      ],
+    }).expect('<nested1><nested2><nested3/></nested2></nested1>')
+
+    given({
+      name: 'tag',
+      attrs: {
+        int: 47,
+        text: 'text',
+        escape: '<escape me>',
+      },
+    }).expect('<tag int="47" text="text" escape="&lt;escape me&gt;"/>')
+
+    given({
+      name: 'tag',
+      content: ['text'],
+      attrs: {
+        int: 47,
+        text: 'text',
+        escape: '<escape me>',
+      },
+    }).expect('<tag int="47" text="text" escape="&lt;escape me&gt;">text</tag>')
+  })
+})

badge-maker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "badge-maker",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Shields.io badge library",
   "keywords": [
     "GitHub",
@@ -35,9 +35,8 @@
     "logo": "https://opencollective.com/opencollective/logo.txt"
   },
   "dependencies": {
-    "anafanafo": "^1.0.0",
-    "camelcase": "^6.0.0",
-    "is-css-color": "^1.0.0"
+    "anafanafo": "2.0.0",
+    "css-color-converter": "^2.0.0"
   },
   "scripts": {
     "test": "echo 'Run tests from parent dir'; false"

config/custom-environment-variables.yml

@@ -21,7 +21,7 @@ public:
     key: 'HTTPS_KEY'
     cert: 'HTTPS_CRT'
 
-  redirectUri: 'REDIRECT_URI'
+  redirectUrl: 'REDIRECT_URI'
 
   rasterUrl: 'RASTER_URL'
 
@@ -30,9 +30,6 @@ public:
       __name: 'ALLOWED_ORIGIN'
       __format: 'json'
 
-  persistence:
-    dir: 'PERSISTENCE_DIR'
-
   services:
     bitbucketServer:
       authorizedOrigins: 'BITBUCKET_SERVER_ORIGINS'
@@ -60,20 +57,20 @@ public:
   cacheHeaders:
     defaultCacheLengthSeconds: 'BADGE_MAX_AGE_SECONDS'
 
-  rateLimit: 'RATE_LIMIT'
-
   fetchLimit: 'FETCH_LIMIT'
 
-  shieldsProductionHerokuHacks: 'SHIELDS_PRODUCTION_HEROKU_HACKS'
+  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'

config/default.yml

@@ -16,9 +16,6 @@ public:
   cors:
     allowedOrigin: []
 
-  persistence:
-    dir: './private'
-
   services:
     github:
       baseUri: 'https://api.github.com/'
@@ -30,12 +27,13 @@ public:
   cacheHeaders:
     defaultCacheLengthSeconds: 120
 
-  rateLimit: true
-
   handleInternalErrors: true
 
   fetchLimit: '10MB'
 
-  shieldsProductionHerokuHacks: false
+  requestTimeoutSeconds: 120
+  requestTimeoutMaxAgeSeconds: 30
+
+  requireCloudflare: false
 
 private: {}

config/development.yml

@@ -5,6 +5,4 @@ public:
   cors:
     allowedOrigin: ['http://localhost:3000']
 
-  rateLimit: false
-
   handleInternalErrors: false

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

@@ -1,5 +1,6 @@
 private:
   # These are the keys which are set on the production servers.
+  discord_bot_token: ...
   gh_client_id: ...
   gh_client_secret: ...
   redis_url: ...

config/shields-io-production.yml

@@ -15,10 +15,4 @@ public:
   cors:
     allowedOrigin: ['http://shields.io', 'https://shields.io']
 
-  redirectUrl: 'https://shields.io/'
-
   rasterUrl: 'https://raster.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']

config/test.yml

@@ -3,8 +3,6 @@ public:
     address: 'localhost'
     port: 1111
 
-  rateLimit: false
-
   redirectUrl: 'http://frontend.example.test'
 
   rasterUrl: 'http://raster.example.test'

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

@@ -146,9 +146,11 @@ class AuthHelper {
     )
   }
 
-  get _bearerAuthHeader() {
+  _bearerAuthHeader(bearerKey) {
     const { _pass: pass } = this
-    return this.isConfigured ? { Authorization: `Bearer ${pass}` } : undefined
+    return this.isConfigured
+      ? { Authorization: `${bearerKey} ${pass}` }
+      : undefined
   }
 
   static _mergeHeaders(requestParams, headers) {
@@ -168,17 +170,21 @@ class AuthHelper {
     }
   }
 
-  withBearerAuthHeader(requestParams) {
+  withBearerAuthHeader(
+    requestParams,
+    bearerKey = 'Bearer' // lgtm [js/hardcoded-credentials]
+  ) {
     return this._withAnyAuth(requestParams, requestParams =>
-      this.constructor._mergeHeaders(requestParams, this._bearerAuthHeader)
+      this.constructor._mergeHeaders(
+        requestParams,
+        this._bearerAuthHeader(bearerKey)
+      )
     )
   }
 
   static _mergeQueryParams(requestParams, query) {
-    const {
-      options: { qs: existingQuery, ...restOptions } = {},
-      ...rest
-    } = requestParams
+    const { options: { qs: existingQuery, ...restOptions } = {}, ...rest } =
+      requestParams
     return {
       options: {
         qs: {

core/base-service/base-graphql.js

@@ -46,6 +46,9 @@ class BaseGraphqlService extends BaseService {
    *    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.
@@ -61,6 +64,7 @@ class BaseGraphqlService extends BaseService {
     variables = {},
     options = {},
     httpErrorMessages = {},
+    transformJson = data => data,
     transformErrors = defaultTransformErrors,
   }) {
     const mergedOptions = {
@@ -74,7 +78,7 @@ class BaseGraphqlService extends BaseService {
       options: mergedOptions,
       errorMessages: httpErrorMessages,
     })
-    const json = this._parseJson(buffer)
+    const json = transformJson(this._parseJson(buffer))
     if (json.errors) {
       const exception = transformErrors(json.errors)
       if (exception instanceof ShieldsRuntimeError) {

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const gql = require('graphql-tag')
 const sinon = require('sinon')
@@ -12,15 +12,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyGraphqlService extends BaseGraphqlService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestGraphql({

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const BaseJsonService = require('./base-json')
@@ -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({

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

@@ -1,74 +0,0 @@
-'use strict'
-
-const makeBadge = require('../../badge-maker/lib/make-badge')
-const BaseService = require('./base')
-const { MetricHelper } = require('./metric-helper')
-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, metricInstance }, serviceConfig) {
-    const { cacheHeaders: cacheHeaderConfig } = serviceConfig
-    const { _cacheLength: serviceDefaultCacheLengthSeconds } = this
-    const { regex, captureNames } = prepareRoute(this.route)
-
-    const metricHelper = MetricHelper.create({
-      metricInstance,
-      ServiceClass: this,
-    })
-
-    camp.route(regex, async (queryParams, match, end, ask) => {
-      const metricHandle = metricHelper.startRequest()
-
-      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] || '.svg').replace(/^\./, '')
-      badgeData.format = format
-
-      const svg = makeBadge(badgeData)
-
-      setCacheHeaders({
-        cacheHeaderConfig,
-        serviceDefaultCacheLengthSeconds,
-        queryParams,
-        res: ask.res,
-      })
-
-      makeSend(format, ask.res, end)(svg)
-
-      metricHandle.noteResponseSent()
-    })
-  }
-}

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

@@ -2,28 +2,17 @@
 
 const { expect } = require('chai')
 const sinon = require('sinon')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 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({
@@ -36,10 +25,7 @@ class DummySvgScrapingService extends BaseSvgScrapingService {
 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 () {
@@ -123,9 +109,7 @@ describe('BaseSvgScrapingService', function () {
 
     it('allows overriding the valueMatcher', async function () {
       class WithValueMatcher extends BaseSvgScrapingService {
-        static get route() {
-          return {}
-        }
+        static route = {}
 
         async handle() {
           return this._requestSvg({

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const BaseXmlService = require('./base-xml')
@@ -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({
@@ -57,9 +50,7 @@ describe('BaseXmlService', 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({

core/base-service/base-yaml.js

@@ -57,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

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const BaseYamlService = require('./base-yaml')
@@ -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({

core/base-service/base.js

@@ -5,7 +5,7 @@
 
 // See available emoji at http://emoji.muan.co/
 const emojic = require('emojic')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const log = require('../server/log')
 const { AuthHelper } = require('./auth-helper')
 const { MetricHelper, MetricNames } = require('./metric-helper')
@@ -90,9 +90,7 @@ class BaseService {
     throw new Error(`Category not set for ${this.name}`)
   }
 
-  static get isDeprecated() {
-    return false
-  }
+  static isDeprecated = false
 
   /**
    * Route to mount this service on
@@ -119,9 +117,7 @@ class BaseService {
    * @abstract
    * @type {module:core/base-service/base~Auth}
    */
-  static get auth() {
-    return undefined
-  }
+  static auth = undefined
 
   /**
    * Array of Example objects describing example URLs for this service.
@@ -139,9 +135,7 @@ class BaseService {
    * @abstract
    * @type {module:core/base-service/base~Example[]}
    */
-  static get examples() {
-    return []
-  }
+  static examples = []
 
   static get _cacheLength() {
     const cacheLengths = {
@@ -160,9 +154,7 @@ class BaseService {
    *
    * @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}`)
@@ -221,16 +213,25 @@ class BaseService {
 
   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 get enabledMetrics() {
-    return []
-  }
+  static enabledMetrics = []
 
   static isMetricEnabled(metricName) {
     return this.enabledMetrics.includes(metricName)

core/base-service/base.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const chai = require('chai')
 const { expect } = chai
 const sinon = require('sinon')
@@ -29,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 {
@@ -68,9 +55,7 @@ class DummyService extends BaseService {
 }
 
 class DummyServiceWithServiceResponseSizeMetricEnabled extends DummyService {
-  static get enabledMetrics() {
-    return [MetricNames.SERVICE_RESPONSE_SIZE]
-  }
+  static enabledMetrics = [MetricNames.SERVICE_RESPONSE_SIZE]
 }
 
 describe('BaseService', function () {
@@ -124,9 +109,7 @@ describe('BaseService', function () {
     })
 
     class WithRoute extends BaseService {
-      static get route() {
-        return {}
-      }
+      static route = {}
     }
     it('Should throw if handle() is not overridden', function () {
       return expect(WithRoute.invoke({}, {}, {})).to.be.rejectedWith(
@@ -346,7 +329,7 @@ describe('BaseService', function () {
   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)$/
+    const expectedRouteRegex = /^\/foo(?:\/([^\/#\?]+?))(|\.svg|\.json)$/
 
     let mockCamp
     let mockHandleRequest
@@ -370,10 +353,8 @@ describe('BaseService', function () {
     it('handles the request', async function () {
       expect(mockHandleRequest).to.have.been.calledOnce
 
-      const {
-        queryParams: serviceQueryParams,
-        handler: requestHandler,
-      } = mockHandleRequest.getCall(0).args[1]
+      const { queryParams: serviceQueryParams, handler: requestHandler } =
+        mockHandleRequest.getCall(0).args[1]
       expect(serviceQueryParams).to.deep.equal([
         'queryParamA',
         'legacyQueryParamA',
@@ -390,9 +371,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: 'flat',
+        style: 'flat',
         namedLogo: undefined,
         logo: undefined,
         logoWidth: undefined,
@@ -406,13 +388,8 @@ describe('BaseService', function () {
 
   describe('getDefinition', function () {
     it('returns the expected result', function () {
-      const {
-        category,
-        name,
-        isDeprecated,
-        route,
-        examples,
-      } = DummyService.getDefinition()
+      const { category, name, isDeprecated, route, examples } =
+        DummyService.getDefinition()
       expect({
         category,
         name,
@@ -479,9 +456,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',
@@ -528,14 +503,15 @@ describe('BaseService', function () {
         buffer: 'x'.repeat(65536 + 1),
         res: { statusCode: 200 },
       })
-      const serviceInstance = new DummyServiceWithServiceResponseSizeMetricEnabled(
-        { sendAndCacheRequest, metricHelper },
-        defaultConfig
-      )
+      const serviceInstance =
+        new DummyServiceWithServiceResponseSizeMetricEnabled(
+          { sendAndCacheRequest, metricHelper },
+          defaultConfig
+        )
 
       await serviceInstance._request({ url })
 
-      expect(register.getSingleMetricAsString('service_response_bytes'))
+      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'
         )
@@ -561,18 +537,16 @@ describe('BaseService', function () {
       await serviceInstance._request({ url })
 
       expect(
-        register.getSingleMetricAsString('service_response_bytes')
+        await register.getSingleMetricAsString('service_response_bytes')
       ).to.not.contain('service_response_bytes_bucket')
     })
   })
   describe('auth', function () {
     class AuthService extends DummyService {
-      static get auth() {
-        return {
-          passKey: 'myci_pass',
-          serviceKey: 'myci',
-          isRequired: true,
-        }
+      static auth = {
+        passKey: 'myci_pass',
+        serviceKey: 'myci',
+        isRequired: true,
       }
 
       async handle() {

core/base-service/cache-headers.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const assert = require('assert')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const coalesce = require('./coalesce')
 
 const serverStartTimeGMTString = new Date().toGMTString()

core/base-service/categories.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const categories = require('../../services/categories')
 
 const isRealCategory = Joi.equal(...categories.map(({ id }) => id)).required()

core/base-service/coalesce-badge.js

@@ -160,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,
@@ -179,7 +177,7 @@ module.exports = function coalesceBadge(
       serviceLabelColor,
       defaultLabelColor
     ),
-    template: style,
+    style,
     namedLogo,
     logo: logoSvgBase64,
     logoWidth,

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

@@ -7,63 +7,61 @@ 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',
-      ])
+      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'])
+      expect(coalesceBadge({}, {}, {}, { category: 'cat' })).to.include({
+        label: 'cat',
+      })
     })
 
     it('preserves an empty label', function () {
-      expect(
-        coalesceBadge({}, { label: '', message: '10k' }, {}).text
-      ).to.deep.equal(['', '10k'])
+      expect(coalesceBadge({}, { label: '', message: '10k' }, {})).to.include({
+        label: '',
+      })
     })
 
     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',
-      ])
+      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')
+      expect(coalesceBadge({}, {}, {})).to.include({ color: 'lightgrey' })
     })
 
     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 () {
@@ -73,21 +71,23 @@ describe('coalesceBadge', function () {
             { 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')
+      expect(coalesceBadge({}, { color: 'red' }, {})).to.include({
+        color: 'red',
+      })
     })
   })
 
@@ -97,20 +97,19 @@ describe('coalesceBadge', function () {
     })
 
     it('applies the service label color', function () {
-      expect(coalesceBadge({}, { labelColor: 'red' }, {}).labelColor).to.equal(
-        'red'
-      )
+      expect(coalesceBadge({}, { labelColor: 'red' }, {})).to.include({
+        labelColor: 'red',
+      })
     })
 
     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 () {
@@ -120,8 +119,8 @@ describe('coalesceBadge', function () {
           { color: 123 },
           { color: 'green' },
           {}
-        ).color
-      ).to.equal('123')
+        )
+      ).to.include({ color: '123' })
       // also expected for legacy name
       expect(
         coalesceBadge(
@@ -129,8 +128,8 @@ describe('coalesceBadge', function () {
           { colorB: 123 },
           { color: 'green' },
           {}
-        ).color
-      ).to.equal('123')
+        )
+      ).to.include({ color: '123' })
     })
   })
 
@@ -148,9 +147,9 @@ describe('coalesceBadge', function () {
     })
 
     it('applies the named logo', function () {
-      expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).namedLogo).to.equal(
-        'npm'
-      )
+      expect(coalesceBadge({}, { namedLogo: 'npm' }, {})).to.include({
+        namedLogo: 'npm',
+      })
       expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).logo).to.equal(
         getShieldsIcon({ name: 'npm' })
       ).and.not.to.be.empty
@@ -219,8 +218,8 @@ describe('coalesceBadge', 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 () {
@@ -230,35 +229,36 @@ describe('coalesceBadge', function () {
           { 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)
+      expect(coalesceBadge({ logoWidth: 20 }, {}, {})).to.include({
+        logoWidth: 20,
+      })
     })
 
     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)
+      expect(coalesceBadge({ logoPosition: -10 }, {}, {})).to.include({
+        logoPosition: -10,
+      })
     })
 
     it('applies the logo position', function () {
       expect(
         coalesceBadge({}, { namedLogo: 'npm', logoPosition: -10 }, {})
-          .logoPosition
-      ).to.equal(-10)
+      ).to.include({ logoPosition: -10 })
     })
   })
 
@@ -268,8 +268,7 @@ describe('coalesceBadge', function () {
         coalesceBadge(
           { link: 'https://circleci.com/gh/badges/daily-tests' },
           {
-            link:
-              'https://circleci.com/workflow-run/184ef3de-4836-4805-a2e4-0ceba099f92d',
+            link: 'https://circleci.com/workflow-run/184ef3de-4836-4805-a2e4-0ceba099f92d',
           },
           {}
         ).links
@@ -279,20 +278,24 @@ describe('coalesceBadge', function () {
 
   describe('Style', function () {
     it('falls back to flat with invalid style', function () {
-      expect(coalesceBadge({ style: 'pill' }, {}, {}).template).to.equal('flat')
-      expect(coalesceBadge({ style: 7 }, {}, {}).template).to.equal('flat')
-      expect(coalesceBadge({ style: undefined }, {}, {}).template).to.equal(
-        'flat'
-      )
+      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' }, {}, {}).template).to.equal(
-        'flat'
-      )
-      expect(
-        coalesceBadge({ style: 'popout-square' }, {}, {}).template
-      ).to.equal('flat-square')
+      expect(coalesceBadge({ style: 'popout' }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: 'popout-square' }, {}, {})).to.include({
+        style: 'flat-square',
+      })
     })
   })
 
@@ -300,8 +303,7 @@ describe('coalesceBadge', function () {
     it('overrides the cache length', function () {
       expect(
         coalesceBadge({ style: 'pill' }, { cacheSeconds: 123 }, {})
-          .cacheLengthSeconds
-      ).to.equal(123)
+      ).to.include({ cacheLengthSeconds: 123 })
     })
   })
 })

core/base-service/deprecated-service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const camelcase = require('camelcase')
 const BaseService = require('./base')
 const { isValidCategory } = require('./categories')
@@ -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/examples.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { pathToRegexp, compile } = require('path-to-regexp')
 const categories = require('../../services/categories')
 const coalesceBadge = require('./coalesce-badge')
@@ -124,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,

core/base-service/graphql.spec.js

@@ -13,7 +13,7 @@ describe('mergeQueries function', function () {
       print(
         mergeQueries(
           gql`
-            query($param: String!) {
+            query ($param: String!) {
               foo(param: $param) {
                 bar
               }
@@ -29,7 +29,7 @@ describe('mergeQueries function', function () {
       print(
         mergeQueries(
           gql`
-            query($param: String!) {
+            query ($param: String!) {
               foo(param: $param) {
                 bar
               }

core/base-service/index.js

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

core/base-service/legacy-request-handler.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const request = require('request')
-const queryString = require('query-string')
 const makeBadge = require('../../badge-maker/lib/make-badge')
 const { setCacheHeaders } = require('./cache-headers')
 const {
@@ -10,27 +9,10 @@ const {
   ShieldsRuntimeError,
 } = require('./errors')
 const { makeSend } = require('./legacy-result-sender')
-const LruCache = require('./lru-cache')
 const coalesceBadge = require('./coalesce-badge')
 
 const userAgent = 'Shields.io/2003a'
 
-// We avoid calling the vendor's server for computation of the information in a
-// number of badges.
-const minAccuracy = 0.75
-
-// The quotient of (vendor) data change frequency by badge request frequency
-// must be lower than this to trigger sending the cached data *before*
-// updating our data from the vendor's server.
-// Indeed, the accuracy of our badges are:
-// A(Δt) = 1 - min(# data change over Δt, # requests over Δt)
-//             / (# requests over Δt)
-//       = 1 - max(1, df) / rf
-const freqRatioMax = 1 - minAccuracy
-
-// Request cache size of 5MB (~5000 bytes/image).
-const requestCache = new LruCache(1000)
-
 // These query parameters are available to any badge. They are handled by
 // `coalesceBadge`.
 const globalQueryParams = new Set([
@@ -101,13 +83,23 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
   }
 
   const allowedKeys = flattenQueryParams(handlerOptions.queryParams)
-  const {
-    cacheLength: serviceDefaultCacheLengthSeconds,
-    fetchLimitBytes,
-  } = handlerOptions
+  const { cacheLength: serviceDefaultCacheLengthSeconds, fetchLimitBytes } =
+    handlerOptions
 
   return (queryParams, match, end, ask) => {
-    const reqTime = new Date()
+    /*
+    This is here for legacy reasons. The badge server and frontend used to live
+    on two different servers. When we merged them there was a conflict so we
+    did this to avoid moving the endpoint docs to another URL.
+
+    Never ever do this again.
+    */
+    if (match[0] === '/endpoint' && Object.keys(queryParams).length === 0) {
+      ask.res.statusCode = 301
+      ask.res.setHeader('Location', '/endpoint/')
+      ask.res.end()
+      return
+    }
 
     // `defaultCacheLengthSeconds` can be overridden by
     // `serviceDefaultCacheLengthSeconds` (either by category or on a badge-
@@ -137,49 +129,10 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
       filteredQueryParams[key] = queryParams[key]
     })
 
-    // Use sindresorhus query-string because it sorts the keys, whereas the
-    // builtin querystring module relies on the iteration order.
-    const stringified = queryString.stringify(filteredQueryParams)
-    const cacheIndex = `${match[0]}?${stringified}`
-
-    // Should we return the data right away?
-    const cached = requestCache.get(cacheIndex)
-    let cachedVersionSent = false
-    if (cached !== undefined) {
-      // A request was made not long ago.
-      const tooSoon = +reqTime - cached.time < cached.interval
-      if (tooSoon || cached.dataChange / cached.reqs <= freqRatioMax) {
-        const svg = makeBadge(cached.data.badgeData)
-        setCacheHeadersOnResponse(
-          ask.res,
-          cached.data.badgeData.cacheLengthSeconds
-        )
-        makeSend(cached.data.format, ask.res, end)(svg)
-        cachedVersionSent = true
-        // We do not wish to call the vendor servers.
-        if (tooSoon) {
-          return
-        }
-      }
-    }
-
     // In case our vendor servers are unresponsive.
     let serverUnresponsive = false
     const serverResponsive = setTimeout(() => {
       serverUnresponsive = true
-      if (cachedVersionSent) {
-        return
-      }
-      if (requestCache.has(cacheIndex)) {
-        const cached = requestCache.get(cacheIndex)
-        const svg = makeBadge(cached.data.badgeData)
-        setCacheHeadersOnResponse(
-          ask.res,
-          cached.data.badgeData.cacheLengthSeconds
-        )
-        makeSend(cached.data.format, ask.res, end)(svg)
-        return
-      }
       ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate')
       const badgeData = coalesceBadge(
         filteredQueryParams,
@@ -192,8 +145,6 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
       makeSend(extension, ask.res, end)(svg)
     }, 25000)
 
-    // Only call vendor servers when last request is older than…
-    let cacheInterval = 5000 // milliseconds
     function cachingRequest(uri, options, callback) {
       if (typeof options === 'function' && !callback) {
         callback = options
@@ -209,20 +160,7 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
       options.headers['User-Agent'] = userAgent
 
       let bufferLength = 0
-      const r = request(options, (err, res, body) => {
-        if (res != null && res.headers != null) {
-          const cacheControl = res.headers['cache-control']
-          if (cacheControl != null) {
-            const age = cacheControl.match(/max-age=([0-9]+)/)
-            // Would like to get some more test coverage on this before changing it.
-            // eslint-disable-next-line no-self-compare
-            if (age != null && +age[1] === +age[1]) {
-              cacheInterval = +age[1] * 1000
-            }
-          }
-        }
-        callback(err, res, body)
-      })
+      const r = request(options, callback)
       r.on('data', chunk => {
         bufferLength += chunk.length
         if (bufferLength > fetchLimitBytes) {
@@ -250,34 +188,17 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
           return
         }
         clearTimeout(serverResponsive)
-        // Check for a change in the data.
-        let dataHasChanged = false
-        if (
-          cached !== undefined &&
-          cached.data.badgeData.text[1] !== badgeData.text[1]
-        ) {
-          dataHasChanged = true
-        }
         // Add format to badge data.
         badgeData.format = format
-        // Update information in the cache.
-        const updatedCache = {
-          reqs: cached ? cached.reqs + 1 : 1,
-          dataChange: cached ? cached.dataChange + (dataHasChanged ? 1 : 0) : 1,
-          time: +reqTime,
-          interval: cacheInterval,
-          data: { format, badgeData },
-        }
-        requestCache.set(cacheIndex, updatedCache)
-        if (!cachedVersionSent) {
-          const svg = makeBadge(badgeData)
-          setCacheHeadersOnResponse(ask.res, badgeData.cacheLengthSeconds)
-          makeSend(format, ask.res, end)(svg)
-        }
+        const svg = makeBadge(badgeData)
+        setCacheHeadersOnResponse(ask.res, badgeData.cacheLengthSeconds)
+        makeSend(format, ask.res, end)(svg)
       },
       cachingRequest
     )
+    // eslint-disable-next-line promise/prefer-await-to-then
     if (result && result.catch) {
+      // eslint-disable-next-line promise/prefer-await-to-then
       result.catch(err => {
         throw err
       })
@@ -285,15 +206,8 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
   }
 }
 
-function clearRequestCache() {
-  requestCache.clear()
-}
-
 module.exports = {
   handleRequest,
   promisify,
-  clearRequestCache,
-  // Expose for testing.
-  _requestCache: requestCache,
   userAgent,
 }

core/base-service/legacy-request-handler.spec.js

@@ -6,11 +6,7 @@ const portfinder = require('portfinder')
 const Camp = require('@shields_io/camp')
 const got = require('../got-test-client')
 const coalesceBadge = require('./coalesce-badge')
-const {
-  handleRequest,
-  clearRequestCache,
-  _requestCache,
-} = require('./legacy-request-handler')
+const { handleRequest } = require('./legacy-request-handler')
 
 async function performTwoRequests(baseUrl, first, second) {
   expect((await got(`${baseUrl}${first}`)).statusCode).to.equal(200)
@@ -83,7 +79,6 @@ describe('The request handler', function () {
     camp.on('listening', () => done())
   })
   afterEach(function (done) {
-    clearRequestCache()
     if (camp) {
       camp.close(() => done())
       camp = null
@@ -196,57 +191,18 @@ describe('The request handler', function () {
 
   describe('caching', function () {
     describe('standard query parameters', function () {
-      let handlerCallCount
-      beforeEach(function () {
-        handlerCallCount = 0
-      })
-
       function register({ cacheHeaderConfig }) {
         camp.route(
           /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
           handleRequest(
             cacheHeaderConfig,
             (queryParams, match, sendBadge, request) => {
-              ++handlerCallCount
               fakeHandler(queryParams, match, sendBadge, request)
             }
           )
         )
       }
 
-      context('With standard cache settings', function () {
-        beforeEach(function () {
-          register({ cacheHeaderConfig: standardCacheHeaders })
-        })
-
-        it('should cache identical requests', async function () {
-          await performTwoRequests(
-            baseUrl,
-            '/testing/123.svg',
-            '/testing/123.svg'
-          )
-          expect(handlerCallCount).to.equal(1)
-        })
-
-        it('should differentiate known query parameters', async function () {
-          await performTwoRequests(
-            baseUrl,
-            '/testing/123.svg?label=foo',
-            '/testing/123.svg?label=bar'
-          )
-          expect(handlerCallCount).to.equal(2)
-        })
-
-        it('should ignore unknown query parameters', async function () {
-          await performTwoRequests(
-            baseUrl,
-            '/testing/123.svg?foo=1',
-            '/testing/123.svg?foo=2'
-          )
-          expect(handlerCallCount).to.equal(1)
-        })
-      })
-
       it('should set the expires header to current time + defaultCacheLengthSeconds', async function () {
         register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 900 } })
         const { headers } = await got(`${baseUrl}/testing/123.json`)
@@ -277,7 +233,6 @@ describe('The request handler', function () {
           handleRequest(
             { defaultCacheLengthSeconds: 300 },
             (queryParams, match, sendBadge, request) => {
-              ++handlerCallCount
               createFakeHandlerWithCacheLength(400)(
                 queryParams,
                 match,
@@ -298,7 +253,6 @@ describe('The request handler', function () {
           handleRequest(
             { defaultCacheLengthSeconds: 300 },
             (queryParams, match, sendBadge, request) => {
-              ++handlerCallCount
               createFakeHandlerWithCacheLength(200)(
                 queryParams,
                 match,
@@ -345,21 +299,6 @@ describe('The request handler', function () {
           'no-cache, no-store, must-revalidate'
         )
       })
-
-      describe('the cache key', function () {
-        beforeEach(function () {
-          register({ cacheHeaderConfig: standardCacheHeaders })
-        })
-        const expectedCacheKey = '/testing/123.json?color=123&label=foo'
-        it('should match expected and use canonical order - 1', async function () {
-          await got(`${baseUrl}/testing/123.json?color=123&label=foo`)
-          expect(_requestCache.cache).to.have.keys(expectedCacheKey)
-        })
-        it('should match expected and use canonical order - 2', async function () {
-          await got(`${baseUrl}/testing/123.json?label=foo&color=123`)
-          expect(_requestCache.cache).to.have.keys(expectedCacheKey)
-        })
-      })
     })
 
     describe('custom query parameters', function () {

core/base-service/loader-test-fixtures/valid-array.fixture.js

@@ -3,28 +3,12 @@
 const BaseJsonService = require('../base-json')
 
 class GoodServiceOne extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'one',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'one' }
 }
 class GoodServiceTwo extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'two',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'two' }
 }
 
 module.exports = [GoodServiceOne, GoodServiceTwo]

core/base-service/loader-test-fixtures/valid-class.fixture.js

@@ -3,16 +3,8 @@
 const BaseJsonService = require('../base-json')
 
 class GoodService extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'it/is',
-      pattern: 'good',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'it/is', pattern: 'good' }
 }
 
 module.exports = GoodService

core/base-service/loader-test-fixtures/valid-object.fixture.js

@@ -3,28 +3,12 @@
 const BaseJsonService = require('../base-json')
 
 class GoodServiceOne extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'one',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'one' }
 }
 class GoodServiceTwo extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'two',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'two' }
 }
 
 module.exports = { GoodServiceOne, GoodServiceTwo }

core/base-service/lru-cache.js

@@ -1,136 +0,0 @@
-'use strict'
-
-// In-memory KV, remove the oldest data when the capacity is reached.
-
-const typeEnum = {
-  unit: 0,
-  heap: 1,
-}
-
-// In bytes.
-let heapSize
-function computeHeapSize() {
-  return (heapSize = process.memoryUsage().heapTotal)
-}
-
-let heapSizeTimeout
-function getHeapSize() {
-  if (heapSizeTimeout == null) {
-    // Compute the heap size every 60 seconds.
-    heapSizeTimeout = setInterval(computeHeapSize, 60 * 1000)
-    return computeHeapSize()
-  } else {
-    return heapSize
-  }
-}
-
-function CacheSlot(key, value) {
-  this.key = key
-  this.value = value
-  this.older = null // Newest slot that is older than this slot.
-  this.newer = null // Oldest slot that is newer than this slot.
-}
-
-function Cache(capacity, type) {
-  type = type || 'unit'
-  this.capacity = capacity
-  this.type = typeEnum[type]
-  this.cache = new Map() // Maps cache keys to CacheSlots.
-  this.newest = null // Newest slot in the cache.
-  this.oldest = null
-}
-
-Cache.prototype = {
-  set: function addToCache(cacheKey, cached) {
-    let slot = this.cache.get(cacheKey)
-    if (slot === undefined) {
-      slot = new CacheSlot(cacheKey, cached)
-      this.cache.set(cacheKey, slot)
-    }
-    this.makeNewest(slot)
-    const numItemsToRemove = this.limitReached()
-    if (numItemsToRemove > 0) {
-      for (let i = 0; i < numItemsToRemove; i++) {
-        this.removeOldest()
-      }
-    }
-  },
-
-  get: function getFromCache(cacheKey) {
-    const slot = this.cache.get(cacheKey)
-    if (slot !== undefined) {
-      this.makeNewest(slot)
-      return slot.value
-    }
-  },
-
-  has: function hasInCache(cacheKey) {
-    return this.cache.has(cacheKey)
-  },
-
-  makeNewest: function makeNewestSlot(slot) {
-    const previousNewest = this.newest
-    if (previousNewest === slot) {
-      return
-    }
-    const older = slot.older
-    const newer = slot.newer
-
-    if (older !== null) {
-      older.newer = newer
-    } else if (newer !== null) {
-      this.oldest = newer
-    }
-    if (newer !== null) {
-      newer.older = older
-    }
-    this.newest = slot
-
-    if (previousNewest !== null) {
-      slot.older = previousNewest
-      slot.newer = null
-      previousNewest.newer = slot
-    } else {
-      // If previousNewest is null, the cache used to be empty.
-      this.oldest = slot
-    }
-  },
-
-  removeOldest: function removeOldest() {
-    const cacheKey = this.oldest.key
-    if (this.oldest !== null) {
-      this.oldest = this.oldest.newer
-      if (this.oldest !== null) {
-        this.oldest.older = null
-      }
-    }
-    this.cache.delete(cacheKey)
-  },
-
-  // Returns the number of elements to remove if we're past the limit.
-  limitReached: function heuristic() {
-    if (this.type === typeEnum.unit) {
-      // Remove the excess.
-      return Math.max(0, this.cache.size - this.capacity)
-    } else if (this.type === typeEnum.heap) {
-      if (getHeapSize() >= this.capacity) {
-        console.log('LRU HEURISTIC heap:', getHeapSize())
-        // Remove half of them.
-        return this.cache.size >> 1
-      } else {
-        return 0
-      }
-    } else {
-      console.error(`Unknown heuristic '${this.type}' for LRU cache.`)
-      return 1
-    }
-  },
-
-  clear: function () {
-    this.cache.clear()
-    this.newest = null
-    this.oldest = null
-  },
-}
-
-module.exports = Cache

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

@@ -1,134 +0,0 @@
-'use strict'
-
-const { expect } = require('chai')
-const LRU = require('./lru-cache')
-
-function expectCacheSlots(cache, keys) {
-  expect(cache.cache.size).to.equal(keys.length)
-
-  const slots = keys.map(k => cache.cache.get(k))
-
-  const first = slots[0]
-  const last = slots.slice(-1)[0]
-
-  expect(cache.oldest).to.equal(first)
-  expect(cache.newest).to.equal(last)
-
-  expect(first.older).to.be.null
-  expect(last.newer).to.be.null
-
-  for (let i = 0; i + 1 < slots.length; ++i) {
-    const current = slots[i]
-    const next = slots[i + 1]
-    expect(current.newer).to.equal(next)
-    expect(next.older).to.equal(current)
-  }
-}
-
-describe('The LRU cache', function () {
-  it('should support a zero capacity', function () {
-    const cache = new LRU(0)
-    cache.set('key', 'value')
-    expect(cache.cache.size).to.equal(0)
-  })
-
-  it('should support a one capacity', function () {
-    const cache = new LRU(1)
-    cache.set('key1', 'value1')
-    expectCacheSlots(cache, ['key1'])
-    cache.set('key2', 'value2')
-    expectCacheSlots(cache, ['key2'])
-    expect(cache.get('key1')).to.be.undefined
-    expect(cache.get('key2')).to.equal('value2')
-  })
-
-  it('should remove the oldest element when reaching capacity', function () {
-    const cache = new LRU(2)
-
-    cache.set('key1', 'value1')
-    cache.set('key2', 'value2')
-    cache.set('key3', 'value3')
-    cache.cache.get('key1')
-
-    expectCacheSlots(cache, ['key2', 'key3'])
-    expect(cache.cache.get('key1')).to.be.undefined
-    expect(cache.get('key1')).to.be.undefined
-    expect(cache.get('key2')).to.equal('value2')
-    expect(cache.get('key3')).to.equal('value3')
-  })
-
-  it('should make sure that resetting a key in cache makes it newest', function () {
-    const cache = new LRU(2)
-
-    cache.set('key', 'value')
-    cache.set('key2', 'value2')
-
-    expectCacheSlots(cache, ['key', 'key2'])
-
-    cache.set('key', 'value')
-
-    expectCacheSlots(cache, ['key2', 'key'])
-  })
-
-  describe('getting a key in the cache', function () {
-    context('when the requested key is oldest', function () {
-      it('should leave the keys in the expected order', function () {
-        const cache = new LRU(2)
-        cache.set('key1', 'value1')
-        cache.set('key2', 'value2')
-
-        expectCacheSlots(cache, ['key1', 'key2'])
-
-        expect(cache.get('key1')).to.equal('value1')
-
-        expectCacheSlots(cache, ['key2', 'key1'])
-      })
-    })
-
-    context('when the requested key is newest', function () {
-      it('should leave the keys in the expected order', function () {
-        const cache = new LRU(2)
-        cache.set('key1', 'value1')
-        cache.set('key2', 'value2')
-
-        expect(cache.get('key2')).to.equal('value2')
-
-        expectCacheSlots(cache, ['key1', 'key2'])
-      })
-    })
-
-    context('when the requested key is in the middle', function () {
-      it('should leave the keys in the expected order', function () {
-        const cache = new LRU(3)
-        cache.set('key1', 'value1')
-        cache.set('key2', 'value2')
-        cache.set('key3', 'value3')
-
-        expectCacheSlots(cache, ['key1', 'key2', 'key3'])
-
-        expect(cache.get('key2')).to.equal('value2')
-
-        expectCacheSlots(cache, ['key1', 'key3', 'key2'])
-      })
-    })
-  })
-
-  it('should clear', function () {
-    // Set up.
-    const cache = new LRU(2)
-    cache.set('key1', 'value1')
-    cache.set('key2', 'value2')
-
-    // Confidence check.
-    expect(cache.get('key1')).to.equal('value1')
-    expect(cache.get('key2')).to.equal('value2')
-
-    // Run.
-    cache.clear()
-
-    // Test.
-    expect(cache.get('key1')).to.be.undefined
-    expect(cache.get('key2')).to.be.undefined
-    expect(cache.cache.size).to.equal(0)
-  })
-})

core/base-service/metric-helper.js

@@ -11,13 +11,12 @@ class MetricHelper {
         serviceFamily,
         name,
       })
-      this.serviceResponseSizeHistogram = metricInstance.createServiceResponseSizeHistogram(
-        {
+      this.serviceResponseSizeHistogram =
+        metricInstance.createServiceResponseSizeHistogram({
           category,
           serviceFamily,
           name,
-        }
-      )
+        })
     } else {
       this.metricInstance = undefined
       this.serviceRequestCounter = undefined

core/base-service/redirector.js

@@ -2,7 +2,7 @@
 
 const camelcase = require('camelcase')
 const emojic = require('emojic')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const queryString = require('query-string')
 const BaseService = require('./base')
 const {
@@ -41,27 +41,15 @@ module.exports = function redirector(attrs) {
   } = Joi.attempt(attrs, attrSchema, `Redirector for ${attrs.route.base}`)
 
   return class Redirector extends BaseService {
-    static get name() {
-      if (name) {
-        return name
-      } else {
-        return `${camelcase(route.base.replace(/\//g, '_'), {
-          pascalCase: true,
-        })}Redirect`
-      }
-    }
+    static name =
+      name ||
+      `${camelcase(route.base.replace(/\//g, '_'), {
+        pascalCase: true,
+      })}Redirect`
 
-    static get category() {
-      return category
-    }
-
-    static get isDeprecated() {
-      return true
-    }
-
-    static get route() {
-      return route
-    }
+    static category = category
+    static isDeprecated = true
+    static route = route
 
     static register({ camp, metricInstance }, { rasterUrl }) {
       const { regex, captureNames } = prepareRoute({
@@ -94,7 +82,7 @@ module.exports = function redirector(attrs) {
         trace.logTrace('inbound', emojic.ticket, 'Named params', namedParams)
         trace.logTrace('inbound', emojic.crayon, 'Query params', queryParams)
 
-        const targetPath = transformPath(namedParams)
+        const targetPath = encodeURI(transformPath(namedParams))
         trace.logTrace('validate', emojic.dart, 'Target', targetPath)
 
         let urlSuffix = ask.uri.search || ''

core/base-service/redirector.spec.js

@@ -121,6 +121,20 @@ describe('Redirector', function () {
       )
     })
 
+    it('should correctly encode the redirect URL', async function () {
+      const { statusCode, headers } = await got(
+        `${baseUrl}/very/old/service/hello%0Dworld.svg?foobar=a%0Db`,
+        {
+          followRedirect: false,
+        }
+      )
+
+      expect(statusCode).to.equal(301)
+      expect(headers.location).to.equal(
+        '/new/service/hello%0Dworld.svg?foobar=a%0Db'
+      )
+    })
+
     describe('transformQueryParams', function () {
       const route = {
         base: 'another/old/service',

core/base-service/route.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const escapeStringRegexp = require('escape-string-regexp')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { pathToRegexp } = require('path-to-regexp')
 
 function makeFullUrl(base, partialUrl) {

core/base-service/route.spec.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { expect } = require('chai')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { test, given, forCases } = require('sazerac')
 const {
   prepareRoute,

core/base-service/service-definitions.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 
 // This should be kept in sync with the schema in
 // `frontend/lib/service-definitions/index.ts`.

core/base-service/validate.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const emojic = require('emojic')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const trace = require('./trace')
 
 function validate(

core/base-service/validate.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const trace = require('./trace')

core/server/influx-metrics.js

@@ -1,8 +1,6 @@
 'use strict'
 const os = require('os')
-const { promisify } = require('util')
-const { post } = require('request')
-const postAsync = promisify(post)
+const got = require('got')
 const generateInstanceId = require('./instance-id-generator')
 const { promClientJsonToInfluxV2 } = require('./metrics/format-converters')
 const log = require('./log')
@@ -15,21 +13,19 @@ module.exports = class InfluxMetrics {
   }
 
   async sendMetrics() {
-    const auth = {
-      user: this._config.username,
-      pass: this._config.password,
-    }
     const request = {
-      uri: this._config.url,
+      url: this._config.url,
       headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-      body: this.metrics(),
+      body: await this.metrics(),
       timeout: this._config.timeoutMillseconds,
-      auth,
+      username: this._config.username,
+      password: this._config.password,
+      throwHttpErrors: false,
     }
 
     let response
     try {
-      response = await postAsync(request)
+      response = await got.post(request)
     } catch (error) {
       log.error(
         new Error(`Cannot push metrics. Cause: ${error.name}: ${error.message}`)
@@ -38,7 +34,7 @@ module.exports = class InfluxMetrics {
     if (response && response.statusCode >= 300) {
       log.error(
         new Error(
-          `Cannot push metrics. ${response.request.href} responded with status code ${response.statusCode}`
+          `Cannot push metrics. ${request.url} responded with status code ${response.statusCode}`
         )
       )
     }
@@ -51,8 +47,8 @@ module.exports = class InfluxMetrics {
     )
   }
 
-  metrics() {
-    return promClientJsonToInfluxV2(this._metricInstance.metrics(), {
+  async metrics() {
+    return promClientJsonToInfluxV2(await this._metricInstance.metrics(), {
       env: this._config.envLabel,
       application: 'shields',
       instance: this._instanceId,

core/server/influx-metrics.spec.js

@@ -36,7 +36,7 @@ describe('Influx metrics', function () {
         instanceIdEnvVarName: 'INSTANCE_ID',
       })
 
-      expect(influxMetrics.metrics()).to.contain('instance=instance3')
+      expect(await influxMetrics.metrics()).to.contain('instance=instance3')
     })
 
     it('should use a hostname as an instance label', async function () {
@@ -46,7 +46,9 @@ describe('Influx metrics', function () {
       }
       const influxMetrics = new InfluxMetrics(metricInstance, customConfig)
 
-      expect(influxMetrics.metrics()).to.be.contain('instance=test-hostname')
+      expect(await influxMetrics.metrics()).to.be.contain(
+        'instance=test-hostname'
+      )
     })
 
     it('should use a random string as an instance label', async function () {
@@ -55,7 +57,7 @@ describe('Influx metrics', function () {
       }
       const influxMetrics = new InfluxMetrics(metricInstance, customConfig)
 
-      expect(influxMetrics.metrics()).to.be.match(/instance=\w+ /)
+      expect(await influxMetrics.metrics()).to.be.match(/instance=\w+ /)
     })
 
     it('should use a hostname alias as an instance label', async function () {
@@ -66,7 +68,7 @@ describe('Influx metrics', function () {
       }
       const influxMetrics = new InfluxMetrics(metricInstance, customConfig)
 
-      expect(influxMetrics.metrics()).to.be.contain(
+      expect(await influxMetrics.metrics()).to.be.contain(
         'instance=test-hostname-alias'
       )
     })
@@ -148,7 +150,7 @@ describe('Influx metrics', function () {
           .and(
             sinon.match.has(
               'message',
-              'Cannot push metrics. Cause: NetConnectNotAllowedError: Nock: Disallowed net connect for "shields-metrics.io:80/metrics"'
+              'Cannot push metrics. Cause: RequestError: Nock: Disallowed net connect for "shields-metrics.io:80/metrics"'
             )
           )
       )

core/server/metrics/format-converters.js

@@ -2,26 +2,26 @@
 const groupBy = require('lodash.groupby')
 
 function promClientJsonToInfluxV2(metrics, extraLabels = {}) {
-  // TODO Replace with Array.prototype.flatMap() after migrating to Node.js >= 11
-  const flatMap = (f, arr) => arr.reduce((acc, x) => acc.concat(f(x)), [])
-  return flatMap(metric => {
-    const valuesByLabels = groupBy(metric.values, value =>
-      JSON.stringify(Object.entries(value.labels).sort())
-    )
-    return Object.values(valuesByLabels).map(metricsWithSameLabel => {
-      const labels = Object.entries(metricsWithSameLabel[0].labels)
-        .concat(Object.entries(extraLabels))
-        .sort((a, b) => a[0].localeCompare(b[0]))
-        .map(labelEntry => `${labelEntry[0]}=${labelEntry[1]}`)
-        .join(',')
-      const labelsFormatted = labels ? `,${labels}` : ''
-      const values = metricsWithSameLabel
-        .sort((a, b) => a.metricName.localeCompare(b.metricName))
-        .map(value => `${value.metricName || metric.name}=${value.value}`)
-        .join(',')
-      return `prometheus${labelsFormatted} ${values}`
-    })
-  }, metrics).join('\n')
+  return metrics
+    .flatMap(metric => {
+      const valuesByLabels = groupBy(metric.values, value =>
+        JSON.stringify(Object.entries(value.labels).sort())
+      )
+      return Object.values(valuesByLabels).map(metricsWithSameLabel => {
+        const labels = Object.entries(metricsWithSameLabel[0].labels)
+          .concat(Object.entries(extraLabels))
+          .sort((a, b) => a[0].localeCompare(b[0]))
+          .map(labelEntry => `${labelEntry[0]}=${labelEntry[1]}`)
+          .join(',')
+        const labelsFormatted = labels ? `,${labels}` : ''
+        const values = metricsWithSameLabel
+          .sort((a, b) => a.metricName.localeCompare(b.metricName))
+          .map(value => `${value.metricName || metric.name}=${value.value}`)
+          .join(',')
+        return `prometheus${labelsFormatted} ${values}`
+      })
+    }, metrics)
+    .join('\n')
 }
 
 module.exports = { promClientJsonToInfluxV2 }

core/server/metrics/format-converters.spec.js

@@ -22,7 +22,7 @@ describe('Metric format converters', function () {
       expect(influx).to.be.equal('prometheus counter1=11')
     })
 
-    it('converts a counter (from prometheus registry)', function () {
+    it('converts a counter (from prometheus registry)', async function () {
       const register = new prometheus.Registry()
       const counter = new prometheus.Counter({
         name: 'counter1',
@@ -31,7 +31,7 @@ describe('Metric format converters', function () {
       })
       counter.inc(11)
 
-      const influx = promClientJsonToInfluxV2(register.getMetricsAsJSON())
+      const influx = promClientJsonToInfluxV2(await register.getMetricsAsJSON())
 
       expect(influx).to.be.equal('prometheus counter1=11')
     })
@@ -52,7 +52,7 @@ describe('Metric format converters', function () {
       expect(influx).to.be.equal('prometheus gauge1=20')
     })
 
-    it('converts a gauge (from prometheus registry)', function () {
+    it('converts a gauge (from prometheus registry)', async function () {
       const register = new prometheus.Registry()
       const gauge = new prometheus.Gauge({
         name: 'gauge1',
@@ -61,7 +61,7 @@ describe('Metric format converters', function () {
       })
       gauge.inc(20)
 
-      const influx = promClientJsonToInfluxV2(register.getMetricsAsJSON())
+      const influx = promClientJsonToInfluxV2(await register.getMetricsAsJSON())
 
       expect(influx).to.be.equal('prometheus gauge1=20')
     })
@@ -101,7 +101,7 @@ prometheus histogram1_count=3,histogram1_sum=111`)
       )
     })
 
-    it('converts a histogram (from prometheus registry)', function () {
+    it('converts a histogram (from prometheus registry)', async function () {
       const register = new prometheus.Registry()
       const histogram = new prometheus.Histogram({
         name: 'histogram1',
@@ -113,7 +113,7 @@ prometheus histogram1_count=3,histogram1_sum=111`)
       histogram.observe(10)
       histogram.observe(1)
 
-      const influx = promClientJsonToInfluxV2(register.getMetricsAsJSON())
+      const influx = promClientJsonToInfluxV2(await register.getMetricsAsJSON())
 
       expect(sortLines(influx)).to.be.equal(
         sortLines(`prometheus,le=+Inf histogram1_bucket=3
@@ -151,7 +151,7 @@ prometheus summary1_count=3,summary1_sum=111`)
       )
     })
 
-    it('converts a summary (from prometheus registry)', function () {
+    it('converts a summary (from prometheus registry)', async function () {
       const register = new prometheus.Registry()
       const summary = new prometheus.Summary({
         name: 'summary1',
@@ -163,7 +163,7 @@ prometheus summary1_count=3,summary1_sum=111`)
       summary.observe(10)
       summary.observe(1)
 
-      const influx = promClientJsonToInfluxV2(register.getMetricsAsJSON())
+      const influx = promClientJsonToInfluxV2(await register.getMetricsAsJSON())
 
       expect(sortLines(influx)).to.be.equal(
         sortLines(`prometheus,quantile=0.99 summary1=100

core/server/monitor.js

@@ -1,100 +0,0 @@
-'use strict'
-
-const config = require('config').util.toObject()
-const secretIsValid = require('./secret-is-valid')
-const RateLimit = require('./rate-limit')
-const log = require('./log')
-
-function secretInvalid(req, res) {
-  if (!secretIsValid(req.password)) {
-    // An unknown entity tries to connect. Let the connection linger for a minute.
-    setTimeout(() => {
-      res.json({ errors: [{ code: 'invalid_secrets' }] })
-    }, 10000)
-    return true
-  }
-  return false
-}
-
-function setRoutes({ rateLimit }, { server, metricInstance }) {
-  const ipRateLimit = new RateLimit({
-    // Exclude IPs for GitHub Camo, determined experimentally by running e.g.
-    // `curl --insecure -u ":shields-secret" https://s0.shields-server.com/sys/rate-limit`
-    safelist: /^(?:192\.30\.252\.\d+)|(?:140\.82\.115\.\d+)$/,
-  })
-  const badgeTypeRateLimit = new RateLimit({ maxHitsPerPeriod: 3000 })
-  const refererRateLimit = new RateLimit({
-    maxHitsPerPeriod: 300,
-    safelist: /^https?:\/\/shields\.io\/$/,
-  })
-
-  server.handle((req, res, next) => {
-    if (req.url.startsWith('/sys/')) {
-      if (secretInvalid(req, res)) {
-        return
-      }
-    }
-
-    if (rateLimit) {
-      const ip =
-        (req.headers['x-forwarded-for'] || '').split(', ')[0] ||
-        req.socket.remoteAddress
-      const badgeType = req.url.split(/[/-]/).slice(0, 3).join('')
-      const referer = req.headers.referer
-
-      if (ipRateLimit.isBanned(ip, req, res)) {
-        metricInstance.noteRateLimitExceeded('ip')
-        return
-      }
-      if (badgeTypeRateLimit.isBanned(badgeType, req, res)) {
-        metricInstance.noteRateLimitExceeded('badge_type')
-        return
-      }
-      if (refererRateLimit.isBanned(referer, req, res)) {
-        metricInstance.noteRateLimitExceeded('referrer')
-        return
-      }
-    }
-
-    next()
-  })
-
-  server.get('/sys/network', (req, res) => {
-    res.json({ ips: config.public.shields_ips })
-  })
-
-  server.ws('/sys/logs', socket => {
-    const listener = (...msg) => socket.send(msg.join(' '))
-    socket.on('close', () => log.removeListener(listener))
-    socket.on('message', msg => {
-      let req
-      try {
-        req = JSON.parse(msg)
-      } catch (e) {
-        return
-      }
-      if (!secretIsValid(req.secret)) {
-        return socket.close()
-      }
-      log.addListener(listener)
-    })
-  })
-
-  server.get('/sys/rate-limit', (req, res) => {
-    res.json({
-      ip: ipRateLimit.toJSON(),
-      badgeType: badgeTypeRateLimit.toJSON(),
-      referer: refererRateLimit.toJSON(),
-    })
-  })
-
-  return function () {
-    ipRateLimit.stop()
-    badgeTypeRateLimit.stop()
-    refererRateLimit.stop()
-  }
-}
-
-module.exports = {
-  setRoutes,
-}

core/server/prometheus-metrics.js

@@ -19,46 +19,12 @@ module.exports = class PrometheusMetrics {
         // 250 ms increments up to 2 seconds, then 500 ms increments up to 8
         // seconds, then 1 second increments up to 15 seconds.
         buckets: [
-          250,
-          500,
-          750,
-          1000,
-          1250,
-          1500,
-          1750,
-          2000,
-          2250,
-          2500,
-          2750,
-          3000,
-          3250,
-          3500,
-          3750,
-          4000,
-          4500,
-          5000,
-          5500,
-          6000,
-          6500,
-          7000,
-          7500,
-          8000,
-          9000,
-          10000,
-          11000,
-          12000,
-          13000,
-          14000,
-          15000,
+          250, 500, 750, 1000, 1250, 1500, 1750, 2000, 2250, 2500, 2750, 3000,
+          3250, 3500, 3750, 4000, 4500, 5000, 5500, 6000, 6500, 7000, 7500,
+          8000, 9000, 10000, 11000, 12000, 13000, 14000, 15000,
         ],
         registers: [this.register],
       }),
-      rateLimitExceeded: new prometheus.Counter({
-        name: 'rate_limit_exceeded_total',
-        help: 'Count of rate limit exceeded by type',
-        labelNames: ['rate_limit_type'],
-        registers: [this.register],
-      }),
       serviceResponseSize: new prometheus.Histogram({
         name: 'service_response_bytes',
         help: 'Service response size in bytes',
@@ -76,9 +42,9 @@ module.exports = class PrometheusMetrics {
   async registerMetricsEndpoint(server) {
     const { register } = this
 
-    server.route(/^\/metrics$/, (data, match, end, ask) => {
+    server.route(/^\/metrics$/, async (data, match, end, ask) => {
       ask.res.setHeader('Content-Type', register.contentType)
-      ask.res.end(register.metrics())
+      ask.res.end(await register.metrics())
     })
   }
 
@@ -90,8 +56,8 @@ module.exports = class PrometheusMetrics {
     }
   }
 
-  metrics() {
-    return this.register.getMetricsAsJSON()
+  async metrics() {
+    return await this.register.getMetricsAsJSON()
   }
 
   /**
@@ -110,10 +76,6 @@ module.exports = class PrometheusMetrics {
     return this.counters.responseTime.observe(responseTime)
   }
 
-  noteRateLimitExceeded(rateLimitType) {
-    return this.counters.rateLimitExceeded.labels(rateLimitType).inc()
-  }
-
   createServiceResponseSizeHistogram({ category, serviceFamily, name }) {
     const service = decamelize(name)
     return this.counters.serviceResponseSize.labels(

core/server/rate-limit.js

@@ -1,60 +0,0 @@
-'use strict'
-
-// A rate limit ensures that a request parameter gets flagged if it goes
-// above a limit.
-module.exports = class RateLimit {
-  constructor(options = {}) {
-    // this.hits: Map from request parameters to the number of hits.
-    this.hits = new Map()
-    this.period = options.period || 200 // 3 min ⅓, in seconds
-    this.maxHitsPerPeriod = options.maxHitsPerPeriod || 500
-    this.banned = new Set()
-    this.bannedUrls = new Set()
-    this.safelist = options.safelist || /(?!)/ // Matches nothing by default.
-    this.interval = setInterval(this.resetHits.bind(this), this.period * 1000)
-  }
-
-  stop() {
-    clearInterval(this.interval)
-    this.interval = undefined
-  }
-
-  resetHits() {
-    this.hits.clear()
-    this.banned.clear()
-    this.bannedUrls.clear()
-  }
-
-  isBanned(reqParam, req, res) {
-    const hitsInCurrentPeriod = this.hits.get(reqParam) || 0
-    if (
-      reqParam != null &&
-      !this.safelist.test(reqParam) &&
-      hitsInCurrentPeriod > this.maxHitsPerPeriod
-    ) {
-      this.banned.add(reqParam)
-    }
-
-    if (this.banned.has(reqParam)) {
-      res.statusCode = 429
-      res.setHeader('Retry-After', String(this.period))
-      res.end(
-        `Exceeded limit ${this.maxHitsPerPeriod} requests ` +
-          `per ${this.period} seconds`
-      )
-      this.bannedUrls.add(req.url)
-      return true
-    }
-
-    this.hits.set(reqParam, hitsInCurrentPeriod + 1)
-    return false
-  }
-
-  toJSON() {
-    return {
-      banned: [...this.banned],
-      hits: [...this.hits],
-      urls: [...this.bannedUrls],
-    }
-  }
-}

core/server/secret-is-valid.js

@@ -1,7 +1,5 @@
 'use strict'
 
-const serverSecrets = require('../../lib/server-secrets')
-
 function constEq(a, b) {
   if (a.length !== b.length) {
     return false
@@ -13,9 +11,10 @@ function constEq(a, b) {
   return zero === 0
 }
 
-module.exports = function secretIsValid(secret = '') {
-  return (
-    serverSecrets.shields_secret &&
-    constEq(secret, serverSecrets.shields_secret)
-  )
+function makeSecretIsValid(shieldsSecret) {
+  return function secretIsValid(secret = '') {
+    return shieldsSecret && constEq(secret, shieldsSecret)
+  }
 }
+
+module.exports = { makeSecretIsValid }

core/server/server.js

@@ -6,22 +6,20 @@
 const path = require('path')
 const url = require('url')
 const { URL } = url
+const cloudflareMiddleware = require('cloudflare-middleware')
 const bytes = require('bytes')
 const Camp = require('@shields_io/camp')
-const originalJoi = require('@hapi/joi')
+const originalJoi = require('joi')
 const makeBadge = require('../../badge-maker/lib/make-badge')
 const GithubConstellation = require('../../services/github/github-constellation')
 const suggest = require('../../services/suggest')
 const { loadServiceClasses } = require('../base-service/loader')
 const { makeSend } = require('../base-service/legacy-result-sender')
-const {
-  handleRequest,
-  clearRequestCache,
-} = require('../base-service/legacy-request-handler')
+const { handleRequest } = require('../base-service/legacy-request-handler')
 const { clearRegularUpdateCache } = require('../legacy/regular-update')
 const { rasterRedirectUrl } = require('../badge-urls/make-badge-url')
+const { nonNegativeInteger } = require('../../services/validators')
 const log = require('./log')
-const sysMonitor = require('./monitor')
 const PrometheusMetrics = require('./prometheus-metrics')
 const InfluxMetrics = require('./influx-metrics')
 
@@ -89,10 +87,10 @@ const publicConfigSchema = Joi.object({
         .integer()
         .min(1)
         .when('enabled', { is: true, then: Joi.required() }),
-      intervalSeconds: Joi.number()
-        .integer()
-        .min(1)
-        .when('enabled', { is: true, then: Joi.required() }),
+      intervalSeconds: Joi.number().integer().min(1).when('enabled', {
+        is: true,
+        then: Joi.required(),
+      }),
       instanceIdFrom: Joi.string()
         .equal('hostname', 'env-var', 'random')
         .when('enabled', { is: true, then: Joi.required() }),
@@ -117,9 +115,6 @@ const publicConfigSchema = Joi.object({
   cors: {
     allowedOrigin: Joi.array().items(optionalUrl).required(),
   },
-  persistence: {
-    dir: Joi.string().required(),
-  },
   services: Joi.object({
     bitbucketServer: defaultService,
     drone: defaultService,
@@ -142,19 +137,20 @@ const publicConfigSchema = Joi.object({
     teamcity: defaultService,
     trace: Joi.boolean().required(),
   }).required(),
-  cacheHeaders: {
-    defaultCacheLengthSeconds: Joi.number().integer().required(),
-  },
-  rateLimit: Joi.boolean().required(),
+  cacheHeaders: { defaultCacheLengthSeconds: nonNegativeInteger },
   handleInternalErrors: Joi.boolean().required(),
   fetchLimit: Joi.string().regex(/^[0-9]+(b|kb|mb|gb|tb)$/i),
-  shieldsProductionHerokuHacks: Joi.boolean(),
+  requestTimeoutSeconds: nonNegativeInteger,
+  requestTimeoutMaxAgeSeconds: nonNegativeInteger,
+  documentRoot: Joi.string().default(
+    path.resolve(__dirname, '..', '..', 'public')
+  ),
+  requireCloudflare: Joi.boolean().required(),
 }).required()
 
 const privateConfigSchema = Joi.object({
   azure_devops_token: Joi.string(),
-  bintray_user: Joi.string(),
-  bintray_apikey: Joi.string(),
+  discord_bot_token: Joi.string(),
   drone_token: Joi.string(),
   gh_client_id: Joi.string(),
   gh_client_secret: Joi.string(),
@@ -163,12 +159,13 @@ const privateConfigSchema = Joi.object({
   jenkins_pass: Joi.string(),
   jira_user: Joi.string(),
   jira_pass: Joi.string(),
+  bitbucket_server_username: Joi.string(),
+  bitbucket_server_password: Joi.string(),
   nexus_user: Joi.string(),
   nexus_pass: Joi.string(),
   npm_token: Joi.string(),
   redis_url: Joi.string().uri({ scheme: ['redis', 'rediss'] }),
   sentry_dsn: Joi.string(),
-  shields_ips: Joi.array().items(Joi.string().ip()),
   shields_secret: Joi.string(),
   sl_insight_userUuid: Joi.string(),
   sl_insight_apiToken: Joi.string(),
@@ -186,6 +183,11 @@ const privateMetricsInfluxConfigSchema = privateConfigSchema.append({
   influx_username: Joi.string().required(),
   influx_password: Joi.string().required(),
 })
+
+function addHandlerAtIndex(camp, index, handlerFn) {
+  camp.stack.splice(index, 0, handlerFn)
+}
+
 /**
  * The Server is based on the web framework Scoutcamp. It creates
  * an http server, sets up helpers for token persistence and monitoring.
@@ -224,7 +226,6 @@ class Server {
     }
 
     this.githubConstellation = new GithubConstellation({
-      persistence: publicConfig.persistence,
       service: publicConfig.services.github,
       private: privateConfig,
     })
@@ -278,6 +279,23 @@ class Server {
     })
   }
 
+  // See https://www.viget.com/articles/heroku-cloudflare-the-right-way/
+  requireCloudflare() {
+    // Set `req.ip`, which is expected by `cloudflareMiddleware()`. This is set
+    // by Express but not Scoutcamp.
+    addHandlerAtIndex(this.camp, 0, function (req, res, next) {
+      // On Heroku, `req.socket.remoteAddress` is the Heroku router. However,
+      // the router ensures that the last item in the `X-Forwarded-For` header
+      // is the real origin.
+      // https://stackoverflow.com/a/18517550/893113
+      req.ip = process.env.DYNO
+        ? req.headers['x-forwarded-for'].split(', ').pop()
+        : req.socket.remoteAddress
+      next()
+    })
+    addHandlerAtIndex(this.camp, 1, cloudflareMiddleware())
+  }
+
   /**
    * Set up Scoutcamp routes for 404/not found responses
    */
@@ -295,7 +313,8 @@ class Server {
         end
       )(
         makeBadge({
-          text: ['410', `${format} no longer available`],
+          label: '410',
+          message: `${format} no longer available`,
           color: 'lightgray',
           format: 'svg',
         })
@@ -310,7 +329,8 @@ class Server {
           end
         )(
           makeBadge({
-            text: ['404', 'raster badges not available'],
+            label: '404',
+            message: 'raster badges not available',
             color: 'lightgray',
             format: 'svg',
           })
@@ -328,7 +348,8 @@ class Server {
         end
       )(
         makeBadge({
-          text: ['404', 'badge not found'],
+          label: '404',
+          message: 'badge not found',
           color: 'red',
           format,
         })
@@ -392,8 +413,6 @@ class Server {
           rasterUrl: config.public.rasterUrl,
           private: config.private,
           public: config.public,
-          shieldsProductionHerokuHacks:
-            config.public.shieldsProductionHerokuHacks,
         }
       )
     )
@@ -410,27 +429,26 @@ class Server {
       bind: { port, address: hostname },
       ssl: { isSecure: secure, cert, key },
       cors: { allowedOrigin },
-      rateLimit,
+      requireCloudflare,
     } = this.config.public
 
     log(`Server is starting up: ${this.baseUrl}`)
 
     const camp = (this.camp = Camp.create({
-      documentRoot: path.resolve(__dirname, '..', '..', 'public'),
+      documentRoot: this.config.public.documentRoot,
       port,
       hostname,
       secure,
+      staticMaxAge: 300,
       cert,
       key,
     }))
 
-    const { metricInstance } = this
-    this.cleanupMonitor = sysMonitor.setRoutes(
-      { rateLimit },
-      { server: camp, metricInstance }
-    )
+    if (requireCloudflare) {
+      this.requireCloudflare()
+    }
 
-    const { githubConstellation } = this
+    const { githubConstellation, metricInstance } = this
     await githubConstellation.initialize(camp)
     if (metricInstance) {
       if (this.config.public.metrics.prometheus.endpointEnabled) {
@@ -448,6 +466,19 @@ class Server {
     this.registerRedirects()
     this.registerServices()
 
+    camp.timeout = this.config.public.requestTimeoutSeconds * 1000
+    if (this.config.public.requestTimeoutSeconds > 0) {
+      camp.on('timeout', socket => {
+        const maxAge = this.config.public.requestTimeoutMaxAgeSeconds
+        socket.write('HTTP/1.1 408 Request Timeout\r\n')
+        socket.write('Content-Type: text/html; charset=UTF-8\r\n')
+        socket.write('Content-Encoding: UTF-8\r\n')
+        socket.write(`Cache-Control: max-age=${maxAge}, s-maxage=${maxAge}\r\n`)
+        socket.write('Connection: close\r\n\r\n')
+        socket.write('Request Timeout')
+        socket.end()
+      })
+    }
     camp.listenAsConfigured()
 
     await new Promise(resolve => camp.on('listening', () => resolve()))
@@ -456,7 +487,6 @@ class Server {
   static resetGlobalState() {
     // This state should be migrated to instance state. When possible, do not add new
     // global state.
-    clearRequestCache()
     clearRegularUpdateCache()
   }
 

core/server/server.spec.js

@@ -1,8 +1,11 @@
 'use strict'
 
+const path = require('path')
 const { expect } = require('chai')
 const isSvg = require('is-svg')
 const config = require('config')
+const nock = require('nock')
+const sinon = require('sinon')
 const got = require('../got-test-client')
 const Server = require('./server')
 const { createTestServer } = require('./in-process-server-test-helpers')
@@ -13,7 +16,11 @@ describe('The server', function () {
     before('Start the server', async function () {
       // Fixes https://github.com/badges/shields/issues/2611
       this.timeout(10000)
-      server = await createTestServer()
+      server = await createTestServer({
+        public: {
+          documentRoot: path.resolve(__dirname, 'test-public'),
+        },
+      })
       baseUrl = server.baseUrl
       await server.start()
     })
@@ -45,6 +52,16 @@ describe('The server', function () {
         .and.to.include('apple')
     })
 
+    it('should serve front-end with default maxAge', async function () {
+      const { headers } = await got(`${baseUrl}/`)
+      expect(headers['cache-control']).to.equal('max-age=300, s-maxage=300')
+    })
+
+    it('should serve badges with custom maxAge', async function () {
+      const { headers } = await got(`${baseUrl}npm/l/express`)
+      expect(headers['cache-control']).to.equal('max-age=3600, s-maxage=3600')
+    })
+
     it('should redirect colorscheme PNG badges as configured', async function () {
       const { statusCode, headers } = await got(
         `${baseUrl}:fruit-apple-green.png`,
@@ -168,6 +185,79 @@ describe('The server', function () {
     })
   })
 
+  context('`requireCloudflare` is enabled', function () {
+    let server
+    afterEach(async function () {
+      if (server) {
+        server.stop()
+      }
+    })
+
+    it('should reject requests from localhost with an empty 200 response', async function () {
+      this.timeout(10000)
+      server = await createTestServer({ public: { requireCloudflare: true } })
+      await server.start()
+
+      const { statusCode, body } = await got(
+        `${server.baseUrl}badge/foo-bar-blue.svg`
+      )
+
+      expect(statusCode).to.be.equal(200)
+      expect(body).to.equal('')
+    })
+  })
+
+  describe('`requestTimeoutSeconds` setting', function () {
+    let server
+
+    beforeEach(async function () {
+      this.timeout(10000)
+
+      // configure server to time out requests that take >2 seconds
+      server = await createTestServer({ public: { requestTimeoutSeconds: 2 } })
+      await server.start()
+
+      // /fast returns a 200 OK after a 1 second delay
+      server.camp.route(/^\/fast$/, (data, match, end, ask) => {
+        setTimeout(() => {
+          ask.res.statusCode = 200
+          ask.res.end()
+        }, 1000)
+      })
+
+      // /slow returns a 200 OK after a 3 second delay
+      server.camp.route(/^\/slow$/, (data, match, end, ask) => {
+        setTimeout(() => {
+          ask.res.statusCode = 200
+          ask.res.end()
+        }, 3000)
+      })
+    })
+
+    afterEach(async function () {
+      if (server) {
+        server.stop()
+      }
+      server = undefined
+    })
+
+    it('should time out slow requests', async function () {
+      this.timeout(10000)
+      const { statusCode, body } = await got(`${server.baseUrl}slow`, {
+        throwHttpErrors: false,
+      })
+      expect(statusCode).to.be.equal(408)
+      expect(body).to.equal('Request Timeout')
+    })
+
+    it('should not time out fast requests', async function () {
+      this.timeout(10000)
+      const { statusCode, body } = await got(`${server.baseUrl}fast`)
+      expect(statusCode).to.be.equal(200)
+      expect(body).to.equal('')
+    })
+  })
+
   describe('configuration', function () {
     let server
     afterEach(async function () {
@@ -329,4 +419,67 @@ describe('The server', function () {
       })
     })
   })
+
+  describe('running with metrics enabled', function () {
+    let server, baseUrl, scope, clock
+    const metricsPushIntervalSeconds = 1
+    before('Start the server', async function () {
+      // Fixes https://github.com/badges/shields/issues/2611
+      this.timeout(10000)
+      process.env.INSTANCE_ID = 'test-instance'
+      server = await createTestServer({
+        public: {
+          metrics: {
+            prometheus: { enabled: true },
+            influx: {
+              enabled: true,
+              url: 'http://localhost:1112/metrics',
+              instanceIdFrom: 'env-var',
+              instanceIdEnvVarName: 'INSTANCE_ID',
+              envLabel: 'localhost-env',
+              intervalSeconds: metricsPushIntervalSeconds,
+            },
+          },
+        },
+        private: {
+          influx_username: 'influx-username',
+          influx_password: 'influx-password',
+        },
+      })
+      clock = sinon.useFakeTimers()
+      baseUrl = server.baseUrl
+      await server.start()
+    })
+    after('Shut down the server', async function () {
+      if (server) {
+        await server.stop()
+      }
+      server = undefined
+      nock.cleanAll()
+      delete process.env.INSTANCE_ID
+      clock.restore()
+    })
+
+    it('should push custom metrics', async function () {
+      scope = nock('http://localhost:1112', {
+        reqheaders: {
+          'Content-Type': 'application/x-www-form-urlencoded',
+        },
+      })
+        .post(
+          '/metrics',
+          /prometheus,application=shields,category=static,env=localhost-env,family=static-badge,instance=test-instance,service=static_badge service_requests_total=1\n/
+        )
+        .basicAuth({ user: 'influx-username', pass: 'influx-password' })
+        .reply(200)
+      await got(`${baseUrl}badge/fruit-apple-green.svg`)
+
+      await clock.tickAsync(1000 * metricsPushIntervalSeconds + 500)
+
+      expect(scope.isDone()).to.be.equal(
+        true,
+        `pending mocks: ${scope.pendingMocks()}`
+      )
+    })
+  })
 })

core/server/test-public/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>shields.io</title>
+  </head>
+  <body>
+    concise, consistent, legible
+  </body>
+</html>

core/service-test-runner/icedfrisby-shields.js

@@ -3,7 +3,7 @@
  * @module
  */
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 
 /**

core/service-test-runner/service-tester.js

@@ -84,7 +84,7 @@ class ServiceTester {
       .before(() => {
         this.beforeEach()
       })
-      // eslint-disable-next-line mocha/prefer-arrow-callback
+      // eslint-disable-next-line mocha/prefer-arrow-callback, promise/prefer-await-to-then
       .finally(function () {
         // `this` is the IcedFrisby instance.
         let responseBody

core/token-pooling/fs-token-persistence.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const fsos = require('fsos')
-const TokenPersistence = require('./token-persistence')
-
-class FsTokenPersistence extends TokenPersistence {
-  constructor({ path }) {
-    super()
-    this.path = path
-  }
-
-  async initialize() {
-    let contents
-    try {
-      contents = await fsos.get(this.path)
-    } catch (e) {
-      if (e.code === 'ENOENT') {
-        contents = '[]'
-      } else {
-        throw e
-      }
-    }
-
-    const tokens = JSON.parse(contents)
-    this._tokens = new Set(tokens)
-    return tokens
-  }
-
-  async save() {
-    const tokens = Array.from(this._tokens)
-    await fsos.set(this.path, JSON.stringify(tokens))
-  }
-
-  async onTokenAdded(token) {
-    if (!this._tokens) {
-      throw Error('initialize() has not been called')
-    }
-    this._tokens.add(token)
-    await this.save()
-  }
-
-  async onTokenRemoved(token) {
-    if (!this._tokens) {
-      throw Error('initialize() has not been called')
-    }
-    this._tokens.delete(token)
-    await this.save()
-  }
-}
-
-module.exports = FsTokenPersistence

core/token-pooling/fs-token-persistence.spec.js

@@ -1,72 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const tmp = require('tmp')
-const readFile = require('fs-readfile-promise')
-const { expect } = require('chai')
-const FsTokenPersistence = require('./fs-token-persistence')
-
-describe('File system token persistence', function () {
-  let path, persistence
-  beforeEach(function () {
-    path = tmp.tmpNameSync()
-    persistence = new FsTokenPersistence({ path })
-  })
-
-  context('when the file does not exist', function () {
-    it('does nothing', async function () {
-      const tokens = await persistence.initialize()
-      expect(tokens).to.deep.equal([])
-    })
-
-    it('saving creates an empty file', async function () {
-      await persistence.initialize()
-
-      await persistence.save()
-
-      const json = JSON.parse(await readFile(path))
-      expect(json).to.deep.deep.equal([])
-    })
-  })
-
-  context('when the file exists', function () {
-    const initialTokens = ['a', 'b', 'c'].map(char => char.repeat(40))
-
-    beforeEach(async function () {
-      fs.writeFileSync(path, JSON.stringify(initialTokens))
-    })
-
-    it('loads the contents', async function () {
-      const tokens = await persistence.initialize()
-      expect(tokens).to.deep.equal(initialTokens)
-    })
-
-    context('when tokens are added', function () {
-      it('saves the change', async function () {
-        const newToken = 'e'.repeat(40)
-        const expected = Array.from(initialTokens)
-        expected.push(newToken)
-
-        await persistence.initialize()
-        await persistence.noteTokenAdded(newToken)
-
-        const savedTokens = JSON.parse(await readFile(path))
-        expect(savedTokens).to.deep.equal(expected)
-      })
-    })
-
-    context('when tokens are removed', function () {
-      it('saves the change', async function () {
-        const expected = Array.from(initialTokens)
-        const toRemove = expected.pop()
-
-        await persistence.initialize()
-
-        await persistence.noteTokenRemoved(toRemove)
-
-        const savedTokens = JSON.parse(await readFile(path))
-        expect(savedTokens).to.deep.equal(expected)
-      })
-    })
-  })
-})

core/token-pooling/redis-token-persistence.js

@@ -3,13 +3,13 @@
 const { URL } = require('url')
 const Redis = require('ioredis')
 const log = require('../server/log')
-const TokenPersistence = require('./token-persistence')
 
-module.exports = class RedisTokenPersistence extends TokenPersistence {
+module.exports = class RedisTokenPersistence {
   constructor({ url, key }) {
-    super()
     this.url = url
     this.key = key
+    this.noteTokenAdded = this.noteTokenAdded.bind(this)
+    this.noteTokenRemoved = this.noteTokenRemoved.bind(this)
   }
 
   async initialize() {
@@ -40,4 +40,20 @@ module.exports = class RedisTokenPersistence extends TokenPersistence {
   async onTokenRemoved(token) {
     await this.redis.srem(this.key, token)
   }
+
+  async noteTokenAdded(token) {
+    try {
+      await this.onTokenAdded(token)
+    } catch (e) {
+      log.error(e)
+    }
+  }
+
+  async noteTokenRemoved(token) {
+    try {
+      await this.onTokenRemoved(token)
+    } catch (e) {
+      log.error(e)
+    }
+  }
 }

core/token-pooling/token-persistence.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const log = require('../server/log')
-
-// This is currently bound to the legacy github auth code. That will be
-// replaced with a dependency-injected token provider.
-class TokenPersistence {
-  constructor() {
-    this.noteTokenAdded = this.noteTokenAdded.bind(this)
-    this.noteTokenRemoved = this.noteTokenRemoved.bind(this)
-  }
-
-  async initialize() {
-    throw Error('initialize() is not implemented')
-  }
-
-  async stop() {}
-
-  async onTokenAdded(token) {
-    throw Error('onTokenAdded() is not implemented')
-  }
-
-  async noteTokenAdded(token) {
-    try {
-      await this.onTokenAdded(token)
-    } catch (e) {
-      log.error(e)
-    }
-  }
-
-  async onTokenRemoved(token) {
-    throw Error('onTokenRemoved() is not implemented')
-  }
-
-  async noteTokenRemoved(token) {
-    try {
-      await this.onTokenRemoved(token)
-    } catch (e) {
-      log.error(e)
-    }
-  }
-}
-
-module.exports = TokenPersistence

cypress/integration/main-page.spec.js

@@ -62,4 +62,13 @@ describe('Main page', function () {
 
     cy.get(`img[src='${backendUrl}/github/issues/badges/shields?color=orange']`)
   })
+
+  it('Do not duplicate example parameters', function () {
+    cy.visit('/category/funding')
+
+    cy.contains('GitHub Sponsors').click()
+    cy.get('[name="style"]').should($style => {
+      expect($style).to.have.length(1)
+    })
+  })
 })

dangerfile.js

@@ -111,10 +111,7 @@ if (allFiles.length > 100) {
 
     // eslint-disable-next-line promise/prefer-await-to-then
     danger.git.diffForFile(file).then(({ diff }) => {
-      if (
-        (diff.includes('authHelper') || diff.includes('serverSecrets')) &&
-        !secretsDocs.modified
-      ) {
+      if (diff.includes('authHelper') && !secretsDocs.modified) {
         warn(
           [
             `:books: Remember to ensure any changes to \`config.private\` `,
@@ -134,11 +131,11 @@ if (allFiles.length > 100) {
         )
       }
 
-      if (diff.includes("require('joi')")) {
+      if (diff.includes("require('@hapi/joi')")) {
         fail(
           [
-            `Found import of 'joi' in \`${file}\`. <br>`,
-            "Joi must be imported as '@hapi/joi'.",
+            `Found import of '@hapi/joi' in \`${file}\`. <br>`,
+            "Joi must be imported as 'joi'.",
           ].join('')
         )
       }

doc/TUTORIAL.md

@@ -25,7 +25,7 @@ and learn about the [Github workflow](http://try.github.io/).
 
 #### Node, NPM
 
-Node 10 or later is required. If you don't already have them,
+Node >=12 and NPM >=7 is required. If you don't already have them,
 install node and npm: https://nodejs.org/en/download/
 
 ### Setup a dev install
@@ -116,17 +116,10 @@ const { BaseService } = require('..')
 // (3)
 module.exports = class Example extends BaseService {
   // (4)
-  static get category() {
-    return 'build'
-  }
+  static category = 'build'
 
   // (5)
-  static get route() {
-    return {
-      base: 'example',
-      pattern: ':text',
-    }
-  }
+  static route = { base: 'example', pattern: ':text' }
 
   // (6)
   async handle({ text }) {
@@ -186,7 +179,7 @@ const { renderVersionBadge } = require('..//version')
 const { BaseJsonService } = require('..')
 
 // (4)
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const schema = Joi.object({
   version: Joi.string().required(),
 }).required()
@@ -194,22 +187,13 @@ const schema = Joi.object({
 // (5)
 module.exports = class GemVersion extends BaseJsonService {
   // (6)
-  static get category() {
-    return 'version'
-  }
+  static category = 'version'
 
   // (7)
-  static get route() {
-    return {
-      base: 'gem/v',
-      pattern: ':gem',
-    }
-  }
+  static route = { base: 'gem/v', pattern: ':gem' }
 
   // (8)
-  static get defaultBadgeData() {
-    return { label: 'gem' }
-  }
+  static defaultBadgeData = { label: 'gem' }
 
   // (11)
   static render({ version }) {
@@ -242,7 +226,7 @@ Description of the code:
    - [text-formatters.js](https://github.com/badges/shields/blob/master/services/text-formatters.js)
    - [version.js](https://github.com/badges/shields/blob/master/services/version.js)
 3. Our badge will query a JSON API so we will extend `BaseJsonService` instead of `BaseService`. This contains some helpers to reduce the need for boilerplate when calling a JSON API.
-4. We perform input validation by defining a schema which we expect the JSON we receive to conform to. This is done using [Joi](https://github.com/hapijs/joi). Defining a schema means we can ensure the JSON we receive meets our expectations and throw an error if we receive unexpected input without having to explicitly code validation checks. The schema also acts as a filter on the JSON object. Any properties we're going to reference need to be validated, otherwise they will be filtered out. In this case our schema declares that we expect to receive an object which must have a property called 'version', which is a string.
+4. We perform input validation by defining a schema which we expect the JSON we receive to conform to. This is done using [Joi](https://github.com/hapijs/joi). Defining a schema means we can ensure the JSON we receive meets our expectations and throw an error if we receive unexpected input without having to explicitly code validation checks. The schema also acts as a filter on the JSON object. Any properties we're going to reference need to be validated, otherwise they will be filtered out. In this case our schema declares that we expect to receive an object which must have a property called 'version', which is a string. There is further documentation on [input validation](input-validation.md).
 5. Our module exports a class which extends `BaseJsonService`
 6. Returns the name of the category to sort this badge into (eg. "build"). Used to sort the examples on the main [shields.io](https://shields.io) website. [Here](https://github.com/badges/shields/blob/master/services/categories.js) is the list of the valid categories. See [section 4.4](#44-adding-an-example-to-the-front-page) for more details on examples.
 7. As with our previous badge, we need to declare a route. This time we will capture a variable called `gem`.
@@ -298,23 +282,19 @@ Once we have implemented our badge, we can add it to the index so that users can
 module.exports = class GemVersion extends BaseJsonService {
   // ...
 
-  static get category() {
-    // (1)
-    return 'version'
-  }
+  // (1)
+  static category = 'version'
 
-  static get examples() {
-    // (2)
-    return [
-      {
-        // (3)
-        title: 'Gem',
-        namedParams: { gem: 'formatador' },
-        staticPreview: this.render({ version: '2.1.0' }),
-        keywords: ['ruby'],
-      },
-    ]
-  }
+  // (2)
+  static examples = [
+    {
+      // (3)
+      title: 'Gem',
+      namedParams: { gem: 'formatador' },
+      staticPreview: this.render({ version: '2.1.0' }),
+      keywords: ['ruby'],
+    },
+  ]
 }
 ```
 
@@ -331,7 +311,7 @@ Save, run `npm start`, and you can see it [locally](http://127.0.0.1:3000/).
 
 If you update `examples`, you don't have to restart the server. Run `npm run defs` in another terminal window and the frontend will update.
 
-### (4.5) Write Tests <!-- Change the link below when you change the heading -->
+### (4.5) Write Tests<!-- Change the link below when you change the heading -->
 
 [write tests]: #45-write-tests