feat(drivers): drivers receives the config via setConfig method

since drivers can control their construction lifecycle, we pass them the config via `setConfig`
method

package.json

@@ -23,6 +23,7 @@
   "author": "virk",
   "license": "MIT",
   "devDependencies": {
+    "@adonisjs/fold": "^4.0.2",
     "@adonisjs/sink": "^1.0.13",
     "coveralls": "^2.13.1",
     "cz-conventional-changelog": "^2.0.0",
@@ -41,10 +42,13 @@
     }
   },
   "nyc": {
-    "exclude": ["bin"]
+    "exclude": [
+      "bin"
+    ]
   },
   "dependencies": {
     "@adonisjs/generic-exceptions": "^1.0.0",
+    "debug": "^3.0.0",
     "form-data": "^2.2.0",
     "get-stream": "^3.0.0",
     "got": "^7.1.0",

src/Mail/Drivers/Smtp.js

@@ -20,7 +20,15 @@ const nodemailer = require('nodemailer')
  * @constructor
  */
 class SmtpDriver {
-  constructor (config) {
+  /**
+   * This method is called by mail manager automatically
+   * and passes the config object
+   *
+   * @method setConfig
+   *
+   * @param  {Object}  config
+   */
+  setConfig (config) {
     this.transporter = nodemailer.createTransport(config)
   }
 

src/Mail/Drivers/SparkPost.js

@@ -12,6 +12,12 @@ const nodemailer = require('nodemailer')
 const getStream = require('get-stream')
 const Request = require('../../Request')
 
+/**
+ * The core transportor node-mailer
+ *
+ * @class SparkPostTransporter
+ * @constructor
+ */
 class SparkPostTransporter {
   constructor (config) {
     this.config = config
@@ -182,7 +188,15 @@ class SparkPostTransporter {
  * @constructor
  */
 class SparkPost {
-  constructor (config) {
+  /**
+   * This method is called by mail manager automatically
+   * and passes the config object
+   *
+   * @method setConfig
+   *
+   * @param  {Object}  config
+   */
+  setConfig (config) {
     this.transporter = nodemailer.createTransport(new SparkPostTransporter(config))
   }
 

src/Mail/Manager.js

@@ -10,6 +10,7 @@
 */
 
 const GE = require('@adonisjs/generic-exceptions')
+const { ioc } = require('@adonisjs/fold')
 const Drivers = require('./Drivers')
 const MailSender = require('./Sender')
 
@@ -21,6 +22,26 @@ const MailSender = require('./Sender')
  * @constructor
  */
 class MailManager {
+  constructor () {
+    this._drivers = {}
+  }
+
+  /**
+   * Exposing api to be extend, IoC container will
+   * use this method when someone tries to
+   * extend mail provider
+   *
+   * @method extend
+   *
+   * @param  {String} name
+   * @param  {Object} implementation
+   *
+   * @return {void}
+   */
+  extend (name, implementation) {
+    this._drivers[name] = implementation
+  }
+
   /**
    * Returns an instance of sender with the defined
    * driver.
@@ -37,13 +58,16 @@ class MailManager {
       throw GE.InvalidArgumentException.invalidParameter('Cannot get driver instance without a name')
     }
 
-    const Driver = Drivers[name.toLowerCase()]
+    name = name.toLowerCase()
+    const Driver = Drivers[name] || this._drivers[name]
 
     if (!Driver) {
       throw GE.InvalidArgumentException.invalidParameter(`${name} is not a valid mail driver`)
     }
 
-    return new MailSender(new Driver(config))
+    const driverInstance = ioc.make(Driver)
+    driverInstance.setConfig(config)
+    return new MailSender(driverInstance)
   }
 }
 

test/mail-sender.spec.js

@@ -20,7 +20,8 @@ test.group('Mail sender', () => {
     /**
      * Driver instance
      */
-    const smtp = new SmtpDriver({
+    const smtp = new SmtpDriver()
+    smtp.setConfig({
       host: process.env.SMTP_HOST,
       port: Number(process.env.SMTP_PORT),
       auth: {
@@ -96,7 +97,8 @@ test.group('Mail sender', () => {
     /**
      * Driver instance
      */
-    const smtp = new SmtpDriver({
+    const smtp = new SmtpDriver()
+    smtp.setConfig({
       host: process.env.SMTP_HOST,
       port: Number(process.env.SMTP_PORT),
       auth: {

test/smtp-driver.spec.js

@@ -27,13 +27,15 @@ test.group('Stmp driver', (group) => {
   })
 
   test('newup smtp driver', (assert) => {
-    const smtp = new SmtpDriver(this.config)
+    const smtp = new SmtpDriver()
+    smtp.setConfig(this.config)
     assert.instanceOf(smtp, SmtpDriver)
     assert.isDefined(smtp.transporter)
   })
 
   test('send plain email', async (assert) => {
-    const smtp = new SmtpDriver(this.config)
+    const smtp = new SmtpDriver()
+    smtp.setConfig(this.config)
 
     const response = await helpers.processWithDelay(smtp.send({
       from: process.env.SMTP_FROM_EMAIL,
@@ -53,7 +55,8 @@ test.group('Stmp driver', (group) => {
   }).timeout(0)
 
   test('send email with attachment', async (assert) => {
-    const smtp = new SmtpDriver(this.config)
+    const smtp = new SmtpDriver()
+    smtp.setConfig(this.config)
 
     const response = await helpers.processWithDelay(smtp.send({
       from: process.env.SMTP_FROM_EMAIL,
@@ -81,7 +84,8 @@ test.group('Stmp driver', (group) => {
   test('throw errors if unable to send email', async (assert) => {
     assert.plan(1)
     this.config.auth.user = null
-    const smtp = new SmtpDriver(this.config)
+    const smtp = new SmtpDriver()
+    smtp.setConfig(this.config)
 
     try {
       await helpers.processWithDelay(smtp.send({