fix/options-type-validations

.env.sample

@@ -1,24 +1,46 @@
+# PUPPETEER CONFIG
+PUPPETEER_ARGS =
+
 # HIGHCHARTS CONFIG
 HIGHCHARTS_VERSION = latest
 HIGHCHARTS_CDN_URL = https://code.highcharts.com/
 HIGHCHARTS_FORCE_FETCH = false
 HIGHCHARTS_CACHE_PATH = .cache
+HIGHCHARTS_ADMIN_TOKEN =
 HIGHCHARTS_CORE_SCRIPTS =
 HIGHCHARTS_MODULE_SCRIPTS =
 HIGHCHARTS_INDICATOR_SCRIPTS =
-HIGHCHARTS_ADMIN_TOKEN =
+HIGHCHARTS_CUSTOM_SCRIPTS =
 
 # EXPORT CONFIG
+EXPORT_INFILE =
+EXPORT_INSTR =
+EXPORT_OPTIONS =
+EXPORT_SVG =
 EXPORT_TYPE = png
 EXPORT_CONSTR = chart
+EXPORT_OUTFILE =
+EXPORT_B64 = false
+EXPORT_NO_DOWNLOAD = false
+EXPORT_HEIGHT =
+EXPORT_WIDTH =
+EXPORT_SCALE =
 EXPORT_DEFAULT_HEIGHT = 400
 EXPORT_DEFAULT_WIDTH = 600
 EXPORT_DEFAULT_SCALE = 1
+EXPORT_GLOBAL_OPTIONS =
+EXPORT_THEME_OPTIONS =
+EXPORT_BATCH =
 EXPORT_RASTERIZATION_TIMEOUT = 1500
 
 # CUSTOM LOGIC CONFIG
 CUSTOM_LOGIC_ALLOW_CODE_EXECUTION = false
 CUSTOM_LOGIC_ALLOW_FILE_RESOURCES = false
+CUSTOM_LOGIC_CUSTOM_CODE =
+CUSTOM_LOGIC_CALLBACK =
+CUSTOM_LOGIC_RESOURCES =
+CUSTOM_LOGIC_LOAD_CONFIG =
+CUSTOM_LOGIC_CREATE_CONFIG =
 
 # SERVER CONFIG
 SERVER_ENABLE = false
@@ -57,6 +79,7 @@ POOL_IDLE_TIMEOUT = 30000
 POOL_CREATE_RETRY_INTERVAL = 200
 POOL_REAPER_INTERVAL = 1000
 POOL_BENCHMARKING = false
+POOL_RESOURCES_INTERVAL = 30000
 
 # LOGGING CONFIG
 LOGGING_LEVEL = 4
@@ -75,6 +98,7 @@ OTHER_LISTEN_TO_PROCESS_EXITS = true
 OTHER_NO_LOGO = false
 OTHER_HARD_RESET_PAGE = false
 OTHER_BROWSER_SHELL_MODE = true
+OTHER_CONNECTION_OVER_PIPE = false
 
 # DEBUG CONFIG
 DEBUG_ENABLE = false

.eslintrc.cjs

@@ -25,6 +25,7 @@ module.exports = {
   ],
   rules: {
     'no-unused-vars': 'off',
-    'import/no-cycle': 'error'
+    'import/no-cycle': 'error',
+    'import/no-named-as-default': 'off'
   }
 };

.prettierignore

@@ -1,3 +1,3 @@
-samples/cli/infile_not_json.json
+samples/cli/infileNotJson.json
 node_modules/
 dist/

CHANGELOG.md

