Merge pull request #10 from alkem-io/develop

Release v0.3.1

Author: valentinyanakiev

config.yml

@@ -37,7 +37,7 @@ settings:
   collaboration:
     enabled: ${ENABLED}:true
     #
-    port: ${PORT}:4002
+    port: ${COLLABORATION_PORT}:4002
     # the window in which contributions are accepted to be counted towards a single contribution event;
     # time is in SECONDS
     contribution_window: ${CONTRIBUTION_WINDOW}:600
@@ -50,4 +50,7 @@ settings:
     # how often the inactivity timer is reset;
     # you want it to be large enough to not reset too frequently,
     # but small enough to be accurate
-    reset_collaborator_mode_debounce: ${INACTIVITY_DEBOUNCE}:1000
+    reset_collaborator_mode_debounce: ${INACTIVITY_DEBOUNCE}:1000
+  rest:
+    # the REST API
+    port: ${REST_PORT}:4005

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "whiteboard-collaboration-service",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Alkemio Whiteboard Collaboration Service for Excalidraw backend",
   "author": "Alkemio Foundation",
   "private": false,
@@ -31,7 +31,7 @@
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1",
     "socket.io": "^4.7.5",
-    "socket.io-adapter": "^2.5.4",
+    "socket.io-adapter": "^2.5.5",
     "yaml": "^2.4.2"
   },
   "devDependencies": {

package.json

@@ -4,10 +4,13 @@ import { ConfigModule } from '@nestjs/config';
 import { WinstonConfigService } from './config/winston.config';
 import { ServerModule } from './excalidraw-backend/server.module';
 import configuration from './config/configuration';
+import { HealthController } from './services/health/health.controller';
+import { HealthModule } from './services/health/health.module';
 
 @Module({
   imports: [
     ServerModule,
+    HealthModule,
     ConfigModule.forRoot({
       envFilePath: ['.env'],
       isGlobal: true,

src/app.module.ts

@@ -29,5 +29,8 @@ export interface ConfigType {
       collaborator_inactivity: number;
       reset_collaborator_mode_debounce: number;
     };
+    rest: {
+      port: number;
+    };
   };
 }

src/config/config.type.ts

@@ -11,7 +11,7 @@ export const getExcalidrawBaseServerOrFail = (
 ): SocketIoServer => {
   const httpServer = http.createServer();
   httpServer.listen(port, () => {
-    logger.verbose?.(`Listening on port ${port}`);
+    logger.verbose?.(`Collaboration endpoint Listening on port ${port}`);
   });
 
   return new SocketIO(httpServer, {

src/excalidraw-backend/get.excalidraw.base.server.ts

@@ -1,6 +1,8 @@
 import { NestFactory } from '@nestjs/core';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { AppModule } from './app.module';
+import { ConfigService } from '@nestjs/config';
+import { ConfigType } from './config';
 
 (async () => {
   const app = await NestFactory.create(AppModule, {
@@ -14,4 +16,12 @@ import { AppModule } from './app.module';
   });
   const logger = app.get(WINSTON_MODULE_NEST_PROVIDER);
   app.useLogger(logger);
+
+  const configService: ConfigService<ConfigType, true> = app.get(ConfigService);
+  const port = configService.get('settings.rest.port', {
+    infer: true,
+  });
+  await app.listen(port, () => {
+    logger.verbose?.(`Rest endpoint running on port ${port}`);
+  });
 })();

src/main.ts

@@ -0,0 +1,17 @@
+import { Controller, Get, HttpException, HttpStatus } from '@nestjs/common';
+import { WhiteboardIntegrationService } from '../whiteboard-integration/whiteboard.integration.service';
+
+@Controller('/health')
+export class HealthController {
+  constructor(
+    private readonly integrationService: WhiteboardIntegrationService,
+  ) {}
+  @Get('/')
+  public async healthCheck(): Promise<string> {
+    if (!(await this.integrationService.isConnected())) {
+      throw new HttpException('unhealthy!', HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+    return 'healthy!';
+  }
+}

src/services/health/health.controller.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { HealthController } from './health.controller';
+import { WhiteboardIntegrationModule } from '../whiteboard-integration/whiteboard.integration.module';
+
+@Module({
+  imports: [WhiteboardIntegrationModule],
+  controllers: [HealthController],
+})
+export class HealthModule {}

src/services/health/health.module.ts

@@ -1,5 +1,5 @@
 export enum WhiteboardIntegrationMessagePattern {
-  ACCESS_GRANTED = 'accessGranted',
   WHO = 'who',
   INFO = 'info',
+  HEALTH_CHECK = 'health-check',
 }

src/services/whiteboard-integration/message.pattern.enum.ts

@@ -0,0 +1,3 @@
+export class BaseOutputData {
+  constructor(public event: string) {}
+}

src/services/whiteboard-integration/outputs/base.output.data.ts

@@ -0,0 +1,7 @@
+import { BaseOutputData } from './base.output.data';
+
+export class HealthCheckOutputData extends BaseOutputData {
+  constructor(public healthy: boolean) {
+    super('health-check-output');
+  }
+}

src/services/whiteboard-integration/outputs/health.check.output.data.ts

@@ -1 +1,2 @@
 export * from './info.output.data';
+export * from './health.check.output.data';

src/services/whiteboard-integration/outputs/index.ts

@@ -0,0 +1 @@
+export * from './rmq.connection.error';

src/services/whiteboard-integration/types/index.ts

@@ -0,0 +1,14 @@
+export type RMQConnectionError = {
+  err: {
+    stack: string;
+    message: string;
+  };
+  url: {
+    protocol: string;
+    hostname: string;
+    username: string;
+    password: string;
+    port: number;
+    heartbeat: number;
+  };
+};