documentation on environment variables

Make 'trust proxy' option configurable

.dockerignore

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

README.md

@@ -6,7 +6,7 @@ This service is designed to gather weather data to be used by [IASsure](https://
 
 ## Installation/Deployment
 
-IASsure-WX can be installed using docker. The image is available at `git.fsisp.de/fionn/iassure`.
+IASsure-WX can be installed using docker. The image is available at `git.fsisp.de/fionn/iassure-wx`.
 
 Tags:
   - `latest` - The newest recommended build, built from `main`
@@ -16,3 +16,17 @@ Tags:
 ## 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_ID=
+```

backend/package.json

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

backend/src/app.ts

@@ -4,14 +4,14 @@ import morgan from 'morgan';
 import router from './router';
 import wxService from './services/wx.service';
 
-const { PORT = 3000 } = process.env;
+const { PORT = 3000, BASE_PATH = '/api', TRUST_PROXY_IP = false } = process.env;
 
 const app = express();
 
-app.set('trust proxy', true);
+app.set('trust proxy', TRUST_PROXY_IP);
 app.use(morgan('combined'));
 
-app.use('/api', router.router);
+app.use(BASE_PATH, router.router);
 
 const frontendRoot = '/opt/frontend/dist';
 app.use(express.static(frontendRoot));
@@ -25,11 +25,27 @@ 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(PORT, () => {
   console.log(
     `application is listening on port ${PORT}`,
   );
 });
+
+const shutdown = (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);
+  });
+};
+
+process.on('SIGTERM', () => shutdown('SIGTERM'));
+process.on('SIGINT', () => shutdown('SIGINT'));

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,6 +1,6 @@
-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 } = {};
 
@@ -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: {
@@ -68,15 +68,15 @@ 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"] = {
+  data.levels['0'] = {
-    "T(K)": String(Number(hourlyData?.[`temperature_2m`]?.[index]) + 273.15),
+    'T(K)': String(Number(hourlyData?.temperature_2m?.[index]) + 273.15),
-    "windspeed": String(hourlyData?.[`windspeed_10m`]?.[index]),
+    'windspeed': String(hourlyData?.windspeed_10m?.[index]),
-    "windhdg": String(hourlyData?.[`winddirection_10m`]?.[index]),
+    'windhdg': String(hourlyData?.winddirection_10m?.[index]),
   };
 
   for (const [qnh, fl] of Object.entries(qnhLevelMapping)) {
@@ -85,10 +85,10 @@ export async function getDataAtFix(fix: WxFix, index: number): Promise<WxFixData
     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;
@@ -104,10 +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)"
+        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());
@@ -133,4 +133,4 @@ export default {
   getWx,
   generateData,
   wrappedGenerateData,
-}
+};