@hexonet/semantic-release-whmcs 3.0.2 → 3.1.2

package/coverage/sorter.js

@@ -0,0 +1,196 @@
+/* eslint-disable */
+var addSorting = (function() {
+    'use strict';
+    var cols,
+        currentSort = {
+            index: 0,
+            desc: false
+        };
+
+    // returns the summary table element
+    function getTable() {
+        return document.querySelector('.coverage-summary');
+    }
+    // returns the thead element of the summary table
+    function getTableHeader() {
+        return getTable().querySelector('thead tr');
+    }
+    // returns the tbody element of the summary table
+    function getTableBody() {
+        return getTable().querySelector('tbody');
+    }
+    // returns the th element for nth column
+    function getNthColumn(n) {
+        return getTableHeader().querySelectorAll('th')[n];
+    }
+
+    function onFilterInput() {
+        const searchValue = document.getElementById('fileSearch').value;
+        const rows = document.getElementsByTagName('tbody')[0].children;
+        for (let i = 0; i < rows.length; i++) {
+            const row = rows[i];
+            if (
+                row.textContent
+                    .toLowerCase()
+                    .includes(searchValue.toLowerCase())
+            ) {
+                row.style.display = '';
+            } else {
+                row.style.display = 'none';
+            }
+        }
+    }
+
+    // loads the search box
+    function addSearchBox() {
+        var template = document.getElementById('filterTemplate');
+        var templateClone = template.content.cloneNode(true);
+        templateClone.getElementById('fileSearch').oninput = onFilterInput;
+        template.parentElement.appendChild(templateClone);
+    }
+
+    // loads all columns
+    function loadColumns() {
+        var colNodes = getTableHeader().querySelectorAll('th'),
+            colNode,
+            cols = [],
+            col,
+            i;
+
+        for (i = 0; i < colNodes.length; i += 1) {
+            colNode = colNodes[i];
+            col = {
+                key: colNode.getAttribute('data-col'),
+                sortable: !colNode.getAttribute('data-nosort'),
+                type: colNode.getAttribute('data-type') || 'string'
+            };
+            cols.push(col);
+            if (col.sortable) {
+                col.defaultDescSort = col.type === 'number';
+                colNode.innerHTML =
+                    colNode.innerHTML + '<span class="sorter"></span>';
+            }
+        }
+        return cols;
+    }
+    // attaches a data attribute to every tr element with an object
+    // of data values keyed by column name
+    function loadRowData(tableRow) {
+        var tableCols = tableRow.querySelectorAll('td'),
+            colNode,
+            col,
+            data = {},
+            i,
+            val;
+        for (i = 0; i < tableCols.length; i += 1) {
+            colNode = tableCols[i];
+            col = cols[i];
+            val = colNode.getAttribute('data-value');
+            if (col.type === 'number') {
+                val = Number(val);
+            }
+            data[col.key] = val;
+        }
+        return data;
+    }
+    // loads all row data
+    function loadData() {
+        var rows = getTableBody().querySelectorAll('tr'),
+            i;
+
+        for (i = 0; i < rows.length; i += 1) {
+            rows[i].data = loadRowData(rows[i]);
+        }
+    }
+    // sorts the table using the data for the ith column
+    function sortByIndex(index, desc) {
+        var key = cols[index].key,
+            sorter = function(a, b) {
+                a = a.data[key];
+                b = b.data[key];
+                return a < b ? -1 : a > b ? 1 : 0;
+            },
+            finalSorter = sorter,
+            tableBody = document.querySelector('.coverage-summary tbody'),
+            rowNodes = tableBody.querySelectorAll('tr'),
+            rows = [],
+            i;
+
+        if (desc) {
+            finalSorter = function(a, b) {
+                return -1 * sorter(a, b);
+            };
+        }
+
+        for (i = 0; i < rowNodes.length; i += 1) {
+            rows.push(rowNodes[i]);
+            tableBody.removeChild(rowNodes[i]);
+        }
+
+        rows.sort(finalSorter);
+
+        for (i = 0; i < rows.length; i += 1) {
+            tableBody.appendChild(rows[i]);
+        }
+    }
+    // removes sort indicators for current column being sorted
+    function removeSortIndicators() {
+        var col = getNthColumn(currentSort.index),
+            cls = col.className;
+
+        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+        col.className = cls;
+    }
+    // adds sort indicators for current column being sorted
+    function addSortIndicators() {
+        getNthColumn(currentSort.index).className += currentSort.desc
+            ? ' sorted-desc'
+            : ' sorted';
+    }
+    // adds event listeners for all sorter widgets
+    function enableUI() {
+        var i,
+            el,
+            ithSorter = function ithSorter(i) {
+                var col = cols[i];
+
+                return function() {
+                    var desc = col.defaultDescSort;
+
+                    if (currentSort.index === i) {
+                        desc = !currentSort.desc;
+                    }
+                    sortByIndex(i, desc);
+                    removeSortIndicators();
+                    currentSort.index = i;
+                    currentSort.desc = desc;
+                    addSortIndicators();
+                };
+            };
+        for (i = 0; i < cols.length; i += 1) {
+            if (cols[i].sortable) {
+                // add the click event handler on the th so users
+                // dont have to click on those tiny arrows
+                el = getNthColumn(i).querySelector('.sorter').parentElement;
+                if (el.addEventListener) {
+                    el.addEventListener('click', ithSorter(i));
+                } else {
+                    el.attachEvent('onclick', ithSorter(i));
+                }
+            }
+        }
+    }
+    // adds sorting functionality to the UI
+    return function() {
+        if (!getTable()) {
+            return;
+        }
+        cols = loadColumns();
+        loadData();
+        addSearchBox();
+        addSortIndicators();
+        enableUI();
+    };
+})();
+
+window.addEventListener('load', addSorting);

