adonisjs-queue/src/Queue/Manager.js

An addon/plugin package to provide driver-based job queueing services in AdonisJS 4.0+

'use strict'

/*
 * adonis-queue
 *
 * (c) Harminder Virk <virk@adonisjs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
*/

const { ioc } = require('@adonisjs/fold')
const GE = require('@adonisjs/generic-exceptions')
// const drivers = require('./Drivers')

/**
 * The queue manager class is exposed as IoC container
 * binding, which can be used to add new driver and
 * get an instance of a given driver.
 *
 * @namespace Adonis/Src/Queue
 * @manager Adonis/Src/Queue
 * @singleton
 * @group Http
 *
 * @class Manager
 */
class Manager {
  constructor (defaultDrivers = {}) {
    this._drivers = defaultDrivers
  }

  /**
   * Method called by ioc when someone extends the queue
   * manager to add their own driver
   *
   * @method extend
   *
   * @param  {String} key
   * @param  {Class} implementation
   *
   * @return {void}
   */
  extend (key, implementation) {
    if (!this._drivers[key]) {
      this._drivers[key] = implementation
    }
  }

  /**
   * Makes the instance of driver
   *
   * @method makeDriverInstance
   *
   * @param  {String} name
   * @param  {Function} creatorCallback
   *
   * @return {Object}
   */
  makeDriverInstance (name, creatorCallback) {
    const driver = this._drivers[name] || ''

    if (!driver) {
      throw GE
        .InvalidArgumentException
        .invoke(`${name} is not a valid queue driver`, 500, 'E_INVALID_QUEUE_DRIVER')
    }

    if (typeof creatorCallback !== 'function') {
      throw GE
        .InvalidArgumentException
        .invoke(`creatorCallback not provided`, 500, 'E_INVALID_QUEUE_DRIVER')
    }

    if ((driver.indexOf('/') === -1) ||
      (driver.charAt(0) === '@')) {
      return creatorCallback(require(driver))
    }

    return creatorCallback(ioc.make(driver))
  }
}

module.exports = Manager