Merge pull request #7 from Inist-CNRS/feat/dev-mode

Add a development mode

.editorconfig

@@ -17,3 +17,11 @@ tab_width = 2
 indent_size = 2
 tab_width = 2
 
+[package-lock.json]
+indent_size = 2
+tab_width = 2
+
+[package.json]
+indent_size = 2
+tab_width = 2
+

.gitignore

@@ -5,4 +5,8 @@ tdm-fe/.next/
 .gitlab-ci.yml
 helm/*
 tdm-be/environment-recette.ts
-.idea
+.idea
+tdm-be/uploads/*
+!tdm-be/uploads/.keep
+tdm-be/dynamic-config.json
+tdm-be/logs/*

Dockerfile

@@ -58,7 +58,7 @@ FROM node:18.19-bullseye-slim AS application
 # Add ezmaster config file
 RUN echo '{ \
     "httpPort": 3000, \
-    "configPath": "/app/config/default.json", \
+    "configPath": "/app/config/production.json", \
     "dataPath": "/app" \
     }' > /etc/ezmaster.json
 

Makefile

@@ -4,3 +4,14 @@ install:
 	cd ../tdm-fe && \
 	npm install && \
 	cd ..
+
+
+run-dev:
+	docker compose -f docker-compose.dev.yml up --force-recreate
+
+update-front-api:
+	cd tdm-be && \
+	npm run swagger-autogen && \
+	cd ../tdm-fe && \
+	npm run generate-api && \
+	cd ..

docker-compose.dev.yml

@@ -0,0 +1,44 @@
+version: "3.5"
+
+services:
+  tdm-factory-backend:
+    container_name: tdm-factory-dev-backend
+    image: node:18.19-bullseye-slim
+    environment:
+      NODE_ENV: development
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./tdm-be:/app
+    working_dir: /app
+    command: npm run dev
+    networks:
+      - tdm-factory-network
+
+  tdm-factory-frontend:
+    container_name: tdm-factory-dev-frontend
+    image: node:18.19-bullseye-slim
+    environment:
+      NODE_ENV: development
+    ports:
+      - "8080:8080"
+    volumes:
+      - ./tdm-fe:/app
+    working_dir: /app
+    command: npm run dev
+    networks:
+      - tdm-factory-network
+
+  tdm-factory-maildev:
+    container_name: tdm-factory-dev-maildev
+    image: maildev/maildev
+    ports:
+      - "1025:1025"
+      - "1080:1080"
+    networks:
+      - tdm-factory-network
+
+networks:
+  tdm-factory-network:
+    driver: bridge
+    name: tdm-factory-network

tdm-be/config/default.json

@@ -1,34 +1,9 @@
 {
-  "port": 3000,
-  "password": "",
-  "hosts": {
-    "internal": {
-      "host": "",
-      "isHttps": false
-    },
-    "external": {
-      "host": "",
-      "isHttps": false
+    "port": 3000,
+    "password": "",
+    "fileFolder": "uploads/",
+    "cron": {
+        "schedule": "0 0 * * *",
+        "deleteFileOlderThan": 7
     }
-  },
-  "smtp": {
-    "host": "maildev",
-    "port": 1025,
-    "auth": {
-      "user": "",
-      "pass": ""
-    },
-    "secure": false,
-    "tls": {
-      "ignore": true,
-      "rejectUnauthorized": false
-    }
-  },
-  "fileFolder": "uploads/",
-  "dumpFile": "dump.tar.gz",
-  "finalFile": "final.tar.gz",
-  "cron": {
-    "schedule": "0 0 * * *",
-    "deleteFileOlderThan": 7
-  }
-}
+}

tdm-be/config/development.json

@@ -0,0 +1,21 @@
+{
+    "hosts": {
+        "internal": {
+            "host": "{ngrok host}",
+            "isHttps": true
+        },
+        "external": {
+            "host": "http://localhost:8080",
+            "isHttps": false
+        }
+    },
+    "smtp": {
+        "host": "tdm-factory-dev-maildev",
+        "port": 1025,
+        "secure": false,
+        "tls": {
+            "ignore": true,
+            "rejectUnauthorized": false
+        }
+    }
+}

tdm-be/config/production.json

@@ -0,0 +1,26 @@
+{
+    "password": "{very secure password}",
+    "hosts": {
+        "internal": {
+            "host": "{machine ip or internal host}",
+            "isHttps": true
+        },
+        "external": {
+            "host": "{external host / revers proxy host}",
+            "isHttps": false
+        }
+    },
+    "smtp": {
+        "host": "{mail services host}",
+        "port": 1025,
+        "secure": false,
+        "tls": {
+            "ignore": true,
+            "rejectUnauthorized": false
+        }
+    },
+    "cron": {
+        "schedule": "0 0 * * *",
+        "deleteFileOlderThan": 7
+    }
+}

tdm-be/package.json

@@ -23,6 +23,7 @@
     "cors": "^2.8.5",
     "express": "^4.18.2",
     "express-basic-auth": "^1.2.1",
+    "md5": "^2.3.0",
     "multer": "^1.4.5-lts.1",
     "node-cron": "^3.0.3",
     "nodemailer": "^6.9.9",
@@ -35,6 +36,7 @@
     "@types/config": "^3.3.3",
     "@types/cors": "^2.8.17",
     "@types/express": "^4.17.21",
+    "@types/md5": "^2.3.5",
     "@types/multer": "^1.4.11",
     "@types/node": "^18.19.15",
     "@types/node-cron": "^3.0.11",

tdm-be/src/controller/traitment.ts

@@ -1,7 +1,7 @@
 import environment from '../lib/config';
 import logger from '../lib/logger';
 import { StatusEnum } from '../model/StatusEnum';
-import currentTraitments from '../model/Traitment';
+import { addTraitement, getTraitement } from '../model/Traitment';
 import { sendEmail } from '../service/email-sender';
 import axios from 'axios';
 import express from 'express';
@@ -65,9 +65,9 @@ const router = express.Router();
 //Route to start traitment wrapping and then enrichment
 router.post(
     '/start',
-    (req: Request<{}, {}, Traitment>, res) => {
+    (req: Request<unknown, unknown, Traitment>, res) => {
         const traitment: Traitment = req.body;
-        currentTraitments.push(traitment);
+        addTraitement(traitment);
         const url = traitment.wrapper?.url ? traitment.wrapper?.url : '';
         const urlEnrichment = traitment.enrichment?.url ? traitment.enrichment?.url : '';
         const fileData = fs.readFileSync(`${environment.fileFolder}${traitment.file}`);
@@ -209,7 +209,7 @@ router.post('/upload', upload.single('file'), (req: any, res: Response) => {
 //Route to retrieve traitment status
 router.get('/status', (req, res) => {
     const { id } = req.query;
-    const traitment: Traitment = currentTraitments.filter((t) => t.timestamp + '' === id)[0];
+    const traitment: Traitment = getTraitement().filter((t) => t.timestamp + '' === id)[0];
     let status: StatusEnum = StatusEnum.UNKNOWN;
     if (traitment) {
         status = traitment.status;

tdm-be/src/controller/webhook.ts

@@ -1,7 +1,7 @@
 import logger from '../lib/logger';
 import configModel from '../model/Config';
 import { StatusEnum } from '../model/StatusEnum';
-import currentTraitments from '../model/Traitment';
+import { getTraitement, setTraitement } from '../model/Traitment';
 import { sendEmail } from '../service/email-sender';
 import axios from 'axios';
 import express from 'express';
@@ -19,7 +19,7 @@ router.post(
     '/success',
     (req, res) => {
         const { id } = req.query;
-        const traitment: Traitment = currentTraitments.filter((t) => t.timestamp + '' === id)[0];
+        const traitment: Traitment = getTraitement().filter((t) => t.timestamp + '' === id)[0];
         const enrichment = config.enrichments.filter(
             (enrichment: SwaggerApi) => traitment.enrichment.url.indexOf(enrichment.url) > -1,
         )[0];
@@ -65,10 +65,10 @@ router.post(
     '/failure',
     (req, res) => {
         const { id } = req.query;
-        const traitment: Traitment = currentTraitments.filter((traitment) => traitment.timestamp === id)[0];
+        const traitment: Traitment = getTraitement().filter((traitment) => traitment.timestamp === id)[0];
         traitment.status = StatusEnum.FINISHED_ERROR;
         if (traitment) {
-            currentTraitments = currentTraitments.filter((t) => t.timestamp !== traitment.timestamp);
+            setTraitement(getTraitement().filter((t) => t.timestamp !== traitment.timestamp));
             // Process the payload as needed
             logger.info('Received webhook error:', id);
             const mailOptions: EmailOptions = {

tdm-be/src/model/Traitment.ts

@@ -11,6 +11,16 @@ export class Traitment {
     status: StatusEnum = StatusEnum.UNKNOWN;
 }
 
-const currentTraitments: Traitment[] = [];
+let currentTraitments: Traitment[] = [];
 
-export default currentTraitments;
+export const addTraitement = (traitement: Traitment) => {
+    currentTraitments.push(traitement);
+};
+
+export const getTraitement = () => {
+    return currentTraitments;
+};
+
+export const setTraitement = (traitements: Traitment[]) => {
+    currentTraitments = traitements;
+};

tdm-be/src/swagger/swagger.js

@@ -15,7 +15,7 @@ const swaggerOptions = {
             },
         ],
     },
-    apis: ['./routers/data-enrichment.ts', './routers/data-wrapper.ts', './routers/traitment.ts'], // Specify the file containing your routes
+    apis: ['./src/controller/data-enrichment.ts', './src/controller/data-wrapper.ts', './src/controller/traitment.ts'], // Specify the file containing your routes
 };
 
 const swaggerOptionsConfig = {
@@ -32,19 +32,19 @@ const swaggerOptionsConfig = {
             },
         ],
     },
-    apis: ['./routers/config.ts'], // Specify the file containing your routes
+    apis: ['./src/controller/config.ts'], // Specify the file containing your routes
 };
 
 const swaggerSpec = swaggerJsdoc(swaggerOptions);
 
 // Write Swagger JSON to a file
 const swaggerJson = JSON.stringify(swaggerSpec, null, 2);
-fs.writeFileSync('swagger.json', swaggerJson);
+fs.writeFileSync(__dirname + '/swagger.json', swaggerJson);
 
 const swaggerSpecConfig = swaggerJsdoc(swaggerOptionsConfig);
 
 // Write Swagger JSON to a file
 const swaggerJsonConfig = JSON.stringify(swaggerSpecConfig, null, 2);
-fs.writeFileSync('swagger-config.json', swaggerJsonConfig);
+fs.writeFileSync(__dirname + '/swagger-config.json', swaggerJsonConfig);
 
 console.log('Swagger JSON file generated successfully');