@hexonet/semantic-release-whmcs 5.2.8 → 5.2.10

package/.env.example

@@ -0,0 +1,15 @@
+# Copy this file to .env and fill in real values.
+# Never commit your .env (it is gitignored).
+
+WHMCSMP_PRODUCTID=product id
+WHMCSMP_LOGIN=your.email@example.com
+WHMCSMP_PASSWORD=your-password
+
+# Recommended for CI/headless environments
+PUPPETEER_HEADLESS=1
+
+# Optional: more logs
+# DEBUG=semantic-release:whmcs
+
+# Optional: stable cache/workdir in Docker
+# PROJECT_WORKDIR=/usr/share/rtldev-middleware-whmcs-src

package/HISTORY.md

@@ -1,3 +1,18 @@
+## [5.2.10](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.2.9...v5.2.10) (2026-02-16)
+
+
+### Bug Fixes
+
+* **deps:** bump puppeteer from 24.37.2 to 24.37.3 ([171b2e2](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/171b2e262aa53093347265249ddcbc893f606541))
+
+## [5.2.9](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.2.8...v5.2.9) (2026-02-06)
+
+
+### Bug Fixes
+
+* **prepare.js:** update OS dependency installation process for Puppeteer on Debian/Ubuntu ([f52c709](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/f52c709a8ec1d7eff02009e83afd9235083a0509))
+* **prepare/puppet:**  enhance prepare.js and puppet.js for improved configuration handling ([450b0e0](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/450b0e0a088afc45286c1cd6ed49b8d325d63c55))
+
 ## [5.2.8](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.2.7...v5.2.8) (2026-02-06)
 
 

package/README.md

@@ -11,7 +11,7 @@
 
 | Step | Description |
 | ---- | ----------- |
