Merge branch 'master' into 567/user-data-dir-config

Author: cvasseng

.env.sample

@@ -32,6 +32,8 @@ SERVER_BENCHMARKING = false
 # SERVER PROXY CONFIG
 SERVER_PROXY_HOST =
 SERVER_PROXY_PORT =
+SERVER_PROXY_USERNAME =
+SERVER_PROXY_PASSWORD =
 SERVER_PROXY_TIMEOUT = 5000
 
 # SERVER RATE LIMITING CONFIG

CHANGELOG.md

@@ -11,6 +11,12 @@ _Fixes:_
 - Fixed an issue where the chart constructor was sometimes incorrectly set, causing the export to fail
 - Added referrers to CDN cache fetches on first startup/install. 
 - Fixed an issue that would sometimes cause cause a crash due to fail due to `Accept-Ranges` headers
+- Fixed the warning message when the the default `resources.json` file is not found.
+- Fixed the problem with the lack of the `instr` value, when the `options` is set instead
+
+_New Features:_
+
+- Added proxy authentication [(#631)](https://github.com/highcharts/node-export-server/issues/631).
 
 _New features:_
 

README.md

@@ -219,6 +219,8 @@ The format, along with its default values, is as follows (using the recommended
     "proxy": {
       "host": "",
       "port": 8080,
+      "username": false,
+      "password": false,
       "timeout": 5000
     },
     "rateLimiting": {
@@ -328,6 +330,8 @@ These variables are set in your environment and take precedence over options fro
 
 - `SERVER_PROXY_HOST`: The host of the proxy server to use, if it exists (defaults to ``).
 - `SERVER_PROXY_PORT`: The port of the proxy server to use, if it exists (defaults to ``).
+- `SERVER_PROXY_USERNAME`: If used proxy with authentication, need to pass username and password (defaults to ``).
+- `SERVER_PROXY_PASSWORD`: If used proxy with authentication, need to pass username and password (defaults to ``).
 - `SERVER_PROXY_TIMEOUT`: The timeout for the proxy server to use, if it exists (defaults to ``).
 
 ### Server Rate Limiting Config
@@ -424,6 +428,8 @@ _Available options:_
 - `--serverBenchmarking`: Indicates whether to display the duration, in milliseconds, of specific actions that occur on the server while serving a request (defaults to `false`).
 - `--proxyHost`: The host of the proxy server to use, if it exists (defaults to `false`).
 - `--proxyPort`: The port of the proxy server to use, if it exists (defaults to `false`).
+- `--proxyUsername`: If you want your proxy to be authenticated, pass the username with password (defaults to `false`).
+- `--proxyPassword`: If you want your proxy to be authenticated, pass the username with password (defaults to `false`).
 - `--proxyTimeout`: The timeout for the proxy server to use, if it exists (defaults to `5000`).
 - `--enableRateLimiting`: Enables rate limiting for the server (defaults to `false`).
 - `--maxRequests`: The maximum number of requests allowed in one minute (defaults to `10`).

dist/index.esm.js

@@ -174,15 +174,15 @@ export const fetchScripts = async (
 ) => {
   // Configure proxy if exists
   let proxyAgent;
-  const proxyHost = proxyOptions.host;
-  const proxyPort = proxyOptions.port;
+  const { host, port, username, password } = proxyOptions;
 
   // Try to create a Proxy Agent
-  if (proxyHost && proxyPort) {
+  if (host && port) {
     try {
       proxyAgent = new HttpsProxyAgent({
-        host: proxyHost,
-        port: proxyPort
+        host,
+        port,
+        ...(username && password ? { username, password } : {})
       });
     } catch (error) {
       throw new ExportError('[cache] Could not create a Proxy Agent.').setError(

dist/index.esm.js.map

@@ -97,6 +97,9 @@ export const startExport = async (settings, endCallback) => {
     try {
       log(4, '[chart] Attempting to export from a raw input.');
 
+      // Use whichever one is available
+      exportOptions.instr = exportOptions.instr || exportOptions.options;
+
       // Perform a direct inject when forced
       if (toBoolean(options.customLogic?.allowCodeExecution)) {
         return doStraightInject(options, endCallback);
@@ -321,11 +324,7 @@ const doExport = async (options, chartJson, endCallback, svg) => {
           toBoolean(options.customLogic.allowFileResources)
         );
       } catch (error) {
-        logWithStack(
-          2,
-          error,
-          `[chart] Unable to load the default resources.json file.`
-        );
+        log(2, `[chart] Unable to load the default resources.json file.`);
       }
     }
   }

lib/cache.js

@@ -169,6 +169,8 @@ export const Config = z.object({
   // server proxy
   SERVER_PROXY_HOST: v.string(),
   SERVER_PROXY_PORT: v.positiveNum(),
+  SERVER_PROXY_USERNAME: v.string(),
+  SERVER_PROXY_PASSWORD: v.string(),
   SERVER_PROXY_TIMEOUT: v.nonNegativeNum(),
 
   // server rate limiting

lib/chart.js

@@ -406,6 +406,20 @@ export const defaultConfig = {
         cliName: 'proxyPort',
         description: 'The port of the proxy server to use, if it exists.'
       },
+      username: {
+        value: false,
+        type: 'string',
+        envLink: 'SERVER_PROXY_USERNAME',
+        cliName: 'proxyUsername',
+        description: 'The username for the proxy server, if it exists.'
+      },
+      password: {
+        value: false,
+        type: 'string',
+        envLink: 'SERVER_PROXY_PASSWORD',
+        cliName: 'proxyPassword',
+        description: 'The password for the proxy server, if it exists.'
+      },
       timeout: {
         value: 5000,
         type: 'number',