@hexonet/semantic-release-whmcs 4.0.2 → 4.0.3

package/lib/delete-marketplace-version.js

@@ -1,105 +1,86 @@
 const debug = require('debug')('semantic-release:whmcs')
-const resolveConfig = require('./resolve-config')
 const puppet = require('./puppet')
+const path = require('path')
 
 /**
  * A method to publish the module update on whmcs market place
  */
 module.exports = async (pluginConfig, context) => {
-  const {
-    version,
-    logger
-  } = context
+  // if (!context.logger) {
+  //    context.logger = console;
+  // }
 
+  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
+  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
+
+  const { version } = context
   if (!version || !version.length) {
-    debug('deleting product version failed. No input data available.')
-    logger.error('WHMCS Marketplace deleting product version failed. No input data available.')
+    debug(`${out}Deleting product version failed. No input data available.`)
     return false
   }
 
-  let success = true
-  const { whmcsLOGIN, whmcsPASSWORD, whmcsPRODUCTID, withHEAD, DEBUG } = resolveConfig(context)
-  const { gotoOpts, navOpts, selectorOpts, page } = await puppet(withHEAD, DEBUG, logger)
-
-  debug(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-  logger.log(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
+  debug(`${out}Delete Version: ${version}`)
 
-  debug(`Delete Version: ${version}`)
-  logger.log(`Delete Version: ${version}`)
+  const püppi = await puppet(context)
+  const result = await püppi.login()
+  if (!result) {
+    return result
+  }
+  const { page, navOpts, gotoOpts, selectorOpts, productid, urlbase } =
+    püppi.config
 
   // strip markdown links from notes as not allowed to keep
-  const wmbase = 'https://marketplace.whmcs.com'
-  let url = `${wmbase}/user/login`
-
   try {
+    // navigate to product administration
+    const url = `${urlbase}/product/${productid}/edit#versions`
     await page.goto(url, gotoOpts)
-    // do login
-    const selector = 'div.login-leftcol form button[type="submit"]'
-    await page.waitForSelector(selector, selectorOpts)
-    debug('login form loaded at %s', url)
-    await page.type('#email', whmcsLOGIN)
-    await page.type('#password', whmcsPASSWORD)
-    debug('WHMCS Marketplace credentials entered')
-    const nav = page.waitForNavigation(navOpts)
-    await page.hover(selector)
-    await page.click(selector)
-    await nav
-    debug('Login form successfully submitted.')
-    logger.log('WHMCS Marketplace Login Form successfully submitted.')
-  } catch (error) {
-    debug('WHMCS Marketplace login failed.', error.message)
-    logger.error('WHMCS Marketplace login failed.', error.message)
-    success = false
-  }
-  if (success) {
-    try {
-      if (!parseInt(whmcsPRODUCTID, 10)) {
-        return false
-      }
-      // open versions tab
-      url = `${wmbase}/product/${whmcsPRODUCTID}/edit#versions`
-      await page.goto(url, gotoOpts)
-      debug('product page loaded at %s', url)
+    debug('product page loaded at %s', url)
+    // open versions tab (instead of doing it via url)
+    // let selector = '#nav-tabs li a[href="#versions"]';
+    // await page.waitForSelector(selector, selectorOpts);
+    // await page.click(selector);
 
-      // delete version
-      const xpath = `//td[contains(., "Version ${version}")]/following-sibling::td/a[contains(@class, "btn-styled-red")]`
-      await page.waitForXPath(xpath, selectorOpts)
+    // delete version
+    // xpath improvements / changes with v16.1.0
+    // -> https://github.com/puppeteer/puppeteer/pull/8730
+    // https://github.com/puppeteer/puppeteer/blob/d1681ec06b7c3db4b51c20b17b3339f852efbd4d/test/src/queryhandler.spec.ts
+    let elements = []
+    do {
+      const xpath = `xpath/.//td[contains(., "Version ${version}")]/following-sibling::td/a[contains(@class, "btn-styled-red")]`
+      await page.waitForSelector(xpath, selectorOpts)
       debug('XPath found.')
-      let nav = page.waitForNavigation(navOpts)
-      /* istanbul ignore next */
-      const elements = await page.$x(xpath)
-      debug('Delete Button - click.')
-      await elements[0].hover()
-      await elements[0].click()
-      debug('Delete Button - clicked.')
-      await nav
-      debug('Navigation finished.')
-
-      // confirm deletion
-      const selector = 'div.listing-edit-container form button[type="submit"]'
-      await page.waitForSelector(selector, selectorOpts)
-      debug('confirmation form loaded at %s', url)
-      nav = page.waitForNavigation(navOpts)
-      await page.hover(selector)
-      await page.click(selector)
-      await nav
-
-      debug('deleting product version succeeded.')
-      logger.log('WHMCS Marketplace deleting product version succeeded.')
-      success = true
-    } catch (error) {
-      debug('deleting product version failed.', error.message)
-      logger.error('WHMCS Marketplace deleting product version failed.', error.message)
-      success = false
+      const nav = page.waitForNavigation(navOpts)
+      elements = await page.$$(xpath)
+      if (elements.length) {
+        debug('Delete Button - click.')
+        await elements[0].hover()
+        await elements[0].click()
+        debug('Delete Button - clicked.')
+        await nav
+        debug('Navigation finished.')
+        // confirm deletion
+        const selector = 'button.btn-styled-red'
+        await page.waitForSelector(selector, selectorOpts)
+        debug('deletion confirmation button available')
+        debug('click confirmation button')
+        await page.clickAndNavigate(selector)
+        debug('clicked confirmation button')
+        await nav
+        debug('WHMCS Marketplace deleting product version succeeded.')
+      }
+    } while (elements.length)
+  } catch (error) {
+    // while loop and having all versions deleted
+    if (!/waiting for selector `.\/\//i.test(error.message)) {
+      debug('Deleting product version failed.', error.message)
+      await page.browser().close()
+      return false
     }
   }
 
   await page.browser().close()
-  if (!success) {
-    return false
-  }
   return {
     name: 'WHMCS Marketplace Product Version',
-    url: `${wmbase}/product/${whmcsPRODUCTID}`
+    url: `${urlbase}/product/${productid}`
   }
 }

package/lib/get-github-releases.js

@@ -9,27 +9,25 @@ const GitHub = require('github-api')
  * A method to get releases from github repository
  */
 module.exports = async (pluginConfig, context) => {
-  const {
-    logger
-  } = context
-
   debug('Getting releases from GitHub')
-  logger.log('Getting releases from GitHub')
 
-  const { githubREPO, githubTOKEN } = resolveConfig(context)
+  const { ghrepo, ghtoken } = resolveConfig(context)
 
   const gh = new GitHub({
-    token: githubTOKEN
+    token: ghtoken
   })
-  if (githubREPO) { // optional by default false
-    const repo = githubREPO.split('/')
+  if (ghrepo) {
+    // optional by default false
+    const repo = ghrepo.split('/')
     const githubReleases = await gh.getRepo(repo[0], repo[1]).listReleases()
     if (githubReleases.status === 200) {
-      githubReleases.data.forEach(r => logger.log(`Detected GitHub release ${r.name.substring(1)}`))
+      githubReleases.data.forEach((r) =>
+        debug(`Detected GitHub release ${r.name.substring(1)}`)
+      )
       githubReleases.data.reverse()
       return githubReleases.data
     }
-    logger.log('Failed to get releases from GitHub')
+    debug('Failed to get releases from GitHub')
   }
   return false
 }

package/lib/publish.js

@@ -1,136 +1,95 @@
-const debug = require('debug')('semantic-release:whmcs')
-const resolveConfig = require('./resolve-config')
-const puppet = require('./puppet')
-const setCompatibleVersions = require('./set-compatible-versions')
+const debug = require("debug")("semantic-release:whmcs");
+const puppet = require("./puppet");
+const setCompatibleVersions = require("./set-compatible-versions");
+const path = require("path");
 
 /**
  * A method to publish the module update on whmcs market place
  */
 module.exports = async (pluginConfig, context) => {
+  const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
+  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`;
+
   const {
     nextRelease: { notes, version, releaseDate },
-    logger
-  } = context
-
+  } = context;
   if (!notes || !notes.length || !version || !version.length) {
-    debug('publishing new product version failed. No input data available.')
-    logger.error(
-      'WHMCS Marketplace publishing new product version failed. No input data available.'
-    )
+    debug(
+      `${out}Publishing new product version failed. No input data available.`
+    );
+    return false;
   }
-
-  let success = true
-  const { whmcsLOGIN, whmcsPASSWORD, whmcsPRODUCTID, withHEAD, DEBUG } =
-    resolveConfig(context)
-  const { gotoOpts, navOpts, selectorOpts, page } = await puppet(withHEAD, DEBUG, logger)
-
-  debug(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-  logger.log(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-
-  debug(`Release Version: ${version}`)
-  logger.log(`Release Version: ${version}`)
-  debug(`Notes: ${notes}`)
-  logger.log(`Release Notes: ${notes}`)
-
   // strip markdown links from notes as not allowed to keep (taken from remove-markdown and cleaned up)
-  const cleanedNotes = notes.replace(/\[([^[\]]*)\]\([^()]*\)/gm, '$1')
-
-  const wmbase = 'https://marketplace.whmcs.com'
-  let url = `${wmbase}/user/login`
+  const cleanedNotes = notes.replace(/\[([^[\]]*)\]\([^()]*\)/gm, "$1");
 
-  try {
-    await page.goto(url, gotoOpts)
-    // do login
-    const selector = 'div.login-leftcol form button[type="submit"]'
-    await page.waitForSelector(selector, selectorOpts)
-    debug('login form loaded at %s', url)
-    await page.type('#email', whmcsLOGIN)
-    await page.type('#password', whmcsPASSWORD)
-    debug('WHMCS Marketplace credentials entered')
-    const nav = page.waitForNavigation(navOpts)
-    await page.hover(selector)
-    await page.click(selector)
-    await nav
-    debug('Login form successfully submitted.')
-    logger.log('WHMCS Marketplace Login Form successfully submitted.')
-  } catch (error) {
-    debug('WHMCS Marketplace login failed.', error.message)
-    logger.error('WHMCS Marketplace login failed.', error.message)
-    success = false
+  const püppi = await puppet(context);
+  const result = await püppi.login();
+  if (!result) {
+    return result;
   }
-  if (success) {
-    try {
-      if (!parseInt(whmcsPRODUCTID, 10)) {
-        return false
-      }
-      // add new version
-      url = `${wmbase}/product/${whmcsPRODUCTID}/versions/new`
-      await page.goto(url, gotoOpts)
-      debug('product page loaded at %s', url)
-      const selector = 'div.listing-edit-container form button[type="submit"]'
-      await page.waitForSelector(selector, selectorOpts)
-      debug('product page submit button selector found')
-      /* istanbul ignore next */
-      await page.$eval(
-        '#version',
-        (el, value) => {
-          el.value = value
-        },
-        version
-      )
-      debug('form input for version finished.')
+  const { page, gotoOpts, selectorOpts, productid, urlbase } = püppi.config;
 
-      // fill input type date with localized string
-      // https://www.mattzeunert.com/2020/04/01/filling-out-a-date-input-with-puppeteer.html
-      const date = releaseDate ? new Date(releaseDate) : new Date()
-      /* istanbul ignore next */
-      const dateString = await page.evaluate(
-        (d) =>
-          new Date(d).toLocaleDateString(navigator.language, {
-            day: '2-digit',
-            month: '2-digit',
-            year: 'numeric'
-          }),
-        date.toISOString()
-      )
-      await page.type('#released_at', dateString)
+  debug(`Release Version: ${version}`);
+  debug(`Notes: ${notes}`);
 
-      debug('form input for released_at finished.')
-      /* istanbul ignore next */
-      await page.$eval(
-        '#description',
-        (el, value) => {
-          el.value = value
-        },
-        cleanedNotes
-      )
-      debug('form input for description finished.')
-      const nav = page.waitForNavigation(navOpts)
-      await page.hover(selector)
-      await page.click(selector)
-      await nav
+  try {
+    // add new version
+    const url = `${urlbase}/product/${productid}/versions/new`;
+    await page.goto(url, gotoOpts);
+    debug("product page loaded at %s", url);
+    const selector = 'div.listing-edit-container form button[type="submit"]';
+    await page.waitForSelector(selector, selectorOpts);
+    debug("product page submit button selector found");
+    /* istanbul ignore next */
+    await page.$eval(
+      "#version",
+      (el, value) => {
+        el.value = value;
+      },
+      version
+    );
+    debug("form input for version finished.");
 
-      await setCompatibleVersions(pluginConfig, context)
+    // fill input type date with localized string
+    // https://www.mattzeunert.com/2020/04/01/filling-out-a-date-input-with-puppeteer.html
+    const date = releaseDate ? new Date(releaseDate) : new Date();
+    /* istanbul ignore next */
+    const dateString = await page.evaluate(
+      (d) =>
+        new Date(d).toLocaleDateString(navigator.language, {
+          day: "2-digit",
+          month: "2-digit",
+          year: "numeric",
+        }),
+      date.toISOString()
+    );
+    await page.enterAndType("#released_at", dateString);
 
-      debug('publishing new product version succeeded.')
-      logger.log('WHMCS Marketplace publishing new product version succeeded.')
-      success = true
-    } catch (error) {
-      debug('publishing new product version failed.', error.message)
-      logger.error(
-        'WHMCS Marketplace publishing new product version failed.',
-        error.message
-      )
-      success = false
-    }
-  }
+    debug("form input for released_at finished.");
+    /* istanbul ignore next */
+    await page.$eval(
+      "#description",
+      (el, value) => {
+        el.value = value;
+      },
+      cleanedNotes
+    );
+    debug("form input for description finished.");
 
-  await page.browser().close()
-  if (!success) {
-    return false
+    await page.clickAndNavigate(
+      'div.listing-edit-container form button[type="submit"]'
+    );
+    await setCompatibleVersions(pluginConfig, context);
+  } catch (error) {
+    debug("Publishing new product version failed.", error.message);
+    await page.browser().close();
+    return false;
   }
+  debug("Publishing new product version succeeded.");
+  await page.browser().close();
+
   return {
-    name: 'WHMCS Marketplace Product Version',
-    url: `${wmbase}/product/${whmcsPRODUCTID}`
-  }
-}
+    name: "WHMCS Marketplace Product Version",
+    url: `${urlbase}/product/${productid}`,
+  };
+};

package/lib/puppet.js

@@ -1,25 +1,31 @@
 const puppeteer = require('puppeteer')
+const debug = require('debug')('semantic-release:whmcs')
+const resolveConfig = require('./resolve-config')
 
-module.exports = async (withHEAD, DEBUG, logger) => {
-  if (!logger) {
-    logger = console
-  }
-  const gotoOpts = {
-    waitUntil: ['load', 'domcontentloaded'],
-    timeout: 240000
-  }
-  const navOpts = {
-    waitUntil: 'networkidle0',
-    timeout: 240000
-  }
-  const selectorOpts = {
-    timeout: 10000
+module.exports = async (context) => {
+  const cfg = {
+    urlbase: 'https://marketplace.whmcs.com',
+    ...resolveConfig(context),
+    // logger: logger,
+    gotoOpts: {
+      waitUntil: ['load', 'domcontentloaded'],
+      timeout: 240000
+    },
+    navOpts: {
+      waitUntil: ['networkidle0'],
+      timeout: 240000
+    },
+    selectorOpts: {
+      timeout: 10000
+    },
+    logger: context.logger
   }
 
   const browser = await puppeteer.launch({
-    headless: !withHEAD,
+    headless: cfg.headless === '1',
     defaultViewport: null, // automatically full-sized
     args: [
+      '--disable-gpu',
       '--incognito',
       '--start-maximized',
       '--no-sandbox',
@@ -27,24 +33,21 @@ module.exports = async (withHEAD, DEBUG, logger) => {
       '--disable-infobars',
       '--ignore-certifcate-errors',
       '--ignore-certifcate-errors-spki-list',
-      '--ignoreHTTPSErrors=true',
-      '--user-agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Safari/537.36"'
+      '--ignoreHTTPSErrors=true'
     ]
   })
+  const { logger } = cfg
   const [page] = await browser.pages()
-
-  await page.setRequestInterception(true)
-  page.on('request', request => {
-    if (/^(image|stylesheet|other)$/i.test(request.resourceType())) {
-      request.abort()
-    } else {
-      request.continue()
-    }
+  await page.setExtraHTTPHeaders({
+    'Accept-Language': 'en-GB,en-US;q=0.9,en;q=0.8'
   })
+  await page.setUserAgent(
+    'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36'
+  )
   await page.setJavaScriptEnabled(true)
 
-  if (DEBUG) {
-    page.on('console', msg => {
+  if (cfg.debug) {
+    page.on('console', (msg) => {
       for (let i = 0; i < msg.args().length; i++) {
         logger.log(`${i}: ${msg.args()[i]}`)
       }
@@ -52,11 +55,59 @@ module.exports = async (withHEAD, DEBUG, logger) => {
   }
 
   page.clickAndNavigate = async (selector) => {
+    const { page, navOpts } = this.config
     const nav = page.waitForNavigation(navOpts)
     await page.hover(selector)
     await page.click(selector)
     await nav
   }
 
-  return { page, gotoOpts, navOpts, selectorOpts }
+  page.enterAndType = async (selector, value) => {
+    const { page, selectorOpts } = this.config
+    await page.waitForSelector(selector, selectorOpts)
+    await page.type(selector, value)
+  }
+
+  this.login = async () => {
+    const { page, login, password, productid, gotoOpts, urlbase } = this.config
+    const selector = 'div.login-leftcol form button[type="submit"]'
+    // do login
+    try {
+      await page.goto(`${urlbase}/user/login`, gotoOpts)
+      debug('login form loaded at %s', `${urlbase}/user/login`)
+      await page.enterAndType('#email', login)
+      await page.enterAndType('#password', password)
+      debug('WHMCS Marketplace credentials entered')
+      await page.clickAndNavigate(selector)
+      debug('WHMCS Marketplace login form submitted.')
+    } catch (error) {
+      debug(
+        'WHMCS Marketplace login failed or Product ID missing',
+        error.message
+      )
+      await page.browser().close()
+      return false
+    }
+    debug('WHMCS Marketplace login succeeded.')
+
+    // access MP Product ID
+    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()
+      return false
+    }
+
+    tmp = tmp.replace(/(.)/g, '$&\u200E')
+    debug(`WHMCS Marketplace Product ID: ${tmp}`)
+
+    return true
+  }
+
+  this.config = {
+    ...cfg,
+    page
+  }
+
+  return this
 }

package/lib/resolve-config.js

@@ -1,10 +1,11 @@
 module.exports = ({ env }) => ({
-  whmcsLOGIN: env.WHMCSMP_LOGIN || false,
-  whmcsPASSWORD: env.WHMCSMP_PASSWORD || false,
-  whmcsPRODUCTID: env.WHMCSMP_PRODUCTID || false,
-  whmcsMINVERSION: env.WHMCSMP_MINVERSION || '7.10',
-  githubTOKEN: env.GH_TOKEN || env.GITHUB_TOKEN || false,
-  githubREPO: env.GH_REPO || env.GITHUB_REPO || false,
-  withHEAD: env.WITH_HEAD || false,
-  DEBUG: (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false
+  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
 })