Merge branch 'main' into chile

Author: MichaelLangbein

.gitignore

@@ -1,3 +1,3 @@
 ./backend/data
-
+.env
 

CHANGELOG.md

@@ -9,22 +9,30 @@
 - Integrate new, comparison-based frontend
 - Integrate backend for content-redaction
 - Old frontend: modularize
+- Dockerize whole architecture, provide redundancy
 
 # [2.0.5] 
+
+## Features
+- Overall:
+    - all components of architecture now dockerized
+- Compare frontend
+    - link click on eqSelection with form
+    - mirrorClick rule now allows `include` and `exclude` of `compositeId`s
+    - styles feature differently on click
+    - Custom converter for wizard/eqSim
+    - exposure now displayed
     - Ongoing
-        - link click on eqSelection with form
-            - dropdown doesnt know which of the options the new value is
-                - add a `valueToKey` property to wizardComplex?
-        - new rule: focus on first step from beginning
     - Upcoming
         - create a docker-compose.yml for backend, frontends and monitor
-            - create a global config-file
-        - style layer differently on click
         - translation service
-        - focus on eq-selection immediately
         - steps: show errors
         - auto-pilot: configurable start-strategy
 
+## Bug fixes
+- Compare frontend
+    - Map zooms in to first available step right after selecting a scenario
+
 # [2.0.4](https://github.com/riesgos/dlr-riesgos-frontend/releases/tag/2.0.4) (May 16 2023) Created monitor and new frontend  
 ## Features
 - monitor: 
@@ -34,15 +42,10 @@
     - tickets now stay alive for a certain time after they've been fetched
     - added `execute?skipCache=true` option for execute-requests
     - added `runall.ts` which runs all steps once every hour.
-    - fix: logging threw error on circular objects.
     - added `expires` headers
 - frontend: 
     - now allows multiple (dynamic) legends for one layer at the same time. Applied to eq-catalogue.
     - now has circle-legend
-    - fix: race condition in making post-eq-damage mapable.
-    - fix: wrong style and legend for chile-damage.
-    - fix: *should* have fixed NS_BINDING_ABORTED.
-    - fix: error in one process does not stop processing of other processes.
 - Compare frontend
     - all code now in modules
     - map allows per-step data-converters which are semi-automatically injected
@@ -68,9 +71,7 @@
     - insideOne ruleset: data now mirrored
     - auto-pilot only started when rules allow it
     - legends now displayed - if present
-    - fix: layer- and wizard-services no longer cause multiple ui-updates on every state-change (reason: base-observable now shared)
     - popup: increased close button clickable area
-    - fix: click on map only fires click-handler *once*.
     - dropdown now selects value when clicked on map
     - wizard expanded from beginning: did need to move `share` up in filter-obs
     - reducers: parseAPIScenariosIntoNewState: strict typing
@@ -79,9 +80,16 @@
 # [2.0.3](https://github.com/riesgos/dlr-riesgos-frontend/releases/tag/2.0.3) (Mar. 9 2023) Bug fixes  
 
 ## Bug fixes
+- layer- and wizard-services no longer cause multiple ui-updates on every state-change (reason: base-observable now shared)
+- click on map only fires click-handler *once*.
 - removed superfluous console-logs
 - literal parameters of eq-catalog were not accepted
     - because no `userDataProvided` action triggered when user edits literal values
+- logging threw error on circular objects.
+- race condition in making post-eq-damage mapable.
+- wrong style and legend for chile-damage.
+- *should* have fixed NS_BINDING_ABORTED (happend in Firefox, presumably because too many posts at the same time).
+- error in one process does not stop processing of other processes.
 
 
 

backend/Dockerfile

@@ -0,0 +1,20 @@
+FROM node:16
+
+WORKDIR backend
+
+# install and build
+COPY . .
+RUN npm ci
+RUN npm run build:prod
+
+# config
+ENV maxStoreLifeTimeMinutes "1440"
+# adminEmails: comma separated list
+ENV adminEmails ""
+ENV sourceEmail "info@test.com"
+ENV port "8008"
+
+
+# running
+EXPOSE ${port}
+CMD ["node",  "dist/main.js"]

backend/package.json

