Changelog for Release server-2023-11-01 (#9705)

* Update Changelog

* Update CHANGELOG.md

---------

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

.circleci/config.yml

@@ -1,3 +0,0 @@
-version: 2
-# Do nothing
-# TODO: disable Circle

.dockerignore

@@ -3,6 +3,7 @@ shields.env
 .git/
 .gitignore
 .vscode/
+fly.toml
 
 # Improve layer cacheability.
 Dockerfile

.eslintrc.yml

@@ -2,7 +2,6 @@ extends:
   - standard
   - standard-jsx
   - standard-react
-  - plugin:@typescript-eslint/recommended
   - prettier
   - eslint:recommended
 
@@ -18,12 +17,13 @@ settings:
   react:
     version: '16.8'
   jsdoc:
-    mode: jsdoc
+    mode: typescript
 
 plugins:
   - chai-friendly
   - jsdoc
   - mocha
+  - icedfrisby
   - no-extension-in-require
   - sort-class-members
   - import
@@ -36,39 +36,33 @@ overrides:
   # rules listed here are only ones which conflict.
 
   - files:
-      - '**/*.js'
-      - '!frontend/**/*.js'
+      - 'badge-maker/**/*.js'
+      - '**/*.cjs'
     env:
       node: true
       es6: true
+
+  - files:
+      - '**/*.js'
+      - '!frontend/**/*.js'
+      - '!badge-maker/**/*.js'
+    env:
+      node: true
+      es6: true
+    parserOptions:
+      sourceType: 'module'
+    parser: '@typescript-eslint/parser'
     rules:
       no-console: 'off'
-      '@typescript-eslint/explicit-module-boundary-types': 'off'
 
   - files:
-      - '**/*.@(ts|tsx)'
+      - '**/*.ts'
     parserOptions:
       sourceType: 'module'
     parser: '@typescript-eslint/parser'
-    rules:
-      # Argh.
-      '@typescript-eslint/explicit-function-return-type':
-        ['error', { 'allowExpressions': true }]
-      '@typescript-eslint/no-empty-function': 'error'
-      '@typescript-eslint/no-var-requires': 'error'
-      '@typescript-eslint/no-object-literal-type-assertion': 'off'
-      '@typescript-eslint/no-explicit-any': 'error'
-      '@typescript-eslint/ban-ts-ignore': 'off'
-      '@typescript-eslint/explicit-module-boundary-types': 'off'
 
   - files:
-      - core/**/*.ts
-    parserOptions:
-      sourceType: 'module'
-    parser: '@typescript-eslint/parser'
-  - files:
-      - gatsby-browser.js
-      - 'frontend/**/*.@(js|ts|tsx)'
+      - 'frontend/**/*.js'
     parserOptions:
       sourceType: 'module'
     env:
@@ -113,21 +107,20 @@ overrides:
       mocha: true
     rules:
       mocha/no-exclusive-tests: 'error'
+      mocha/no-skipped-tests: 'error'
       mocha/no-mocha-arrows: 'error'
       mocha/prefer-arrow-callback: 'error'
 
+  - files:
+      - 'services/**/*.tester.js'
+    rules:
+      icedfrisby/no-exclusive-tests: 'error'
+      icedfrisby/no-skipped-tests: 'error'
+
 rules:
   # Disable some rules from eslint:recommended.
   no-empty: ['error', { 'allowEmptyCatch': true }]
 
-  # Allow unused parameters. In callbacks, removing them seems to obscure
-  # what the functions are doing.
-  '@typescript-eslint/no-unused-vars': ['error', { 'args': 'none' }]
-  no-unused-vars: 'off'
-
-  '@typescript-eslint/no-var-requires': 'off'
-
-  '@typescript-eslint/no-use-before-define': 'error'
   no-use-before-define: 'off'
 
   # These should be disabled by eslint-config-prettier, but are not.
@@ -178,7 +171,7 @@ rules:
   jsdoc/check-tag-names: 'error'
   jsdoc/check-types: 'error'
   jsdoc/implements-on-classes: 'error'
-  jsdoc/newline-after-description: 'error'
+  jsdoc/tag-lines: ['error', 'any', { 'startLines': 1 }]
   jsdoc/require-param: 'error'
   jsdoc/require-param-description: 'error'
   jsdoc/require-param-name: 'error'
@@ -189,11 +182,7 @@ rules:
   jsdoc/require-returns-type: 'error'
   jsdoc/valid-types: 'error'
 
-  # Disable some from TypeScript.
-  '@typescript-eslint/camelcase': off
-  '@typescript-eslint/explicit-function-return-type': 'off'
-  '@typescript-eslint/no-empty-function': 'off'
-
+  react/prop-types: 'off'
   react/jsx-sort-props: 'error'
   react-hooks/rules-of-hooks: 'error'
   react-hooks/exhaustive-deps: 'error'

.github/ISSUE_TEMPLATE/3_Badge_request.yml

@@ -12,7 +12,7 @@ body:
         **fetch and display data from an upstream service**.
         If your suggestion is for a static badge
         (which shows the same information every time it is requested), it is
-        [already possible to make these](https://github.com/badges/shields/blob/master/doc/static-badges.md).
+        [already possible to make these](https://shields.io/docs/static-badges).
         We don't add specific routes for badges which only show static information.
 
   - type: textarea
@@ -25,7 +25,7 @@ body:
         - Which service is this badge for e.g: GitHub, Travis CI
         - What sort of information should this badge show?
           Provide an example in plain text e.g: "version | v1.01" or as a static badge
-          (static badge generator can be found at https://shields.io/#your-badge )
+          (static badge generator can be found at https://shields.io/badges/static-badge )
     validations:
       required: true
 

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

@@ -1,12 +0,0 @@
-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: 'node16'
-  main: 'index.js'

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

@@ -1,68 +0,0 @@
-'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('<!--'))
-    .filter(
-      line =>
-        !line.startsWith(
-          '<p><a href="https://www.gatsbyjs.com/docs/reference/release-notes/'
-        )
-    )
-  return allChangelogLinesAreVersionBump(changelogLines)
-}
-
-module.exports = { isPointlessVersionBump }

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

@@ -1,38 +0,0 @@
-'use strict'
-
-const core = require('@actions/core')
-const github = require('@actions/github')
-const { isPointlessVersionBump } = 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.')
-      }
-    }
-  } catch (error) {
-    core.setFailed(error.message)
-  }
-}
-
-run()

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

@@ -1,431 +0,0 @@
-{
-  "name": "close-bot",
-  "version": "0.0.0",
-  "lockfileVersion": 2,
-  "requires": true,
-  "packages": {
-    "": {
-      "name": "close-bot",
-      "version": "0.0.0",
-      "license": "CC0",
-      "dependencies": {
-        "@actions/core": "^1.10.0",
-        "@actions/github": "^5.1.1"
-      }
-    },
-    "node_modules/@actions/core": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
-      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
-      "dependencies": {
-        "@actions/http-client": "^2.0.1",
-        "uuid": "^8.3.2"
-      }
-    },
-    "node_modules/@actions/github": {
-      "version": "5.1.1",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
-      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
-      "dependencies": {
-        "@actions/http-client": "^2.0.1",
-        "@octokit/core": "^3.6.0",
-        "@octokit/plugin-paginate-rest": "^2.17.0",
-        "@octokit/plugin-rest-endpoint-methods": "^5.13.0"
-      }
-    },
-    "node_modules/@actions/http-client": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
-      "dependencies": {
-        "tunnel": "^0.0.6"
-      }
-    },
-    "node_modules/@octokit/auth-token": {
-      "version": "2.5.0",
-      "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.5.0.tgz",
-      "integrity": "sha512-r5FVUJCOLl19AxiuZD2VRZ/ORjp/4IN98Of6YJoJOkY75CIBuYfmiNHGrDwXr+aLGG55igl9QrxX3hbiXlLb+g==",
-      "dependencies": {
-        "@octokit/types": "^6.0.3"
-      }
-    },
-    "node_modules/@octokit/core": {
-      "version": "3.6.0",
-      "resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.6.0.tgz",
-      "integrity": "sha512-7RKRKuA4xTjMhY+eG3jthb3hlZCsOwg3rztWh75Xc+ShDWOfDDATWbeZpAHBNRpm4Tv9WgBMOy1zEJYXG6NJ7Q==",
-      "dependencies": {
-        "@octokit/auth-token": "^2.4.4",
-        "@octokit/graphql": "^4.5.8",
-        "@octokit/request": "^5.6.3",
-        "@octokit/request-error": "^2.0.5",
-        "@octokit/types": "^6.0.3",
-        "before-after-hook": "^2.2.0",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "node_modules/@octokit/endpoint": {
-      "version": "6.0.12",
-      "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.12.tgz",
-      "integrity": "sha512-lF3puPwkQWGfkMClXb4k/eUT/nZKQfxinRWJrdZaJO85Dqwo/G0yOC434Jr2ojwafWJMYqFGFa5ms4jJUgujdA==",
-      "dependencies": {
-        "@octokit/types": "^6.0.3",
-        "is-plain-object": "^5.0.0",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "node_modules/@octokit/graphql": {
-      "version": "4.8.0",
-      "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.8.0.tgz",
-      "integrity": "sha512-0gv+qLSBLKF0z8TKaSKTsS39scVKF9dbMxJpj3U0vC7wjNWFuIpL/z76Qe2fiuCbDRcJSavkXsVtMS6/dtQQsg==",
-      "dependencies": {
-        "@octokit/request": "^5.6.0",
-        "@octokit/types": "^6.0.3",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "node_modules/@octokit/openapi-types": {
-      "version": "11.2.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.2.0.tgz",
-      "integrity": "sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA=="
-    },
-    "node_modules/@octokit/plugin-paginate-rest": {
-      "version": "2.17.0",
-      "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.17.0.tgz",
-      "integrity": "sha512-tzMbrbnam2Mt4AhuyCHvpRkS0oZ5MvwwcQPYGtMv4tUa5kkzG58SVB0fcsLulOZQeRnOgdkZWkRUiyBlh0Bkyw==",
-      "dependencies": {
-        "@octokit/types": "^6.34.0"
-      },
-      "peerDependencies": {
-        "@octokit/core": ">=2"
-      }
-    },
-    "node_modules/@octokit/plugin-rest-endpoint-methods": {
-      "version": "5.13.0",
-      "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.13.0.tgz",
-      "integrity": "sha512-uJjMTkN1KaOIgNtUPMtIXDOjx6dGYysdIFhgA52x4xSadQCz3b/zJexvITDVpANnfKPW/+E0xkOvLntqMYpviA==",
-      "dependencies": {
-        "@octokit/types": "^6.34.0",
-        "deprecation": "^2.3.1"
-      },
-      "peerDependencies": {
-        "@octokit/core": ">=3"
-      }
-    },
-    "node_modules/@octokit/request": {
-      "version": "5.6.3",
-      "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.6.3.tgz",
-      "integrity": "sha512-bFJl0I1KVc9jYTe9tdGGpAMPy32dLBXXo1dS/YwSCTL/2nd9XeHsY616RE3HPXDVk+a+dBuzyz5YdlXwcDTr2A==",
-      "dependencies": {
-        "@octokit/endpoint": "^6.0.1",
-        "@octokit/request-error": "^2.1.0",
-        "@octokit/types": "^6.16.1",
-        "is-plain-object": "^5.0.0",
-        "node-fetch": "^2.6.7",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "node_modules/@octokit/request-error": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
-      "integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==",
-      "dependencies": {
-        "@octokit/types": "^6.0.3",
-        "deprecation": "^2.0.0",
-        "once": "^1.4.0"
-      }
-    },
-    "node_modules/@octokit/types": {
-      "version": "6.34.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.34.0.tgz",
-      "integrity": "sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==",
-      "dependencies": {
-        "@octokit/openapi-types": "^11.2.0"
-      }
-    },
-    "node_modules/before-after-hook": {
-      "version": "2.2.2",
-      "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.2.tgz",
-      "integrity": "sha512-3pZEU3NT5BFUo/AD5ERPWOgQOCZITni6iavr5AUw5AUwQjMlI0kzu5btnyD39AF0gUEsDPwJT+oY1ORBJijPjQ=="
-    },
-    "node_modules/deprecation": {
-      "version": "2.3.1",
-      "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz",
-      "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ=="
-    },
-    "node_modules/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==",
-      "engines": {
-        "node": ">=0.10.0"
-      }
-    },
-    "node_modules/node-fetch": {
-      "version": "2.6.7",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
-      "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
-      "dependencies": {
-        "whatwg-url": "^5.0.0"
-      },
-      "engines": {
-        "node": "4.x || >=6.0.0"
-      },
-      "peerDependencies": {
-        "encoding": "^0.1.0"
-      },
-      "peerDependenciesMeta": {
-        "encoding": {
-          "optional": true
-        }
-      }
-    },
-    "node_modules/once": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
-      "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
-      "dependencies": {
-        "wrappy": "1"
-      }
-    },
-    "node_modules/tr46": {
-      "version": "0.0.3",
-      "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
-      "integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o="
-    },
-    "node_modules/tunnel": {
-      "version": "0.0.6",
-      "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
-      "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
-      "engines": {
-        "node": ">=0.6.11 <=0.7.0 || >=0.7.3"
-      }
-    },
-    "node_modules/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=="
-    },
-    "node_modules/uuid": {
-      "version": "8.3.2",
-      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
-      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
-      "bin": {
-        "uuid": "dist/bin/uuid"
-      }
-    },
-    "node_modules/webidl-conversions": {
-      "version": "3.0.1",
-      "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
-      "integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE="
-    },
-    "node_modules/whatwg-url": {
-      "version": "5.0.0",
-      "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
-      "integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=",
-      "dependencies": {
-        "tr46": "~0.0.3",
-        "webidl-conversions": "^3.0.0"
-      }
-    },
-    "node_modules/wrappy": {
-      "version": "1.0.2",
-      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
-      "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8="
-    }
-  },
-  "dependencies": {
-    "@actions/core": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
-      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
-      "requires": {
-        "@actions/http-client": "^2.0.1",
-        "uuid": "^8.3.2"
-      }
-    },
-    "@actions/github": {
-      "version": "5.1.1",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
-      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
-      "requires": {
-        "@actions/http-client": "^2.0.1",
-        "@octokit/core": "^3.6.0",
-        "@octokit/plugin-paginate-rest": "^2.17.0",
-        "@octokit/plugin-rest-endpoint-methods": "^5.13.0"
-      }
-    },
-    "@actions/http-client": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
-      "requires": {
-        "tunnel": "^0.0.6"
-      }
-    },
-    "@octokit/auth-token": {
-      "version": "2.5.0",
-      "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.5.0.tgz",
-      "integrity": "sha512-r5FVUJCOLl19AxiuZD2VRZ/ORjp/4IN98Of6YJoJOkY75CIBuYfmiNHGrDwXr+aLGG55igl9QrxX3hbiXlLb+g==",
-      "requires": {
-        "@octokit/types": "^6.0.3"
-      }
-    },
-    "@octokit/core": {
-      "version": "3.6.0",
-      "resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.6.0.tgz",
-      "integrity": "sha512-7RKRKuA4xTjMhY+eG3jthb3hlZCsOwg3rztWh75Xc+ShDWOfDDATWbeZpAHBNRpm4Tv9WgBMOy1zEJYXG6NJ7Q==",
-      "requires": {
-        "@octokit/auth-token": "^2.4.4",
-        "@octokit/graphql": "^4.5.8",
-        "@octokit/request": "^5.6.3",
-        "@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.12",
-      "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.12.tgz",
-      "integrity": "sha512-lF3puPwkQWGfkMClXb4k/eUT/nZKQfxinRWJrdZaJO85Dqwo/G0yOC434Jr2ojwafWJMYqFGFa5ms4jJUgujdA==",
-      "requires": {
-        "@octokit/types": "^6.0.3",
-        "is-plain-object": "^5.0.0",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "@octokit/graphql": {
-      "version": "4.8.0",
-      "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.8.0.tgz",
-      "integrity": "sha512-0gv+qLSBLKF0z8TKaSKTsS39scVKF9dbMxJpj3U0vC7wjNWFuIpL/z76Qe2fiuCbDRcJSavkXsVtMS6/dtQQsg==",
-      "requires": {
-        "@octokit/request": "^5.6.0",
-        "@octokit/types": "^6.0.3",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "@octokit/openapi-types": {
-      "version": "11.2.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.2.0.tgz",
-      "integrity": "sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA=="
-    },
-    "@octokit/plugin-paginate-rest": {
-      "version": "2.17.0",
-      "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.17.0.tgz",
-      "integrity": "sha512-tzMbrbnam2Mt4AhuyCHvpRkS0oZ5MvwwcQPYGtMv4tUa5kkzG58SVB0fcsLulOZQeRnOgdkZWkRUiyBlh0Bkyw==",
-      "requires": {
-        "@octokit/types": "^6.34.0"
-      }
-    },
-    "@octokit/plugin-rest-endpoint-methods": {
-      "version": "5.13.0",
-      "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.13.0.tgz",
-      "integrity": "sha512-uJjMTkN1KaOIgNtUPMtIXDOjx6dGYysdIFhgA52x4xSadQCz3b/zJexvITDVpANnfKPW/+E0xkOvLntqMYpviA==",
-      "requires": {
-        "@octokit/types": "^6.34.0",
-        "deprecation": "^2.3.1"
-      }
-    },
-    "@octokit/request": {
-      "version": "5.6.3",
-      "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.6.3.tgz",
-      "integrity": "sha512-bFJl0I1KVc9jYTe9tdGGpAMPy32dLBXXo1dS/YwSCTL/2nd9XeHsY616RE3HPXDVk+a+dBuzyz5YdlXwcDTr2A==",
-      "requires": {
-        "@octokit/endpoint": "^6.0.1",
-        "@octokit/request-error": "^2.1.0",
-        "@octokit/types": "^6.16.1",
-        "is-plain-object": "^5.0.0",
-        "node-fetch": "^2.6.7",
-        "universal-user-agent": "^6.0.0"
-      }
-    },
-    "@octokit/request-error": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
-      "integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==",
-      "requires": {
-        "@octokit/types": "^6.0.3",
-        "deprecation": "^2.0.0",
-        "once": "^1.4.0"
-      }
-    },
-    "@octokit/types": {
-      "version": "6.34.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.34.0.tgz",
-      "integrity": "sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==",
-      "requires": {
-        "@octokit/openapi-types": "^11.2.0"
-      }
-    },
-    "before-after-hook": {
-      "version": "2.2.2",
-      "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.2.tgz",
-      "integrity": "sha512-3pZEU3NT5BFUo/AD5ERPWOgQOCZITni6iavr5AUw5AUwQjMlI0kzu5btnyD39AF0gUEsDPwJT+oY1ORBJijPjQ=="
-    },
-    "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.7",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
-      "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
-      "requires": {
-        "whatwg-url": "^5.0.0"
-      }
-    },
-    "once": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
-      "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
-      "requires": {
-        "wrappy": "1"
-      }
-    },
-    "tr46": {
-      "version": "0.0.3",
-      "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
-      "integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o="
-    },
-    "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=="
-    },
-    "uuid": {
-      "version": "8.3.2",
-      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
-      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
-    },
-    "webidl-conversions": {
-      "version": "3.0.1",
-      "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
-      "integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE="
-    },
-    "whatwg-url": {
-      "version": "5.0.0",
-      "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
-      "integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=",
-      "requires": {
-        "tr46": "~0.0.3",
-        "webidl-conversions": "^3.0.0"
-      }
-    },
-    "wrappy": {
-      "version": "1.0.2",
-      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
-      "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8="
-    }
-  }
-}

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

@@ -1,16 +0,0 @@
-{
-  "name": "close-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.10.0",
-    "@actions/github": "^5.1.1"
-  }
-}

.github/actions/docusaurus-swizzled-warning/action.yml

@@ -0,0 +1,12 @@
+name: 'docusaurus-theme-openapi swizzled component changes warning'
+description: 'Check for changes in docusaurus-theme-openapi components which are swizzled and prints out a warning'
+branding:
+  icon: 'alert-triangle'
+  color: 'yellow'
+inputs:
+  github-token:
+    description: 'The GITHUB_TOKEN secret'
+    required: true
+runs:
+  using: 'node20'
+  main: 'index.js'

.github/actions/docusaurus-swizzled-warning/helpers.js

