travis-deploy-once/lib/wait-for-other-jobs.js

Run a deployment script only once in the Travis test matrix

const pRetry = require('p-retry');
const getJobs = require('./get-jobs');
const verifyJobsState = require('./verify-jobs-state');

/**
 * Call the Travis API periodically to verify the jobs status for the current build, until all jobs are successfully completed or as soon as one of them fails.
 * Use an exponential backoff strategy: the more attempt the more to wait for the next one. Starts by calling the API after 3 seconds, and increase with each retry up to 15s.
 *
 * @param {Object} options Options.
 * @param {Travis} options.travis Travis API client
 * @param {Number} options.buildId Current build id
 * @param {Number} options.currentJobId Current job id
 * @param {Array} options.initialJobs List of jobs retrieved initially
 * @param {Object} options.logger To log info and error
 * @param {Object} retryOpts Options to pass to `retry` (https://github.com/tim-kos/node-retry#retryoperationoptions)
 * @param {Object} jobsRetryOpts Options to pass to `retry` (https://github.com/tim-kos/node-retry#retryoperationoptions) for retrieving the Travis jobs
 * @return {Promise<Boolean>} Promise that resolve to `true` if all other jobs are successful, `false` if one of them is failed
 */
module.exports = async (
  {travisOpts, travisToken, buildId, currentJobId, initialJobs, logger},
  retryOpts,
  jobsRetryOpts
) => {
  let lastAttempt;
  let jobCount;
  const run = async attempt => {
    lastAttempt = attempt;
    let jobs;
    // On the first attempt use the jobs retrieved from the API, previously
    if (attempt === 1) {
      jobs = initialJobs;
    } else {
      // On subsequent attempts call the API to get the most recent statuses
      try {
        jobs = await getJobs(travisOpts, travisToken, buildId, jobsRetryOpts);
      } catch (error) {
        logger.log(`Failed attempt ${attempt}, because Travis API returned the error: ${error}.`);
        throw error;
      }
    }
    jobCount = jobs.length;
    // Exclude the current job
    jobs = jobs.filter(job => job.id !== currentJobId);
    const pendingJobs = verifyJobsState(jobs, logger);
    if (pendingJobs.length > 0) {
      logger.log(`Aborting attempt ${attempt}, because of pending job(s): ${pendingJobs.join(', ')}.`);
      return Promise.reject(new Error('retry'));
    }
    return true;
  };

  try {
    await pRetry(run, Object.assign({forever: true, factor: 1.5, minTimeout: 3000, maxTimeout: 15000}, retryOpts));
    logger.log(`Success at attempt ${lastAttempt}. All ${jobCount} jobs passed.`);
    return true;
  } catch (error) {
    // Abort error
    logger.error(`Aborting at attempt ${lastAttempt}. Job ${error.message} failed.`);
    return false;
  }
};