[feature] support Promise/async/await (resolve #26)

Author: Bingmang

.travis.yml

@@ -0,0 +1,11 @@
+language: node_js
+node_js:
+  - "7"
+  - "8"
+  - "9"
+services:
+  - mysql
+  - mongodb
+  - redis
+after_success: 
+  - nyc report --reporter=text-lcov | coveralls

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2015-2018] [Rong Yin]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,13 @@
+# SQLX
+
+> Database driver with extended features like mysql changelog/oplog, connection auto release.
+
+[![NPM version][npm-image]][npm-url]
+[![Build status][travis-image]][travis-url]
+[![Coverage Status][coveralls-image]][coveralls-url]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
@@ -59,11 +69,22 @@ var operator_info = {
 }
 const conn = client.getConnection(operator_info)
 
+// callback
 conn.insert('table7', {a:1, b:2}, function(err, rows, info) {
   if (err) throw err
   console.log(rows, info)
 })
 
+// Promise/async/await
+let result
+try {
+  result = await conn.insert('table7', {a:1, b:2})
+  console.log(result.rows)  // rows
+  console.log(result.info)  // info
+} catch (err) {
+  throw err
+}
+
 ```
 
 ### action whitelist: operator_info.actions
@@ -157,6 +178,7 @@ const InterfaceTwo = {
 
 ### method
 ```javascript
+// callback
 conn.selectEx(
   /* table */ 'table0',
   /* custom sql */ 'select ... join ...where field1 = ? and field2 = ?',
@@ -196,6 +218,19 @@ conn.delete(
   /* where */ {field1: 10},
   function(err, rows, info) {
   })
+
+// Promise/async/await
+let result
+try {
+  result = await conn.insert(
+    /* table */ 'table0',
+    /* set   */ {field1: 20})
+  console.log(result.rows)  // rows
+  console.log(result.info)  // info
+} catch (err) {
+  throw err
+}
+// other functions also works.
 ```
 
 
@@ -239,3 +274,15 @@ cd node-sqlx
 npm i
 npm test
 ```
+
+
+[npm-image]: https://img.shields.io/npm/v/sqlx.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/sqlx
+[travis-image]: https://img.shields.io/travis/yinrong/node-sqlx/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/yinrong/node-sqlx
+[license-image]: http://img.shields.io/npm/l/sqlx.svg?style=flat-square
+[license-url]: LICENSE
+[downloads-image]: http://img.shields.io/npm/dm/sqlx.svg?style=flat-square
+[downloads-url]: https://npmjs.org/package/sqlx
+[coveralls-image]: https://img.shields.io/coveralls/github/yinrong/node-sqlx/master.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/github/yinrong/node-sqlx

lib/$/index.js

@@ -14,4 +14,6 @@ util: require('util'),
 
 _: require('lodash'),
 
+thenifyApi: require('./thenifyApi')
+
 }

lib/$/thenifyApi.js

@@ -0,0 +1,49 @@
+/**
+ * Convert the API to support Promise
+ */
+module.exports = (source, methods) => {
+  let thenify_api = {}
+  methods.forEach((name) => {
+    // promisify only if it's a function
+    if (typeof source[name] === 'function') {
+      thenify_api[name] = thenify(source[name])
+    }
+  })
+  return thenify_api
+}
+
+/**
+ * Turn async functions into promises and backward compatible with callback
+ *
+ * @param {Function} __fn__
+ * @return {Function}
+ */
+
+function thenify(__fn__) {
+  return function (...args) {
+    let self = this
+    // callback was assigned
+    if (typeof args[args.length - 1] === 'function') {
+      return __fn__.apply(self, args)
+    }
+    // no callback, return Promise
+    return new Promise((resolve, reject) => {
+      let args_with_callback = args
+      args_with_callback.push(createCallback(resolve, reject))
+      __fn__.apply(self, args_with_callback)
+    })
+  }
+}
+
+function createCallback(resolve, reject) {
+  return function (err, ...values) {
+    if (err) {
+      return reject(err)
+    }
+    let result = {
+      rows: values[0],
+      info: values[1],
+    }
+    resolve(result)
+  }
+}

lib/Connection.js

@@ -99,6 +99,9 @@ Connection.prototype.release = function() {
   return
 }
 
