@hexonet/semantic-release-whmcs 4.0.0 → 4.0.3

package/lib/scrape-marketplace-versions.js

@@ -1,79 +1,45 @@
 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 {
-    logger
-  } = context
+  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
+  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
 
-  let success = true
-  const { whmcsLOGIN, whmcsPASSWORD, whmcsPRODUCTID, DEBUG } = resolveConfig(context)
-  const { gotoOpts, navOpts, selectorOpts, page } = await puppet(DEBUG, logger)
-
-  debug(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-  logger.log(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-
-  const wmbase = 'https://marketplace.whmcs.com'
-  let url = `${wmbase}/user/login`
+  const püppi = await puppet(context)
+  const result = await püppi.login()
+  if (!result) {
+    return result
+  }
+  const { page, gotoOpts, selectorOpts, productid, urlbase } = püppi.config
 
+  let marketplaceVersions = []
   try {
+    // scrap versions from WHMCS marketplace
+    const url = `${urlbase}/product/${productid}/edit#versions`
     await page.goto(url, gotoOpts)
-    // do login
-    const selector = 'div.login-leftcol form button[type="submit"]'
+    debug(`${out}product page loaded at %s`, url)
+    const selector = 'div#versions tr strong'
     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
-  }
-  let marketplaceVersions = false
-  if (success) {
-    try {
-      if (!parseInt(whmcsPRODUCTID, 10)) {
-        return false
-      }
-
-      // scrap versions from WHMCS marketplace
-      url = `${wmbase}/product/${whmcsPRODUCTID}/edit#versions`
-      await page.goto(url, gotoOpts)
-      debug('product page loaded at %s', url)
-      const selector = 'div#versions tr strong'
-      await page.waitForSelector(selector, selectorOpts)
-      debug('product version table found')
-      /* istanbul ignore next */
-      marketplaceVersions = await page.$$eval('div#versions tr td strong', tds => tds.map((td) => {
+    debug('product version table found')
+    /* istanbul ignore next */
+    marketplaceVersions = await page.$$eval(selector, (tds) =>
+      tds.map((td) => {
         return td.innerText.substring(8)
-      }))
-      marketplaceVersions.reverse()
-      marketplaceVersions.forEach(v => logger.log(`Detected WHMCS version ${v}`))
-
-      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
-    }
+      })
+    )
+    marketplaceVersions.reverse()
+    marketplaceVersions.forEach((v) => debug(`Detected WHMCS version ${v}`))
+  } 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()
-  if (!success) {
-    return false
-  }
   return marketplaceVersions
 }

package/lib/set-compatible-versions.js

@@ -1,97 +1,71 @@
 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 {
-    logger
-  } = context
+  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
+  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
 
-  let success = true
-  const { whmcsLOGIN, whmcsPASSWORD, whmcsPRODUCTID, whmcsMINVERSION, DEBUG } = resolveConfig(context)
-  const { gotoOpts, navOpts, selectorOpts, page } = await puppet(DEBUG, logger)
-
-  debug(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-  logger.log(`WHMCS Marketplace Product ID: ${whmcsPRODUCTID}`)
-
-  const wmbase = 'https://marketplace.whmcs.com'
-  let url = `${wmbase}/user/login`
+  const püppi = await puppet(context)
+  const result = await püppi.login()
+  if (!result) {
+    return result
+  }
+  const { page, gotoOpts, selectorOpts, productid, urlbase, minversion } =
+    püppi.config
 
+  debug(out)
   try {
+    // scrap versions from WHMCS marketplace
+    const url = `${urlbase}/product/${productid}/edit#compatibility`
     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
-      }
+    debug('product page loaded at %s', url)
 
-      // scrap versions from WHMCS marketplace
-      url = `${wmbase}/product/${whmcsPRODUCTID}/edit#compatibility`
-      await page.goto(url, gotoOpts)
-      debug('product page loaded at %s', url)
-
-      const selector = 'input[name="versionIds[]"]'
-      const submitSelector = 'div#compatibility button[type="submit"]'
-      await page.waitForSelector(selector, selectorOpts)
-      await page.waitForSelector(submitSelector, selectorOpts)
-      debug('compatibility version table found')
-
-      logger.log(`Minimum required WHMCS version: ${whmcsMINVERSION}`)
-      /* istanbul ignore next */
-      await page.$$eval(selector, (checkboxes, whmcsMINVERSION) => checkboxes.forEach(function (c, i) {
-        const checkParts = c.className.split('-')[0].split('_')
-        const minParts = whmcsMINVERSION.split('.')
-        let check = true
-        for (let i = 0; i < 2; i++) {
-          const a = ~~checkParts[i]
-          const b = ~~minParts[i]
-          if (a > b) {
-            break
-          }
-          if (a < b) {
-            check = false
-            break
-          }
-        }
-        c.checked = check
-      }), whmcsMINVERSION)
-      const submitNav = page.waitForNavigation(navOpts)
-      await page.hover(submitSelector)
-      await page.click(submitSelector)
-      await submitNav
+    const selector = 'input[name="versionIds[]"]'
+    const submitSelector = 'div#compatibility button[type="submit"]'
+    await page.waitForSelector(selector, selectorOpts)
+    await page.waitForSelector(submitSelector, selectorOpts)
+    debug('compatibility version table found')
 
-      debug('updating whmcs compatibility list succeeded.')
-      logger.log('WHMCS Marketplace updating whmcs compatibility list succeeded.')
-      success = true
-    } catch (error) {
-      debug('updating whmcs compatibility list failed.', error.message)
-      logger.error('WHMCS Marketplace updating whmcs compatibility list failed.', error.message)
-      success = false
+    let tmp = minversion
+    if (tmp) {
+      tmp = tmp.replace(/(.)/g, '$&\u200E')
     }
+    debug(`Minimum required WHMCS version: ${tmp}`)
+    /* istanbul ignore next */
+    await page.$$eval(
+      selector,
+      (checkboxes, minversion) =>
+        checkboxes.forEach(function (c) {
+          const checkParts = c.className.split('-')[0].split('_')
+          const minParts = minversion.split('.')
+          let check = true
+          for (let i = 0; i < 2; i++) {
+            const a = ~~checkParts[i]
+            const b = ~~minParts[i]
+            if (a > b) {
+              break
+            }
+            if (a < b) {
+              check = false
+              break
+            }
+          }
+          c.checked = check
+        }),
+      minversion
+    )
+    await page.clickAndNavigate(submitSelector)
+  } catch (error) {
+    debug('Updating whmcs compatibility list failed.', error.message)
+    await page.browser().close()
+    return false
   }
 
+  debug('Updating whmcs compatibility list succeeded.')
   await page.browser().close()
-  return success
+  return true
 }

