[feature] mongo findOneAndUpdate & count

Author: 高鸣飞

.travis.yml

@@ -9,3 +9,9 @@ services:
   - redis
 after_success: 
   - nyc report --reporter=text-lcov | coveralls
+deploy:
+  provider: npm
+  email: [email protected]
+  api_key: 438c9fe0-e2d6-4e7e-8559-ad7c8eed53a2
+  on:
+    branch: master

README.md

@@ -92,18 +92,21 @@ database driver with extended features.
 ## feature list
 * changelog/oplog
 * auto release timeout connection
+* read-write access control
 
 ## api support
 
-|  Method  | MySQL  | MongoDB | Redis |
-| :------- |:------:| :------:| :----:|
-| select   |   √    |    √    |   √   |
-| selectEx |   √    |    ×    |   ×   |
-| insert   |   √    |    √    |   √   |
-| update   |   √    |    √    |   √   |
-| delete   |   √    |    √    |   √   |
-| find     |   ×    |    √    |   ×   |
-| aggregate|   ×    |    √    |   ×   |
+|     Method      | MySQL  | MongoDB | Redis |
+| :-------        |:------:| :------:| :----:|
+| select          |   √    |    √    |   √   |
+| selectEx        |   √    |    ×    |   ×   |
+| insert          |   √    |    √    |   √   |
+| update          |   √    |    √    |   √   |
+| delete          |   √    |    √    |   √   |
+| find            |   ×    |    √    |   ×   |
+| aggregate       |   ×    |    √    |   ×   |
+| count           |   ×    |    √    |   ×   |
+| findOneAndUpdate|   ×    |    √    |   ×   |
 
 ## interface
 
@@ -285,14 +288,14 @@ conn.delete(
   function(err, rows, info) {
   })
 
