Merge pull request #536 from highcharts/feat/disabling-logging

feat/disabling-logging

Author: PaulDalek

.env.sample

@@ -62,6 +62,8 @@ POOL_BENCHMARKING = false
 LOGGING_LEVEL = 4
 LOGGING_FILE = highcharts-export-server.log
 LOGGING_DEST = log/
+LOGGING_TO_CONSOLE = true
+LOGGING_TO_FILE = true
 
 # UI CONFIG
 UI_ENABLE = true

README.md

@@ -111,7 +111,6 @@ The format, along with its default values, is as follows (using the recommended
       "map",
       "gantt",
       "exporting",
-      "export-data",
       "parallel-coordinates",
       "accessibility",
       "annotations-advanced",
@@ -169,14 +168,17 @@ The format, along with its default values, is as follows (using the recommended
       "marker-clusters",
       "hollowcandlestick",
       "heikinashi",
-      "flowmap"
+      "flowmap",
+      "export-data",
+      "navigator",
+      "textpath"
     ],
     "indicatorScripts": [
       "indicators-all"
     ],
     "customScripts": [
-      "https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.29.4/moment.min.js",
-      "https://cdnjs.cloudflare.com/ajax/libs/moment-timezone/0.5.34/moment-timezone-with-data.min.js"
+      "https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.30.1/moment.min.js",
+      "https://cdnjs.cloudflare.com/ajax/libs/moment-timezone/0.5.45/moment-timezone-with-data.min.js"
     ],
     "forceFetch": false,
     "cachePath": ".cache"
@@ -246,7 +248,9 @@ The format, along with its default values, is as follows (using the recommended
   "logging": {
     "level": 4,
     "file": "highcharts-export-server.log",
-    "dest": "log/"
+    "dest": "log/",
+    "toConsole": true,
+    "toFile": true
   },
   "ui": {
     "enable": false,
@@ -350,8 +354,10 @@ These variables are set in your environment and take precedence over options fro
 ### Logging Config
 
 - `LOGGING_LEVEL`: The logging level to be used. Can be **0** - silent, **1** - error, **2** - warning, **3** - notice, **4** - verbose or **5** benchmark (defaults to `4`).
-- `LOGGING_FILE`: The name of a log file. The `logDest` option also needs to be set to enable file logging (defaults to `highcharts-export-server.log`).
-- `LOGGING_DEST`: The path to store log files. This also enables file logging (defaults to `log/`).
+- `LOGGING_FILE`: The name of a log file. The `logToFile` and `logDest` options also need to be set to enable file logging (defaults to `highcharts-export-server.log`).
+- `LOGGING_DEST`: The path to store log files. The `logToFile` option also needs to be set to enable file logging (defaults to `log/`).
+- `LOGGING_TO_CONSOLE`: Enables or disables showing logs in the console (defaults to `true`).
+- `LOGGING_TO_FILE`: Enables or disables creation of the log directory and saving the log into a .log file (defaults to `true`).
 
 ### UI Config
 
@@ -431,8 +437,10 @@ _Available options:_
 - `--reaperInterval`: The duration, in milliseconds, after which the check for idle resources to destroy is triggered (defaults to `1000`).
 - `--poolBenchmarking`: Indicate whether to show statistics for the pool of resources or not (defaults to `false`).
 - `--logLevel`: The logging level to be used. Can be **0** - silent, **1** - error, **2** - warning, **3** - notice, **4** - verbose or **5** - benchmark (defaults to `4`).
-- `--logFile`: The name of a log file. The `--logDest` option also needs to be set to enable file logging (defaults to `highcharts-export-server.log`).
-- `--logDest`: The path to store log files. This also enables file logging (defaults to `log/`).
+- `--logFile`: The name of a log file. The `logToFile` and `logDest` options also need to be set to enable file logging (defaults to `highcharts-export-server.log`).
+- `--logDest`: The path to store log files. The `logToFile` option also needs to be set to enable file logging (defaults to `log/`).
+- `--logToConsole`: Enables or disables showing logs in the console (defaults to `true`).
+- `--logToFile`: Enables or disables creation of the log directory and saving the log into a .log file (defaults to `true`).
 - `--enableUi`: Enables or disables the user interface (UI) for the Export Server (defaults to `false`).
 - `--uiRoute`: The endpoint route to which the user interface (UI) should be attached (defaults to `/`).
 - `--nodeEnv`: The type of Node.js environment (defaults to `production`).

lib/envs.js

@@ -194,6 +194,8 @@ export const Config = z.object({
     .transform((value) => (value !== '' ? parseFloat(value) : undefined)),
   LOGGING_FILE: v.string(),
   LOGGING_DEST: v.string(),
+  LOGGING_TO_CONSOLE: v.boolean(),
+  LOGGING_TO_FILE: v.boolean(),
 
   // ui
   UI_ENABLE: v.boolean(),

lib/logger.js

@@ -14,8 +14,6 @@ See LICENSE file in root for details.
 
 import { appendFile, existsSync, mkdirSync } from 'fs';
 
-import { defaultConfig } from './schemas/config.js';
-
 // The available colors
 const colors = ['red', 'yellow', 'blue', 'gray', 'green'];
 
@@ -52,11 +50,6 @@ let logging = {
   listeners: []
 };
 
-// Gather init logging options
-for (const [key, option] of Object.entries(defaultConfig.logging)) {
-  logging[key] = option.value;
-}
-
 /**
  * Logs the provided texts to a file, if file logging is enabled. It creates
  * the necessary directory structure if not already created and appends the
@@ -66,28 +59,26 @@ for (const [key, option] of Object.entries(defaultConfig.logging)) {
  * @param {string} prefix - An optional prefix to be added to each log entry.
  */
 const logToFile = (texts, prefix) => {
-  if (logging.toFile) {
-    if (!logging.pathCreated) {
-      // Create if does not exist
-      !existsSync(logging.dest) && mkdirSync(logging.dest);
+  if (!logging.pathCreated) {
+    // Create if does not exist
+    !existsSync(logging.dest) && mkdirSync(logging.dest);
 
-      // We now assume the path is available, e.g. it's the responsibility
-      // of the user to create the path with the correct access rights.
-      logging.pathCreated = true;
-    }
+    // We now assume the path is available, e.g. it's the responsibility
+    // of the user to create the path with the correct access rights.
+    logging.pathCreated = true;
+  }
 
-    // Add the content to a file
-    appendFile(
-      `${logging.dest}${logging.file}`,
-      [prefix].concat(texts).join(' ') + '\n',
-      (error) => {
-        if (error) {
-          console.log(`[logger] Unable to write to log file: ${error}`);
-          logging.toFile = false;
-        }
+  // Add the content to a file
+  appendFile(
+    `${logging.dest}${logging.file}`,
+    [prefix].concat(texts).join(' ') + '\n',
+    (error) => {
+      if (error) {
+        console.log(`[logger] Unable to write to log file: ${error}`);
+        logging.toFile = false;
       }
-    );
-  }
+    }
+  );
 };
 
 /**
@@ -102,7 +93,7 @@ export const log = (...args) => {
   const [newLevel, ...texts] = args;
 
   // Current logging options
-  const { level, levelsDesc } = logging;
+  const { levelsDesc, level } = logging;
 
   // Check if log level is within a correct range or is a benchmark log
   if (
@@ -132,7 +123,9 @@ export const log = (...args) => {
   }
 
   // Log to file
-  logToFile(texts, prefix);
+  if (logging.toFile) {
+    logToFile(texts, prefix);
+  }
 };
 
 /**
@@ -189,7 +182,9 @@ export const logWithStack = (newLevel, error, customMessage) => {
   });
 
   // Log to file
-  logToFile(texts, prefix);
+  if (logging.toFile) {
+    logToFile(texts, prefix);
+  }
 };
 
 /**
@@ -231,17 +226,22 @@ export const enableFileLogging = (logDest, logFile) => {
 /**
  * Initializes logging with the specified logging configuration.
  *
- * @param {Object} logging - The logging configuration object.
+ * @param {Object} loggingOptions - The logging configuration object.
  */
-export const initLogging = (logging) => {
+export const initLogging = (loggingOptions) => {
+  // Set all the logging options on our logging module object
+  for (const [key, value] of Object.entries(loggingOptions)) {
+    logging[key] = value;
+  }
+
   // Set the log level
-  setLogLevel(logging && parseInt(logging.level));
+  setLogLevel(loggingOptions && parseInt(loggingOptions.level));
 
   // Set the log file path and name
-  if (logging && logging.dest) {
+  if (loggingOptions && loggingOptions.dest && loggingOptions.toFile) {
     enableFileLogging(
-      logging.dest,
-      logging.file || 'highcharts-export-server.log'
+      loggingOptions.dest,
+      loggingOptions.file || 'highcharts-export-server.log'
     );
   }
 };
@@ -255,22 +255,11 @@ export const listen = (fn) => {
   logging.listeners.push(fn);
 };
 
-/**
- * Toggles the standard output (console) logging.
- *
- * @param {boolean} enabled - If true, enables console logging; if false,
- * disables it.
- */
-export const toggleSTDOut = (enabled) => {
-  logging.toConsole = enabled;
-};
-
 export default {
   log,
   logWithStack,
   setLogLevel,
   enableFileLogging,
   initLogging,
-  listen,
-  toggleSTDOut
+  listen
 };

lib/sanitize.js

@@ -31,8 +31,7 @@ import DOMPurify from 'dompurify';
 export function sanitize(input) {
   const window = new JSDOM('').window;
   const purify = DOMPurify(window);
-  /// return purify.sanitize(input, { ADD_TAGS: ['foreignObject'] });
-  return purify.sanitize(input);
+  return purify.sanitize(input, { ADD_TAGS: ['foreignObject'] });
 }
 
 export default sanitize;

lib/schemas/config.js

@@ -83,7 +83,11 @@ export const scriptsNames = {
     'navigator',
     'textpath'
   ],
-  indicators: ['indicators-all']
+  indicators: ['indicators-all'],
+  custom: [
+    'https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.30.1/moment.min.js',
+    'https://cdnjs.cloudflare.com/ajax/libs/moment-timezone/0.5.45/moment-timezone-with-data.min.js'
+  ]
 };
 
 // This is the configuration object with all options and their default values,
@@ -176,10 +180,7 @@ export const defaultConfig = {
       description: 'The indicators of Highcharts to fetch.'
     },
     customScripts: {
-      value: [
-        'https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.29.4/moment.min.js',
-        'https://cdnjs.cloudflare.com/ajax/libs/moment-timezone/0.5.34/moment-timezone-with-data.min.js'
-      ],
+      value: scriptsNames.custom,
       type: 'string[]',
       description: 'Additional custom scripts or dependencies to fetch.'
     },
@@ -567,15 +568,30 @@ export const defaultConfig = {
       envLink: 'LOGGING_FILE',
       cliName: 'logFile',
       description:
-        'The name of a log file. The logDest option also needs to be set to enable file logging.'
+        'The name of a log file. The `logToFile` and `logDest` options also need to be set to enable file logging.'
     },
     dest: {
       value: 'log/',
       type: 'string',
       envLink: 'LOGGING_DEST',
       cliName: 'logDest',
       description:
-        'The path to store log files. This also enables file logging.'
+        'The path to store log files. The `logToFile` option also needs to be set to enable file logging.'
+    },
+    toConsole: {
+      value: true,
+      type: 'boolean',
+      envLink: 'LOGGING_TO_CONSOLE',
+      cliName: 'logToConsole',
+      description: 'Enables or disables showing logs in the console.'
+    },
+    toFile: {
+      value: true,
+      type: 'boolean',
+      envLink: 'LOGGING_TO_FILE',
+      cliName: 'logToFile',
+      description:
+        'Enables or disables creation of the log directory and saving the log into a .log file.'
     }
   },
   ui: {
@@ -1001,14 +1017,27 @@ export const promptsConfig = {
     {
       type: 'text',
       name: 'file',
-      message: 'A log file name. Set with the --logDest to enable file logging',
+      message:
+        'A log file name. Set with --toFile and --logDest to enable file logging',
       initial: defaultConfig.logging.file.value
     },
     {
       type: 'text',
       name: 'dest',
-      message: 'The path to log files. Enables file logging',
+      message: 'The path to a log file when the file logging is enabled',
       initial: defaultConfig.logging.dest.value
+    },
+    {
+      type: 'toggle',
+      name: 'toConsole',
+      message: 'Enable logging to the console',
+      initial: defaultConfig.logging.toConsole.value
+    },
+    {
+      type: 'toggle',
+      name: 'toFile',
+      message: 'Enables logging to a file',
+      initial: defaultConfig.logging.toFile.value
     }
   ],
   ui: [

package-lock.json

@@ -34,7 +34,7 @@
     "http-tests-single": "node ./tests/http/http_test_runner_single.js",
     "node-tests": "node ./tests/node/node_test_runner.js",
     "node-tests-single": "node ./tests/node/node_test_runner_single.js",
-    "prepare": "husky install || true",
+    "prepare": "husky || true",
     "build": "rollup -c",
     "unit:test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },

package.json

@@ -44,4 +44,44 @@ describe('sanitize', () => {
     const output = sanitize(input);
     expect(output).toBe('');
   });
+
+  it('removes standalone foreignObject element', () => {
+    const input = '<foreignObject>The foreignObject element</foreignObject>';
+    const output = sanitize(input);
+    expect(output).toBe('');
+  });
+
+  it('removes foreignObject element along with the containing iframe and b tags', () => {
+    const input =
+      "<foreignObject><iframe src=''></iframe><b>Hello</b></foreignObject>";
+    const output = sanitize(input);
+    expect(output).toBe('');
+  });
+
+  it('does not remove foreignObject element from SVG', () => {
+    const input =
+      '<svg><foreignObject>The foreignObject tag</foreignObject></svg>';
+    const output = sanitize(input);
+    expect(output).toBe(
+      '<svg><foreignObject>The foreignObject tag</foreignObject></svg>'
+    );
+  });
+
+  it('does not remove foreignObject with HTML tag inside from SVG', () => {
+    const input =
+      '<svg><foreignObject><span>HTML element</span></foreignObject></svg>';
+    const output = sanitize(input);
+    expect(output).toBe(
+      '<svg><foreignObject><span>HTML element</span></foreignObject></svg>'
+    );
+  });
+
+  it('removes iframe tag and leaves b tag inside foreignObject element from SVG', () => {
+    const input =
+      "<svg><foreignObject><iframe src='<internal AWS UP>'></iframe><b>Hello</b></foreignObject></svg>";
+    const output = sanitize(input);
+    expect(output).toBe(
+      '<svg><foreignObject><b>Hello</b></foreignObject></svg>'
+    );
+  });
 });