package/lib/verify.js

@@ -5,13 +5,14 @@ const getError = require('./get-error')
 module.exports = async (pluginConfig, context) => {
   const cfg = resolveConfig(context)
   const errors = []
-  if (cfg.whmcsLOGIN === false || cfg.whmcsPASSWORD === false) {
+  if (cfg.login === false || cfg.password === false) {
     errors.push(getError('EWHMCSNOCREDENTIALS'))
   }
-  if (cfg.whmcsPRODUCTID === false) {
+  // TODO: we might test Marketplace login using given credentials
+  if (cfg.productid === false) {
     errors.push(getError('EWHMCSNOPRODUCTID'))
   }
-  if (!/^[0-9]+$/.test(cfg.whmcsPRODUCTID)) {
+  if (!/^[0-9]+$/.test(cfg.productid) || !parseInt(cfg.productid, 10)) {
     errors.push(getError('EWHMCSINVALIDPRODUCTID'))
   }
   if (errors.length > 0) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hexonet/semantic-release-whmcs",
   "description": "`semantic-release` plugin for auto-publishing on WHMCS marketplace",
-  "version": "4.0.0",
+  "version": "4.0.3",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -14,7 +14,7 @@
   "license": "MIT",
   "engines": {
     "node": ">=16.15.1",
-    "npm": ">=8.11.1"
+    "npm": ">=8.11.0"
   },
   "homepage": "https://github.com/hexonet/semantic-release-whmcs#readme",
   "repository": "github:hexonet/semantic-release-whmcs",
@@ -52,9 +52,8 @@
   },
   "scripts": {
     "coverage": "nyc npm run test",
-    "test": "ava --verbose --timeout=2m",
-    "lint": "eslint --fix --config=./.eslintrc.js *.js lib/*.js lib/definitions/*.js README.md *.json test/*.test.js",
-    "semantic-release": "semantic-release"
+    "test": "ava --fail-fast --verbose --timeout=2m",
+    "lint": "eslint --fix --config=./.eslintrc.js *.js lib/*.js lib/definitions/*.js README.md *.json test/*.test.js"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",
@@ -65,12 +64,12 @@
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-json": "^3.0.0",
-    "eslint-plugin-markdown": "^2.1.0",
-    "eslint-plugin-n": "^15.2.0",
+    "eslint-plugin-markdown": "^3.0.0",
+    "eslint-plugin-n": "^15.2.2",
     "eslint-plugin-promise": "^6.0.0",
     "esm": "^3.2.25",
     "nyc": "^15.1.0",
-    "semantic-release": "^19.0.2",
+    "semantic-release": "^19.0.3",
     "stream-buffers": "^3.0.2"
   },
   "dependencies": {
@@ -78,7 +77,7 @@
     "aggregate-error": "^3.1.0",
     "debug": "^4.3.4",
     "github-api": "^3.4.0",
-    "puppeteer": "^14.0.0",
+    "puppeteer": "^16.0.0",
     "yargs": "^17.0.1"
   }
 }