@hexonet/semantic-release-whmcs 3.0.2 → 3.1.2

package/lib/puppet.js

@@ -0,0 +1,62 @@
+const puppeteer = require('puppeteer')
+
+module.exports = async (DEBUG, logger) => {
+  if (!logger) {
+    logger = console
+  }
+  const gotoOpts = {
+    waitUntil: ['load', 'domcontentloaded'],
+    timeout: 240000
+  }
+  const navOpts = {
+    waitUntil: 'networkidle0',
+    timeout: 240000
+  }
+  const selectorOpts = {
+    timeout: 10000
+  }
+
+  const browser = await puppeteer.launch({
+    headless: !DEBUG,
+    defaultViewport: null, // automatically full-sized
+    args: [
+      '--incognito',
+      '--start-maximized',
+      '--no-sandbox',
+      '--disable-setuid-sandbox',
+      '--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"'
+    ]
+  })
+  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.setJavaScriptEnabled(true)
+
+  if (DEBUG) {
+    page.on('console', msg => {
+      for (let i = 0; i < msg.args().length; i++) {
+        logger.log(`${i}: ${msg.args()[i]}`)
+      }
+    })
+  }
+
+  page.clickAndNavigate = async (selector) => {
+    const nav = page.waitForNavigation(navOpts)
+    await page.hover(selector)
+    await page.click(selector)
+    await nav
+  }
+
+  return { page, gotoOpts, navOpts, selectorOpts }
+}

package/lib/resolve-config.js

