Merged branch.

Author: PaulDalek

README.md

@@ -26,12 +26,13 @@ import {
   printLicense,
   printUsage,
   printVersion,
-  setOptions
+  setGlobalOptions
 } from '../lib/config.js';
 import { initExport } from '../lib/index.js';
 import { log, logWithStack } from '../lib/logger.js';
 import { manualConfig } from '../lib/prompt.js';
 import { shutdownCleanUp } from '../lib/resourceRelease.js';
+
 import { startServer } from '../lib/server/server.js';
 
 import ExportError from '../lib/errors/ExportError.js';
@@ -81,7 +82,7 @@ async function start() {
     }
 
     // Set the options, keeping the priority order of setting values
-    const options = setOptions({}, args, true);
+    const options = setGlobalOptions({}, args);
 
     // If all options are correctly parsed
     if (options) {
@@ -90,35 +91,44 @@ async function start() {
 
       // In this case we want to prepare config manually
       if (options.customLogic.createConfig) {
-        manualConfig(options.customLogic.createConfig);
+        manualConfig(
+          options.customLogic.createConfig,
+          options.customLogic.allowCodeExecution
+        );
         return;
       }
 
       // Start server
       if (options.server.enable) {
         // Init the export mechanism for the server configuration
-        await initExport(options);
+        await initExport();
 
         // Run the server
-        await startServer(options.server);
+        await startServer();
       } else {
         // Perform batch exports
         if (options.export.batch) {
           // Init the export mechanism for batch exports
-          await initExport(options);
+          await initExport();
 
           // Start batch exports
-          await batchExport(options);
+          await batchExport({
+            export: options.export,
+            customLogic: options.customLogic
+          });
         } else {
           // No need for multiple workers in case of a single CLI export
           options.pool.minWorkers = 1;
           options.pool.maxWorkers = 1;
 
           // Init the export mechanism for a single export
-          await initExport(options);
+          await initExport();
 
           // Start a single export
-          await singleExport(options);
+          await singleExport({
+            export: options.export,
+            customLogic: options.customLogic
+          });
         }
       }
     } else {

bin/cli.js

@@ -221,7 +221,7 @@ export async function newPage(poolResource) {
  * @param {boolean} [hardReset=false] - A flag indicating the type of clearing
  * to be performed. If true, navigates to `about:blank` and resets content
  * and scripts. If false, clears the body content by setting a predefined HTML
- * structure. The default value is false.
+ * structure. The default value is `false`.
  *
  * @returns {Promise<boolean>} A Promise that resolves to true when page
  * is correctly cleared and false when it is not.
@@ -268,8 +268,8 @@ export async function clearPage(poolResource, hardReset = false) {
  *
  * @param {Object} page - The Puppeteer page object to which resources will
  * be added.
- * @param {Object} customLogicOptions - The object containing `customLogic`
- * options.
+ * @param {Object} customLogicOptions - The configuration object containing
+ * `customLogic` options.
  *
  * @returns {Promise<Array.<Object>>} A Promise that resolves to an array
  * of injected resources.

dist/index.cjs

@@ -48,106 +48,117 @@ const cache = {
  * @async
  * @function checkAndUpdateCache
  *
- * @param {Object} highchartsOptions - Object containing `highcharts` options.
- * @param {Object} serverProxyOptions - Object containing `server.proxy`
- * options.
+ * @param {Object} highchartsOptions - The configuration object containing
+ * `highcharts` options.
+ * @param {Object} serverProxyOptions- The configuration object containing
+ * `server.proxy` options.
  */
 export async function checkAndUpdateCache(
   highchartsOptions,
   serverProxyOptions
 ) {
-  let fetchedModules;
-
-  // Get the cache path
-  const cachePath = getCachePath();
-
-  // Prepare paths to manifest and sources from the cache folder
-  const manifestPath = join(cachePath, 'manifest.json');
-  const sourcePath = join(cachePath, 'sources.js');
-
-  // Create the cache destination if it doesn't exist already
-  !existsSync(cachePath) && mkdirSync(cachePath, { recursive: true });
-
-  // Fetch all the scripts either if the `manifest.json` does not exist
-  // or if the `forceFetch` option is enabled
-  if (!existsSync(manifestPath) || highchartsOptions.forceFetch) {
-    log(3, '[cache] Fetching and caching Highcharts dependencies.');
-    fetchedModules = await _updateCache(
-      highchartsOptions,
-      serverProxyOptions,
-      sourcePath
-    );
-  } else {
-    let requestUpdate = false;
+  try {
+    let fetchedModules;
 
-    // Read the manifest JSON
-    const manifest = JSON.parse(readFileSync(manifestPath));
+    // Get the cache path
+    const cachePath = getCachePath();
 
-    // Check if the modules is an array, if so, we rewrite it to a map to make
-    // it easier to resolve modules.
-    if (manifest.modules && Array.isArray(manifest.modules)) {
-      const moduleMap = {};
-      manifest.modules.forEach((m) => (moduleMap[m] = 1));
-      manifest.modules = moduleMap;
-    }
+    // Prepare paths to manifest and sources from the cache folder
+    const manifestPath = join(cachePath, 'manifest.json');
+    const sourcePath = join(cachePath, 'sources.js');
 
-    // Get the actual number of scripts to be fetched
-    const { coreScripts, moduleScripts, indicatorScripts } = highchartsOptions;
-    const numberOfModules =
-      coreScripts.length + moduleScripts.length + indicatorScripts.length;
-
-    // Compare the loaded highcharts config with the contents in cache.
-    // If there are changes, fetch requested modules and products,
-    // and bake them into a giant blob. Save the blob.
-    if (manifest.version !== highchartsOptions.version) {
-      log(
-        2,
-        '[cache] A Highcharts version mismatch in the cache, need to re-fetch.'
-      );
-      requestUpdate = true;
-    } else if (Object.keys(manifest.modules || {}).length !== numberOfModules) {
-      log(
-        2,
-        '[cache] The cache and the requested modules do not match, need to re-fetch.'
-      );
-      requestUpdate = true;
-    } else {
-      // Check each module, if anything is missing refetch everything
-      requestUpdate = (moduleScripts || []).some((moduleName) => {
-        if (!manifest.modules[moduleName]) {
-          log(
-            2,
-            `[cache] The ${moduleName} is missing in the cache, need to re-fetch.`
-          );
-          return true;
-        }
-      });
-    }
+    // Create the cache destination if it doesn't exist already
+    !existsSync(cachePath) && mkdirSync(cachePath, { recursive: true });
 
-    // Update cache if needed
-    if (requestUpdate) {
+    // Fetch all the scripts either if the `manifest.json` does not exist
+    // or if the `forceFetch` option is enabled
+    if (!existsSync(manifestPath) || highchartsOptions.forceFetch) {
+      log(3, '[cache] Fetching and caching Highcharts dependencies.');
       fetchedModules = await _updateCache(
         highchartsOptions,
         serverProxyOptions,
         sourcePath
       );
     } else {
-      log(3, '[cache] Dependency cache is up to date, proceeding.');
+      let requestUpdate = false;
 
-      // Load the sources
-      cache.sources = readFileSync(sourcePath, 'utf8');
+      // Read the manifest JSON
+      const manifest = JSON.parse(readFileSync(manifestPath), 'utf8');
 
-      // Get current modules map
-      fetchedModules = manifest.modules;
+      // Check if the modules is an array, if so, we rewrite it to a map to make
+      // it easier to resolve modules.
+      if (manifest.modules && Array.isArray(manifest.modules)) {
+        const moduleMap = {};
+        manifest.modules.forEach((m) => (moduleMap[m] = 1));
+        manifest.modules = moduleMap;
+      }
+
+      // Get the actual number of scripts to be fetched
+      const { coreScripts, moduleScripts, indicatorScripts } =
+        highchartsOptions;
+      const numberOfModules =
+        coreScripts.length + moduleScripts.length + indicatorScripts.length;
+
+      // Compare the loaded highcharts config with the contents in cache.
+      // If there are changes, fetch requested modules and products,
+      // and bake them into a giant blob. Save the blob.
+      if (manifest.version !== highchartsOptions.version) {
+        log(
+          2,
+          '[cache] A Highcharts version mismatch in the cache, need to re-fetch.'
+        );
+        requestUpdate = true;
+      } else if (
+        Object.keys(manifest.modules || {}).length !== numberOfModules
+      ) {
+        log(
+          2,
+          '[cache] The cache and the requested modules do not match, need to re-fetch.'
+        );
+        requestUpdate = true;
+      } else {
+        // Check each module, if anything is missing refetch everything
+        requestUpdate = (moduleScripts || []).some((moduleName) => {
+          if (!manifest.modules[moduleName]) {
+            log(
+              2,
+              `[cache] The ${moduleName} is missing in the cache, need to re-fetch.`
+            );
+            return true;
+          }
+        });
+      }
+
+      // Update cache if needed
+      if (requestUpdate) {
+        fetchedModules = await _updateCache(
+          highchartsOptions,
+          serverProxyOptions,
+          sourcePath
+        );
+      } else {
+        log(3, '[cache] Dependency cache is up to date, proceeding.');
 
-      // Extract and save version of currently used Highcharts
-      cache.hcVersion = extractVersion(cache.sources);
+        // Load the sources
+        cache.sources = readFileSync(sourcePath, 'utf8');
+
+        // Get current modules map
+        fetchedModules = manifest.modules;
+
+        // Extract and save version of currently used Highcharts
+        cache.hcVersion = extractVersion(cache.sources);
+      }
     }
-  }
 
-  // Finally, save the new manifest, which is basically our current config
-  // in a slightly different format
-  await _saveConfigToManifest(highchartsOptions, fetchedModules);
+    // Finally, save the new manifest, which is basically our current config
+    // in a slightly different format
+    await _saveConfigToManifest(highchartsOptions, fetchedModules);
+  } catch (error) {
+    throw new ExportError(
+      '[cache] Could not configure cache and create or update the config manifest.',
+      500
+    ).setError(error);
+  }
 }
 
 /**
@@ -235,7 +246,7 @@ export function getCache() {
  * @returns {string} The absolute path to the cache directory for Highcharts.
  */
 export function getCachePath() {
-  return getAbsolutePath(getOptions().highcharts.cachePath); // #562
+  return getAbsolutePath(getOptions().highcharts.cachePath, 'utf8'); // #562
 }
 
 /**
@@ -251,7 +262,7 @@ export function getCachePath() {
  * modules have been fetched.
  * @param {boolean} [shouldThrowError=false] - A flag to indicate if the error
  * should be thrown. This should be used only for the core scripts. The default
- * value is false.
+ * value is `false`.
  *
  * @returns {Promise<string>} A Promise that resolves to the text representation
  * of the fetched script.
@@ -304,7 +315,8 @@ async function _fetchAndProcessScript(
  * @async
  * @function _saveConfigToManifest
  *
- * @param {Object} highchartsOptions - Object containing `highcharts` options.
+ * @param {Object} highchartsOptions - The configuration object containing
+ * `highcharts` options.
  * @param {Object} [fetchedModules={}] - An object which tracks which Highcharts
  * modules have been fetched. The default value is an empty object.
  *
@@ -345,8 +357,8 @@ async function _saveConfigToManifest(highchartsOptions, fetchedModules = {}) {
  * @param {Array.<string>} moduleScripts - Highcharts modules to fetch.
  * @param {Array.<string>} customScripts - Custom script paths to fetch (full
  * URLs).
- * @param {Object} serverProxyOptions - Object containing `server.proxy`
- * options.
+ * @param {Object} serverProxyOptions - The configuration object containing
+ * `server.proxy` options.
  * @param {Object} fetchedModules - An object which tracks which Highcharts
  * modules have been fetched.
  *
@@ -413,9 +425,10 @@ async function _fetchScripts(
  * @async
  * @function _updateCache
  *
- * @param {Object} highchartsOptions - Object containing `highcharts` options.
- * @param {Object} serverProxyOptions - Object containing `server.proxy`
- * options.
+ * @param {Object} highchartsOptions - The configuration object containing
+ * `highcharts` options.
+ * @param {Object} serverProxyOptions - The configuration object containing
+ * `server.proxy` options.
  * @param {string} sourcePath - The path to the source file in the cache.
  *
  * @returns {Promise<Object>} A Promise that resolves to an object representing