Merge branch 'release/v1.2.0'

Make 'trust proxy' option configurable

.dockerignore

@@ -1,2 +1,2 @@
 .git
-node_modules
+**/node_modules

.drone.yml

@@ -3,12 +3,12 @@ type: docker
 name: build dev
 
 steps:
-  - name: build and push image
+  - name: build for staging
     image: plugins/docker
     settings:
       dockerfile: Dockerfile
-      registry: git.fsisp.de
+      registry: hub.fsisp.de
-      repo: git.fsisp.de/fionn/isasure-wx
+      repo: hub.fsisp.de/library/iassure-wx
       username:
         from_secret: reg_username
       password:
@@ -16,32 +16,27 @@ steps:
       tags:
         - dev
         - '${DRONE_COMMIT:0:8}'
-
+    when:
-trigger:
       branch:
         - dev
         - develop
+      event:
+        - push
 
----
+  - name: build for production
-kind: pipeline
-type: docker
-name: build master
-
-steps:
-  - name: build and push image
     image: plugins/docker
     settings:
       dockerfile: Dockerfile
-      registry: git.fsisp.de
+      registry: hub.fsisp.de
-      repo: git.fsisp.de/fionn/isasure-wx
+      repo: hub.fsisp.de/library/iassure-wx
       username:
         from_secret: reg_username
       password:
         from_secret: reg_password
       tags:
         - latest
+        - '${DRONE_TAG}'
         - '${DRONE_COMMIT:0:8}'
-
+    when:
-trigger:
+      event:
-  branch:
+        - tag
-    - main

README.md

@@ -1,7 +1,34 @@
-# TypeScript Project Template
+# IASsure-WX
 
-## preparation
+## idea
 
