Change KnexProvider interface, add helper functions for testing knex

najs-framework · Jun 23, 2018 · eee2434 · eee2434
1 parent 11a71cf
commit eee2434
Show file tree

Hide file tree

Showing 19 changed files with 229 additions and 34 deletions.
diff --git a/dist/lib/contracts/KnexProvider.d.ts b/dist/lib/contracts/KnexProvider.d.ts
@@ -1,5 +1,5 @@
 declare namespace Najs.Contracts.Eloquent {
-    interface KnexProvider<QueryBuilder, Config extends object> extends Najs.Contracts.Autoload {
+    interface KnexProvider<Knex, QueryBuilder, Config extends object> extends Najs.Contracts.Autoload {
         /**
          * Set default config for knex instance
          */
@@ -11,6 +11,10 @@ declare namespace Najs.Contracts.Eloquent {
         /**
          * Create an knex instance
          */
-        create(table: string, config?: Config): QueryBuilder;
+        createKnex(config?: Config): Knex;
+        /**
+         * Create an knex instance
+         */
+        createQueryBuilder(table: string, config?: Config): QueryBuilder;
     }
 }
diff --git a/dist/lib/facades/global/KnexProviderFacade.d.ts b/dist/lib/facades/global/KnexProviderFacade.d.ts
@@ -1,8 +1,8 @@
 /// <reference path="../../contracts/KnexProvider.d.ts" />
 import '../../providers/KnexProvider';
 import { IFacade, IFacadeBase } from 'najs-facade';
-import { QueryBuilder, Config } from 'knex';
-export interface IKnexProviderFacade extends Najs.Contracts.Eloquent.KnexProvider<QueryBuilder, Config> {
+import * as Knex from 'knex';
+export interface IKnexProviderFacade extends Najs.Contracts.Eloquent.KnexProvider<Knex, Knex.QueryBuilder, Knex.Config> {
 }
 export declare const KnexProviderFacade: IKnexProviderFacade & IFacade;
 export declare const KnexProvider: IKnexProviderFacade & IFacadeBase;
diff --git a/dist/lib/providers/KnexProvider.d.ts b/dist/lib/providers/KnexProvider.d.ts
@@ -1,10 +1,12 @@
 /// <reference path="../contracts/KnexProvider.d.ts" />
+import * as Knex from 'knex';
 import { Facade } from 'najs-facade';
 import { QueryBuilder, Config } from 'knex';
-export declare class KnexProvider extends Facade implements Najs.Contracts.Eloquent.KnexProvider<QueryBuilder, Config> {
+export declare class KnexProvider extends Facade implements Najs.Contracts.Eloquent.KnexProvider<Knex, QueryBuilder, Config> {
     protected config: Config;
     getClassName(): string;
     setDefaultConfig(config: Config): this;
     getDefaultConfig(): Config;
-    create(table: string, config?: Config): QueryBuilder;
+    createKnex(config?: Config): Knex;
+    createQueryBuilder(table: string, config?: Config): QueryBuilder;
 }
diff --git a/dist/lib/providers/KnexProvider.js b/dist/lib/providers/KnexProvider.js
@@ -16,8 +16,11 @@ class KnexProvider extends najs_facade_1.Facade {
     getDefaultConfig() {
         return this.config;
     }
-    create(table, config) {
-        return Knex(config || this.config)(table);
+    createKnex(config) {
+        return Knex(config || this.config);
+    }
+    createQueryBuilder(table, config) {
+        return this.createKnex(config)(table);
     }
 }
 exports.KnexProvider = KnexProvider;

diff --git a/dist/lib/query-builders/KnexQueryBuilder.d.ts b/dist/lib/query-builders/KnexQueryBuilder.d.ts
@@ -8,9 +8,11 @@ export declare class KnexQueryBuilder extends QueryBuilderBase {
         deletedAt: string;
     };
     protected table: string;
-    protected knex: Knex.QueryBuilder;
+    protected knexQueryBuilder: Knex.QueryBuilder;
     constructor(table: string, primaryKeyName: string, softDelete?: {
         deletedAt: string;
     });
     orderBy(field: string, direction?: string): this;
+    withTrashed(): this;
+    onlyTrashed(): this;
 }
diff --git a/dist/lib/query-builders/KnexQueryBuilder.js b/dist/lib/query-builders/KnexQueryBuilder.js
@@ -10,17 +10,21 @@ class KnexQueryBuilder extends QueryBuilderBase_1.QueryBuilderBase {
         this.table = table;
         this.primaryKeyName = primaryKeyName;
         this.softDelete = softDelete;
-        this.knex = KnexProviderFacade_1.KnexProvider.create(table);
+        this.knexQueryBuilder = KnexProviderFacade_1.KnexProvider.createQueryBuilder(table);
     }
     orderBy(field, direction) {
         this.isUsed = true;
-        this.knex.orderBy(field, direction);
+        this.knexQueryBuilder.orderBy(field, direction);
+        return this;
+    }
+    withTrashed() {
+        return this;
+    }
+    onlyTrashed() {
         return this;
     }
 }
 exports.KnexQueryBuilder = KnexQueryBuilder;
-// getPrimaryKeyName orderByAsc orderByDesc
-// withTrashed onlyTrashed
 const methods = [
     // NajsEloquent.QueryBuilder.IBasicQuery
     'select',
@@ -30,7 +34,7 @@ const methods = [
 for (const name of methods) {
     KnexQueryBuilder.prototype[name] = function () {
         this['isUsed'] = true;
-        this['knex'][name](...arguments);
+        this['knexQueryBuilder'][name](...arguments);
         return this;
     };
 }
diff --git a/dist/test/providers/KnexProvider.test.js b/dist/test/providers/KnexProvider.test.js
@@ -27,12 +27,12 @@ describe('KnexProvider', function () {
             expect(knexProvider.getDefaultConfig() === config).toBe(true);
         });
     });
-    describe('.create()', function () {
+    describe('.createKnex()', function () {
         it('calls knex() with default config, then passes table to the result function', function () {
             const knexProvider = new KnexProvider_1.KnexProvider();
             const config = { client: 'mysql' };
             knexProvider.setDefaultConfig(config);
-            const result = knexProvider.create('table');
+            const result = knexProvider.createKnex(config)('table');
             expect(result['client']['config'] === config).toBe(true);
             expect(result.toQuery()).toEqual('select * from `table`');
         });
@@ -41,7 +41,26 @@ describe('KnexProvider', function () {
             const defaultConfig = { client: 'mysql' };
             knexProvider.setDefaultConfig(defaultConfig);
             const config = { client: 'mysql' };
-            const result = knexProvider.create('table', config);
+            const result = knexProvider.createKnex(config)('table');
+            expect(result['client']['config'] === config).toBe(true);
+            expect(result.toQuery()).toEqual('select * from `table`');
+        });
+    });
+    describe('.createQueryBuilder()', function () {
+        it('calls knex() with default config, then passes table to the result function', function () {
+            const knexProvider = new KnexProvider_1.KnexProvider();
+            const config = { client: 'mysql' };
+            knexProvider.setDefaultConfig(config);
+            const result = knexProvider.createQueryBuilder('table');
+            expect(result['client']['config'] === config).toBe(true);
+            expect(result.toQuery()).toEqual('select * from `table`');
+        });
+        it('calls knex() with passed config, then passes table to the result function', function () {
+            const knexProvider = new KnexProvider_1.KnexProvider();
+            const defaultConfig = { client: 'mysql' };
+            knexProvider.setDefaultConfig(defaultConfig);
+            const config = { client: 'mysql' };
+            const result = knexProvider.createQueryBuilder('table', config);
             expect(result['client']['config'] === config).toBe(true);
             expect(result.toQuery()).toEqual('select * from `table`');
         });

diff --git a/dist/test/query-builders/KnexQueryBuilder.test.d.ts b/dist/test/query-builders/KnexQueryBuilder.test.d.ts
@@ -0,0 +1 @@
+import 'jest';
diff --git a/dist/test/query-builders/KnexQueryBuilder.test.js b/dist/test/query-builders/KnexQueryBuilder.test.js
@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("jest");
+const util_1 = require("../util");
+// import { KnexProvider } from '../../lib/facades/global/KnexProviderFacade'
+describe('KnexQueryBuilder', function () {
+    beforeAll(async function () {
+        return util_1.init_knex('najs_eloquent_knex_query_builder').then(function () {
+            return util_1.knex_run_sql(`CREATE TABLE users (
+        id INT NOT NULL AUTO_INCREMENT,
+        first_name VARCHAR(255),
+        last_name VARCHAR(255),
+        email VARCHAR(255),
+        created_at DATETIME,
+        updated_at DATETIME,
+        deleted_at DATETIME,
+        age INT,
+        PRIMARY KEY (id)
+      )`);
+        });
+    });
+    it('should work', function () { });
+});
diff --git a/dist/test/util.d.ts b/dist/test/util.d.ts
@@ -2,3 +2,5 @@ export declare function init_mongoose(mongoose: any, name: string): Promise<any>
 export declare function delete_collection(mongoose: any, collection: string): Promise<any>;
 export declare function init_mongodb(name: string): any;
 export declare function delete_collection_use_mongodb(name: string): any;
+export declare function init_knex(database: string): Promise<any>;
+export declare function knex_run_sql(sql: string): Promise<any>;
diff --git a/dist/test/util.js b/dist/test/util.js
@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const MongodbProviderFacade_1 = require("../lib/facades/global/MongodbProviderFacade");
+const KnexProviderFacade_1 = require("../lib/facades/global/KnexProviderFacade");
 function init_mongoose(mongoose, name) {
     return new Promise(resolve => {
         mongoose.connect('mongodb://localhost/najs_eloquent_test_' + name);
@@ -27,3 +28,38 @@ function delete_collection_use_mongodb(name) {
         .drop();
 }
 exports.delete_collection_use_mongodb = delete_collection_use_mongodb;
+function init_knex(database) {
+    return new Promise(resolve => {
+        const connection = {
+            host: '127.0.0.1',
+            user: 'root',
+            password: ''
+        };
+        KnexProviderFacade_1.KnexProviderFacade.setDefaultConfig({
+            client: 'mysql',
+            connection: connection
+        });
+        const dropDatabaseSql = `DROP DATABASE IF EXISTS ${database}`;
+        const createDatabaseSql = `CREATE DATABASE ${database} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_bin`;
+        const knex = KnexProviderFacade_1.KnexProviderFacade.createKnex();
+        knex.raw(dropDatabaseSql).then(function (result) {
+            knex.raw(createDatabaseSql).then(function (result) {
+                connection['database'] = database;
+                KnexProviderFacade_1.KnexProviderFacade.setDefaultConfig({
+                    client: 'mysql',
+                    connection: connection
+                });
+                resolve();
+            });
+        });
+    });
+}
+exports.init_knex = init_knex;
+function knex_run_sql(sql) {
+    return new Promise(resolve => {
+        KnexProviderFacade_1.KnexProviderFacade.createKnex()
+            .raw(sql)
+            .then(resolve);
+    });
+}
+exports.knex_run_sql = knex_run_sql;
diff --git a/lib/contracts/KnexProvider.ts b/lib/contracts/KnexProvider.ts
@@ -1,5 +1,5 @@
 namespace Najs.Contracts.Eloquent {
-  export interface KnexProvider<QueryBuilder, Config extends object> extends Najs.Contracts.Autoload {
+  export interface KnexProvider<Knex, QueryBuilder, Config extends object> extends Najs.Contracts.Autoload {
     /**
      * Set default config for knex instance
      */
@@ -13,6 +13,11 @@ namespace Najs.Contracts.Eloquent {
     /**
      * Create an knex instance
      */
-    create(table: string, config?: Config): QueryBuilder
+    createKnex(config?: Config): Knex
+
+    /**
+     * Create an knex instance
+     */
+    createQueryBuilder(table: string, config?: Config): QueryBuilder
   }
 }
diff --git a/lib/facades/global/KnexProviderFacade.ts b/lib/facades/global/KnexProviderFacade.ts
@@ -4,10 +4,11 @@ import '../../providers/KnexProvider'
 import { make } from 'najs-binding'
 import { Facade, IFacade, IFacadeBase } from 'najs-facade'
 import { container } from '../container'
-import { QueryBuilder, Config } from 'knex'
+import * as Knex from 'knex'
 import { NajsEloquent } from '../../constants'
 
-export interface IKnexProviderFacade extends Najs.Contracts.Eloquent.KnexProvider<QueryBuilder, Config> {}
+export interface IKnexProviderFacade
+  extends Najs.Contracts.Eloquent.KnexProvider<Knex, Knex.QueryBuilder, Knex.Config> {}
 
 const facade = Facade.create<IKnexProviderFacade>(container, 'KnexProvider', function() {
   return make<IKnexProviderFacade>(NajsEloquent.Provider.KnexProvider)

diff --git a/lib/providers/KnexProvider.ts b/lib/providers/KnexProvider.ts
@@ -6,7 +6,7 @@ import { Facade } from 'najs-facade'
 import { QueryBuilder, Config } from 'knex'
 import { register } from 'najs-binding'
 
-export class KnexProvider extends Facade implements Najs.Contracts.Eloquent.KnexProvider<QueryBuilder, Config> {
+export class KnexProvider extends Facade implements Najs.Contracts.Eloquent.KnexProvider<Knex, QueryBuilder, Config> {
   protected config: Config
 
   getClassName() {
@@ -23,8 +23,12 @@ export class KnexProvider extends Facade implements Najs.Contracts.Eloquent.Knex
     return this.config
   }
 
-  create(table: string, config?: Config): QueryBuilder {
-    return Knex(config || this.config)(table)
+  createKnex(config?: Config): Knex {
+    return Knex(config || this.config)
+  }
+
+  createQueryBuilder(table: string, config?: Config): QueryBuilder {
+    return this.createKnex(config)(table)
   }
 }
 register(KnexProvider, NajsEloquent.Provider.KnexProvider)
diff --git a/lib/query-builders/KnexQueryBuilder.ts b/lib/query-builders/KnexQueryBuilder.ts
@@ -13,25 +13,31 @@ export interface KnexQueryBuilder
 export class KnexQueryBuilder extends QueryBuilderBase {
   protected softDelete?: { deletedAt: string }
   protected table: string
-  protected knex: Knex.QueryBuilder
+  protected knexQueryBuilder: Knex.QueryBuilder
 
   constructor(table: string, primaryKeyName: string, softDelete?: { deletedAt: string }) {
     super()
     this.table = table
     this.primaryKeyName = primaryKeyName
     this.softDelete = softDelete
-    this.knex = KnexProvider.create(table)
+    this.knexQueryBuilder = KnexProvider.createQueryBuilder(table)
   }
 
   orderBy(field: string, direction?: string): this {
     this.isUsed = true
-    this.knex.orderBy(field, direction)
+    this.knexQueryBuilder.orderBy(field, direction)
+    return this
+  }
+
+  withTrashed() {
+    return this
+  }
+
+  onlyTrashed() {
     return this
   }
 }
 
-// getPrimaryKeyName orderByAsc orderByDesc
-// withTrashed onlyTrashed
 const methods = [
   // NajsEloquent.QueryBuilder.IBasicQuery
   'select',
@@ -42,7 +48,7 @@ const methods = [
 for (const name of methods) {
   KnexQueryBuilder.prototype[name] = function() {
     this['isUsed'] = true
-    this['knex'][name](...arguments)
+    this['knexQueryBuilder'][name](...arguments)
     return this
   }
 }
diff --git a/script/start-db-by-docker.sh b/script/start-db-by-docker.sh
@@ -4,4 +4,4 @@ docker rm -v najs-eloquent-mongo
 docker run -p "27017:27017" --name najs-eloquent-mongo -d mongo
 
 docker rm -v najs-eloquent-mariadb
-docker run -p "3306:3306" -e MYSQL_ROOT_PASSWORD=root --name najs-eloquent-mariadb -d mariadb
+docker run -p "3306:3306" -e MYSQL_ALLOW_EMPTY_PASSWORD=1 --name najs-eloquent-mariadb -d mariadb
diff --git a/test/providers/KnexProvider.test.ts b/test/providers/KnexProvider.test.ts
@@ -29,12 +29,12 @@ describe('KnexProvider', function() {
     })
   })
 
-  describe('.create()', function() {
+  describe('.createKnex()', function() {
     it('calls knex() with default config, then passes table to the result function', function() {
       const knexProvider = new KnexProvider()
       const config = { client: 'mysql' }
       knexProvider.setDefaultConfig(config)
-      const result = knexProvider.create('table')
+      const result = knexProvider.createKnex(config)('table')
       expect(result['client']['config'] === config).toBe(true)
       expect(result.toQuery()).toEqual('select * from `table`')
     })
@@ -45,7 +45,29 @@ describe('KnexProvider', function() {
       knexProvider.setDefaultConfig(defaultConfig)
 
       const config = { client: 'mysql' }
-      const result = knexProvider.create('table', config)
+      const result = knexProvider.createKnex(config)('table')
+      expect(result['client']['config'] === config).toBe(true)
+      expect(result.toQuery()).toEqual('select * from `table`')
+    })
+  })
+
+  describe('.createQueryBuilder()', function() {
+    it('calls knex() with default config, then passes table to the result function', function() {
+      const knexProvider = new KnexProvider()
+      const config = { client: 'mysql' }
+      knexProvider.setDefaultConfig(config)
+      const result = knexProvider.createQueryBuilder('table')
+      expect(result['client']['config'] === config).toBe(true)
+      expect(result.toQuery()).toEqual('select * from `table`')
+    })
+
+    it('calls knex() with passed config, then passes table to the result function', function() {
+      const knexProvider = new KnexProvider()
+      const defaultConfig = { client: 'mysql' }
+      knexProvider.setDefaultConfig(defaultConfig)
+
+      const config = { client: 'mysql' }
+      const result = knexProvider.createQueryBuilder('table', config)
       expect(result['client']['config'] === config).toBe(true)
       expect(result.toQuery()).toEqual('select * from `table`')
     })