+// support Promise/async/await and callback
+Connection.prototype = $.thenifyApi(Connection.prototype, $.ALL_METHODS)
+
 var local = {}
 
 local.assureNoUndefined = (obj) => {

package.json

@@ -1,13 +1,13 @@
 {
   "name": "sqlx",
-  "version": "3.0.2",
-  "description": "database driver with extended features like mysql changelog/oplog, connection auto release.",
+  "version": "4.0.0",
+  "description": "Database driver with extended features like mysql changelog/oplog, connection auto release.",
   "main": "index.js",
   "directories": {
     "test": "test"
   },
   "scripts": {
-    "test": "istanbul cover --dir .cov _mocha test; echo .cov/lcov-report/index.html"
+    "test": "nyc ./node_modules/.bin/_mocha; echo .cov/index.html"
   },
   "repository": {
     "type": "git",
@@ -35,6 +35,26 @@
     "redis": "^2.8.0"
   },
   "devDependencies": {
-    "lodash": "^4.15.0"
+    "coveralls": "^3.0.0",
+    "lodash": "^4.15.0",
+    "mocha": "^3.5.3",
+    "nyc": "^11.4.1"
+  },
+  "nyc": {
+    "check-coverage": true,
+    "report-dir": "./.cov",
+    "include": [
+      "$/*.js",
+      "lib/*.js",
+      "lib/**/*.js"
+    ],
+    "extension": [
+      ".js"
+    ],
+    "reporter": [
+      "html",
+      "text-summary"
+    ],
+    "all": true
   }
 }

test/mysql.js

@@ -165,6 +165,7 @@ it('where in delete', function(done) {
   })
 })
 
+
 it('release', (done) => {
   const client = sqlx.createClient()
   client.define('*', MYSQL_CONFIG_1)

test/thenifyApi.js

@@ -0,0 +1,91 @@
+describe('sqlx-promise', function() {
+
+it('mysql async/await', async () => {
+  child_process.execSync('mysql -uroot < test/mysql_initdb.txt')
+  const client = sqlx.createClient()
+  client.define('*', MYSQL_CONFIG_1)
+
+  const conn = client.getConnection(OPERATER_INFO)
+  let result
+  // insert
+  await conn.insert(
+    'table1',
+    [
+      {a:1, b:21},
+      {a:2, b:22},
+      {a:3, b:23},
+      {a:3, b:123},
+    ])
+  // select
+  result = await conn.select('table1', '*', { $and: { a: 3, b: 123 } })
+  assert.equal(result.rows.length, 1)
+  // update
+  result = await conn.update('table1', {b:1}, {a:3})
+  assert.equal(result.rows.affected_rows, 2)
+  assert.equal(result.rows.changed_rows, 2)
+  // selectEx
+  result = await conn.selectEx('table1', 'select * from table1 where a = ?', [2])
+  assert.equal(result.rows.length, 1)
+  assert.equal(result.rows[0].b, 22)
+  // delete
+  result = await conn.delete('table1', {a:3})
+  assert.equal(result.rows.affected_rows, 2)
+  conn.release()
+})
+
+it('redis async/await', async () => {
+  const client = sqlx.createClient()
+  client.define('budget', {type: 'redis', config: REDIS_CONIFG})
+
+  const conn = client.getConnection(OPERATER_INFO)
+  let result
+  // insert
+  result = await conn.insert('budget', {key1: 'value1'})
+  assert.equal(result.rows, 'OK')
+  // select
+  result = await conn.select('budget', '*', {key1: 1})
+  assert.equal(result.rows, 'value1')
+  // update
+  result = await conn.update('budget', {key1: 'value2'}, {key1: 1})
+  assert.equal(result.rows, 'OK')
+  result = await conn.select('budget', '*', {key1: 1})
+  assert.equal(result.rows, 'value2')
+  // delete
+  result = await conn.delete('budget', {key1: 1})
+  assert.equal(result.rows, 1)
+  result = await conn.select('budget', '*', {key1: 1})
+  assert.equal(result.rows, null)
+  conn.release()
+})
+})
+
+
+const assert = require('assert')
+const async = require('async')
+const sqlx = require('..')
+const child_process = require('child_process')
+const _ = require('lodash')
+
+// mysql
+const MYSQL_CONFIG_1 = {
+  type: 'mysql',
+  config: {
+    connectionLimit: 1,
+    host: '127.0.0.1',
+    user: 'root',
+    password: '',
+    //debug: ['ComQueryPacket'],
+    database: 'sqlx_mysql',
+  } }
+
+// redis
+const REDIS_CONIFG = {
+  host: '127.0.0.1',
+  port: '6379',
+}
+
+// sqlx operater
+const OPERATER_INFO = {
+  user: '101,23',
+  actions: '*',
+}