-```sh
+This service is designed to gather weather data to be used by [IASsure](https://github.com/MorpheusXAUT/IASsure) by [MorpheusXAUT](https://github.com/MorpheusXAUT). It uses the [Open-Meteo.com](https://open-meteo.com)-API to gather the necessary data to provide to the plugin.
-npm install -g eslint eslint-config-airbnb-typescript eslint-plugin-import eslint-plugin-n eslint-plugin-promise
+
+## Installation/Deployment
+
+IASsure-WX can be installed using docker. The image is available at `hub.fsisp.de/library/iassure-wx`.
+
+Tags:
+  - `latest` - The newest recommended build, built from `main`
+  - `dev` - The newest development/staging build, built from `develop`
+  - Other than those tags, every image is tagged with the git commit id
+
+## Configuration
+
+IASsure-WX can be configured using the `wx-config.json`-file. For now it contains test data but will include production data for at least the Langen FIR. It necessary, another file can be mounted on top of it (`/opt/wx-config.json`). You may also choose to make the necessary changes to the file in this repository. The file is documented in the schema definition file (`wx-config.schema.json`).
+
+## Environment Variables
+
+Some options can be defined using environment variables:
+
+```bash 
+# defines the port, the application will listen on
+PORT=3000
+# defines the base path used for the api
+BASE_PATH=/api
+# defines ips that are allowed as proxy ips
+# See http://expressjs.com/en/guide/behind-proxies.html
+TRUST_PROXY=
+# set to true to disable /api-Endpoint. will also disable frontend.
+DISABLE_DEFAULT_API_ENDPOINT=
 ```

backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "app",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "",
   "main": "index.js",
   "type": "module",

backend/src/app.ts

@@ -3,19 +3,26 @@ import nodesched from 'node-schedule';
 import morgan from 'morgan';
 import router from './router';
 import wxService from './services/wx.service';
-
+import appConfig from './config';
-const { PORT = 3000 } = process.env;
 
 const app = express();
 
-app.set('trust proxy', true);
+const config = appConfig();
+
+app.set('trust proxy', config.trustProxy);
 app.use(morgan('combined'));
 
-app.use('/api', router.router);
+if (config.apiBasePath) {
+  app.use(config.apiBasePath, router.router);
+}
 
-const frontendRoot = '/opt/frontend/dist';
+if (!config.disableDefaultApiEndpoint) {
-app.use(express.static(frontendRoot));
+  app.use('/api', router.router);
-app.use((req, res) => res.sendFile(`${frontendRoot}/index.html`));
+
+  const frontendRoot = '/opt/frontend/dist';
+  app.use(express.static(frontendRoot));
+  app.use((req, res) => res.sendFile(`${frontendRoot}/index.html`));
+}
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 app.use((err, req: Request, res: Response, next: NextFunction) => {
@@ -25,11 +32,26 @@ app.use((err, req: Request, res: Response, next: NextFunction) => {
   res.status(500).json({ msg: 'an error occurred' });
 });
 
-nodesched.scheduleJob('regenerate data', '*/30 * * * * *', wxService.wrappedGenerateData)
+nodesched.scheduleJob('regenerate data', '*/30 * * * * *', wxService.wrappedGenerateData);
 wxService.wrappedGenerateData();
 
-app.listen(PORT, () => {
+const server = app.listen(config.port, () => {
   console.log(
-    `application is listening on port ${PORT}`,
+    `application is listening on port ${config.port}`,
   );
 });
+
+function processShutdown(signal: string) {
+  console.log(`${signal} signal received. Shutting down.`);
+  server.close((err) => {
+    if (err) {
+      console.error(`Failed to shut down server gracefully: ${err}`);
+      process.exit(1);
+    }
+
+    console.log('Server closed');
+    process.exit(0);
+  });
+}
+
+['SIGTERM', 'SIGINT'].map(signal => process.on(signal, processShutdown.bind(undefined, signal)));

backend/src/config.ts

@@ -0,0 +1,28 @@
+export interface Config {
+  port: number;
+  apiBasePath: string;
+  disableDefaultApiEndpoint: boolean;
+  trustProxy: string | boolean;
+}
+
+export default function appConfig(): Config {
+  const {
+    PORT,
+    BASE_PATH,
+    TRUST_PROXY,
+    DISABLE_DEFAULT_API_ENDPOINT,
+  } = process.env;
+
+  let trustProxy: string | boolean = false;
+
+  if (TRUST_PROXY == '*') {
+    trustProxy = true;
+  }
+
+  return {
+    port: Number(PORT ?? 3000),
+    apiBasePath: BASE_PATH ?? '',
+    trustProxy,
+    disableDefaultApiEndpoint: DISABLE_DEFAULT_API_ENDPOINT == 'true',
+  };
+}

backend/src/controllers/region.controller.ts

@@ -15,7 +15,7 @@ export async function getRegion(req: express.Request, res: express.Response, nex
 
     const regionData = regionsService.getRegion(region);
 
-    if(!regionData) {
+    if (!regionData) {
       return next();
     }
 

backend/src/services/config.service.ts

@@ -23,4 +23,4 @@ export function getConfig(): WxConfig {
 
 export default {
   getConfig,
-}
+};

backend/src/services/regions.service.ts

@@ -1,6 +1,6 @@
-import configService, { WxConfig, WxRegion } from "./config.service";
+import configService, { WxConfig, WxRegion } from './config.service';
 
-export function getRegions(): WxConfig["regions"] {
+export function getRegions(): WxConfig['regions'] {
   return configService.getConfig().regions;
 }
 

backend/src/services/wx.service.ts

@@ -1,8 +1,8 @@
-import axios from "axios";
+import axios from 'axios';
-import { WxFix } from "./config.service";
+import { WxFix } from './config.service';
-import regionsService from "./regions.service";
+import regionsService from './regions.service';
 
-const cachedData: {[key: string]: WxData} = {};
+const cachedData: { [key: string]: WxData } = {};
 
 const qnhLevelMapping = {
   200: 390,
@@ -12,7 +12,7 @@ const qnhLevelMapping = {
   500: 180,
   600: 140,
   700: 100,
-  850: 50
+  850: 50,
 };
 
 const necessaryDatapoints = [
@@ -34,10 +34,10 @@ for (const qnh of Object.keys(qnhLevelMapping)) {
 }
 
 interface WxLevelData {
-  "T(K)": string;
+  'T(K)': string;
   windspeed: string;
   windhdg: string;
-};
+}
 
 export interface WxFixData {
   coords: {
@@ -54,6 +54,7 @@ export interface WxData {
   info: {
     date: string;
     datestring: string;
+    legal: string;
   };
   data: {
     [key: string]: WxFixData;
@@ -67,27 +68,27 @@ export async function getDataAtFix(fix: WxFix, index: number): Promise<WxFixData
   const data: WxFixData = {
     coords: {
       lat: String(fix.lat),
-      long: String(fix.lon)
+      long: String(fix.lon),
     },
-    levels: {}
+    levels: {},
-  }
-
-  data.levels["0"] = {
-    "T(K)": String(Number(hourlyData?.[`temperature_2m`]?.[index]) + 273.15),
-    "windspeed": String(hourlyData?.[`windspeed_10m`]?.[index]),
-    "windhdg": String(hourlyData?.[`winddirection_10m`]?.[index]),
   };
 
-  for(const [qnh, fl] of Object.entries(qnhLevelMapping)) {
+  data.levels['0'] = {
+    'T(K)': String(Number(hourlyData?.temperature_2m?.[index]) + 273.15),
+    'windspeed': String(hourlyData?.windspeed_10m?.[index]),
+    'windhdg': String(hourlyData?.winddirection_10m?.[index]),
+  };
+
+  for (const [qnh, fl] of Object.entries(qnhLevelMapping)) {
     const temp = Number(hourlyData?.[`temperature_${qnh}hPa`]?.[index]) + 273.15;
     const dir = hourlyData?.[`winddirection_${qnh}hPa`]?.[index];
     const speed = hourlyData?.[`windspeed_${qnh}hPa`]?.[index]; 
 
     data.levels[String(fl)] = {
-      "T(K)": String(temp),
+      'T(K)': String(temp),
-      "windspeed": String(speed),
+      'windspeed': String(speed),
-      "windhdg": String(dir),
+      'windhdg': String(dir),
-    }
+    };
   }
 
   return data;
@@ -103,9 +104,10 @@ export async function generateData() {
       info: {
         date: now.toISOString(),
         datestring: `${now.getUTCDate()}${now.getUTCHours()}`,
+        legal: 'Weather data by Open-Meteo.com (https://open-meteo.com)',
       },
-      data: {}
+      data: {},
-    }
+    };
 
     for (const fix of region.fixes) {
       regionData.data[fix.name] = await getDataAtFix(fix, now.getUTCHours());
@@ -131,4 +133,4 @@ export default {
   getWx,
   generateData,
   wrappedGenerateData,
-}
+};

docker-compose.yml

@@ -9,10 +9,7 @@ services:
       args:
         - NODE_ENV=development
     ports:
-      - '3030:3030/tcp'
+      - '3030:3000/tcp'
       - '9229:9229/tcp'
     volumes:
       - .:/opt:delegated
-    environment:
-      - MONGO_URI
-      - PORT=3030

utils/convert-csv-to-json.js

@@ -0,0 +1,20 @@
+/**
+ * This script can be used to convert a csv-file to the json format required by the wx-config.json
+ * 
+ * the csv needs to follow the following format: <FIX>,<LAT>,<LON>
+ */
+
+const fs = require('fs');
+
+const points = fs
+  .readFileSync('./fixes.csv')
+  .toString()
+  .split('\n')
+  .map(str => str.split(','))
+  .map(data => ({
+    name: data[0],
+    lat: Number(data[1]),
+    lon: Number(data[2]),
+  }));
+
+fs.writeFileSync('./fixes.json', JSON.stringify(points, undefined, 2));

wx-config.json

@@ -32,17 +32,452 @@
       ]
     },
     {
-      "identifier": "LOVV",
+      "identifier": "EDXX",
       "fixes": [
+        {
+          "name": "RDG",
+          "lat": 49.040139,
+          "lon": 12.526625
+        },
+        {
+          "name": "OTT",
+          "lat": 48.180394,
+          "lon": 11.816536
+        },
+        {
+          "name": "LNZ",
+          "lat": 48.229711,
+          "lon": 14.103156
+        },
+        {
+          "name": "VOZ",
+          "lat": 49.532328,
+          "lon": 14.874664
+        },
+        {
+          "name": "MASUR",
+          "lat": 48.520097,
+          "lon": 15.439292
+        },
         {
           "name": "VATET",
           "lat": 47.600953,
           "lon": 14.033119
         },
         {
-          "name": "LNZ",
+          "name": "INSEL",
-          "lat": 48.229711,
+          "lat": 47.155556,
-          "lon": 14.103156
+          "lon": 12.405278
+        },
+        {
+          "name": "TRA",
+          "lat": 47.6895,
+          "lon": 8.436972
+        },
+        {
+          "name": "NAXAV",
+          "lat": 46.463856,
+          "lon": 11.322183
+        },
+        {
+          "name": "HOC",
+          "lat": 47.466556,
+          "lon": 7.665444
+        },
+        {
+          "name": "LUPEN",
+          "lat": 48.435053,
+          "lon": 7.733622
+        },
+        {
+          "name": "LADAT",
+          "lat": 49.265256,
+          "lon": 7.839472
+        },
+        {
+          "name": "GTQ",
+          "lat": 48.986444,
+          "lon": 6.716222
+        },
+        {
+          "name": "VALEK",
+          "lat": 49.514444,
+          "lon": 5.781111
+        },
+        {
+          "name": "LNO",
+          "lat": 50.585833,
+          "lon": 5.710278
+        },
+        {
+          "name": "BUB",
+          "lat": 50.902333,
+          "lon": 4.538083
+        },
+        {
+          "name": "OKIDU",
+          "lat": 51.7894,
+          "lon": 4.85
+        },
+        {
+          "name": "SPY",
+          "lat": 52.540278,
+          "lon": 4.853778
+        },
+        {
+          "name": "NAPRO",
+          "lat": 51.855833,
+          "lon": 6.058889
+        },
+        {
+          "name": "RKN",
+          "lat": 52.133194,
+          "lon": 6.763889
+        },
+        {
+          "name": "EEL",
+          "lat": 53.164167,
+          "lon": 6.66675
+        },
+        {
+          "name": "EDUBU",
+          "lat": 54.183333,
+          "lon": 6.5
+        },
+        {
+          "name": "TIPAN",
+          "lat": 54.598369,
+          "lon": 4.398944
+        },
+        {
+          "name": "AMADA",
+          "lat": 55,
+          "lon": 6.35
+        },
+        {
+          "name": "BAVTA",
+          "lat": 55.603056,
+          "lon": 8.3
+        },
+        {
+          "name": "ODN",
+          "lat": 55.581011,
+          "lon": 10.652989
+        },
+        {
+          "name": "ERNOV",
+          "lat": 56.168861,
+          "lon": 12.573778
+        },
+        {
+          "name": "TIDVU",
+          "lat": 55.411306,
+          "lon": 13.557528
+        },
+        {
+          "name": "LUSID",
+          "lat": 54.916667,
+          "lon": 15.296111
+        },
+        {
+          "name": "VAVUN",
+          "lat": 53.475278,
+          "lon": 15.333056
+        },
+        {
+          "name": "DENKO",
+          "lat": 52.816861,
+          "lon": 15.8325
+        },
+        {
+          "name": "KELOD",
+          "lat": 52.233889,
+          "lon": 15.883333
+        },
+        {
+          "name": "VELAB",
+          "lat": 51.469722,
+          "lon": 16.748889
+        },
+        {
+          "name": "LAGAR",
+          "lat": 50.795275,
+          "lon": 15.367089
+        },
+        {
+          "name": "ELMEK",
+          "lat": 49.9039,
+          "lon": 14.029875
+        },
+        {
+          "name": "BRENO",
+          "lat": 46.98,
+          "lon": 11.376667
+        },
+        {
+          "name": "ALG",
+          "lat": 47.997381,
+          "lon": 10.262189
+        },
+        {
+          "name": "LBU",
+          "lat": 48.912975,
+          "lon": 9.340228
+        },
+        {
+          "name": "DKB",
+          "lat": 49.142753,
+          "lon": 10.238306
+        },
+        {
+          "name": "SULUS",
+          "lat": 50.075192,
+          "lon": 10.728808
+        },
+        {
+          "name": "BAMKI",
+          "lat": 50.718064,
+          "lon": 11.020208
+        },
+        {
+          "name": "KOJEC",
+          "lat": 51.512719,
+          "lon": 11.50445
+        },
+        {
+          "name": "OSKAN",
+          "lat": 51.460847,
+          "lon": 13.627669
+        },
+        {
+          "name": "MAREM",
+          "lat": 50.715467,
+          "lon": 13.628808
+        },
+        {
+          "name": "ABERU",
+          "lat": 50.069194,
+          "lon": 12.093719
+        },
+        {
+          "name": "LAMSI",
+          "lat": 48.653353,
+          "lon": 13.583442
+        },
+        {
+          "name": "SBG",
+          "lat": 47.967533,
+          "lon": 12.894072
+        },
+        {
+          "name": "ERKIR",
+          "lat": 47.537778,
+          "lon": 12.008889
+        },
+        {
+          "name": "WLD",
+          "lat": 48.579419,
+          "lon": 11.129386
+        },
+        {
+          "name": "UPALA",
+          "lat": 49.214372,
+          "lon": 11.221436
+        },
+        {
+          "name": "SUL",
+          "lat": 48.381586,
+          "lon": 8.644836
+        },
+        {
+          "name": "KRH",
+          "lat": 48.992944,
+          "lon": 8.584236
+        },
+        {
+          "name": "UMDAS",
+          "lat": 49.395864,
+          "lon": 8.824181
+        },
+        {
+          "name": "COSJE",
+          "lat": 49.717531,
+          "lon": 9.947
+        },
+        {
+          "name": "BOMBI",
+          "lat": 50.056667,
+          "lon": 8.800278
+        },
+        {
+          "name": "UBIDU",
+          "lat": 50.073333,
+          "lon": 7.906389
+        },
+        {
+          "name": "UMUPU",
+          "lat": 50.558611,
+          "lon": 7.431389
+        },
+        {
+          "name": "BITBU",
+          "lat": 49.98295,
+          "lon": 6.561628
+        },
+        {
+          "name": "NVO",
+          "lat": 50.822675,
+          "lon": 6.636533
+        },
+        {
+          "name": "GMH",
+          "lat": 51.170511,
+          "lon": 7.892039
+        },
+        {
+          "name": "DODEN",
+          "lat": 50.602256,
+          "lon": 8.09325
+        },
+        {
+          "name": "DEMAB",
+          "lat": 50.541111,
+          "lon": 9.955833
+        },
+        {
+          "name": "MAPOX",
+          "lat": 51.133611,
+          "lon": 8.813889
+        },
+        {
+          "name": "RIMET",
+          "lat": 51.333889,
+          "lon": 10.219444
+        },
+        {
+          "name": "PIROT",
+          "lat": 52.053431,
+          "lon": 9.236903
+        },
+        {
+          "name": "HMM",
+          "lat": 51.856867,
+          "lon": 7.708294
+        },
+        {
+          "name": "DIBIR",
+          "lat": 51.276944,
+          "lon": 6.124444
+        },
+        {
+          "name": "BASUM",
+          "lat": 52.771989,
+          "lon": 8.788539
+        },
+        {
+          "name": "MADOR",
+          "lat": 52.566667,
+          "lon": 9.9525
+        },
+        {
+          "name": "HLZ",
+          "lat": 52.363394,
+          "lon": 10.795219
+        },
+        {
+          "name": "MAG",
+          "lat": 51.994989,
+          "lon": 11.794306
+        },
+        {
+          "name": "KLF",
+          "lat": 52.019353,
+          "lon": 13.563414
+        },
+        {
+          "name": "KORUP",
+          "lat": 51.583056,
+          "lon": 14.738056
+        },
+        {
+          "name": "SUBIX",
+          "lat": 52.379722,
+          "lon": 14.585556
+        },
+        {
+          "name": "KETAP",
+          "lat": 52.927853,
+          "lon": 13.654947
+        },
+        {
+          "name": "OGBER",
+          "lat": 52.613889,
+          "lon": 12.724722
+        },
+        {
+          "name": "BKD",
+          "lat": 53.034525,
+          "lon": 11.546217
+        },
+        {
+          "name": "HAM",
+          "lat": 53.685575,
+          "lon": 10.204997
+        },
+        {
+          "name": "WSN",
+          "lat": 53.347169,
+          "lon": 8.874733
+        },
+        {
+          "name": "DHE",
+          "lat": 54.185686,
+          "lon": 7.9107
+        },
+        {
+          "name": "ATTUS",
+          "lat": 54.899722,
+          "lon": 8.782778
+        },
+        {
+          "name": "ALASA",
+          "lat": 54.808611,
+          "lon": 9.961667
+        },
+        {
+          "name": "BAGOS",
+          "lat": 54.572778,
+          "lon": 11.27
+        },
+        {
+          "name": "ROBUS",
+          "lat": 55.109444,
+          "lon": 11.719722
+        },
+        {
+          "name": "BANKU",
+          "lat": 54.795833,
+          "lon": 12.935278
+        },
+        {
+          "name": "UMSET",
+          "lat": 54.833056,
+          "lon": 14.158611
+        },
+        {
+          "name": "POBOX",
+          "lat": 54.158889,
+          "lon": 14.094167
+        },
+        {
+          "name": "FLD",
+          "lat": 53.762736,
+          "lon": 13.563136
+        },
+        {
+          "name": "TAGOB",
+          "lat": 53.734772,
+          "lon": 11.833056
         }
       ]
     }