@@ -0,0 +1,105 @@
+'use strict'
+
+/**
+ * Returns info about all files changed in a PR (max 3000 results)
+ *
+ * @param {object} client hydrated octokit ready to use for GitHub Actions
+ * @param {string} owner repo owner
+ * @param {string} repo repo name
+ * @param {number} pullNumber pull request number
+ * @returns {object[]} array of object that describe pr changed files - see https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests-files
+ */
+async function getAllFilesForPullRequest(client, owner, repo, pullNumber) {
+  const perPage = 100 // Max number of items per page
+  let page = 1 // Start with the first page
+  let allFiles = []
+  while (true) {
+    const response = await client.rest.pulls.listFiles({
+      owner,
+      repo,
+      pull_number: pullNumber,
+      per_page: perPage,
+      page,
+    })
+
+    if (response.data.length === 0) {
+      // Break the loop if no more results
+      break
+    }
+
+    allFiles = allFiles.concat(response.data)
+    page++ // Move to the next page
+  }
+  return allFiles
+}
+
+/**
+ * Get a list of files changed betwen two tags for a github repo
+ *
+ * @param {object} client hydrated octokit ready to use for GitHub Actions
+ * @param {string} owner repo owner
+ * @param {string} repo repo name
+ * @param {string} baseTag base tag
+ * @param {string} headTag head tag
+ * @returns {string[]} Array listing all changed files betwen the base tag and the head tag
+ */
+async function getChangedFilesBetweenTags(
+  client,
+  owner,
+  repo,
+  baseTag,
+  headTag,
+) {
+  const response = await client.rest.repos.compareCommits({
+    owner,
+    repo,
+    base: baseTag,
+    head: headTag,
+  })
+
+  return response.data.files.map(file => file.filename)
+}
+
+function findKeyEndingWith(obj, ending) {
+  for (const key in obj) {
+    if (key.endsWith(ending)) {
+      return key
+    }
+  }
+}
+
+/**
+ * Get large (>1MB) JSON file from git repo on at ref as a json object
+ *
+ * @param {object} client Hydrated octokit ready to use for GitHub Actions
+ * @param {string} owner Repo owner
+ * @param {string} repo Repo name
+ * @param {string} path Path of the file in repo relative to root directory
+ * @param {string} ref Git refrence (commit, branch, tag)
+ * @returns {string[]} Array listing all changed files betwen the base tag and the head tag
+ */
+async function getLargeJsonAtRef(client, owner, repo, path, ref) {
+  const fileSha = (
+    await client.rest.repos.getContent({
+      owner,
+      repo,
+      path,
+      ref,
+    })
+  ).data.sha
+  const fileBlob = (
+    await client.rest.git.getBlob({
+      owner,
+      repo,
+      file_sha: fileSha,
+    })
+  ).data.content
+  return JSON.parse(Buffer.from(fileBlob, 'base64').toString())
+}
+
+module.exports = {
+  getAllFilesForPullRequest,
+  getChangedFilesBetweenTags,
+  findKeyEndingWith,
+  getLargeJsonAtRef,
+}

.github/actions/docusaurus-swizzled-warning/index.js

@@ -0,0 +1,148 @@
+'use strict'
+
+const core = require('@actions/core')
+const github = require('@actions/github')
+const {
+  getAllFilesForPullRequest,
+  getChangedFilesBetweenTags,
+  findKeyEndingWith,
+  getLargeJsonAtRef,
+} = 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)
+    const packageName = 'docusaurus-theme-openapi'
+    const packageParentName = 'docusaurus-preset-openapi'
+    const overideComponents = ['Curl', 'Response']
+    const messageTemplate = `<table><thead><tr><th colspan="2">
+      ⚠️ This PR contains changes to components of ${packageName} we've overridden
+    </th></tr>
+    <tr><th colspan="2">
+      We need to watch out for changes to the ${overideComponents.join(
+        ', ',
+      )} components
+    </th></tr></thead>
+    `
+
+    if (
+      !['dependabot[bot]', 'dependabot-preview[bot]'].includes(pr.user.login)
+    ) {
+      return
+    }
+    const files = await getAllFilesForPullRequest(
+      client,
+      github.context.repo.owner,
+      github.context.repo.repo,
+      pr.number,
+    )
+
+    const file = files.filter(f => f.filename === 'package-lock.json')[0]
+    if (file === undefined) {
+      return
+    }
+
+    const prCommitRefForFile = file.contents_url.split('ref=')[1]
+    const pkgLockNewJson = await getLargeJsonAtRef(
+      client,
+      github.context.repo.owner,
+      github.context.repo.repo,
+      file.filename,
+      prCommitRefForFile,
+    )
+    const pkgLockOldJson = await getLargeJsonAtRef(
+      client,
+      github.context.repo.owner,
+      github.context.repo.repo,
+      file.filename,
+      'master',
+    )
+
+    const oldVesionModuleKey = findKeyEndingWith(
+      pkgLockOldJson.packages,
+      `node_modules/${packageName}`,
+    )
+    const newVesionModuleKey = findKeyEndingWith(
+      pkgLockNewJson.packages,
+      `node_modules/${packageName}`,
+    )
+    let oldVersion = pkgLockOldJson.packages[oldVesionModuleKey].version
+    let newVersion = pkgLockNewJson.packages[newVesionModuleKey].version
+
+    const oldVesionModuleKeyParent = findKeyEndingWith(
+      pkgLockOldJson.packages,
+      `node_modules/${packageParentName}`,
+    )
+    const newVesionModuleKeyParent = findKeyEndingWith(
+      pkgLockNewJson.packages,
+      `node_modules/${packageParentName}`,
+    )
+    const oldVersionParent =
+      pkgLockOldJson.packages[oldVesionModuleKeyParent].dependencies[
+        packageName
+      ].substring(1)
+    const newVersionParent =
+      pkgLockNewJson.packages[newVesionModuleKeyParent].dependencies[
+        packageName
+      ].substring(1)
+
+    // if parent dependency is higher version then existing
+    // npm install will retrive the newer version from the parent dependency
+    if (oldVersionParent > oldVersion) {
+      oldVersion = oldVersionParent
+    }
+    if (newVersionParent > newVersion) {
+      newVersion = newVersionParent
+    }
+    core.info(`oldVersion=${oldVersion}`)
+    core.info(`newVersion=${newVersion}`)
+
+    if (newVersion !== oldVersion) {
+      const pkgChangedFiles = await getChangedFilesBetweenTags(
+        client,
+        'cloud-annotations',
+        'docusaurus-openapi',
+        `v${oldVersion}`,
+        `v${newVersion}`,
+      )
+      const changedComponents = overideComponents.filter(
+        componenet =>
+          pkgChangedFiles.filter(
+            path =>
+              path.includes('docusaurus-theme-openapi/src/theme') &&
+              path.includes(componenet),
+          ).length > 0,
+      )
+      const versionReport = `<tbody><tr><td> Old version </td><td> ${oldVersion} </td></tr>
+      <tr><td> New version </td><td> ${newVersion} </td></tr>
+      `
+      const changedComponentsReport = `<tr><td> Overide components changed </td><td> ${changedComponents.join(
+        ', ',
+      )} </td></tr></tbody></table>
+      `
+      const body = messageTemplate + versionReport + changedComponentsReport
+      await client.rest.issues.createComment({
+        owner: github.context.repo.owner,
+        repo: github.context.repo.repo,
+        issue_number: pr.number,
+        body,
+      })
+
+      core.info('Found changes and posted comment, done.')
+      return
+    }
+
+    core.info('No changes found, done.')
+  } catch (error) {
+    core.setFailed(error.message)
+  }
+}
+
+run()

.github/actions/docusaurus-swizzled-warning/package-lock.json

