feat: add info page for debugging

Author: joshunrau

.env.template

@@ -56,8 +56,6 @@ GATEWAY_API_KEY=
 DEBUG=false
 # Whether 'verbose' level logs should be enabled
 VERBOSE=false
-# Prevent heap allocation failure
-NODE_OPTIONS="--max-old-space-size=8192"
 # Enable rate limitting
 THROTTLER_ENABLED=true
 # Disable iteration for password hashing (not recommended for production)

.github/workflows/ci.yaml

@@ -74,6 +74,8 @@ jobs:
       - name: Build and Push Docker Images
         uses: docker/build-push-action@v6
         with:
+          build-args: |
+            RELEASE_VERSION=${{ needs.configure.outputs.current_version }}
           context: .
           file: ${{ matrix.dockerfile }}
           push: ${{ needs.configure.outputs.is_release }}

apps/api/Dockerfile

@@ -1,5 +1,6 @@
 FROM node:lts-alpine AS base
 WORKDIR /app
+ARG RELEASE_VERSION
 ENV GATEWAY_DATABASE_URL="file:/dev/null"
 ENV PNPM_HOME="/pnpm"
 ENV PATH="$PNPM_HOME:$PATH"

apps/api/package.json

@@ -5,7 +5,7 @@
   "private": true,
   "license": "Apache-2.0",
   "scripts": {
-    "build": "tsx scripts/build.ts",
+    "build": "NODE_ENV=production tsx scripts/build.ts",
     "db:generate": "prisma generate",
     "dev": "NODE_ENV=development env-cmd -f ../../.env tsx scripts/dev.ts",
     "dev:test": "NODE_ENV=test env-cmd -f ../../.env tsx scripts/dev.ts",
@@ -38,6 +38,7 @@
     "@opendatacapture/demo": "workspace:*",
     "@opendatacapture/instrument-library": "workspace:*",
     "@opendatacapture/instrument-utils": "workspace:*",
+    "@opendatacapture/release-info": "workspace:*",
     "@opendatacapture/runtime-core": "workspace:*",
     "@opendatacapture/runtime-v1": "workspace:*",
     "@opendatacapture/schemas": "workspace:*",

apps/api/scripts/build.ts

@@ -10,6 +10,8 @@ import type { BuildOptions } from 'esbuild';
 import esbuildPluginTsc from 'esbuild-plugin-tsc';
 const require = module.createRequire(import.meta.url);
 
+import { getReleaseInfo } from '@opendatacapture/release-info';
+
 const entryFile = path.resolve(import.meta.dirname, '../src/main.ts');
 const outdir = path.resolve(import.meta.dirname, '../dist');
 const tsconfig = path.resolve(import.meta.dirname, '../tsconfig.json');
@@ -25,6 +27,9 @@ const options: { external: NonNullable<unknown>; plugins: NonNullable<unknown> }
     js: "Object.defineProperties(globalThis, { __dirname: { value: import.meta.dirname, writable: false }, __filename: { value: import.meta.filename, writable: false }, require: { value: (await import('module')).createRequire(import.meta.url), writable: false } });"
   },
   bundle: true,
+  define: {
+    __RELEASE_INFO__: JSON.stringify(await getReleaseInfo())
+  },
   entryPoints: [entryFile],
   external: ['@nestjs/microservices', '@nestjs/websockets/socket-module', 'class-transformer', 'class-validator'],
   format: 'esm',

apps/api/src/gateway/gateway.controller.ts

@@ -0,0 +1,19 @@
+import { Controller, Get } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+import type { GatewayHealthcheckResult } from '@opendatacapture/schemas/gateway';
+
+import { RouteAccess } from '@/core/decorators/route-access.decorator';
+
+import { GatewayService } from './gateway.service';
+
+@ApiTags('Gateway')
+@Controller({ path: 'gateway' })
+export class GatewayController {
+  constructor(private readonly gatewayService: GatewayService) {}
+
+  @Get('healthcheck')
+  @RouteAccess([])
+  healthcheck(): Promise<GatewayHealthcheckResult> {
+    return this.gatewayService.healthcheck();
+  }
+}

apps/api/src/gateway/gateway.module.ts

@@ -8,10 +8,12 @@ import { InstrumentsModule } from '@/instruments/instruments.module';
 import { SessionsModule } from '@/sessions/sessions.module';
 import { SetupModule } from '@/setup/setup.module';
 
+import { GatewayController } from './gateway.controller';
 import { GatewayService } from './gateway.service';
 import { GatewaySynchronizer } from './gateway.synchronizer';
 
 @Module({
+  controllers: [GatewayController],
   exports: [GatewayService],
   imports: [
     forwardRef(() => AssignmentsModule),

apps/api/src/gateway/gateway.service.ts

@@ -8,6 +8,11 @@ import type {
   MutateAssignmentResponseBody,
   RemoteAssignment
 } from '@opendatacapture/schemas/assignment';
+import {
+  $GatewayHealthcheckSuccessResult,
+  type GatewayHealthcheckFailureResult,
+  type GatewayHealthcheckResult
+} from '@opendatacapture/schemas/gateway';
 
 import { InstrumentsService } from '@/instruments/instruments.service';
 
@@ -71,4 +76,30 @@ export class GatewayService {
     }
     return result.data;
   }
+
+  async healthcheck(): Promise<GatewayHealthcheckResult> {
+    const response = await this.httpService.axiosRef.get('/api/healthcheck');
+    if (response.status !== HttpStatus.OK) {
+      return {
+        ok: false,
+        status: response.status,
+        statusText: response.statusText
+      } satisfies GatewayHealthcheckFailureResult;
+    }
+    const result = await $GatewayHealthcheckSuccessResult.safeParseAsync(response.data);
+    if (!result.success) {
+      const statusText = 'Healthcheck data received from gateway do not match expected structure';
+      this.logger.error({
+        data: response.data as unknown,
+        error: result.error.format(),
+        message: `ERROR: ${statusText}`
+      });
+      return {
+        ok: false,
+        status: HttpStatus.INTERNAL_SERVER_ERROR,
+        statusText
+      };
+    }
+    return result.data;
+  }
 }

apps/api/src/setup/setup.service.ts

@@ -1,6 +1,6 @@
 import { ForbiddenException, Injectable } from '@nestjs/common';
 import { type CreateAdminData } from '@opendatacapture/schemas/setup';
-import type { InitAppOptions } from '@opendatacapture/schemas/setup';
+import type { InitAppOptions, SetupState } from '@opendatacapture/schemas/setup';
 
 import { ConfigurationService } from '@/configuration/configuration.service';
 import { DemoService } from '@/demo/demo.service';
@@ -28,8 +28,10 @@ export class SetupService {
     return {
       isDemo: Boolean(savedOptions?.isDemo),
       isGatewayEnabled: this.configurationService.get('GATEWAY_ENABLED'),
-      isSetup: Boolean(savedOptions?.isSetup)
-    };
+      isSetup: Boolean(savedOptions?.isSetup),
+      releaseInfo: __RELEASE_INFO__,
+      uptime: Math.round(process.uptime())
+    } satisfies SetupState;
   }
 
   async initApp({ admin, dummySubjectCount, initDemo, recordsPerSubject }: InitAppOptions) {

apps/api/src/typings/global.d.ts

@@ -0,0 +1,5 @@
+import type { ReleaseInfo } from '@opendatacapture/schemas/setup';
+
+declare global {
+  const __RELEASE_INFO__: ReleaseInfo;
+}