@hexonet/semantic-release-whmcs 5.1.2 → 5.1.3

package/HISTORY.md

@@ -1,3 +1,10 @@
+## [5.1.3](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.1.2...v5.1.3) (2025-09-04)
+
+
+### Bug Fixes
+
+* **core:** implement timeout handling for publish operations and improve error handling in compatibility updates ([5fc8b34](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/5fc8b345a8412e0ec0bfa92922fe2939af84224a))
+
 ## [5.1.2](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v5.1.1...v5.1.2) (2025-09-01)
 
 

package/README.md

@@ -76,6 +76,7 @@ That said, before you can use this module for publishing new product/module vers
 | `PUPPETEER_HEADLESS` | **Optional.** Toggle headless mode on/off. by default true. Values: 1,0. |
 | `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. |
 
 ### Options
 

package/index.js

@@ -6,6 +6,7 @@ import githubReleases from "./lib/get-github-releases.js";
 import marketplaceVersions from "./lib/scrape-marketplace-versions.js";
 
 let verified;
+let whmcsPublishResult = null;
 
 /**
  * Called by semantic-release during the verify step
@@ -26,9 +27,30 @@ async function verifyConditions(pluginConfig, context) {
  */
 async function publish(pluginConfig, context) {
   await verifyConditions(pluginConfig, context);
-  return publishWHMCS(pluginConfig, context);
+
+  const result = await publishWHMCS(pluginConfig, context);
+
+  // Store the result globally for success/fail hooks
+  whmcsPublishResult = {
+    success: !!result,
+    version: context.nextRelease?.version,
+    result: result,
+  };
+
+  if (result) {
+    console.log(`✅ WHMCS: Published version ${context.nextRelease?.version}`);
+  } else {
+    console.log(`❌ WHMCS: Failed to publish version ${context.nextRelease?.version}`);
+  }
+
+  return result;
 }
 
+/**
+ * Sync versions from GitHub releases to WHMCS marketplace
+ * @param {*} pluginConfig The semantic-release plugin config
+ * @param {*} context The context provided by semantic-release
+ */
 async function syncVersions(pluginConfig, context) {
   await verifyConditions(pluginConfig, context);
   const releases = await githubReleases(pluginConfig, context);
@@ -43,29 +65,88 @@ async function syncVersions(pluginConfig, context) {
           releaseDate: release.published_at,
         };
         console.log(`Adding missing version ${context.nextRelease.version}`);
-        await publish(pluginConfig, context);
+        const result = await publish(pluginConfig, context);
+        console.log(`Published version ${context.nextRelease.version}:`, result);
       }
     }
   }
+  return undefined;
 }
 
+/**
+ * Delete a version from WHMCS marketplace
+ * @param {*} pluginConfig The semantic-release plugin config
+ * @param {*} context The context provided by semantic-release
+ */
 async function delVersion(pluginConfig, context) {
   await verifyConditions(pluginConfig, context);
-  await deleteVersion(pluginConfig, context);
+  const result = await deleteVersion(pluginConfig, context);
+  return result;
 }
 
+/**
+ * Update compatibility versions for a product
+ * @param {*} pluginConfig The semantic-release plugin config
+ * @param {*} context The context provided by semantic-release
+ */
 async function updateCompatibility(pluginConfig, context) {
   await verifyConditions(pluginConfig, context);
-  await setCompatibleVersions(pluginConfig, context);
+  const result = await setCompatibleVersions(pluginConfig, context);
+  return result;
 }
 
+// /**
+//  * Called by semantic-release when a release succeeds
+//  * @param {*} pluginConfig The semantic-release plugin config
+//  * @param {*} context The context provided by semantic-release
+//  */
+// async function success(pluginConfig, context) {
+//   if (whmcsPublishResult) {
+//     if (whmcsPublishResult.success) {
+//       console.log(`🎉 WHMCS: Successfully published version ${whmcsPublishResult.version} to marketplace`);
+//       if (whmcsPublishResult.result?.url) {
+//         console.log(`🔗 WHMCS: ${whmcsPublishResult.result.url}`);
+//       }
+//     } else {
+//       console.log(`⚠️  WHMCS: Version ${whmcsPublishResult.version} was NOT published to marketplace (WHMCS publish failed)`);
+//     }
+//   } else {
+//     console.log(`⚠️  WHMCS: No WHMCS publish attempted during this release`);
+//   }
+// }
+
+/**
+ * Called by semantic-release when a release fails
+ * @param {*} pluginConfig The semantic-release plugin config
+ * @param {*} context The context provided by semantic-release
+ */
 async function fail(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context);
+  if (whmcsPublishResult) {
+    if (whmcsPublishResult.success) {
+      console.log(`✅ WHMCS: Version ${whmcsPublishResult.version} was successfully published to marketplace`);
+      console.log(`ℹ️  WHMCS: Release failed due to other plugins, not WHMCS`);
+    } else {
+      console.log(`❌ WHMCS: Failed to publish version ${whmcsPublishResult.version} to marketplace`);
+    }
+  } else {
+    console.log(`ℹ️  WHMCS: No WHMCS publish was attempted before failure`);
+  }
+
+  // Also show any WHMCS-specific errors from context
+  const { errors } = context;
+  const whmcsErrors = errors?.filter(
+    (e) => e.message?.toLowerCase().includes("whmcs") || e.message?.toLowerCase().includes("marketplace")
+  );
+
+  if (whmcsErrors?.length > 0) {
+    console.log(`🔍 WHMCS: ${whmcsErrors.map((e) => e.message).join(", ")}`);
+  }
 }
 
 export default {
   verifyConditions,
   publish,
+  //success,
   fail,
   syncVersions,
   delVersion,

package/lib/delete-marketplace-version.js

@@ -88,8 +88,8 @@ export default async (pluginConfig, context) => {
     }
 
     // Click the confirmation button and wait for navigation/alert
-    await clickAndWaitForResult(page, 'button[type="submit"].btn-styled-red', { navOpts });
-    await wait(200);
+    await clickAndWaitForResult(page, "button.btn-styled-red", { navOpts });
+    await wait(300);
     debug("Checking for alert-success after confirmation...");
     const result = await waitForSubmitResult(page, { timeout: navOpts.timeout });
     if (result === "error") {
@@ -103,7 +103,7 @@ export default async (pluginConfig, context) => {
     } else {
       // Fallback: check if the version row is gone
       debug("No success or error alert appeared after delete. Checking if version row is gone...");
-      await page.waitForSelector("table", { timeout: 5000 });
+      await page.waitForSelector("table", { timeout: 1000 });
       const rowsAfter = await page.$$("tr");
       for (const row of rowsAfter) {
         const textContent = await row.evaluate((el) => el.textContent);

package/lib/publish.js

@@ -23,6 +23,7 @@ export default async (pluginConfig, context) => {
   const cleanedNotes = notes.replace(/\[([^[\]]*)\]\([^()]*\)/gm, "$1");
 
   let page, püppi, urlbase, productid, gotoOpts, selectorOpts;
+  let success = false;
 
   debug(`Release Version: ${version}`);
   debug(`Notes: ${notes}`);
@@ -77,25 +78,42 @@ export default async (pluginConfig, context) => {
     const result = await waitForSubmitResult(page, { timeout: selectorOpts.timeout || 15000 });
     if (result === "error") {
       debug("Publish failed: error alert shown.");
-      await safeClose(page);
-      return false;
+      success = false;
     } else if (result === "success") {
       debug("Publish succeeded.");
+      success = true;
     } else {
       debug("No success or error alert appeared after submit.");
+      success = false;
     }
 
-    await setCompatibleVersions(pluginConfig, context);
+    // Call setCompatibleVersions with proper error handling
+    if (success) {
+      try {
+        await setCompatibleVersions(pluginConfig, context);
+        debug("Compatible versions set successfully.");
+      } catch (compatError) {
+        debug("Setting compatible versions failed:", compatError.message);
+        // Don't fail the main publish, just log the error
+      }
+    }
   } catch (error) {
     debug("Publishing new product version failed.", error.message);
-    await safeClose(page);
-    return false;
+    success = false;
+  } finally {
+    if (page) {
+      await safeClose(page);
+    }
   }
-  debug("Publishing new product version succeeded.");
-  await safeClose(page);
 
-  return {
-    name: "WHMCS Marketplace Product Version",
-    url: `${urlbase}/product/${productid}`,
-  };
+  if (success) {
+    debug("Publishing new product version succeeded.");
+    return {
+      name: "WHMCS Marketplace Product Version",
+      url: `${urlbase}/product/${productid}`,
+    };
+  } else {
+    debug("Publishing new product version failed.");
+    return false;
+  }
 };

package/lib/puppet-utils.js

@@ -54,7 +54,7 @@ export async function clickAndWaitForResult(page, selector, { navOpts, resultTim
   let navigated = false;
   try {
     await Promise.all([
-      page.waitForNavigation({ waitUntil: "networkidle0", timeout: navOpts?.timeout || 10000 }),
+      page.waitForNavigation({ waitUntil: "domcontentloaded", timeout: navOpts?.timeout || 10000 }),
       btn.evaluate((el) => el.click()),
     ]);
     navigated = true;

package/lib/puppet.js

@@ -3,7 +3,7 @@ import resolveConfig from "./resolve-config.js";
 import debugConfig from "debug";
 import path from "path";
 import { fileURLToPath } from "url";
-import { waitForNavigationOrSelector, robustType, wait } from "./puppet-utils.js";
+import { waitForNavigationOrSelector, robustType, wait, safeClose } from "./puppet-utils.js";
 const debug = debugConfig("semantic-release:whmcs");
 
 const __filename = fileURLToPath(import.meta.url);
@@ -16,14 +16,14 @@ export default async (context) => {
     // logger: logger,
     gotoOpts: {
       waitUntil: ["load", "domcontentloaded"],
-      timeout: 20 * 1000,
+      timeout: 3 * 1000, // 3 seconds
     },
     navOpts: {
       waitUntil: ["networkidle0"],
-      timeout: 20 * 1000,
+      timeout: 6 * 1000, // 6 seconds
     },
     selectorOpts: {
-      timeout: 20 * 1000,
+      timeout: 6 * 1000, // 6 seconds
     },
     logger: context.logger,
   };
@@ -51,7 +51,7 @@ export default async (context) => {
   }
 
   const browser = await puppeteer.launch({
-    headless: cfg.headless === "1" ? "true" : false,
+    headless: cfg.headless === "1" ? true : false,
     defaultViewport: null, // automatically full-sized
     args: launchArgs,
   });
@@ -92,7 +92,7 @@ export default async (context) => {
       const { redirected, selectorFound, url } = await waitForNavigationOrSelector(page, {
         urlPart: "/account",
         selector: ".account-navbar",
-        timeout: 5000,
+        timeout: 15000,
       });
       if (!redirected && !selectorFound) {
         // Check for alert-danger (login error) on the same page
@@ -103,7 +103,7 @@ 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 page.browser().close();
+        await safeClose(page);
         return false;
       }
       debug("WHMCS Marketplace login succeeded (redirected: %s, selectorFound: %s)", redirected, selectorFound);
@@ -114,7 +114,7 @@ export default async (context) => {
       } catch (e) {
         debug("Screenshot failed", e.message);
       }
-      await page.browser().close();
+      await safeClose(page);
       return false;
     }
 
@@ -122,7 +122,7 @@ 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 page.browser().close();
+      await safeClose(page);
       return false;
     }
     tmp = tmp.replace(/(.)/g, "$&\u200E");

package/lib/resolve-config.js

@@ -1,11 +1,14 @@
-export default ({ env }) => ({
-  login: env.WHMCSMP_LOGIN || false,
-  password: env.WHMCSMP_PASSWORD || false,
-  productid: env.WHMCSMP_PRODUCTID || false,
-  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",
-  debug: (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false,
-  useCookieExtension: env.USE_COOKIE_EXTENSION || true,
-});
+export default (context) => {
+  const env = context?.env || process.env;
+  return {
+    login: env.WHMCSMP_LOGIN || false,
+    password: env.WHMCSMP_PASSWORD || false,
+    productid: env.WHMCSMP_PRODUCTID || false,
+    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",
+    debug: (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false,
+    useCookieExtension: env.USE_COOKIE_EXTENSION || true,
+  };
+};

package/lib/set-compatible-versions.js

@@ -2,6 +2,7 @@ import puppet from "./puppet.js";
 import debugConfig from "debug";
 import { fileURLToPath } from "node:url";
 import { robustType, wait, waitForSubmitResult, loginAndNavigate, clickAndWaitForResult } from "./puppet-utils.js";
+import { safeClose } from "./puppet-utils.js";
 const debug = debugConfig("semantic-release:whmcs");
 const __filename = fileURLToPath(import.meta.url);
 
@@ -12,10 +13,9 @@ export default async (pluginConfig, context) => {
   const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
   const out = `\n${sep}\n${__filename}\n${sep}\n`;
 
-  let page, püppi;
-  const { productid, urlbase, gotoOpts, selectorOpts, minversion } = (context && context.config) || {};
-
+  let page, püppi, urlbase, productid, gotoOpts, selectorOpts, minversion;
   debug(out);
+  let success = false;
   try {
     // Login and navigate to compatibility page
     ({ page, püppi } = await loginAndNavigate(
@@ -24,7 +24,7 @@ export default async (pluginConfig, context) => {
       (p) => `${p.config.urlbase}/product/${p.config.productid}/edit#compatibility`,
       undefined
     ));