@@ -0,0 +1,237 @@
+{
+    "name": "docusaurus-swizzled-warning",
+    "version": "0.0.0",
+    "lockfileVersion": 3,
+    "requires": true,
+    "packages": {
+        "": {
+            "name": "docusaurus-swizzled-warning",
+            "version": "0.0.0",
+            "license": "CC0",
+            "dependencies": {
+                "@actions/core": "^1.10.1",
+                "@actions/github": "^6.0.0"
+            }
+        },
+        "node_modules/@actions/core": {
+            "version": "1.10.1",
+            "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
+            "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
+            "dependencies": {
+                "@actions/http-client": "^2.0.1",
+                "uuid": "^8.3.2"
+            }
+        },
+        "node_modules/@actions/github": {
+            "version": "6.0.0",
+            "resolved": "https://registry.npmjs.org/@actions/github/-/github-6.0.0.tgz",
+            "integrity": "sha512-alScpSVnYmjNEXboZjarjukQEzgCRmjMv6Xj47fsdnqGS73bjJNDpiiXmp8jr0UZLdUB6d9jW63IcmddUP+l0g==",
+            "dependencies": {
+                "@actions/http-client": "^2.2.0",
+                "@octokit/core": "^5.0.1",
+                "@octokit/plugin-paginate-rest": "^9.0.0",
+                "@octokit/plugin-rest-endpoint-methods": "^10.0.0"
+            }
+        },
+        "node_modules/@actions/http-client": {
+            "version": "2.2.0",
+            "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.2.0.tgz",
+            "integrity": "sha512-q+epW0trjVUUHboliPb4UF9g2msf+w61b32tAkFEwL/IwP0DQWgbCMM0Hbe3e3WXSKz5VcUXbzJQgy8Hkra/Lg==",
+            "dependencies": {
+                "tunnel": "^0.0.6",
+                "undici": "^5.25.4"
+            }
+        },
+        "node_modules/@fastify/busboy": {
+            "version": "2.0.0",
+            "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.0.0.tgz",
+            "integrity": "sha512-JUFJad5lv7jxj926GPgymrWQxxjPYuJNiNjNMzqT+HiuP6Vl3dk5xzG+8sTX96np0ZAluvaMzPsjhHZ5rNuNQQ==",
+            "engines": {
+                "node": ">=14"
+            }
+        },
+        "node_modules/@octokit/auth-token": {
+            "version": "4.0.0",
+            "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-4.0.0.tgz",
+            "integrity": "sha512-tY/msAuJo6ARbK6SPIxZrPBms3xPbfwBrulZe0Wtr/DIY9lje2HeV1uoebShn6mx7SjCHif6EjMvoREj+gZ+SA==",
+            "engines": {
+                "node": ">= 18"
+            }
+        },
+        "node_modules/@octokit/core": {
+            "version": "5.0.1",
+            "resolved": "https://registry.npmjs.org/@octokit/core/-/core-5.0.1.tgz",
+            "integrity": "sha512-lyeeeZyESFo+ffI801SaBKmCfsvarO+dgV8/0gD8u1d87clbEdWsP5yC+dSj3zLhb2eIf5SJrn6vDz9AheETHw==",
+            "dependencies": {
+                "@octokit/auth-token": "^4.0.0",
+                "@octokit/graphql": "^7.0.0",
+                "@octokit/request": "^8.0.2",
+                "@octokit/request-error": "^5.0.0",
+                "@octokit/types": "^12.0.0",
+                "before-after-hook": "^2.2.0",
+                "universal-user-agent": "^6.0.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            }
+        },
+        "node_modules/@octokit/endpoint": {
+            "version": "9.0.1",
+            "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-9.0.1.tgz",
+            "integrity": "sha512-hRlOKAovtINHQPYHZlfyFwaM8OyetxeoC81lAkBy34uLb8exrZB50SQdeW3EROqiY9G9yxQTpp5OHTV54QD+vA==",
+            "dependencies": {
+                "@octokit/types": "^12.0.0",
+                "is-plain-object": "^5.0.0",
+                "universal-user-agent": "^6.0.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            }
+        },
+        "node_modules/@octokit/graphql": {
+            "version": "7.0.2",
+            "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-7.0.2.tgz",
+            "integrity": "sha512-OJ2iGMtj5Tg3s6RaXH22cJcxXRi7Y3EBqbHTBRq+PQAqfaS8f/236fUrWhfSn8P4jovyzqucxme7/vWSSZBX2Q==",
+            "dependencies": {
+                "@octokit/request": "^8.0.1",
+                "@octokit/types": "^12.0.0",
+                "universal-user-agent": "^6.0.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            }
+        },
+        "node_modules/@octokit/openapi-types": {
+            "version": "19.0.0",
+            "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-19.0.0.tgz",
+            "integrity": "sha512-PclQ6JGMTE9iUStpzMkwLCISFn/wDeRjkZFIKALpvJQNBGwDoYYi2fFvuHwssoQ1rXI5mfh6jgTgWuddeUzfWw=="
+        },
+        "node_modules/@octokit/plugin-paginate-rest": {
+            "version": "9.0.0",
+            "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-9.0.0.tgz",
+            "integrity": "sha512-oIJzCpttmBTlEhBmRvb+b9rlnGpmFgDtZ0bB6nq39qIod6A5DP+7RkVLMOixIgRCYSHDTeayWqmiJ2SZ6xgfdw==",
+            "dependencies": {
+                "@octokit/types": "^12.0.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            },
+            "peerDependencies": {
+                "@octokit/core": ">=5"
+            }
+        },
+        "node_modules/@octokit/plugin-rest-endpoint-methods": {
+            "version": "10.0.1",
+            "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-10.0.1.tgz",
+            "integrity": "sha512-fgS6HPkPvJiz8CCliewLyym9qAx0RZ/LKh3sATaPfM41y/O2wQ4Z9MrdYeGPVh04wYmHFmWiGlKPC7jWVtZXQA==",
+            "dependencies": {
+                "@octokit/types": "^12.0.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            },
+            "peerDependencies": {
+                "@octokit/core": ">=5"
+            }
+        },
+        "node_modules/@octokit/request": {
+            "version": "8.1.4",
+            "resolved": "https://registry.npmjs.org/@octokit/request/-/request-8.1.4.tgz",
+            "integrity": "sha512-M0aaFfpGPEKrg7XoA/gwgRvc9MSXHRO2Ioki1qrPDbl1e9YhjIwVoHE7HIKmv/m3idzldj//xBujcFNqGX6ENA==",
+            "dependencies": {
+                "@octokit/endpoint": "^9.0.0",
+                "@octokit/request-error": "^5.0.0",
+                "@octokit/types": "^12.0.0",
+                "is-plain-object": "^5.0.0",
+                "universal-user-agent": "^6.0.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            }
+        },
+        "node_modules/@octokit/request-error": {
+            "version": "5.0.1",
+            "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.0.1.tgz",
+            "integrity": "sha512-X7pnyTMV7MgtGmiXBwmO6M5kIPrntOXdyKZLigNfQWSEQzVxR4a4vo49vJjTWX70mPndj8KhfT4Dx+2Ng3vnBQ==",
+            "dependencies": {
+                "@octokit/types": "^12.0.0",
+                "deprecation": "^2.0.0",
+                "once": "^1.4.0"
+            },
+            "engines": {
+                "node": ">= 18"
+            }
+        },
+        "node_modules/@octokit/types": {
+            "version": "12.0.0",
+            "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.0.0.tgz",
+            "integrity": "sha512-EzD434aHTFifGudYAygnFlS1Tl6KhbTynEWELQXIbTY8Msvb5nEqTZIm7sbPEt4mQYLZwu3zPKVdeIrw0g7ovg==",
+            "dependencies": {
+                "@octokit/openapi-types": "^19.0.0"
+            }
+        },
+        "node_modules/before-after-hook": {
+            "version": "2.2.3",
+            "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.3.tgz",
+            "integrity": "sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ=="
+        },
+        "node_modules/deprecation": {
+            "version": "2.3.1",
+            "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz",
+            "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ=="
+        },
+        "node_modules/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==",
+            "engines": {
+                "node": ">=0.10.0"
+            }
+        },
+        "node_modules/once": {
+            "version": "1.4.0",
+            "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+            "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
+            "dependencies": {
+                "wrappy": "1"
+            }
+        },
+        "node_modules/tunnel": {
+            "version": "0.0.6",
+            "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
+            "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
+            "engines": {
+                "node": ">=0.6.11 <=0.7.0 || >=0.7.3"
+            }
+        },
+        "node_modules/undici": {
+            "version": "5.26.3",
+            "resolved": "https://registry.npmjs.org/undici/-/undici-5.26.3.tgz",
+            "integrity": "sha512-H7n2zmKEWgOllKkIUkLvFmsJQj062lSm3uA4EYApG8gLuiOM0/go9bIoC3HVaSnfg4xunowDE2i9p8drkXuvDw==",
+            "dependencies": {
+                "@fastify/busboy": "^2.0.0"
+            },
+            "engines": {
+                "node": ">=14.0"
+            }
+        },
+        "node_modules/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=="
+        },
+        "node_modules/uuid": {
+            "version": "8.3.2",
+            "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+            "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+            "bin": {
+                "uuid": "dist/bin/uuid"
+            }
+        },
+        "node_modules/wrappy": {
+            "version": "1.0.2",
+            "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+            "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
+        }
+    }
+}

.github/actions/docusaurus-swizzled-warning/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "docusaurus-swizzled-warning",
+    "version": "0.0.0",
+    "description": "",
+    "main": "index.js",
+    "private": true,
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "author": "jNullj",
+    "license": "CC0",
+    "dependencies": {
+        "@actions/core": "^1.10.1",
+        "@actions/github": "^6.0.0"
+    }
+}

.github/actions/draft-release/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:12-buster
+FROM node:18-bullseye
 
 RUN apt-get update
 RUN apt-get install -y jq

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

@@ -2,14 +2,17 @@
 
 set -euxo pipefail
 
-# Set up a git user
-git config user.name "release[bot]"
-git config user.email "actions@users.noreply.github.com"
+# mark workspace dir as 'safe'
+git config --system --add safe.directory '/github/workspace'
 
 # Find last server-YYYY-MM-DD tag
 git fetch --unshallow --tags
 LAST_TAG=$(git tag | grep server | tail -n 1)
 
+# Set up a git user
+git config user.name "release[bot]"
+git config user.email "actions@users.noreply.github.com"
+
 # Find the marker in CHANGELOG.md
 INSERT_POINT=$(grep -n "^\-\-\-$" CHANGELOG.md | cut -f1 -d:)
 INSERT_POINT=$((INSERT_POINT+1))

.github/actions/frontend-tests/action.yml

@@ -1,31 +0,0 @@
-name: 'Frontend tests'
-description: 'Run frontend tests and check types'
-runs:
-  using: 'composite'
-  steps:
-    - name: Prepare frontend tests
-      if: always()
-      run: npm run defs && npm run features
-      shell: bash
-
-    - name: Tests
-      if: always()
-      run: npm run test:frontend -- --reporter json --reporter-option 'output=reports/frontend-tests.json'
-      shell: bash
-
-    - name: Type Checks
-      if: always()
-      run: |
-        set -o pipefail
-        npm run check-types:frontend 2>&1 | tee reports/frontend-types.txt
-      shell: bash
-
-    - name: Write Markdown Summary
-      if: always()
-      run: |
-        node scripts/mocha2md.js 'Frontend Tests' reports/frontend-tests.json >> $GITHUB_STEP_SUMMARY
-        echo '# Frontend Types' >> $GITHUB_STEP_SUMMARY
-        echo '```' >> $GITHUB_STEP_SUMMARY
-        cat reports/frontend-types.txt >> $GITHUB_STEP_SUMMARY
-        echo '```' >> $GITHUB_STEP_SUMMARY
-      shell: bash

.github/actions/integration-tests/action.yml

@@ -7,11 +7,19 @@ inputs:
 runs:
   using: 'composite'
   steps:
+    - name: Migrate DB
+      if: always()
+      run: npm run migrate up
+      env:
+        POSTGRES_URL: postgresql://postgres:postgres@localhost:5432/ci_test
+      shell: bash
+
     - name: Integration Tests
       if: always()
       run: npm run test:integration -- --reporter json --reporter-option 'output=reports/integration-tests.json'
       env:
         GH_TOKEN: '${{ inputs.github-token }}'
+        POSTGRES_URL: postgresql://postgres:postgres@localhost:5432/ci_test
       shell: bash
 
     - name: Write Markdown Summary

.github/actions/setup/action.yml

@@ -19,6 +19,10 @@ runs:
       with:
         node-version: ${{ inputs.node-version }}
 
+    - name: Install NPM 9
+      run: npm install -g npm@^9.0.0
+      shell: bash
+
     - name: Install dependencies
       if: ${{ inputs.cypress == 'false' }}
       env:

.github/dependabot.yml

@@ -8,6 +8,7 @@ updates:
       day: friday
       time: '12:00'
     open-pull-requests-limit: 99
+    rebase-strategy: disabled
     ignore:
       # https://github.com/badges/shields/issues/7324
       # https://github.com/badges/shields/issues/7447
@@ -16,9 +17,6 @@ updates:
       - dependency-name: 'decamelize'
       - dependency-name: 'humanize-string'
 
-      # https://github.com/badges/shields/pull/7288#issuecomment-974699240
-      - dependency-name: '@types/node'
-
   # badge-maker package dependencies
   - package-ecosystem: npm
     directory: '/badge-maker'
@@ -27,17 +25,22 @@ updates:
       day: friday
       time: '12:00'
     open-pull-requests-limit: 99
+    rebase-strategy: disabled
 
-  # close-bot package dependencies
-  - package-ecosystem: npm
-    directory: '/.github/actions/close-bot'
-    schedule:
-      interval: weekly
-      day: friday
-      time: '12:00'
-    open-pull-requests-limit: 99
+  # GH actions
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
       interval: weekly
     open-pull-requests-limit: 99
+    rebase-strategy: disabled
+
+    # docusaurus-swizzled-warning package dependencies
+  - package-ecosystem: npm
+    directory: '/.github/actions/docusaurus-swizzled-warning'
+    schedule:
+      interval: weekly
+      day: friday
+      time: '12:00'
+    open-pull-requests-limit: 99
+    rebase-strategy: disabled

.github/scripts/check-docusaurus-versions.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Docusaurus outputs some important errors as log messages
+# but doesn't actually fail
+# https://github.com/facebook/docusaurus/blob/v2.4.3/packages/docusaurus/src/server/siteMetadata.ts#L75-L92
+# this script runs `docusaurus build`. If it outputs any [ERROR]s, we exit with 1
+
+if ( npm run build 2>&1 | grep '\[ERROR\]' )
+then
+    echo "You probably need to run: npm update @docusaurus/preset-classic"
+    exit 1
+else
+    exit 0
+fi

.github/scripts/cleanup-review-apps.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+apps=$(flyctl apps list --json | jq -r .[].ID | grep -E "pr-[0-9]+-badges-shields") || exit 0
+
+for app in $apps
+do
+  flyctl apps destroy "$app" -y
+done

.github/scripts/deploy-review-app.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+app="pr-$PR_NUMBER-badges-shields"
+region="ewr"
+org="shields-io"
+
+# Get PR JSON from the API
+# This will fail if $PR_NUMBER is not a valid PR
+pr_json=$(curl --fail "https://api.github.com/repos/badges/shields/pulls/$PR_NUMBER")
+
+# Checkout the PR branch
+git config user.name "actions[bot]"
+git config user.email "actions@users.noreply.github.com"
+git fetch origin "pull/$PR_NUMBER/head:pr-$PR_NUMBER"
+git checkout "pr-$PR_NUMBER"
+
+# If the app does not already exist, create it
+if ! flyctl status --app "$app"; then
+  flyctl launch --no-deploy --copy-config --name "$app" --region "$region" --org "$org" --dockerfile ./Dockerfile
+  echo $SECRETS | tr " " "\n" | flyctl secrets import --app "$app"
+fi
+
+# Deploy
+flyctl deploy --app "$app" --region "$region"
+flyctl scale count 1 --app "$app" --yes
+
+# Post a comment on the PR
+app_url=$(flyctl status --app "$app" --json | jq -r .Hostname)
+comment_url=$(echo "$pr_json" | jq .comments_url -r)
+curl "$comment_url" \
+    -X POST \
+    -H "Authorization: token $GITHUB_TOKEN" \
+    --data "{\"body\":\"🚀 Updated review app: https://$app_url\"}"

.github/workflows/build-docker-image.yml

@@ -1,25 +1,30 @@
 name: Build Docker Image
 on:
   pull_request:
+  push:
+    branches:
+      - 'gh-readonly-queue/**'
 
 jobs:
   build-docker-image:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
+        with:
+          version: v0.9.1
 
       - name: Set Git Short SHA
         run: echo "SHORT_SHA=${GITHUB_SHA::7}" >> $GITHUB_ENV
 
       - name: Build
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           context: .
           push: false
-          tags: shieldsio/shields:pr-validation
+          tags: ghcr.io/badges/shields:pr-validation
           build-args: |
             version=${{ env.SHORT_SHA }}

.github/workflows/check-docusaurus-versions.yml

@@ -0,0 +1,23 @@
+name: Check Docusaurus Plugin Versions
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  check-docusaurus-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 18
+          cypress: true
+
+      - run: .github/scripts/check-docusaurus-versions.sh

.github/workflows/cleanup-review-apps.yml

@@ -0,0 +1,24 @@
+name: Cleanup Review Apps
+on:
+  schedule:
+    - cron: '0 7 * * *'
+    # At 07:00, daily
+  workflow_dispatch:
+
+jobs:
+  cleanup-review-apps:
+    runs-on: ubuntu-latest
+    environment: 'Review Apps'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: superfly/flyctl-actions/setup-flyctl@master
+
+      - name: install jq
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get install -y jq
+
+      - run: .github/scripts/cleanup-review-apps.sh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

.github/workflows/create-release.yml

@@ -6,6 +6,7 @@ on:
 
 permissions:
   contents: write
+  packages: write
 
 jobs:
   create-release:
@@ -23,7 +24,7 @@ jobs:
         run: echo "::set-output name=date::$(date --rfc-3339=date)"
 
       - name: Checkout branch "master"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: 'master'
 
@@ -34,19 +35,37 @@ jobs:
           tag: server-${{ steps.date.outputs.date }}
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
+        with:
+          version: v0.9.1
 
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Build and push snapshot release to DockerHub
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           context: .
           push: true
           tags: shieldsio/shields:server-${{ steps.date.outputs.date }}
           build-args: |
             version=server-${{ steps.date.outputs.date }}
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push snapshot release to GHCR
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ghcr.io/badges/shields:server-${{ steps.date.outputs.date }}
+          build-args: |
+            version=server-${{ steps.date.outputs.date }}

.github/workflows/danger.yml

@@ -1,7 +1,7 @@
 name: Danger
 on:
   pull_request_target:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
 
 permissions:
   checks: write
@@ -11,15 +11,15 @@ permissions:
 jobs:
   danger:
     runs-on: ubuntu-latest
-    if: github.actor != 'dependabot[bot]'
+    if: github.actor != 'dependabot[bot]' && github.actor != 'repo-ranger[bot]'
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Danger
         run: npm run danger ci

.github/workflows/deploy-docs.yml

@@ -12,14 +12,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
 
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 18
+
       - name: Build
-        run: |
-          npm ci
-          npm run build-docs
+        run: npm run build-docs
 
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@v4

.github/workflows/deploy-review-app.yml

@@ -0,0 +1,43 @@
+name: Create/Update Review App
+on:
+  workflow_dispatch:
+    inputs:
+      pr_number:
+        description: 'PR Number to deploy e.g: 1234'
+        required: true
+
+permissions:
+  pull-requests: write
+
+jobs:
+  deploy-review-app:
+    runs-on: ubuntu-latest
+    environment: 'Review Apps'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: superfly/flyctl-actions/setup-flyctl@master
+
+      - name: install jq
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get install -y jq
+
+      - run: .github/scripts/deploy-review-app.sh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
+          PR_NUMBER: ${{ github.event.inputs.pr_number }}
+          # credentials to set when we create the review app
+          SECRETS: |
+            GH_TOKEN=${{ secrets.GH_PAT }}
+            LIBRARIESIO_TOKENS=${{ secrets.SERVICETESTS_LIBRARIESIO_TOKENS }}
+            OBS_USER=${{ secrets.SERVICETESTS_OBS_USER }}
+            OBS_PASS=${{ secrets.SERVICETESTS_OBS_PASS }}
+            SL_INSIGHT_API_TOKEN=${{ secrets.SERVICETESTS_SL_INSIGHT_USER_UUID }}
+            SL_INSIGHT_USER_UUID=${{ secrets.SERVICETESTS_SL_INSIGHT_API_TOKEN }}
+            TWITCH_CLIENT_ID=${{ secrets.SERVICETESTS_TWITCH_CLIENT_ID }}
+            TWITCH_CLIENT_SECRET=${{ secrets.SERVICETESTS_TWITCH_CLIENT_SECRET }}
+            WHEELMAP_TOKEN=${{ secrets.SERVICETESTS_WHEELMAP_TOKEN }}
+            YOUTUBE_API_KEY=${{ secrets.SERVICETESTS_YOUTUBE_API_KEY }}

.github/workflows/docusaurus-swizzled-warning.yml

@@ -1,22 +1,22 @@
-name: Auto close
+name: Docusaurus swizzled component changes warning
 on:
-  pull_request_target:
+  pull_request:
     types: [opened]
 
 permissions:
   pull-requests: write
 
 jobs:
-  auto-close:
+  docusaurus-swizzled-warning:
     runs-on: ubuntu-latest
     if: github.actor == 'dependabot[bot]'
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install action dependencies
-        run: cd .github/actions/close-bot && npm ci
+        run: cd .github/actions/docusaurus-swizzled-warning && npm ci
 
-      - uses: ./.github/actions/close-bot
+      - uses: ./.github/actions/docusaurus-swizzled-warning
         with:
           github-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/draft-release.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Draft Release
         uses: ./.github/actions/draft-release

.github/workflows/enforce-dependency-review.yml

@@ -1,13 +1,13 @@
 name: 'Dependency Review'
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
 
 jobs:
   enforce-dependency-review:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@v3

.github/workflows/publish-docker-next.yml

@@ -4,18 +4,23 @@ on:
     branches:
       - master
 
+permissions:
+  packages: write
+
 jobs:
   publish-docker-next:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
+        with:
+          version: v0.9.1
 
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
@@ -23,11 +28,31 @@ jobs:
       - name: Set Git Short SHA
         run: echo "SHORT_SHA=${GITHUB_SHA::7}" >> $GITHUB_ENV
 
-      - name: Build and push
-        uses: docker/build-push-action@v3
+      - name: Build and push to DockerHub
+        id: docker_build_push
+        uses: docker/build-push-action@v5
         with:
           context: .
           push: true
           tags: shieldsio/shields:next
           build-args: |
             version=${{ env.SHORT_SHA }}
+
+      - name: Output Image Digest
+        run: echo ${{ steps.docker_build_push.outputs.digest }} >> $GITHUB_STEP_SUMMARY
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push to GHCR
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ghcr.io/badges/shields:next
+          build-args: |
+            version=${{ env.SHORT_SHA }}

.github/workflows/test-bug-run-badge.yml

@@ -0,0 +1,69 @@
+name: Test new bug report badge
+run-name: Test bug report on issue ${{ github.event.issue.number }}
+on:
+  issues:
+    types: [opened]
+jobs:
+  extract-bug-badge-url:
+    if: ${{ contains(github.event.issue.labels.*.name, 'question') }}
+    runs-on: ubuntu-latest
+    outputs:
+      runBadgeTest: ${{ steps.testCondition.outputs.runNext }}
+      link: ${{ steps.testCondition.outputs.link }}
+    steps:
+      - name: Test badge test run conditions
+        id: testCondition
+        env:
+          ISSUE_BODY: '${{ github.event.issue.body }}'
+        run: |
+          product=$(echo "$ISSUE_BODY" | grep -A2 "Are you experiencing an issue with.*" | tail -n 1)
+          link=$(echo "$ISSUE_BODY" | grep -A2 "Link to the badge.*" | tail -n 1)
+
+          if [[ "$product" == "shields.io" && "$link" == "https://img.shields.io"* ]]; then
+            echo "runNext=true" >> "$GITHUB_OUTPUT"
+            echo "link=$link" >> "$GITHUB_OUTPUT"
+          else
+            echo "Conditions not met. Skipping the workflow..."
+            echo "runNext=false" >> "$GITHUB_OUTPUT"
+          fi
+
+  run-bug-badge-url-test:
+    needs: extract-bug-badge-url
+    if: needs.extract-bug-badge-url.outputs.runBadgeTest == 'true'
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 18
+          cypress: false
+
+      - name: Output debug info
+        env:
+          TEST_BADGE_LINK: '${{ needs.extract-bug-badge-url.outputs.link }}'
+        run: npm run badge $TEST_BADGE_LINK
+
+      - name: Add Comment to Issue
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const issueNumber = context.issue.number;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const runId = context.runId;
+            const jobUrl = `https://github.com/${owner}/${repo}/actions/runs/${runId}`;
+            const issueComment = `
+              Badge tested using \`npm run badge ${{ needs.extract-bug-badge-url.outputs.link }}\`
+              Output is available [here](${jobUrl})
+            `;
+            github.rest.issues.createComment({
+              issue_number: issueNumber,
+              owner: owner,
+              repo: repo,
+              body: issueComment
+            });

.github/workflows/test-e2e.yml

@@ -1,7 +1,7 @@
 name: E2E
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Cache Cypress binary
         id: cache-cypress
@@ -26,16 +26,13 @@ jobs:
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
           cypress: true
 
-      - name: Frontend build
-        run: GATSBY_BASE_URL=http://localhost:8080 npm run build
-
       - name: Run tests
         env:
           GH_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-        run: npm run e2e-on-build
+        run: npm run e2e
 
       - name: Archive videos
         if: always()

.github/workflows/test-frontend.yml

@@ -1,26 +0,0 @@
-name: Frontend
-on:
-  pull_request:
-    types: [opened, edited, reopened, synchronize]
-  push:
-    branches-ignore:
-      - 'gh-pages'
-      - 'dependabot/**'
-
-jobs:
-  test-frontend:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          node-version: 16
-
-      - name: Frontend tests
-        uses: ./.github/actions/frontend-tests
-
-      - name: Frontend build
-        run: npm run build

.github/workflows/test-integration-20.yml

@@ -1,37 +1,41 @@
-name: Integration@node 17
+name: Integration@node 20
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
       - 'dependabot/**'
 
 jobs:
-  test-integration-17:
+  test-integration-20:
     runs-on: ubuntu-latest
     env:
       PAT_EXISTS: ${{ secrets.GH_PAT != '' }}
 
     services:
-      redis:
-        image: redis
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: ci_test
         options: >-
-          --health-cmd "redis-cli ping"
+          --health-cmd pg_isready
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
         ports:
-          - 6379:6379
+          - 5432:5432
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 17
+          node-version: 20
         env:
           NPM_CONFIG_ENGINE_STRICT: 'false'
 

.github/workflows/test-integration.yml

@@ -1,7 +1,7 @@
 name: Integration
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
@@ -14,24 +14,28 @@ jobs:
       PAT_EXISTS: ${{ secrets.GH_PAT != '' }}
 
     services:
-      redis:
-        image: redis
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: ci_test
         options: >-
-          --health-cmd "redis-cli ping"
+          --health-cmd pg_isready
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
         ports:
-          - 6379:6379
+          - 5432:5432
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Integration Tests (with PAT)
         if: ${{ env.PAT_EXISTS == 'true' }}

.github/workflows/test-lint.yml

@@ -1,7 +1,7 @@
 name: Lint
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
@@ -12,12 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
 
       - name: ESLint
         if: always()

.github/workflows/test-main-20.yml

@@ -1,23 +1,23 @@
-name: Main@node 17
+name: Main@node 20
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
       - 'dependabot/**'
 
 jobs:
-  test-main-17:
+  test-main-20:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 17
+          node-version: 20
         env:
           NPM_CONFIG_ENGINE_STRICT: 'false'
 

.github/workflows/test-main.yml

@@ -1,7 +1,7 @@
 name: Main
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
@@ -17,12 +17,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Core tests
         uses: ./.github/actions/core-tests

.github/workflows/test-package-cli.yml

@@ -1,7 +1,7 @@
 name: Package CLI
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
@@ -16,25 +16,19 @@ jobs:
     strategy:
       matrix:
         include:
-          - node: '14'
-            engine-strict: 'false'
           - node: '16'
-            engine-strict: 'false'
           - node: '18'
-            engine-strict: 'true'
+          - node: '20'
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Node JS ${{ inputs.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 
       - name: Install dependencies
-        env:
-          CYPRESS_INSTALL_BINARY: 0
-          NPM_CONFIG_ENGINE_STRICT: ${{ matrix.engine-strict }}
         run: |
           cd badge-maker
           npm install

.github/workflows/test-package-lib.yml

@@ -1,7 +1,7 @@
 name: Package Library
 on:
   pull_request:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, reopened, synchronize]
   push:
     branches-ignore:
       - 'gh-pages'
@@ -13,15 +13,15 @@ jobs:
     strategy:
       matrix:
         include:
-          - node: '14'
-            engine-strict: 'false'
           - node: '16'
-            engine-strict: 'true'
+            engine-strict: 'false'
           - node: '18'
+            engine-strict: 'true'
+          - node: '20'
             engine-strict: 'false'
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup

.github/workflows/test-services-20.yml

@@ -1,20 +1,23 @@
-name: Services@node 17
+name: Services@node 20
 on:
   pull_request:
     types: [opened, edited, reopened, synchronize]
+  push:
+    branches:
+      - 'gh-readonly-queue/**'
 
 jobs:
-  test-services-17:
+  test-services-20:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 17
+          node-version: 20
         env:
           NPM_CONFIG_ENGINE_STRICT: 'false'
 

.github/workflows/test-services.yml

@@ -2,6 +2,9 @@ name: Services
 on:
   pull_request:
     types: [opened, edited, reopened, synchronize]
+  push:
+    branches:
+      - 'gh-readonly-queue/**'
 
 jobs:
   test-services:
@@ -9,12 +12,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Service tests (triggered from local branch)
         if: github.event.pull_request.head.repo.full_name == github.repository

.github/workflows/update-github-api.yml

@@ -14,18 +14,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Check for new GitHub API version
         run: node scripts/update-github-api.js
 
       - name: Create Pull Request if config has changed
-        uses: peter-evans/create-pull-request@v4
+        uses: peter-evans/create-pull-request@v5
         with:
           token: '${{ secrets.GITHUB_TOKEN }}'
           commit-message: Update GitHub API Version

.gitignore

@@ -92,10 +92,7 @@ typings/
 
 # Temporary build artifacts.
 /build
-.next
-badge-examples.json
-supported-features.json
-service-definitions.yml
+frontend/categories/*.yaml
 
 # Local runtime configuration.
 /config/local*.yml
@@ -103,11 +100,6 @@ service-definitions.yml
 # Template for the local runtime configuration.
 !/config/local*.template.yml
 
-# Gatsby
-/frontend/.cache
-/frontend/public
-/public
-
 # Cypress
 /cypress/videos/
 /cypress/screenshots/
@@ -117,3 +109,11 @@ service-definitions.yml
 
 # Flamebearer
 flamegraph.html
+
+# config file for node-pg-migrate
+migrations-config.json
+
+# Frontend/Docusaurus
+frontend/.docusaurus
+frontend/.cache-loader
+/public

.mocharc-frontend.yml

@@ -1,5 +0,0 @@
-reporter: mocha-env-reporter
-require:
-  - '@babel/polyfill'
-  - '@babel/register'
-  - mocha-yaml-loader

.nycrc-frontend.json

@@ -1,10 +0,0 @@
-{
-  "reporter": ["lcov"],
-  "all": false,
-  "silent": true,
-  "clean": false,
-  "sourceMap": false,
-  "instrument": false,
-  "include": ["frontend/**/*.js"],
-  "exclude": ["**/*.spec.js", "**/mocha-*.js"]
-}

.prettierignore

@@ -10,5 +10,5 @@ public
 private/*.json
 /.nyc_output
 analytics.json
-supported-features.json
-service-definitions.yml
+frontend/.docusaurus
+frontend/categories

CHANGELOG.md

@@ -4,6 +4,131 @@ Note: this changelog is for the shields.io server. The changelog for the badge-m
 
 ---
 
+## server-2023-11-01
+
+- fix greasyfork 404 bug [#9632](https://github.com/badges/shields/issues/9632)
+- Hacktoberfest 2023 support - resolves #9636 [#9637](https://github.com/badges/shields/issues/9637)
+- switch to fixed OpenCollective images [#9615](https://github.com/badges/shields/issues/9615)
+- Dependency updates
+
+## server-2023-10-02
+
+- add python package total downloads from [pepy] badge [#9564](https://github.com/badges/shields/issues/9564)
+- deprecate [redmine] plugin rating badges [#9568](https://github.com/badges/shields/issues/9568)
+- fix [bower] version badge [#9567](https://github.com/badges/shields/issues/9567)
+- Add [PythonVersionFromToml] shield [#9516](https://github.com/badges/shields/issues/9516)
+- Add [dub] score badge service [#9549](https://github.com/badges/shields/issues/9549)
+- Dependency updates
+
+## server-2023-09-04
+
+- Fix [testspace] badges [#9525](https://github.com/badges/shields/issues/9525)
+- fix rSt code example [#9528](https://github.com/badges/shields/issues/9528)
+- Add dynamic TOML support via [DynamicToml] Service [#9517](https://github.com/badges/shields/issues/9517)
+- cache [pypi] downloads for longer [#9522](https://github.com/badges/shields/issues/9522)
+- [twitter] --> x [#9496](https://github.com/badges/shields/issues/9496)
+- [bundlejs] add badge for the npm package size [#9055](https://github.com/badges/shields/issues/9055)
+- Switch [OpenCollective] badges to use GraphQL and auth [#9387](https://github.com/badges/shields/issues/9387)
+- [Pulsar] Add Pulsar Badges for Stargazers & Downloads [#8767](https://github.com/badges/shields/issues/8767)
+- Add [CurseForge] badges [#9252](https://github.com/badges/shields/issues/9252)
+- deploy on node 18 [#9385](https://github.com/badges/shields/issues/9385)
+- allow calling [github] without auth [#9427](https://github.com/badges/shields/issues/9427)
+- Dependency updates
+
+## server-2023-08-01
+
+- Convert `examples` arrays to `openApi` objects (part 1) [#9320](https://github.com/badges/shields/issues/9320)
+- Migrate from docs.rs' builds API to status API [#9422](https://github.com/badges/shields/issues/9422)
+- [OpenVSX] Fix OpenVSX API call for unversioned package URLs [#9408](https://github.com/badges/shields/issues/9408)
+- Add support for [Lemmy] [#9368](https://github.com/badges/shields/issues/9368)
+- upgrade to npm 9 [#9323](https://github.com/badges/shields/issues/9323)
+- Go back to default YouTube cache [#9372](https://github.com/badges/shields/issues/9372)
+- Add [GitHubDiscussionsSearch] and GitHubRepoDiscussionsSearch service [#9340](https://github.com/badges/shields/issues/9340)
+- Allow user to filter github tags and releases [#9193](https://github.com/badges/shields/issues/9193)
+- don't URL encode slash in [githubactionsworkflow] badge [#9322](https://github.com/badges/shields/issues/9322)
+- add a bit of border to select boxes [#9348](https://github.com/badges/shields/issues/9348)
+- deprecate [snyk] badges [#9349](https://github.com/badges/shields/issues/9349)
+- increase max-age on [docker] badges, again [#9350](https://github.com/badges/shields/issues/9350) [#9369](https://github.com/badges/shields/issues/9369)
+- Dependency updates
+
+## server-2023-07-02
+
+By far the most significant change in this release is the long-awaited launch of the re-designed frontend:
+
+- migrate frontend to docusaurus [#9014](https://github.com/badges/shields/issues/9014)
+- fix a load of spacing issues in frontend content [#9281](https://github.com/badges/shields/issues/9281)
+- set a sensible meta description [#9283](https://github.com/badges/shields/issues/9283)
+- chore(frontend): open homepage feature links in new tab [#9300](https://github.com/badges/shields/issues/9300)
+- adapt opencollective images to theme background [#9298](https://github.com/badges/shields/issues/9298)
+- temp fix: wrap code examples tabs in narrow browser windows [#9302](https://github.com/badges/shields/issues/9302)
+- add a bit of border to text boxes [#9324](https://github.com/badges/shields/issues/9324)
+
+Other changes in this release:
+
+- cache [dockerpulls] badges for an hour [#9343](https://github.com/badges/shields/issues/9343)
+- Mention YouTube API services and link to Google Privacy Policy [#9339](https://github.com/badges/shields/issues/9339)
+- allow negative timestamps in relative [date] badge [#9321](https://github.com/badges/shields/issues/9321)
+- upgrade to graphql 16 [#9290](https://github.com/badges/shields/issues/9290)
+- remove obsolete travis .org examples [#9284](https://github.com/badges/shields/issues/9284)
+- increase max age on reddit badges [#9282](https://github.com/badges/shields/issues/9282)
+- feat: Add author filter option for [GithubCommitActivity] [#9251](https://github.com/badges/shields/issues/9251)
+- Fix: [GithubCommitActivity] invalid branch error handling [#9258](https://github.com/badges/shields/issues/9258)
+- Implement a pattern for dealing with upstream APIs which are slow on the first hit; affects [endpoint] [#9233](https://github.com/badges/shields/issues/9233)
+- Delete old deprecated services [#9254](https://github.com/badges/shields/issues/9254)
+- feat: add 'canceled' status to netlify deploy badge [#9240](https://github.com/badges/shields/issues/9240)
+- increase default cache on youtube badges [#9238](https://github.com/badges/shields/issues/9238)
+- embiggen youtube cache, again [#9250](https://github.com/badges/shields/issues/9250)
+- Dependency updates
+
+## server-2023-06-01
+
+- feat: Add total commits to [GitHubCommitActivity] [#9196](https://github.com/badges/shields/issues/9196)
+- set a custom error on 429 [#9159](https://github.com/badges/shields/issues/9159)
+- deprecate [travis].org badges [#9171](https://github.com/badges/shields/issues/9171)
+- count private sponsors on [GithubSponsors] badge [#9170](https://github.com/badges/shields/issues/9170)
+- Dependency updates
+
+## server-2023-05-01
+
+** Removal:** For users who need to maintain a Github Token pool, storage has been provided via the `RedisTokenPersistence` and `REDIS_URL` settings. This feature was deprecated in `server-2023-03-01`. As of this release, the `RedisTokenPersistence` backend is now removed. If you are using this feature, you will need to migrate to using the `SQLTokenPersistence` backend for storage and provide a postgres connection string via the `POSTGRES_URL` setting. [#8922](https://github.com/badges/shields/issues/8922)
+
+- fail to start server if there are duplicate service names [#9099](https://github.com/badges/shields/issues/9099)
+- [SourceForge] Added badges for SourceForge [#9078](https://github.com/badges/shields/issues/9078) [#9102](https://github.com/badges/shields/issues/9102)
+- crates: Use `?include=` to reduce crates.io backend load [#9081](https://github.com/badges/shields/issues/9081)
+- Dependency updates
+
+## server-2023-04-02
+
+- [JenkinsCoverage] Update Jenkins Code Coverage API for new plugin version [#9010](https://github.com/badges/shields/issues/9010)
+- [CTAN] fallback to date if version is empty [#9036](https://github.com/badges/shields/issues/9036)
+- Update to [CTAN] API version 2.0 [#9016](https://github.com/badges/shields/issues/9016)
+- handle missing statistics array in [VisualStudioMarketplace] badges [#8985](https://github.com/badges/shields/issues/8985)
+- [Netlify] upgrade colors for SVG parsing [#8971](https://github.com/badges/shields/issues/8971)
+- Fix [Vcpkg] version service for different version fields [#8945](https://github.com/badges/shields/issues/8945)
+- only try to close pool if one exists [#8947](https://github.com/badges/shields/issues/8947)
+- misc minor fixes to [githubsize node pypi] [#8946](https://github.com/badges/shields/issues/8946)
+- Dependency updates
+
+## server-2023-03-01
+
+**Deprecation:** For users who need to maintain a Github Token pool, storage has been provided via the `RedisTokenPersistence` and `REDIS_URL` settings. As of this release, the `RedisTokenPersistence` backend is now deprecated and will be removed in a future release. If you are using this feature, you will need to migrate to using the `SQLTokenPersistence` backend for storage and provide a postgres connection string via the `POSTGRES_URL` setting. [#8922](https://github.com/badges/shields/issues/8922)
+
+- fix: for crates.io versions, use max_stable_version if it exists [#8687](https://github.com/badges/shields/issues/8687)
+- don't autofocus search [#8927](https://github.com/badges/shields/issues/8927)
+- Add [Vcpkg] version service [#8923](https://github.com/badges/shields/issues/8923)
+- fix: Set uid/gid in docker image to 0 [#8908](https://github.com/badges/shields/issues/8908)
+- expose port 443 in Dockerfile [#8889](https://github.com/badges/shields/issues/8889)
+- Dependency updates
+
+## server-2023-02-01
+
+- replace [twitter] badge with static fallback [#8842](https://github.com/badges/shields/issues/8842)
+- Add various [Polymart] badges [#8811](https://github.com/badges/shields/issues/8811)
+- update [githubpipenv] tests/examples [#8797](https://github.com/badges/shields/issues/8797)
+- deprecate [apm] service [#8773](https://github.com/badges/shields/issues/8773)
+- deprecate lgtm [#8771](https://github.com/badges/shields/issues/8771)
+- Dependency updates
+
 ## server-2023-01-01
 
 - Breaking change: Routes for GitHub workflows badge have changed. See https://github.com/badges/shields/issues/8671 for more details

CONTRIBUTING.md

@@ -134,9 +134,19 @@ Prettier before a commit by default.
 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.
-Use `brew install redis`, `yum install redis`, etc. The test runner will
-start the server automatically.
+The integration tests are not run by default. For most contributions it is OK to skip these unless you're working directly on the code for storing the GitHub token pool in postgres.
+
+To run the integration tests:
+
+- You must have PostgreSQL installed. Use `brew install postgresql`, `apt-get install postgresql`, etc.
+- Set a connection string either with an env var `POSTGRES_URL=postgresql://user:pass@127.0.0.1:5432/db_name` or by using
+  ```yaml
+  private:
+    postgres_url: 'postgresql://user:pass@127.0.0.1:5432/db_name'
+  ```
+  in a yaml config file.
+- Run `npm run migrate up` to apply DB migrations
+- Run `npm run test:integration` to run the tests
 
 [service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine AS Builder
+FROM node:18-alpine AS Builder
 
 RUN mkdir -p /usr/src/app
 RUN mkdir /usr/src/app/private
@@ -9,17 +9,17 @@ COPY package.json package-lock.json /usr/src/app/
 COPY badge-maker /usr/src/app/badge-maker/
 
 RUN apk add python3 make g++
-RUN npm install -g "npm@>=8"
+RUN npm install -g "npm@^9.0.0"
 # We need dev deps to build the front end. We don't need Cypress, though.
 RUN NODE_ENV=development CYPRESS_INSTALL_BINARY=0 npm ci
 
 COPY . /usr/src/app
 RUN npm run build
-RUN npm prune --production
+RUN npm prune --omit=dev
 RUN npm cache clean --force
 
 # Use multi-stage build to reduce size
-FROM node:16-alpine
+FROM node:18-alpine
 
 ARG version=dev
 ENV DOCKER_SHIELDS_VERSION=$version
@@ -30,8 +30,8 @@ LABEL fly.version=$version
 ENV NODE_ENV production
 
 WORKDIR /usr/src/app
-COPY --from=Builder /usr/src/app /usr/src/app
+COPY --from=Builder --chown=0:0 /usr/src/app /usr/src/app
 
 CMD node server
 
-EXPOSE 80
+EXPOSE 80 443

README.md

@@ -23,7 +23,7 @@
         <img src="https://img.shields.io/discord/308323056592486420?logo=discord"
             alt="chat on Discord"></a>
     <a href="https://twitter.com/intent/follow?screen_name=shields_io">
-        <img src="https://img.shields.io/twitter/follow/shields_io?style=social&logo=twitter"
+        <img src="https://img.shields.io/twitter/follow/shields_io?style=social&logo=X"
             alt="follow on Twitter"></a>
 </p>
 
@@ -70,7 +70,7 @@ This repo hosts:
 [Make your own badges!][custom badges]
 (Quick example: `https://img.shields.io/badge/left-right-f39f37`)
 
-[custom badges]: https://shields.io/#your-badge
+[custom badges]: https://img.shields.io/badges/static-badge
 
 ### Quickstart
 
@@ -92,14 +92,17 @@ 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)
 
+If you intend on reporting or contributing a fix related to security vulnerabilities, please first refer to our [security policy][security].
+
 [service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
 [tutorial]: https://github.com/badges/shields/blob/master/doc/TUTORIAL.md
 [contributing]: https://github.com/badges/shields/blob/master/CONTRIBUTING.md
+[security]: https://github.com/badges/shields/blob/master/SECURITY.md
 
 ## Development
 
-1. Install Node 16 or later. You can use the [package manager][] of your choice.
-   Tests need to pass in Node 16 and 17.
+1. Install Node 18 or later. You can use the [package manager][] of your choice.
+   Tests need to pass in Node 18 and 20.
 2. Clone this repository.
 3. Run `npm ci` to install the dependencies.
 4. Run `npm start` to start the badge server and the frontend dev server.
@@ -107,7 +110,7 @@ You can read a [tutorial on how to add a badge][tutorial].
 
 When server source files change, the badge server should automatically restart
 itself (using [nodemon][]). When the frontend files change, the frontend dev
-server (`gatsby dev`) should also automatically reload. However the badge
+server (`docusaurus start`) should also automatically reload. However the badge
 definitions are built only before the server first starts. To regenerate those,
 either run `npm run defs` or manually restart the server.
 

badge-maker/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 4.0.0 [WIP]
 
-- Drop compatibility with Node < 14
+- Drop compatibility with Node < 16
 
 ## 3.3.1
 
@@ -275,7 +275,7 @@ badge.loadFont('/path/to/Verdana.ttf', err => {
     { text: ['build', 'passed'], colorscheme: 'green', template: 'flat' },
     (svg, err) => {
       // svg is a string containing your badge
-    }
+    },
   )
 })
 ```

badge-maker/index.test-d.ts

@@ -7,19 +7,19 @@ expectError(
   makeBadge({
     message: 'passed',
     style: 'invalid style',
-  })
+  }),
 )
 
 expectType<string>(
   makeBadge({
     message: 'passed',
-  })
+  }),
 )
 expectType<string>(
   makeBadge({
     label: 'build',
     message: 'passed',
-  })
+  }),
 )
 expectType<string>(
   makeBadge({
@@ -28,7 +28,7 @@ expectType<string>(
     labelColor: 'green',
     color: 'red',
     style: 'flat',
-  })
+  }),
 )
 
 const error = new ValidationError()

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

@@ -1,7 +1,6 @@
 'use strict'
 
 const path = require('path')
-const isSvg = require('is-svg')
 const { spawn } = require('child-process-promise')
 const { expect, use } = require('chai')
 use(require('chai-string'))
@@ -20,6 +19,7 @@ describe('The CLI', function () {
   })
 
   it('should produce default badges', async function () {
+    const { default: isSvg } = await import('is-svg')
     const { stdout } = await runCli(['cactus', 'grown'])
     expect(stdout)
       .to.satisfy(isSvg)
@@ -28,11 +28,13 @@ describe('The CLI', function () {
   })
 
   it('should produce colorschemed badges', async function () {
+    const { default: isSvg } = await import('is-svg')
     const { stdout } = await runCli(['cactus', 'grown', ':green'])
     expect(stdout).to.satisfy(isSvg)
   })
 
   it('should produce right-color badges', async function () {
+    const { default: isSvg } = await import('is-svg')
     const { stdout } = await runCli(['cactus', 'grown', '#abcdef'])
     expect(stdout).to.satisfy(isSvg).and.to.include('#abcdef')
   })

badge-maker/lib/badge-renderers.js

@@ -69,7 +69,7 @@ function getLogoElement({ logo, horizPadding, badgeHeight, logoWidth }) {
 
 function renderBadge(
   { links, leftWidth, rightWidth, height, accessibleText },
-  content
+  content,
 ) {
   const width = leftWidth + rightWidth
   const leftLink = links[0]
@@ -397,7 +397,7 @@ class Plastic extends Badge {
         accessibleText: this.accessibleText,
         height: this.constructor.height,
       },
-      [gradient, clipPath, backgroundGroup, this.foregroundGroupElement]
+      [gradient, clipPath, backgroundGroup, this.foregroundGroupElement],
     )
   }
 }
@@ -446,7 +446,7 @@ class Flat extends Badge {
         accessibleText: this.accessibleText,
         height: this.constructor.height,
       },
-      [gradient, clipPath, backgroundGroup, this.foregroundGroupElement]
+      [gradient, clipPath, backgroundGroup, this.foregroundGroupElement],
     )
   }
 }
@@ -478,7 +478,7 @@ class FlatSquare extends Badge {
         accessibleText: this.accessibleText,
         height: this.constructor.height,
       },
-      [backgroundGroup, this.foregroundGroupElement]
+      [backgroundGroup, this.foregroundGroupElement],
     )
   }
 }
@@ -748,7 +748,7 @@ function social({
       accessibleText,
       height: externalHeight,
     },
-    [style, gradients, backgroundGroup, logoElement, foregroundGroup]
+    [style, gradients, backgroundGroup, logoElement, foregroundGroup],
   )
 }
 
@@ -978,7 +978,7 @@ function forTheBadge({
       accessibleText: createAccessibleText({ label, message }),
       height: BADGE_HEIGHT,
     },
-    [backgroundGroup, foregroundGroup]
+    [backgroundGroup, foregroundGroup],
   )
 }
 

badge-maker/lib/color.spec.js

@@ -75,7 +75,7 @@ test(toSvgColor, () => {
   given('papayawhip').expect('papayawhip')
   given('purple').expect('purple')
   forCases([given(''), given(undefined), given('not-a-color')]).expect(
-    undefined
+    undefined,
   )
   given('lightgray').expect('#9f9f9f')
   given('informational').expect('#007ec6')

badge-maker/lib/index.js

@@ -32,7 +32,7 @@ function _validate(format) {
   ]
   if ('style' in format && !styleValues.includes(format.style)) {
     throw new ValidationError(
-      `Field \`style\` must be one of (${styleValues.toString()})`
+      `Field \`style\` must be one of (${styleValues.toString()})`,
     )
   }
 }
@@ -46,7 +46,7 @@ function _clean(format) {
       cleaned[key] = format[key]
     } else {
       throw new ValidationError(
-        `Unexpected field '${key}'. Allowed values are (${expectedKeys.toString()})`
+        `Unexpected field '${key}'. Allowed values are (${expectedKeys.toString()})`,
       )
     }
   })

badge-maker/lib/index.spec.js

@@ -1,21 +1,21 @@
 'use strict'
 
 const { expect } = require('chai')
-const isSvg = require('is-svg')
 const { makeBadge, ValidationError } = require('.')
 
 describe('makeBadge function', function () {
-  it('should produce badge with valid input', function () {
+  it('should produce badge with valid input', async function () {
+    const { default: isSvg } = await import('is-svg')
     expect(
       makeBadge({
         label: 'build',
         message: 'passed',
-      })
+      }),
     ).to.satisfy(isSvg)
     expect(
       makeBadge({
         message: 'passed',
-      })
+      }),
     ).to.satisfy(isSvg)
     expect(
       makeBadge({
@@ -23,7 +23,7 @@ describe('makeBadge function', function () {
         message: 'passed',
         color: 'green',
         style: 'flat',
-      })
+      }),
     ).to.satisfy(isSvg)
   })
 
@@ -32,44 +32,44 @@ describe('makeBadge function', function () {
       console.log(x)
       expect(() => makeBadge(x)).to.throw(
         ValidationError,
-        'makeBadge takes an argument of type object'
+        'makeBadge takes an argument of type object',
       )
     })
     expect(() => makeBadge({})).to.throw(
       ValidationError,
-      'Field `message` is required'
+      'Field `message` is required',
     )
     expect(() => makeBadge({ label: 'build' })).to.throw(
       ValidationError,
-      'Field `message` is required'
+      'Field `message` is required',
     )
     expect(() =>
-      makeBadge({ label: 'build', message: 'passed', labelColor: 7 })
+      makeBadge({ label: 'build', message: 'passed', labelColor: 7 }),
     ).to.throw(ValidationError, 'Field `labelColor` must be of type string')
     expect(() =>
-      makeBadge({ label: 'build', message: 'passed', format: 'png' })
+      makeBadge({ label: 'build', message: 'passed', format: 'png' }),
     ).to.throw(ValidationError, "Unexpected field 'format'")
     expect(() =>
-      makeBadge({ label: 'build', message: 'passed', template: 'flat' })
+      makeBadge({ label: 'build', message: 'passed', template: 'flat' }),
     ).to.throw(ValidationError, "Unexpected field 'template'")
     expect(() =>
-      makeBadge({ label: 'build', message: 'passed', foo: 'bar' })
+      makeBadge({ label: 'build', message: 'passed', foo: 'bar' }),
     ).to.throw(ValidationError, "Unexpected field 'foo'")
     expect(() =>
       makeBadge({
         label: 'build',
         message: 'passed',
         style: 'something else',
-      })
+      }),
     ).to.throw(
       ValidationError,
-      'Field `style` must be one of (plastic,flat,flat-square,for-the-badge,social)'
+      'Field `style` must be one of (plastic,flat,flat-square,for-the-badge,social)',
     )
     expect(() =>
-      makeBadge({ label: 'build', message: 'passed', style: 'popout' })
+      makeBadge({ label: 'build', message: 'passed', style: 'popout' }),
     ).to.throw(
       ValidationError,
-      'Field `style` must be one of (plastic,flat,flat-square,for-the-badge,social)'
+      'Field `style` must be one of (plastic,flat,flat-square,for-the-badge,social)',
     )
   })
 })

badge-maker/lib/make-badge.js

@@ -58,6 +58,6 @@ module.exports = function makeBadge({
       logoPadding: logo && label.length ? 3 : 0,
       color: toSvgColor(color),
       labelColor: toSvgColor(labelColor),
-    })
+    }),
   )
 }

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

@@ -3,12 +3,11 @@
 const { test, given, forCases } = require('sazerac')
 const { expect } = require('chai')
 const snapshot = require('snap-shot-it')
-const isSvg = require('is-svg')
 const prettier = require('prettier')
 const makeBadge = require('./make-badge')
 
-function expectBadgeToMatchSnapshot(format) {
-  snapshot(prettier.format(makeBadge(format), { parser: 'html' }))
+async function expectBadgeToMatchSnapshot(format) {
+  snapshot(await prettier.format(makeBadge(format), { parser: 'html' }))
 }
 
 function testColor(color = '', colorAttr = 'color') {
@@ -18,7 +17,7 @@ function testColor(color = '', colorAttr = 'color') {
       message: 'Bob',
       [colorAttr]: color,
       format: 'json',
-    })
+    }),
   ).color
 }
 
@@ -68,7 +67,7 @@ describe('The badge generator', function () {
         given('bluish'),
         given('almostred'),
         given('brightmaroon'),
-        given('cactus')
+        given('cactus'),
       ).expect(undefined)
     })
   })
@@ -80,15 +79,16 @@ describe('The badge generator', function () {
   })
 
   describe('SVG', function () {
-    it('should produce SVG', function () {
+    it('should produce SVG', async function () {
+      const { default: isSvg } = await import('is-svg')
       expect(makeBadge({ label: 'cactus', message: 'grown', format: 'svg' }))
         .to.satisfy(isSvg)
         .and.to.include('cactus')
         .and.to.include('grown')
     })
 
-    it('should match snapshot', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshot', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -113,7 +113,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should replace undefined svg badge style with "flat"', function () {
+    it('should replace undefined svg badge style with "flat"', async function () {
+      const { default: isSvg } = await import('is-svg')
       const jsonBadgeWithUnknownStyle = makeBadge({
         label: 'name',
         message: 'Bob',
@@ -137,14 +138,14 @@ describe('The badge generator', function () {
           message: 'Bob',
           format: 'svg',
           style: 'unknown_style',
-        })
+        }),
       ).to.throw(Error, "Unknown badge style: 'unknown_style'")
     })
   })
 
   describe('"flat" template badge generation', function () {
-    it('should match snapshots: message/label, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -154,8 +155,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -166,8 +167,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -176,8 +177,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -187,8 +188,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo and labelColor', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo and labelColor', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -199,8 +200,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with links', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with links', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -211,8 +212,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the label color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the label color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -222,8 +223,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the message color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the message color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -235,8 +236,8 @@ describe('The badge generator', function () {
   })
 
   describe('"flat-square" template badge generation', function () {
-    it('should match snapshots: message/label, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -246,8 +247,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -258,8 +259,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -268,8 +269,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -279,8 +280,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo and labelColor', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo and labelColor', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -291,8 +292,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with links', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with links', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -303,8 +304,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the label color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the label color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -314,8 +315,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the message color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the message color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -327,8 +328,8 @@ describe('The badge generator', function () {
   })
 
   describe('"plastic" template badge generation', function () {
-    it('should match snapshots: message/label, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -338,8 +339,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -350,8 +351,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -360,8 +361,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -371,8 +372,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo and labelColor', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo and labelColor', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -383,8 +384,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with links', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with links', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -395,8 +396,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the label color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the label color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -406,8 +407,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the message color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the message color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -427,7 +428,7 @@ describe('The badge generator', function () {
           message: 1999,
           format: 'svg',
           style: 'for-the-badge',
-        })
+        }),
       )
         .to.include('1998')
         .and.to.include('1999')
@@ -440,14 +441,14 @@ describe('The badge generator', function () {
           message: '1 string',
           format: 'svg',
           style: 'for-the-badge',
-        })
+        }),
       )
         .to.include('LABEL')
         .and.to.include('1 STRING')
     })
 
-    it('should match snapshots: message/label, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -457,8 +458,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -469,8 +470,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -479,8 +480,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -490,8 +491,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo and labelColor', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo and labelColor', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -502,8 +503,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with links', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with links', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -514,8 +515,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the label color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the label color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -525,8 +526,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: black text when the message color is light', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: black text when the message color is light', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -545,7 +546,7 @@ describe('The badge generator', function () {
           message: 'some-value',
           format: 'svg',
           style: 'social',
-        })
+        }),
       )
         .to.include('Some-key')
         .and.to.include('some-value')
@@ -559,14 +560,14 @@ describe('The badge generator', function () {
           message: 'some-value',
           format: 'json',
           style: 'social',
-        })
+        }),
       )
         .to.include('""')
         .and.to.include('some-value')
     })
 
-    it('should match snapshots: message/label, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -576,8 +577,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -588,8 +589,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, no logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, no logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -598,8 +599,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -609,8 +610,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message only, with logo and labelColor', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message only, with logo and labelColor', async function () {
+      await expectBadgeToMatchSnapshot({
         label: '',
         message: 'grown',
         format: 'svg',
@@ -621,8 +622,8 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should match snapshots: message/label, with links', function () {
-      expectBadgeToMatchSnapshot({
+    it('should match snapshots: message/label, with links', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'cactus',
         message: 'grown',
         format: 'svg',
@@ -635,8 +636,8 @@ describe('The badge generator', function () {
   })
 
   describe('badges with logos should always produce the same badge', function () {
-    it('badge with logo', function () {
-      expectBadgeToMatchSnapshot({
+    it('badge with logo', async function () {
+      await expectBadgeToMatchSnapshot({
         label: 'label',
         message: 'message',
         format: 'svg',

badge-maker/lib/xml.js

@@ -35,7 +35,7 @@ class XmlElement {
    *    Name of the XML tag
    * @param {Array.<string|module:badge-maker/lib/xml~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
+   *    string and XmlElement objects. If content is `[]` or omitted the
    *    element will be rendered as a self-closing element.
    * @param {object} [attrs.attrs={}]
    *    Object representing the tag's attributes as name/value pairs
@@ -66,7 +66,7 @@ class XmlElement {
         })
         .join(' ')
       return stripXmlWhitespace(
-        `<${this.name}${attrsStr}>${content}</${this.name}>`
+        `<${this.name}${attrsStr}>${content}</${this.name}>`,
       )
     }
     return stripXmlWhitespace(`<${this.name}${attrsStr}/>`)
@@ -88,7 +88,7 @@ class ElementList {
         typeof el.render === 'function'
           ? acc + el.render()
           : acc + escapeXml(el),
-      ''
+      '',
     )
   }
 }

badge-maker/package.json

@@ -26,8 +26,7 @@
     "badge": "lib/badge-cli.js"
   },
   "engines": {
-    "node": ">= 14",
-    "npm": ">= 6"
+    "node": ">=16"
   },
   "collective": {
     "type": "opencollective",

config/custom-environment-variables.yml

@@ -77,6 +77,7 @@ private:
   bitbucket_password: 'BITBUCKET_PASS'
   bitbucket_server_username: 'BITBUCKET_SERVER_USER'
   bitbucket_server_password: 'BITBUCKET_SERVER_PASS'
+  curseforge_api_key: 'CURSEFORGE_API_KEY'
   discord_bot_token: 'DISCORD_BOT_TOKEN'
   drone_token: 'DRONE_TOKEN'
   gh_client_id: 'GH_CLIENT_ID'
@@ -94,6 +95,8 @@ private:
   obs_user: 'OBS_USER'
   obs_pass: 'OBS_PASS'
   redis_url: 'REDIS_URL'
+  opencollective_token: 'OPENCOLLECTIVE_TOKEN'
+  postgres_url: 'POSTGRES_URL'
   sentry_dsn: 'SENTRY_DSN'
   sl_insight_userUuid: 'SL_INSIGHT_USER_UUID'
   sl_insight_apiToken: 'SL_INSIGHT_API_TOKEN'

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

@@ -1,10 +1,10 @@
 private:
   # These are the keys which are set on the production servers.
+  curseforge_api_key: ...
   discord_bot_token: ...
   gh_client_id: ...
   gh_client_secret: ...
   gitlab_token: ...
-  redis_url: ...
   sentry_dsn: ...
   shields_secret: ...
   sl_insight_userUuid: ...

config/local.template.yml

@@ -4,6 +4,7 @@ private:
   # The possible values are documented in `doc/server-secrets.md`. Note that
   # you can also set these values through environment variables, which may be
   # preferable for self hosting.
+  curseforge_api_key: '...'
   gh_token: '...'
   gitlab_token: '...'
   obs_user: '...'

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

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

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

@@ -1,119 +1,5 @@
 // Avoid "Attempted import error: 'URL' is not exported from 'url'" in frontend.
 import url from 'url'
-import queryString from 'query-string'
-
-function badgeUrlFromPath({
-  baseUrl = '',
-  path,
-  queryParams,
-  style,
-  format = '',
-  longCache = false,
-}) {
-  const outExt = format.length ? `.${format}` : ''
-
-  const outQueryString = queryString.stringify({
-    cacheSeconds: longCache ? '2592000' : undefined,
-    style,
-    ...queryParams,
-  })
-  const suffix = outQueryString ? `?${outQueryString}` : ''
-
-  return `${baseUrl}${path}${outExt}${suffix}`
-}
-
-function encodeField(s) {
-  return encodeURIComponent(s.replace(/-/g, '--').replace(/_/g, '__'))
-}
-
-function staticBadgeUrl({
-  baseUrl = '',
-  label,
-  message,
-  labelColor,
-  color = 'lightgray',
-  style,
-  namedLogo,
-  format = '',
-  links = [],
-}) {
-  const path = [label, message, color].map(encodeField).join('-')
-  const outQueryString = queryString.stringify({
-    labelColor,
-    style,
-    logo: namedLogo,
-    link: links,
-  })
-  const outExt = format.length ? `.${format}` : ''
-  const suffix = outQueryString ? `?${outQueryString}` : ''
-  return `${baseUrl}/badge/${path}${outExt}${suffix}`
-}
-
-function queryStringStaticBadgeUrl({
-  baseUrl = '',
-  label,
-  message,
-  color,
-  labelColor,
-  style,
-  namedLogo,
-  logoColor,
-  logoWidth,
-  logoPosition,
-  format = '',
-}) {
-  // schemaVersion could be a parameter if we iterate on it,
-  // for now it's hardcoded to the only supported version.
-  const schemaVersion = '1'
-  const suffix = `?${queryString.stringify({
-    label,
-    message,
-    color,
-    labelColor,
-    style,
-    logo: namedLogo,
-    logoColor,
-    logoWidth,
-    logoPosition,
-  })}`
-  const outExt = format.length ? `.${format}` : ''
-  return `${baseUrl}/static/v${schemaVersion}${outExt}${suffix}`
-}
-
-function dynamicBadgeUrl({
-  baseUrl,
-  datatype,
-  label,
-  dataUrl,
-  query,
-  prefix,
-  suffix,
-  color,
-  style,
-  format = '',
-}) {
-  const outExt = format.length ? `.${format}` : ''
-
-  const queryParams = {
-    label,
-    url: dataUrl,
-    query,
-    style,
-  }
-
-  if (color) {
-    queryParams.color = color
-  }
-  if (prefix) {
-    queryParams.prefix = prefix
-  }
-  if (suffix) {
-    queryParams.suffix = suffix
-  }
-
-  const outQueryString = queryString.stringify(queryParams)
-  return `${baseUrl}/badge/dynamic/${datatype}${outExt}?${outQueryString}`
-}
 
 function rasterRedirectUrl({ rasterUrl }, badgeUrl) {
   // Ensure we're always using the `rasterUrl` by using just the path from
@@ -124,11 +10,4 @@ function rasterRedirectUrl({ rasterUrl }, badgeUrl) {
   return result
 }
 
-export {
-  badgeUrlFromPath,
-  encodeField,
-  staticBadgeUrl,
-  queryStringStaticBadgeUrl,
-  dynamicBadgeUrl,
-  rasterRedirectUrl,
-}
+export { rasterRedirectUrl }

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

@@ -1,142 +0,0 @@
-import { test, given } from 'sazerac'
-import {
-  badgeUrlFromPath,
-  encodeField,
-  staticBadgeUrl,
-  queryStringStaticBadgeUrl,
-  dynamicBadgeUrl,
-} from './make-badge-url.js'
-
-describe('Badge URL generation functions', function () {
-  test(badgeUrlFromPath, () => {
-    given({
-      baseUrl: 'http://example.com',
-      path: '/npm/v/gh-badges',
-      style: 'flat-square',
-      longCache: true,
-    }).expect(
-      'http://example.com/npm/v/gh-badges?cacheSeconds=2592000&style=flat-square'
-    )
-  })
-
-  test(encodeField, () => {
-    given('foo').expect('foo')
-    given('').expect('')
-    given('happy go lucky').expect('happy%20go%20lucky')
-    given('do-right').expect('do--right')
-    given('it_is_a_snake').expect('it__is__a__snake')
-  })
-
-  test(staticBadgeUrl, () => {
-    given({
-      label: 'foo',
-      message: 'bar',
-      color: 'blue',
-      style: 'flat-square',
-    }).expect('/badge/foo-bar-blue?style=flat-square')
-    given({
-      label: 'foo',
-      message: 'bar',
-      color: 'blue',
-      style: 'flat-square',
-      format: 'png',
-      namedLogo: 'github',
-    }).expect('/badge/foo-bar-blue.png?logo=github&style=flat-square')
-    given({
-      label: 'Hello World',
-      message: 'Привет Мир',
-      color: '#aabbcc',
-    }).expect(
-      '/badge/Hello%20World-%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80-%23aabbcc'
-    )
-    given({
-      label: '123-123',
-      message: 'abc-abc',
-      color: 'blue',
-    }).expect('/badge/123--123-abc--abc-blue')
-    given({
-      label: '123-123',
-      message: '',
-      color: 'blue',
-      style: 'social',
-    }).expect('/badge/123--123--blue?style=social')
-    given({
-      label: '',
-      message: 'blue',
-      color: 'blue',
-    }).expect('/badge/-blue-blue')
-  })
-
-  test(queryStringStaticBadgeUrl, () => {
-    // the query-string library sorts parameters by name
-    given({
-      label: 'foo',
-      message: 'bar',
-      color: 'blue',
-      style: 'flat-square',
-    }).expect('/static/v1?color=blue&label=foo&message=bar&style=flat-square')
-    given({
-      label: 'foo Bar',
-      message: 'bar Baz',
-      color: 'blue',
-      style: 'flat-square',
-      format: 'png',
-      namedLogo: 'github',
-    }).expect(
-      '/static/v1.png?color=blue&label=foo%20Bar&logo=github&message=bar%20Baz&style=flat-square'
-    )
-    given({
-      label: 'Hello World',
-      message: 'Привет Мир',
-      color: '#aabbcc',
-    }).expect(
-      '/static/v1?color=%23aabbcc&label=Hello%20World&message=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80'
-    )
-  })
-
-  test(dynamicBadgeUrl, () => {
-    const dataUrl = 'http://example.com/foo.json'
-    const query = '$.bar'
-    const prefix = 'value: '
-    given({
-      baseUrl: 'http://img.example.com',
-      datatype: 'json',
-      label: 'foo',
-      dataUrl,
-      query,
-      prefix,
-      style: 'plastic',
-    }).expect(
-      [
-        'http://img.example.com/badge/dynamic/json',
-        '?label=foo',
-        `&prefix=${encodeURIComponent(prefix)}`,
-        `&query=${encodeURIComponent(query)}`,
-        '&style=plastic',
-        `&url=${encodeURIComponent(dataUrl)}`,
-      ].join('')
-    )
-    const suffix = '<- value'
-    const color = 'blue'
-    given({
-      baseUrl: 'http://img.example.com',
-      datatype: 'json',
-      label: 'foo',
-      dataUrl,
-      query,
-      suffix,
-      color,
-      style: 'plastic',
-    }).expect(
-      [
-        'http://img.example.com/badge/dynamic/json',
-        '?color=blue',
-        '&label=foo',
-        `&query=${encodeURIComponent(query)}`,
-        '&style=plastic',
-        `&suffix=${encodeURIComponent(suffix)}`,
-        `&url=${encodeURIComponent(dataUrl)}`,
-      ].join('')
-    )
-  })
-})

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

@@ -7,7 +7,7 @@ describe('Badge URL helper functions', function () {
     given('single trailing underscore_').expect('single trailing underscore ')
     given('__double leading underscores').expect('_double leading underscores')
     given('double trailing underscores__').expect(
-      'double trailing underscores_'
+      'double trailing underscores_',
     )
     given('treble___underscores').expect('treble_ underscores')
     given('fourfold____underscores').expect('fourfold__underscores')

core/base-service/auth-helper.js

@@ -11,7 +11,7 @@ class AuthHelper {
       isRequired = false,
       defaultToEmptyStringForUser = false,
     },
-    config
+    config,
   ) {
     if (!userKey && !passKey) {
       throw Error('Expected userKey or passKey to be set')
@@ -142,7 +142,7 @@ class AuthHelper {
 
   withBasicAuth(requestParams) {
     return this._withAnyAuth(requestParams, requestParams =>
-      this.constructor._mergeAuth(requestParams, this._basicAuth)
+      this.constructor._mergeAuth(requestParams, this._basicAuth),
     )
   }
 
@@ -153,6 +153,11 @@ class AuthHelper {
       : undefined
   }
 
+  _apiKeyHeader(apiKeyHeader) {
+    const { _pass: pass } = this
+    return this.isConfigured ? { [apiKeyHeader]: pass } : undefined
+  }
+
   static _mergeHeaders(requestParams, headers) {
     const {
       options: { headers: existingHeaders, ...restOptions } = {},
@@ -170,15 +175,21 @@ class AuthHelper {
     }
   }
 
+  withApiKeyHeader(requestParams, header = 'x-api-key') {
+    return this._withAnyAuth(requestParams, requestParams =>
+      this.constructor._mergeHeaders(requestParams, this._apiKeyHeader(header)),
+    )
+  }
+
   withBearerAuthHeader(
     requestParams,
-    bearerKey = 'Bearer' // lgtm [js/hardcoded-credentials]
+    bearerKey = 'Bearer', // lgtm [js/hardcoded-credentials]
   ) {
     return this._withAnyAuth(requestParams, requestParams =>
       this.constructor._mergeHeaders(
         requestParams,
-        this._bearerAuthHeader(bearerKey)
-      )
+        this._bearerAuthHeader(bearerKey),
+      ),
     )
   }
 
@@ -204,7 +215,7 @@ class AuthHelper {
       this.constructor._mergeQueryParams(requestParams, {
         ...(userKey ? { [userKey]: this._user } : undefined),
         ...(passKey ? { [passKey]: this._pass } : undefined),
-      })
+      }),
     )
   }
 }

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

@@ -8,12 +8,13 @@ describe('AuthHelper', function () {
     it('throws without userKey or passKey', function () {
       expect(() => new AuthHelper({}, {})).to.throw(
         Error,
-        'Expected userKey or passKey to be set'
+        'Expected userKey or passKey to be set',
       )
     })
     it('throws without serviceKey or authorizedOrigins', function () {
       expect(
-        () => new AuthHelper({ userKey: 'myci_user', passKey: 'myci_pass' }, {})
+        () =>
+          new AuthHelper({ userKey: 'myci_user', passKey: 'myci_pass' }, {}),
       ).to.throw(Error, 'Expected authorizedOrigins or serviceKey to be set')
     })
     it('throws when authorizedOrigins is not an array', function () {
@@ -25,8 +26,8 @@ describe('AuthHelper', function () {
               passKey: 'myci_pass',
               authorizedOrigins: true,
             },
-            { private: {} }
-          )
+            { private: {} },
+          ),
       ).to.throw(Error, 'Expected authorizedOrigins to be an array of origins')
     })
   })
@@ -35,7 +36,7 @@ describe('AuthHelper', function () {
     function validate(config, privateConfig) {
       return new AuthHelper(
         { authorizedOrigins: ['https://example.test'], ...config },
-        { private: privateConfig }
+        { private: privateConfig },
       ).isValid
     }
     test(validate, () => {
@@ -43,20 +44,20 @@ describe('AuthHelper', function () {
         // Fully configured user + pass.
         given(
           { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
-          { myci_user: 'admin', myci_pass: 'abc123' }
+          { myci_user: 'admin', myci_pass: 'abc123' },
         ),
         given(
           { userKey: 'myci_user', passKey: 'myci_pass' },
-          { myci_user: 'admin', myci_pass: 'abc123' }
+          { myci_user: 'admin', myci_pass: 'abc123' },
         ),
         // Fully configured user or pass.
         given(
           { userKey: 'myci_user', isRequired: true },
-          { myci_user: 'admin' }
+          { myci_user: 'admin' },
         ),
         given(
           { passKey: 'myci_pass', isRequired: true },
-          { myci_pass: 'abc123' }
+          { myci_pass: 'abc123' },
         ),
         given({ userKey: 'myci_user' }, { myci_user: 'admin' }),
         given({ passKey: 'myci_pass' }, { myci_pass: 'abc123' }),
@@ -70,16 +71,16 @@ describe('AuthHelper', function () {
         // Partly configured.
         given(
           { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
-          { myci_user: 'admin' }
+          { myci_user: 'admin' },
         ),
         given(
           { userKey: 'myci_user', passKey: 'myci_pass' },
-          { myci_user: 'admin' }
+          { myci_user: 'admin' },
         ),
         // Missing required config.
         given(
           { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
-          {}
+          {},
         ),
         given({ userKey: 'myci_user', isRequired: true }, {}),
         given({ passKey: 'myci_pass', isRequired: true }, {}),
@@ -91,18 +92,18 @@ describe('AuthHelper', function () {
     function validate(config, privateConfig) {
       return new AuthHelper(
         { authorizedOrigins: ['https://example.test'], ...config },
-        { private: privateConfig }
+        { private: privateConfig },
       )._basicAuth
     }
     test(validate, () => {
       forCases([
         given(
           { userKey: 'myci_user', passKey: 'myci_pass', isRequired: true },
-          { myci_user: 'admin', myci_pass: 'abc123' }
+          { myci_user: 'admin', myci_pass: 'abc123' },
         ),
         given(
           { userKey: 'myci_user', passKey: 'myci_pass' },
-          { myci_user: 'admin', myci_pass: 'abc123' }
+          { myci_user: 'admin', myci_pass: 'abc123' },
         ),
       ]).expect({ username: 'admin', password: 'abc123' })
       given({ userKey: 'myci_user' }, { myci_user: 'admin' }).expect({
@@ -114,11 +115,11 @@ describe('AuthHelper', function () {
         password: 'abc123',
       })
       given({ userKey: 'myci_user', passKey: 'myci_pass' }, {}).expect(
-        undefined
+        undefined,
       )
       given(
         { passKey: 'myci_pass', defaultToEmptyStringForUser: true },
-        { myci_pass: 'abc123' }
+        { myci_pass: 'abc123' },
       ).expect({
         username: '',
         password: 'abc123',
@@ -168,7 +169,7 @@ describe('AuthHelper', function () {
         expect(() =>
           authHelper.enforceStrictSsl({
             options: { https: { rejectUnauthorized: false } },
-          })
+          }),
         ).to.throw(InvalidParameter)
       })
     })
@@ -192,7 +193,7 @@ describe('AuthHelper', function () {
         expect(() =>
           authHelper.enforceStrictSsl({
             options: { https: { rejectUnauthorized: false } },
-          })
+          }),
         ).not.to.throw()
       })
     })
@@ -318,7 +319,7 @@ describe('AuthHelper', function () {
           },
         },
         private: { myci_user: 'admin', myci_pass: 'abc123' },
-      }
+      },
     )
     const withBasicAuth = requestOptions =>
       authHelper.withBasicAuth(requestOptions)
@@ -376,7 +377,7 @@ describe('AuthHelper', function () {
         withBasicAuth({
           url: 'https://myci.test/api',
           options: { https: { rejectUnauthorized: false } },
-        })
+        }),
       ).to.throw(InvalidParameter)
     })
   })

core/base-service/base-graphql.js

@@ -20,7 +20,7 @@ class BaseGraphqlService extends BaseService {
   /**
    * Parse data from JSON endpoint
    *
-   * @param {string} buffer JSON repsonse from upstream API
+   * @param {string} buffer JSON response from upstream API
    * @returns {object} Parsed response
    */
   _parseJson(buffer) {
@@ -44,8 +44,14 @@ class BaseGraphqlService extends BaseService {
    *    and custom error messages e.g: `{ 404: 'package not found' }`.
    *    This can be used to extend or override the
    *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
+   *    and an object of params to pass when we construct an Inaccessible exception object
+   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
+   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
+   *    for allowed keys
+   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
    * @param {Function} [attrs.transformJson=data => data] Function which takes the raw json and transforms it before
-   * further procesing. In case of multiple query in a single graphql call and few of them
+   * further processing. In case of multiple query in a single graphql call and few of them
    * throw error, partial data might be used ignoring the error.
    * @param {Function} [attrs.transformErrors=defaultTransformErrors]
    *    Function which takes an errors object from a GraphQL
@@ -62,6 +68,7 @@ class BaseGraphqlService extends BaseService {
     variables = {},
     options = {},
     httpErrorMessages = {},
+    systemErrors = {},
     transformJson = data => data,
     transformErrors = defaultTransformErrors,
   }) {
@@ -74,7 +81,8 @@ class BaseGraphqlService extends BaseService {
     const { buffer } = await this._request({
       url,
       options: mergedOptions,
-      errorMessages: httpErrorMessages,
+      httpErrors: httpErrorMessages,
+      systemErrors,
     })
     const json = transformJson(this._parseJson(buffer))
     if (json.errors) {
@@ -83,7 +91,7 @@ class BaseGraphqlService extends BaseService {
         throw exception
       } else {
         throw Error(
-          `transformErrors() must return a ShieldsRuntimeError; got ${exception}`
+          `transformErrors() must return a ShieldsRuntimeError; got ${exception}`,
         )
       }
     }

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

@@ -35,23 +35,23 @@ describe('BaseGraphqlService', function () {
         Promise.resolve({
           buffer: '{"some": "json"}',
           res: { statusCode: 200 },
-        })
+        }),
       )
     })
 
     it('invokes _requestFetcher', async function () {
       await DummyGraphqlService.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
         'http://example.com/graphql',
         {
-          body: '{"query":"{\\n  requiredString\\n}\\n","variables":{}}',
+          body: '{"query":"{\\n  requiredString\\n}","variables":{}}',
           headers: { Accept: 'application/json' },
           method: 'POST',
-        }
+        },
       )
     })
 
@@ -74,17 +74,17 @@ describe('BaseGraphqlService', function () {
 
       await WithOptions.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
         'http://example.com/graphql',
         {
-          body: '{"query":"{\\n  requiredString\\n}\\n","variables":{}}',
+          body: '{"query":"{\\n  requiredString\\n}","variables":{}}',
           headers: { Accept: 'application/json' },
           method: 'POST',
           searchParams: { queryParam: 123 },
-        }
+        },
       )
     })
   })