@@ -3,7 +3,7 @@ module.exports = ({ env }) => ({
   whmcsPASSWORD: env.WHMCSMP_PASSWORD || false,
   whmcsPRODUCTID: env.WHMCSMP_PRODUCTID || false,
   whmcsMINVERSION: env.WHMCSMP_MINVERSION || '7.10',
-  githubTOKEN: env.GH_TOKEN || false,
-  githubREPO: env.GH_REPO || false,
+  githubTOKEN: env.GH_TOKEN || env.GITHUB_TOKEN || false,
+  githubREPO: env.GH_REPO || env.GITHUB_REPO || false,
   DEBUG: (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false
 })

package/lib/scrape-marketplace-versions.js

@@ -1,12 +1,6 @@
 const debug = require('debug')('semantic-release:whmcs')
 const resolveConfig = require('./resolve-config')
-const puppeteer = require('puppeteer')
-const gotoOpts = {
-  waitUntil: ['load', 'domcontentloaded'],
-  timeout: 240000
-}
-const navOpts = { waitUntil: 'networkidle0', timeout: 240000 }
-const selectorOpts = { timeout: 240000 }
+const puppet = require('./puppet')
 
 /**
  * A method to publish the module update on whmcs market place
@@ -18,40 +12,15 @@ module.exports = async (pluginConfig, context) => {
 
   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 browser = await puppeteer.launch({
-    headless: !DEBUG,
-    defaultViewport: null, // automatically full-sized
-    args: [
-      '--incognito',
-      '--start-maximized',
-      '--no-sandbox',
-      '--disable-setuid-sandbox',
-      '--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"'
-    ]
-  })
-  const [page] = await browser.pages()
 
   try {
-    await page.setRequestInterception(true)
-    page.on('request', request => {
-      if (/^(image|stylesheet|other)$/i.test(request.resourceType())) {
-        request.abort()
-      } else {
-        request.continue()
-      }
-    })
-
-    await page.setJavaScriptEnabled(true)
     await page.goto(url, gotoOpts)
     // do login
     const selector = 'div.login-leftcol form button[type="submit"]'
@@ -61,6 +30,7 @@ module.exports = async (pluginConfig, context) => {
     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.')
@@ -84,6 +54,7 @@ module.exports = async (pluginConfig, context) => {
       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) => {
         return td.innerText.substring(8)
       }))
@@ -100,7 +71,7 @@ module.exports = async (pluginConfig, context) => {
     }
   }
 
-  await browser.close()
+  await page.browser().close()
   if (!success) {
     return false
   }

package/lib/set-compatible-versions.js

@@ -1,12 +1,6 @@
 const debug = require('debug')('semantic-release:whmcs')
 const resolveConfig = require('./resolve-config')
-const puppeteer = require('puppeteer')
-const gotoOpts = {
-  waitUntil: ['load', 'domcontentloaded'],
-  timeout: 240000
-}
-const navOpts = { waitUntil: 'networkidle0', timeout: 240000 }
-const selectorOpts = { timeout: 240000 }
+const puppet = require('./puppet')
 
 /**
  * A method to publish the module update on whmcs market place
@@ -18,40 +12,15 @@ module.exports = async (pluginConfig, context) => {
 
   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 browser = await puppeteer.launch({
-    headless: !DEBUG,
-    defaultViewport: null, // automatically full-sized
-    args: [
-      '--incognito',
-      '--start-maximized',
-      '--no-sandbox',
-      '--disable-setuid-sandbox',
-      '--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"'
-    ]
-  })
-  const [page] = await browser.pages()
 
   try {
-    await page.setRequestInterception(true)
-    page.on('request', request => {
-      if (/^(image|stylesheet|other)$/i.test(request.resourceType())) {
-        request.abort()
-      } else {
-        request.continue()
-      }
-    })
-
-    await page.setJavaScriptEnabled(true)
     await page.goto(url, gotoOpts)
     // do login
     const selector = 'div.login-leftcol form button[type="submit"]'
@@ -61,6 +30,7 @@ module.exports = async (pluginConfig, context) => {
     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.')
@@ -89,6 +59,7 @@ module.exports = async (pluginConfig, context) => {
       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('.')
@@ -107,6 +78,7 @@ module.exports = async (pluginConfig, context) => {
         c.checked = check
       }), whmcsMINVERSION)
       const submitNav = page.waitForNavigation(navOpts)
+      await page.hover(submitSelector)
       await page.click(submitSelector)
       await submitNav
 
@@ -120,6 +92,6 @@ module.exports = async (pluginConfig, context) => {
     }
   }
 
-  await browser.close()
+  await page.browser().close()
   return success
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hexonet/semantic-release-whmcs",
   "description": "`semantic-release` plugin for auto-publishing on WHMCS marketplace",
-  "version": "3.0.2",
+  "version": "3.1.2",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -13,8 +13,8 @@
   "main": "index.js",
   "license": "MIT",
   "engines": {
-    "node": ">=10.18.0",
-    "npm": ">=6.14.8"
+    "node": ">=16.15.1",
+    "npm": ">=8.11.1"
   },
   "homepage": "https://github.com/hexonet/semantic-release-whmcs#readme",
   "repository": "github:hexonet/semantic-release-whmcs",
@@ -57,29 +57,28 @@
     "semantic-release": "semantic-release"
   },
   "devDependencies": {
-    "@octokit/core": "^3.2.0",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/exec": "^5.0.0",
-    "@semantic-release/git": "^9.0.0",
-    "ava": "^3.13.0",
-    "debug": "^4.2.0",
-    "eslint": "^7.12.1",
-    "eslint-config-standard": "^16.0.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-json": "^2.1.2",
-    "eslint-plugin-markdown": "^1.0.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/exec": "^6.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "ava": "^4.0.0",
+    "eslint": "^8.0.1",
+    "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-promise": "^6.0.0",
     "esm": "^3.2.25",
     "nyc": "^15.1.0",
-    "semantic-release": "^17.2.1"
+    "semantic-release": "^18.0.1",
+    "stream-buffers": "^3.0.2"
   },
   "dependencies": {
-    "@semantic-release/error": "^2.2.0",
+    "@semantic-release/error": "^3.0.0",
     "aggregate-error": "^3.1.0",
+    "debug": "^4.3.4",
     "github-api": "^3.4.0",
-    "puppeteer": "^9.0.0",
-    "sinon": "^9.2.1",
-    "yargs": "^16.2.0"
+    "puppeteer": "^14.0.0",
+    "yargs": "^17.0.1"
   }
 }

package/whmcs.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 
 const { publish, syncVersions, delVersion, updateCompatibility } = require('./index.js')
 
@@ -7,7 +6,7 @@ const context = {
   logger: new class {
     log (msg) { console.log(msg) }
     info (msg) { console.log(msg) }
-    error (msg, details) { console.log(msg + ' ' + details) }
+    error (msg, details) { console.error(msg + ' ' + details) }
   }()
 }
 

package/.github/workflows/release.yml

@@ -1,56 +0,0 @@
-name: Release
-on: [push, pull_request]
-
-jobs:
-  test:
-    name: Test @ NodeJS - x86 - ubuntu-latest
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [14.x]
-    if: github.event_name == 'pull_request' || (github.event_name == 'push' && contains(toJson(github.event.commits), '[skip ci]') == false)
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup NodeJS ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install dependencies
-        run: |
-          npm prune
-          npm i
-      - name: Linting
-        run: npm run lint
-      - name: Tests
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-          GITHUB_REPO: ${{ secrets.GH_REPO }}
-          WHMCSMP_LOGIN: ${{ secrets.WHMCSMP_LOGIN }}
-          WHMCSMP_PASSWORD: ${{ secrets.WHMCSMP_PASSWORD }}
-          WHMCSMP_PRODUCTID: ${{ secrets.WHMCSMP_PRODUCTID_ISPAPI_SSL }}
-          WHMCSMP_MINVERSION: ${{ secrets.WHMCSMP_MINVERSION }}
-        run: npm run test
-  release:
-    name: Release @ NodeJS LTS - x86 - ubuntu-latest
-    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
-    runs-on: ubuntu-latest
-    needs: "test"
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-      - name: Setup NodeJS LTS
-        uses: actions/setup-node@v2
-      - name: Install dependencies
-        run: |
-          npm prune
-          npm i
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-          GITHUB_REPO: ${{ secrets.GH_REPO }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release

package/test/publish.test.js

@@ -1,78 +0,0 @@
-import test from 'ava'
-import { stub } from 'sinon'
-const publish = require('../lib/publish')
-const deleteVersion = require('../lib/delete-marketplace-version')
-
-test.beforeEach(t => {
-  // Mock logger
-  t.context.log = stub()
-  t.context.error = stub()
-  t.context.logger = { log: t.context.log, error: t.context.error }
-})
-
-test.serial('Verify publishing [login fails]', async t => {
-  const context = {
-    env: {
-      WHMCSMP_LOGIN: 'anonymous@hexonet.net',
-      WHMCSMP_PASSWORD: '1234567890',
-      WHMCSMP_PRODUCTID: '0'
-    },
-    logger: t.context.logger,
-    nextRelease: {
-      version: 'v6.6.6',
-      notes: '# something changed\n\ntwice.'
-    }
-  }
-  const result = await publish({}, context)
-  t.is(result, false)
-})
-
-test.serial('Verify publishing [no product id]', async t => {
-  const env = {
-    WHMCSMP_LOGIN: process.env.WHMCSMP_LOGIN,
-    WHMCSMP_PASSWORD: process.env.WHMCSMP_PASSWORD
-  }
-  t.truthy(env.WHMCSMP_LOGIN)
-  t.truthy(env.WHMCSMP_PASSWORD)
-  const context = {
-    env,
-    logger: t.context.logger,
-    nextRelease: {
-      version: 'v6.6.6',
-      notes: '# something changed\n\ntwice.'
-    }
-  }
-  const result = await publish({}, context)
-  t.is(result, false)
-})
-
-test.skip('Verify publishing [all fine]', async t => {
-  const env = process.env
-  t.truthy(env.WHMCSMP_LOGIN)
-  t.truthy(env.WHMCSMP_PASSWORD)
-  t.truthy(env.WHMCSMP_PRODUCTID)
-  t.truthy(env.WHMCSMP_MINVERSION)
-  const context = {
-    env,
-    logger: t.context.logger,
-    nextRelease: {
-      version: '0.0.1',
-      notes: '# something changed\n\ntwice\n\n[link test](https://github.com/papakai) [link test2](https://github.com/papakai)\n\ndone.'
-    }
-  }
-  const result = await publish({}, context)
-  t.assert(result !== false)
-
-  // wait 5s between adding and deleting
-  await new Promise((resolve) => {
-    setTimeout(resolve, 5000)
-  })
-
-  const delContext = {
-    env,
-    logger: t.context.logger,
-    version: context.nextRelease.version
-  }
-  const del = await deleteVersion({}, delContext)
-  t.assert(del !== false)
-})

package/test/verify.test.js

@@ -1,54 +0,0 @@
-import test from 'ava'
-import { stub } from 'sinon'
-const verify = require('../lib/verify')
-/* eslint camelcase: ["error", {properties: "never"}] */
-
-test.beforeEach(t => {
-  // Mock logger
-  t.context.log = stub()
-  t.context.error = stub()
-  t.context.logger = { log: t.context.log, error: t.context.error }
-})
-
-test.serial('Verify credentials [no login]', async t => {
-  const env = {}
-  const [error] = await t.throwsAsync(
-    verify({}, { env, logger: t.context.logger })
-  )
-  t.is(error.name, 'SemanticReleaseError')
-  t.is(error.code, 'EWHMCSNOCREDENTIALS')
-})
-
-test.serial('Verify credentials [no password]', async t => {
-  const env = { WHMCSMP_LOGIN: 'mylogin' }
-  const [error] = await t.throwsAsync(
-    verify({}, { env, logger: t.context.logger })
-  )
-  t.is(error.name, 'SemanticReleaseError')
-  t.is(error.code, 'EWHMCSNOCREDENTIALS')
-})
-
-test.serial('Verify product id [no product id]', async t => {
-  const env = { WHMCSMP_LOGIN: 'mylogin', WHMCSMP_PASSWORD: 'mypassword' }
-  const [error] = await t.throwsAsync(
-    verify({}, { env, logger: t.context.logger })
-  )
-  t.is(error.name, 'SemanticReleaseError')
-  t.is(error.code, 'EWHMCSNOPRODUCTID')
-})
-
-test.serial('Verify product id [invalid product id]', async t => {
-  const env = { WHMCSMP_LOGIN: 'mylogin', WHMCSMP_PASSWORD: 'mypassword', WHMCSMP_PRODUCTID: 'myproductid' }
-  const [error] = await t.throwsAsync(
-    verify({}, { env, logger: t.context.logger })
-  )
-  t.is(error.name, 'SemanticReleaseError')
-  t.is(error.code, 'EWHMCSINVALIDPRODUCTID')
-})
-
-test.serial('Verify data [all fine]', async t => {
-  const env = { WHMCSMP_LOGIN: 'mylogin', WHMCSMP_PASSWORD: 'mypassword', WHMCSMP_PRODUCTID: '123456' }
-  await t.notThrowsAsync(
-    verify({}, { env, logger: t.context.logger })
-  )
-})