Function add

lib/recorder.js:191–235

* Adds a promise to a chain. * Promise description should be passed as first parameter. * * @param {string|function} taskName * @param {function} [fn] * @param {boolean} [force=false] * @param {boolean} [retry] * undefined: `add(fn)` -> `false` and `add('step',fn)` -> `true`

(taskName, fn = undefined, force = false, retry = undefined, timeout = undefined)

   * @inner
   */
  add(taskName, fn = undefined, force = false, retry = undefined, timeout = undefined) {
    if (typeof taskName === 'function') {
      fn = taskName
      taskName = fn.toString()
      if (retry === undefined) retry = false
    }
    if (retry === undefined) retry = true
    if (!running && !force) {
      return Promise.resolve()
    }
    tasks.push(taskName)
    debug(chalk.gray(`${currentQueue()} Queued | ${taskName}`))

    return (promise = Promise.resolve(promise).then(res => {
      // prefer options for non-conditional retries
      const retryOpts = this.retries
        .sort((r1, r2) => r1.when && !r2.when)
        .slice(-1)
        .pop()
      // no retries or unnamed tasks
      debug(`${currentQueue()} Running | ${taskName} | Timeout: ${timeout || 'None'}`)
      if (retryOpts) debug(`${currentQueue()} Retry opts`, JSON.stringify(retryOpts))

      if (!retryOpts || !taskName || !retry) {
        const [promise, timer] = getTimeoutPromise(timeout, taskName)
        return Promise.race([promise, Promise.resolve(res).then(fn)]).finally(() => clearTimeout(timer))
      }

      const retryRules = this.retries.slice().reverse()
      return promiseRetry(Object.assign({}, defaultRetryOptions, retryOpts), (retry, number) => {
        if (number > 1) output.log(`${currentQueue()}Retrying... Attempt #${number}`)
        const [promise, timer] = getTimeoutPromise(timeout, taskName)
        return Promise.race([promise, Promise.resolve(res).then(fn)])
          .finally(() => clearTimeout(timer))
          .catch(err => {
            if (ignoredErrs.includes(err)) return
            for (const retryObj of retryRules) {
              if (!retryObj.when) return retry(err)
              if (retryObj.when && retryObj.when(err)) return retry(err)
            }
            throw err
          })
      })
    }))
  },

  /**
   * @param {*} opts