Merge pull request #1 from Shikyaro/dev

v0.0.3

Author: a1k0r

README.MD

@@ -12,13 +12,14 @@ npm install multi-data-source
 ## Features
 
 * Multiple data sources support
-* Multiple RDBMS support (only PostgreSQL and MySQL for now, but you feel free to create your own connector to favorite RDBMS)
-* Little query template engine
-* Single interface to pass query parameters to all RDBMS by built-in query param escape module
+* Multiple RDBMS support (only PostgreSQL for now, but you feel free to contribute your own connector to favorite RDBMS)
+* Single interface to pass query parameters to multiple RDBMS with [param wrapping module](https://github.com/shikyaro/node-query-template)
+
 
 ## Dependencies
 
-* [pg](https://github.com/brianc/node-postgres) -- Used to handle postgres connection
+* [pg](https://github.com/brianc/node-postgres) -- Used to handle Postgres connection
+* [query-template](https://github.com/shikyaro/node-query-template) -- Used to process queries before execution (templating and parametrizing)
 
 ## Usage example
 
@@ -52,15 +53,15 @@ const getUsersByScore = {
         `,
     addons: {
         noGlobalJoin: {
-            arg: {name: 'global', value: false},
+            options: {propertyName: 'global', propertyValue: false},
             sql: 'INNER JOIN mega_jackpot_halls AS mjh USING(hall_id)',
         },
         nickname: {
-            arg: {name: 'needNickname', value: true},
+            options: {propertyName: 'needNickname', propertyValue: true},
             sql: ', nickname',
         },
         balance: {
-            arg: {name: 'balanceCondition', value: true},
+            options: {propertyName: 'balanceCondition', propertyValue: true},
             sql: 'AND balance >= :balance',
         },
     },
@@ -93,6 +94,32 @@ try {
 }
 ```
 
+## Configuration guide
+
+### Storage configuration
+By default storage conig is semi-equal to [pg](https://github.com/brianc/node-postgres) config with additional field `storageType`.
+
+**Supported storage types:**
+* `pg` -- type for PostgreSQL connection
+
+### Query configuration
+This library using equal query definition to [query-template](https://github.com/shikyaro/node-query-template)
+
+```js
+const query = {
+    sql: 'SELECT * FROM table', // String with SQL code
+    addons: { // Object with named additions
+        addonName: { // Addition object
+            sql: 'AND field1 = :field1', // String with addition SQL
+            options: { // Object with addition config
+                propertyName: 'field1', // Name of templating property
+                propertyValue: true, // Value of templating property
+            }
+        }   
+    }
+}
+```
+
 ## Author
 
 Pavel Romanov -- alkor@alkor.pw -- [GitHub](https://github.com/Shikyaro)

connections/AbstractConnection.js renamed to connections/abstract-connection.js

@@ -1,15 +1,17 @@
+const QueryTemplater = require('query-template');
 /**
  * @class {AbstractConnection}
  * @abstract
  */
 class AbstractConnection {
     /**
-     * @param {{client: object, queries: object?}} config config obj
+     * @param {{client: object, queries: object?, templater: object?}} config config obj
      */
     constructor(config) {
         this.config = config;
         this.client = config.client;
         this.queries = config.queries;
+        this.templater = config.templater || new QueryTemplater();
 
         if (new.target === AbstractConnection) {
             throw new TypeError('Abstract class can not be created!');
@@ -19,7 +21,7 @@ class AbstractConnection {
     /**
      * @abstract
      * @async
-     * @param {{name: String, sql:String, addonds: Object}} queryObject query data
+     * @param {{name: String, sql:String, addons: Object}} queryObject query data
      * @param {Object} queryParams named params
      * @param {Object} queryOptions options
      * @returns {Promise<Array>} query result

connections/PostgresConnection.js renamed to connections/postgres-connection.js

@@ -1,5 +1,4 @@
-const AbstractConnection = require('./AbstractConnection');
-const {escapeParams, QueryTemplater} = require('../query');
+const AbstractConnection = require('./abstract-connection.js');
 
 /**
  * @inheritDoc
@@ -8,37 +7,40 @@ class PostgresConnection extends AbstractConnection {
     /**
      * @async
      * @param {String} query SQL
+     * @param {Array} params query params
      * @returns {Promise<Array>} result
      * @private
      */
-    async _executeQuery(query) {
-        const {rows} = await this.client.query(query);
+    async _executeQuery(query, params) {
+        const {rows} = await this.client.query(query, params);
         return rows;
     }
 
     /**
      * @inheritDoc
      */
     rawQuery(queryText, queryParams, queryOptions = null) {
-        const preparedQuery = escapeParams(queryText, queryParams);
-        return this._executeQuery(preparedQuery);
+        const {query, params} = this.templater.parametrizeQuery(queryText, queryParams, this.config.type);
+        return this._executeQuery(query, params);
     }
 
     /**
      * @inheritDoc
      */
     query(queryObject, queryParams, queryOptions = {}) {
-        const {sql} = queryObject;
+        const {sql, addons} = queryObject;
+        if (!sql) {
+            throw new TypeError('Invalid query object, "sql" property missing');
+        }
+        const {templateParams = {}} = queryOptions;
         let queryText = sql;
 
-        const {templateParams} = queryOptions;
-        if (templateParams) {
-            queryText = QueryTemplater.buildQuery(queryObject, templateParams);
+        if (addons) {
+            queryText = this.templater.processTemplates(queryObject, {...queryParams, ...templateParams});
         }
 
-        const preparedQuery = escapeParams(queryText, queryParams);
-
-        return this._executeQuery(preparedQuery);
+        const {query, params} = this.templater.parametrizeQuery(queryText, queryParams, this.config.type);
+        return this._executeQuery(query, params);
     }
 
     /**

connections/testing-connection.js

@@ -0,0 +1,52 @@
+const AbstractConnection = require('./abstract-connection');
+const MockManager = require('../mock/mock-manager.js');
+
+/**
+ * @inheritDoc
+ */
+class TestingConnection extends AbstractConnection {
+    /**
+     * @inheritDoc
+     */
+    rawQuery(queryText, queryParams, queryOptions = null) {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    query(queryObject, queryParams, queryOptions = {}) {
+        // TODO: make standard with NODE_ENV naming rules
+        // TODO: use utils? module to check environment
+        return MockManager.mockQuery(queryObject, queryParams);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async transaction() {
+        // await this.client.query('BEGIN;');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async commit() {
+        // await this.client.query('COMMIT;');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async rollback() {
+        // await this.client.query('ROLLBACK;');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async release() {
+        // await this.client.release();
+    }
+}
+
+module.exports = TestingConnection;

connectors/AbstractConnector.js renamed to connectors/abstract-connector.js

@@ -1,5 +1,7 @@
-const PostgresConnector = require('./PostgresConnector');
+const PostgresConnector = require('./postgres-connector');
+const TestingConnector = require('./testing-connector');
 
 module.exports = {
     PostgresConnector,
+    TestingConnector,
 };

connectors/index.js

@@ -1,7 +1,7 @@
 const {Pool} = require('pg');
 
-const AbstractConnector = require('./AbstractConnector');
-const PostgresConnection = require('../connections/PostgresConnection');
+const AbstractConnector = require('./abstract-connector.js');
+const PostgresConnection = require('../connections/postgres-connection.js');
 
 /**
  * @inheritDoc
@@ -12,12 +12,7 @@ class PostgresConnector extends AbstractConnector {
      */
     constructor(config) {
         super(config);
-
         this.pool = new Pool({...config});
-
-        // this.pool.on('error', error => {
-        //     // log.error(`Something happened with Postgres pool ${config.storageName}. errorCode: ${error.code}. error: ${error}`);
-        // });
     }
 
     /**

connectors/PostgresConnector.js renamed to connectors/postgres-connector.js

@@ -0,0 +1,47 @@
+const AbstractConnector = require('./abstract-connector.js');
+const TestingConnection = require('../connections/testing-connection.js');
+
+/**
+ * @inheritDoc
+ */
+class TestingConnector extends AbstractConnector {
+    /**
+     * @inheritDoc
+     */
+    constructor(config) {
+        super(config);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async getConnection() {
+        // TODO simple object just for initial testing
+        const client = {};
+
+        const config = {
+            client,
+            ...(this.config),
+        };
+
+        const connection = new TestingConnection(config);
+
+        return connection;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async releaseConnection(connection) {
+        // await connection.client.release();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    async closeConnection() {
+        // await this.pool.end();
+    }
+}
+
+module.exports = TestingConnector;