Merge branch 'master' into enhancement/dev-tools-protocol-limit

cvasseng · web-flow · commit 53a2e2f94f54 · 2025-02-26T13:09:19.000+01:00
diff --git a/.env.sample b/.env.sample
@@ -1,3 +1,6 @@
+# PUPPETEER CONFIG
+PUPPETEER_TEMP_DIR = ./tmp/
+
 # HIGHCHARTS CONFIG
 HIGHCHARTS_VERSION = latest
 HIGHCHARTS_CDN_URL = https://code.highcharts.com/
@@ -29,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
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,14 @@ _Fixes:_
 - Fixed an issue that would sometimes cause cause a crash due to fail due to `Accept-Ranges` headers
 - Wrapped the `clearPageResources` function in a try-catch to handle potential page resources errors.
 - Secured against errors caused by `dev-tools` protocol data size limitations.
+- Corrected the `Node.js Module` example in the README.
+- 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).
+- Made the temporary Puppeteer directory (`PUPPETEER_TEMP_DIR`) (till now, `'./tmp'`) configurable by the user [(#567)](https://github.com/highcharts/node-export-server/issues/567).
 
 # 4.0.2
 
diff --git a/README.md b/README.md
@@ -98,7 +98,8 @@ The format, along with its default values, is as follows (using the recommended
 ```
 {
   "puppeteer": {
-    "args": []
+    "args": [],
+    "tempDir": "./tmp/"
   },
   "highcharts": {
     "version": "latest",
@@ -218,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": {
@@ -286,6 +289,10 @@ To load an additional JSON configuration file, use the `--loadConfig <filepath>`
 
 These variables are set in your environment and take precedence over options from the `lib/schemas/config.js` file. They can be set in the `.env` file (refer to the `.env.sample` file). If you prefer setting these variables through the `package.json`, use `export` command on Linux/Mac OS X and `set` command on Windows.
 
+### Puppeteer Config
+
+- `PUPPETEER_TEMP_DIR`: The directory for Puppeteer to store temporary files (defaults to `./tmp/`).
+
 ### Highcharts Config
 
 - `HIGHCHARTS_VERSION`: Highcharts version to use (defaults to `latest`).
@@ -323,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
@@ -419,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`).
@@ -573,20 +584,23 @@ const options = {
   }
 };
 
-// Initialize export settings with your chart's config
-const exportSettings = exporter.setOptions(options);
+// Logic must be triggered in an asynchronous function
+(async () => {
+  // Initialize export settings with your chart's config
+  const exportSettings = exporter.setOptions(options);
 
-// Must initialize exporting before being able to export charts
-await exporter.initExport(exportSettings);
+  // Must initialize exporting before being able to export charts
+  await exporter.initExport(exportSettings);
 
-// Perform an export
-await exporter.startExport(exportSettings, async (error, info) => {
-  // The export result is now in info
-  // It will be base64 encoded (info.data)
+  // Perform an export
+  await exporter.startExport(exportSettings, async (error, info) => {
+    // The export result is now in info
+    // It will be base64 encoded (info.result)
 
-  // Kill the pool when we are done with it
-  await exporter.killPool();
-});
+    // Kill the pool when we are done with it
+    await exporter.killPool();
+  });
+})();
 ```
 
 ## CommonJS support
diff --git a/dist/index.cjs b/dist/index.cjs
diff --git a/dist/index.esm.js b/dist/index.esm.js
diff --git a/dist/index.esm.js.map b/dist/index.esm.js.map
diff --git a/lib/browser.js b/lib/browser.js
@@ -59,14 +59,14 @@ export function get() {
  */
 export async function create(puppeteerArgs) {
   // Get debug and other options
-  const { debug, other } = getOptions();
+  const { puppeteer: puppeteerOptions, debug, other } = getOptions();
 
   // Get the debug options
   const { enable: enabledDebug, ...debugOptions } = debug;
 
   const launchOptions = {
     headless: other.browserShellMode ? 'shell' : true,
-    userDataDir: './tmp/',
+    userDataDir: puppeteerOptions.tempDir || './tmp/',
     args: puppeteerArgs,
     handleSIGINT: false,
     handleSIGTERM: false,
diff --git a/lib/cache.js b/lib/cache.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(
diff --git a/lib/chart.js b/lib/chart.js
@@ -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.`);
       }
     }
   }
