@hexonet/semantic-release-whmcs 5.1.22 → 5.2.0

package/.github/workflows/test.yml

@@ -1,5 +1,6 @@
 name: Dependabot auto-merge & tests
 on:
+  workflow_call:
   pull_request:
     types:
       - opened

package/HISTORY.md

@@ -1,3 +1,18 @@
+# [5.2.0](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.1.22...v5.2.0) (2026-01-07)
+
+
+### Bug Fixes
+
+* **deps:** bump puppeteer from 24.30.0 to 24.31.0 ([7d2ff8a](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/7d2ff8a2ead33c606f76e72303a92ed2fda05622))
+* **deps:** bump puppeteer from 24.31.0 to 24.33.0 ([e05fd23](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/e05fd2336697239e1766f0617e08c8c62fc83040))
+* **deps:** bump puppeteer from 24.33.0 to 24.33.1 ([cfbb3ad](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/cfbb3adb2310cbb04e9c4a48520e05f74cc996bf))
+* **deps:** bump puppeteer from 24.33.1 to 24.34.0 ([aff5059](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/aff5059079c0c95cec7c513c2d12a0a79dd45c03))
+
+
+### Features
+
+* **index.js:** add prepare step to install Chromium/Chrome OS dependencies for Puppeteer ([7e61220](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/7e61220646f4e3bcf68d300370a47668955b990b))
+
 ## [5.1.22](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.1.21...v5.1.22) (2025-11-13)
 
 

package/README.md

@@ -11,6 +11,7 @@
 
 | Step | Description |
 | ---- | ----------- |