@@ -98,8 +98,8 @@ describe('BaseGraphqlService', function () {
       expect(
         await DummyGraphqlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: 'some-string',
       })
@@ -113,8 +113,8 @@ describe('BaseGraphqlService', function () {
       expect(
         await DummyGraphqlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -130,8 +130,8 @@ describe('BaseGraphqlService', function () {
       expect(
         await DummyGraphqlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -149,8 +149,8 @@ describe('BaseGraphqlService', function () {
       expect(
         await DummyGraphqlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -188,8 +188,8 @@ describe('BaseGraphqlService', function () {
       expect(
         await WithErrorHandler.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',

core/base-service/base-json.js

@@ -14,7 +14,7 @@ class BaseJsonService extends BaseService {
   /**
    * Parse data from JSON endpoint
    *
-   * @param {string} buffer JSON repsonse from upstream API
+   * @param {string} buffer JSON response from upstream API
    * @returns {object} Parsed response
    */
   _parseJson(buffer) {
@@ -30,14 +30,26 @@ class BaseJsonService extends BaseService {
    * @param {string} attrs.url URL to request
    * @param {object} [attrs.options={}] Options to pass to got. See
    *    [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md)
-   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   * @param {object} [attrs.httpErrors={}] Key-value map of status codes
    *    and custom error messages e.g: `{ 404: 'package not found' }`.
    *    This can be used to extend or override the
    *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
+   *    and an object of params to pass when we construct an Inaccessible exception object
+   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
+   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
+   *    for allowed keys
+   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
    * @returns {object} Parsed response
    * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md
    */
-  async _requestJson({ schema, url, options = {}, errorMessages = {} }) {
+  async _requestJson({
+    schema,
+    url,
+    options = {},
+    httpErrors = {},
+    systemErrors = {},
+  }) {
     const mergedOptions = {
       ...{ headers: { Accept: 'application/json' } },
       ...options,
@@ -45,7 +57,8 @@ class BaseJsonService extends BaseService {
     const { buffer } = await this._request({
       url,
       options: mergedOptions,
-      errorMessages,
+      httpErrors,
+      systemErrors,
     })
     const json = this._parseJson(buffer)
     return this.constructor._validate(json, schema)

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

@@ -28,21 +28,21 @@ describe('BaseJsonService', function () {
         Promise.resolve({
           buffer: '{"some": "json"}',
           res: { statusCode: 200 },
-        })
+        }),
       )
     })
 
     it('invokes _requestFetcher', async function () {
       await DummyJsonService.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
         'http://example.com/foo.json',
         {
           headers: { Accept: 'application/json' },
-        }
+        },
       )
     })
 
@@ -60,7 +60,7 @@ describe('BaseJsonService', function () {
 
       await WithOptions.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
@@ -69,7 +69,7 @@ describe('BaseJsonService', function () {
           headers: { Accept: 'application/json' },
           method: 'POST',
           searchParams: { queryParam: 123 },
-        }
+        },
       )
     })
   })
@@ -83,8 +83,8 @@ describe('BaseJsonService', function () {
       expect(
         await DummyJsonService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: 'some-string',
       })
@@ -98,8 +98,8 @@ describe('BaseJsonService', function () {
       expect(
         await DummyJsonService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -115,8 +115,8 @@ describe('BaseJsonService', function () {
       expect(
         await DummyJsonService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',

core/base-service/base-static.js

@@ -33,14 +33,14 @@ export default class BaseStaticService extends BaseService {
         {},
         serviceConfig,
         namedParams,
-        queryParams
+        queryParams,
       )
 
       const badgeData = coalesceBadge(
         queryParams,
         serviceData,
         this.defaultBadgeData,
-        this
+        this,
       )
 
       // The final capture group is the extension.

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

@@ -53,10 +53,16 @@ class BaseSvgScrapingService extends BaseService {
    * @param {string} attrs.url URL to request
    * @param {object} [attrs.options={}] Options to pass to got. See
    *    [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md)
-   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   * @param {object} [attrs.httpErrors={}] Key-value map of status codes
    *    and custom error messages e.g: `{ 404: 'package not found' }`.
    *    This can be used to extend or override the
    *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
+   *    and an object of params to pass when we construct an Inaccessible exception object
+   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
+   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
+   *    for allowed keys
+   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
    * @returns {object} Parsed response
    * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md
    */
@@ -65,7 +71,8 @@ class BaseSvgScrapingService extends BaseService {
     valueMatcher,
     url,
     options = {},
-    errorMessages = {},
+    httpErrors = {},
+    systemErrors = {},
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
     const mergedOptions = {
@@ -75,7 +82,8 @@ class BaseSvgScrapingService extends BaseService {
     const { buffer } = await this._request({
       url,
       options: mergedOptions,
-      errorMessages,
+      httpErrors,
+      systemErrors,
     })
     logTrace(emojic.dart, 'Response SVG', buffer)
     const data = {

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

@@ -28,7 +28,7 @@ describe('BaseSvgScrapingService', function () {
   describe('valueFromSvgBadge', function () {
     it('should find the correct value', function () {
       expect(BaseSvgScrapingService.valueFromSvgBadge(exampleSvg)).to.equal(
-        exampleMessage
+        exampleMessage,
       )
     })
   })
@@ -40,21 +40,21 @@ describe('BaseSvgScrapingService', function () {
         Promise.resolve({
           buffer: exampleSvg,
           res: { statusCode: 200 },
-        })
+        }),
       )
     })
 
     it('invokes _requestFetcher with the expected header', async function () {
       await DummySvgScrapingService.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
         'http://example.com/foo.svg',
         {
           headers: { Accept: 'image/svg+xml' },
-        }
+        },
       )
     })
 
@@ -75,7 +75,7 @@ describe('BaseSvgScrapingService', function () {
 
       await WithCustomOptions.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
@@ -84,7 +84,7 @@ describe('BaseSvgScrapingService', function () {
           method: 'POST',
           headers: { Accept: 'image/svg+xml' },
           searchParams: { queryParam: 123 },
-        }
+        },
       )
     })
   })
@@ -98,8 +98,8 @@ describe('BaseSvgScrapingService', function () {
       expect(
         await DummySvgScrapingService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: exampleMessage,
       })
@@ -124,8 +124,8 @@ describe('BaseSvgScrapingService', function () {
       expect(
         await WithValueMatcher.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: 'a different message',
       })
@@ -139,8 +139,8 @@ describe('BaseSvgScrapingService', function () {
       expect(
         await DummySvgScrapingService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',

core/base-service/base-toml.js

@@ -0,0 +1,82 @@
+/**
+ * @module
+ */
+
+import emojic from 'emojic'
+import { parse } from 'smol-toml'
+import BaseService from './base.js'
+import { InvalidResponse } from './errors.js'
+import trace from './trace.js'
+
+/**
+ * Services which query a TOML endpoint should extend BaseTomlService
+ *
+ * @abstract
+ */
+class BaseTomlService extends BaseService {
+  /**
+   * Request data from an upstream API serving TOML,
+   * parse it and validate against a schema
+   *
+   * @param {object} attrs Refer to individual attrs
+   * @param {Joi} attrs.schema Joi schema to validate the response against
+   * @param {string} attrs.url URL to request
+   * @param {object} [attrs.options={}] Options to pass to got. See
+   *    [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md)
+   * @param {object} [attrs.httpErrors={}] Key-value map of status codes
+   *    and custom error messages e.g: `{ 404: 'package not found' }`.
+   *    This can be used to extend or override the
+   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
+   *    and an object of params to pass when we construct an Inaccessible exception object
+   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
+   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
+   *    for allowed keys
+   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
+   * @returns {object} Parsed response
+   * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md
+   */
+  async _requestToml({
+    schema,
+    url,
+    options = {},
+    httpErrors = {},
+    systemErrors = {},
+  }) {
+    const logTrace = (...args) => trace.logTrace('fetch', ...args)
+    const mergedOptions = {
+      ...{
+        headers: {
+          Accept:
+            // the official header should be application/toml - see https://toml.io/en/v1.0.0#mime-type
+            // but as this is not registered here https://www.iana.org/assignments/media-types/media-types.xhtml
+            // some apps use other mime-type like application/x-toml, text/plain etc....
+            'text/x-toml, text/toml, application/x-toml, application/toml, text/plain',
+        },
+      },
+      ...options,
+    }
+    const { buffer } = await this._request({
+      url,
+      options: mergedOptions,
+      httpErrors,
+      systemErrors,
+    })
+    let parsed
+    try {
+      parsed = parse(buffer.toString())
+    } catch (err) {
+      logTrace(emojic.dart, 'Response TOML (unparseable)', buffer)
+      throw new InvalidResponse({
+        prettyMessage: 'unparseable toml response',
+        underlyingError: err,
+      })
+    }
+    logTrace(emojic.dart, 'Response TOML (before validation)', parsed, {
+      deep: true,
+    })
+    return this.constructor._validate(parsed, schema)
+  }
+}
+
+export default BaseTomlService

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

@@ -0,0 +1,150 @@
+import Joi from 'joi'
+import { expect } from 'chai'
+import sinon from 'sinon'
+import BaseTomlService from './base-toml.js'
+
+const dummySchema = Joi.object({
+  requiredString: Joi.string().required(),
+}).required()
+
+class DummyTomlService extends BaseTomlService {
+  static category = 'cat'
+  static route = { base: 'foo' }
+
+  async handle() {
+    const { requiredString } = await this._requestToml({
+      schema: dummySchema,
+      url: 'http://example.com/foo.toml',
+    })
+    return { message: requiredString }
+  }
+}
+
+const expectedToml = `
+# example toml
+requiredString = "some-string"
+`
+
+const invalidSchemaToml = `
+# example toml - legal toml syntax but invalid schema
+unexpectedKey = "some-string"
+`
+
+const invalidTomlSyntax = `
+# example illegal toml syntax that can't be parsed
+missing= "space"
+colonsCantBeUsed: 42
+missing "assignment"
+`
+
+describe('BaseTomlService', function () {
+  describe('Making requests', function () {
+    let requestFetcher
+    beforeEach(function () {
+      requestFetcher = sinon.stub().returns(
+        Promise.resolve({
+          buffer: expectedToml,
+          res: { statusCode: 200 },
+        }),
+      )
+    })
+
+    it('invokes _requestFetcher', async function () {
+      await DummyTomlService.invoke(
+        { requestFetcher },
+        { handleInternalErrors: false },
+      )
+
+      expect(requestFetcher).to.have.been.calledOnceWith(
+        'http://example.com/foo.toml',
+        {
+          headers: {
+            Accept:
+              'text/x-toml, text/toml, application/x-toml, application/toml, text/plain',
+          },
+        },
+      )
+    })
+
+    it('forwards options to _requestFetcher', async function () {
+      class WithOptions extends DummyTomlService {
+        async handle() {
+          const { requiredString } = await this._requestToml({
+            schema: dummySchema,
+            url: 'http://example.com/foo.toml',
+            options: { method: 'POST', searchParams: { queryParam: 123 } },
+          })
+          return { message: requiredString }
+        }
+      }
+
+      await WithOptions.invoke(
+        { requestFetcher },
+        { handleInternalErrors: false },
+      )
+
+      expect(requestFetcher).to.have.been.calledOnceWith(
+        'http://example.com/foo.toml',
+        {
+          headers: {
+            Accept:
+              'text/x-toml, text/toml, application/x-toml, application/toml, text/plain',
+          },
+          method: 'POST',
+          searchParams: { queryParam: 123 },
+        },
+      )
+    })
+  })
+
+  describe('Making badges', function () {
+    it('handles valid toml responses', async function () {
+      const requestFetcher = async () => ({
+        buffer: expectedToml,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyTomlService.invoke(
+          { requestFetcher },
+          { handleInternalErrors: false },
+        ),
+      ).to.deep.equal({
+        message: 'some-string',
+      })
+    })
+
+    it('handles toml responses which do not match the schema', async function () {
+      const requestFetcher = async () => ({
+        buffer: invalidSchemaToml,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyTomlService.invoke(
+          { requestFetcher },
+          { handleInternalErrors: false },
+        ),
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'invalid response data',
+      })
+    })
+
+    it('handles unparseable toml responses', async function () {
+      const requestFetcher = async () => ({
+        buffer: invalidTomlSyntax,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyTomlService.invoke(
+          { requestFetcher },
+          { handleInternalErrors: false },
+        ),
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'unparseable toml response',
+      })
+    })
+  })
+})

core/base-service/base-xml.js

@@ -24,10 +24,16 @@ class BaseXmlService extends BaseService {
    * @param {string} attrs.url URL to request
    * @param {object} [attrs.options={}] Options to pass to got. See
    *    [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md)
-   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   * @param {object} [attrs.httpErrors={}] Key-value map of status codes
    *    and custom error messages e.g: `{ 404: 'package not found' }`.
    *    This can be used to extend or override the
    *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
+   *    and an object of params to pass when we construct an Inaccessible exception object
+   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
+   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
+   *    for allowed keys
+   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
    * @param {object} [attrs.parserOptions={}] Options to pass to fast-xml-parser. See
    *    [documentation](https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json)
    * @returns {object} Parsed response
@@ -38,7 +44,8 @@ class BaseXmlService extends BaseService {
     schema,
     url,
     options = {},
-    errorMessages = {},
+    httpErrors = {},
+    systemErrors = {},
     parserOptions = {},
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
@@ -49,7 +56,8 @@ class BaseXmlService extends BaseService {
     const { buffer } = await this._request({
       url,
       options: mergedOptions,
-      errorMessages,
+      httpErrors,
+      systemErrors,
     })
     const validateResult = XMLValidator.validate(buffer)
     if (validateResult !== true) {

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

@@ -28,21 +28,21 @@ describe('BaseXmlService', function () {
         Promise.resolve({
           buffer: '<requiredString>some-string</requiredString>',
           res: { statusCode: 200 },
-        })
+        }),
       )
     })
 
     it('invokes _requestFetcher', async function () {
       await DummyXmlService.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
         'http://example.com/foo.xml',
         {
           headers: { Accept: 'application/xml, text/xml' },
-        }
+        },
       )
     })
 
@@ -62,7 +62,7 @@ describe('BaseXmlService', function () {
 
       await WithCustomOptions.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
@@ -71,7 +71,7 @@ describe('BaseXmlService', function () {
           headers: { Accept: 'application/xml, text/xml' },
           method: 'POST',
           searchParams: { queryParam: 123 },
-        }
+        },
       )
     })
   })
@@ -85,8 +85,8 @@ describe('BaseXmlService', function () {
       expect(
         await DummyXmlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: 'some-string',
       })
@@ -112,8 +112,8 @@ describe('BaseXmlService', function () {
       expect(
         await DummyXmlServiceWithParserOption.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: 'some-string with trailing whitespace   ',
       })
@@ -127,8 +127,8 @@ describe('BaseXmlService', function () {
       expect(
         await DummyXmlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -144,8 +144,8 @@ describe('BaseXmlService', function () {
       expect(
         await DummyXmlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',

core/base-service/base-yaml.js

@@ -23,10 +23,16 @@ class BaseYamlService extends BaseService {
    * @param {string} attrs.url URL to request
    * @param {object} [attrs.options={}] Options to pass to got. See
    *    [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md)
-   * @param {object} [attrs.errorMessages={}] Key-value map of status codes
+   * @param {object} [attrs.httpErrors={}] Key-value map of status codes
    *    and custom error messages e.g: `{ 404: 'package not found' }`.
    *    This can be used to extend or override the
    *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
+   *    and an object of params to pass when we construct an Inaccessible exception object
+   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
+   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
+   *    for allowed keys
+   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
    * @param {object} [attrs.encoding='utf8'] Character encoding
    * @returns {object} Parsed response
    * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md
@@ -35,7 +41,8 @@ class BaseYamlService extends BaseService {
     schema,
     url,
     options = {},
-    errorMessages = {},
+    httpErrors = {},
+    systemErrors = {},
     encoding = 'utf8',
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
@@ -51,7 +58,8 @@ class BaseYamlService extends BaseService {
     const { buffer } = await this._request({
       url,
       options: mergedOptions,
-      errorMessages,
+      httpErrors,
+      systemErrors,
     })
     let parsed
     try {

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

@@ -44,14 +44,14 @@ describe('BaseYamlService', function () {
         Promise.resolve({
           buffer: expectedYaml,
           res: { statusCode: 200 },
-        })
+        }),
       )
     })
 
     it('invokes _requestFetcher', async function () {
       await DummyYamlService.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
@@ -61,7 +61,7 @@ describe('BaseYamlService', function () {
             Accept:
               'text/x-yaml, text/yaml, application/x-yaml, application/yaml, text/plain',
           },
-        }
+        },
       )
     })
 
@@ -79,7 +79,7 @@ describe('BaseYamlService', function () {
 
       await WithOptions.invoke(
         { requestFetcher },
-        { handleInternalErrors: false }
+        { handleInternalErrors: false },
       )
 
       expect(requestFetcher).to.have.been.calledOnceWith(
@@ -91,7 +91,7 @@ describe('BaseYamlService', function () {
           },
           method: 'POST',
           searchParams: { queryParam: 123 },
-        }
+        },
       )
     })
   })
@@ -105,8 +105,8 @@ describe('BaseYamlService', function () {
       expect(
         await DummyYamlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         message: 'some-string',
       })
@@ -120,8 +120,8 @@ describe('BaseYamlService', function () {
       expect(
         await DummyYamlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -137,8 +137,8 @@ describe('BaseYamlService', function () {
       expect(
         await DummyYamlService.invoke(
           { requestFetcher },
-          { handleInternalErrors: false }
-        )
+          { handleInternalErrors: false },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',

core/base-service/base.js

@@ -21,6 +21,7 @@ import {
 } from './errors.js'
 import { validateExample, transformExample } from './examples.js'
 import { fetch } from './got.js'
+import { getEnum } from './openapi.js'
 import {
   makeFullUrl,
   assertValidRoute,
@@ -44,7 +45,7 @@ const optionalStringWhenNamedLogoPresent = Joi.alternatives().conditional(
   {
     is: Joi.string().required(),
     then: Joi.string(),
-  }
+  },
 )
 
 const optionalNumberWhenAnyLogoPresent = Joi.alternatives()
@@ -102,6 +103,26 @@ class BaseService {
     throw new Error(`Route not defined for ${this.name}`)
   }
 
+  /**
+   * Extract an array of allowed values from this service's route pattern
+   * for a given route parameter
+   *
+   * @param {string} param The name of a param in this service's route pattern
+   * @returns {string[]} Array of allowed values for this param
+   */
+  static getEnum(param) {
+    if (!('pattern' in this.route)) {
+      throw new Error('getEnum() requires route to have a .pattern property')
+    }
+    const enumeration = getEnum(this.route.pattern, param)
+    if (!Array.isArray(enumeration)) {
+      throw new Error(
+        `Could not extract enum for param ${param} from pattern ${this.route.pattern}`,
+      )
+    }
+    return enumeration
+  }
+
   /**
    * Configuration for the authentication helper that prepares credentials
    * for upstream requests.
@@ -140,6 +161,15 @@ class BaseService {
    */
   static examples = []
 
+  /**
+   * Optional: an OpenAPI Paths Object describing this service's
+   * route or routes in OpenAPI format.
+   *
+   * @see https://swagger.io/specification/#paths-object
+   * @abstract
+   */
+  static openApi = undefined
+
   static get _cacheLength() {
     const cacheLengths = {
       build: 30,
@@ -174,21 +204,37 @@ class BaseService {
     Joi.assert(
       this.defaultBadgeData,
       defaultBadgeDataSchema,
-      `Default badge data for ${this.name}`
+      `Default badge data for ${this.name}`,
     )
 
     this.examples.forEach((example, index) =>
-      validateExample(example, index, this)
+      validateExample(example, index, this),
     )
+
+    // ensure openApi spec matches route
+    if (this.openApi) {
+      const preparedRoute = prepareRoute(this.route)
+      for (const [key, value] of Object.entries(this.openApi)) {
+        let example = key
+        for (const param of value.get.parameters) {
+          example = example.replace(`{${param.name}}`, param.example)
+        }
+        if (!example.match(preparedRoute.regex)) {
+          throw new Error(
+            `Inconsistent Open Api spec and Route found for service ${this.name}`,
+          )
+        }
+      }
+    }
   }
 
   static getDefinition() {
-    const { category, name, isDeprecated } = this
+    const { category, name, isDeprecated, openApi } = this
     const { base, format, pattern } = this.route
     const queryParams = getQueryParamNames(this.route)
 
     const examples = this.examples.map((example, index) =>
-      transformExample(example, index, this)
+      transformExample(example, index, this),
     )
 
     let route
@@ -200,7 +246,7 @@ class BaseService {
       route = undefined
     }
 
-    const result = { category, name, isDeprecated, route, examples }
+    const result = { category, name, isDeprecated, route, examples, openApi }
 
     assertValidServiceDefinition(result, `getDefinition() for ${this.name}`)
 
@@ -209,7 +255,7 @@ class BaseService {
 
   constructor(
     { requestFetcher, authHelper, metricHelper },
-    { handleInternalErrors }
+    { handleInternalErrors },
   ) {
     this._requestFetcher = requestFetcher
     this.authHelper = authHelper
@@ -217,7 +263,7 @@ class BaseService {
     this._metricHelper = metricHelper
   }
 
-  async _request({ url, options = {}, errorMessages = {} }) {
+  async _request({ url, options = {}, httpErrors = {}, systemErrors = {} }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
     let logUrl = url
     const logOptions = Object.assign({}, options)
@@ -225,9 +271,9 @@ class BaseService {
       const params = new URLSearchParams(
         Object.fromEntries(
           Object.entries(options.searchParams).filter(
-            ([k, v]) => v !== undefined
-          )
-        )
+            ([k, v]) => v !== undefined,
+          ),
+        ),
       )
       logUrl = `${url}?${params.toString()}`
       delete logOptions.searchParams
@@ -235,12 +281,16 @@ class BaseService {
     logTrace(
       emojic.bowAndArrow,
       'Request',
-      `${logUrl}\n${JSON.stringify(logOptions, null, 2)}`
+      `${logUrl}\n${JSON.stringify(logOptions, null, 2)}`,
+    )
+    const { res, buffer } = await this._requestFetcher(
+      url,
+      options,
+      systemErrors,
     )
-    const { res, buffer } = await this._requestFetcher(url, options)
     await this._meterResponse(res, buffer)
     logTrace(emojic.dart, 'Response status code', res.statusCode)
-    return checkErrorResponse(errorMessages)({ buffer, res })
+    return checkErrorResponse(httpErrors)({ buffer, res })
   }
 
   static enabledMetrics = []
@@ -266,7 +316,7 @@ class BaseService {
       prettyErrorMessage = 'invalid response data',
       includeKeys = false,
       allowAndStripUnknownKeys = true,
-    } = {}
+    } = {},
   ) {
     return validate(
       {
@@ -278,7 +328,7 @@ class BaseService {
         allowAndStripUnknownKeys,
       },
       data,
-      schema
+      schema,
     )
   }
 
@@ -319,18 +369,22 @@ class BaseService {
       error instanceof Deprecated
     ) {
       trace.logTrace('outbound', emojic.noGoodWoman, 'Handled error', error)
-      return {
+      const serviceData = {
         isError: true,
         message: error.prettyMessage,
         color: 'lightgray',
       }
+      if (error.cacheSeconds !== undefined) {
+        serviceData.cacheSeconds = error.cacheSeconds
+      }
+      return serviceData
     } else if (this._handleInternalErrors) {
       if (
         !trace.logTrace(
           'unhandledError',
           emojic.boom,
           'Unhandled internal error',
-          error
+          error,
         )
       ) {
         // This is where we end up if an unhandled exception is thrown in
@@ -348,7 +402,7 @@ class BaseService {
         'unhandledError',
         emojic.boom,
         'Unhandled internal error',
-        error
+        error,
       )
       throw error
     }
@@ -358,7 +412,7 @@ class BaseService {
     context = {},
     config = {},
     namedParams = {},
-    queryParams = {}
+    queryParams = {},
   ) {
     trace.logTrace('inbound', emojic.womanCook, 'Service class', this.name)
     trace.logTrace('inbound', emojic.ticket, 'Named params', namedParams)
@@ -392,13 +446,13 @@ class BaseService {
             traceSuccessMessage: 'Query params after validation',
           },
           queryParams,
-          queryParamSchema
+          queryParamSchema,
         )
         trace.logTrace(
           'inbound',
           emojic.crayon,
           'Query params after validation',
-          queryParams
+          queryParams,
         )
       } catch (error) {
         serviceError = error
@@ -412,7 +466,7 @@ class BaseService {
       try {
         serviceData = await serviceInstance.handle(
           namedParams,
-          transformedQueryParams
+          transformedQueryParams,
         )
         serviceInstance._validateServiceData(serviceData)
       } catch (error) {
@@ -437,7 +491,7 @@ class BaseService {
       librariesIoApiProvider,
       metricInstance,
     },
-    serviceConfig
+    serviceConfig,
   ) {
     const { cacheHeaders: cacheHeaderConfig } = serviceConfig
     const { regex, captureNames } = prepareRoute(this.route)
@@ -465,14 +519,14 @@ class BaseService {
             },
             serviceConfig,
             namedParams,
-            queryParams
+            queryParams,
           )
 
           const badgeData = coalesceBadge(
             queryParams,
             serviceData,
             this.defaultBadgeData,
-            this
+            this,
           )
           // The final capture group is the extension.
           const format = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
@@ -481,7 +535,7 @@ class BaseService {
           metricHandle.noteResponseSent()
         },
         cacheLength: this._cacheLength,
-      })
+      }),
     )
   }
 }

core/base-service/base.spec.js

@@ -72,8 +72,8 @@ describe('BaseService', function () {
         {},
         defaultConfig,
         { namedParamA: 'bar.bar.bar' },
-        { queryParamA: '!' }
-      )
+        { queryParamA: '!' },
+      ),
     ).to.deep.equal({
       message: 'Hello namedParamA: bar.bar.bar with queryParamA: !',
     })
@@ -85,8 +85,8 @@ describe('BaseService', function () {
         {},
         defaultConfig,
         { namedParamA: 'bar.bar.bar' },
-        { queryParamA: ['foo', 'bar'] }
-      )
+        { queryParamA: ['foo', 'bar'] },
+      ),
     ).to.deep.equal({
       color: 'red',
       isError: true,
@@ -97,13 +97,13 @@ describe('BaseService', function () {
   describe('Required overrides', function () {
     it('Should throw if render() is not overridden', function () {
       expect(() => BaseService.render()).to.throw(
-        /^render\(\) function not implemented for BaseService$/
+        /^render\(\) function not implemented for BaseService$/,
       )
     })
 
     it('Should throw if route is not overridden', function () {
       return expect(BaseService.invoke({}, {}, {})).to.be.rejectedWith(
-        /^Route not defined for BaseService$/
+        /^Route not defined for BaseService$/,
       )
     })
 
@@ -112,13 +112,13 @@ describe('BaseService', function () {
     }
     it('Should throw if handle() is not overridden', function () {
       return expect(WithRoute.invoke({}, {}, {})).to.be.rejectedWith(
-        /^Handler not implemented for WithRoute$/
+        /^Handler not implemented for WithRoute$/,
       )
     })
 
     it('Should throw if category is not overridden', function () {
       expect(() => BaseService.category).to.throw(
-        /^Category not set for BaseService$/
+        /^Category not set for BaseService$/,
       )
     })
   })
@@ -135,25 +135,25 @@ describe('BaseService', function () {
         {},
         defaultConfig,
         { namedParamA: 'bar.bar.bar' },
-        { queryParamA: '!' }
+        { queryParamA: '!' },
       )
       expect(trace.logTrace).to.be.calledWithMatch(
         'inbound',
         sinon.match.string,
         'Service class',
-        'DummyService'
+        'DummyService',
       )
       expect(trace.logTrace).to.be.calledWith(
         'inbound',
         sinon.match.string,
         'Named params',
-        { namedParamA: 'bar.bar.bar' }
+        { namedParamA: 'bar.bar.bar' },
       )
       expect(trace.logTrace).to.be.calledWith(
         'inbound',
         sinon.match.string,
         'Query params after validation',
-        { queryParamA: '!' }
+        { queryParamA: '!' },
       )
     })
   })
@@ -171,7 +171,7 @@ describe('BaseService', function () {
       const serviceData = await LinkService.invoke(
         {},
         { handleInternalErrors: false },
-        { namedParamA: 'bar.bar.bar' }
+        { namedParamA: 'bar.bar.bar' },
       )
 
       expect(serviceData).to.deep.equal({
@@ -194,7 +194,7 @@ describe('BaseService', function () {
           await ThrowingService.invoke(
             {},
             { handleInternalErrors: false },
-            { namedParamA: 'bar.bar.bar' }
+            { namedParamA: 'bar.bar.bar' },
           )
           expect.fail('Expected to throw')
         } catch (e) {
@@ -212,7 +212,7 @@ describe('BaseService', function () {
           await ThrowingService.invoke(
             {},
             { handleInternalErrors: false },
-            { namedParamA: 'bar.bar.bar' }
+            { namedParamA: 'bar.bar.bar' },
           )
           expect.fail('Expected to throw')
         } catch (e) {
@@ -233,8 +233,8 @@ describe('BaseService', function () {
         await ThrowingService.invoke(
           {},
           { handleInternalErrors: true },
-          { namedParamA: 'bar.bar.bar' }
-        )
+          { namedParamA: 'bar.bar.bar' },
+        ),
       ).to.deep.equal({
         isError: true,
         color: 'lightgray',
@@ -251,7 +251,7 @@ describe('BaseService', function () {
           }
         }
         expect(
-          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' }),
         ).to.deep.equal({
           isError: true,
           color: 'red',
@@ -266,7 +266,7 @@ describe('BaseService', function () {
           }
         }
         expect(
-          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' }),
         ).to.deep.equal({
           isError: true,
           color: 'lightgray',
@@ -281,7 +281,7 @@ describe('BaseService', function () {
           }
         }
         expect(
-          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' }),
         ).to.deep.equal({
           isError: true,
           color: 'lightgray',
@@ -296,7 +296,7 @@ describe('BaseService', function () {
           }
         }
         expect(
-          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' }),
         ).to.deep.equal({
           isError: true,
           color: 'lightgray',
@@ -311,7 +311,7 @@ describe('BaseService', function () {
           }
         }
         expect(
-          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' }),
         ).to.deep.equal({
           isError: true,
           color: 'red',
@@ -322,7 +322,7 @@ describe('BaseService', function () {
   })
 
   describe('ScoutCamp integration', function () {
-    // TODO Strangly, without the useless escape the regexes do not match in Node 12.
+    // TODO Strangely, without the useless escape the regexes do not match in Node 12.
     // eslint-disable-next-line no-useless-escape
     const expectedRouteRegex = /^\/foo(?:\/([^\/#\?]+?))(|\.svg|\.json)$/
 
@@ -336,7 +336,7 @@ describe('BaseService', function () {
       mockHandleRequest = sinon.spy()
       DummyService.register(
         { camp: mockCamp, handleRequest: mockHandleRequest },
-        defaultConfig
+        defaultConfig,
       )
     })
 
@@ -413,8 +413,8 @@ describe('BaseService', function () {
       expect(() =>
         DummyService._validate(
           { requiredString: ['this', "shouldn't", 'work'] },
-          dummySchema
-        )
+          dummySchema,
+        ),
       )
         .to.throw()
         .instanceof(InvalidResponse)
@@ -436,7 +436,7 @@ describe('BaseService', function () {
       })
       const serviceInstance = new DummyService(
         { requestFetcher },
-        defaultConfig
+        defaultConfig,
       )
 
       const url = 'some-url'
@@ -453,14 +453,14 @@ describe('BaseService', function () {
         `${url}?param1=foobar\n${JSON.stringify(
           { headers: options.headers },
           null,
-          2
-        )}`
+          2,
+        )}`,
       )
       expect(trace.logTrace).to.be.calledWithMatch(
         'fetch',
         sinon.match.string,
         'Response status code',
-        200
+        200,
       )
     })
 
@@ -471,7 +471,7 @@ describe('BaseService', function () {
       })
       const serviceInstance = new DummyService(
         { requestFetcher },
-        defaultConfig
+        defaultConfig,
       )
 
       try {
@@ -504,17 +504,17 @@ describe('BaseService', function () {
       const serviceInstance =
         new DummyServiceWithServiceResponseSizeMetricEnabled(
           { requestFetcher, metricHelper },
-          defaultConfig
+          defaultConfig,
         )
 
       await serviceInstance._request({ url })
 
       expect(await register.getSingleMetricAsString('service_response_bytes'))
         .to.contain(
-          'service_response_bytes_bucket{le="65536",category="other",family="undefined",service="dummy_service_with_service_response_size_metric_enabled"} 0\n'
+          'service_response_bytes_bucket{le="65536",category="other",family="undefined",service="dummy_service_with_service_response_size_metric_enabled"} 0\n',
         )
         .and.to.contain(
-          'service_response_bytes_bucket{le="131072",category="other",family="undefined",service="dummy_service_with_service_response_size_metric_enabled"} 1\n'
+          'service_response_bytes_bucket{le="131072",category="other",family="undefined",service="dummy_service_with_service_response_size_metric_enabled"} 1\n',
         )
     })
 
@@ -529,16 +529,17 @@ describe('BaseService', function () {
       })
       const serviceInstance = new DummyService(
         { requestFetcher, metricHelper },
-        defaultConfig
+        defaultConfig,
       )
 
       await serviceInstance._request({ url })
 
       expect(
-        await register.getSingleMetricAsString('service_response_bytes')
+        await register.getSingleMetricAsString('service_response_bytes'),
       ).to.not.contain('service_response_bytes_bucket')
     })
   })
+
   describe('auth', function () {
     class AuthService extends DummyService {
       static auth = {
@@ -565,8 +566,8 @@ describe('BaseService', function () {
             },
             private: { myci_pass: 'abc123' },
           },
-          { namedParamA: 'bar.bar.bar' }
-        )
+          { namedParamA: 'bar.bar.bar' },
+        ),
       ).to.deep.equal({ message: 'The CI password is abc123' })
     })
 
@@ -583,8 +584,8 @@ describe('BaseService', function () {
           },
           {
             namedParamA: 'bar.bar.bar',
-          }
-        )
+          },
+        ),
       ).to.deep.equal({
         color: 'lightgray',
         isError: true,
@@ -592,4 +593,44 @@ describe('BaseService', function () {
       })
     })
   })
+
+  describe('getEnum', function () {
+    class EnumService extends DummyService {
+      static route = {
+        base: 'foo',
+        pattern: ':namedParamA/:namedParamB(this|that)',
+        queryParamSchema,
+      }
+    }
+
+    it('returns an array of allowed values', async function () {
+      expect(EnumService.getEnum('namedParamB')).to.deep.equal(['this', 'that'])
+    })
+
+    it('throws if param name is invalid', async function () {
+      expect(() => EnumService.getEnum('notAValidParam')).to.throw(
+        'Could not extract enum for param notAValidParam from pattern :namedParamA/:namedParamB(this|that)',
+      )
+    })
+
+    it('throws if param name is not an enum', async function () {
+      expect(() => EnumService.getEnum('namedParamA')).to.throw(
+        'Could not extract enum for param namedParamA from pattern :namedParamA/:namedParamB(this|that)',
+      )
+    })
+
+    it('throws if route does not have a pattern', async function () {
+      class FormatService extends DummyService {
+        static route = {
+          base: 'foo',
+          format: '([^/]+?)',
+          queryParamSchema,
+        }
+      }
+
+      expect(() => FormatService.getEnum('notAValidParam')).to.throw(
+        'getEnum() requires route to have a .pattern property',
+      )
+    })
+  })
 })

core/base-service/cache-headers.js

@@ -39,14 +39,14 @@ function coalesceCacheLength({
   assert(defaultCacheLengthSeconds !== undefined)
 
   const cacheLength = coalesce(
+    serviceOverrideCacheLengthSeconds,
     serviceDefaultCacheLengthSeconds,
-    defaultCacheLengthSeconds
+    defaultCacheLengthSeconds,
   )
 
   // Overrides can apply _more_ caching, but not less. Query param overriding
   // can request more overriding than service override, but not less.
   const candidateOverrides = [
-    serviceOverrideCacheLengthSeconds,
     overrideCacheLengthFromQueryParams(queryParams),
   ].filter(x => x !== undefined)
 

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

@@ -74,12 +74,12 @@ describe('Cache header functions', function () {
         serviceDefaultCacheLengthSeconds: 900,
         serviceOverrideCacheLengthSeconds: 400,
         queryParams: {},
-      }).expect(900)
+      }).expect(400)
       given({
         cacheHeaderConfig,
         serviceOverrideCacheLengthSeconds: 400,
         queryParams: {},
-      }).expect(777)
+      }).expect(400)
       given({
         cacheHeaderConfig,
         serviceOverrideCacheLengthSeconds: 900,
@@ -125,7 +125,7 @@ describe('Cache header functions', function () {
 
       it('should set the expected Cache-Control header', function () {
         expect(res._headers['cache-control']).to.equal(
-          'no-cache, no-store, must-revalidate'
+          'no-cache, no-store, must-revalidate',
         )
       })
 
@@ -141,7 +141,7 @@ describe('Cache header functions', function () {
 
       it('should set the expected Cache-Control header', function () {
         expect(res._headers['cache-control']).to.equal(
-          'max-age=123, s-maxage=123'
+          'max-age=123, s-maxage=123',
         )
       })
 
@@ -156,7 +156,7 @@ describe('Cache header functions', function () {
     it('sets the expected fields', function () {
       const expectedFields = ['date', 'cache-control', 'expires']
       expectedFields.forEach(field =>
-        expect(res._headers[field]).to.equal(undefined)
+        expect(res._headers[field]).to.equal(undefined),
       )
 
       setCacheHeaders({
@@ -169,7 +169,7 @@ describe('Cache header functions', function () {
       expectedFields.forEach(field =>
         expect(res._headers[field])
           .to.be.a('string')
-          .and.have.lengthOf.at.least(1)
+          .and.have.lengthOf.at.least(1),
       )
     })
   })
@@ -181,7 +181,7 @@ describe('Cache header functions', function () {
 
     it('should set the expected Cache-Control header', function () {
       expect(res._headers['cache-control']).to.equal(
-        `max-age=${24 * 3600}, s-maxage=${24 * 3600}`
+        `max-age=${24 * 3600}, s-maxage=${24 * 3600}`,
       )
     })
 
@@ -190,7 +190,7 @@ describe('Cache header functions', function () {
       expect(new Date(lastModified)).to.be.withinTime(
         // Within the last 60 seconds.
         new Date(Date.now() - 60 * 1000),
-        new Date()
+        new Date(),
       )
     })
   })
@@ -221,7 +221,7 @@ describe('Cache header functions', function () {
           })
           expect(serverHasBeenUpSinceResourceCached(req)).to.equal(false)
         })
-      }
+      },
     )
     context(
       'when the If-Modified-Since header is after the process started',
@@ -233,7 +233,7 @@ describe('Cache header functions', function () {
           })
           expect(serverHasBeenUpSinceResourceCached(req)).to.equal(true)
         })
-      }
+      },
     )
   })
 })

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

@@ -2,21 +2,22 @@ import { NotFound, InvalidResponse, Inaccessible } from './errors.js'
 
 const defaultErrorMessages = {
   404: 'not found',
+  429: 'rate limited by upstream service',
 }
 
-export default function checkErrorResponse(errorMessages = {}) {
+export default function checkErrorResponse(httpErrors = {}) {
   return async function ({ buffer, res }) {
     let error
-    errorMessages = { ...defaultErrorMessages, ...errorMessages }
+    httpErrors = { ...defaultErrorMessages, ...httpErrors }
     if (res.statusCode === 404) {
-      error = new NotFound({ prettyMessage: errorMessages[404] })
+      error = new NotFound({ prettyMessage: httpErrors[404] })
     } else if (res.statusCode !== 200) {
       const underlying = Error(
-        `Got status code ${res.statusCode} (expected 200)`
+        `Got status code ${res.statusCode} (expected 200)`,
       )
       const props = { underlyingError: underlying }
-      if (errorMessages[res.statusCode] !== undefined) {
-        props.prettyMessage = errorMessages[res.statusCode]
+      if (httpErrors[res.statusCode] !== undefined) {
+        props.prettyMessage = httpErrors[res.statusCode]
       }
       if (res.statusCode >= 500) {
         error = new Inaccessible(props)

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

@@ -45,6 +45,42 @@ describe('async error handler', function () {
     })
   })
 
+  context('when status is 429', function () {
+    const buffer = Buffer.from('some stuff')
+    const res = { statusCode: 429 }
+
+    it('throws InvalidResponse', async function () {
+      try {
+        await checkErrorResponse()({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(InvalidResponse)
+        expect(e.message).to.equal(
+          'Invalid Response: Got status code 429 (expected 200)',
+        )
+        expect(e.prettyMessage).to.equal('rate limited by upstream service')
+        expect(e.response).to.equal(res)
+        expect(e.buffer).to.equal(buffer)
+      }
+    })
+
+    it('displays the custom too many requests', async function () {
+      const notFoundMessage = "terribly sorry but that's one too many requests"
+      try {
+        await checkErrorResponse({ 429: notFoundMessage })({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(InvalidResponse)
+        expect(e.message).to.equal(
+          'Invalid Response: Got status code 429 (expected 200)',
+        )
+        expect(e.prettyMessage).to.equal(
+          "terribly sorry but that's one too many requests",
+        )
+      }
+    })
+  })
+
   context('when status is 4xx', function () {
     it('throws InvalidResponse', async function () {
       const res = { statusCode: 499 }
@@ -54,7 +90,7 @@ describe('async error handler', function () {
       } catch (e) {
         expect(e).to.be.an.instanceof(InvalidResponse)
         expect(e.message).to.equal(
-          'Invalid Response: Got status code 499 (expected 200)'
+          'Invalid Response: Got status code 499 (expected 200)',
         )
         expect(e.prettyMessage).to.equal('invalid')
         expect(e.response).to.equal(res)
@@ -70,7 +106,7 @@ describe('async error handler', function () {
       } catch (e) {
         expect(e).to.be.an.instanceof(InvalidResponse)
         expect(e.message).to.equal(
-          'Invalid Response: Got status code 403 (expected 200)'
+          'Invalid Response: Got status code 403 (expected 200)',
         )
         expect(e.prettyMessage).to.equal('access denied')
       }
@@ -86,7 +122,7 @@ describe('async error handler', function () {
       } catch (e) {
         expect(e).to.be.an.instanceof(Inaccessible)
         expect(e.message).to.equal(
-          'Inaccessible: Got status code 503 (expected 200)'
+          'Inaccessible: Got status code 503 (expected 200)',
         )
         expect(e.prettyMessage).to.equal('inaccessible')
         expect(e.response).to.equal(res)
@@ -102,7 +138,7 @@ describe('async error handler', function () {
       } catch (e) {
         expect(e).to.be.an.instanceof(Inaccessible)
         expect(e.message).to.equal(
-          'Inaccessible: Got status code 500 (expected 200)'
+          'Inaccessible: Got status code 500 (expected 200)',
         )
         expect(e.prettyMessage).to.equal('server overloaded')
       }

core/base-service/coalesce-badge.js

@@ -36,7 +36,7 @@ export default function coalesceBadge(
   serviceData,
   // These two parameters were kept separate to make tests clearer.
   defaultBadgeData,
-  { category, _cacheLength: defaultCacheSeconds } = {}
+  { category, _cacheLength: defaultCacheSeconds } = {},
 ) {
   // The "overrideX" naming is based on services that provide badge
   // parameters themselves, which can be overridden by a query string
@@ -141,7 +141,7 @@ export default function coalesceBadge(
     } else {
       namedLogo = coalesce(
         serviceNamedLogo,
-        style === 'social' ? defaultNamedLogo : undefined
+        style === 'social' ? defaultNamedLogo : undefined,
       )
       namedLogoColor = coalesce(overrideLogoColor, serviceLogoColor)
     }
@@ -166,13 +166,13 @@ export default function coalesceBadge(
       isError ? undefined : overrideColor,
       serviceColor,
       defaultColor,
-      'lightgrey'
+      'lightgrey',
     ),
     labelColor: coalesce(
       // In case of an error, disregard user's color override.
       isError ? undefined : overrideLabelColor,
       serviceLabelColor,
-      defaultLabelColor
+      defaultLabelColor,
     ),
     style,
     namedLogo,

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

@@ -25,7 +25,7 @@ describe('coalesceBadge', function () {
 
     it('overrides the label', function () {
       expect(
-        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {})
+        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {}),
       ).to.include({ label: 'purr count' })
     })
   })
@@ -54,11 +54,11 @@ describe('coalesceBadge', function () {
 
     it('overrides the color', function () {
       expect(
-        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {})
+        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {}),
       ).to.include({ color: '10ADED' })
       // also expected for legacy name
       expect(
-        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {})
+        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {}),
       ).to.include({ color: 'B0ADED' })
     })
 
@@ -68,16 +68,16 @@ describe('coalesceBadge', function () {
           coalesceBadge(
             { color: '10ADED' },
             { isError: true, color: 'lightgray' },
-            {}
-          )
+            {},
+          ),
         ).to.include({ color: 'lightgray' })
         // also expected for legacy name
         expect(
           coalesceBadge(
             { colorB: 'B0ADED' },
             { isError: true, color: 'lightgray' },
-            {}
-          )
+            {},
+          ),
         ).to.include({ color: 'lightgray' })
       })
     })
@@ -102,11 +102,11 @@ describe('coalesceBadge', function () {
 
     it('overrides the label color', function () {
       expect(
-        coalesceBadge({ labelColor: '42f483' }, { color: 'green' }, {})
+        coalesceBadge({ labelColor: '42f483' }, { color: 'green' }, {}),
       ).to.include({ labelColor: '42f483' })
       // also expected for legacy name
       expect(
-        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {})
+        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {}),
       ).to.include({ labelColor: 'B2f483' })
     })
 
@@ -116,8 +116,8 @@ describe('coalesceBadge', function () {
           // Scoutcamp converts numeric query params to numbers.
           { color: 123 },
           { color: 'green' },
-          {}
-        )
+          {},
+        ),
       ).to.include({ color: '123' })
       // also expected for legacy name
       expect(
@@ -125,8 +125,8 @@ describe('coalesceBadge', function () {
           // Scoutcamp converts numeric query params to numbers.
           { colorB: 123 },
           { color: 'green' },
-          {}
-        )
+          {},
+        ),
       ).to.include({ color: '123' })
     })
   })
@@ -140,7 +140,7 @@ describe('coalesceBadge', function () {
     it('when a social badge, uses the default named logo', function () {
       // .not.be.empty for confidence that nothing has changed with `getShieldsIcon()`.
       expect(
-        coalesceBadge({ style: 'social' }, {}, { namedLogo: 'appveyor' }).logo
+        coalesceBadge({ style: 'social' }, {}, { namedLogo: 'appveyor' }).logo,
       ).to.equal(getSimpleIcon({ name: 'appveyor' })).and.not.be.empty
     })
 
@@ -149,28 +149,28 @@ describe('coalesceBadge', function () {
         namedLogo: 'npm',
       })
       expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).logo).to.equal(
-        getShieldsIcon({ name: 'npm' })
+        getShieldsIcon({ name: 'npm' }),
       ).and.not.to.be.empty
     })
 
     it('applies the named monochrome logo with color', function () {
       expect(
         coalesceBadge({}, { namedLogo: 'dependabot', logoColor: 'blue' }, {})
-          .logo
+          .logo,
       ).to.equal(getShieldsIcon({ name: 'dependabot', color: 'blue' })).and.not
         .to.be.empty
     })
 
     it('applies the named multicolored logo with color', function () {
       expect(
-        coalesceBadge({}, { namedLogo: 'npm', logoColor: 'blue' }, {}).logo
+        coalesceBadge({}, { namedLogo: 'npm', logoColor: 'blue' }, {}).logo,
       ).to.equal(getSimpleIcon({ name: 'npm', color: 'blue' })).and.not.to.be
         .empty
     })
 
     it('overrides the logo', function () {
       expect(
-        coalesceBadge({ logo: 'npm' }, { namedLogo: 'appveyor' }, {}).logo
+        coalesceBadge({ logo: 'npm' }, { namedLogo: 'appveyor' }, {}).logo,
       ).to.equal(getShieldsIcon({ name: 'npm' })).and.not.be.empty
     })
 
@@ -179,8 +179,8 @@ describe('coalesceBadge', function () {
         coalesceBadge(
           { logo: 'dependabot', logoColor: 'blue' },
           { namedLogo: 'appveyor' },
-          {}
-        ).logo
+          {},
+        ).logo,
       ).to.equal(getShieldsIcon({ name: 'dependabot', color: 'blue' })).and.not
         .be.empty
     })
@@ -190,8 +190,8 @@ describe('coalesceBadge', function () {
         coalesceBadge(
           { logo: 'npm', logoColor: 'blue' },
           { namedLogo: 'appveyor' },
-          {}
-        ).logo
+          {},
+        ).logo,
       ).to.equal(getSimpleIcon({ name: 'npm', color: 'blue' })).and.not.be.empty
     })
 
@@ -205,8 +205,8 @@ describe('coalesceBadge', function () {
             logoPosition: -3,
             logoWidth: 100,
           },
-          {}
-        ).logo
+          {},
+        ).logo,
       ).to.equal(getShieldsIcon({ name: 'npm' })).and.not.be.empty
     })
 
@@ -215,8 +215,8 @@ describe('coalesceBadge', function () {
         coalesceBadge(
           { logoColor: 'blue' },
           { namedLogo: 'dependabot', logoColor: 'red' },
-          {}
-        ).logo
+          {},
+        ).logo,
       ).to.equal(getShieldsIcon({ name: 'dependabot', color: 'blue' })).and.not
         .be.empty
     })
@@ -226,8 +226,8 @@ describe('coalesceBadge', function () {
         coalesceBadge(
           { logoColor: 'blue' },
           { namedLogo: 'npm', logoColor: 'red' },
-          {}
-        ).logo
+          {},
+        ).logo,
       ).to.equal(getSimpleIcon({ name: 'npm', color: 'blue' })).and.not.be.empty
     })
 
@@ -235,7 +235,7 @@ describe('coalesceBadge', function () {
     it('overrides logoSvg', function () {
       const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
       expect(coalesceBadge({ logo: 'npm' }, { logoSvg }, {}).logo).to.equal(
-        getShieldsIcon({ name: 'npm' })
+        getShieldsIcon({ name: 'npm' }),
       ).and.not.be.empty
     })
   })
@@ -244,7 +244,7 @@ describe('coalesceBadge', function () {
     it('overrides the logo with custom svg', function () {
       const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
       expect(
-        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {})
+        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {}),
       ).to.include({ logo: logoSvg })
     })
 
@@ -254,8 +254,8 @@ describe('coalesceBadge', function () {
         coalesceBadge(
           { logo: logoSvg, logoColor: 'brightgreen' },
           { namedLogo: 'appveyor' },
-          {}
-        )
+          {},
+        ),
       ).to.include({ logo: logoSvg })
     })
   })
@@ -269,7 +269,7 @@ describe('coalesceBadge', function () {
 
     it('applies the logo width', function () {
       expect(
-        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {})
+        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {}),
       ).to.include({ logoWidth: 275 })
     })
   })
@@ -283,7 +283,7 @@ describe('coalesceBadge', function () {
 
     it('applies the logo position', function () {
       expect(
-        coalesceBadge({}, { namedLogo: 'npm', logoPosition: -10 }, {})
+        coalesceBadge({}, { namedLogo: 'npm', logoPosition: -10 }, {}),
       ).to.include({ logoPosition: -10 })
     })
   })
@@ -296,8 +296,8 @@ describe('coalesceBadge', function () {
           {
             link: 'https://circleci.com/workflow-run/184ef3de-4836-4805-a2e4-0ceba099f92d',
           },
-          {}
-        ).links
+          {},
+        ).links,
       ).to.deep.equal(['https://circleci.com/gh/badges/daily-tests'])
     })
   })
@@ -328,7 +328,7 @@ describe('coalesceBadge', function () {
   describe('Cache length', function () {
     it('overrides the cache length', function () {
       expect(
-        coalesceBadge({ style: 'pill' }, { cacheSeconds: 123 }, {})
+        coalesceBadge({ style: 'pill' }, { cacheSeconds: 123 }, {}),
       ).to.include({ cacheLengthSeconds: 123 })
     })
   })

core/base-service/deprecated-service.js

@@ -20,7 +20,7 @@ function deprecatedService(attrs) {
   const { route, name, label, category, examples, message } = Joi.attempt(
     attrs,
     attrSchema,
-    `Deprecated service for ${attrs.route.base}`
+    `Deprecated service for ${attrs.route.base}`,
   )
 
   return class DeprecatedService extends BaseService {

core/base-service/errors.js

@@ -42,6 +42,7 @@ class ShieldsRuntimeError extends Error {
     if (props.underlyingError) {
       this.stack = props.underlyingError.stack
     }
+    this.cacheSeconds = props.cacheSeconds
   }
 }
 
@@ -206,6 +207,9 @@ class Deprecated extends ShieldsRuntimeError {
  * @property {string} prettyMessage User-facing error message to override the
  * value of `defaultPrettyMessage()`. This is the text that will appear on the
  * badge when we catch and render the exception (Optional)
+ * @property {number} cacheSeconds Length of time to cache this error response
+ * for. Defaults to the cacheLength of the service class throwing the error
+ * (Optional)
  */
 
 export {

core/base-service/examples.js

@@ -6,7 +6,7 @@ import { makeFullUrl } from './route.js'
 
 const optionalObjectOfKeyValues = Joi.object().pattern(
   /./,
-  Joi.string().allow(null)
+  Joi.string().allow(null),
 )
 
 const schema = Joi.object({
@@ -32,19 +32,19 @@ function validateExample(example, index, ServiceClass) {
   const result = Joi.attempt(
     example,
     schema,
-    `Example for ${ServiceClass.name} at index ${index}`
+    `Example for ${ServiceClass.name} at index ${index}`,
   )
 
   const { pattern, namedParams } = result
 
   if (!pattern && !ServiceClass.route.pattern) {
     throw new Error(
-      `Example for ${ServiceClass.name} at index ${index} does not declare a pattern`
+      `Example for ${ServiceClass.name} at index ${index} does not declare a pattern`,
     )
   }
   if (pattern === ServiceClass.route.pattern) {
     throw new Error(
-      `Example for ${ServiceClass.name} at index ${index} declares a redundant pattern which should be removed`
+      `Example for ${ServiceClass.name} at index ${index} declares a redundant pattern which should be removed`,
     )
   }
 
@@ -57,7 +57,7 @@ function validateExample(example, index, ServiceClass) {
     throw Error(
       `In example for ${
         ServiceClass.name
-      } at index ${index}, ${e.message.toLowerCase()}`
+      } at index ${index}, ${e.message.toLowerCase()}`,
     )
   }
   // Make sure there are no extra keys.
@@ -73,8 +73,8 @@ function validateExample(example, index, ServiceClass) {
       `In example for ${
         ServiceClass.name
       } at index ${index}, namedParams contains unknown keys: ${extraKeys.join(
-        ', '
-      )}`
+        ', ',
+      )}`,
     )
   }
 
@@ -86,22 +86,22 @@ function validateExample(example, index, ServiceClass) {
         `In example for ${
           ServiceClass.name
         } at index ${index}, keywords contains words that are less than two characters long: ${tinyKeywords.join(
-          ', '
-        )}`
+          ', ',
+        )}`,
       )
     }
     // Make sure none of the keywords are already included in the title.
     const title = (example.title || ServiceClass.name).toLowerCase()
     const redundantKeywords = example.keywords.filter(k =>
-      title.includes(k.toLowerCase())
+      title.includes(k.toLowerCase()),
     )
     if (redundantKeywords.length) {
       throw Error(
         `In example for ${
           ServiceClass.name
         } at index ${index}, keywords contains words that are already in the title: ${redundantKeywords.join(
-          ', '
-        )}`
+          ', ',
+        )}`,
       )
     }
   }
@@ -126,15 +126,16 @@ function transformExample(inExample, index, ServiceClass) {
     {},
     staticPreview,
     ServiceClass.defaultBadgeData,
-    ServiceClass
+    ServiceClass,
   )
 
+  const category = categories.find(c => c.id === ServiceClass.category)
   return {
     title,
     example: {
       pattern: makeFullUrl(
         ServiceClass.route.base,
-        pattern || ServiceClass.route.pattern
+        pattern || ServiceClass.route.pattern,
       ),
       namedParams,
       queryParams,
@@ -146,9 +147,7 @@ function transformExample(inExample, index, ServiceClass) {
       style: style === 'flat' ? undefined : style,
       namedLogo,
     },
-    keywords: keywords.concat(
-      categories.find(c => c.id === ServiceClass.category).keywords
-    ),
+    keywords: category ? keywords.concat(category.keywords) : keywords,
     documentation: documentation ? { __html: documentation } : undefined,
   }
 }

core/base-service/examples.spec.js

@@ -16,7 +16,7 @@ describe('validateExample function', function () {
 
     validExamples.forEach(example => {
       expect(() =>
-        validateExample(example, 0, { route: {}, name: 'mockService' })
+        validateExample(example, 0, { route: {}, name: 'mockService' }),
       ).not.to.throw(Error)
     })
   })
@@ -66,7 +66,7 @@ describe('validateExample function', function () {
 
     invalidExamples.forEach(example => {
       expect(() =>
-        validateExample(example, 0, { route: {}, name: 'mockService' })
+        validateExample(example, 0, { route: {}, name: 'mockService' }),
       ).to.throw(Error)
     })
   })
@@ -93,7 +93,7 @@ test(transformExample, function () {
       keywords: ['hello'],
     },
     0,
-    ExampleService
+    ExampleService,
   ).expect({
     title: 'ExampleService',
     example: {
@@ -119,7 +119,7 @@ test(transformExample, function () {
       keywords: ['hello'],
     },
     0,
-    ExampleService
+    ExampleService,
   ).expect({
     title: 'ExampleService',
     example: {
@@ -146,7 +146,7 @@ test(transformExample, function () {
       keywords: ['hello'],
     },
     0,
-    ExampleService
+    ExampleService,
   ).expect({
     title: 'ExampleService',
     example: {