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>

.dependabot/config.yml

@@ -31,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: 🎨 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/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/add_deployment_status.yml

@@ -1,28 +0,0 @@
-name: Ddd deployment status
-
-on:
-  pull_request_target:
-    types: [closed]
-
-jobs:
-  add_deployment_status:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Create comment
-        if: ${{ github.event_name == 'pull_request_target'
-          && github.event.action == 'closed'
-          && github.event.pull_request.merged
-          && !startsWith(github.event.pull_request.head.ref, 'dependabot/')
-          && github.event.pull_request.base.ref == 'master' }}
-        #       From a security perspective it's good practice to reference the commit hash
-        #       https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#security
-        uses: peter-evans/create-or-update-comment@41f3207a84f33bd70388036109082784d059dcaa
-        with:
-          issue-number: ${{ github.event.pull_request.number }}
-          edit-mode: replace
-          body: |
-            This pull request was merged to [${{ github.event.pull_request.base.ref }}](${{ github.event.repository.html_url }}/tree/${{ github.event.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](${{ github.event.repository.html_url }}/tree/gh-pages) branch: ![](https://img.shields.io/github/commit-status/${{ github.event.repository.full_name }}/gh-pages/${{ github.event.pull_request.merge_commit_sha }}.svg?label=deploy%20status)

.github/workflows/auto-approve.yml

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

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

CONTRIBUTING.md

@@ -101,7 +101,7 @@ There are three places to get help:
   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.
@@ -131,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.
@@ -153,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.

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:
 
@@ -91,10 +94,6 @@ 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)
-[![Hacktoberfest 2020](https://img.shields.io/github/hacktoberfest/2020/badges/shields?label=hacktoberfest%202020)](https://github.com/badges/shields/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest)
-
-Let's see if we can beat last year!
-[![Hacktoberfest 2019](https://img.shields.io/github/hacktoberfest/2019/badges/shields?label=hacktoberfest%202019)](https://github.com/badges/shields/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest)
 
 [service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
 [tutorial]: doc/TUTORIAL.md

__snapshots__/make-badge.spec.js

@@ -969,15 +969,15 @@ exports['The badge generator "for-the-badge" template badge generation should ma
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="145.5"
+  width="146.75"
   height="28"
   role="img"
   aria-label="CACTUS: GROWN"
 >
   <title>CACTUS: GROWN</title>
   <g shape-rendering="crispEdges">
-    <rect width="73" height="28" fill="#0f0" />
-    <rect x="73" width="72.5" height="28" fill="#b3e" />
+    <rect width="72.5" height="28" fill="#0f0" />
+    <rect x="72.5" width="74.25" height="28" fill="#b3e" />
   </g>
   <g
     fill="#fff"
@@ -986,16 +986,16 @@ exports['The badge generator "for-the-badge" template badge generation should ma
     text-rendering="geometricPrecision"
     font-size="100"
   >
-    <text fill="#fff" x="365" y="175" transform="scale(.1)" textLength="490">
+    <text transform="scale(.1)" x="362.5" y="175" textLength="485" fill="#fff">
       CACTUS
     </text>
     <text
-      fill="#fff"
-      x="1092.5"
-      y="175"
-      font-weight="bold"
       transform="scale(.1)"
-      textLength="485"
+      x="1096.25"
+      y="175"
+      textLength="502.5"
+      fill="#fff"
+      font-weight="bold"
     >
       GROWN
     </text>
@@ -1008,15 +1008,15 @@ exports['The badge generator "for-the-badge" template badge generation should ma
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="162.5"
+  width="163.75"
   height="28"
   role="img"
   aria-label="CACTUS: GROWN"
 >
   <title>CACTUS: GROWN</title>
   <g shape-rendering="crispEdges">
-    <rect width="90" height="28" fill="#0f0" />
-    <rect x="90" width="72.5" height="28" fill="#b3e" />
+    <rect width="89.5" height="28" fill="#0f0" />
+    <rect x="89.5" width="74.25" height="28" fill="#b3e" />
   </g>
   <g
     fill="#fff"
@@ -1032,16 +1032,16 @@ exports['The badge generator "for-the-badge" template badge generation should ma
       height="14"
       xlink:href="data:image/svg+xml;base64,PHN2ZyB4bWxu"
     />
-    <text fill="#fff" x="535" y="175" transform="scale(.1)" textLength="490">
+    <text transform="scale(.1)" x="532.5" y="175" textLength="485" fill="#fff">
       CACTUS
     </text>
     <text
-      fill="#fff"
-      x="1262.5"
-      y="175"
-      font-weight="bold"
       transform="scale(.1)"
-      textLength="485"
+      x="1266.25"
+      y="175"
+      textLength="502.5"
+      fill="#fff"
+      font-weight="bold"
     >
       GROWN
     </text>
@@ -1054,15 +1054,14 @@ exports['The badge generator "for-the-badge" template badge generation should ma
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="72.5"
+  width="74.25"
   height="28"
   role="img"
   aria-label="GROWN"
 >
   <title>GROWN</title>
   <g shape-rendering="crispEdges">
-    <rect width="0" height="28" fill="#b3e" />
-    <rect x="0" width="72.5" height="28" fill="#b3e" />
+    <rect width="74.25" height="28" fill="#b3e" />
   </g>
   <g
     fill="#fff"
@@ -1072,12 +1071,12 @@ exports['The badge generator "for-the-badge" template badge generation should ma
     font-size="100"
   >
     <text
-      fill="#fff"
-      x="362.5"
-      y="175"
-      font-weight="bold"
       transform="scale(.1)"
-      textLength="485"
+      x="371.25"
+      y="175"
+      textLength="502.5"
+      fill="#fff"
+      font-weight="bold"
     >
       GROWN
     </text>
@@ -1090,15 +1089,14 @@ exports['The badge generator "for-the-badge" template badge generation should ma
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="90.5"
+  width="94.25"
   height="28"
   role="img"
   aria-label="GROWN"
 >
   <title>GROWN</title>
   <g shape-rendering="crispEdges">
-    <rect width="0" height="28" fill="#555" />
-    <rect x="0" width="90.5" height="28" fill="#b3e" />
+    <rect width="94.25" height="28" fill="#b3e" />
   </g>
   <g
     fill="#fff"
@@ -1115,12 +1113,12 @@ exports['The badge generator "for-the-badge" template badge generation should ma
       xlink:href="data:image/svg+xml;base64,PHN2ZyB4bWxu"
     />
     <text
-      fill="#fff"
-      x="542.5"
-      y="175"
-      font-weight="bold"
       transform="scale(.1)"
-      textLength="485"
+      x="571.25"
+      y="175"
+      textLength="502.5"
+      fill="#fff"
+      font-weight="bold"
     >
       GROWN
     </text>
@@ -1133,7 +1131,7 @@ exports['The badge generator "for-the-badge" template badge generation should ma
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="104.5"
+  width="106.25"
   height="28"
   role="img"
   aria-label="GROWN"
@@ -1141,7 +1139,7 @@ exports['The badge generator "for-the-badge" template badge generation should ma
   <title>GROWN</title>
   <g shape-rendering="crispEdges">
     <rect width="32" height="28" fill="#0f0" />
-    <rect x="32" width="72.5" height="28" fill="#b3e" />
+    <rect x="32" width="74.25" height="28" fill="#b3e" />
   </g>
   <g
     fill="#fff"
@@ -1158,19 +1156,12 @@ exports['The badge generator "for-the-badge" template badge generation should ma
       xlink:href="data:image/svg+xml;base64,PHN2ZyB4bWxu"
     />
     <text
-      fill="#fff"
-      x="230"
-      y="175"
       transform="scale(.1)"
-      textLength="-60"
-    ></text>
-    <text
-      fill="#fff"
-      x="682.5"
+      x="691.25"
       y="175"
+      textLength="502.5"
+      fill="#fff"
       font-weight="bold"
-      transform="scale(.1)"
-      textLength="485"
     >
       GROWN
     </text>
@@ -1183,12 +1174,12 @@ exports['The badge generator "for-the-badge" template badge generation should ma
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="145.5"
+  width="146.75"
   height="28"
 >
   <g shape-rendering="crispEdges">
-    <rect width="73" height="28" fill="#0f0" />
-    <rect x="73" width="72.5" height="28" fill="#b3e" />
+    <rect width="72.5" height="28" fill="#0f0" />
+    <rect x="72.5" width="74.25" height="28" fill="#b3e" />
   </g>
   <g
     fill="#fff"
@@ -1198,20 +1189,26 @@ exports['The badge generator "for-the-badge" template badge generation should ma
     font-size="100"
   >
     <a target="_blank" xlink:href="https://shields.io/">
-      <rect width="73" height="28" fill="rgba(0,0,0,0)" />
-      <text fill="#fff" x="365" y="175" transform="scale(.1)" textLength="490">
+      <rect width="72.5" height="28" fill="rgba(0,0,0,0)" />
+      <text
+        transform="scale(.1)"
+        x="362.5"
+        y="175"
+        textLength="485"
+        fill="#fff"
+      >
         CACTUS
       </text>
     </a>
     <a target="_blank" xlink:href="https://www.google.co.uk/">
-      <rect width="72.5" height="28" x="73" fill="rgba(0,0,0,0)" />
+      <rect width="74.25" height="28" x="72.5" fill="rgba(0,0,0,0)" />
       <text
-        fill="#fff"
-        x="1092.5"
-        y="175"
-        font-weight="bold"
         transform="scale(.1)"
-        textLength="485"
+        x="1096.25"
+        y="175"
+        textLength="502.5"
+        fill="#fff"
+        font-weight="bold"
       >
         GROWN
       </text>
@@ -1911,15 +1908,15 @@ exports['The badge generator text colors should use black text when the message
 <svg
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink"
-  width="145.5"
+  width="146.75"
   height="28"
   role="img"
   aria-label="CACTUS: GROWN"
 >
   <title>CACTUS: GROWN</title>
   <g shape-rendering="crispEdges">
-    <rect width="73" height="28" fill="#000" />
-    <rect x="73" width="72.5" height="28" fill="#e2ffe1" />
+    <rect width="72.5" height="28" fill="#000" />
+    <rect x="72.5" width="74.25" height="28" fill="#e2ffe1" />
   </g>
   <g
     fill="#fff"
@@ -1928,16 +1925,16 @@ exports['The badge generator text colors should use black text when the message
     text-rendering="geometricPrecision"
     font-size="100"
   >
-    <text fill="#fff" x="365" y="175" transform="scale(.1)" textLength="490">
+    <text transform="scale(.1)" x="362.5" y="175" textLength="485" fill="#fff">
       CACTUS
     </text>
     <text
-      fill="#333"
-      x="1092.5"
-      y="175"
-      font-weight="bold"
       transform="scale(.1)"
-      textLength="485"
+      x="1096.25"
+      y="175"
+      textLength="502.5"
+      fill="#333"
+      font-weight="bold"
     >
       GROWN
     </text>

badge-maker/lib/badge-renderers.js

@@ -2,8 +2,14 @@
 
 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
@@ -20,19 +26,6 @@ function colorsForBackground(color) {
   }
 }
 
-function escapeXml(s) {
-  if (s === undefined || typeof s !== 'string') {
-    return undefined
-  } else {
-    return s
-      .replace(/&/g, '&')
-      .replace(/</g, '&lt;')
-      .replace(/>/g, '&gt;')
-      .replace(/"/g, '&quot;')
-      .replace(/'/g, '&apos;')
-  }
-}
-
 function roundUpToOdd(val) {
   return val % 2 === 0 ? val + 1 : val
 }
@@ -576,126 +569,232 @@ function forTheBadge({
   links,
   logo,
   logoWidth,
-  logoPadding,
   color = '#4c1',
   labelColor,
 }) {
-  // For the Badge is styled in all caps. Convert to caps here so widths can
-  // be measured using the correct characters.
+  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 = preferredWidthOf(label, { font: '10px Verdana' }) || 0
-  let messageWidth =
-    preferredWidthOf(message, { font: 'bold 10px Verdana' }) || 0
-  const height = 28
-  const hasLabel = label.length || labelColor
-  if (labelColor == null) {
-    labelColor = '#555'
-  }
-  const horizPadding = 9
-  const { hasLogo, totalLogoWidth, renderedLogo } = renderLogo({
-    logo,
-    badgeHeight: height,
-    horizPadding,
-    logoWidth,
-    logoPadding,
-  })
-
-  labelWidth += 10 + totalLogoWidth
-  if (label.length) {
-    // Add 10 px of padding, plus approximately 1 px of letter spacing per
-    // character.
-    labelWidth += 10 + 2 * label.length
-  } else if (hasLogo) {
-    if (hasLabel) {
-      labelWidth += 7
-    } else {
-      labelWidth -= 7
-    }
-  } else {
-    labelWidth -= 11
-  }
-
-  // Add 20 px of padding, plus approximately 1.5 px of letter spacing per
-  // character.
-  messageWidth += 20 + 1.5 * message.length
-  const leftWidth = hasLogo && !hasLabel ? 0 : labelWidth
-  const rightWidth =
-    hasLogo && !hasLabel ? messageWidth + labelWidth : messageWidth
-
-  labelColor = hasLabel || hasLogo ? labelColor : color
-
-  color = escapeXml(color)
-  labelColor = escapeXml(labelColor)
-
-  let [leftLink, rightLink] = links
-  leftLink = escapeXml(leftLink)
-  rightLink = escapeXml(rightLink)
+  const [leftLink, rightLink] = links
   const { hasLeftLink, hasRightLink } = hasLinks({ links })
 
-  const accessibleText = createAccessibleText({ label, message })
+  const outLabelColor = labelColor || '#555'
 
-  function renderLabelText() {
-    const { textColor } = colorsForBackground(labelColor)
-    const labelTextX = ((labelWidth + totalLogoWidth) / 2) * 10
-    const labelTextLength = (labelWidth - (24 + totalLogoWidth)) * 10
-    const escapedLabel = escapeXml(label)
+  // 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
 
-    const text = `<text fill="${textColor}" x="${labelTextX}" y="175" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
+  // 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,
+      },
+    })
 
     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
     }
   }
 
-  function renderMessageText() {
+  function getMessageElement() {
     const { textColor } = colorsForBackground(color)
-
-    const text = `<text fill="${textColor}" x="${
-      (labelWidth + messageWidth / 2) * 10
-    }" y="175" font-weight="bold" transform="scale(.1)" textLength="${
-      (messageWidth - 24) * 10
-    }">
-      ${escapeXml(message)}</text>`
+    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
     }
   }
 
+  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('')
   )
 }
 

badge-maker/lib/make-badge.js

@@ -2,10 +2,7 @@
 
 const { normalizeColor, toSvgColor } = require('./color')
 const badgeRenderers = require('./badge-renderers')
-
-function stripXmlWhitespace(xml) {
-  return xml.replace(/>\s+/g, '>').replace(/<\s+/g, '<').trim()
-}
+const { stripXmlWhitespace } = require('./xml')
 
 /*
 note: makeBadge() is fairly thinly wrapped so if we are making changes here

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>')
+  })
+})

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'
 
@@ -57,16 +57,15 @@ public:
   cacheHeaders:
     defaultCacheLengthSeconds: 'BADGE_MAX_AGE_SECONDS'
 
-  rateLimit: 'RATE_LIMIT'
-
   fetchLimit: 'FETCH_LIMIT'
 
+  requestTimeoutSeconds: 'REQUEST_TIMEOUT_SECONDS'
+  requestTimeoutMaxAgeSeconds: 'REQUEST_TIMEOUT_MAX_AGE_SECONDS'
+
   requireCloudflare: 'REQUIRE_CLOUDFLARE'
 
 private:
   azure_devops_token: 'AZURE_DEVOPS_TOKEN'
-  bintray_user: 'BINTRAY_USER'
-  bintray_apikey: 'BINTRAY_API_KEY'
   bitbucket_username: 'BITBUCKET_USER'
   bitbucket_password: 'BITBUCKET_PASS'
   bitbucket_server_username: 'BITBUCKET_SERVER_USER'

config/default.yml

@@ -27,12 +27,13 @@ public:
   cacheHeaders:
     defaultCacheLengthSeconds: 120
 
-  rateLimit: true
-
   handleInternalErrors: true
 
   fetchLimit: '10MB'
 
+  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/shields-io-production.yml

@@ -15,6 +15,4 @@ public:
   cors:
     allowedOrigin: ['http://shields.io', 'https://shields.io']
 
-  redirectUrl: 'https://shields.io/'
-
   rasterUrl: 'https://raster.shields.io'

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

@@ -183,10 +183,8 @@ class AuthHelper {
   }
 
   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-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-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.js

@@ -213,7 +213,18 @@ 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)

core/base-service/base.spec.js

@@ -329,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
@@ -353,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,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,
@@ -463,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',
@@ -512,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'
         )
@@ -545,7 +537,7 @@ 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')
     })
   })

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

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

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,10 +83,8 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
   }
 
   const allowedKeys = flattenQueryParams(handlerOptions.queryParams)
-  const {
-    cacheLength: serviceDefaultCacheLengthSeconds,
-    fetchLimitBytes,
-  } = handlerOptions
+  const { cacheLength: serviceDefaultCacheLengthSeconds, fetchLimitBytes } =
+    handlerOptions
 
   return (queryParams, match, end, ask) => {
     /*
@@ -121,8 +101,6 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
       return
     }
 
-    const reqTime = new Date()
-
     // `defaultCacheLengthSeconds` can be overridden by
     // `serviceDefaultCacheLengthSeconds` (either by category or on a badge-
     // by-badge basis). Then in turn that can be overridden by
@@ -151,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,
@@ -206,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
@@ -223,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) {
@@ -264,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.message !== badgeData.message
-        ) {
-          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
       })
@@ -299,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/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

@@ -82,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/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,57 +0,0 @@
-'use strict'
-
-const RateLimit = require('./rate-limit')
-
-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 (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/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/server.js

@@ -15,14 +15,11 @@ 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')
 
@@ -90,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() }),
@@ -140,19 +137,19 @@ 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),
+  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(),
@@ -162,6 +159,8 @@ 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(),
@@ -430,17 +429,17 @@ 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,
     }))
@@ -449,13 +448,7 @@ class Server {
       this.requireCloudflare()
     }
 
-    const { metricInstance } = this
-    this.cleanupMonitor = sysMonitor.setRoutes(
-      { rateLimit },
-      { server: camp, metricInstance }
-    )
-
-    const { githubConstellation } = this
+    const { githubConstellation, metricInstance } = this
     await githubConstellation.initialize(camp)
     if (metricInstance) {
       if (this.config.public.metrics.prometheus.endpointEnabled) {
@@ -473,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()))
@@ -481,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`,
@@ -190,6 +207,57 @@ describe('The server', function () {
     })
   })
 
+  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 () {
@@ -351,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/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

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)
+    })
+  })
 })

doc/TUTORIAL.md

@@ -25,7 +25,7 @@ and learn about the [Github workflow](http://try.github.io/).
 
 #### Node, NPM
 
-Node 12 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
@@ -226,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`.

doc/code-walkthrough.md

@@ -125,10 +125,9 @@ test this kind of logic through unit tests (e.g. of `render()` and
     registered.)
 2.  Scoutcamp invokes a callback with the four parameters:
     `( queryParams, match, end, ask )`. This callback is defined in
-    [`legacy-request-handler`][legacy-request-handler]. If the badge result
-    is found in a relatively small in-memory cache, the response is sent
-    immediately. Otherwise a timeout is set to handle unresponsive service
-    code and the next callback is invoked: the legacy handler function.
+    [`legacy-request-handler`][legacy-request-handler]. A timeout is set to
+    handle unresponsive service code and the next callback is invoked: the
+    legacy handler function.
 3.  The legacy handler function receives
     `( queryParams, match, sendBadge, request )`. Its job is to extract data
     from the regex `match` and `queryParams`, invoke `request` to fetch
@@ -162,8 +161,8 @@ test this kind of logic through unit tests (e.g. of `render()` and
     service’s defaults to produce an object that fully describes the badge to
     be rendered.
 9.  `sendBadge` is invoked with that object. It does some housekeeping on the
-    timeout and caches the result. Then it renders the badge to svg or raster
-    and pushes out the result over the HTTPS connection.
+    timeout. Then it renders the badge to svg or raster and pushes out the
+    result over the HTTPS connection.
 
 [error reporting]: https://github.com/badges/shields/blob/master/doc/production-hosting.md#error-reporting
 [coalescebadge]: https://github.com/badges/shields/blob/master/core/base-service/coalesce-badge.js

doc/input-validation.md

@@ -0,0 +1,50 @@
+# Input Data Validation
+
+When we receive input data from an upstream API, we perform input validation to:
+
+- Ensure we won't throw a runtime error trying to render a badge
+- Ensure we won't render badges with spurious or unexpected output e.g: ![](https://img.shields.io/badge/version-null-blue) ![](https://img.shields.io/badge/coverage-NaN%25-red) ![](https://img.shields.io/badge/build-undefined-red) ![](https://img.shields.io/badge/coverage---10%25-critical) etc
+- Express and document our understanding of the input data
+
+## Writing schemas and validation
+
+- The default validation mechanism should be to use [Joi](https://github.com/sideway/joi) to define a schema for the input data. Validation against Joi schemas is implemented in the base classes and inherited by every service class that extends them. Sometimes additional manual validation is needed which can't be covered by Joi and plugins in which case we implement it by hand.
+
+- If validation is implemented manually (because we need to enforce a constraint that can't be expressed with Joi), invalid data should throw an [InvalidResponse](https://contributing.shields.io/module-core_base-service_errors-InvalidResponse.html) exception.
+
+- Our definition of "valid" should not be stricter than the upstream API's definition of "valid".
+
+- The schema/validation we choose is informed by the assumptions we're making about the data. e.g:
+
+  - If we're going to use a value, make sure it exists.
+  - If we need to multiply it by something, we check it's a number.
+  - If we're going to call `.split()` on it, we make sure it's a string.
+  - If we're going to address `foo[0]`, `foo` must be an array.
+  - If we're going to sort a version on the assumption it is a semver, check it's a semver
+
+- We don't need to validate characteristics we don't rely on. For example, if we're just going to render a version on a badge with the same exact value from the API response and do not need to sort or transform the value, then it doesn't matter what format the version number is in. We can use a very relaxed schema to validate in this case, e.g. `Joi.string().required()`
+
+- If theory (docs) and practice (real-world API responses) conflict, real-world outputs take precedence over documented behaviour. e.g: if the docs say version is a semver but we learn that there are real-world packages where the version number is `0.3b` or `1.2.1.27` then we should accept those values in preference to enforcing the documented API behaviour.
+
+- Shields is descriptive rather than prescriptive. We reflect the established norms of the communities we serve.
+
+- It is fine to define a single schema which is applied to multiple badges. For example, we could define a schema that says:
+
+  ```js
+  const schema = Joi.object({
+    license: Joi.string().required(),
+    version: Joi.string().required(),
+  }).required()
+  ```
+
+  and have both the license and version badges validate the response against that schema.
+
+- For build status badges there is a shared [isBuildStatus](https://github.com/badges/shields/blob/master/services/build-status.js) validator. In most cases build status badges should use `isBuildStatus` or input validation and `renderBuildStatusBadge` should be used for rendering. Any additional status values can be added to the relevant color arrays.
+
+## Identifying problems
+
+- If we know of a real-world example of a package/repo/etc that causes us to render an invalid value on a badge (e.g: ![](https://img.shields.io/badge/version-null-blue) ![](https://img.shields.io/badge/coverage-NaN%25-red) ![](https://img.shields.io/badge/build-undefined-red) ) our input validation is broken and we should fix it.
+
+- If we know of a real-world example of a package/repo/etc that causes us to throw an unhandled runtime exception, our input validation is broken and we should fix it.
+
+- We should not fail to render a badge because of a validation failure on a field that isn't necessary to render the badge. In the above example of a shared license/version schema: If we become aware of a real-world example of a package/repo/etc that has a `version` key but not a `license` key then we should split the schema (or make `version` optional and handle the error in code).

doc/production-hosting.md

@@ -14,55 +14,43 @@ Production hosting is managed by the Shields ops team:
 [operations issues]: https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3Aoperations
 [ops discord]: https://discordapp.com/channels/308323056592486420/480747695879749633
 
-| Component                     | Subcomponent                    | People with access                                                                         |
-| ----------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------ |
-| shields-production-us         | Account owner                   | @paulmelnikow                                                                              |
-| shields-production-us         | Full access                     | @calebcartwright, @chris48s, @paulmelnikow, @pyvesb                                        |
-| shields-production-us         | Access management               | @calebcartwright, @chris48s, @paulmelnikow, @pyvesb                                        |
-| Compose.io Redis              | Account owner                   | @paulmelnikow                                                                              |
-| Compose.io Redis              | Account access                  | @paulmelnikow                                                                              |
-| Compose.io Redis              | Database connection credentials | @calebcartwright, @chris48s, @paulmelnikow, @pyvesb                                        |
-| Zeit Now                      | Team owner                      | @paulmelnikow                                                                              |
-| Zeit Now                      | Team members                    | @paulmelnikow, @chris48s, @calebcartwright, @platan                                        |
-| Raster server                 | Full access as team members     | @paulmelnikow, @chris48s, @calebcartwright, @platan                                        |
-| shields-server.com redirector | Full access as team members     | @paulmelnikow, @chris48s, @calebcartwright, @platan                                        |
-| Legacy badge servers          | Account owner                   | @espadrine                                                                                 |
-| Legacy badge servers          | ssh, logs                       | @espadrine                                                                                 |
-| Legacy badge servers          | Deployment                      | @espadrine, @paulmelnikow                                                                  |
-| Legacy badge servers          | Admin endpoints                 | @espadrine, @paulmelnikow                                                                  |
-| Cloudflare (CDN)              | Account owner                   | @espadrine                                                                                 |
-| Cloudflare (CDN)              | Access management               | @espadrine                                                                                 |
-| Cloudflare (CDN)              | Admin access                    | @calebcartwright, @chris48s, @espadrine, @paulmelnikow, @PyvesB                            |
-| Twitch                        | OAuth app                       | @PyvesB                                                                                    |
-| Discord                       | OAuth app                       | @PyvesB                                                                                    |
-| YouTube                       | Account owner                   | @PyvesB                                                                                    |
-| OpenStreetMap (for Wheelmap)  | Account owner                   | @paulmelnikow                                                                              |
-| DNS                           | Account owner                   | @olivierlacan                                                                              |
-| DNS                           | Read-only account access        | @espadrine, @paulmelnikow, @chris48s                                                       |
-| Sentry                        | Error reports                   | @espadrine, @paulmelnikow                                                                  |
-| Frontend                      | Deployment                      | Technically anyone with push access but in practice must be deployed with the badge server |
-| Metrics server                | Owner                           | @platan                                                                                    |
-| UptimeRobot                   | Account owner                   | @paulmelnikow                                                                              |
-| More metrics                  | Owner                           | @RedSparr0w                                                                                |
-| Netlify (documentation site)  | Owner                           | @chris48s                                                                                  |
-
-There are [too many bottlenecks][issue 2577]!
-
-[issue 2577]: https://github.com/badges/shields/issues/2577
+| Component                     | Subcomponent                    | People with access                                              |
+| ----------------------------- | ------------------------------- | --------------------------------------------------------------- |
+| shields-production-us         | Account owner                   | @paulmelnikow                                                   |
+| shields-production-us         | Full access                     | @calebcartwright, @chris48s, @paulmelnikow, @pyvesb             |
+| shields-production-us         | Access management               | @calebcartwright, @chris48s, @paulmelnikow, @pyvesb             |
+| Compose.io Redis              | Account owner                   | @paulmelnikow                                                   |
+| Compose.io Redis              | Account access                  | @paulmelnikow                                                   |
+| Compose.io Redis              | Database connection credentials | @calebcartwright, @chris48s, @paulmelnikow, @pyvesb             |
+| Zeit Now                      | Team owner                      | @paulmelnikow                                                   |
+| Zeit Now                      | Team members                    | @paulmelnikow, @chris48s, @calebcartwright, @platan             |
+| Raster server                 | Full access as team members     | @paulmelnikow, @chris48s, @calebcartwright, @platan             |
+| shields-server.com redirector | Full access as team members     | @paulmelnikow, @chris48s, @calebcartwright, @platan             |
+| Cloudflare (CDN)              | Account owner                   | @espadrine                                                      |
+| Cloudflare (CDN)              | Access management               | @espadrine                                                      |
+| Cloudflare (CDN)              | Admin access                    | @calebcartwright, @chris48s, @espadrine, @paulmelnikow, @PyvesB |
+| Twitch                        | OAuth app                       | @PyvesB                                                         |
+| Discord                       | OAuth app                       | @PyvesB                                                         |
+| YouTube                       | Account owner                   | @PyvesB                                                         |
+| OpenStreetMap (for Wheelmap)  | Account owner                   | @paulmelnikow                                                   |
+| DNS                           | Account owner                   | @olivierlacan                                                   |
+| DNS                           | Read-only account access        | @espadrine, @paulmelnikow, @chris48s                            |
+| Sentry                        | Error reports                   | @espadrine, @paulmelnikow                                       |
+| Metrics server                | Owner                           | @platan                                                         |
+| UptimeRobot                   | Account owner                   | @paulmelnikow                                                   |
+| More metrics                  | Owner                           | @RedSparr0w                                                     |
 
 ## Attached state
 
 Shields has mercifully little persistent state:
 
-1.  The GitHub tokens we collect are saved on each server in a cloud Redis database.
-    They can also be fetched from the [GitHub auth admin endpoint][] for debugging.
-2.  The server keeps a few caches in memory. These are neither persisted nor
-    inspectable.
-    - The [request cache][]
-    - The [regular-update cache][]
+1. The GitHub tokens we collect are saved on each server in a cloud Redis
+   database. They can also be fetched from the [GitHub auth admin endpoint][]
+   for debugging.
+2. The server keeps the [regular-update cache][] in memory. It is neither
+   persisted nor inspectable.
 
 [github auth admin endpoint]: https://github.com/badges/shields/blob/master/services/github/auth/admin.js
-[request cache]: https://github.com/badges/shields/blob/master/core/base-service/legacy-request-handler.js#L29-L30
 [regular-update cache]: https://github.com/badges/shields/blob/master/core/legacy/regular-update.js
 
 ## Configuration
@@ -90,32 +78,17 @@ files:
 [shields-io-production.yml]: ../config/shields-io-production.yml
 [default.yml]: ../config/default.yml
 
-The project ships with `dotenv`, however there is no `.env` in production.
-
 ## Badge CDN
 
 Sitting in front of the three servers is a Cloudflare Free account which
 provides several services:
 
-- Global CDN, caching, and SSL gateway for `img.shields.io`
+- Global CDN, caching, and SSL gateway for `img.shields.io` and `shields.io`
 - Analytics through the Cloudflare dashboard
-- DNS hosting for `shields.io`
+- DNS resolution for `shields.io` (and subdomains)
 
 Cloudflare is configured to respect the servers' cache headers.
 
-## Frontend
-
-The frontend is served by [GitHub Pages][] via the [gh-pages branch][gh-pages]. SSL is enforced.
-
-`shields.io` resolves to the GitHub Pages hosts. It is not proxied through
-Cloudflare.
-
-Technically any maintainer can push to `gh-pages`, but in practice the frontend must be deployed
-with the badge server via the deployment process described below.
-
-[github pages]: https://pages.github.com/
-[gh-pages]: https://github.com/badges/shields/tree/gh-pages
-
 ## Raster server
 
 The raster server `raster.shields.io` (a.k.a. the rasterizing proxy) is
@@ -125,28 +98,14 @@ hosted on [Zeit Now][]. It's managed in the
 [zeit now]: https://zeit.co/now
 [svg-to-image-proxy]: https://github.com/badges/svg-to-image-proxy
 
-## Deployment
+### Heroku Deployment
 
-The deployment is done in two stages: the badge server (heroku) and the front-end (gh-pages).
-
-### Heroku
+Both the badge server and frontend are served from Heroku.
 
 After merging a commit to master, heroku should create a staging deploy. Check this has deployed correctly in the `shields-staging` pipeline and review http://shields-staging.herokuapp.com/
 
 If we're happy with it, "promote to production". This will deploy what's on staging to the `shields-production-eu` and `shields-production-us` pieplines.
 
-### Frontend
-
-To deploy the front-end to GH pages, use a clean clone of the shields repo.
-
-```sh
-$ git pull  # update the working copy
-$ npm ci  # install dependencies (devDependencies are needed to build the frontend)
-$ make deploy-gh-pages  # build the frontend and push it to the gh-pages branch
-```
-
-No secrets are required to build or deploy the frontend.
-
 ## DNS
 
 DNS is registered with [DNSimple][].
@@ -169,6 +128,13 @@ the server. It's generously donated by [Sentry][sentry home]. We bundle
 [sentry home]: https://sentry.io/shields/
 [sentry configuration]: https://github.com/badges/shields/blob/master/doc/self-hosting.md#sentry
 
+## URLs
+
+The canonical and only recommended domain for badge URLs is `img.shields.io`. Currently it is possible to request badges on both `img.shields.io` and `shields.io` i.e: https://img.shields.io/badge/build-passing-brightgreen and https://shields.io/badge/build-passing-brightgreen will both work. However:
+
+- We never show or generate the `img.`-less URL format on https://shields.io/
+- We make no guarantees about the `img.`-less URL format. At some future point we may remove the ability to serve badges on `shields.io` (without `img.`) without any warning. `img.shields.io` should always be used for badge urls.
+
 ## Monitoring
 
 Overall server performance and requests by service are monitored using
@@ -188,19 +154,3 @@ Request performance is monitored in two places:
 [monitor]: https://shields.redsparr0w.com/1568/
 [notifications]: http://shields.redsparr0w.com/discord_notification
 [monitor discord]: https://discordapp.com/channels/308323056592486420/470700909182320646
-
-## Legacy servers
-
-There are three legacy servers on OVH VPS’s which are currently used for proxying.
-
-| Cname                       | Hostname             | Type | IP             | Location           |
-| --------------------------- | -------------------- | ---- | -------------- | ------------------ |
-| [s0.servers.shields.io][s0] | vps71670.vps.ovh.ca  | VPS  | 192.99.59.72   | Quebec, Canada     |
-| [s1.servers.shields.io][s1] | vps244529.ovh.net    | VPS  | 51.254.114.150 | Gravelines, France |
-| [s2.servers.shields.io][s2] | vps117870.vps.ovh.ca | VPS  | 149.56.96.133  | Quebec, Canada     |
-
-[s0]: https://s0.servers.shields.io/index.html
-[s1]: https://s1.servers.shields.io/index.html
-[s2]: https://s2.servers.shields.io/index.html
-
-The only way to inspect the commit on the server is with `git ls-remote`.

doc/releases.md

@@ -0,0 +1,57 @@
+# Releases
+
+Shields is a community project that is stewarded by a handful of core maintainers who contribute on a volunteer basis. We do our best to maintain the availability and reliability of the service, and enhance and improve the project overall. However, if you've spotted something wrong or would like to see a specific feature implemented, please consider helping us resolve it by submitting a pull request. All community contributions, even documentation improvements, are welcome!
+
+https://github.com/badges/shields is a monorepo and hosts the Shields frontend and server code as well as the [badge-maker][npm package] NPM library (and the [badge design specification](https://github.com/badges/shields/tree/master/spec)). The packaging and release processes for these items is described in the respective sections below.
+
+## badge-maker package
+
+We follow [Semantic Versioning](https://semver.org/) for the badge-maker package, and publish git Tags using the form `X.Y.Z`, and all such tags of this form are badge-maker releases (e.g. [3.3.0](https://github.com/badges/shields/releases/tag/3.3.0))
+
+The [badge-maker][npm package] is also published to the npm.js registry.
+
+Releases of badge-maker are done as and when needed, and not on any predetermined interval.
+
+## Shields.io service
+
+The [Shields.io Service][shields.io] consists of the frontend [https://shields.io][shields.io] website which allows users to browse and discover available badges, as well as the badge server backend that serves up requested badges (e.g. https://img.shields.io/badge/badges-rock-blue).
+
+This is the core, free, anonymous service available for anyone to use and which serves up hundreds of millions of badges every month!
+
+We do not have a fixed schedule for deploying updates to the Shields.io production environment, but we typically deploy the latest version at least once per week.
+
+We do not have any guaranteed SLA for the Shields.io service, but we do have monitoring and observability capabilities in place and our [Operations team](https://github.com/badges/shields#project-leaders) will review and address any availability, performance, etc. issues on a best-effort basis.
+
+More information about the production environment can be found [here][production hosting]
+
+## Shields server
+
+Some users may wish to host their own instance of Shields so we also make it possible for users to do so. This is particularly useful if you want to serve badges for resources that require authentication or are not exposed to the internet (e.g: inside a corporate network). A variety of options are available either by installing from source or using a docker image.
+
+### Important information
+
+This Shields server is the exact same codebase that powers the main Shields.io service; we do not have a separate self-hosted version of Shields. This means that the server codebase is geared towards the development, maintenance, and operation of the Shields.io service so there are a few things to note:
+
+- We often have to reject or de-prioritize feature requests that are only applicable for self-hosting and/or which may be problematic for the core Shields.io offering (e.g. requiring authentication on the badge server)
+- We do not accept new badges that cannot be utilized with Shields.io (e.g. those that would always require user-specific authorization)
+- We do not do any additional testing nor validation of self-hosted instances (e.g. we test Shields.io with Jira Cloud badges, but we don't test a self-hosted Shields server against a self-hosted Jira server instance with auth)
+- We're happy to try to offer some tips and guidance to self-hosters when and where we can, but we don't have the ability to troubleshoot/debug/support/etc. self-hosted Shields servers
+  - Note that Paul, a core team member, offers some paid support options for those interested in self-hosting support. Contact him at ![](https://img.shields.io/badge/paul-%40m6ize.com-blue) for more information.
+
+We are happy to document and collate any self-hosting patterns/approaches that others have found to be helpful to be able to share with the broader community. If you have any self-hosting material you'd like to share, please feel free to get in contact with us (or even open a PR) and we'll work with you to get that incorporated for the benefit of other self-hosters!
+
+### Server Releases
+
+We try to make it as easy as possible for users to self-host a Shields server so we publish a few releases of the server. Please be sure to refer to the [self hosting guide][self hosting] for a detailed walk through on how to spin up a server.
+
+- The server uses [Calendar Versioning](https://calver.org/). Tags of the form `server-YYYY-MM-DD` are server releases (these are the tags that are relevant to self-hosting users, e.g. [server-2021-02-01](https://github.com/badges/shields/releases/tag/server-2021-02-01)).
+- As well as [tags on GitHub](https://github.com/badges/shields/tags), server releases are also pushed to [DockerHub](https://registry.hub.docker.com/r/shieldsio/shields/tags). See the self-hosting section on [Docker](https://github.com/badges/shields/blob/master/doc/self-hosting.md#Docker) for more details.
+- We publish release notes for server releases in the [CHANGELOG](https://github.com/badges/shields/blob/master/CHANGELOG.md). There may occasionally be non-backwards compatible changes to be aware of.
+- We will normally put out one release per month. If there is a security patch or major bugfix affecting self-hosting users, we may put out an out-of-sequence release.
+- Releases are just a snapshot in time. We advise always tracking the latest release to ensure you are up-to-date with the latest bug fixes and security updates. There are no 'patch' releases - we don't backport fixes to old releases. Tagged versions just provide a convenient way to apply upgrades in a controlled way or roll back to an older version if necessary and communicate about versions.
+- You can stay on the bleeding edge by tracking the `master` branch for source installs or the `next` tag on DockerHub.
+
+[shields.io]: https://shields.io
+[npm package]: https://www.npmjs.com/package/badge-maker
+[production hosting]: https://github.com/badges/shields/blob/master/doc/production-hosting.md
+[self hosting]: https://github.com/badges/shields/blob/master/doc/self-hosting.md

doc/rewriting-services.md

@@ -1,283 +0,0 @@
-**_WARNING: all legacy services have been rewritten, this document may contain outdated information._**
-
-# Tips for rewriting legacy services
-
-## Background
-
-The services are in the process of being rewritten to use our new service
-framework ([#1358](https://github.com/badges/shields/issues/1358)).
-Meanwhile, the legacy services extend from an abstract
-adapter called [LegacyService][] which provides a place to put the
-`camp.route()` invocation. The wrapper extends from [BaseService][], so it
-supports badge examples via `category`, `examples`, and `route`. Setting `route`
-also enables `createServiceTester()` to infer a service's base path, reducing
-boilerplate for [creating the tester][creating a tester].
-
-Legacy services look like:
-
-```js
-module.exports = class ExampleService extends LegacyService {
-  static category = 'build'
-
-  static registerLegacyRouteHandler({ camp, cache }) {
-    camp.route(
-      /^\/example\/([^\/]+)\/([^\/]+)\.(svg|png|gif|jpg|json)$/,
-      cache(function (data, match, sendBadge, request) {
-        var first = match[1]
-        var second = match[2]
-        var format = match[3]
-        var badgeData = getBadgeData('X' + first + 'X', data)
-        badgeData.text[1] = second
-        badgeData.colorscheme = 'blue'
-        badgeData.colorB = '#008bb8'
-        sendBadge(format, badgeData)
-      })
-    )
-  }
-}
-```
-
-References:
-
-- Current documentation
-  - [Defining a route][]
-  - [Defining examples][]
-  - [Creating a tester][]
-- [BaseService, the new service framework][baseservice]
-- [LegacyService, the adapter][legacyservice]
-- [Obsolete tutorial on legacy services][old tutorial], possibly useful as a reference
-
-[old tutorial]: https://github.com/badges/shields/blob/e25e748a03d4cbb50c60b69d2b2404fc08e7cead/doc/TUTORIAL.md
-[defining a route]: https://github.com/badges/shields/blob/master/doc/TUTORIAL.md#42-our-first-badge
-[defining examples]: https://github.com/badges/shields/blob/master/doc/TUTORIAL.md#44-adding-an-example-to-the-front-page
-[creating a tester]: https://github.com/badges/shields/blob/master/doc/service-tests.md#1-boilerplate
-[baseservice]: https://github.com/badges/shields/blob/master/services/base.js
-[legacyservice]: https://github.com/badges/shields/blob/master/services/legacy-service.js
-
-## First, write some tests
-
-If service tests don’t exist for the legacy service, stop and write them first.
-It’s recommended to PR these separately. If there’s some test coverage, it’s
-probably fine to move right ahead and add more in the process. Make sure the
-tests are passing, though.
-
-## Organization
-
-1. When there’s a single legacy service that handles lots of different things
-   (e.g. version, license, and downloads), it should be split into three separate
-   service classes and placed in three separate files, e.g.:
-
-- `example-version.service.js`
-- `example-license.service.js`
-- `example-downloads.service.js`
-
-2. When a badge offers different variants of basically the same thing, it’s okay
-   to put them in the same service class. For example, daily/weekly/monthly/total
-   downloads can go in one badge, and star rating vs point rating vs rating count
-   can go in one badge, and same with various kinds of detail about a pull request.
-   The hard limit (as of now anyway) is _one category per service class_.
-
-3. If the tests haven’t been split up, split them up too and make sure they
-   still pass.
-
-## Get the route working
-
-1. Disable the legacy service by adding a `return` at the top of
-   `registerLegacyRouteHandler()`.
-
-2. Set up the route for one of the badges. First determine if you can express
-   the route using a `pattern`. A `pattern` (e.g. `pattern: ':param1/:param2'`) is
-   the simplest way to declare the route, also the most readable, and will be
-   useful for displaying a badge builder with fields in the front end and
-   generating badge URLs programmatically.
-
-3. When creating the initial route, you can stub out the service. A minimal
-   service extends BaseJsonService (or BaseService, or one of the others), and
-   defines `route()` and `handle()`. `defaultBadgeData` is optional but suggested:
-
-```js
-const BaseJsonService = require('../base-json')
-
-class ExampleDownloads extends BaseJsonService {
-  static route = { base: 'example/d', pattern: ':param1/:param2' }
-
-  static defaultBadgeData() {
-    return { label: 'downloads' } // or whatever
-  }
-
-  async handle({ param1, param2 }) {
-    return { message: 'hello' }
-  }
-}
-```
-
-4. We don’t have really good tools for debugging matches, so the best you can do
-   is run a subset of your tests. To run a single service test, add `.only()`
-   somewhere in the chain, and run `npm run test:services:trace -- --only=example`.
-
-```js
-t.create('build status')
-  .get('/pip.json')
-  .only() // Prevent this ServiceTester from running its other tests.
-  .expectBadge(
-    label: 'docs',
-    message: Joi.alternatives().try(isBuildStatus, Joi.equal('unknown')),
-  )
-```
-
-5. Presumably the test will fail, though by examining the copious output, you
-   can confirm the route was matched and the named parameters mapped successfully.
-   Since you'll have just run the tests on the old code (right?) you'll know you
-   haven't inadvertently changed the route (an easy mistake to make).
-
-6. If the legacy service had a base URL and you've changed it, you’ll need to
-   update the tests _and_ the examples. Take care to do that.
-
-## Implement `render()` and `handle()`
-
-Once the route is working, fill out `render()` and `handle()`.
-
-1. If there’s a single service, you can implement fetch as a method or a
-   function at the top of the file. If there are more than one service which share
-   fetching code, you can put the fetch function in `example-common.js` like this
-   one for github:
-
-<details>
-
-```js
-const Joi = require('joi')
-const { errorMessagesFor } = require('./github-helpers')
-
-const issueSchema = Joi.object({
-  head: Joi.object({
-    sha: Joi.string().required(),
-  }).required(),
-}).required()
-
-async function fetchIssue(serviceInstance, { user, repo, number }) {
-  return serviceInstance._requestJson({
-    schema: issueSchema,
-    url: `/repos/${user}/${repo}/pulls/${number}`,
-    errorMessages: errorMessagesFor('pull request or repo not found'),
-  })
-}
-
-module.exports = {
-  fetchIssue,
-}
-```
-
-</details>
-
-or create an abstract superclass like **PypiBase**:
-
-<details>
-
-```js
-const Joi = require('joi')
-const BaseJsonService = require('../base-json')
-
-const schema = Joi.object({
-  info: Joi.object({
-    ...
-  }).required()
-}).required()
-
-module.exports = class PypiBase extends BaseJsonService {
-  static buildRoute(base) {
-    return {
-      base,
-      pattern: ':egg*',
-    }
-  }
-
-  async fetch({ egg }) {
-    return this._requestJson({
-      schema,
-      url: `https://pypi.org/pypi/${egg}/json`,
-      errorMessages: { 404: 'package or version not found' },
-    })
-  }
-}
-```
-
-</details>
-
-2. Validation should be handled using Joi. Save this for last. While you're
-   getting things working, you can use `const schema = Joi.any()`, which matches
-   anything.
-
-3. Substitution of default values should also be handled by Joi, using
-   `.default()`.
-
-4. To keep with the design pattern of `render()`, formatting concerns, including
-   concatenation and color computation, should be dealt with inside `render()`.
-   This helps avoid static examples falling out of sync with the implementation.
-
-## Error handling
-
-BaseService includes built-in runtime error handling. Error classes are defined
-in `services/errors.js`. Request code and validation code will throw a runtime
-error, which will then bubble up to BaseService, which then renders an error
-badge. The cases covered by built-in error handling need not be tested in each
-service, and existing tests should be removed.
-
-1. If an external server can't be reached or returns a 5xx status code,
-   `_requestJson()` along with code in `lib/error-helper.js` will bubble up an
-   **Inaccessible** error.
-
-2. If a response does not match the schema, `validate()` will bubble up an
-   **InvalidResponse** error which will display **invalid response data**.
-
-Error handling can also be customized by the service. Alternate messages
-corresponding to HTTP status codes can be specified in the `errorMessages`
-parameter to `_requestJson()` etc.
-
-For the not found case, a service test should establish that the API is doing
-what we expect. If the API returns a 404 error, code in `lib/error-helper.js`
-will automatically throw a **NotFound** error. The error message can, and
-generally should be customized to display something more specific like
-**package not found** or **room not found**.
-
-Not all services return a 404 response in the not found case. Sometimes a
-different status code is returned.
-
-Sometimes a 200 response must be examined to distinguish the not found case from a success case. This can be handled in either of two ways:
-
-- Write a schema which accommodates both the success and error cases.
-- Write the schema for the success case. Pass `schema: Joi.any()` to
-  `_requestJson()`. Manually check for the error case, then invoke
-  `_validate()` with the success-case schema.
-
-In either case, the service should throw e.g
-`new NotFound({ prettyMessage: 'package not found' })`.
-
-## Convert the examples
-
-1. Convert all the examples to `pattern`, `namedParams`, and `staticExample`. In some cases you can use the `pattern` inherited from `route`, though in other cases you may need to specify a pattern in the example. For example, when showing download badges for several periods, you may want to render the example with an explicit `dt` instead of `:which`. You will also need to specify a pattern for badges that use a `format` regex in the route.
-
-2. Open the frontend and check that the static preview badges look good.
-   Remember, none of them are live.
-
-3. Open up the prepared example URLs in their own tabs, and make sure they work correctly.
-
-## Validation
-
-When it's time to add the schema, refer to the Joi API docs:
-https://github.com/hapijs/joi/blob/master/API.md
-
-## Housekeeping
-
-Switch to `createServiceTester`:
-
-```js
-const t = (module.exports = require('../tester').createServiceTester())
-```
-
-This may require updating the URLs, which will be relative to the service's base
-URL. When using `createServiceTester`, services need to be specified using
-the non-case-sensitive service class name, or a leading substring (e.g.
-`AppveyorTests` or `appveyor`).
-
-Do this last. Since it involves changing test URLs, and you don't want to
-accidentally change them.

doc/self-hosting.md

@@ -1,6 +1,8 @@
 # Hosting your own Shields server
 
-## Installation
+This document describes how to host your own shields server either from source or using a docker image. See the docs on [releases](https://github.com/badges/shields/blob/master/doc/releases.md#shields-server) for info on how we version the server and how to choose a release.
+
+## Installing from Source
 
 You will need Node 12 or later, which you can install using a
 [package manager][].
@@ -14,18 +16,19 @@ curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -; sudo apt-get in
 ```sh
 git clone https://github.com/badges/shields.git
 cd shields
+git checkout $(git tag | grep server | tail -n 1)  # checkout the latest tag
 npm ci  # You may need sudo for this.
 ```
 
 [package manager]: https://nodejs.org/en/download/package-manager/
 
-## Build the frontend
+### Build the frontend
 
 ```sh
 npm run build
 ```
 
-## Start the server
+### Start the server
 
 ```sh
 sudo node server
@@ -44,7 +47,7 @@ The root gets redirected to https://shields.io.
 
 For testing purposes, you can go to `http://localhost/`.
 
-## Heroku
+### Deploying to Heroku
 
 Once you have installed the [Heroku CLI][]
 
@@ -57,9 +60,32 @@ heroku open
 
 [heroku cli]: https://devcenter.heroku.com/articles/heroku-cli
 
+### Deploying to Zeit Vercel
+
+To deploy using Zeit Vercel:
+
+```console
+npm run build  # Not sure why, but this needs to be run before deploying.
+vercel
+```
+
 ## Docker
 
-You can build and run the server locally using Docker. First build an image:
+### DockerHub
+
+We publish images to DockerHub at https://registry.hub.docker.com/r/shieldsio/shields
+
+The `next` tag is the latest build from `master`, or tagged releases are available
+https://registry.hub.docker.com/r/shieldsio/shields/tags
+
+```console
+$ docker pull shieldsio/shields:next
+$ docker run shieldsio/shields:next
+```
+
+### Building Docker Image Locally
+
+Alternatively, you can build and run the server locally using Docker. First build an image:
 
 ```console
 $ docker build -t shields .
@@ -114,15 +140,6 @@ preconfigured raster server.
 [raster server]: https://github.com/badges/svg-to-image-proxy
 [micro]: https://github.com/zeit/micro
 
-## Zeit Now
-
-To deploy using Zeit Now:
-
-```console
-npm run build  # Not sure why, but this needs to be run before deploying.
-now
-```
-
 ## Persistence
 
 To enable Redis-backed GitHub token persistence, point `REDIS_URL` to your
@@ -195,19 +212,19 @@ private:
 sudo node server
 ```
 
-### Prometheus
+## Prometheus
 
 Shields uses [prom-client](https://github.com/siimon/prom-client) to provide [default metrics](https://prometheus.io/docs/instrumenting/writing_clientlibs/#standard-and-runtime-collectors). These metrics are disabled by default.
-You can enable them by `METRICS_PROMETHEUS_ENABLED` environment variable.
+You can enable them by `METRICS_PROMETHEUS_ENABLED` and `METRICS_PROMETHEUS_ENDPOINT_ENABLED` environment variables.
 
 ```bash
-METRICS_PROMETHEUS_ENABLED=true npm start
+METRICS_PROMETHEUS_ENABLED=true METRICS_PROMETHEUS_ENDPOINT_ENABLED=true npm start
 ```
 
 Metrics are available at `/metrics` resource.
 
-### Cloudflare
+## Cloudflare
 
-Shields uses Cloudflare as a downstream CDN. If your installation does the same,
+Shields.io uses Cloudflare as a downstream CDN. If your installation does the same,
 you can configure your server to only accept requests coming from Cloudflare's IPs.
 Set `public.requireCloudflare: true`.

doc/server-secrets.md

@@ -80,14 +80,6 @@ An Azure DevOps Token (PAT) is required for accessing [private Azure DevOps proj
 [ado personal access tokens]: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=vsts#create-personal-access-tokens-to-authenticate-access
 [ado token scopes]: https://docs.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=vsts#scopes
 
-### Bintray
-
-- `BINTRAY_USER` (yml: `private.bintray_user`)
-- `BINTRAY_API_KEY` (yml: `private.bintray_apikey`)
-
-The bintray API [requires authentication](https://bintray.com/docs/api/#_authentication)
-Create an account and obtain a token from the user profile page.
-
 ### Bitbucket (Cloud)
 
 - `BITBUCKET_USER` (yml: `private.bitbucket_username`)

doc/service-tests.md

@@ -260,21 +260,9 @@ npm run coverage:report:open
 
 ## Pull requests
 
-The affected service ids should be included in square brackets in the pull request
-title. That way, Circle CI 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.
+Pull requests must follow the [documented conventions][pr-conventions] in order to execute the correct set of service tests.
 
-For example:
-
-- [Travis] Fix timeout issues
-- [Travis Sonar] Support user token authentication
-- Add tests for [CRAN] and [CPAN]
-
-In the rare case when it's necessary to see the output of a full service-test
-run in a PR, 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.
+[pr-conventions]: https://github.com/badges/shields/blob/master/CONTRIBUTING.md#running-service-tests-in-pull-requests
 
 ## Getting help
 

doc/users.md

@@ -1,50 +0,0 @@
-# Notable Projects Using Shields
-
-- https://github.com/AFNetworking/AFNetworking
-- https://github.com/angular/angular.js
-- https://github.com/ansible/ansible
-- https://github.com/apple/swift
-- https://github.com/atom/atom
-- https://github.com/babel/babel
-- https://github.com/bevacqua/dragula
-- https://github.com/bower/bower
-- https://github.com/chartjs/Chart.js
-- https://github.com/creationix/nvm
-- https://github.com/discourse/discourse
-- https://github.com/docker/docker
-- https://github.com/electron/electron
-- https://github.com/elm-lang/core
-- https://github.com/emberjs/ember.js
-- https://github.com/expressjs/express
-- https://github.com/facebook/react
-- https://github.com/FortAwesome/Font-Awesome
-- https://github.com/gitlabhq/gitlabhq
-- https://github.com/gulpjs/gulp
-- https://github.com/h5bp/html5-boilerplate
-- https://github.com/jakubroztocil/httpie
-- https://github.com/jekyll/jekyll
-- https://github.com/kennethreitz/requests
-- https://github.com/kubernetes/kubernetes
-- https://github.com/laravel/laravel
-- https://github.com/less/less.js
-- https://github.com/Microsoft/TypeScript
-- https://github.com/Microsoft/vscode
-- https://github.com/mitchellh/vagrant
-- https://github.com/Modernizr/Modernizr
-- https://github.com/moment/moment
-- https://github.com/mrdoob/three.js
-- https://github.com/necolas/normalize.css
-- https://github.com/nodejs/node
-- https://github.com/plataformatec/devise
-- https://github.com/postcss/postcss
-- https://github.com/rails/rails
-- https://github.com/reactjs/redux
-- https://github.com/socketio/socket.io
-- https://github.com/tensorflow/tensorflow
-- https://github.com/TryGhost/Ghost
-- https://github.com/twbs/bootstrap
-- https://github.com/videojs/video.js
-- https://github.com/vuejs/vue
-- https://github.com/webpack/webpack
-- https://github.com/yarnpkg/yarn
-- https://github.com/zurb/foundation-sites

frontend/components/customizer/customizer.tsx

@@ -11,13 +11,6 @@ import {
   CopiedContentIndicatorHandle,
 } from './copied-content-indicator'
 
-function getBaseUrlFromWindowLocation(): string {
-  // Default to the current hostname for when there is no `BASE_URL` set
-  // at build time (as in most PaaS deploys).
-  const { protocol, hostname } = window.location
-  return `${protocol}//${hostname}`
-}
-
 export default function Customizer({
   baseUrl,
   title,
@@ -39,9 +32,8 @@ export default function Customizer({
 }): JSX.Element {
   // https://github.com/DefinitelyTyped/DefinitelyTyped/issues/35572
   // https://github.com/DefinitelyTyped/DefinitelyTyped/issues/28884#issuecomment-471341041
-  const indicatorRef = useRef<
-    CopiedContentIndicatorHandle
-  >() as React.MutableRefObject<CopiedContentIndicatorHandle>
+  const indicatorRef =
+    useRef<CopiedContentIndicatorHandle>() as React.MutableRefObject<CopiedContentIndicatorHandle>
   const [path, setPath] = useState('')
   const [queryString, setQueryString] = useState<string>()
   const [pathIsComplete, setPathIsComplete] = useState<boolean>()
@@ -50,7 +42,7 @@ export default function Customizer({
 
   function generateBuiltBadgeUrl(): string {
     const suffix = queryString ? `?${queryString}` : ''
-    return `${baseUrl || getBaseUrlFromWindowLocation()}${path}${suffix}`
+    return `${baseUrl}${path}${suffix}`
   }
 
   function renderLivePreview(): JSX.Element {

frontend/components/customizer/path-builder.tsx

@@ -91,15 +91,15 @@ export function constructPath({
       if (typeof token === 'string') {
         return token.trim()
       } else {
-        const { delimiter, name, optional } = token
+        const { prefix, name, modifier } = token
         const value = namedParams[name]
         if (value) {
-          return `${delimiter}${value.trim()}`
-        } else if (optional) {
+          return `${prefix}${value.trim()}`
+        } else if (modifier === '?' || modifier === '*') {
           return ''
         } else {
           isComplete = false
-          return `${delimiter}:${name}`
+          return `${prefix}:${name}`
         }
       }
     })
@@ -221,14 +221,15 @@ export default function PathBuilder({
     tokenIndex: number,
     namedParamIndex: number
   ): JSX.Element {
-    const { delimiter, optional } = token
+    const { prefix, modifier } = token
+    const optional = modifier === '?' || modifier === '*'
     const name = `${token.name}`
 
     const exampleValue = exampleParams[name] || '(not set)'
 
     return (
       <React.Fragment key={token.name}>
-        {renderLiteral(delimiter, tokenIndex, false)}
+        {renderLiteral(prefix, tokenIndex, false)}
         <PathBuilderColumn pathContainsOnlyLiterals={false} withHorizPadding>
           <NamedParamLabelContainer>
             <BuilderLabel htmlFor={name}>{humanizeString(name)}</BuilderLabel>

frontend/components/customizer/query-string-builder.tsx

@@ -241,15 +241,21 @@ export default function QueryStringBuilder({
   const [queryParams, setQueryParams] = useState(() =>
     // For each of the custom query params defined in `exampleParams`,
     // create empty values in `queryParams`.
-    Object.entries(exampleParams).reduce((accum, [name, value]) => {
-      // Custom query params are either string or boolean. Inspect the example
-      // value to infer which one, and set empty values accordingly.
-      // Throughout the component, these two types are supported in the same
-      // manner: by inspecting this value type.
-      const isStringParam = typeof value === 'string'
-      accum[name] = isStringParam ? '' : true
-      return accum
-    }, {} as { [k: string]: string | boolean })
+    Object.entries(exampleParams)
+      .filter(
+        // If the example defines a value for one of the standard supported
+        // options, do not duplicate the corresponding parameter.
+        ([name]) => !supportedBadgeOptions.some(option => name === option.name)
+      )
+      .reduce((accum, [name, value]) => {
+        // Custom query params are either string or boolean. Inspect the example
+        // value to infer which one, and set empty values accordingly.
+        // Throughout the component, these two types are supported in the same
+        // manner: by inspecting this value type.
+        const isStringParam = typeof value === 'string'
+        accum[name] = isStringParam ? '' : true
+        return accum
+      }, {} as { [k: string]: string | boolean })
   )
   // For each of the standard badge options, create empty values in
   // `badgeOptions`. When `initialStyle` has been provided, use it.

frontend/components/development/logo-page.tsx

@@ -1,7 +1,7 @@
 import React from 'react'
 import styled from 'styled-components'
 import { staticBadgeUrl } from '../../../core/badge-urls/make-badge-url'
-import { baseUrl } from '../../constants'
+import { getBaseUrl } from '../../constants'
 import { shieldsLogos, simpleIcons } from '../../lib/supported-features'
 import Meta from '../meta'
 import Header from '../header'
@@ -19,6 +19,7 @@ const StyledTable = styled.table`
 `
 
 function NamedLogoTable({ logoNames }: { logoNames: string[] }): JSX.Element {
+  const baseUrl = getBaseUrl()
   return (
     <StyledTable>
       <thead>

frontend/components/development/style-page.tsx

@@ -1,10 +1,11 @@
 import React, { Fragment } from 'react'
 import styled from 'styled-components'
+// FIXME: is this needed?
 // @ts-ingnore
 import { staticBadgeUrl } from '../../../core/badge-urls/make-badge-url'
-import { baseUrl } from '../../constants'
+import { getBaseUrl } from '../../constants'
 import Meta from '../meta'
-// @ts-ignore
+// ts-expect-error: because reasons?
 import Header from '../header'
 import { H3, Badge } from '../common'
 
@@ -62,11 +63,6 @@ function Badges({
   )
 }
 
-interface StyleExamples {
-  title: string
-  badges: BadgeData[]
-}
-
 const examples = [
   {
     title: 'Basic examples',
@@ -123,6 +119,7 @@ const examples = [
 ]
 
 function StyleTable({ style }: { style: string }): JSX.Element {
+  const baseUrl = getBaseUrl()
   return (
     <StyledTable>
       <thead>

frontend/components/dynamic-badge-maker.tsx

@@ -57,16 +57,19 @@ export default function DynamicBadgeMaker({
     e.preventDefault()
 
     const { datatype, label, dataUrl, query, color, prefix, suffix } = values
-    window.location.href = dynamicBadgeUrl({
-      baseUrl,
-      datatype,
-      label,
-      dataUrl,
-      query,
-      color,
-      prefix,
-      suffix,
-    })
+    window.open(
+      dynamicBadgeUrl({
+        baseUrl,
+        datatype,
+        label,
+        dataUrl,
+        query,
+        color,
+        prefix,
+        suffix,
+      }),
+      '_blank'
+    )
   }
 
   return (

frontend/components/main.tsx

@@ -11,7 +11,7 @@ import {
   RenderableExample,
 } from '../lib/service-definitions'
 import ServiceDefinitionSetHelper from '../lib/service-definitions/service-definition-set-helper'
-import { baseUrl } from '../constants'
+import { getBaseUrl } from '../constants'
 import Meta from './meta'
 import Header from './header'
 import SuggestionAndSearch from './suggestion-and-search'
@@ -45,15 +45,15 @@ export default function Main({
 }): JSX.Element {
   const [searchIsInProgress, setSearchIsInProgress] = useState(false)
   const [queryIsTooShort, setQueryIsTooShort] = useState(false)
-  const [searchResults, setSearchResults] = useState<{
-    [k: string]: ServiceDefinition[]
-  }>()
+  const [searchResults, setSearchResults] =
+    useState<{
+      [k: string]: ServiceDefinition[]
+    }>()
   const [selectedExample, setSelectedExample] = useState<RenderableExample>()
-  const [
-    selectedExampleIsSuggestion,
-    setSelectedExampleIsSuggestion,
-  ] = useState(false)
+  const [selectedExampleIsSuggestion, setSelectedExampleIsSuggestion] =
+    useState(false)
   const searchTimeout = useRef(0)
+  const baseUrl = getBaseUrl()
 
   function performSearch(query: string): void {
     setSearchIsInProgress(false)

frontend/components/meta.tsx

@@ -1,7 +1,10 @@
 import React from 'react'
 import { Helmet } from 'react-helmet'
+// eslint-disable-next-line
 // @ts-ignore
 import favicon from '../images/favicon.png'
+import '@fontsource/lato'
+import '@fontsource/lekton'
 
 const description = `We serve fast and scalable informational images as badges
 for GitHub, Travis CI, Jenkins, WordPress and many more services. Use them to
@@ -17,10 +20,6 @@ export default function Meta(): JSX.Element {
       <meta content="width=device-width,initial-scale=1" name="viewport" />
       <meta content={description} name="description" />
       <link href={favicon} rel="icon" type="image/png" />
-      <link
-        href="https://fonts.googleapis.com/css?family=Lato|Lekton"
-        rel="stylesheet"
-      />
     </Helmet>
   )
 }

frontend/components/static-badge-maker.tsx

@@ -31,7 +31,7 @@ export default function StaticBadgeMaker({
     e.preventDefault()
 
     const { label, message, color } = values
-    window.location.href = staticBadgeUrl({ baseUrl, label, message, color })
+    window.open(staticBadgeUrl({ baseUrl, label, message, color }), '_blank')
   }
 
   return (

frontend/components/usage.tsx

@@ -3,7 +3,7 @@ import { Link } from 'gatsby'
 import styled from 'styled-components'
 import { staticBadgeUrl } from '../../core/badge-urls/make-badge-url'
 import { advertisedStyles, shieldsLogos } from '../lib/supported-features'
-// @ts-ignore
+// ts-expect-error: because reasons?
 import StaticBadgeMaker from './static-badge-maker'
 import DynamicBadgeMaker from './dynamic-badge-maker'
 import { H2, H3, Badge, VerticalSpace } from './common'
@@ -378,8 +378,10 @@ export default function Usage({ baseUrl }: { baseUrl: string }): JSX.Element {
           <QueryParam
             documentation={
               <span>
-                Specify what clicking on the left/right of a badge should do
-                (esp. for social badge style)
+                Specify what clicking on the left/right of a badge should do.
+                Note that this only works when integrating your badge in an
+                <StyledCode>&lt;object&gt;</StyledCode> HTML tag, but not an
+                <StyledCode>&lt;img&gt;</StyledCode> tag or a markup language.
               </span>
             }
             key="link"
@@ -432,8 +434,8 @@ export default function Usage({ baseUrl }: { baseUrl: string }): JSX.Element {
         for use cases where SVG will not work. These requests should be made to
         our raster server <code>https://raster.shields.io</code>. For example,
         the raster equivalent of{' '}
-        <code>https://img.shields.io/v/npm/express</code> is{' '}
-        <code>https://raster.shields.io/v/npm/express</code>. For backward
+        <code>https://img.shields.io/npm/v/express</code> is{' '}
+        <code>https://raster.shields.io/npm/v/express</code>. For backward
         compatibility, the badge server will redirect <code>.png</code> badges
         to the raster server.
       </p>

frontend/constants.ts

@@ -1 +1,33 @@
-export const baseUrl = process.env.GATSBY_BASE_URL || ''
+const baseUrl = process.env.GATSBY_BASE_URL
+
+export function getBaseUrl(): string {
+  if (baseUrl) {
+    return baseUrl
+  }
+
+  /*
+  This is a special case for production.
+
+  We want to be able to build the front end with no value set for
+  `GATSBY_BASE_URL` so that we can deploy a build to staging
+  and then promote the exact same build to production.
+
+  When deployed to staging, we want the frontend on
+  https://staging.shields.io/ to generate badges with the base
+  https://staging.shields.io/
+
+  When we promote to production we want https://shields.io/ and
+  https://www.shields.io/ to both generate badges with the base
+  https://img.shields.io/
+  */
+  try {
+    const { protocol, hostname } = window.location
+    if (['shields.io', 'www.shields.io'].includes(hostname)) {
+      return 'https://img.shields.io'
+    }
+    return `${protocol}//${hostname}`
+  } catch (e) {
+    // server-side rendering
+    return ''
+  }
+}

frontend/lib/pattern-helpers.ts

@@ -21,19 +21,11 @@ export function removeRegexpFromPattern(pattern: string): string {
       if (typeof token === 'string') {
         return token
       } else {
-        const { delimiter, optional, repeat, name, pattern } = token
+        const { prefix, modifier, name, pattern } = token
         if (typeof name === 'number') {
-          return `${delimiter}(${pattern})`
+          return `${prefix}(${pattern})`
         } else {
-          let modifier = ''
-          if (optional && !repeat) {
-            modifier = '?'
-          } else if (!optional && repeat) {
-            modifier = '+'
-          } else if (optional && repeat) {
-            modifier = '*'
-          }
-          return `${delimiter}:${name}${modifier}`
+          return `${prefix}:${name}${modifier}`
         }
       }
     })

frontend/pages/community.tsx

@@ -1,6 +1,6 @@
 import React from 'react'
 import styled from 'styled-components'
-import { baseUrl } from '../constants'
+import { getBaseUrl } from '../constants'
 import Meta from '../components/meta'
 import Header from '../components/header'
 import Footer from '../components/footer'
@@ -19,6 +19,7 @@ const SponsorContainer = styled.div`
 `
 
 export default function SponsorsPage(): JSX.Element {
+  const baseUrl = getBaseUrl()
   return (
     <MainContainer>
       <GlobalStyle />
@@ -114,9 +115,6 @@ export default function SponsorsPage(): JSX.Element {
           <li>
             <a href="https://lgtm.com/">LGTM</a>
           </li>
-          <li>
-            <a href="https://www.netlify.com/">Netlify</a>
-          </li>
           <li>
             <a href="https://uptimerobot.com/">Uptime Robot</a>
           </li>

frontend/pages/endpoint.tsx

@@ -1,7 +1,7 @@
 import React from 'react'
 import styled, { css } from 'styled-components'
 import { staticBadgeUrl } from '../../core/badge-urls/make-badge-url'
-import { baseUrl } from '../constants'
+import { getBaseUrl } from '../constants'
 import Meta from '../components/meta'
 import Header from '../components/header'
 import Footer from '../components/footer'
@@ -89,6 +89,7 @@ const Schema = styled.dl`
 `
 
 export default function EndpointPage(): JSX.Element {
+  const baseUrl = getBaseUrl()
   return (
     <MainContainer>
       <GlobalStyle />

gatsby-config.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const path = require('path')
+
 module.exports = {
   siteMetadata: {
     title: 'Shields.io: Quality metadata badges for open source projects',
@@ -11,7 +13,7 @@ module.exports = {
     {
       resolve: 'gatsby-plugin-page-creator',
       options: {
-        path: `${__dirname}/frontend/pages`,
+        path: path.join(__dirname, 'frontend', 'pages'),
       },
     },
     'gatsby-plugin-react-helmet',

gatsby-node.js

@@ -12,7 +12,7 @@ const envFlag = require('node-env-flag')
 
 const includeDevPages = envFlag(process.env.INCLUDE_DEV_PAGES, true)
 
-const { categories } = yaml.safeLoad(
+const { categories } = yaml.load(
   fs.readFileSync('./service-definitions.yml', 'utf8')
 )
 

package.json

@@ -22,45 +22,47 @@
     "url": "https://github.com/badges/shields"
   },
   "dependencies": {
-    "@sentry/node": "^5.27.1",
-    "@shields_io/camp": "^18.0.0",
+    "@fontsource/lato": "^4.4.1",
+    "@fontsource/lekton": "^4.4.0",
+    "@sentry/node": "^6.4.1",
+    "@shields_io/camp": "^18.1.1",
     "badge-maker": "file:badge-maker",
     "bytes": "^3.1.0",
-    "camelcase": "^6.1.0",
-    "chalk": "^4.1.0",
-    "check-node-version": "^4.0.3",
+    "camelcase": "^6.2.0",
+    "chalk": "^4.1.1",
+    "check-node-version": "^4.1.0",
     "cloudflare-middleware": "^1.0.4",
-    "config": "^3.3.2",
-    "cross-env": "^7.0.2",
-    "decamelize": "^3.2.0",
-    "dotenv": "^8.2.0",
+    "config": "^3.3.6",
+    "cross-env": "^7.0.3",
+    "decamelize": "^5.0.0",
     "emojic": "^1.1.16",
     "escape-string-regexp": "^4.0.0",
-    "fast-xml-parser": "^3.17.4",
-    "glob": "^7.1.6",
-    "graphql": "^14.7.0",
-    "graphql-tag": "^2.11.0",
-    "ioredis": "4.17.3",
-    "joi": "17.2.1",
+    "fast-xml-parser": "^3.19.0",
+    "glob": "^7.1.7",
+    "got": "11.8.2",
+    "graphql": "^15.5.0",
+    "graphql-tag": "^2.12.4",
+    "ioredis": "4.27.3",
+    "joi": "17.4.0",
     "joi-extension-semver": "5.0.0",
-    "js-yaml": "^3.14.0",
-    "jsonpath": "~1.0.2",
+    "js-yaml": "^4.1.0",
+    "jsonpath": "~1.1.1",
     "lodash.countby": "^4.6.0",
     "lodash.groupby": "^4.6.0",
     "lodash.times": "^4.3.2",
     "moment": "^2.29.1",
     "node-env-flag": "^0.1.0",
     "parse-link-header": "^1.0.1",
-    "path-to-regexp": "^5.0.0",
-    "pretty-bytes": "^5.4.1",
+    "path-to-regexp": "^6.2.0",
+    "pretty-bytes": "^5.6.0",
     "priorityqueuejs": "^2.0.0",
-    "prom-client": "^11.5.3",
-    "query-string": "^6.13.6",
+    "prom-client": "^13.1.0",
+    "query-string": "^7.0.0",
     "request": "~2.88.2",
-    "semver": "~7.3.2",
-    "simple-icons": "3.12.1",
-    "webextension-store-meta": "^1.0.2",
-    "xmldom": "~0.2.1",
+    "semver": "~7.3.5",
+    "simple-icons": "4.25.0",
+    "webextension-store-meta": "^1.0.3",
+    "xmldom": "~0.6.0",
     "xpath": "~0.0.32"
   },
   "scripts": {
@@ -96,8 +98,6 @@
     "check-types:package": "tsd badge-maker",
     "check-types:frontend": "tsc --noEmit --project .",
     "depcheck": "check-node-version --node \">= 12.0\"",
-    "fix-issue-5294": "rimraf node_modules/@types/react-native",
-    "postinstall": "run-s --silent depcheck fix-issue-5294",
     "prebuild": "run-s --silent depcheck",
     "features": "node scripts/export-supported-features-cli.js > supported-features.json",
     "defs": "node scripts/export-service-definitions-cli.js > service-definitions.yml",
@@ -115,10 +115,10 @@
     "e2e": "start-server-and-test start http://localhost:3000 test:e2e",
     "e2e-on-build": "cross-env CYPRESS_baseUrl=http://localhost:8080 start-server-and-test start:server:e2e-on-build http://localhost:8080 test:e2e",
     "badge": "cross-env NODE_CONFIG_ENV=test TRACE_SERVICES=true node scripts/badge-cli.js",
-    "build-docs": "rimraf api-docs/ && jsdoc --pedantic -c ./jsdoc.json ."
+    "build-docs": "rimraf api-docs/ && jsdoc --pedantic -c ./jsdoc.json . && echo 'contributing.shields.io' > api-docs/CNAME"
   },
   "lint-staged": {
-    "**/*.js": [
+    "**/*.@(js|ts|tsx)": [
       "eslint --fix",
       "prettier --write"
     ],
@@ -141,113 +141,108 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.12.3",
+    "@babel/core": "^7.14.3",
     "@babel/polyfill": "^7.12.1",
-    "@babel/register": "7.12.1",
-    "@mapbox/react-click-to-select": "^2.2.0",
-    "@types/chai": "^4.2.14",
+    "@babel/register": "7.13.16",
+    "@mapbox/react-click-to-select": "^2.2.1",
+    "@types/chai": "^4.2.18",
     "@types/lodash.debounce": "^4.0.6",
     "@types/lodash.groupby": "^4.6.6",
-    "@types/mocha": "^8.0.3",
-    "@types/node": "^14.11.8",
-    "@types/react-helmet": "^6.1.0",
-    "@types/react-modal": "^3.10.6",
-    "@types/react-select": "^3.0.22",
-    "@types/styled-components": "5.1.3",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/parser": "^2.34.0",
-    "babel-plugin-inline-react-svg": "^1.1.1",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "^15.6.1",
+    "@types/react-helmet": "^6.1.1",
+    "@types/react-modal": "^3.12.0",
+    "@types/react-select": "^4.0.15",
+    "@types/styled-components": "5.1.9",
+    "@typescript-eslint/eslint-plugin": "^4.25.0",
+    "@typescript-eslint/parser": "^4.23.0",
+    "babel-plugin-inline-react-svg": "^2.0.1",
     "babel-plugin-istanbul": "^6.0.0",
-    "babel-preset-gatsby": "^0.5.1",
+    "babel-preset-gatsby": "^1.2.0",
     "caller": "^1.0.1",
-    "chai": "^4.1.2",
+    "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
-    "chai-datetime": "^1.7.0",
+    "chai-datetime": "^1.8.0",
     "chai-string": "^1.4.0",
-    "cheerio": "^1.0.0-rc.3",
     "child-process-promise": "^2.2.1",
-    "clipboard-copy": "^3.1.0",
-    "concurrently": "^5.3.0",
-    "cypress": "^5.3.0",
-    "danger": "^10.5.0",
+    "clipboard-copy": "^4.0.1",
+    "concurrently": "^6.2.0",
+    "cypress": "^7.4.0",
+    "danger": "^10.6.4",
     "danger-plugin-no-test-shortcuts": "^2.0.0",
     "deepmerge": "^4.2.2",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.13.0",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-config-standard-react": "^9.2.0",
-    "eslint-plugin-chai-friendly": "^0.6.0",
-    "eslint-plugin-cypress": "^2.11.2",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jsdoc": "^30.7.3",
-    "eslint-plugin-mocha": "^6.3.0",
+    "eslint": "^7.27.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-config-standard-jsx": "^10.0.0",
+    "eslint-config-standard-react": "^11.0.1",
+    "eslint-plugin-chai-friendly": "^0.7.1",
+    "eslint-plugin-cypress": "^2.11.3",
+    "eslint-plugin-import": "^2.23.3",
+    "eslint-plugin-jsdoc": "^35.0.0",
+    "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-no-extension-in-require": "^0.2.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-react": "^7.21.5",
-    "eslint-plugin-react-hooks": "^2.5.1",
-    "eslint-plugin-sort-class-members": "^1.8.0",
-    "eslint-plugin-standard": "^4.0.2",
-    "fetch-ponyfill": "^6.1.1",
-    "form-data": "^3.0.0",
-    "fs-readfile-promise": "^3.0.1",
-    "gatsby": "2.24.73",
-    "gatsby-plugin-catch-links": "^2.3.10",
-    "gatsby-plugin-page-creator": "^2.3.33",
-    "gatsby-plugin-react-helmet": "^3.3.9",
-    "gatsby-plugin-remove-trailing-slashes": "^2.3.10",
-    "gatsby-plugin-styled-components": "^3.3.9",
-    "gatsby-plugin-typescript": "^2.4.24",
-    "got": "11.7.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-react": "^7.23.2",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "eslint-plugin-sort-class-members": "^1.11.0",
+    "fetch-ponyfill": "^7.1.0",
+    "form-data": "^4.0.0",
+    "gatsby": "3.6.1",
+    "gatsby-plugin-catch-links": "^3.1.0",
+    "gatsby-plugin-page-creator": "^3.6.0",
+    "gatsby-plugin-react-helmet": "^4.1.0",
+    "gatsby-plugin-remove-trailing-slashes": "^3.1.0",
+    "gatsby-plugin-styled-components": "^4.6.0",
+    "gatsby-plugin-typescript": "^3.2.0",
     "humanize-string": "^2.1.0",
-    "husky": "^4.3.0",
+    "husky": "^4.3.8",
     "icedfrisby": "4.0.0",
     "icedfrisby-nock": "^2.0.0",
-    "is-png": "^2.0.0",
-    "is-svg": "^4.2.1",
+    "is-svg": "^4.3.1",
     "js-yaml-loader": "^1.2.2",
-    "jsdoc": "^3.6.6",
-    "lint-staged": "^10.4.2",
+    "jsdoc": "^3.6.7",
+    "lint-staged": "^11.0.0",
     "lodash.debounce": "^4.0.8",
     "lodash.difference": "^4.5.0",
     "minimist": "^1.2.5",
-    "mocha": "^7.2.0",
+    "mocha": "^8.4.0",
     "mocha-env-reporter": "^4.0.0",
     "mocha-junit-reporter": "^2.0.0",
     "mocha-yaml-loader": "^1.0.3",
-    "nock": "13.0.4",
-    "node-mocks-http": "^1.9.0",
-    "nodemon": "^2.0.6",
+    "nock": "13.0.11",
+    "node-mocks-http": "^1.10.1",
+    "nodemon": "^2.0.7",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "opn-cli": "^5.0.0",
     "portfinder": "^1.0.28",
-    "prettier": "2.1.2",
-    "react": "^16.14.0",
-    "react-dom": "^16.13.1",
-    "react-error-overlay": "^6.0.7",
+    "prettier": "2.3.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-error-overlay": "^6.0.9",
     "react-helmet": "^6.1.0",
-    "react-modal": "^3.11.2",
+    "react-modal": "^3.13.1",
     "react-pose": "^4.0.10",
-    "react-select": "^3.1.0",
+    "react-select": "^4.3.1",
     "read-all-stdin-sync": "^1.0.5",
     "redis-server": "^1.2.2",
     "require-hacker": "^3.0.1",
     "rimraf": "^3.0.2",
     "sazerac": "^2.0.0",
-    "sinon": "^9.2.0",
-    "sinon-chai": "^3.5.0",
-    "snap-shot-it": "^7.9.3",
-    "start-server-and-test": "1.11.5",
-    "styled-components": "^5.2.0",
-    "tmp": "0.2.1",
-    "tsd": "^0.13.1",
+    "sinon": "^11.1.1",
+    "sinon-chai": "^3.7.0",
+    "snap-shot-it": "^7.9.6",
+    "start-server-and-test": "1.12.3",
+    "styled-components": "^5.3.0",
     "ts-mocha": "^8.0.0",
-    "typescript": "^4.0.3"
+    "tsd": "^0.14.0",
+    "typescript": "^4.3.2"
   },
   "engines": {
     "node": "^12.18.3",
-    "npm": "^6.14.7"
+    "npm": ">=7.0.0"
   },
   "babel": {
     "plugins": [

readme-logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="198" height="58"><rect rx="8" x="140" width="55" height="58" fill="#555" /><g stroke="#555" stroke-width="8"><path d="M135.5 54a8 8 0 0 0 8.5 -8.5"/><rect x="4" y="4" rx="8" width="190" height="50" fill="none"/></g><g fill="#555"><path d="m23.906 33.641c.953-.083 1.906-.167 2.859-.25.108 2.099 1.511 4.139 3.578 4.722 2.438.895 5.357.799 7.559-.658 1.49-1.129 1.861-3.674.324-4.925-1.557-1.322-3.685-1.504-5.576-2.057-2.343-.565-4.912-1.133-6.611-2.979-1.805-2.088-1.627-5.485.292-7.443 2.041-2.113 5.222-2.55 8.02-2.274 2.46.244 5.058 1.343 6.252 3.635.426.908 1.095 2.241.656 3.108-.888.173-1.81.148-2.715.245-.077-2.084-1.727-4.073-3.863-4.234-1.902-.317-4.02-.252-5.691.802-1.398.989-1.849 3.363-.381 4.494 1.281 1.01 2.962 1.199 4.482 1.642 2.66.627 5.602 1.118 7.596 3.158 2 2.188 1.893 5.84-.088 8.01-2.01 2.32-5.304 2.972-8.237 2.713-2.585-.147-5.319-1.024-6.916-3.184-.987-1.288-1.517-2.905-1.542-4.523"/><path d="m45.953 41c0-7.635 0-15.271 0-22.906.938 0 1.875 0 2.813 0 0 2.74 0 5.479 0 8.219 1.391-1.721 3.69-2.523 5.86-2.236 1.975.154 4.03 1.371 4.513 3.402.504 1.973.278 4.02.33 6.04 0 2.495 0 4.989 0 7.484-.938 0-1.875 0-2.813 0-.009-3.675.018-7.351-.014-11.03-.026-1.342-.627-2.835-2-3.282-2.187-.802-5.077.393-5.609 2.773-.417 1.764-.216 3.586-.264 5.381 0 2.051 0 4.102 0 6.153-.938 0-1.875 0-2.813 0"/><path d="m63.781 21.328v-3.234h2.813v3.234zm0 19.672v-16.594h2.813v16.594z"/><path d="m82.25 35.656c.969.12 1.938.24 2.906.359-.702 3.464-4.348 5.767-7.781 5.386-3.235-.066-6.43-2.328-7.06-5.598-.843-3.307-.404-7.285 2.101-9.784 3.082-3 8.699-2.618 11.235.892 1.374 1.85 1.676 4.267 1.578 6.51-4.125 0-8.25 0-12.375 0-.142 2.889 2.267 6 5.346 5.658 1.881-.162 3.613-1.566 4.045-3.423m-9.234-4.547c3.089 0 6.177 0 9.266 0 .129-2.774-2.616-5.422-5.419-4.713-2.174.427-3.912 2.474-3.846 4.713"/><path d="m88.64 41v-22.906h2.813v22.906z"/><path d="m106.59 41c0-.698 0-1.396 0-2.094-1.412 2.442-4.776 3.067-7.233 1.949-2.378-1.02-3.971-3.403-4.345-5.924-.507-2.761-.123-5.768 1.389-8.167 1.863-2.705 5.968-3.642 8.711-1.741.422.228 1.028 1.144 1.294 1.018-.006-2.649-.0001-5.298-.003-7.948.932 0 1.865 0 2.797 0 0 7.635 0 15.271 0 22.906-.87 0-1.74 0-2.61 0m-8.89-8.281c-.075 2.246.637 4.861 2.79 5.952 2 1.023 4.682-.047 5.488-2.134.897-1.996.746-4.278.388-6.382-.425-1.95-2.046-3.804-4.158-3.805-1.903-.065-3.633 1.363-4.099 3.181-.327 1.028-.394 2.116-.408 3.188"/><path d="m112.52 36.05c.927-.146 1.854-.292 2.781-.438.126 1.69 1.513 3.244 3.239 3.365 1.398.212 3.01.12 4.12-.851.807-.749 1.1-2.243.159-3.01-.908-.723-2.115-.812-3.182-1.172-1.797-.485-3.713-.848-5.243-1.97-1.83-1.551-1.868-4.679-.099-6.293 1.577-1.507 3.918-1.784 6-1.594 1.685.176 3.54.749 4.535 2.217.464.715.708 1.549.844 2.384-.917.125-1.833.25-2.75.375-.121-1.569-1.653-2.762-3.19-2.695-1.246-.082-2.702.012-3.608.982-.624.724-.543 1.971.314 2.481.998.706 2.269.757 3.389 1.173 1.754.512 3.647.848 5.141 1.965 1.686 1.476 1.728 4.244.396 5.966-1.298 1.788-3.597 2.417-5.709 2.448-1.466-.007-2.984-.214-4.299-.893-1.599-.909-2.585-2.655-2.84-4.444"/></g><g fill="#fff"><path d="m151.11 41v-22.906h3.03v22.906z"/><path d="m158.55 29.844c-.277-4.765 2.335-9.977 7.05-11.551 4.902-1.757 11.226.197 13.477 5.098 2.266 4.706 1.89 10.92-1.767 14.833-4.554 4.948-13.81 3.976-17.08-1.954-1.111-1.946-1.679-4.188-1.68-6.426m3.125.047c-.377 4.273 2.892 8.844 7.375 8.951 3.791.221 7.557-2.653 7.997-6.497.794-3.731.139-8.292-3.107-10.696-3.788-2.814-10.05-1.104-11.591 3.444-.54 1.539-.642 3.181-.675 4.798"/></g></svg>

scripts/export-service-definitions-cli.js

@@ -9,4 +9,4 @@ const definitions = collectDefinitions()
 // https://github.com/nodeca/js-yaml/issues/356#issuecomment-312430599
 const cleaned = JSON.parse(JSON.stringify(definitions))
 
-process.stdout.write(yaml.safeDump(cleaned, { flowLevel: 5 }))
+process.stdout.write(yaml.dump(cleaned, { flowLevel: 5 }))

scripts/import-github-tokens.js

@@ -1,50 +0,0 @@
-'use strict'
-
-const { promises: fs } = require('fs')
-const Redis = require('ioredis')
-
-const key = 'githubUserTokens'
-
-async function loadTokens() {
-  const contents = await fs.readFile('all_tokens_uniq.json', 'utf8')
-  const tokens = JSON.parse(contents)
-  console.log(`${tokens.length} tokens loaded`)
-  return tokens
-}
-
-function createClient() {
-  const redis = new Redis(process.env.REDIS_URL, {
-    tls: { servername: new URL(process.env.REDIS_URL).hostname },
-  })
-  redis.on('error', err => {
-    console.error(err)
-  })
-  return redis
-}
-
-async function load() {
-  const redis = createClient()
-  const tokens = await loadTokens()
-  await redis.sadd(key, tokens)
-  await redis.quit()
-}
-
-async function list() {
-  const redis = createClient()
-  const tokens = await redis.smembers(key)
-  console.log(`${tokens.length} tokens loaded`)
-  await redis.quit()
-}
-
-;(async () => {
-  try {
-    // await load()
-    await list()
-  } catch (e) {
-    console.error(e)
-    process.exit(1)
-  }
-})()
-
-// Appease the linter.
-module.exports = { load, list }

server.js

@@ -4,8 +4,6 @@
 const fs = require('fs')
 const path = require('path')
 
-require('dotenv').config()
-
 // Set up Sentry reporting as early in the process as possible.
 const config = require('config').util.toObject()
 const Sentry = require('@sentry/node')
@@ -37,6 +35,13 @@ if (process.argv[3]) {
 console.log('Configuration:')
 console.dir(config.public, { depth: null })
 
+if (fs.existsSync('.env')) {
+  console.error(
+    'Legacy .env file found. It should be deleted and replaced with environment variables or config/local.yml'
+  )
+  process.exit(1)
+}
+
 const legacySecretsPath = path.join(__dirname, 'private', 'secret.json')
 if (fs.existsSync(legacySecretsPath)) {
   console.error(

services/ansible/ansible-quality.service.js

@@ -18,7 +18,9 @@ class AnsibleGalaxyContent extends BaseJsonService {
   }
 }
 
-module.exports = class AnsibleGalaxyContentQualityScore extends AnsibleGalaxyContent {
+module.exports = class AnsibleGalaxyContentQualityScore extends (
+  AnsibleGalaxyContent
+) {
   static category = 'analysis'
   static route = { base: 'ansible/quality', pattern: ':projectId' }
 

services/appveyor/appveyor-tests.service.js

@@ -100,10 +100,8 @@ module.exports = class AppVeyorTests extends AppVeyorBase {
     },
   ]
 
-  static get defaultBadgeData() {
-    return {
-      label: 'tests',
-    }
+  static defaultBadgeData = {
+    label: 'tests',
   }
 
   static render({

services/aur/aur.service.js

@@ -168,30 +168,22 @@ class AurMaintainer extends BaseAurService {
 }
 
 class AurLastModified extends BaseAurService {
-  static get category() {
-    return 'activity'
+  static category = 'activity'
+
+  static route = {
+    base: 'aur/last-modified',
+    pattern: ':packageName',
   }
 
-  static get route() {
-    return {
-      base: 'aur/last-modified',
-      pattern: ':packageName',
-    }
-  }
+  static examples = [
+    {
+      title: 'AUR last modified',
+      namedParams: { packageName: 'google-chrome' },
+      staticPreview: this.render({ date: new Date().getTime() }),
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'AUR last modified',
-        namedParams: { packageName: 'google-chrome' },
-        staticPreview: this.render({ date: new Date().getTime() }),
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'last modified' }
-  }
+  static defaultBadgeData = { label: 'last modified' }
 
   static render({ date }) {
     const color = ageColor(date)

services/azure-devops/azure-devops-base.js

@@ -15,12 +15,10 @@ const latestBuildSchema = Joi.object({
 }).required()
 
 module.exports = class AzureDevOpsBase extends BaseJsonService {
-  static get auth() {
-    return {
-      passKey: 'azure_devops_token',
-      authorizedOrigins: ['https://dev.azure.com'],
-      defaultToEmptyStringForUser: true,
-    }
+  static auth = {
+    passKey: 'azure_devops_token',
+    authorizedOrigins: ['https://dev.azure.com'],
+    defaultToEmptyStringForUser: true,
   }
 
   async fetch({ url, options, schema, errorMessages }) {

services/bintray/bintray-downloads.service.js

@@ -1,115 +0,0 @@
-'use strict'
-
-const Joi = require('joi')
-const { metric } = require('../text-formatters')
-const { downloadCount } = require('../color-formatters')
-const { BaseJsonService } = require('..')
-
-const schema = Joi.object({
-  totalDownloads: Joi.number().required(),
-}).required()
-
-const versionSchema = Joi.object({
-  name: Joi.string().required(),
-}).required()
-
-const documentation = `
-<p>
-  These badges utilize unofficial Bintray APIs to retrieve download data. <br />
-  As such, they may be unstable or intermittently unavailable.
-</p>`
-
-module.exports = class BintrayDownloads extends BaseJsonService {
-  static category = 'downloads'
-
-  static route = {
-    base: 'bintray',
-    pattern: ':interval(dt)/:subject/:repo/:packageName/:version*',
-  }
-
-  static auth = {
-    userKey: 'bintray_user',
-    passKey: 'bintray_apikey',
-    authorizedOrigins: ['https://bintray.com'],
-  }
-
-  static examples = [
-    {
-      title: 'Bintray',
-      staticPreview: this.render({ downloads: 69000 }),
-      namedParams: {
-        interval: 'dt',
-        subject: 'asciidoctor',
-        repo: 'maven',
-        packageName: 'asciidoctorj',
-      },
-      documentation,
-    },
-    {
-      title: 'Bintray (latest)',
-      staticPreview: this.render({ version: 'latest', downloads: 69000 }),
-      namedParams: {
-        interval: 'dt',
-        subject: 'asciidoctor',
-        repo: 'maven',
-        packageName: 'asciidoctorj',
-        version: 'latest',
-      },
-      documentation,
-    },
-    {
-      title: 'Bintray (version)',
-      staticPreview: this.render({ version: '1.6.0', downloads: 69000 }),
-      namedParams: {
-        interval: 'dt',
-        subject: 'asciidoctor',
-        repo: 'maven',
-        packageName: 'asciidoctorj',
-        version: '1.6.0',
-      },
-      documentation,
-    },
-  ]
-
-  static defaultBadgeData = { label: 'downloads' }
-
-  static render({ version, downloads }) {
-    return {
-      label: version ? `downloads@${version}` : 'downloads',
-      message: metric(downloads),
-      color: downloadCount(downloads),
-    }
-  }
-
-  async fetch({ subject, repo, packageName, version }) {
-    let actualVersion = version
-    if (version === 'latest') {
-      actualVersion = (
-        await this._requestJson(
-          this.authHelper.withBasicAuth({
-            schema: versionSchema,
-            url: `https://bintray.com/api/v1/packages/${subject}/${repo}/${packageName}/versions/_latest`,
-          })
-        )
-      ).name
-    }
-    return this._requestJson(
-      this.authHelper.withBasicAuth({
-        schema,
-        url: actualVersion
-          ? `https://bintray.com/api/ui/version/${subject}/${repo}/${packageName}/${actualVersion}/total_downloads`
-          : `https://bintray.com/api/ui/package/${subject}/${repo}/${packageName}/total_downloads`,
-      })
-    )
-  }
-
-  async handle({ version, subject, repo, packageName }) {
-    const { totalDownloads } = await this.fetch({
-      subject,
-      repo,
-      packageName,
-      version,
-    })
-    return this.constructor.render({ version, downloads: totalDownloads })
-  }
-}

services/bintray/bintray-downloads.spec.js

@@ -1,47 +0,0 @@
-'use strict'
-
-const { expect } = require('chai')
-const nock = require('nock')
-const { cleanUpNockAfterEach, defaultContext } = require('../test-helpers')
-const BintrayDownloads = require('./bintray-downloads.service')
-
-describe('BintrayDownloads', function () {
-  describe('auth', function () {
-    cleanUpNockAfterEach()
-
-    const user = 'admin'
-    const pass = 'password'
-    const config = {
-      private: {
-        bintray_user: user,
-        bintray_apikey: pass,
-      },
-    }
-
-    it('sends the auth information as configured', async function () {
-      const scope = nock('https://bintray.com')
-        .get('/api/ui/package/asciidoctor/maven/asciidoctorj/total_downloads')
-        // This ensures that the expected credentials are actually being sent with the HTTP request.
-        // Without this the request wouldn't match and the test would fail.
-        .basicAuth({ user, pass })
-        .reply(200, {
-          totalDownloads: 69,
-        })
-
-      expect(
-        await BintrayDownloads.invoke(defaultContext, config, {
-          interval: 'dt',
-          subject: 'asciidoctor',
-          repo: 'maven',
-          packageName: 'asciidoctorj',
-        })
-      ).to.deep.equal({
-        color: 'yellowgreen',
-        label: 'downloads',
-        message: '69',
-      })
-
-      scope.done()
-    })
-  })
-})

services/bintray/bintray-downloads.tester.js

@@ -1,32 +0,0 @@
-'use strict'
-
-const { isMetric } = require('../test-validators')
-const t = (module.exports = require('../tester').createServiceTester())
-
-t.create('downloads')
-  .get('/dt/asciidoctor/maven/asciidoctorj.json')
-  .expectBadge({
-    label: 'downloads',
-    message: isMetric,
-  })
-
-t.create('downloads (not found)')
-  .get('/dt/asciidoctor/maven/not-a-real-package.json')
-  .expectBadge({
-    label: 'downloads',
-    message: 'not found',
-  })
-
-t.create('downloads (mocked)')
-  .get('/dt/asciidoctor/maven/asciidoctorj.json')
-  .intercept(nock =>
-    nock('https://bintray.com')
-      .get('/api/ui/package/asciidoctor/maven/asciidoctorj/total_downloads')
-      .reply(200, {
-        totalDownloads: 420,
-      })
-  )
-  .expectBadge({
-    label: 'downloads',
-    message: '420',
-  })