Merge pull request #530 from highcharts/enhancement/added-browser-shell-flag

enhancement/added-browser-shell-flag

Author: PaulDalek

.env.sample

@@ -72,6 +72,7 @@ OTHER_NODE_ENV = production
 OTHER_LISTEN_TO_PROCESS_EXITS = true
 OTHER_NO_LOGO = false
 OTHER_HARD_RESET_PAGE = false
+OTHER_BROWSER_SHELL_MODE = true
 
 # DEBUG CONFIG
 DEBUG_ENABLE = false

.puppeteerrc.cjs

@@ -1,8 +1,8 @@
-const {join} = require('path');
+const { join } = require('path');
 
 /**
  * @type {import("puppeteer").Configuration}
  */
 module.exports = {
-  cacheDirectory: join(__dirname, 'node_modules', '.puppeteer-cache'),
+  cacheDirectory: join(__dirname, 'node_modules', '.puppeteer-cache')
 };

CHANGELOG.md

@@ -20,7 +20,8 @@ _Enhancements:_
 - Optimized code by reducing evaluate function calls to enhance performance and minimize jumping between NodeJS and browser processes.
 - Optimized and moved chart creation initialization scripts from the HTML template to a separate module named `highcharts.js`.
 - Optimized the `clearPage` function to ensure content cleaning is only performed once, during resource release.
-- Introduced `hardResetPage` option for resetting the page's content (including Highcharts scripts) each time the page is released to the pool (defaulting to `false`).
+- Introduced the `hardResetPage` option for resetting the page's content (including Highcharts scripts) each time the page is released to the pool (defaulting to `false`).
+- Introduced the `browserShellMode` option for controlling the mode in which the browser runs (new or old, `shell` mode).
 - Optimized creating and acquiring pages from the pool.
 - Optimized adding and releasing additional JS and CSS resources.
 - Made corrections for gracefully shutting down resources, including running servers, ongoing intervals, browser instance, created pages, and workers pool.

README.md

@@ -58,18 +58,22 @@ export function get() {
  * instance are reached, or if no browser instance is found after retries.
  */
 export async function create(puppeteerArgs) {
+  // Get debug and other options
+  const { debug, other } = getOptions();
+
   // Get the debug options
-  const { enable: enabledDebug, ...debug } = getOptions().debug;
+  const { enable: enabledDebug, ...debugOptions } = debug;
+
   const launchOptions = {
-    headless: 'shell',
+    headless: other.browserShellMode ? 'shell' : true,
     userDataDir: './tmp/',
     args: puppeteerArgs,
     handleSIGINT: false,
     handleSIGTERM: false,
     handleSIGHUP: false,
     waitForInitialPage: false,
     defaultViewport: null,
-    ...(enabledDebug && debug)
+    ...(enabledDebug && debugOptions)
   };
 
   // Create a browser
@@ -103,6 +107,12 @@ export async function create(puppeteerArgs) {
 
     try {
       await open();
+
+      // Shell mode inform
+      if (launchOptions.headless === 'shell') {
+        log(3, `[browser] Launched browser in shell mode.`);
+      }
+
       // Debug mode inform
       if (enabledDebug) {
         log(3, `[browser] Launched browser in debug mode.`);

dist/index.cjs

@@ -204,6 +204,7 @@ export const Config = z.object({
   OTHER_LISTEN_TO_PROCESS_EXITS: v.boolean(),
   OTHER_NO_LOGO: v.boolean(),
   OTHER_HARD_RESET_PAGE: v.boolean(),
+  OTHER_BROWSER_SHELL_MODE: v.boolean(),
 
   // debugger
   DEBUG_ENABLE: v.boolean(),

dist/index.esm.js

@@ -618,6 +618,12 @@ export const defaultConfig = {
       type: 'boolean',
       envLink: 'OTHER_HARD_RESET_PAGE',
       description: 'Decides if the page content should be reset entirely.'
+    },
+    browserShellMode: {
+      value: true,
+      type: 'boolean',
+      envLink: 'OTHER_BROWSER_SHELL_MODE',
+      description: 'Decides if the browser runs in the shell mode.'
     }
   },
   debug: {
@@ -1040,6 +1046,12 @@ export const promptsConfig = {
       name: 'hardResetPage',
       message: 'Decides if the page content should be reset entirely',
       initial: defaultConfig.other.hardResetPage.value
+    },
+    {
+      type: 'toggle',
+      name: 'browserShellMode',
+      message: 'Decides if the browser runs in the shell mode',
+      initial: defaultConfig.other.browserShellMode.value
     }
   ],
   debug: [