Merge pull request #630 from highcharts/567/user-data-dir-config

567/user-data-dir-config

Author: cvasseng

.env.sample

@@ -1,3 +1,6 @@
+# PUPPETEER CONFIG
+PUPPETEER_TEMP_DIR = ./tmp/
+
 # HIGHCHARTS CONFIG
 HIGHCHARTS_VERSION = latest
 HIGHCHARTS_CDN_URL = https://code.highcharts.com/

CHANGELOG.md

@@ -18,6 +18,10 @@ _New Features:_
 
 - Added proxy authentication [(#631)](https://github.com/highcharts/node-export-server/issues/631).
 
+_New features:_
+
+- 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
 
 _Hotfix_:

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",
@@ -288,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`).

dist/index.cjs

@@ -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,

dist/index.esm.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()

dist/index.esm.js.map

@@ -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,

lib/browser.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();