-    const { urlbase, productid, gotoOpts, selectorOpts, minversion } = püppi.config;
+    ({ urlbase, productid, gotoOpts, selectorOpts, minversion } = püppi.config);
     const url = `${urlbase}/product/${productid}/edit#compatibility`;
     debug("product page loaded at %s", url);
 
@@ -69,20 +69,30 @@ export default async (pluginConfig, context) => {
     const result = await waitForSubmitResult(page, { timeout: gotoOpts.timeout || 10000 });
     if (result === "error") {
       debug("Compatibility update failed: error alert shown.");
-      await page.browser().close();
-      return false;
+      success = false;
     } else if (result === "success") {
       debug("Compatibility update succeeded.");
+      success = true;
     } else {
       debug("No success or error alert appeared after submit.");
     }
   } catch (error) {
     debug("Updating whmcs compatibility list failed.", error.message);
-    await page.browser().close();
-    return false;
+    success = false;
+  } finally {
+    if (page) {
+      await safeClose(page);
+    }
   }
 
-  debug("Updating whmcs compatibility list succeeded.");
-  await page.browser().close();
-  return true;
+  if (success) {
+    debug("Updating whmcs compatibility list succeeded.");
+    return {
+      name: "WHMCS Marketplace Compatibility Update",
+      url: `${urlbase}/product/${productid}/edit#compatibility`,
+    };
+  } else {
+    debug("Updating whmcs compatibility list failed.");
+    return 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.2",
+  "version": "5.1.3",
   "private": false,
   "type": "module",
   "publishConfig": {
@@ -40,7 +40,7 @@
     "nodeArguments": [
       "--no-warnings"
     ],
-    "timeout": "10m"
+    "timeout": "5m"
   },
   "prettier": {
     "printWidth": 120,
@@ -77,7 +77,7 @@
     "ava": "6.4.1",
     "c8": "^10.0.0",
     "prettier": "^3.0.0",
-    "semantic-release": "^24.0.0",
+    "semantic-release": "^24.2.7",
     "semantic-release-teams-notify-plugin": "github:centralnicgroup-opensource/rtldev-middleware-semantic-release-notify-plugin",
     "stream-buffers": "^3.0.2"
   },