Merge branch 'master' into gh-actions-api

Author: calebcartwright

.circleci/config.yml

@@ -104,7 +104,7 @@ services_steps: &services_steps
         environment:
           mocha_reporter: mocha-junit-reporter
           MOCHA_FILE: junit/services/results.xml
-        command: npm run test:services:pr:run
+        command: RETRY_COUNT=3 npm run test:services:pr:run
 
     - store_test_results:
         path: junit

.eslintrc.yml

@@ -4,6 +4,8 @@ extends:
   - plugin:@typescript-eslint/recommended
   - prettier/@typescript-eslint
   - prettier/standard
+  - prettier/react
+  - eslint:recommended
 
 parserOptions:
   # Override eslint-config-standard, which incorrectly sets this to "module",
@@ -34,6 +36,7 @@ overrides:
       - '!frontend/**/*.js'
     env:
       node: true
+      es6: true
     rules:
       no-console: 'off'
       '@typescript-eslint/no-var-requires': off
@@ -94,6 +97,8 @@ overrides:
   - files:
       - '**/*.spec.@(js|ts|tsx)'
       - '**/*.integration.js'
+      - '**/test-helpers.js'
+      - 'core/service-test-runner/**/*.js'
     env:
       mocha: true
     rules:
@@ -113,7 +118,7 @@ rules:
   '@typescript-eslint/no-var-requires': error
 
   # These should be disabled by eslint-config-prettier, but are not.
-  spaced-comment: 'off'
+  no-extra-semi: 'off'
 
   # Shields additions.
   no-var: 'error'
@@ -160,7 +165,6 @@ rules:
   '@typescript-eslint/camelcase': off
 
   react/jsx-sort-props: 'error'
-  react/prop-types: 'off'
   react-hooks/rules-of-hooks: 'error'
   react-hooks/exhaustive-deps: 'error'
   jsx-quotes: ['error', 'prefer-double']

.gitpod.yml

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

.nycrc.json

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

CONTRIBUTING.md

@@ -24,10 +24,20 @@ maybe you'd like to open a pull request to address one of them:
 
 You can help by improving the project's usage and developer instructions.
 