-| `prepare` | Install OS dependencies required by Puppeteer and Chromium/Chrome (Debian/Ubuntu only) if `osDepsCommand` is configured. |
+| `prepare` | Install OS dependencies required by Puppeteer and Chromium/Chrome (Debian/Ubuntu only). Can be customized via `osDepsCommand`. |
 | `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. |
 
@@ -28,7 +28,7 @@ FYI: This module is ESM ready!
 ### Requirements
 
 * Installed nodejs/npm. We suggest using [nvm](https://github.com/creationix/nvm).
-* **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`.
+* **OS Dependencies**: On Debian/Ubuntu systems, the `prepare` step installs Chrome (for testing) + required OS packages using `pnpm dlx puppeteer browsers install chrome --install-deps` (falls back to `npx` if `pnpm` is unavailable). You can override the command via `osDepsCommand`.
 * Using [semantic-release](https://github.com/semantic-release/semantic-release) in your CI/CD process
 
 ### Install
@@ -39,7 +39,7 @@ 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). The `prepare` step handles OS dependencies if `osDepsCommand` is provided (requires `sudo` access on Debian/Ubuntu for system packages).
+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 on Debian/Ubuntu (requires `sudo` access for system packages).
 
 ```json
 {
@@ -92,6 +92,8 @@ That said, before you can use this module for publishing new product/module vers
 | `GH_TOKEN` | **Optional.** GitHub API authentication token to use for syncing versions. |
 | `GH_REPO` | **Optional.** GitHub repository name (format: organization/repository) to use for syncing versions. |
 | `useCookieExtension` | **Optional.** Use cookies extension when puppeteer is running to avoid cookie banner disruptions. |
+| `WHMCS_OS_DEPS_ALWAYS` | **Optional.** Force OS dependency installation in `prepare` even if there is no new release version. Useful for CI experiments. Values: `1` / `true`. |
+| `SKIP_OS_DEPS` | **Optional.** Skip OS dependency installation in `prepare`. Values: `1` / `true` (also supported: `skipOsDeps`). |
 
 ### Options
 

package/index.js

@@ -1,3 +1,10 @@
+// Set Puppeteer cache dir early, before any puppeteer imports
+import path from "path";
+const workDir = process.env.PROJECT_WORKDIR || process.cwd();
+if (!process.env.PUPPETEER_CACHE_DIR) {
+  process.env.PUPPETEER_CACHE_DIR = path.join(workDir, ".cache", "puppeteer");
+}
+
 import verifyWHMCS from "./lib/verify.js";
 import prepareWHMCS from "./lib/prepare.js";
 import publishWHMCS from "./lib/publish.js";

package/lib/prepare.js

@@ -1,5 +1,8 @@
 import { spawn } from "child_process";
 import debugConfig from "debug";
+import fs from "node:fs";
+import path from "node:path";
+import resolveConfig from "./resolve-config.js";
 
 const debug = debugConfig("semantic-release:whmcs");
 
@@ -23,6 +26,26 @@ export function __resetSpawnImplementation() {
   spawnImplementation = spawn;
 }
 
+function resolveCacheDir(context) {
+  if (process.env.PUPPETEER_CACHE_DIR) return process.env.PUPPETEER_CACHE_DIR;
+  const workDir = process.env.PROJECT_WORKDIR || context?.cwd || process.cwd();
+  return path.join(workDir, ".cache", "puppeteer");
+}
+
+function resolveInstalledChromeExecutable(cacheDir) {
+  try {
+    const chromeDir = path.join(cacheDir, "chrome");
+    if (!fs.existsSync(chromeDir)) return null;
+    const versions = fs.readdirSync(chromeDir).filter(Boolean).sort();
+    if (versions.length === 0) return null;
+    const latest = versions[versions.length - 1];
+    const candidate = path.join(chromeDir, latest, "chrome-linux64", "chrome");
+    return fs.existsSync(candidate) ? candidate : null;
+  } catch {
+    return null;
+  }
+}
+
 /**
  * Spawn a child process and return a promise
  * @param {string} command The command to run
@@ -67,7 +90,8 @@ export default async (pluginConfig = {}, context = {}) => {
   }
 
   // Check if OS dependency installation is disabled
-  if (pluginConfig.skipOsDeps === true) {
+  const cfg = resolveConfig(context);
+  if (pluginConfig.skipOsDeps === true || cfg.skipOsDeps) {
     debug("OS dependency installation skipped (skipOsDeps=true)");
     console.log("ℹ️  Skipping OS dependency installation");
     return;
@@ -77,23 +101,42 @@ export default async (pluginConfig = {}, context = {}) => {
     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);
+        debug("Detected Debian/Ubuntu system, installing Chrome (for testing) + OS deps for Puppeteer");
+
+        const cacheDir = resolveCacheDir(context);
+        process.env.PUPPETEER_CACHE_DIR = cacheDir;
+
+        const envPath = process.env.PATH || "";
+        const home = process.env.HOME || "";
+        const envPrefix = ["env", `PATH=${envPath}`, `HOME=${home}`, `PUPPETEER_CACHE_DIR=${cacheDir}`];
+
+        if (Array.isArray(pluginConfig.osDepsCommand) && pluginConfig.osDepsCommand.length > 0) {
+          await spawnPromise("sudo", [...envPrefix, ...pluginConfig.osDepsCommand]);
         } else {
-          debug("PUPPETEER_EXECUTABLE_PATH already set to %s", process.env.PUPPETEER_EXECUTABLE_PATH);
+          // Straightforward: let Puppeteer's installer handle both Chrome + OS deps.
+          await spawnPromise("sudo", [
+            ...envPrefix,
+            "pnpm",
+            "dlx",
+            "puppeteer",
+            "browsers",
+            "install",
+            "chrome",
+            "--install-deps",
+          ]);
         }
+
+        const execPath = resolveInstalledChromeExecutable(cacheDir);
+        if (execPath) {
+          process.env.PUPPETEER_EXECUTABLE_PATH = execPath;
+          debug("Resolved Chrome executable: %s", execPath);
+        }
+
+        debug("PUPPETEER_CACHE_DIR: %s", process.env.PUPPETEER_CACHE_DIR);
+        debug("PUPPETEER_EXECUTABLE_PATH: %s", process.env.PUPPETEER_EXECUTABLE_PATH);
+        debug("Chrome/Chromium OS dependencies installed successfully");
       } catch (error) {
-        debug("Warning: Could not install google-chrome-stable via apt-get: %s", error.message);
+        debug("Warning: Could not install Chrome/Chromium OS dependencies: %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"

package/lib/puppet.js

@@ -1,14 +1,97 @@
-import puppeteer from "puppeteer";
 import resolveConfig from "./resolve-config.js";
 import debugConfig from "debug";
 import path from "path";
+import fs from "fs";
+import os from "os";
 import { fileURLToPath } from "url";
 import { waitForNavigationOrSelector, robustType, wait, safeClose } from "./puppet-utils.js";
+
 const debug = debugConfig("semantic-release:whmcs");
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 export default async (context) => {
+  // Set PUPPETEER_CACHE_DIR BEFORE importing puppeteer
+  const workDir = process.env.PROJECT_WORKDIR || process.cwd();
+  if (!process.env.PUPPETEER_CACHE_DIR) {
+    process.env.PUPPETEER_CACHE_DIR = path.join(workDir, ".cache", "puppeteer");
+  }
+
+  debug("PROJECT_WORKDIR: %s", process.env.PROJECT_WORKDIR);
+  debug("PUPPETEER_CACHE_DIR: %s", process.env.PUPPETEER_CACHE_DIR);
+  debug("PUPPETEER_EXECUTABLE_PATH: %s", process.env.PUPPETEER_EXECUTABLE_PATH);
+
+  // Check if cache dir exists and list contents
+  const cacheDir = process.env.PUPPETEER_CACHE_DIR;
+  if (fs.existsSync(cacheDir)) {
+    debug("Cache dir contents: %s", fs.readdirSync(cacheDir).join(", "));
+    const chromeDir = path.join(cacheDir, "chrome");
+    if (fs.existsSync(chromeDir)) {
+      debug("Chrome dir contents: %s", fs.readdirSync(chromeDir).join(", "));
+    }
+  } else {
+    debug("Cache dir does NOT exist: %s", cacheDir);
+  }
+
+  const puppeteer = (await import("puppeteer")).default;
+
+  // Get executable path - prefer env var, then puppeteer's default
+  let executablePath = process.env.PUPPETEER_EXECUTABLE_PATH;
+  if (!executablePath) {
+    executablePath = puppeteer.executablePath();
+    debug("Using puppeteer.executablePath(): %s", executablePath);
+  }
+
+  // Check if executable exists
+  if (!fs.existsSync(executablePath)) {
+    // Try to find Chrome in the configured cache dir
+    const chromeDir = path.join(cacheDir, "chrome");
+    let found = false;
+    if (fs.existsSync(chromeDir)) {
+      const versions = fs.readdirSync(chromeDir);
+      debug("Available Chrome versions: %s", versions.join(", "));
+      if (versions.length > 0) {
+        const latestVersion = versions.sort().pop();
+        const possiblePath = path.join(chromeDir, latestVersion, "chrome-linux64", "chrome");
+        if (fs.existsSync(possiblePath)) {
+          executablePath = possiblePath;
+          debug("Found Chrome at: %s", executablePath);
+          found = true;
+        }
+      }
+    }
+
+    if (!found) {
+      // Fallback: Check default cache locations (home dir)
+      // This handles cases where PROJECT_WORKDIR is set but prepare step didn't run or install to project cache
+      const homeCache = path.join(os.homedir(), ".cache", "puppeteer", "chrome");
+      if (fs.existsSync(homeCache)) {
+        debug("Checking fallback cache at: %s", homeCache);
+        const versions = fs.readdirSync(homeCache).filter((v) => v.startsWith("linux-") || v.startsWith("chrome-"));
+        if (versions.length > 0) {
+          const latestVersion = versions.sort().pop();
+          const possiblePath = path.join(homeCache, latestVersion, "chrome-linux64", "chrome");
+          if (fs.existsSync(possiblePath)) {
+            executablePath = possiblePath;
+            debug("Found Chrome in fallback location: %s", executablePath);
+          }
+        }
+      }
+    }
+  }
+
+  if (!fs.existsSync(executablePath)) {
+    throw new Error(
+      `Chrome executable not found at: ${executablePath}\n` +
+        `PUPPETEER_CACHE_DIR: ${cacheDir} (exists: ${fs.existsSync(cacheDir)})\n` +
+        `PUPPETEER_EXECUTABLE_PATH: ${process.env.PUPPETEER_EXECUTABLE_PATH}\n` +
+        `PROJECT_WORKDIR: ${process.env.PROJECT_WORKDIR}\n` +
+        `process.cwd(): ${process.cwd()}`
+    );
+  }
+
+  debug("Final Chrome executable: %s", executablePath);
+
   let config;
   const cfg = {
     urlbase: "https://marketplace.whmcs.com",
@@ -51,9 +134,10 @@ export default async (context) => {
   }
 
   const browser = await puppeteer.launch({
-    headless: cfg.headless === "1" ? true : false,
+    headless: cfg.headless,
     defaultViewport: null, // automatically full-sized
     args: launchArgs,
+    executablePath,
   });
   const { logger } = cfg;
   const [page] = await browser.pages();

package/lib/resolve-config.js

@@ -7,9 +7,10 @@ export default (context) => {
     minversion: env.WHMCSMP_MINVERSION || "7.10",
     ghtoken: env.GH_TOKEN || env.GITHUB_TOKEN || false,
     ghrepo: env.GH_REPO || env.GITHUB_REPO || false,
-    headless: env.PUPPETEER_HEADLESS || "1",
+    headless: env.PUPPETEER_HEADLESS !== "0" && env.PUPPETEER_HEADLESS !== "false" && env.PUPPETEER_HEADLESS !== false,
     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,
+    skipOsDeps: env.SKIP_OS_DEPS === "1" || env.SKIP_OS_DEPS === "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.2.8",
+  "version": "5.2.10",
   "private": false,
   "type": "module",
   "publishConfig": {
@@ -37,6 +37,9 @@
     "files": [
       "test/**/*.test.js"
     ],
+    "require": [
+      "dotenv/config"
+    ],
     "nodeArguments": [
       "--no-warnings"
     ],
@@ -68,7 +71,8 @@
   "overrides": {
     "http-cache-semantics": "^4.1.1",
     "word-wrap": "npm:@aashutoshrathi/word-wrap@1.2.6",
-    "glob-parent": "^5.1.2"
+    "glob-parent": "^5.1.2",
+    "tar": "^7.5.7"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
@@ -76,8 +80,9 @@
     "@semantic-release/git": "^10.0.1",
     "ava": "6.4.1",
     "c8": "^10.1.3",
-    "prettier": "^3.7.4",
-    "semantic-release": "^25.0.2",
+    "dotenv": "^16.6.1",
+    "prettier": "^3.8.1",
+    "semantic-release": "^25.0.3",
     "semantic-release-teams-notify-plugin": "github:centralnicgroup-opensource/rtldev-middleware-semantic-release-notify-plugin",
     "stream-buffers": "^3.0.3"
   },
@@ -86,7 +91,7 @@
     "@semantic-release/error": "^4.0.0",
     "aggregate-error": "^5.0.0",
     "debug": "^4.4.3",
-    "puppeteer": ">=23.4.0",
+    "puppeteer": "^24.37.2",
     "yargs": "^18.0.0"
   }
 }