feat: make readiness logic configurable (#29)

* feat: make readiness logic configurable

* fix: readiness logic

* docs: update readme

---------

Co-authored-by: Gergely Békési <gergely.bekesi@ethswarm.org>

Author: slapec93

README.md

@@ -70,6 +70,7 @@ When `HOSTNAME` is set, the gateway resolves subdomains against the Bee node:
 | DATABASE_CONFIG           | —                         | MySQL connection as JSON: `{"user":"","password":"","host":"","port":3306,"database":"","ssl":{"ca":"..."}}`. If unset, all database-backed features are disabled. |
 | DATABASE_PASSWORD         | —                         | MySQL password (overrides the `password` field in `DATABASE_CONFIG`)                    |
 | MATTERMOST_WEBHOOK_URL    | —                         | URL of the Mattermost incoming webhook used for alerts                                  |
+| READINESS_MODE            | `normal`                  | `normal`: check only Bee readiness, `strict`: check Bee readiness and Bee depth         |
 
 ## Maintainers
 

src/config.ts

@@ -1,14 +1,19 @@
 import { Duration } from '@ethersphere/bee-js'
 import { Types } from 'cafe-utility'
 
+export enum ReadinessMode {
+    Strict = 'strict',
+    Normal = 'normal'
+}
+
 export interface AppConfig {
     beeApiUrl: string
     hostname: string
     authorization?: string
     instanceName?: string
     moderationSecret?: string
     removePinHeader?: boolean
-    readinessCheck?: boolean
+    readinessMode?: ReadinessMode
     homepage?: string
     mattermostWebhookUrl?: string
 }
@@ -39,6 +44,7 @@ export type EnvironmentVariables = Partial<{
     // Server
     PORT: string
     HOSTNAME: string
+    READINESS_MODE: ReadinessMode
 
     // Moderation
     MODERATION_SECRET: string
@@ -87,6 +93,7 @@ export function getAppConfig(env: EnvironmentVariables): AppConfig {
         removePinHeader: env.REMOVE_PIN_HEADER ? env.REMOVE_PIN_HEADER === 'true' : true,
         homepage: env.HOMEPAGE,
         mattermostWebhookUrl: env.MATTERMOST_WEBHOOK_URL,
+        readinessMode: env.READINESS_MODE === ReadinessMode.Strict ? ReadinessMode.Strict : ReadinessMode.Normal
     }
 }
 

src/readiness.ts

@@ -2,11 +2,15 @@ import { Bee } from '@ethersphere/bee-js'
 import { READINESS_TIMEOUT_MS } from './config'
 import { logger } from './logger'
 
-export async function checkReadiness(bee: Bee): Promise<boolean> {
+export async function checkReadiness(bee: Bee, strict: boolean): Promise<boolean> {
     try {
-        const health = await bee.getHealth({ timeout: READINESS_TIMEOUT_MS })
+        const readiness = await bee.getReadiness({ timeout: READINESS_TIMEOUT_MS })
+        const isReady = readiness.status === 'ready'
+        if (!strict) {
+            return isReady
+        }
         const topology = await bee.getTopology({ timeout: READINESS_TIMEOUT_MS })
-        return health.status === 'ok' && topology.depth >= 1 && topology.depth < 31
+        return isReady && topology.depth >= 1 && topology.depth < 31
     } catch (error) {
         logger.error('failed to check readiness', error)
         return false

src/server.ts

@@ -4,7 +4,7 @@ import bodyParser from 'body-parser'
 import { Arrays, Strings, Types } from 'cafe-utility'
 import express, { Application, NextFunction, Request, Response } from 'express'
 import { checkChallenge, createChallenge } from './challenge'
-import { AppConfig } from './config'
+import { AppConfig, ReadinessMode } from './config'
 import { ApprovalRequests } from './database/ApprovalRequests'
 import { runQuery } from './database/Database'
 import { Reports } from './database/Reports'
@@ -78,7 +78,7 @@ export function createApp(config: AppConfig, stampManager: StampManager): Applic
     }
 
     app.get('/readiness', async (_req, res) => {
-        const ready = await checkReadiness(bee)
+        const ready = await checkReadiness(bee, config.readinessMode === ReadinessMode.Strict)
 
         if (ready) {
             res.sendStatus(200)