+| `prepare` | Install OS dependencies required by Puppeteer and Chromium/Chrome (Debian/Ubuntu only) if `osDepsCommand` is configured. |
 | `verifyConditions` | Verify the presence and the validity of the authentication credentials (set via [environment variables](#environment-variables)) and the product id option configuration. |
 | `publish` | Publish product/module version to [WHMCS Marketplace](https://marketplace.whmcs.com) including changelog notes. |
 
@@ -27,7 +28,7 @@ FYI: This module is ESM ready!
 ### Requirements
 
 * Installed nodejs/npm. We suggest using [nvm](https://github.com/creationix/nvm).
-* Installed browser and related OS software dependencies e.g. `sudo npx puppeteer browsers install chrome --install-deps`. It requires root privileges that's why it is sudo'ed. Check the puppeteer docs, for other browsers if you're interested. Note: it may require `sudo apt-get update` first to work.
+* **OS Dependencies**: On Debian/Ubuntu systems, the `prepare` step can run a custom command (e.g. `puppeteer browsers install chrome --install-deps`) to install required packages on demand. This is configured via `osDepsCommand`.
 * Using [semantic-release](https://github.com/semantic-release/semantic-release) in your CI/CD process
 
 ### Install
@@ -38,14 +39,27 @@ FYI: This module is ESM ready!
 
 ### Configuration
 
-The plugin can be loaded in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration). Currently no configuration options are available.
+The plugin can be loaded in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration). The `prepare` step handles OS dependencies if `osDepsCommand` is provided (requires `sudo` access on Debian/Ubuntu for system packages).
 
 ```json
 {
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
-    "@hexonet/semantic-release-whmcs"
+    [
+      "@hexonet/semantic-release-whmcs",
+      {
+        "osDepsCommand": [
+          "pnpm",
+          "dlx",
+          "puppeteer",
+          "browsers",
+          "install",
+          "chrome",
+          "--install-deps"
+        ]
+      }
+    ]
   ]
 }
 ```
@@ -81,7 +95,10 @@ That said, before you can use this module for publishing new product/module vers
 
 ### Options
 
-None available yet.
+| Option | Type | Description |
+| --- | --- | --- |
+| `skipOsDeps` | Boolean | **Optional.** Skip OS dependency installation in the prepare step. Default: `false`. Useful if you already have dependencies installed or prefer to manage them yourself. |
+| `osDepsCommand` | string[] | **Optional.** Command to install dependencies (e.g. `["pnpm", "dlx", "puppeteer", "browsers", "install", "chrome", "--install-deps"]`). <br><br> **Note:** The command is automatically executed with `sudo` and the current `PATH` preserved (via `/bin/bash -c "sudo env PATH=$PATH ..."`), so you do not need to add `sudo` yourself. |
 
 ### Routines
 

package/index.js

@@ -1,4 +1,5 @@
 import verifyWHMCS from "./lib/verify.js";
+import prepareWHMCS from "./lib/prepare.js";
 import publishWHMCS from "./lib/publish.js";
 import deleteVersion from "./lib/delete-marketplace-version.js";
 import setCompatibleVersions from "./lib/set-compatible-versions.js";
@@ -8,6 +9,15 @@ import marketplaceVersions from "./lib/scrape-marketplace-versions.js";
 let verified;
 let whmcsPublishResult = null;
 
+/**
+ * Called by semantic-release during the prepare step
+ * @param {*} pluginConfig The semantic-release plugin config
+ * @param {*} context The context provided by semantic-release
+ */
+async function prepare(pluginConfig, context) {
+  await prepareWHMCS(pluginConfig, context);
+}
+
 /**
  * Called by semantic-release during the verify step
  * @param {*} pluginConfig The semantic-release plugin config
@@ -144,6 +154,7 @@ async function fail(pluginConfig, context) {
 }
 
 export default {
+  prepare,
   verifyConditions,
   publish,
   //success,

package/lib/prepare.js

@@ -0,0 +1,110 @@
+import { spawn } from "child_process";
+import debugConfig from "debug";
+
+const debug = debugConfig("semantic-release:whmcs");
+
+// Exported for testing/debugging
+export const DEBIAN_MARKER = "/etc/debian_version";
+
+let spawnImplementation = spawn;
+
+/**
+ * Test-only hook to override the child_process.spawn implementation.
+ * @param {(cmd: string, args?: string[], options?: object) => NodeJS.Process} implementation
+ */
+export function __setSpawnImplementation(implementation) {
+  spawnImplementation = implementation;
+}
+
+/**
+ * Test-only hook to reset spawn back to the native implementation.
+ */
+export function __resetSpawnImplementation() {
+  spawnImplementation = spawn;
+}
+
+/**
+ * Spawn a child process and return a promise
+ * @param {string} command The command to run
+ * @param {string[]} args The arguments to pass to the command
+ * @param {object} options Options to pass to spawn
+ * @returns {Promise<number>} The exit code of the process
+ */
+function spawnPromise(command, args, options = {}) {
+  return new Promise((resolve, reject) => {
+    const child = spawnImplementation(command, args, { stdio: "inherit", ...options });
+    child.on("exit", (code) => {
+      if (code === 0) resolve(code);
+      else reject(new Error(`Process exited with code ${code}`));
+    });
+    child.on("error", reject);
+  });
+}
+
+/**
+ * Check if the system is Debian-like
+ * @returns {Promise<boolean>}
+ */
+async function isDebianLike() {
+  return new Promise((resolve) => {
+    const child = spawnImplementation("test", ["-f", DEBIAN_MARKER], { stdio: "ignore" });
+    child.on("exit", (code) => resolve(code === 0));
+  });
+}
+
+/**
+ * Called by semantic-release during the prepare step
+ * @param {*} pluginConfig The semantic-release plugin config
+ * @param {*} context The context provided by semantic-release
+ */
+export default async (pluginConfig = {}, context = {}) => {
+  const { nextRelease, lastRelease } = context;
+
+  // Only run if there is a new version
+  if (lastRelease?.version && nextRelease?.version === lastRelease.version) {
+    debug("Skipping prepare step: No new version detected");
+    return;
+  }
+
+  // Check if OS dependency installation is disabled
+  if (pluginConfig.skipOsDeps === true) {
+    debug("OS dependency installation skipped (skipOsDeps=true)");
+    console.log("ℹ️  Skipping OS dependency installation");
+    return;
+  }
+
+  try {
+    debug("Installing Chromium/Chrome OS dependencies for puppeteer...");
+    if (await isDebianLike()) {
+      try {
+        debug("Detected Debian/Ubuntu system, installing google-chrome-stable via apt-get");
+
+        // Update package lists and install Google Chrome stable
+        await spawnPromise("sudo", ["apt-get", "update"]);
+        await spawnPromise("sudo", ["apt-get", "install", "-y", "google-chrome-stable"]);
+        debug("Chromium/Chrome dependencies installed successfully");
+
+        // Set Chrome executable path for Puppeteer if configured
+        const chromePath = "/usr/bin/google-chrome-stable";
+        if (!process.env.PUPPETEER_EXECUTABLE_PATH) {
+          process.env.PUPPETEER_EXECUTABLE_PATH = chromePath;
+          debug("Set PUPPETEER_EXECUTABLE_PATH to %s", chromePath);
+        } else {
+          debug("PUPPETEER_EXECUTABLE_PATH already set to %s", process.env.PUPPETEER_EXECUTABLE_PATH);
+        }
+      } catch (error) {
+        debug("Warning: Could not install google-chrome-stable via apt-get: %s", error.message);
+        console.warn(
+          `⚠️  Warning: Failed to install some OS dependencies: ${error.message}\n` +
+            "⚠️  Some dependencies may need to be installed manually or puppeteer may fall back to downloading Chromium"
+        );
+      }
+    } else {
+      debug("Debian/Ubuntu system not detected, skipping OS dependency installation");
+      console.log("ℹ️  Running on non-Debian system. Puppeteer will download Chromium if needed.");
+    }
+  } catch (error) {
+    debug("Prepare step failed: %s", error.message);
+    throw error;
+  }
+};

package/lib/puppet-utils.js

@@ -32,7 +32,7 @@ export async function loginAndNavigate(puppet, context, urlBuilder, gotoOpts) {
   }
   const { page } = püppi.config;
   const url = typeof urlBuilder === "function" ? urlBuilder(püppi) : urlBuilder;
-  const navOpts = gotoOpts || { waitUntil: ["load", "domcontentloaded"], timeout: 10000 };
+  const navOpts = gotoOpts || püppi.config.gotoOpts || { waitUntil: ["load", "domcontentloaded"], timeout: 10000 };
   debug && debug(`Navigating to: ${url} with options: ${JSON.stringify(navOpts)}`);
   await page.goto(url, navOpts);
   debug && debug(`Navigation to ${url} complete.`);

package/lib/puppet.js

@@ -16,14 +16,14 @@ export default async (context) => {
     // logger: logger,
     gotoOpts: {
       waitUntil: ["load", "domcontentloaded"],
-      timeout: 3 * 1000, // 3 seconds
+      timeout: 30 * 1000, // increase to 30 seconds to handle slower loads
     },
     navOpts: {
       waitUntil: ["networkidle0"],
-      timeout: 6 * 1000, // 6 seconds
+      timeout: 30 * 1000, // increase to 30 seconds to handle slower navigation
     },
     selectorOpts: {
-      timeout: 6 * 1000, // 6 seconds
+      timeout: 15 * 1000, // increase to 15 seconds for selector waits
     },
     logger: context.logger,
   };
@@ -74,11 +74,13 @@ export default async (context) => {
   }
 
   async function login() {
-    const { page, login, password, productid, gotoOpts, urlbase, selectorOpts } = config;
+    const { page, login, password, productid, gotoOpts, urlbase, selectorOpts, keepBrowserOpenOnError } = config;
     const submitSelector = 'div.login-leftcol form button[type="submit"]';
     try {
       await page.goto(`${urlbase}/user/login`, gotoOpts);
       debug("login form loaded at %s", `${urlbase}/user/login`);
+      // Give cookie banners/extensions a short window to run before interacting
+      await wait(2000);
       // Wait for login form
       await page.waitForSelector("#email", selectorOpts);
       await page.waitForSelector("#password", selectorOpts);
@@ -103,7 +105,12 @@ export default async (context) => {
           debug("Login failed: no navigation, no selector, and no error alert after submit");
         }
         // await page.screenshot({ path: `login-failed-no-redirect-or-selector.png` });
-        await safeClose(page);
+        if (keepBrowserOpenOnError) {
+          debug("Keeping browser open for debugging after login failure.");
+          await wait(60 * 1000);
+        } else {
+          await safeClose(page);
+        }
         return false;
       }
       debug("WHMCS Marketplace login succeeded (redirected: %s, selectorFound: %s)", redirected, selectorFound);
@@ -114,7 +121,12 @@ export default async (context) => {
       } catch (e) {
         debug("Screenshot failed", e.message);
       }
-      await safeClose(page);
+      if (keepBrowserOpenOnError) {
+        debug("Keeping browser open for debugging after login error.");
+        await wait(60 * 1000);
+      } else {
+        await safeClose(page);
+      }
       return false;
     }
 
@@ -122,7 +134,12 @@ export default async (context) => {
     let tmp = productid;
     if (!tmp || !/^[0-9]+$/.test(productid) || !parseInt(productid, 10)) {
       debug("No or invalid WHMCS Marketplace Product ID provided.");
-      await safeClose(page);
+      if (keepBrowserOpenOnError) {
+        debug("Keeping browser open for debugging due to invalid product id.");
+        await wait(60 * 1000);
+      } else {
+        await safeClose(page);
+      }
       return false;
     }
     tmp = tmp.replace(/(.)/g, "$&\u200E");

package/lib/resolve-config.js

@@ -10,5 +10,6 @@ export default (context) => {
     headless: env.PUPPETEER_HEADLESS || "1",
     debug: (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false,
     useCookieExtension: env.USE_COOKIE_EXTENSION || true,
+    keepBrowserOpenOnError: env.PUPPETEER_KEEP_OPEN === "1" || env.PUPPETEER_KEEP_OPEN === "true" || false,
   };
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hexonet/semantic-release-whmcs",
   "description": "`semantic-release` plugin for auto-publishing on WHMCS marketplace",
-  "version": "5.1.22",
+  "version": "5.2.0",
   "private": false,
   "type": "module",
   "publishConfig": {
@@ -72,20 +72,20 @@
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/exec": "^7.0.3",
+    "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^10.0.1",
     "ava": "6.4.1",
-    "c8": "^10.0.0",
-    "prettier": "^3.0.0",
-    "semantic-release": "^25.0.1",
+    "c8": "^10.1.3",
+    "prettier": "^3.7.4",
+    "semantic-release": "^25.0.2",
     "semantic-release-teams-notify-plugin": "github:centralnicgroup-opensource/rtldev-middleware-semantic-release-notify-plugin",
-    "stream-buffers": "^3.0.2"
+    "stream-buffers": "^3.0.3"
   },
   "dependencies": {
-    "@octokit/rest": "^22.0.0",
+    "@octokit/rest": "^22.0.1",
     "@semantic-release/error": "^4.0.0",
     "aggregate-error": "^5.0.0",
-    "debug": "^4.3.4",
+    "debug": "^4.4.3",
     "puppeteer": ">=23.4.0",
     "yargs": "^18.0.0"
   }

package/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+onlyBuiltDependencies:
+  - puppeteer