@@ -1,5 +1,25 @@
+# 4.0.3
+
+_New Features:_
+
+- Added support for absolute paths in the `HIGHCHARTS_CACHE_PATH` option [(#562)](https://github.com/highcharts/node-export-server/issues/562)
+
+_Fixes_:
+
+- Improved status codes (user errors instead of 500) [(#577)](https://github.com/highcharts/node-export-server/pull/577)
+
+- Improved memory management/usage [(#586)](https://github.com/highcharts/node-export-server/pull/586)
+
+_Other:_
+
+- Add fair usage policy note on the page [(#583)](https://github.com/highcharts/node-export-server/pull/583)
+
 # 4.0.2
 
+_Hotfix_:
+
+- Fixed missing 'msg' and 'public' bundle in 4.0.1 on NPM.
+
 _Fixes:_
 
 - Made chart userOptions available within `customCode` as variable `options` [(#551)](https://github.com/highcharts/node-export-server/issues/551).

bin/cli.js

@@ -13,7 +13,15 @@ See LICENSE file in root for details.
 
 *******************************************************************************/
 
-import main from '../lib/index.js';
+import { singleExport, batchExport } from '../lib/chart.js';
+import { setOptions } from '../lib/config.js';
+import { initExport } from '../lib/index.js';
+import { log, logWithStack } from '../lib/logger.js';
+import { manualConfig } from '../lib/prompts.js';
+import { shutdownCleanUp } from '../lib/resourceRelease.js';
+import { printLogo, printVersion } from '../lib/utils.js';
+import { printUsage } from '../lib/schemas/config.js';
+import { startServer } from '../lib/server/server.js';
 
 import ExportError from '../lib/errors/ExportError.js';
 
@@ -24,29 +32,27 @@ import ExportError from '../lib/errors/ExportError.js';
  * @throws {Error} Throws an Error if an unexpected error occurs during
  * execution.
  */
-const start = async () => {
+async function start() {
   try {
     // Get the CLI arguments
     const args = process.argv;
 
     // Display version information if requested
-    if (
-      ['-v', '--v', '-version', '--version'].includes(args[args.length - 1])
-    ) {
+    if (['-v', '--v'].includes(args[args.length - 1])) {
       // Print logo with the version information
-      return main.printVersion();
+      return printVersion();
     }
 
     // Display help information if requested
-    if (['-h', '--h', '-help', '--help'].includes(args[args.length - 1])) {
+    if (['-h', '--h'].includes(args[args.length - 1])) {
       // Print logo with the version information
-      return main.printUsage();
+      return printUsage();
     }
 
     // Print logo with a version and usage information if no arguments supplied
     if (args.length <= 2) {
-      main.printUsage();
-      return main.log(
+      printUsage();
+      return log(
         2,
         '[cli] The number of provided arguments is too small. Please refer to the help section above.'
       );
@@ -57,69 +63,58 @@ const start = async () => {
     // 2. Options from a custom JSON file (loaded by the --loadConfig argument)
     // 3. Options from the environment variables (the .env file)
     // 4. Options from the CLI
-    const options = main.setOptions(null, args);
+    const options = setOptions(null, args, true);
 
     // If all options correctly parsed
     if (options) {
       // Print initial logo or text
-      main.printLogo(options.other.noLogo);
+      printLogo(options.other.noLogo);
 
       // In this case we want to prepare config manually
       if (options.customLogic.createConfig) {
-        return main.manualConfig(options.customLogic.createConfig);
+        return manualConfig(options.customLogic.createConfig);
       }
 
       // Start server
       if (options.server.enable) {
         // Init the export mechanism for the server configuration
-        await main.initExport(options);
+        await initExport(options);
 
         // Run the server
-        await main.startServer(options.server);
+        await startServer(options.server);
       } else {
         // Perform batch exports
         if (options.export.batch) {
-          // If not set explicitly, use default option for batch exports
-          if (!args.includes('--minWorkers', '--maxWorkers')) {
-            options.pool = {
-              ...options.pool,
-              minWorkers: 2,
-              maxWorkers: 25
-            };
-          }
-
           // Init a pool for the batch exports
-          await main.initExport(options);
+          await initExport(options);
 
           // Start batch exports
-          await main.batchExport(options);
+          await batchExport(options);
         } else {
           // No need for multiple workers in case of a single CLI export
-          options.pool = {
-            ...options.pool,
-            minWorkers: 1,
-            maxWorkers: 1
-          };
+          options.pool.minWorkers = 1;
+          options.pool.maxWorkers = 1;
 
           // Init a pool for one export
-          await main.initExport(options);
+          await initExport(options);
 
           // Start a single export
-          await main.singleExport(options);
+          await singleExport(options);
         }
       }
     } else {
       throw new ExportError(
-        '[cli] No valid options provided. Please check your input and try again.'
+        '[cli] No valid options provided. Please check your input and try again.',
+        400
       );
     }
   } catch (error) {
     // Log the error with stack
-    main.logWithStack(1, error);
+    logWithStack(1, error);
 
     // Gracefully shut down the process
-    await main.shutdownCleanUp(1);
+    await shutdownCleanUp(1);
   }
-};
+}
 
 start();

jest.config.js

@@ -1,7 +1,10 @@
-export default {
+/** @type {import('jest').Config} */
+const config = {
   testEnvironment: 'jest-environment-node',
   testMatch: ['**/tests/unit/**/*.test.js'],
   transform: {
     // '^.+\\.test.js?$': 'babel-jest'
   }
 };
+
+export default config;