Add status endpoint (#515)

* Add status endpoint

* Prettier

Author: Fletch153

src/config/index.ts

@@ -90,6 +90,7 @@ export const BaseSettingsDefinition = {
       'The URL of the Redis server. Format: [redis[s]:]//[[user][:password@]][host][:port][/db-number][?db=db-number[&password=bar[&option=value]]]',
     type: 'string',
     validate: validator.url(),
+    sensitive: true,
   },
   CACHE_TYPE: {
     description: 'The type of cache to use throughout the EA',
@@ -302,6 +303,7 @@ export const BaseSettingsDefinition = {
     description: 'Base64 Private Key of TSL/SSL certificate',
     type: 'string',
     validate: validator.base64(),
+    sensitive: true,
   },
   TLS_PUBLIC_KEY: {
     description: 'Base64 Public Key of TSL/SSL certificate',
@@ -312,10 +314,12 @@ export const BaseSettingsDefinition = {
     description: 'Password to be used to generate an encryption key',
     type: 'string',
     default: '',
+    sensitive: true,
   },
   TLS_CA: {
     description: 'CA certificate to use for authenticating client certificates',
     type: 'string',
+    sensitive: true,
   },
   MAX_HTTP_REQUEST_QUEUE_LENGTH: {
     description:

src/debug/router.ts

@@ -1,7 +1,8 @@
 import { FastifyInstance } from 'fastify'
 import { join } from 'path'
 import { Adapter } from '../adapter'
-import settingsPage, { buildDebugSettingsList } from './settings-page'
+import settingsPage from './settings-page'
+import { buildSettingsList } from '../util/settings'
 
 /**
  * This function registers the debug endpoints for the adapter.
@@ -13,7 +14,7 @@ import settingsPage, { buildDebugSettingsList } from './settings-page'
 export default function registerDebugEndpoints(app: FastifyInstance, adapter: Adapter) {
   // Debug endpoint to return the current settings in raw JSON (censoring sensitive values)
   app.get(join(adapter.config.settings.BASE_URL, '/debug/settings/raw'), async () => {
-    const censoredSettings = buildDebugSettingsList(adapter)
+    const censoredSettings = buildSettingsList(adapter)
     return JSON.stringify(
       censoredSettings.sort((a, b) => a.name.localeCompare(b.name)),
       null,
@@ -23,7 +24,7 @@ export default function registerDebugEndpoints(app: FastifyInstance, adapter: Ad
 
   // Helpful UI to visualize current settings
   app.get(join(adapter.config.settings.BASE_URL, '/debug/settings'), (req, reply) => {
-    const censoredSettings = buildDebugSettingsList(adapter)
+    const censoredSettings = buildSettingsList(adapter)
     const censoredSettingsPage = settingsPage(censoredSettings)
     reply.headers({ 'content-type': 'text/html' }).send(censoredSettingsPage)
   })

src/debug/settings-page.ts

@@ -1,25 +1,4 @@
-import { Adapter } from '../adapter'
-import { SettingDefinitionDetails } from '../config'
-import { censor } from '../util'
-import CensorList from '../util/censor/censor-list'
-
-export type DebugPageSetting = SettingDefinitionDetails & { name: string; value: unknown }
-
-export const buildDebugSettingsList = (adapter: Adapter): DebugPageSetting[] => {
-  // Censor EA settings
-  const settings = adapter.config.settings
-  const censoredValues = CensorList.getAll()
-  const censoredSettings: Array<SettingDefinitionDetails & { name: string; value: unknown }> = []
-  for (const [key, value] of Object.entries(settings)) {
-    const definitionDetails = adapter.config.getSettingDebugDetails(key)
-    censoredSettings.push({
-      name: key,
-      ...definitionDetails,
-      value: censor(value, censoredValues),
-    })
-  }
-  return censoredSettings
-}
+import { DebugPageSetting } from '../util/settings'
 
 // To enable syntax highlighting in VSCode, you can download the "Comment tagged templates" extension:
 // https://marketplace.visualstudio.com/items?itemName=bierner.comment-tagged-templates

src/index.ts

@@ -16,6 +16,7 @@ import {
 } from './util'
 import { errorCatchingMiddleware, validatorMiddleware } from './validation'
 import { EmptyInputParameters } from './validation/input-params'
+import registerStatusEndpoint from './status/router'
 
 export { FastifyInstance as ServerInstance }
 
@@ -210,6 +211,9 @@ async function buildRestApi(adapter: Adapter) {
     logger.info('Serving debug endpoints')
   }
 
+  // Register status endpoint
+  registerStatusEndpoint(app, adapter)
+
   // Use global error handling
   app.setErrorHandler(errorCatchingMiddleware)
 

src/status/router.ts

@@ -0,0 +1,91 @@
+import { FastifyInstance } from 'fastify'
+import { join } from 'path'
+import { hostname } from 'os'
+import { Adapter } from '../adapter'
+import { buildSettingsList } from '../util/settings'
+
+export interface StatusResponse {
+  adapter: {
+    name: string
+    version: string
+    uptimeSeconds: number
+  }
+  endpoints: {
+    name: string
+    aliases: string[]
+    transports: string[]
+  }[]
+  defaultEndpoint: string
+  configuration: {
+    name: string
+    value: unknown
+    type: string
+    description: string
+    required: boolean
+    default: unknown
+    customSetting: boolean
+    envDefaultOverride: unknown
+  }[]
+  runtime: {
+    nodeVersion: string
+    platform: string
+    architecture: string
+    hostname: string
+  }
+  metrics: {
+    enabled: boolean
+    port?: number
+    endpoint?: string
+  }
+}
+
+/**
+ * This function registers the status endpoint for the adapter.
+ * This endpoint provides comprehensive information about the adapter including:
+ * - Adapter metadata (name, version, commit)
+ * - Configuration (obfuscated sensitive values)
+ * - Runtime information
+ * - Dependencies status
+ * - Endpoints and transports
+ *
+ * @param app - the fastify instance that has been created
+ * @param adapter - the adapter for which to create the status endpoint
+ */
+export default function registerStatusEndpoint(app: FastifyInstance, adapter: Adapter) {
+  // Status endpoint that returns comprehensive adapter information
+  app.get(join(adapter.config.settings.BASE_URL, '/status'), async () => {
+    const metricsEndpoint = adapter.config.settings.METRICS_USE_BASE_URL
+      ? join(adapter.config.settings.BASE_URL, 'metrics')
+      : '/metrics'
+
+    const statusResponse: StatusResponse = {
+      adapter: {
+        name: adapter.name,
+        version: process.env['npm_package_version'] || 'unknown',
+        uptimeSeconds: process.uptime(),
+      },
+      endpoints: adapter.endpoints.map((endpoint) => ({
+        name: endpoint.name,
+        aliases: endpoint.aliases || [],
+        transports: endpoint.transportRoutes.routeNames(),
+      })),
+      defaultEndpoint: adapter.defaultEndpoint || '',
+      configuration: buildSettingsList(adapter),
+      runtime: {
+        nodeVersion: process.version,
+        platform: process.platform,
+        architecture: process.arch,
+        hostname: hostname(),
+      },
+      metrics: {
+        enabled: adapter.config.settings.METRICS_ENABLED,
+        port: adapter.config.settings.METRICS_ENABLED
+          ? adapter.config.settings.METRICS_PORT
+          : undefined,
+        endpoint: adapter.config.settings.METRICS_ENABLED ? metricsEndpoint : undefined,
+      },
+    }
+
+    return statusResponse
+  })
+}

src/util/settings.ts

@@ -0,0 +1,28 @@
+import { Adapter } from '../adapter'
+import { SettingDefinitionDetails } from '../config'
+import { censor } from './index'
+import CensorList from './censor/censor-list'
+
+export type DebugPageSetting = SettingDefinitionDetails & { name: string; value: unknown }
+
+/**
+ * Builds a list of adapter settings with sensitive values censored
+ * Used by both debug settings page and status endpoint
+ */
+export const buildSettingsList = (adapter: Adapter): DebugPageSetting[] => {
+  // Censor EA settings
+  const settings = adapter.config.settings
+  const censoredValues = CensorList.getAll()
+  const censoredSettings: Array<SettingDefinitionDetails & { name: string; value: unknown }> = []
+
+  for (const [key, value] of Object.entries(settings)) {
+    const definitionDetails = adapter.config.getSettingDebugDetails(key)
+    censoredSettings.push({
+      name: key,
+      ...definitionDetails,
+      value: censor(value, censoredValues),
+    })
+  }
+
+  return censoredSettings.sort((a, b) => a.name.localeCompare(b.name))
+}

test/config.test.ts

@@ -1,5 +1,11 @@
 import test from 'ava'
-import { AdapterConfig, getEnv, SettingDefinition, SettingsDefinitionMap } from '../src/config'
+import {
+  AdapterConfig,
+  BaseSettingsDefinition,
+  getEnv,
+  SettingDefinition,
+  SettingsDefinitionMap,
+} from '../src/config'
 import { validator } from '../src/validation/utils'
 
 test.afterEach(async () => {
@@ -161,3 +167,23 @@ test.serial('Test validate function (scientific notation)', async (t) => {
     t.fail()
   }
 })
+
+test('sensitive configuration constants are properly flagged', (t) => {
+  // Extract all settings that are marked as sensitive
+  const actualSensitiveSettings = Object.entries(BaseSettingsDefinition)
+    .filter(([_, setting]) => (setting as { sensitive?: boolean }).sensitive === true)
+    .map(([name]) => name)
+    .sort()
+
+  // Expected list of settings that should be marked as sensitive
+  const expectedSensitiveSettings = [
+    'CACHE_REDIS_PASSWORD',
+    'CACHE_REDIS_URL',
+    'TLS_CA',
+    'TLS_PASSPHRASE',
+    'TLS_PRIVATE_KEY',
+  ].sort()
+
+  // Deep equal comparison
+  t.deepEqual(actualSensitiveSettings, expectedSensitiveSettings)
+})

test/debug-endpoints.test.ts

@@ -2,7 +2,7 @@ import test from 'ava'
 import { start } from '../src'
 import { Adapter } from '../src/adapter'
 import { AdapterConfig } from '../src/config'
-import { DebugPageSetting } from '../src/debug/settings-page'
+import { DebugPageSetting } from '../src/util/settings'
 
 test.serial('debug endpoints return 404 if env var is omitted', async (t) => {
   process.env['DEBUG_ENDPOINTS'] = undefined