package/index.js

@@ -32,17 +32,19 @@ async function publish (pluginConfig, context) {
 async function syncVersions (pluginConfig, context) {
   await verifyConditions(pluginConfig, context)
   const releases = await githubReleases(pluginConfig, context)
-  const versions = await marketplaceVersions(pluginConfig, context)
 
-  for (const release of releases) {
-    if (!versions.includes(release.name.substring(1))) {
-      context.nextRelease = {
-        version: release.name.substring(1),
-        notes: release.body,
-        releaseDate: release.published_at
+  if (releases && releases.length) {
+    const versions = await marketplaceVersions(pluginConfig, context)
+    for (const release of releases) {
+      if (!versions.includes(release.name.substring(1))) {
+        context.nextRelease = {
+          version: release.name.substring(1),
+          notes: release.body,
+          releaseDate: release.published_at
+        }
+        console.log(`Adding missing version ${context.nextRelease.version}`)
+        await publish(pluginConfig, context)
       }
-      console.log(`Adding missing version ${context.nextRelease.version}`)
-      await publish(pluginConfig, context)
     }
   }
 }

package/lib/definitions/errors.js

@@ -1,14 +1,17 @@
 module.exports = {
   EWHMCSNOCREDENTIALS: () => ({
     message: 'No WHMCS Marketplace credentials specified.',
-    details: 'WHMCS Marketplace credentails have to be set in the `WHMCS_LOGIN` and `WHMCS_PASSWORD` environment variables on your CI environment.'
+    details:
+      'WHMCS Marketplace credentails have to be set in the `WHMCS_LOGIN` and `WHMCS_PASSWORD` environment variables on your CI environment.'
   }),
   EWHMCSNOPRODUCTID: () => ({
     message: 'No WHMCS Marketplace Product ID specified.',
-    details: 'The product id of your listed product at the WHMCS Marketplace has to be set in the `WHMCS_PRODUCTID` environment variable on your CI environment. You\'ll find that number in url when visiting the product page in WHMCS Marketplace.'
+    details:
+      "The product id of your listed product at the WHMCS Marketplace has to be set in the `WHMCS_PRODUCTID` environment variable on your CI environment. You'll find that number in url when visiting the product page in WHMCS Marketplace."
   }),
   EWHMCSINVALIDPRODUCTID: () => ({
     message: 'Invalid WHMCS Marketplace Product ID specified.',
-    details: 'The product id of your listed product at the WHMCS Marketplace has to be set in the `WHMCS_PRODUCTID` environment variable on your CI environment. You\'ll find that number in url when visiting the product page in WHMCS Marketplace.'
+    details:
+      "The product id of your listed product at the WHMCS Marketplace has to be set in the `WHMCS_PRODUCTID` environment variable on your CI environment. You'll find that number in url when visiting the product page in WHMCS Marketplace."
   })
 }

package/lib/delete-marketplace-version.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: 10000 }
+const puppet = require('./puppet')
 
 /**
  * A method to publish the module update on whmcs market place
@@ -25,6 +19,7 @@ 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}`)
@@ -35,34 +30,8 @@ module.exports = async (pluginConfig, context) => {
   // strip markdown links from notes as not allowed to keep
   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"]'
@@ -72,6 +41,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.')
@@ -96,8 +66,10 @@ module.exports = async (pluginConfig, context) => {
       await page.waitForXPath(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
@@ -108,6 +80,7 @@ module.exports = async (pluginConfig, context) => {
       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
 
@@ -121,9 +94,7 @@ module.exports = async (pluginConfig, context) => {
     }
   }
 
-  if (!DEBUG) {
-    await browser.close()
-  }
+  await page.browser().close()
   if (!success) {
     return false
   }

package/lib/get-error.js

@@ -1,7 +1,7 @@
 const SemanticReleaseError = require('@semantic-release/error')
 const ERROR_DEFINITIONS = require('./definitions/errors.js')
 
-module.exports = code => {
+module.exports = (code) => {
   const { message, details } = ERROR_DEFINITIONS[code]()
   return new SemanticReleaseError(message, code, details)
 }

package/lib/get-github-releases.js

@@ -14,20 +14,22 @@ module.exports = async (pluginConfig, context) => {
   } = context
 
   debug('Getting releases from GitHub')
-  logger.info('Getting releases from GitHub')
+  logger.log('Getting releases from GitHub')
 
   const { githubREPO, githubTOKEN } = resolveConfig(context)
 
   const gh = new GitHub({
     token: githubTOKEN
   })
-  const repo = githubREPO.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.reverse()
-    return githubReleases.data
+  if (githubREPO) { // optional by default false
+    const repo = githubREPO.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.reverse()
+      return githubReleases.data
+    }
+    logger.log('Failed to get releases from GitHub')
   }
-  logger.error('Failed to get releases from GitHub')
   return false
 }

package/lib/publish.js

@@ -1,13 +1,7 @@
-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 setCompatibleVersions = require('./set-compatible-versions')
+const debug = require("debug")("semantic-release:whmcs");
+const resolveConfig = require("./resolve-config");
+const puppet = require("./puppet");
+const setCompatibleVersions = require("./set-compatible-versions");
 
 /**
  * A method to publish the module update on whmcs market place
@@ -15,129 +9,127 @@ const setCompatibleVersions = require('./set-compatible-versions')
 module.exports = async (pluginConfig, context) => {
   const {
     nextRelease: { notes, version, releaseDate },
-    logger
-  } = context
+    logger,
+  } = 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("publishing new product version failed. No input data available.");
+    logger.error(
+      "WHMCS Marketplace publishing new product version failed. No input data available."
+    );
   }
 
-  let success = true
-  const { whmcsLOGIN, whmcsPASSWORD, whmcsPRODUCTID, DEBUG } = resolveConfig(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}`)
+  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}`)
+  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
-  const cleanedNotes = notes.replace(/\[(.*?)\]\((.+?)\)/gm, '$1')
-  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()
+  const cleanedNotes = notes.replace(/\[([^\]]*?)\]\(([^)]+?)\)/gm, "$1");
+  const wmbase = "https://marketplace.whmcs.com";
+  let url = `${wmbase}/user/login`;
 
   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)
+    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.click(selector)
-    await nav
-    debug('Login form successfully submitted.')
-    logger.log('WHMCS Marketplace Login Form successfully submitted.')
+    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
+    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
+        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')
-      await page.$eval('#version', (el, value) => {
-        el.value = value
-      }, version)
-      debug('form input for version finished.')
+      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.");
 
       // 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()
-      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)
+      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('form input for released_at finished.')
-      await page.$eval('#description', (el, value) => {
-        el.value = value
-      }, cleanedNotes)
-      debug('form input for description finished.')
-      const nav = page.waitForNavigation(navOpts)
-      await page.click(selector)
-      await nav
+      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;
 
-      await setCompatibleVersions(pluginConfig, context)
+      await setCompatibleVersions(pluginConfig, context);
 
-      debug('publishing new product version succeeded.')
-      logger.log('WHMCS Marketplace publishing new product version succeeded.')
-      success = true
+      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("publishing new product version failed.", error.message);
+      logger.error(
+        "WHMCS Marketplace publishing new product version failed.",
+        error.message
+      );
+      success = false;
     }
   }
 
-  await browser.close()
+  await page.browser().close();
   if (!success) {
-    return false
+    return false;
   }
   return {
-    name: 'WHMCS Marketplace Product Version',
-    url: `${wmbase}/product/${whmcsPRODUCTID}`
-  }
-}
+    name: "WHMCS Marketplace Product Version",
+    url: `${wmbase}/product/${whmcsPRODUCTID}`,
+  };
+};