refactor: use queryBuilder as getter to make validations

Author: jlenon7

src/Drivers/MongoDriver.ts

@@ -27,9 +27,7 @@ export class MongoDriver implements DriverContract {
 
   private client: Connection
   private session: ClientSession
-  private queryBuilder: Collection
   private isConnected: boolean
-
   private readonly configs: any
   private readonly connection: string
 
@@ -53,6 +51,18 @@ export class MongoDriver implements DriverContract {
     this.isConnected = true
   }
 
+  private _queryBuilder: Collection
+
+  private get queryBuilder() {
+    if (!this._queryBuilder) {
+      throw new InternalServerException(
+        `Query builder does not exist in ${MongoDriver.name}, this usually happens when you don't have called connect method to create the connection with database`,
+      )
+    }
+
+    return this._queryBuilder
+  }
+
   // This is important only for update and delete queries
   private _where = {}
 
@@ -248,7 +258,7 @@ export class MongoDriver implements DriverContract {
     this._pipeline = query._pipeline
     this.defaultTable = query.defaultTable
 
-    if (this.defaultTable) this.queryBuilder = this.query()
+    if (this.defaultTable) this._queryBuilder = this.query()
   }
 
   query(): Collection {
@@ -609,7 +619,7 @@ export class MongoDriver implements DriverContract {
 
   buildTable(tableName: string): DriverContract {
     this.defaultTable = tableName
-    this.queryBuilder = this.query()
+    this._queryBuilder = this.query()
 
     return this
   }

src/Drivers/MySqlDriver.ts

@@ -10,22 +10,20 @@
 import { Knex } from 'knex'
 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 { Is, paginate, PaginatedResponse } from '@secjs/utils'
 
 export class MySqlDriver implements DriverContract {
   private isConnected: boolean
   private defaultTable: string
 
   private client: Knex | Knex.Transaction
-  private queryBuilder: Knex.QueryBuilder
-
   private readonly configs: any
   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
 
@@ -37,11 +35,23 @@ export class MySqlDriver implements DriverContract {
 
     this.client = client
     this.isConnected = true
-    this.queryBuilder = this.query()
+    this._queryBuilder = this.query()
+  }
+
+  private _queryBuilder: Knex.QueryBuilder
+
+  private get queryBuilder() {
+    if (!this._queryBuilder) {
+      throw new InternalServerException(
+        `Query builder does not exist in ${MySqlDriver.name}, this usually happens when you don't have called connect method to create the connection with database`,
+      )
+    }
+
+    return this._queryBuilder
   }
 
   setQueryBuilder(query: any) {
-    this.queryBuilder = query.client
+    this._queryBuilder = query.client
   }
 
   query() {
@@ -71,7 +81,7 @@ export class MySqlDriver implements DriverContract {
         ]
 
         if (protectedMethods.includes(propertyKey)) {
-          this.queryBuilder = this.query()
+          this._queryBuilder = this.query()
         }
 
         return target[propertyKey]
@@ -92,7 +102,7 @@ export class MySqlDriver implements DriverContract {
     const committedTrx = await client.commit(value)
 
     this.client = null
-    this.queryBuilder = null
+    this._queryBuilder = null
 
     return committedTrx
   }
@@ -108,7 +118,7 @@ export class MySqlDriver implements DriverContract {
     const rolledBackTrx = await client.rollback(error)
 
     this.client = null
-    this.queryBuilder = null
+    this._queryBuilder = null
 
     return rolledBackTrx
   }
@@ -126,7 +136,7 @@ export class MySqlDriver implements DriverContract {
       this.configs,
       saveOnDriver,
     )
-    this.queryBuilder = this.query()
+    this._queryBuilder = this.query()
 
     this.isConnected = true
   }
@@ -189,7 +199,7 @@ export class MySqlDriver implements DriverContract {
 
     this.client = null
     this.isConnected = false
-    this.queryBuilder = null
+    this._queryBuilder = null
     this.defaultTable = null
   }
 
@@ -220,7 +230,7 @@ export class MySqlDriver implements DriverContract {
   async findMany(): Promise<any[]> {
     const data = await this.queryBuilder
 
-    this.queryBuilder = this.query()
+    this._queryBuilder = this.query()
 
     return data
   }
@@ -316,25 +326,25 @@ export class MySqlDriver implements DriverContract {
   }
 
   buildDistinct(...columns: string[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.distinct(...columns)
+    this._queryBuilder = this.queryBuilder.distinct(...columns)
 
     return this
   }
 
   buildGroupBy(...columns: string[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.groupBy(...columns)
+    this._queryBuilder = this.queryBuilder.groupBy(...columns)
 
     return this
   }
 
   buildGroupByRaw(raw: string, queryValues?: any[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.groupByRaw(raw, queryValues)
+    this._queryBuilder = this.queryBuilder.groupByRaw(raw, queryValues)
 
     return this
   }
 
   buildHaving(column: string, operator: string, value: any): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.having(column, operator, value)
+    this._queryBuilder = this.queryBuilder.having(column, operator, value)
 
     return this
   }
@@ -347,13 +357,13 @@ export class MySqlDriver implements DriverContract {
     joinType = 'join',
   ): MySqlDriver {
     if (operator && !column2)
-      this.queryBuilder = this.queryBuilder[joinType](
+      this._queryBuilder = this.queryBuilder[joinType](
         tableName,
         column1,
         operator,
       )
     if (tableName && column2)
-      this.queryBuilder = this.queryBuilder[joinType](
+      this._queryBuilder = this.queryBuilder[joinType](
         tableName,
         column1,
         operator,
@@ -364,19 +374,19 @@ export class MySqlDriver implements DriverContract {
   }
 
   buildJoinRaw(raw: string, queryValues?: any[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.joinRaw(raw, queryValues)
+    this._queryBuilder = this.queryBuilder.joinRaw(raw, queryValues)
 
     return this
   }
 
   buildLimit(number: number): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.limit(number)
+    this._queryBuilder = this.queryBuilder.limit(number)
 
     return this
   }
 
   buildSkip(number: number): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.offset(number)
+    this._queryBuilder = this.queryBuilder.offset(number)
 
     return this
   }
@@ -386,36 +396,36 @@ export class MySqlDriver implements DriverContract {
     value?: any,
   ): MySqlDriver {
     if (typeof statement === 'object') {
-      this.queryBuilder = this.queryBuilder.where(statement)
+      this._queryBuilder = this.queryBuilder.where(statement)
 
       return this
     }
 
-    this.queryBuilder = this.queryBuilder.where(statement, value)
+    this._queryBuilder = this.queryBuilder.where(statement, value)
 
     return this
   }
 
   buildOrderBy(column: string, direction?: 'asc' | 'desc'): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.orderBy(column, direction)
+    this._queryBuilder = this.queryBuilder.orderBy(column, direction)
 
     return this
   }
 
   buildOrderByRaw(raw: string, queryValues?: any[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.orderByRaw(raw, queryValues)
+    this._queryBuilder = this.queryBuilder.orderByRaw(raw, queryValues)
 
     return this
   }
 
   buildSelect(...columns: string[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.select(...columns)
+    this._queryBuilder = this.queryBuilder.select(...columns)
 
     return this
   }
 
   buildTable(tableName: string): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.table(tableName)
+    this._queryBuilder = this.queryBuilder.table(tableName)
 
     this.defaultTable = tableName
 
@@ -427,12 +437,12 @@ export class MySqlDriver implements DriverContract {
     value?: any,
   ): MySqlDriver {
     if (typeof statement === 'object') {
-      this.queryBuilder = this.queryBuilder.where(statement)
+      this._queryBuilder = this.queryBuilder.where(statement)
 
       return this
     }
 
-    this.queryBuilder = this.queryBuilder.where(statement, value)
+    this._queryBuilder = this.queryBuilder.where(statement, value)
 
     return this
   }
@@ -442,12 +452,12 @@ export class MySqlDriver implements DriverContract {
     value?: any,
   ): MySqlDriver {
     if (typeof statement === 'object') {
-      this.queryBuilder = this.queryBuilder.whereLike(statement)
+      this._queryBuilder = this.queryBuilder.whereLike(statement)
 
       return this
     }
 
-    this.queryBuilder = this.queryBuilder.whereLike(statement, value)
+    this._queryBuilder = this.queryBuilder.whereLike(statement, value)
 
     return this
   }
@@ -457,30 +467,30 @@ export class MySqlDriver implements DriverContract {
     value?: any,
   ): MySqlDriver {
     if (typeof statement === 'object') {
-      this.queryBuilder = this.queryBuilder.whereIlike(statement)
+      this._queryBuilder = this.queryBuilder.whereIlike(statement)
 
       return this
     }
 
-    this.queryBuilder = this.queryBuilder.whereIlike(statement, value)
+    this._queryBuilder = this.queryBuilder.whereIlike(statement, value)
 
     return this
   }
 
   buildWhereBetween(columnName: string, values: [any, any]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereBetween(columnName, values)
+    this._queryBuilder = this.queryBuilder.whereBetween(columnName, values)
 
     return this
   }
 
   buildWhereExists(callback: any): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereExists(callback)
+    this._queryBuilder = this.queryBuilder.whereExists(callback)
 
     return this
   }
 
   buildWhereIn(columnName: string, values: any[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereIn(columnName, values)
+    this._queryBuilder = this.queryBuilder.whereIn(columnName, values)
 
     return this
   }
@@ -490,48 +500,48 @@ export class MySqlDriver implements DriverContract {
     value?: any,
   ): MySqlDriver {
     if (typeof statement === 'object') {
-      this.queryBuilder = this.queryBuilder.whereNot(statement)
+      this._queryBuilder = this.queryBuilder.whereNot(statement)
 
       return this
     }
 
-    this.queryBuilder = this.queryBuilder.whereNot(statement, value)
+    this._queryBuilder = this.queryBuilder.whereNot(statement, value)
 
     return this
   }
 
   buildWhereNotBetween(columnName: string, values: [any, any]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereNotBetween(columnName, values)
+    this._queryBuilder = this.queryBuilder.whereNotBetween(columnName, values)
 
     return this
   }
 
   buildWhereNotExists(callback: any): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereNotExists(callback)
+    this._queryBuilder = this.queryBuilder.whereNotExists(callback)
 
     return this
   }
 
   buildWhereNotIn(columnName: string, values: any[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereNotIn(columnName, values)
+    this._queryBuilder = this.queryBuilder.whereNotIn(columnName, values)
 
     return this
   }
 
   buildWhereNull(columnName: string): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereNull(columnName)
+    this._queryBuilder = this.queryBuilder.whereNull(columnName)
 
     return this
   }
 
   buildWhereNotNull(columnName: string): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereNotNull(columnName)
+    this._queryBuilder = this.queryBuilder.whereNotNull(columnName)
 
     return this
   }
 
   buildWhereRaw(raw: string, queryValues?: any[]): MySqlDriver {
-    this.queryBuilder = this.queryBuilder.whereRaw(raw, queryValues)
+    this._queryBuilder = this.queryBuilder.whereRaw(raw, queryValues)
 
     return this
   }