multi-db-orm 1.0.7 → 1.2.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,21 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: NPM Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - run: npm install
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,6 +1,8 @@
 # multi-db-orm
 ORM for multiple SQL and NoSQL databases like firestore , MongoDB , SQlite with Sync ,  Backup and Restore support .
 
+[![NPM Publish](https://github.com/shiveshnavin/multi-db-orm/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/shiveshnavin/multi-db-orm/actions/workflows/npm-publish.yml)
+
 ## 1. Object Relational Mapping
 
 Supported databases:
@@ -189,6 +191,6 @@ Working on enhancing the tool with below features in progress. Feel free to cont
 
 - [ ] Add Backup support for other databases
 - [ ] Add Restore support for other databases
-- [ ] Range Operations like `>=` `<=` 
+- [X] Range Operations like `>=` `<=` 
 - [ ] Aggregations
 - [ ] InsertMany

package/engines/firestoredb.js

@@ -1,6 +1,20 @@
 const { model } = require("mongoose");
 const { MultiDbORM } = require("./multidb");
 
+function removeUndefined(obj) {
+    try {
+
+        Object.keys(obj).forEach(function (key) {
+            if (typeof obj[key] === 'undefined') {
+                delete obj[key];
+            }
+        });
+        return obj
+    } catch (e) {
+        console.log('Error in sanitizing update of object ! ', e.message)
+    }
+}
+
 class FireStoreDB extends MultiDbORM {
 
     admin
@@ -77,7 +91,10 @@ class FireStoreDB extends MultiDbORM {
         var snapshot = await this._get(modelname, filter, options)
         if (snapshot == undefined)
             return []
+        this.metrics.get(modelname, filter, options)
+        let that = this;
         snapshot.forEach(doc => {
+            that.metrics.getOne(modelname, filter, options);
             result.push(doc.data())
         });
         if (this.loglevel > 2)
@@ -90,7 +107,7 @@ class FireStoreDB extends MultiDbORM {
     async getOne(modelname, filter, id, options) {
         var idx = id || filter.id
         if (idx) {
-
+            this.metrics.getOne(modelname, filter, options);
             const modelref = this.getdb().collection(modelname).doc(idx);
             const doc = await modelref.get();
             if (this.loglevel > 2)
@@ -113,17 +130,21 @@ class FireStoreDB extends MultiDbORM {
 
     async create(modelname, sampleObject) {
         this.sync.create(modelname, sampleObject)
+        this.metrics.create(modelname, sampleObject);
+
         if (this.loglevel > 3)
             console.log('CREATE : Not required in DB Type', this.dbType)
     }
 
     async insert(modelname, object, id) {
         this.sync.insert(modelname, object, id)
+        this.metrics.insert(modelname, object, id)
 
         var db = this.getdb();
         var idx = id || object.id || Date.now()
         const docref = db.collection(modelname).doc("" + idx);
         try {
+            removeUndefined(object)
             return await docref.set(object);
         } catch (e) {
 
@@ -145,20 +166,24 @@ class FireStoreDB extends MultiDbORM {
 
 
         try {
+            removeUndefined(object)
             if (idx) {
-
+                this.metrics.update(modelname, filter, object, id)
                 await this.getdb().collection(modelname).doc(idx).update(object);
 
             } else {
                 var snaps = await this._get(modelname, filter)
+                let that = this;
                 snaps.forEach(async function (element) {
+                    that.metrics.getOne(modelname, filter, id)
+                    that.metrics.update(modelname, filter, object, id)
                     await element.ref.update(object)
                 });
             }
         } catch (e) {
 
             if (e.message.indexOf("Firestore doesn't support JavaScript objects with custom prototypes") > -1) {
-                return await update(modelname, filter, JSON.parse(JSON.stringify(object)), id);
+                return await this.update(modelname, filter, JSON.parse(JSON.stringify(object)), id);
             }
             else {
                 throw e;
@@ -174,12 +199,15 @@ class FireStoreDB extends MultiDbORM {
         var idx = id || filter.id
 
         if (idx) {
-
+            this.metrics.delete(modelname, filter, id)
             await this.getdb().collection(modelname).doc(idx).delete();
 
         } else {
             var snaps = await this._get(modelname, filter)
+            let that = this;
             snaps.forEach(async function (element) {
+                that.metrics.getOne(modelname, filter, id)
+                that.metrics.delete(modelname, filter, id)
                 await element.ref.delete();
             });
         }

package/engines/metrics.js

@@ -0,0 +1,78 @@
+class Metrics {
+
+    loglevel = 1
+    dbstats;
+
+    constructor(loglevel) {
+        this.loglevel = loglevel;
+        this.dbstats = {
+            reads: 0,
+            batchReads: 0,
+            inserts: 0,
+            updates: 0,
+            deletes: 0
+        }
+    }
+
+    printStatus() {
+        console.log(dbstats)
+    }
+
+    reset() {
+        this.dbstats = {
+            reads: 0,
+            batchReads: 0,
+            inserts: 0,
+            updates: 0,
+            deletes: 0
+        }
+    }
+
+    getStatus() {
+        this.dbstats.readsTotal = this.dbstats.reads + this.dbstats.batchReads;
+        return this.dbstats;
+    }
+
+    async get(modelname, filter) {
+        this.dbstats.batchReads++;
+        if (this.loglevel > 4)
+            this.printStatus()
+    }
+
+    async getOne(modelname, filter) {
+        this.dbstats.reads++;
+        if (this.loglevel > 4)
+            this.printStatus()
+    }
+
+    async create(modelname, object) {
+        this.dbstats.inserts++;
+        if (this.loglevel > 4)
+            this.printStatus()
+    }
+
+    async insert(modelname, object) {
+        this.dbstats.inserts++;
+        if (this.loglevel > 4)
+            printStatus()
+    }
+
+    async update(modelname, filter, object) {
+        this.dbstats.updates++;
+        if (this.loglevel > 4)
+            this.printStatus()
+    }
+
+    async delete(modelname, filter) {
+        this.dbstats.deletes++;
+        if (this.loglevel > 4)
+            this.printStatus()
+    }
+
+}
+
+
+
+module.exports = {
+    Metrics
+}

package/engines/mongodb.js

@@ -53,6 +53,7 @@ class MongoDB extends MultiDbORM {
         }
     }
     async get(modelname, filter, options) {
+        this.metrics.get(modelname, filter, options);
         if (options && options.apply && options.apply.ineq) {
             filter[`${options.apply.field}`] = {};
             filter[`${options.apply.field}`][`${this._inq2mongop(options.apply.ineq.op)}`] = options.apply.ineq.value
@@ -98,12 +99,14 @@ class MongoDB extends MultiDbORM {
     }
 
     async getOne(modelname, filter, options) {
+        this.metrics.getOne(modelname, filter, options);
         var snapshot = await this.getdb().collection(modelname).findOne(filter)
         return snapshot;
     }
 
     async create(modelname, sampleObject) {
         this.sync.create(modelname, sampleObject)
+        this.metrics.create(modelname, sampleObject);
 
         if (this.loglevel > 3)
             console.log('CREATE : Not required in DB Type', this.dbType)
@@ -111,6 +114,7 @@ class MongoDB extends MultiDbORM {
 
     async insert(modelname, object) {
         this.sync.insert(modelname, object)
+        this.metrics.insert(modelname, object)
 
         const collref = this.getdb().collection(modelname)
         try {
@@ -125,12 +129,14 @@ class MongoDB extends MultiDbORM {
 
     async update(modelname, filter, object) {
         this.sync.update(modelname, filter, object)
+        this.metrics.update(modelname, filter, object)
         var resp = await this.getdb().collection(modelname).updateMany(filter, { $set: object })
         return resp;
     }
 
     async delete(modelname, filter) {
         this.sync.delete(modelname, filter)
+        this.metrics.delete(modelname, filter)
         var resp = await this.getdb().collection(modelname).deleteMany(filter)
         return resp;
     }

package/engines/multidb.js

@@ -1,4 +1,5 @@
 const {Sync} = require('../sync')
+const { Metrics } = require('./metrics')
 class MultiDbORM {
 
     db
@@ -7,10 +8,12 @@ class MultiDbORM {
     lastQLatency
     loglevel = 0
     sync
+    metrics
 
     constructor(db) {
         this.db = db
         this.sync = new Sync()
+        this.metrics = new Metrics(this.loglevel)
     }
 
     setdb(db) {

package/engines/sqlitedb.js

@@ -45,6 +45,7 @@ class SQLiteDB extends MultiDbORM {
     }
 
     async get(modelname, filter, options) {
+        this.metrics.get(modelname, filter, options)
         var where = ''
         for (var key in filter) {
             where = where + `${key} = '${filter[key]}' AND `
@@ -62,9 +63,9 @@ class SQLiteDB extends MultiDbORM {
             }
             else if (options.sort) {
                 sort = `ORDER BY`
-                for(let i=0;i<options.sort.length;i++){
+                for (let i = 0; i < options.sort.length; i++) {
                     sort = sort + ` ${options.sort[i].field} ${options.sort[i].order}`;
-                    if(i < options.sort.length - 1){
+                    if (i < options.sort.length - 1) {
                         sort = sort + ' , ';
                     }
 
@@ -76,6 +77,7 @@ class SQLiteDB extends MultiDbORM {
     }
 
     async getOne(modelname, filter) {
+        this.metrics.getOne(modelname, filter)
         var where = ''
         for (var key in filter) {
             where = where + `${key} = '${filter[key]}' AND `
@@ -88,6 +90,7 @@ class SQLiteDB extends MultiDbORM {
 
     async create(modelname, sampleObject) {
         this.sync.create(modelname, sampleObject)
+        this.metrics.create(modelname, sampleObject)
 
         var cols = ''
         for (var key in sampleObject) {
@@ -106,6 +109,7 @@ class SQLiteDB extends MultiDbORM {
 
     async insert(modelname, object) {
         this.sync.insert(modelname, object)
+        this.metrics.insert(modelname, object)
         var cols = ''
         var vals = ''
         for (var key in object) {
@@ -131,6 +135,7 @@ class SQLiteDB extends MultiDbORM {
 
     async update(modelname, filter, object) {
         this.sync.update(modelname, filter, object)
+        this.metrics.update(modelname, filter, object)
 
         var where = ''
         var vals = ''
@@ -149,6 +154,7 @@ class SQLiteDB extends MultiDbORM {
 
     async delete(modelname, filter) {
         this.sync.delete(modelname, filter)
+        this.metrics.delete(modelname, filter)
 
         var where = ''
         for (var key in filter) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-db-orm",
-  "version": "1.0.7",
+  "version": "1.2.0",
   "description": "CRUD , Backup , Restore and Migration library for multiple databases",
   "main": "index.js",
   "dependencies": {

package/test/models.js

@@ -1,10 +1,10 @@
 class Game {
 
-    id
-    timeStamp
-    userid
-    amount
-    type
+    id;
+    timeStamp;
+    userid;
+    amount;
+    type;
 
     constructor(id,timeStamp,userid,amount,type){
         this.id=id

package/test/test.js

@@ -11,6 +11,7 @@ function checkTestsCompleted() {
 
 async function testSqlite() {
     var sqlitedb = new SQLiteDB();
+    console.log(sqlitedb.metrics.getStatus())
     var gm = new Game('IndVSPak', Date.now(), 'Dhoni', 67.33, 'paid')
     sqlitedb.loglevel = 1
     var res = await sqlitedb.create('games', gm);
@@ -49,6 +50,7 @@ async function testSqlite() {
     })
 
     console.log('SQLite DB Tests Successfull')
+    console.log(sqlitedb.metrics.getStatus())
     checkTestsCompleted();
 }
 
@@ -63,6 +65,8 @@ async function testFireStore() {
         return
     }
     var firebasedb = new FireStoreDB(require('../creds.json'));
+    console.log(firebasedb.metrics.getStatus())
+
     var gm = new Game('IndVSPak', Date.now(), 'Dhoni', 67.33, 'free')
     firebasedb.loglevel = 1
     var res = await firebasedb.create('games', gm);
@@ -104,6 +108,8 @@ async function testFireStore() {
     })
 
     console.log('Firestore DB Tests Successfull')
+    console.log(firebasedb.metrics.getStatus())
+
     checkTestsCompleted();
 
 }
@@ -120,6 +126,8 @@ async function testMongo() {
     }
     var crd = require('../creds.json')
     var mongodb = new MongoDB(crd.mongourl, crd.mongodbname);
+    console.log(mongodb.metrics.getStatus())
+
     if (mongodb.db == undefined) {
         await mongodb._connect();
     }
@@ -163,6 +171,8 @@ async function testMongo() {
         })
         await mongodb.delete('games', { type: 'free' })
         console.log('Mongo DB Tests Successfull')
+        console.log(mongodb.metrics.getStatus())
+
 
     } finally {
         mongodb._close();