Merge pull request #3 from alkem-io/develop

Release: Fixes, Events

Author: valentinyanakiev

.travis.yml

@@ -1,3 +1,4 @@
+dist: focal
 language: node_js
 node_js:
   - v20.12.1
@@ -11,5 +12,3 @@ install:
   - npm install
 before_install:
   - npm i -g [email protected]
-script:
-  - npm run test:ci

README.md

@@ -1,73 +1,31 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
-## Installation
-
-```bash
-$ npm install
-```
-
-## Running the app
-
-```bash
-# development
-$ npm run start
-
-# watch mode
-$ npm run start:dev
-
-# production mode
-$ npm run start:prod
-```
-
-## Test
-
-```bash
-# unit tests
-$ npm run test
-
-# e2e tests
-$ npm run test:e2e
-
-# test coverage
-$ npm run test:cov
-```
-
-## Support
-
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
-
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
-
-## License
-
-Nest is [MIT licensed](LICENSE).
+# Whiteboard collaboration service
+A NestJS backend service to enable real-time collaboration on a whiteboards.
+
+## Features
+- Authentication & Authorization
+- Inactivity tracker
+- Contribution tracker
+- Auto safe
+- Real-time collaboration
+
+## Implementation
+<img src="docs/images/diagram.png" alt="Component Diagram" width="600" />
+
+1. A client is requesting to connect to the collaboration service.
+The service will consult with the alkemio-server through a message queue who is this client.
+If the client is authenticated the client can join.
+2. A client is requesting to collaborate on a whiteboard.
+The service will consult with the alkemio-server through a message queue if this client is authorized to do so.
+3. If the client is authorized, the alkemio-server will return information regarding the whiteboard
+- the access levels
+- is it multi-user
+- how many users can collaborate at a time
+- the collaboration level of the client
+4. Trackers
+- Inactivity - If the user hasn't been activty for a while, based on inactivity interactions with the whiteboard,
+the service will reduce the collaboration level to view-only.
+The client is also notified of this change, so it can take proper actions, like changing the view, disabling controls, etc.
+- Contributions - If the user has made contributions in a certain time window, the service will notify the alkemio-server,
+so it can register a contribution.
+- Auto save - The service will auto save the whiteboard state to the database on intervals.
+The current implementation will ask users of the whiteboard, with the appropriate access in a random fashion to save it.

config.yml

@@ -1,30 +1,53 @@
 rabbitmq:
-  # Connection in the form of 'amqp://[user]:[password]@[host]:[port]?heartbeat=30'
+  # Connection in the form of 'amqp://[user]:[password]@[host]:[port]?heartbeat=[heartbeat]'
   connection:
     # RabbitMQ host
     host: ${RABBITMQ_HOST}:localhost
-
     # RabbitMQ AMQP port. Used by AMQP 0-9-1 and 1.0 clients without and with TLS
     port: ${RABBITMQ_PORT}:5672
-
     # RabbitMQ user
     user: ${RABBITMQ_USER}:alkemio-admin
-
     # RabbitMQ password
     password: ${RABBITMQ_PASSWORD}:alkemio!
+    # heartbeat
+    heartbeat: ${RABBITMQ_HEARTBEAT}:30
+
+monitoring:
+  logging:
+    # A flag setting whether Winston Console transport will be enabled.
+    # If the flag is set to true logs of the appropriate level (see below) will be outputted to the console
+    # after the application has been bootstrapped.
+    # The NestJS bootstrap process is handled by the internal NestJS logging.
+    enabled: ${LOGGING_CONSOLE_ENABLED}:true
+    # Logging level for outputs to console.
+    # Valid values are log|error|warn|debug|verbose.
+    level: ${LOGGING_LEVEL_CONSOLE}:verbose
+    # The logging format will be in json - useful for parsing
+    # if disabled - will be in a human-readable form
+    json: ${LOGGING_FORMAT_JSON}:false
 
 settings:
