refactor: create factories to handle drivers and connections

Author: jlenon7

index.ts

@@ -17,6 +17,7 @@ export * from './src/Builders/ColumnBuilder'
 export * from './src/Builders/ReferenceColumnBuilder'
 
 export * from './src/Utils/Transaction'
-export * from './src/Utils/ConnectionResolver'
+export * from './src/Utils/DriverFactory'
+export * from './src/Utils/ConnectionFactory'
 
 export * from './src/Database'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/database",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Handle your application database with factories, seeders and query builder in Node.js",
   "license": "MIT",
   "author": "João Lenon <lenon@secjs.com.br>",

src/Contracts/DatabaseContract.ts

@@ -32,7 +32,7 @@ export interface DatabaseContract {
    * The most important method from drivers. Creates the connection with database
    *
    */
-  connect(): Promise<DatabaseContract>
+  connect(force?: boolean, saveOnDriver?: boolean): Promise<DatabaseContract>
 
   /**
    * On method
@@ -51,7 +51,7 @@ export interface DatabaseContract {
    * @return Return the actual database chain
    *
    */
-  clone(): Promise<DatabaseContract>
+  clone(): DatabaseContract
 
   /**
    * CloneQuery method

src/Contracts/DriverContract.ts

@@ -20,7 +20,7 @@ export interface DriverContract {
    * The most important method from drivers. Creates the connection with database
    *
    */
-  connect(): Promise<void>
+  connect(force?: boolean, saveOnDriver?: boolean): Promise<void>
 
   /**
    * On method

src/Database.ts

@@ -7,15 +7,10 @@
  * file that was distributed with this source code.
  */
 
-import {
-  InternalServerException,
-  NotImplementedException,
-} from '@secjs/exceptions'
-
-import { Drivers } from './Drivers/Drivers'
 import { JoinType } from './Contracts/JoinType'
-import { Config, PaginatedResponse, Path } from '@secjs/utils'
+import { DriverFactory } from './Utils/DriverFactory'
 import { DriverContract } from './Contracts/DriverContract'
+import { Config, PaginatedResponse, Path } from '@secjs/utils'
 import { DatabaseContract } from './Contracts/DatabaseContract'
 import { TransactionContract } from './Contracts/TransactionContract'
 
@@ -24,71 +19,57 @@ export class Database implements DatabaseContract {
   private connectionName: string
   private driver: DriverContract
 
-  static build(
-    name: string,
-    driver: new (connection: string, configs?: any) => DriverContract,
-  ) {
-    if (Drivers[name])
-      throw new InternalServerException(`Driver ${name} already exists`)
+  constructor(runtimeConfig: any = {}) {
+    new Config().safeLoad(Path.config('database'))
 
-    Drivers[name] = driver
+    this.runtimeConfig = runtimeConfig
+    this.connectionName = 'default'
+    this.driver = DriverFactory.fabricate('default', runtimeConfig)
   }
 
   static get drivers(): string[] {
-    return Object.keys(Drivers)
+    return DriverFactory.availableDrivers()
   }
 
-  private createDriverInstance(connectionName?: string) {
-    connectionName = connectionName || Config.get('database.default')
+  static build(
+    name: string,
+    driver: new (connection: string, configs?: any) => DriverContract,
+  ) {
+    DriverFactory.createDriver(name, driver)
+  }
 
-    const connectionConfig = Config.get(
-      `database.connections.${connectionName}`,
+  static async closeDriver(...drivers: string[]): Promise<void> {
+    const promises = drivers.map(driver =>
+      DriverFactory.closeDriverConnection(driver),
     )
 
-    if (!connectionConfig) {
-      throw new NotImplementedException(
-        `Connection ${connectionName} is not configured inside database.connections object from config/database file`,
-      )
-    }
-
-    if (!Drivers[connectionConfig.driver]) {
-      throw new NotImplementedException(
-        `Driver ${connectionConfig.driver} does not exist, use Database.build method to create a new driver`,
-      )
-    }
-
-    this.connectionName = connectionName
-
-    return new Drivers[connectionConfig.driver](
-      connectionName,
-      this.runtimeConfig,
-    )
+    await Promise.all(promises)
   }
 
-  constructor(runtimeConfig: any = {}) {
-    new Config().safeLoad(Path.config('database'))
-
-    this.runtimeConfig = runtimeConfig
-    this.driver = this.createDriverInstance()
+  static async closeAllDrivers(): Promise<void> {
+    return DriverFactory.closeAllDriversConnection()
   }
 
+  // DriverContract Methods
+
   connection(connection: string, runtimeConfig: any = {}): DatabaseContract {
     this.runtimeConfig = runtimeConfig
 
-    this.driver.close()
-    this.driver = this.createDriverInstance(connection)
+    this.connectionName = connection
+    this.driver = DriverFactory.fabricate(connection, runtimeConfig)
 
     return this
   }
 
-  // DriverContract Methods
-
   setQueryBuilder(query: any): void {
     this.driver.setQueryBuilder(query)
   }
 
-  async connect(): Promise<DatabaseContract> {
-    await this.driver.connect()
+  async connect(
+    force?: boolean,
+    saveOnDriver?: boolean,
+  ): Promise<DatabaseContract> {
+    await this.driver.connect(force, saveOnDriver)
 
     return this
   }
@@ -101,10 +82,10 @@ export class Database implements DatabaseContract {
     return this.driver.cloneQuery()
   }
 
-  async clone(): Promise<DatabaseContract> {
-    const database: any = await new Database()
-      .connection(this.connectionName)
-      .connect()
+  clone(connection?: string): DatabaseContract {
+    const database: any = new Database().connection(
+      connection || this.connectionName,
+    )
 
     database.setQueryBuilder(this.cloneQuery())
 

src/Drivers/Drivers.ts

@@ -15,12 +15,12 @@ import {
   Schema,
 } from 'mongoose'
 import { ObjectID } from 'bson'
-import { Is, paginate, PaginatedResponse } from '@secjs/utils'
 import { Transaction } from '../Utils/Transaction'
+import { DriverFactory } from '../Utils/DriverFactory'
 import { TableBuilder } from '../Builders/TableBuilder'
 import { InternalServerException } from '@secjs/exceptions'
 import { DriverContract } from '../Contracts/DriverContract'
-import { ConnectionResolver } from '../Utils/ConnectionResolver'
+import { Is, paginate, PaginatedResponse } from '@secjs/utils'
 
 export class MongoDriver implements DriverContract {
   private defaultTable: string
@@ -33,27 +33,6 @@ export class MongoDriver implements DriverContract {
   private readonly configs: any
   private readonly connection: string
 
-  // This is important only for update and delete queries
-  private _where = {}
-  // This is important to be global in class to manipulate data before some operations
-  private _pipeline = []
-
-  private get where() {
-    const where = { ...this._where }
-
-    this._where = {}
-
-    return where
-  }
-
-  private get pipeline() {
-    const pipeline = [...this._pipeline]
-
-    this._pipeline = []
-
-    return pipeline
-  }
-
   constructor(
     client: any | string,
     configs: any = {},
@@ -74,6 +53,28 @@ export class MongoDriver implements DriverContract {
     this.isConnected = true
   }
 
+  // This is important only for update and delete queries
+  private _where = {}
+
+  private get where() {
+    const where = { ...this._where }
+
+    this._where = {}
+
+    return where
+  }
+
+  // This is important to be global in class to manipulate data before some operations
+  private _pipeline = []
+
+  private get pipeline() {
+    const pipeline = [...this._pipeline]
+
+    this._pipeline = []
+
+    return pipeline
+  }
+
   async commit(): Promise<any | any[]> {
     const doc = await this.session.commitTransaction()
     await this.session.endSession()
@@ -94,12 +95,14 @@ export class MongoDriver implements DriverContract {
     return doc
   }
 
-  async connect(): Promise<void> {
-    if (this.isConnected) return
+  async connect(force = false, saveOnDriver = true): Promise<void> {
+    if (this.isConnected && !force) return
 
-    this.client = await ConnectionResolver.mongoose(
+    this.client = await DriverFactory.generateDriverClient(
+      'mongo',
       this.connection,
       this.configs,
+      saveOnDriver,
     )
 
     this.isConnected = true
@@ -136,17 +139,27 @@ export class MongoDriver implements DriverContract {
   }
 
   async createDatabase(databaseName: string): Promise<void> {
-    const client = await ConnectionResolver.mongoose(this.connection, {
-      database: databaseName,
-    })
+    const client = await DriverFactory.generateDriverClient(
+      'mongo',
+      this.connection,
+      {
+        database: databaseName,
+      },
+      false,
+    )
 
     await client.close()
   }
 
   async dropDatabase(databaseName: string): Promise<void> {
-    const client = await ConnectionResolver.mongoose(this.connection, {
-      database: databaseName,
-    })
+    const client = await DriverFactory.generateDriverClient(
+      'mongo',
+      this.connection,
+      {
+        database: databaseName,
+      },
+      false,
+    )
 
     await client.dropDatabase()
     await client.close()

src/Drivers/MongoDriver.ts

@@ -8,11 +8,11 @@
  */
 
 import { Knex } from 'knex'
-import { paginate, PaginatedResponse } from '@secjs/utils'
 import { Transaction } from '../Utils/Transaction'
+import { DriverFactory } from '../Utils/DriverFactory'
+import { paginate, PaginatedResponse } from '@secjs/utils'
 import { InternalServerException } from '@secjs/exceptions'
 import { DriverContract } from '../Contracts/DriverContract'
-import { ConnectionResolver } from '../Utils/ConnectionResolver'
 
 export class MySqlDriver implements DriverContract {
   private isConnected: boolean
@@ -117,13 +117,14 @@ export class MySqlDriver implements DriverContract {
     this.queryBuilder.on(event, callback)
   }
 
-  async connect(): Promise<void> {
-    if (this.isConnected) return
+  async connect(force = false, saveOnDriver = true): Promise<void> {
+    if (this.isConnected && !force) return
 
-    this.client = await ConnectionResolver.knex(
+    this.client = await DriverFactory.generateDriverClient(
       'mysql',
       this.connection,
       this.configs,
+      saveOnDriver,
     )
     this.queryBuilder = this.query()
 

src/Drivers/MySqlDriver.ts

@@ -8,11 +8,11 @@
  */
 
 import { Knex } from 'knex'
-import { paginate, PaginatedResponse } from '@secjs/utils'
 import { Transaction } from '../Utils/Transaction'
+import { DriverFactory } from '../Utils/DriverFactory'
+import { Is, paginate, PaginatedResponse } from '@secjs/utils'
 import { InternalServerException } from '@secjs/exceptions'
 import { DriverContract } from '../Contracts/DriverContract'
-import { ConnectionResolver } from '../Utils/ConnectionResolver'
 
 export class PostgresDriver implements DriverContract {
   private isConnected: boolean
@@ -25,7 +25,7 @@ export class PostgresDriver implements DriverContract {
   private readonly connection: string
 
   constructor(client?: Knex | Knex.Transaction | string, configs?: any) {
-    if (typeof client === 'string') {
+    if (Is.String(client)) {
       this.isConnected = false
       this.defaultTable = null
 
@@ -117,13 +117,14 @@ export class PostgresDriver implements DriverContract {
     this.queryBuilder.on(event, callback)
   }
 
-  async connect(): Promise<void> {
-    if (this.isConnected) return
+  async connect(force = false, saveOnDriver = true): Promise<void> {
+    if (this.isConnected && !force) return
 
-    this.client = await ConnectionResolver.knex(
-      'pg',
+    this.client = await DriverFactory.generateDriverClient(
+      'postgres',
       this.connection,
       this.configs,
+      saveOnDriver,
     )
     this.queryBuilder = this.query()