🔂 Merge master into branch

services/healthcheck.js

@@ -10,7 +10,7 @@ const http = require(isSsl ? 'https' : 'http');
 
 /* Location of the server to test */
 const isDocker = !!process.env.IS_DOCKER;
-const port = isSsl ? (process.env.SSL_PORT || (isDocker ? 443 : 4001)) : (process.env.PORT || isDocker ? 80 : 4000);
+const port = isSsl ? (process.env.SSL_PORT || (isDocker ? 443 : 4001)) : (process.env.PORT || (isDocker ? 80 : 4000));
 const host = process.env.HOST || '0.0.0.0';
 const timeout = 2000;
 

services/save-config.js

@@ -5,6 +5,7 @@
  * Finally, it will call a function with the status message
  */
 const fsPromises = require('fs').promises;
+const path = require('path');
 
 module.exports = async (newConfig, render) => {
   /* Either returns nothing (if using default path), or strips navigational characters from path */
@@ -24,7 +25,8 @@ module.exports = async (newConfig, render) => {
   };
 
   // Make the full file name and path to save the backup config file
-  const backupFilePath = `${settings.defaultLocation}${usersFileName || settings.filename}-`
+  const backupFilePath = path.normalize(process.env.BACKUP_DIR || settings.defaultLocation) 
+    + `/${usersFileName || settings.filename}-`
     + `${Math.round(new Date() / 1000)}${settings.backupDenominator}`;
 
   // The path where the main conf.yml should be read and saved to

services/watch-for-changes.js

@@ -0,0 +1,78 @@
+const fs = require('fs');
+const { exec } = require('child_process');
+const path = require('path');
+const crypto = require('crypto');
+
+// Default location of config file in container
+const configFileName = '../public/conf.yml';
+// Real path of config file in container
+const configFilePath = path.resolve(__dirname, configFileName);
+// Amount of time to ignore file after change detected
+const debounceTimeMs = 2000;
+
+// Store current timeout
+let timeout = null;
+// Store last hash of file
+let lastHash = null;
+
+/**
+ * Calculate hash of file, used for de-bounce mechanism to
+ * prevent successive updates if file content not changed
+ */
+const hashFileContent = (filePath) => {
+  const content = fs.readFileSync(filePath, 'utf8');
+  return crypto.createHash('sha256').update(content).digest('hex');
+};
+
+/**
+ * Just logs a given message to terminal so user knows what's happening
+ */
+const logInfo = (message, msgLevel = 'OUTPUT') => {
+  const RESET = '\x1b[0m';
+  let logLevels = {};
+  switch (msgLevel) {
+    case 'ERROR': logLevels = { col: '\x1b[31m', func: console.error }; break;
+    case 'WARNING': logLevels = { col: '\x1b[33m', func: console.warn }; break;
+    case 'INFO': logLevels = { col: '\x1b[36m', func: console.info }; break;
+    case 'SUCCESS': logLevels = { col: '\x1b[32m', func: console.log }; break;
+    default: logLevels = { col: RESET, func: console.log };
+  }
+  logLevels.func(`${logLevels.col}\x1b[1m[${msgLevel}]${RESET} ${logLevels.col}${message}${RESET}\n`);
+};
+
+// Log initial message to user
+logInfo(`When '${configFileName}' is updated, a rebuild will be triggered.\n`);
+
+/**
+ * Code to be executed when a watch event is triggered
+ * Will check correctly expected file and time frame,
+ * then ensure the hash is different from last hash,
+ * and then trigger -rebuild of frontend with yarn build
+ * outputting the stdrout and stderr to user's terminal
+ */
+const watchAction = (eventType, filename) => {
+  if (filename && eventType === 'change') {
+    if (timeout) clearTimeout(timeout);
+    timeout = setTimeout(() => {
+      const currentHash = hashFileContent(configFilePath);
+      if (currentHash !== lastHash) {
+        lastHash = currentHash;
+        logInfo(`${filename} file Changed, running build...`);
+        exec('yarn build', (error, stdout, stderr) => {
+          if (error) {
+            logInfo(error, 'ERROR');
+            return;
+          }
+          logInfo(stdout);
+          logInfo(stderr, 'WARNING');
+          logInfo('Build completed successfully.\n', 'SUCCESS');
+        });
+      } else {
+        logInfo(`${filename} file Detected change, but content is the same. Skipping....`, 'WARNING');
+      }
+    }, debounceTimeMs);
+  }
+};
+
+// Watch given config path, with the watch action function
+fs.watch(configFilePath, watchAction);