+Tutorials are in [/doc](https://github.com/badges/shields/tree/master/doc):
+
 - When you read the documentation, you can fix mistakes and add your own thoughts.
 - When your pull request follows the documentation but the practice changed,
   consider pointing this out and change the documentation for the next person.
 
+API documentation is at [contributing.shields.io](https://contributing.shields.io/):
+
+- This documentation is generated by annotating the code with
+  [JSDoc](https://jsdoc.app/about-getting-started.html) comments.
+  [Example](https://github.com/badges/shields/blob/b3be4d94d5ef570b8daccfd088c343a958988843/core/base-service/base-json.js#L26-L41)
+- Adding a JSDoc comment to some existing code is a great first contribution
+  and a good way to familiarize yourself with the codebase
+
 ### Helping others
 
 You can help with code review, which reduces bugs, and over time has a
@@ -95,12 +105,11 @@ There are three places to get help:
 ## Badge URLs
 
 - The format of new badges should be of the form
-  `/SERVICE/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
-  `/gitter/room/nwjs/nw.js.svg`. The vendor is gitter, the
-  badge is for rooms, the parameter is nwjs/nw.js, and the format is svg.
-- For services which require a hostname, the badge should be of the form
-  `/SERVICE/SCHEME/HOST/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
-  `/discourse/https/discourse.example.com/topics.svg`.
+  `/SERVICE/NOUN/PARAMETERS/QUALIFIERS`. For instance,
+  `/gitter/room/nwjs/nw.js`. The vendor is gitter, the
+  badge is for rooms, and the parameter is nwjs/nw.js.
+- Services which require a url/hostname parameter should use a query parameter to accept that value. For instance,
+  `/discourse/topics?server=https://meta.discourse.org`.
 
 ## Coding guidelines
 

README.md

@@ -114,7 +114,7 @@ It also works with full URLs like
 Use `npm run debug:server` to start server in debug mode.
 [This recipe][nodemon debug] shows how to debug Node.js application in [VS Code][].
 
-Shields has experimental support for [Gitpod Beta][gitpod], a pre-configured development
+Shields has experimental support for [Gitpod][gitpod], a pre-configured development
 environment that runs in your browser. To use Gitpod, click the button below and
 sign in with GitHub. Gitpod also offers a browser add-on, though it is not required.
 Please report any Gitpod bugs, questions, or suggestions in issue

app.json

@@ -23,6 +23,14 @@
     "GH_TOKEN": {
       "description": "Configure the token to be used for the GitHub services.",
       "required": false
+    },
+    "TWITCH_CLIENT_ID": {
+      "description": "Configure the client id to be used for the Twitch service.",
+      "required": false
+    },
+    "TWITCH_CLIENT_SECRET": {
+      "description": "Configure the client secret to be used for the Twitch service.",
+      "required": false
     }
   },
   "formation": {

config/custom-environment-variables.yml

@@ -63,4 +63,6 @@ private:
   sl_insight_userUuid: 'SL_INSIGHT_USER_UUID'
   sl_insight_apiToken: 'SL_INSIGHT_API_TOKEN'
   sonarqube_token: 'SONARQUBE_TOKEN'
+  twitch_client_id: 'TWITCH_CLIENT_ID'
+  twitch_client_secret: 'TWITCH_CLIENT_SECRET'
   wheelmap_token: 'WHEELMAP_TOKEN'

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

@@ -7,4 +7,6 @@ private:
   shields_secret: ...
   sl_insight_userUuid: ...
   sl_insight_apiToken: ...
+  twitch_client_id: ...
+  twitch_client_secret: ...
   wheelmap_token: ...

config/local.template.yml

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

core/base-service/auth-helper.js

@@ -1,14 +1,26 @@
 'use strict'
 
 class AuthHelper {
-  constructor({ userKey, passKey, isRequired = false }, privateConfig) {
+  constructor(
+    {
+      userKey,
+      passKey,
+      isRequired = false,
+      defaultToEmptyStringForUser = false,
+    },
+    privateConfig
+  ) {
     if (!userKey && !passKey) {
       throw Error('Expected userKey or passKey to be set')
     }
 
     this._userKey = userKey
     this._passKey = passKey
-    this.user = userKey ? privateConfig[userKey] : undefined
+    if (userKey) {
+      this.user = privateConfig[userKey]
+    } else {
+      this.user = defaultToEmptyStringForUser ? '' : undefined
+    }
     this.pass = passKey ? privateConfig[passKey] : undefined
     this.isRequired = isRequired
   }

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

@@ -91,6 +91,13 @@ describe('AuthHelper', function() {
       given({ userKey: 'myci_user', passKey: 'myci_pass' }, {}).expect(
         undefined
       )
+      given(
+        { passKey: 'myci_pass', defaultToEmptyStringForUser: true },
+        { myci_pass: 'abc123' }
+      ).expect({
+        user: '',
+        pass: 'abc123',
+      })
     })
   })
 })

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

@@ -2,6 +2,7 @@
 
 const makeBadge = require('../../gh-badges/lib/make-badge')
 const BaseService = require('./base')
+const { MetricHelper } = require('./metric-helper')
 const { setCacheHeaders } = require('./cache-headers')
 const { makeSend } = require('./legacy-result-sender')
 const coalesceBadge = require('./coalesce-badge')
@@ -24,16 +25,19 @@ const { prepareRoute, namedParamsForMatch } = require('./route')
 // configured by the service, the user's request, and the server's default
 // cache length.
 module.exports = class NonMemoryCachingBaseService extends BaseService {
-  static register({ camp, requestCounter }, serviceConfig) {
+  static register({ camp, metricInstance }, serviceConfig) {
     const { cacheHeaders: cacheHeaderConfig } = serviceConfig
     const { _cacheLength: serviceDefaultCacheLengthSeconds } = this
     const { regex, captureNames } = prepareRoute(this.route)
 
-    const serviceRequestCounter = this._createServiceRequestCounter({
-      requestCounter,
+    const metricHelper = MetricHelper.create({
+      metricInstance,
+      ServiceClass: this,
     })
 
     camp.route(regex, async (queryParams, match, end, ask) => {
+      const metricHandle = metricHelper.startRequest()
+
       const namedParams = namedParamsForMatch(captureNames, match, this)
       const serviceData = await this.invoke(
         {},
@@ -64,7 +68,7 @@ module.exports = class NonMemoryCachingBaseService extends BaseService {
 
       makeSend(format, ask.res, end)(svg)
 
-      serviceRequestCounter.inc()
+      metricHandle.noteResponseSent()
     })
   }
 }

core/base-service/base-static.js

@@ -7,18 +7,20 @@ const {
   setCacheHeadersForStaticResource,
 } = require('./cache-headers')
 const { makeSend } = require('./legacy-result-sender')
+const { MetricHelper } = require('./metric-helper')
 const coalesceBadge = require('./coalesce-badge')
 const { prepareRoute, namedParamsForMatch } = require('./route')
 
 module.exports = class BaseStaticService extends BaseService {
-  static register({ camp, requestCounter }, serviceConfig) {
+  static register({ camp, metricInstance }, serviceConfig) {
     const {
       profiling: { makeBadge: shouldProfileMakeBadge },
     } = serviceConfig
     const { regex, captureNames } = prepareRoute(this.route)
 
-    const serviceRequestCounter = this._createServiceRequestCounter({
-      requestCounter,
+    const metricHelper = MetricHelper.create({
+      metricInstance,
+      ServiceClass: this,
     })
 
     camp.route(regex, async (queryParams, match, end, ask) => {
@@ -29,6 +31,8 @@ module.exports = class BaseStaticService extends BaseService {
         return
       }
 
+      const metricHandle = metricHelper.startRequest()
+
       const namedParams = namedParamsForMatch(captureNames, match, this)
       const serviceData = await this.invoke(
         {},
@@ -60,7 +64,7 @@ module.exports = class BaseStaticService extends BaseService {
 
       makeSend(format, ask.res, end)(svg)
 
-      serviceRequestCounter.inc()
+      metricHandle.noteResponseSent()
     })
   }
 }