diff --git a/lib/envs.js b/lib/envs.js
@@ -64,6 +64,24 @@ const v = {
       )
       .transform((value) => (value !== '' ? value : undefined)),
 
+  // Checks if the string is a valid path directory (path format)
+  path: () =>
+    z
+      .string()
+      .trim()
+      .refine(
+        (value) => {
+          // Simplified regex to match both absolute and relative paths
+          return /^(\.\/|\.\.\/|\/|[a-zA-Z]:\\|[a-zA-Z]:\/)?(([\w]+|-)[\\/]?)+$/.test(
+            value
+          );
+        },
+        {},
+        {
+          message: 'The string is an invalid path directory string.'
+        }
+      ),
+
   // Allows positive numbers or no value in which case the returned value will
   // be undefined
   positiveNum: () =>
@@ -96,6 +114,9 @@ const v = {
 };
 
 export const Config = z.object({
+  // puppeteer
+  PUPPETEER_TEMP_DIR: v.string(),
+
   // highcharts
   HIGHCHARTS_VERSION: z
     .string()
@@ -148,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
diff --git a/lib/schemas/config.js b/lib/schemas/config.js
@@ -146,6 +146,12 @@ export const defaultConfig = {
       ],
       type: 'string[]',
       description: 'Arguments array to send to Puppeteer.'
+    },
+    tempDir: {
+      value: './tmp/',
+      type: 'string',
+      envLink: 'PUPPETEER_TEMP_DIR',
+      description: 'The directory for Puppeteer to store temporary files.'
     }
   },
   highcharts: {
@@ -355,7 +361,6 @@ export const defaultConfig = {
       envLink: 'SERVER_MAX_UPLOAD_SIZE',
       description:
         'The maximum upload size, in megabytes, for the server'
-      
     },
     enable: {
       value: false,
@@ -401,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',
diff --git a/tests/unit/envs.test.js b/tests/unit/envs.test.js
@@ -1,6 +1,31 @@
 import { Config } from '../../lib/envs';
 
 describe('Environment variables should be correctly parsed', () => {
+  test('PUPPETEER_TEMP_DIR should be a valid path', () => {
+    const env = { PUPPETEER_TEMP_DIR: '/path/to/dir' };
+    expect(Config.partial().parse(env).PUPPETEER_TEMP_DIR).toEqual(
+      '/path/to/dir'
+    );
+
+    env.PUPPETEER_TEMP_DIR = '/another/path/to/dir';
+    expect(Config.partial().parse(env).PUPPETEER_TEMP_DIR).toEqual(
+      '/another/path/to/dir'
+    );
+
+    env.PUPPETEER_TEMP_DIR = '';
+    expect(() => Config.partial().parse(env)).toThrow();
+  });
+
+  test('PUPPETEER_TEMP_DIR can be a relative path', () => {
+    const env = { PUPPETEER_TEMP_DIR: './tmp/' };
+    expect(Config.partial().parse(env).PUPPETEER_TEMP_DIR).toEqual('./tmp/');
+
+    env.PUPPETEER_TEMP_DIR = '../custom-tmp/';
+    expect(Config.partial().parse(env).PUPPETEER_TEMP_DIR).toEqual(
+      '../custom-tmp/'
+    );
+  });
+
   test('HIGHCHARTS_VERSION accepts latests and not unrelated strings', () => {
     const env = { HIGHCHARTS_VERSION: 'string-other-than-latest' };
     expect(() => Config.partial().parse(env)).toThrow();
