closes #79 and addes uuid document id's by default

Author: sevenbitbyte

examples/test-local-lokidb.js

@@ -3,7 +3,6 @@ const debug = require('debug')('example.loki-db')
 const BouncerModel = require('@dataparty/bouncer-model/dist/bouncer-model.json')
 const Dataparty = require('../src/index.js')
 
-
 let local=null
 
 async function getUser(name) {
@@ -18,6 +17,7 @@ async function main(){
   const dbPath = (await fs.mkdtemp('/tmp/loki-party')) + '/loki.db'
 
   debug('db location', dbPath)
+  console.log(dbPath)
 
   local = new Dataparty.LokiParty({
     path: dbPath,
@@ -32,31 +32,40 @@ async function main(){
 
 
   if(!user){
-    debug('creating document')
+    console.log('creating document')
     user = await local.createDocument('user', {name: 'tester', created: (new Date()).toISOString() })
   }
   else{
-    debug('loaded document')
+    console.log('loaded document')
   }
 
   console.log(user.data)
+  console.log('hash',user.hash)
 
-  user.on('update', (obj)=>{ console.log('update') })
-  user.on('value', (obj)=>{ console.log('value') })
+  user.on('update', (obj)=>{ console.log('event [document.on(update)]') })
+  user.on('value', (obj)=>{ console.log('event [document.on(value)]') })
+  user.on('remove', (obj)=>{ console.log('event [document.on(remove)]') })
 
+  console.log('\nchanging document field')
   user.data.name = 'renamed-tester'
   await user.save()
 
   console.log(user.data)
+  console.log('hash',user.hash)
 
+  console.log('find document by new field value')
   let userFind = await getUser('renamed-tester')
 
   console.log(userFind.data)
+  console.log('hash',userFind.hash)
 
+  console.log('\nchanging document field')
+  userFind.data.name = 'renamed-tester'
+  await userFind.save()
 
-  console.log(dbPath)
-
+  
 
+  console.log('delete document')
   await userFind.remove()
 
 

examples/test-local-tingodb.js

@@ -31,32 +31,44 @@ async function main(){
 
 
   if(!user){
-    debug('creating document')
+    console.log('creating document')
     user = await local.createDocument('user', {name: 'tester', created: (new Date()).toISOString() })
   }
   else{
-    debug('loaded document')
+    console.log('loaded document')
   }
 
-  console.log('before', user.data)
+  console.log(user.data)
+  console.log('hash',user.hash)
 
+  user.on('update', (obj)=>{ console.log('event [document.on(update)]') })
+  user.on('value', (obj)=>{ console.log('event [document.on(value)]') })
+  user.on('remove', (obj)=>{ console.log('event [document.on(remove)]') })
+
+  console.log('\nchanging document field')
   user.data.name = 'renamed-tester'
-  //user.data.invalideField = true
   await user.save()
 
-  console.log('after', user.data)
+  console.log(user.data)
+  console.log('hash',user.hash)
 
+  console.log('find document by new field value')
   let userFind = await getUser('renamed-tester')
 
   console.log(userFind.data)
+  console.log('hash',userFind.hash)
+
+  console.log('\nchanging document field')
+  userFind.data.name = 'renamed-tester'
+  await userFind.save()
 
-  process.exit()
+  
 
+  console.log('delete document')
+  await userFind.remove()
 
-  await user.remove()
 
   console.log(await getUser('renamed-tester'))
-
 }
 
 

package.json

@@ -91,6 +91,7 @@
     "multer": "^1.4.5-lts.1",
     "nconf": "^0.10.0",
     "node-mocks-http": "^1.12.1",
+    "node-object-hash": "^3.0.0",
     "node-persist": "^3.0.1",
     "origin-router": "^1.6.4",
     "parse-url": "^5.0.1",

src/bouncer/db/loki-db.js

@@ -6,6 +6,7 @@ const Loki = require('lokijs')
 const LokiFS = Loki.LokiFsAdapter
 const LFSA = require('lokijs/src/loki-fs-structured-adapter')
 const ObjectId = require('bson-objectid')
+const uuidv4 = require('uuid/v4')
 
 const MongoQuery = require('../mongo-query')
 const { promisfy } = require('promisfy')
@@ -26,14 +27,15 @@ const debug = require('debug')('bouncer.db.loki-db')
  */
 module.exports = class LokiDb extends IDb {
 
-  constructor ({path, factory, dbAdapter, lokiOptions}) {
+  constructor ({path, factory, dbAdapter, lokiOptions, useUuid}) {
     super(factory)
     debug('constructor')
     this.loki = null
     this.lokiOptions = lokiOptions
     this.path = path
     this.dbAdapter = dbAdapter || new LFSA()
     this.error = null
+    this.useUuid = (useUuid==undefined) ? true : useUuid
   }
 
   static get LokiLocalStorageAdapter(){
@@ -142,7 +144,13 @@ module.exports = class LokiDb extends IDb {
   ensureId(obj){
     let temp = {...obj}
     if(!reach(temp,'$meta.id')){
-      temp.$meta.id = (new ObjectId()).toHexString()
+
+      if(this.useUuid){
+        temp.$meta.id = uuidv4()
+      }
+      else{
+        temp.$meta.id = (new ObjectId()).toHexString()
+      }
     }
 
     let dbDoc = this.documentFromObject(temp)
@@ -232,7 +240,19 @@ module.exports = class LokiDb extends IDb {
 
     for(let obj of docs){
       let temp = {...obj}
-      if(temp._id===undefined){ temp._id = (new ObjectId()).toString(); temp.$meta.id=temp._id;  }
+      if(temp._id===undefined){
+
+        if(this.useUuid){
+          temp._id = uuidv4()
+        }
+        else{
+          temp._id = (new ObjectId()).toHexString()
+        }
+
+        temp.$meta.id=temp._id;
+      }
+
+      
 
       let dbDoc = this.documentFromObject(temp)
 
@@ -311,15 +331,16 @@ module.exports = class LokiDb extends IDb {
 
     const dbDoc = collection.findAndRemove( { '$meta.id': obj.$meta.id } )
 
-    debug('dbDoc', dbDoc)
-
-    let finalObj = this.documentToObject(dbDoc)
+    let finalObj = {
+      $meta: obj.$meta
+    }
 
     finalObj.$meta.removed = true
 
     this.emitChange(finalObj, 'remove')
 
-    debug('obj', finalObj)
+    debug('finalObj', finalObj)
+    debug('obj', obj)
 
     await promisfy(this.loki.saveDatabase.bind(this.loki))
     return finalObj

src/bouncer/db/tingo-db.js

@@ -3,10 +3,10 @@
 
 const IDb = require('../idb')
 const Hoek = require('@hapi/hoek')
+const uuidv4 = require('uuid/v4')
 
 const {promisfy} = require('promisfy')
 
-
 const debug = require('debug')('bouncer.db.tingo-db')
 
 
@@ -20,13 +20,14 @@ const debug = require('debug')('bouncer.db.tingo-db')
  */
 module.exports = class TingoDb extends IDb {
 
-  constructor ({path, factory, tingoOptions, prefix}) {
+  constructor ({path, factory, tingoOptions, prefix, useUuid}) {
     super(factory, prefix)
     debug('constructor path=',path, tingoOptions)
     this.tingo = null
     this.path = path
     this.tingoOptions = tingoOptions || {nativeObjectID: true}
     this.error = null
+    this.useUuid = (useUuid==undefined) ? true : useUuid
   }
 
 
@@ -92,7 +93,13 @@ module.exports = class TingoDb extends IDb {
   ensureId(obj){
     let temp = {...obj}
     if(!reach(temp,'$meta.id')){
-      temp.$meta.id = new this.tingo.ObjectID().valueOf()
+      
+      if(this.useUuid){
+        temp.$meta.id = uuidv4()
+      }
+      else{
+        temp.$meta.id = new this.tingo.ObjectID().valueOf()
+      }
     }
 
     let dbDoc = this.documentFromObject(temp)
@@ -196,7 +203,17 @@ module.exports = class TingoDb extends IDb {
 
     for(let obj of docs){
       let temp = {...obj}
-      if(temp._id===undefined){ temp._id = (new this.tingo.ObjectID()).toString(); temp.$meta.id=temp._id;  }
+      if(temp._id===undefined){
+        
+        if(this.useUuid){
+          temp._id = uuidv4()
+        }
+        else{
+          temp._id = (new this.tingo.ObjectID()).toString();
+        }
+      
+        temp.$meta.id=temp._id;
+      }
 
       let dbDoc = this.documentFromObject(temp)
 

src/bouncer/db/zango-db.js

@@ -5,6 +5,7 @@ const Hoek = require('@hapi/hoek')
 const zango = require('zangodb')
 const reach = require('../../utils/reach')
 const ObjectId = require('bson-objectid')
+const uuidv4 = require('uuid/v4')
 
 const MongoQuery = require('../mongo-query')
 const { promisfy } = require('promisfy')
@@ -20,12 +21,13 @@ const debug = require('debug')('bouncer.db.zango-db')
 */
 module.exports = class ZangoDb extends IDb {
 
-  constructor ({dbname, factory}) {
+  constructor ({dbname, factory, useUuid}) {
     super(factory)
     debug('constructor')
     this.zango = null
     this.dbname = dbname
     this.error = null
+    this.useUuid = (useUuid==undefined) ? true : useUuid
   }
 
 
@@ -105,7 +107,13 @@ module.exports = class ZangoDb extends IDb {
   ensureId(obj){
     let temp = {...obj}
     if(!reach(temp,'$meta.id')){
-      temp.$meta.id = (new ObjectId()).toHexString()
+
+      if(this.useUuid){
+        temp.$meta.id = uuidv4()
+      }
+      else{
+        temp.$meta.id = (new ObjectId()).toHexString()
+      }
     }
 
     let dbDoc = this.documentFromObject(temp)

src/party/idocument.js

@@ -3,6 +3,7 @@
 const reach = require('../utils/reach')
 const debug = require('debug')('dataparty.idocument')
 const EventEmitter = require('eventemitter3')
+const objectHasher = require('node-object-hash').hasher()
 
 class IDocument extends EventEmitter {
 
@@ -116,6 +117,15 @@ class IDocument extends EventEmitter {
     return obj
   }
 
+  /**
+   * hash of `document.data` using sha256
+   * @member module:Party.IDocument.hash
+   * @type {object}
+   */
+  get hash(){
+    return objectHasher.hash(this.data)
+  }
+
   /**
    * @async
    * Merge fields into document
@@ -193,7 +203,9 @@ class IDocument extends EventEmitter {
    * 
    */
   async remove(){
-    debug('removing document ', this.data.type, this.data.id)
+    debug('removing document ', this.type, this.id)
+
+    //this.emit('remove', this)
 
     return this.party.remove(this.data)
   }

src/party/loki-cache.js

@@ -32,6 +32,7 @@ module.exports = class LokiCache extends EventEmitter {
   }
 
   remove(type, id){
+    console('cache remove')
     debug('remove', type, id)
     var collection = this.db.getCollection(type)
 
@@ -51,6 +52,10 @@ module.exports = class LokiCache extends EventEmitter {
         debug('remove CATCH -', exception)
         collection.findAndRemove({'$meta.id': id})
       }
+
+      debug('remove found', found)
+
+      this._emitChange(found, 'remove')
     }
 
     var item = this.findById(type, id)
@@ -115,9 +120,11 @@ module.exports = class LokiCache extends EventEmitter {
             catch(err){
               debug('WARN', err)
             }
-            this._emitChange(msg, 'remove')
           }
 
+          debug('emit remove', msg)
+          this._emitChange(msg, 'remove')
+
         // otherwise insert new message (remove old message if it exists)
         } else {