@@ -1,13 +1,13 @@
 {
   "name": "scenarios",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "",
   "scripts": {
     "build:prod": "tsc --build",
     "build:watch": "tsc -w",
     "start": "ts-node-dev --respawn src/main.ts",
-    "test": "jest --runInBand",
-    "test:watch": "jest --watch",
+    "test": "jest --runInBand --bail",
+    "test:watch": "jest --watch --bail",
     "run": "node dist/main.js"
   },
   "keywords": [

backend/src/config.ts

@@ -19,7 +19,7 @@ function externalFunction() {
 
 test("Logs are written to file", async () => {
 
-    const logger = new Logger(logDir)
+    const logger = new Logger(logDir, [])
     logger.monkeyPatch();
 
     externalFunction();

backend/src/logging/logger.test.ts

@@ -1,7 +1,6 @@
 import { appendFileSync } from "fs"
 import { createFileSync, getFileAgeSync, renameFileSync } from "../utils/files";
 import { MailClient } from "../web/mailClient";
-import { config } from '../config';
 import { inspect } from 'util';
 
 
@@ -11,9 +10,10 @@ export class Logger {
 
     constructor(
         private loggingDir: string,
+        private sendMailTo: string[] = [],
+        private sender: string = "info@test.com",
         private verbosity: 'verbose' | 'silent' = 'verbose',
-        private maxLogAge = 24 * 60 * 60,
-        private sendMailOnError = true
+        private maxLogAgeMinutes = 24 * 60,
     ) {
         this.loggingDir = loggingDir.replace(/\/+$/, '');
     }
@@ -53,7 +53,7 @@ export class Logger {
         const fullErrorString = time.toISOString() + "---" + messageString + "\n" + additionalText + "\n";
         appendFileSync(`${this.loggingDir}/errors.txt`, fullErrorString);
 
-        if (this.sendMailOnError) this.mailClient.sendMail([config.adminEmail], 'RIESGOS 2.0: an error has occured', fullErrorString);
+        if (this.sendMailTo.length > 0) this.mailClient.sendMail(this.sender, this.sendMailTo, 'RIESGOS 2.0: an error has occured', fullErrorString);
     }
 
     private messageToString(message: any) {
@@ -75,7 +75,7 @@ export class Logger {
         if (fileAgeSecs === -1) {
             createFileSync(filePath);
         }
-        if (fileAgeSecs > this.maxLogAge) {
+        if (fileAgeSecs > this.maxLogAgeMinutes * 60) {
             renameFileSync(filePath, `${filePath}_${new Date().toISOString()}.txt`);
             createFileSync(filePath);
         }

backend/src/logging/logger.ts

@@ -1,20 +1,28 @@
-import { config } from './config';
 import cors from 'cors';
 import express from 'express';
-import { addScenarioApi } from './scenarios/scenario.interface';
+import { ScenarioAPIConfig, addScenarioApi } from './scenarios/scenario.interface';
 // import { parseCode } from './parser/scenarioParser';
 import { peruFactory } from './usr/peru/peru';
 import { peruShortFactory } from './usr/peru_short/peru';
 import { chileFactory } from './usr/chile/chile';
 import { ecuadorFactory } from './usr/ecuador/ecuador';
 
 
-const port = config.port;
+const port = parseInt(process.env.port || "8008");
 const logDir = `./data/logs/`;   // server-logs
 const storeDir = `./data/store/`;  // files that must be available to outside
 const scriptDir = './data/scenarios';  // user-defined logic
 
 
+const config: ScenarioAPIConfig = {
+    logDir: logDir,
+    maxStoreLifeTimeMinutes: parseInt(process.env.maxStoreLifetimeMinutes || "60"),
+    sender: process.env.sourceEmail || "info@test.com",
+    sendMailTo: (process.env.adminEmails || "").split(","),
+    maxLogAgeMinutes: 24 * 60,
+    storeDir: storeDir,
+    verbosity: 'verbose'   
+}
 
 async function main() {
     const app = express();
@@ -23,7 +31,7 @@ async function main() {
     // const scenarioFactories = await parseCode(scriptDir);
     const scenarioFactories = [chileFactory, ecuadorFactory, peruFactory, peruShortFactory];
 
-    addScenarioApi(app, scenarioFactories, storeDir, logDir, 'verbose', true);
+    addScenarioApi(app, scenarioFactories, config);
     const server = app.listen(port, () => console.log(`app now listening on port ${port}`));
 }
 

backend/src/main.ts

@@ -4,10 +4,19 @@ import { ProcessPool } from './pool';
 import { DatumLinage, Scenario, ScenarioFactory, ScenarioState } from './scenarios';
 import { Logger } from '../logging/logger';
 import { FileStorage } from '../storage/fileStorage';
-import { config } from '../config';
 
 
-export function addScenarioApi(app: Express, scenarioFactories: ScenarioFactory[], storeDir: string, loggingDir: string, verbosity: 'verbose' | 'silent' = 'verbose', sendMailOnError = true) {
+export interface ScenarioAPIConfig {
+    sendMailTo: string[];
+    sender: string;
+    maxLogAgeMinutes: number | undefined;
+    storeDir: string;
+    logDir: string;
+    verbosity: 'verbose' | 'silent';
+    maxStoreLifeTimeMinutes: number;
+}
+
+export function addScenarioApi(app: Express, scenarioFactories: ScenarioFactory[], config: ScenarioAPIConfig) {
     app.use(express.json({
         limit: '50mb'  // required because exposure objects can become pretty big
     }));
@@ -17,9 +26,9 @@ export function addScenarioApi(app: Express, scenarioFactories: ScenarioFactory[
     });
 
     const pool = new ProcessPool();
-    const fs = new FileStorage<DatumLinage>(storeDir, config.maxStoreLifeTimeMinutes * 60);
+    const fs = new FileStorage<DatumLinage>(config.storeDir, config.maxStoreLifeTimeMinutes);
     const scenarios = scenarioFactories.map(sf => sf.createScenario(fs));
-    const logger = new Logger(loggingDir, verbosity, undefined, sendMailOnError);
+    const logger = new Logger(config.logDir, config.sendMailTo, config.sender, config.verbosity, config.maxLogAgeMinutes);
     logger.monkeyPatch();
 
 
@@ -60,6 +69,10 @@ export function addScenarioApi(app: Express, scenarioFactories: ScenarioFactory[
     app.get('/files/:hash', async (req, res) => {
         const hash = req.params.hash;
         const cachedData = await fs.getDataByKey(hash);
+        if (!cachedData) {
+            console.error(`No such file: ${hash}`);
+            res.statusCode = 404;
+        }
         res.send(cachedData);
     });
 

backend/src/scenarios/scenario.interface.ts

@@ -1,7 +1,7 @@
 import axios from 'axios';
 import { Server } from 'http';
 import express, { Express } from 'express';
-import { addScenarioApi } from './scenario.interface';
+import { ScenarioAPIConfig, addScenarioApi } from './scenario.interface';
 import { Datum, ScenarioFactory, ScenarioState } from './scenarios';
 import { sleep } from '../utils/async';
 import { deleteFile } from '../utils/files';
@@ -64,22 +64,31 @@ fakeScenarioFactory.registerStep({
 const sendMailOnError = false;
 const http = axios.create();
 const port = 5003;
-const logDir = './test-data/scenario-errors/logs';
-const storeDir = './test-data/scenario-errors/store';
+const config: ScenarioAPIConfig = {
+    logDir: './test-data/scenario-errors/logs',
+    storeDir: './test-data/scenario-errors/store',
+    verbosity: 'silent',
+    sendMailTo: [],
+    sender: "",
+    maxLogAgeMinutes: 60,
+    maxStoreLifeTimeMinutes: 60
+}
+
+
 let app: Express;
 let server: Server;
 beforeAll(async () => {
-    await deleteFile(storeDir);
-    await deleteFile(logDir);
+    await deleteFile(config.storeDir);
+    await deleteFile(config.logDir);
     app = express();
     app.use(express.json());
     const scenarioFactories = [fakeScenarioFactory];
-    addScenarioApi(app, scenarioFactories, storeDir, logDir, 'silent', sendMailOnError);
+    addScenarioApi(app, scenarioFactories, config);
     server = app.listen(port, () => {});
 });
 
 afterAll(async () => {
-    await deleteFile(storeDir);
+    await deleteFile(config.storeDir);
     server.close();
 });