-  enabled: ${ENABLED}:true
-  # the window in which contributions are accepted to be counted towards a single contribution event;
-  # time is in SECONDS
-  contribution_window: ${CONTRIBUTION_WINDOW}:600
-  # SECONDS between saves
-  save_interval: ${AUTOSAVE_INTERVAL}:15
-  # SECONDS to wait after the request is saved, before it fails
-  save_timeout: ${AUTOSAVE_TIMEOUT}:10
-  # SECONDS of inactivity before a collaborator is made view-only
-  collaborator_inactivity: ${COLLABORATOR_INACTIVITY}:1800
-  # 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
+  # application level settings
+  application:
+    # queue
+    queue: ${QUEUE}:auth
+    # MILLISECONDS wait time for a response after a request on the message queue
+    queue_response_timeout: ${QUEUE_RESPONSE_TIMEOUT}:10000
+  # the collaboration experience
+  collaboration:
+    enabled: ${ENABLED}:true
+    #
+    port: ${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
+    # SECONDS between saves
+    save_interval: ${AUTOSAVE_INTERVAL}:15
+    # SECONDS to wait after the request is saved, before it fails
+    save_timeout: ${AUTOSAVE_TIMEOUT}:10
+    # SECONDS of inactivity before a collaborator is made view-only
+    collaborator_inactivity: ${COLLABORATOR_INACTIVITY}:1800
+    # 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

docs/images/diagram.png

@@ -1,6 +1,6 @@
 {
   "name": "whiteboard-collaboration-service",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Alkemio Whiteboard Collaboration Service for Excalidraw backend",
   "author": "Alkemio Foundation",
   "private": false,
@@ -32,7 +32,7 @@
     "rxjs": "^7.8.1",
     "socket.io": "^4.7.5",
     "socket.io-adapter": "^2.5.4",
-    "yaml": "^2.0.0-7"
+    "yaml": "^2.4.2"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.0.0",

package-lock.json

@@ -0,0 +1,33 @@
+export interface ConfigType {
+  rabbitmq: {
+    connection: {
+      host: string;
+      port: number;
+      user: string;
+      password: string;
+      heartbeat: number;
+    };
+  };
+  monitoring: {
+    logging: {
+      enabled: boolean;
+      level: string;
+      json: boolean;
+    };
+  };
+  settings: {
+    application: {
+      queue: string;
+      queue_response_timeout: number;
+    };
+    collaboration: {
+      enabled: boolean;
+      port: number;
+      contribution_window: number;
+      save_interval: number;
+      save_timeout: number;
+      collaborator_inactivity: number;
+      reset_collaborator_mode_debounce: number;
+    };
+  };
+}

package.json

@@ -1,8 +1,6 @@
 import { readFileSync } from 'fs';
 import { join } from 'path';
-// import YAML from 'yaml';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const YAML = require('yaml'); // todo: WHY??
+import * as YAML from 'yaml';
 
 const YAML_CONFIG_FILENAME = 'config.yml';
 
@@ -16,7 +14,7 @@ export default () => {
   const envConfig = process.env;
 
   YAML.visit(doc, {
-    Scalar(key: any, node: { type: string; value: any }) {
+    Scalar(key, node) {
       if (node.type === 'PLAIN') {
         node.value = buildYamlNodeValue(node.value, envConfig);
       }

src/config/config.type.ts

@@ -0,0 +1,3 @@
+export * from './config.type';
+export * from './configuration';
+export * from './winston.config';

src/config/configuration.ts

@@ -2,14 +2,16 @@ import { Injectable } from '@nestjs/common';
 import * as winston from 'winston';
 import { utilities as nestWinstonModuleUtilities } from 'nest-winston';
 import * as logform from 'logform';
+import { ConfigService } from '@nestjs/config';
+import { ConfigType } from './config.type';
 
-const LOG_LABEL = 'alkemio-server';
+const LOG_LABEL = 'alkemio-whiteboard-collaboration';
 
 const consoleLoggingStandardFormat: logform.Format[] = [
   winston.format.timestamp(),
   nestWinstonModuleUtilities.format.nestLike(undefined, {
     colors: true,
-    prettyPrint: false,
+    prettyPrint: true,
   }),
 ];
 
@@ -21,19 +23,22 @@ const consoleLoggingProdFormat: logform.Format[] = [
 
 @Injectable()
 export class WinstonConfigService {
-  constructor() {}
-
-  async createWinstonModuleOptions() {
-    const json = false;
-    const consoleEnabled = true;
+  constructor(
+    private readonly configService: ConfigService<ConfigType, true>,
+  ) {}
 
+  createWinstonModuleOptions() {
+    const { enabled, level, json } = this.configService.get(
+      'monitoring.logging',
+      { infer: true },
+    );
     const transports: any[] = [
       new winston.transports.Console({
         format: winston.format.combine(
           ...(json ? consoleLoggingProdFormat : consoleLoggingStandardFormat),
         ),
-        level: 'verbose',
-        silent: !consoleEnabled,
+        level,
+        silent: !enabled,
       }),
     ];
 

src/config/index.ts

@@ -1,18 +1,17 @@
-// import http from 'http';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const http = require('http'); // todo why is that?
+import * as http from 'node:http';
+import { LoggerService } from '@nestjs/common';
 import { Namespace, Server as SocketIO } from 'socket.io';
 import { Adapter } from 'socket.io-adapter';
 import { SocketIoServer } from './types';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+
 export const getExcalidrawBaseServerOrFail = (
+  port: number,
+  logger: LoggerService,
   adapterFactory?: typeof Adapter | ((nsp: Namespace) => Adapter),
-): SocketIoServer | never => {
-  const port = 4002;
-
+): SocketIoServer => {
   const httpServer = http.createServer();
   httpServer.listen(port, () => {
-    console.log('Listening on port', port);
+    logger.verbose?.(`Listening on port ${port}`);
   });
 
   return new SocketIO(httpServer, {