Fix substrate healthcheck (#43)

* Fix substrate healthcheck The substrate promise `isReadyOrError` when resolved is never re-evaluated. Therefore the previous implmentation didn't work. This change instead uses the `isConnected` property which is maintained and updated by the library * Wait for first connection or error * Remove only on test * Add tests for healthcheck service down * Update readme and helm chart with new envs * Move responses to fixture * Fix quotes
digicatapult · Apr 13, 2022 · 55d0862 · 55d0862
1 parent bd808a3
commit 55d0862
Show file tree

Hide file tree

Showing 11 changed files with 209 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -52,25 +52,27 @@ npm run test:integration
 
 The following environment variables are used by `dscp-api` and can be configured. Entries marked as `required` are needed when running `dscp-api` in production mode.
 
-| variable                      | required |                       default                       | description                                                                                  |
-| :---------------------------- | :------: | :-------------------------------------------------: | :------------------------------------------------------------------------------------------- |
-| PORT                          |    N     |                       `3001`                        | The port for the API to listen on                                                            |
-| API_HOST                      |    Y     |                          -                          | The hostname of the `dscp-node` the API should connect to                                    |
-| API_PORT                      |    N     |                       `9944`                        | The port of the `dscp-node` the API should connect to                                        |
-| LOG_LEVEL                     |    N     |                       `info`                        | Logging level. Valid values are [`trace`, `debug`, `info`, `warn`, `error`, `fatal`]         |
-| USER_URI                      |    Y     |                          -                          | The Substrate `URI` representing the private key to use when making `dscp-node` transactions |
-| IPFS_HOST                     |    Y     |                          -                          | Hostname of the `IPFS` node to use for metadata storage                                      |
-| IPFS_PORT                     |    N     |                       `15001`                       | Port of the `IPFS` node to use for metadata storage                                          |
-| AUTH_JWKS_URI                 |    N     | `https://inteli.eu.auth0.com/.well-known/jwks.json` | JSON Web Key Set containing public keys used by the Auth0 API                                |
-| AUTH_AUDIENCE                 |    N     |                    `inteli-dev`                     | Identifier of the Auth0 API                                                                  |
-| AUTH_ISSUER                   |    N     |           `https://inteli.eu.auth0.com/`            | Domain of the Auth0 API `                                                                    |
-| AUTH_TOKEN_URL                |    N     |      `https://inteli.eu.auth0.com/oauth/token`      | Auth0 API endpoint that issues an Authorisation (Bearer) access token                        |
-| METADATA_KEY_LENGTH           |    N     |                        `32`                         | Fixed length of metadata keys                                                                |
-| METADATA_VALUE_LITERAL_LENGTH |    N     |                        `32`                         | Fixed length of metadata LITERAL values                                                      |
-| MAX_METADATA_COUNT            |    N     |                        `16`                         | Maximum number of metadata items allowed per token                                           |
-| API_VERSION                   |    N     |               `package.json version`                | API version                                                                                  |
-| API_MAJOR_VERSION             |    N     |                        `v3`                         | API major version                                                                            |
-| FILE_UPLOAD_MAX_SIZE          |    N     |                 `200 * 1024 * 1024`                 | The Maximum file upload size (bytes)                                                         |
+| variable                        | required |                       default                       | description                                                                                  |
+| :------------------------------ | :------: | :-------------------------------------------------: | :------------------------------------------------------------------------------------------- |
+| PORT                            |    N     |                       `3001`                        | The port for the API to listen on                                                            |
+| API_HOST                        |    Y     |                          -                          | The hostname of the `dscp-node` the API should connect to                                    |
+| API_PORT                        |    N     |                       `9944`                        | The port of the `dscp-node` the API should connect to                                        |
+| LOG_LEVEL                       |    N     |                       `info`                        | Logging level. Valid values are [`trace`, `debug`, `info`, `warn`, `error`, `fatal`]         |
+| USER_URI                        |    Y     |                          -                          | The Substrate `URI` representing the private key to use when making `dscp-node` transactions |
+| IPFS_HOST                       |    Y     |                          -                          | Hostname of the `IPFS` node to use for metadata storage                                      |
+| IPFS_PORT                       |    N     |                       `15001`                       | Port of the `IPFS` node to use for metadata storage                                          |
+| AUTH_JWKS_URI                   |    N     | `https://inteli.eu.auth0.com/.well-known/jwks.json` | JSON Web Key Set containing public keys used by the Auth0 API                                |
+| AUTH_AUDIENCE                   |    N     |                    `inteli-dev`                     | Identifier of the Auth0 API                                                                  |
+| AUTH_ISSUER                     |    N     |           `https://inteli.eu.auth0.com/`            | Domain of the Auth0 API `                                                                    |
+| AUTH_TOKEN_URL                  |    N     |      `https://inteli.eu.auth0.com/oauth/token`      | Auth0 API endpoint that issues an Authorisation (Bearer) access token                        |
+| METADATA_KEY_LENGTH             |    N     |                        `32`                         | Fixed length of metadata keys                                                                |
+| METADATA_VALUE_LITERAL_LENGTH   |    N     |                        `32`                         | Fixed length of metadata LITERAL values                                                      |
+| MAX_METADATA_COUNT              |    N     |                        `16`                         | Maximum number of metadata items allowed per token                                           |
+| API_VERSION                     |    N     |               `package.json version`                | API version                                                                                  |
+| API_MAJOR_VERSION               |    N     |                        `v3`                         | API major version                                                                            |
+| FILE_UPLOAD_MAX_SIZE            |    N     |                 `200 * 1024 * 1024`                 | The Maximum file upload size (bytes)                                                         |
+| SUBSTRATE_STATUS_POLL_PERIOD_MS |    N     |                     `10 * 1000`                     | Number of ms between calls to check dscp-node status                                         |
+| SUBSTRATE_STATUS_TIMEOUT_MS     |    N     |                     `2 * 1000`                      | Number of ms to wait for response to dscp-node health requests                               |
 
 ## Running the API
 

diff --git a/app/env.js b/app/env.js
@@ -28,7 +28,7 @@ const vars = envalid.cleanEnv(process.env, {
   API_VERSION: envalid.str({ default: version }),
   API_MAJOR_VERSION: envalid.str({ default: 'v3' }),
   FILE_UPLOAD_MAX_SIZE: envalid.num({ default: 200 * 1024 * 1024 }),
-  SUBSTRATE_STATUS_POLL_PERIOD_MS: envalid.num({ default: 30 * 1000 }),
+  SUBSTRATE_STATUS_POLL_PERIOD_MS: envalid.num({ default: 10 * 1000 }),
   SUBSTRATE_STATUS_TIMEOUT_MS: envalid.num({ default: 2 * 1000 }),
 })
 

diff --git a/app/serviceStatus/apiStatus.js b/app/serviceStatus/apiStatus.js
@@ -3,35 +3,30 @@ const { substrateApi } = require('../util/substrateApi')
 const { SUBSTRATE_STATUS_POLL_PERIOD_MS, SUBSTRATE_STATUS_TIMEOUT_MS } = require('../env')
 
 const getStatus = async () => {
-  try {
-    await substrateApi.isReadyOrError
-    const [chain, runtime] = await Promise.all([substrateApi.runtimeChain, substrateApi.runtimeVersion])
+  await substrateApi.isReadyOrError.catch(() => {})
+  if (!substrateApi.isConnected) {
     return {
-      status: serviceState.UP,
+      status: serviceState.DOWN,
       detail: {
-        chain,
-        runtime: {
-          name: runtime.specName,
-          versions: {
-            spec: runtime.specVersion.toNumber(),
-            impl: runtime.implVersion.toNumber(),
-            authoring: runtime.authoringVersion.toNumber(),
-            transaction: runtime.transactionVersion.toNumber(),
-          },
-        },
+        message: 'Cannot connect to substrate node',
       },
     }
-  } catch (err) {
-    return {
-      status: serviceState.DOWN,
-      detail: !substrateApi.isConnected
-        ? {
-            message: 'Cannot connect to substrate node',
-          }
-        : {
-            message: 'Unknown error getting status from substrate node',
-          },
-    }
+  }
+  const [chain, runtime] = await Promise.all([substrateApi.runtimeChain, substrateApi.runtimeVersion])
+  return {
+    status: serviceState.UP,
+    detail: {
+      chain,
+      runtime: {
+        name: runtime.specName,
+        versions: {
+          spec: runtime.specVersion.toNumber(),
+          impl: runtime.implVersion.toNumber(),
+          authoring: runtime.authoringVersion.toNumber(),
+          transaction: runtime.transactionVersion.toNumber(),
+        },
+      },
+    },
   }
 }
 

diff --git a/helm/dscp-api/Chart.yaml b/helm/dscp-api/Chart.yaml
@@ -1,8 +1,8 @@
 apiVersion: v2
 name: dscp-api
-appVersion: '4.0.3'
+appVersion: '4.0.4'
 description: A Helm chart for dscp-api
-version: '4.0.3'
+version: '4.0.4'
 type: application
 dependencies:
   - name: dscp-node

diff --git a/helm/dscp-api/templates/configmap.yaml b/helm/dscp-api/templates/configmap.yaml
@@ -22,3 +22,5 @@ data:
   authAudience: {{ .Values.config.auth.audience }}
   authIssuer: {{ .Values.config.auth.issuer }}
   authTokenUrl: {{ .Values.config.auth.tokenUrl }}
+  substrateStatusPollPeriodMs: {{ .Values.config.substrateStatusPollPeriodMs | quote }}
+  substrateStatusTimeoutMs: {{ .Values.config.substrateStatusTimeoutMs | quote }}
diff --git a/helm/dscp-api/templates/deployment.yaml b/helm/dscp-api/templates/deployment.yaml
@@ -70,6 +70,16 @@ spec:
                 configMapKeyRef:
                   name: {{ include "dscp-api.fullname" . }}-config
                   key: authTokenUrl
+            - name: SUBSTRATE_STATUS_POLL_PERIOD_MS
+              valueFrom:
+                configMapKeyRef:
+                  name: {{ include "dscp-api.fullname" . }}-config
+                  key: substrateStatusPollPeriodMs
+            - name: SUBSTRATE_STATUS_TIMEOUT_MS
+              valueFrom:
+                configMapKeyRef:
+                  name: {{ include "dscp-api.fullname" . }}-config
+                  key: substrateStatusTimeoutMs
             - name: USER_URI
               valueFrom:
                 secretKeyRef:
@@ -88,4 +98,4 @@ spec:
             failureThreshold: 5
             timeoutSeconds: 3
             periodSeconds: 10
-          {{- end }}
+          {{- end }}
diff --git a/helm/dscp-api/values.yaml b/helm/dscp-api/values.yaml
@@ -7,6 +7,8 @@ config:
   # externalIpfsHost: "" # This overrides dscpIpfs.enabled when setting the IPFS_HOST envar
   # externalIpfsPort: 5001 # This overrides dscpIpfs.enabled when setting the IPFS_PORT envar
   enableLivenessProbe: true
+  substrateStatusPollPeriodMs: 10000
+  substrateStatusTimeoutMs: 2000
   auth:
     jwksUri: https://inteli.eu.auth0.com/.well-known/jwks.json
     audience: inteli-dev
@@ -24,7 +26,7 @@ replicaCount: 1
 image:
   repository: ghcr.io/digicatapult/dscp-api
   pullPolicy: IfNotPresent
-  tag: 'v4.0.3'
+  tag: 'v4.0.4'
 
 dscpNode:
   enabled: false

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dscp-api",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "DSCP API",
   "repository": {
     "type": "git",

diff --git a/test/helper/healthcheckFixtures.js b/test/helper/healthcheckFixtures.js
@@ -0,0 +1,47 @@
+const { API_VERSION } = require('../../app/env')
+
+const responses = {
+  ok: {
+    code: 200,
+    body: {
+      status: 'ok',
+      version: API_VERSION,
+      details: {
+        api: {
+          status: 'ok',
+          detail: {
+            chain: 'Development',
+            runtime: {
+              name: 'dscp',
+              versions: {
+                authoring: 1,
+                impl: 1,
+                spec: 300,
+                transaction: 1,
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  down: {
+    code: 503,
+    body: {
+      status: 'down',
+      version: API_VERSION,
+      details: {
+        api: {
+          status: 'down',
+          detail: {
+            message: 'Cannot connect to substrate node',
+          },
+        },
+      },
+    },
+  },
+}
+
+module.exports = {
+  responses,
+}