-conn.find(        // mongodb only
+conn.find(              // mongodb only
   /* table */ 'table5',
   /* opt   */ {fields: ['field1'], skip: 10, sort: 'field1'},
   /* where */ {field1: 10},
   function(err, rows, info) {
   })
 
-conn.aggregate(   // mongodb only
+conn.aggregate(         // mongodb only
   /* table */ 'table5',
   /* opt   */ {skip: 10, sort: 'name'},
   /* pipe  */ [
@@ -302,6 +305,21 @@ conn.aggregate(   // mongodb only
   function(err, rows, info) {
   })
 
+conn.count(         // mongodb only
+  /* table */ 'table5',
+  /* opt   */ {skip: 10, limit: 50},
+  /* where */ {field1: 10},
+  function(err, rows, info) {
+  })
+
+conn.findOneAndUpdate(   // mongodb only
+  /* table */ 'table5',
+  /* sets  */ {field1: 20},
+  /* where */ {field1: 10},
+  function(err, rows, info) {
+  })
+
+
 // Promise/async/await
 let result
 try {

lib/$/index.js

@@ -10,6 +10,8 @@ ALL_METHODS: [
   'selectEx',
   'find',
   'aggregate',
+  'count',
+  'findOneAndUpdate',
 ],
 
 util: require('util'),

lib/define/mongodb.js

@@ -44,8 +44,10 @@ __destroy() {
  * @param {function} callback 
  */
 insert(table, sets, callback) {
-  if (sets.constructor !== Object && sets.constructor !== Array) {
-    return callback(new Error('invalid sets'))
+  try {
+    checkParams({table, sets, callback})
+  } catch (err) {
+    return callback(err)
   }
   if (this._readonly) {
     return errNotAllowd(callback)
@@ -65,8 +67,10 @@ insert(table, sets, callback) {
 }
 
 update(table, sets, where, callback) {
-  if (sets.constructor !== Object && sets.constructor !== Array) {
-    return callback(new Error('invalid sets'))
+  try {
+    checkParams({table, sets, where, callback})
+  } catch (err) {
+    return callback(err)
   }
   if (this._readonly) {
     return errNotAllowd(callback)
@@ -91,6 +95,11 @@ update(table, sets, where, callback) {
  * @param {function} callback
  */
 delete(table, where, callback) {
+  try {
+    checkParams({table, where, callback})
+  } catch (err) {
+    return callback(err)
+  }
   if (this._readonly) {
     return errNotAllowd(callback)
   }
@@ -113,11 +122,13 @@ delete(table, where, callback) {
  * @param {function} callback 
  */
 select(table, fields, where, callback) {
+  try {
+    checkParams({table, fields, where, callback})
+  } catch (err) {
+    return callback(err)
+  }
   let _fields = fields === '*' ? {} : fields
   this._conn.collection(table).find(where, _fields, (err, docs) => {
-    if (err) {
-      return callback(err)
-    }
     return callback(err, docs, null)
   })
 }
@@ -132,14 +143,35 @@ select(table, fields, where, callback) {
  * @param {function} callback 
  */
 find(table, options, where, callback) {
+  try {
+    checkParams({table, options, where, callback})
+  } catch (err) {
+    return callback(err)
+  }
   this._conn.collection(table).find(where, options, (err, docs) => {
-    if (err) {
-      return callback(err)
-    }
     return callback(err, docs, null)
   })
 }
 
+/**
+ * 
+ * @param {stinrg} table 
+ * @param {object} sets 
+ * @param {object} where 
+ * @param {function} callback 
+ */
+findOneAndUpdate(table, sets, where, callback) {
+  try {
+    checkParams({table, sets, where, callback})
+  } catch (err) {
+    return callback(err)
+  }
+  this._conn.collection(table).findOneAndUpdate(where, sets, 
+    (err, updated_doc) => {
+      return callback(err, updated_doc, null)
+  })
+}
+
 /**
  * Mongodb.close()
  */
@@ -156,20 +188,43 @@ release() {
  * @param {function} callback 
  */
 aggregate(table, options, pipeline, callback) {
+  try {
+    checkParams({table, options, pipeline, callback})
+  } catch (err) {
+    return callback(err)
+  }
   this._conn.collection(table).aggregate(pipeline, options, (err, docs) => {
-    if (err) {
-      return callback(err)
-    }
     return callback(err, docs, null)
   })
 }
 
+/**
+ * Mongodb.count()
+ * 
+ * @param {string} table
+ * @param {object} options
+ * @param {object} where
+ * @param {function} callback
+ */
+count(table, options, where, callback) {
+  try {
+    checkParams({table, options, where, callback})
+  } catch (err) {
+    return callback(err)
+  }
+  this._conn.collection(table).count(where, options, (err, count) => {
+    return callback(err, count, null)
+  })
+}
+
+
 }
 
 const _ = require('lodash')
 const util = require('util')
 const debug = require('debug')('sqlx')
 const monk = require('monk')
+
 function __log() {
   debug(util.format.apply(null, arguments))
 }
@@ -184,3 +239,39 @@ function errNotAllowd(callback) {
   return callback(new Error('not allowed'))
 }
 
+// ------ validator -----
+const Ajv = require('ajv')
+const validator = (new Ajv()).compile({
+  type: 'object',
+  properties: {
+    table: {type: 'string'},
+    options: {type: 'object'},
+    pipeline: {type: 'array'},
+    where: {type: ['object', 'string']},
+    sets: {type: ['object', 'array']},
+    fields: {type: ['array', 'string']}
+  },
+  required: ['table'],
+})
+/**
+ * 
+ * @param {object}          params 
+ * @param {string}          params.table
+ * @param {string|Array}    params.fileds
+ * @param {object|Array}    params.sets
+ * @param {object}          params.where
+ * @param {object}          params.options
+ * @param {function}        params.callback
+ */
+function checkParams(params) {
+  for (let key of _.keys(params)) {
+    if (util.isNullOrUndefined(params[key])) {
+      throw new Error(`Missing parameter: ${key}`)
+    }
+  }
+  if (!validator(params)) {
+    throw new Error(validator.errors.map(err => {
+      return err.dataPath + ' ' + err.message
+    }))
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqlx",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Database driver with extended features like mysql changelog/oplog, connection auto release.",
   "main": "index.js",
   "directories": {
@@ -28,6 +28,7 @@
   },
   "homepage": "https://github.com/yinrong/node-sqlx#readme",
   "dependencies": {
+    "ajv": "^6.1.1",
     "async": "^2.0.1",
     "debug": "^2.2.0",
     "lodash": "^4.17.4",
@@ -57,5 +58,8 @@
       "text-summary"
     ],
     "all": true
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

test/mongodb.js

@@ -60,6 +60,22 @@ it('insert', done => {
   ], err => {throw err})
 })
 
+it('count', done => {
+  const client = sqlx.createClient()
+  client.define('*', DBCONFIG_RW)
+  const conn = client.getConnection(OPCONFIG)
+  async.waterfall([
+  (next) => {
+    conn.count('table1', {
+      limit: 1,
+    }, {title: {$regex: /test/}}, next)
+  },
+  (rows, info, next) => {
+    done()
+  }
+  ], err => {throw err})
+})
+
 it('find', done => {
   const client = sqlx.createClient()
   client.define('*', DBCONFIG_RW)
@@ -79,6 +95,21 @@ it('find', done => {
   ], err => {throw err})
 })
 
+it('findOneAndUpdate', done => {
+  const client = sqlx.createClient()
+  client.define('*', DBCONFIG_RW)
+  const conn = client.getConnection(OPCONFIG)
+  async.waterfall([
+  (next) => {
+    conn.findOneAndUpdate('table1', {title: 'test3'}, {title: 'test2'}, next)
+  },
+  (rows, info, next) => {
+    assert.equal(rows.title, 'test3')
+    done()
+  }
+  ], err => {throw err})
+})
+
 it('aggregate', done => {
   const client = sqlx.createClient()
   client.define('*', DBCONFIG_RW)
@@ -174,13 +205,13 @@ it('error-authority', done => {
   },
   (next) => {
     conn.insert('table1', 'error insert', err => {
-      assert(err.message.match(/invalid sets/))
+      assert(err.message.match(/sets should be object,array/))
       next()
     })
   },
   (next) => {
     conn.update('table1', 'error update', {}, err => {
-      assert(err.message.match(/invalid sets/))
+      assert(err.message.match(/sets should be object,array/))
       next()
     })
   },
@@ -196,6 +227,12 @@ it('error-operations', done => {
   client.define('*', DBCONFIG_RW)
   const conn = client.getConnection(OPCONFIG)
   async.waterfall([
+  (next) => {
+    conn.insert('error', undefined, err => {
+      assert(err.message.match(/Missing/))
+      next()
+    })
+  },
   // insert with wrong 'sets'
   (next) => {
     conn.insert('error', [0], err => {
@@ -234,6 +271,18 @@ it('error-operations', done => {
   // aggregate with wrong 'options' and 'pipeline'
   (next) => {
     conn.aggregate('error', [0], [0], err => {
+      assert(err)
+      next()
+    })
+  },
+  (next) => {
+    conn.count('error', [0], [0], err => {
+      assert(err)
+      next()
+    })
+  },
+  (next) => {
+    conn.findOneAndUpdate('error', [0], [0], err => {
       assert(err)
       done()
     })