spice-js 2.5.37 → 2.6.0

package/build/models/SpiceModel.js

@@ -58,8 +58,7 @@ class SpiceModel {
       var Database = require("spice-" + dbtype);
 
       this.type = "";
-      this.collection = args.connection; //console.log("Args --  Type::", args.type);
-
+      this.collection = args.connection;
       this[_args] = args.args;
       this[_external_modifier_loaded] = false;
       this[_disable_lifecycle_events] = ((_args$args = args.args) == null ? void 0 : _args$args.disable_lifecycle_events) || false;
@@ -179,19 +178,6 @@ class SpiceModel {
     } // }
 
   }
-  /* get type() {
-    return this._type;
-  }
-   // Setter for 'type'
-  set type(value) {
-    if (typeof value !== "string") {
-      // example validation
-      throw new Error("Type must be a string.");
-    }
-    this._type = value;
-    //console.log("Type Setted::", value);
-  } */
-
 
   get database() {
     return this[_database];
@@ -446,9 +432,32 @@ class SpiceModel {
     return return_string;
   }
 
-  get(args) {
+  shouldCache(resource_type) {
+    return spice.cache[resource_type] != undefined;
+  }
+
+  getCacheConfig(resource_type) {
+    return spice.cache[resource_type] || {};
+  }
+
+  getCacheProviderObject(resource_type) {
+    return spice.cache_providers[this.getCacheConfig(resource_type).driver || spice.config.cache.default_driver];
+  }
+
+  exists(item_type, key) {
     var _this2 = this;
 
+    return _asyncToGenerator(function* () {
+      var obj = _this2.getCacheProviderObject(item_type);
+
+      if (obj) return yield obj.exists(key);
+      return false;
+    })();
+  }
+
+  get(args) {
+    var _this3 = this;
+
     return _asyncToGenerator(function* () {
       try {
         if (!args) {
@@ -456,23 +465,45 @@ class SpiceModel {
         }
 
         if (_.isString(args.id)) {
-          yield _this2.run_hook(args, "get", "before");
-          var results = yield _this2.database.get(args.id);
+          yield _this3.run_hook(args, "get", "before");
+          var key = _this3.type + "::" + args.id;
+          var results = {};
+
+          if (_this3.shouldCache(_this3.type)) {
+            var cached_results = yield _this3.getCacheProviderObject(_this3.type).get(key);
+
+            if (cached_results) {
+              //calculate time taken to get data from Cache
+              results = cached_results;
+              /* if (this.type == "user") {
+                console.log("results from Cache", results);
+              } */
+            } else {
+              results = yield _this3.database.get(args.id);
+              /* if (this.type == "user") {
+                console.log("results from DB", results);
+              } */
+
+              yield _this3.getCacheProviderObject(_this3.type).set(key, results, _this3.getCacheConfig(_this3.type));
+            }
+          } else {
+            results = yield _this3.database.get(args.id);
+          }
 
           if (results.type != undefined) {
-            if (results.type != _this2.type) throw new Error(_this2.type + " does not exist type");
+            if (results.type != _this3.type) throw new Error(_this3.type + " does not exist type");
           }
 
           if (results._type != undefined) {
-            if (results._type != _this2.type) throw new Error(_this2.type + " does not exist _type");
+            if (results._type != _this3.type) throw new Error(_this3.type + " does not exist _type");
           }
 
           if (results.deleted == undefined || results.deleted == false) {
-            yield _this2.run_hook(results, "get", "after");
-            results = yield _this2.do_serialize(results, "read", {}, args, (yield _this2.propsToBeRemoved(results)));
+            yield _this3.run_hook(results, "get", "after");
+            results = yield _this3.do_serialize(results, "read", {}, args, (yield _this3.propsToBeRemoved(results)));
             return results;
           } else {
-            throw new Error(_this2.type + " does not exist");
+            throw new Error(_this3.type + " does not exist");
           }
         }
       } catch (e) {
@@ -482,11 +513,11 @@ class SpiceModel {
   }
 
   query(query, scope) {
-    var _this3 = this;
+    var _this4 = this;
 
     return _asyncToGenerator(function* () {
       try {
-        var results = yield _this3.database.query(query, scope);
+        var results = yield _this4.database.query(query, scope);
         return results;
       } catch (error) {
         throw error;
@@ -495,7 +526,7 @@ class SpiceModel {
   }
 
   getMulti(args) {
-    var _this4 = this;
+    var _this5 = this;
 
     return _asyncToGenerator(function* () {
       try {
@@ -503,20 +534,34 @@ class SpiceModel {
           args = {};
         }
 
-        yield _this4.run_hook(_this4, "list", "before");
+        yield _this5.run_hook(_this5, "list", "before");
 
         _.remove(args.ids, o => o == undefined);
 
+        var key = _this5.type + "::" + _.join(args.ids, "|");
+
         var results = [];
 
         if (args.ids.length > 0) {
-          results = yield _this4.database.multi_get(args.ids, true);
+          if (_this5.shouldCache(_this5.type)) {
+            var cached_results = yield _this5.getCacheProviderObject(_this5.type).get(key);
+
+            if (cached_results) {
+              results = cached_results;
+            } else {
+              results = yield _this5.database.multi_get(args.ids, true);
+
+              _this5.getCacheProviderObject(_this5.type).set(key, results, _this5.getCacheConfig(_this5.type));
+            }
+          } else {
+            results = yield _this5.database.multi_get(args.ids, true);
+          }
         }
 
-        _.remove(results, o => o.type != _this4.type);
+        _.remove(results, o => o.type != _this5.type);
 
-        yield _this4.run_hook(results, "list", "after", args.context);
-        results = yield _this4.do_serialize(results, "read", {}, args, (yield _this4.propsToBeRemoved(results)));
+        yield _this5.run_hook(results, "list", "after", args.context);
+        results = yield _this5.do_serialize(results, "read", {}, args, (yield _this5.propsToBeRemoved(results)));
         return results;
       } catch (e) {
         console.log(e.stack);
@@ -526,23 +571,23 @@ class SpiceModel {
   }
 
   exist(data) {
-    var _this5 = this;
+    var _this6 = this;
 
     return _asyncToGenerator(function* () {
       try {
         if (_.isString(data)) {
-          var result = yield _this5.database.get(data);
-          if (result.type) if (result.type != _this5.type) {
+          var result = yield _this6.database.get(data);
+          if (result.type) if (result.type != _this6.type) {
             return false;
           }
-          if (result._type) if (result._type != _this5.type) {
+          if (result._type) if (result._type != _this6.type) {
             return false;
           }
         } else {
-          if (data.type) if (data.type != _this5.type) {
+          if (data.type) if (data.type != _this6.type) {
             return false;
           }
-          if (data._type) if (data._type != _this5.type) {
+          if (data._type) if (data._type != _this6.type) {
             return false;
           }
         }
@@ -555,58 +600,52 @@ class SpiceModel {
   }
 
   update(args) {
-    var _this6 = this;
+    var _this7 = this;
 
     return _asyncToGenerator(function* () {
       try {
-        _this6.updated_at = new SDate().now();
-        var results = yield _this6.database.get(args.id);
-        console.log("Results", results);
-        var item_exist = yield _this6.exist(results);
-        console.log("Item Exist", item_exist);
+        _this7.updated_at = new SDate().now();
+        var results = yield _this7.database.get(args.id);
+        var item_exist = yield _this7.exist(results);
 
         if (!item_exist) {
-          throw new Error(_this6.type + " does not exist. in update");
+          throw new Error(_this7.type + " does not exist. in update");
         }
 
         delete results["id"];
 
-        _.defaults(_this6, results);
+        _.defaults(_this7, results);
 
         var cover_obj = {
           old: results,
-          new: _this6,
+          new: _this7,
           id: args.id
         };
 
         if (args.skip_hooks != true) {
-          yield _this6.run_hook(cover_obj, "update", "before", results);
+          yield _this7.run_hook(cover_obj, "update", "before", results);
         }
 
         var form;
 
         if (args.skip_write_serialize != true && args.skip_serialize != true) {
-          form = yield _this6.do_serialize(_this6, "write", cover_obj.new, args);
+          form = yield _this7.do_serialize(_this7, "write", cover_obj.new, args);
         }
 
-        var db_data = form || _this6; //console.log("New Data Inside Update::::", db_data);
-
-        _this6.implementTypeFix(db_data); // console.log("After ITF::::", db_data);
-
-
-        yield _this6.database.update(args.id, db_data); //console.log("Old Data Inside Update::::", results);
+        var db_data = form || _this7;
+        yield _this7.database.update(args.id, db_data);
 
         if (args.skip_hooks != true) {
-          yield _this6.run_hook(_extends({}, _this6, {
+          yield _this7.run_hook(_extends({}, _this7, {
             id: args.id
           }), "update", "after", results);
         }
 
         if (args.skip_read_serialize != true && args.skip_serialize != true) {
-          form = yield _this6.do_serialize(form, "read", {}, args, (yield _this6.propsToBeRemoved(form)));
+          form = yield _this7.do_serialize(form, "read", {}, args, (yield _this7.propsToBeRemoved(form)));
         }
 
-        _this6.id = args.id;
+        _this7.id = args.id;
         return _extends({}, form, {
           id: args.id
         });
@@ -617,48 +656,36 @@ class SpiceModel {
     })();
   }
 
-  implementTypeFix(item) {
-    /* console.log("Type Before Fix", item.type, item._type);
-    let _new_type = item.type || item._type;
-    //item.type = type;
-    console.log("New type", _new_type);
-     item = { ...item, type: _new_type };
-    delete item._type; */
-    //console.log("Type After Fix", item.type, item._type);
-    //if (item._type) delete item["_type"];
-    //console.log("Type After Fix", item.type);
-  }
-
   create(args) {
-    var _this7 = this;
+    var _this8 = this;
 
     return _asyncToGenerator(function* () {
       try {
         var form;
-        _this7.created_at = new SDate().now();
+        _this8.created_at = new SDate().now();
 
         if (args.body) {
           form = _.defaults({}, args.body);
-          form.created_at = _this7.created_at;
-          form.updated_at = _this7.created_at;
+          form.created_at = _this8.created_at;
+          form.updated_at = _this8.created_at;
           delete form["bucket"];
         }
 
-        var workingForm = form || _this7;
-        _this7.updated_at = new SDate().now();
+        var workingForm = form || _this8;
+        _this8.updated_at = new SDate().now();
         var id = args.id_prefix + "-" + UUID.v4();
 
         if (args && args.id) {
           id = args.id;
         }
 
-        yield _this7.run_hook(workingForm, "create", "before");
-        workingForm = _this7.implementTypeFix((yield _this7.do_serialize(workingForm, "write", {}, args)));
-        var results = yield _this7.database.insert(id, workingForm, args.expiry);
-        yield _this7.run_hook(_extends({}, results, {
+        yield _this8.run_hook(workingForm, "create", "before");
+        workingForm = yield _this8.do_serialize(workingForm, "write", {}, args);
+        var results = yield _this8.database.insert(id, workingForm, args.expiry);
+        yield _this8.run_hook(_extends({}, results, {
           id
         }), "create", "after");
-        results = yield _this7.do_serialize(results, "read", {}, args, (yield _this7.propsToBeRemoved(results)));
+        results = yield _this8.do_serialize(results, "read", {}, args, (yield _this8.propsToBeRemoved(results)));
         return _extends({}, results, {
           id
         });
@@ -670,30 +697,30 @@ class SpiceModel {
   }
 
   delete(args) {
-    var _this8 = this;
+    var _this9 = this;
 
     return _asyncToGenerator(function* () {
-      var item_exist = yield _this8.exist(args.id);
+      var item_exist = yield _this9.exist(args.id);
 
       if (!item_exist) {
-        throw new Error(_this8.type + " does not exist.");
+        throw new Error(_this9.type + " does not exist.");
       }
 
-      var results = yield _this8.database.get(args.id);
+      var results = yield _this9.database.get(args.id);
 
       try {
-        yield _this8.run_hook(args, "delete", "before");
+        yield _this9.run_hook(args, "delete", "before");
         var delete_response = {};
 
         if (args.hard) {
-          delete_response = yield _this8.database.delete(args.id);
+          delete_response = yield _this9.database.delete(args.id);
         } else {
           delete results["id"];
           results.deleted = true;
-          delete_response = yield _this8.database.update(args.id, "");
+          delete_response = yield _this9.database.update(args.id, "");
         }
 
-        yield _this8.run_hook(results, "delete", "after", results);
+        yield _this9.run_hook(results, "delete", "after", results);
         return {};
       } catch (e) {
         console.log(e.stack);
@@ -707,7 +734,7 @@ class SpiceModel {
   }
 
   list(args) {
-    var _this9 = this;
+    var _this10 = this;
 
     return _asyncToGenerator(function* () {
       try {
@@ -721,7 +748,7 @@ class SpiceModel {
           query = args.query;
         } else {
           if (args.filters) {
-            query = yield _this9.makeQueryFromFilter(args.filters);
+            query = _this10.makeQueryFromFilter(args.filters);
           } else {
             if (args.query) {
               query = args.query + " AND (deleted = false OR deleted IS MISSING) ";
@@ -743,22 +770,70 @@ class SpiceModel {
           args.sort = "created_at DESC";
         }
 
-        yield _this9.run_hook(_this9, "list", "before");
+        yield _this10.run_hook(_this10, "list", "before");
+
+        function removeSpaceAndSpecialCharacters(str) {
+          return str.replace(/[^a-zA-Z0-9]/g, "");
+        }
+
+        var key = removeSpaceAndSpecialCharacters(_this10.type + "::" + query + "::" + args.limit + "::" + args.offset + "::" + args.sort + "::" + args.do_count + "::" + args.statement_consistent + "::" + args.columns + "::" + args.is_full_text + "::" + args.is_custom_query);
         var results;
 
         if (args.is_custom_query && args.is_custom_query === "true") {
-          results = yield _this9.database.query(query);
+          if (args.ids.length > 0) {
+            if (_this10.shouldCache(_this10.type)) {
+              var cached_results = yield _this10.getCacheProviderObject(_this10.type).get(key);
+
+              if (cached_results) {
+                results = cached_results;
+              } else {
+                results = yield _this10.database.query(query);
+
+                _this10.getCacheProviderObject(_this10.type).set(key, results, _this10.getCacheConfig(_this10.type));
+              }
+            } else {
+              results = yield _this10.database.query(query);
+            }
+          }
         } else {
           if (args.is_full_text && args.is_full_text === "true") {
-            results = yield _this9.database.full_text_search(_this9.type, query || "", args.limit, args.offset);
+            if (_this10.shouldCache(_this10.type)) {
+              var _cached_results = yield _this10.getCacheProviderObject(_this10.type).get(key);
+
+              if (_cached_results) {
+                results = _cached_results;
+              } else {
+                results = yield _this10.database.full_text_search(_this10.type, query || "", args.limit, args.offset);
+
+                _this10.getCacheProviderObject(_this10.type).set(key, results, _this10.getCacheConfig(_this10.type));
+              }
+            } else {
+              results = yield _this10.database.full_text_search(_this10.type, query || "", args.limit, args.offset);
+            }
           } else {
-            results = yield _this9.database.search(_this9.type, args.columns || "", query || "", args.limit, args.offset, args.sort, args.do_count, args.statement_consistent);
+            if (_this10.shouldCache(_this10.type)) {
+              var _cached_results2 = yield _this10.getCacheProviderObject(_this10.type).get(key);
+
+              if (_cached_results2) {
+                results = _cached_results2;
+              } else {
+                results = yield _this10.database.search(_this10.type, args.columns || "", query || "", args.limit, args.offset, args.sort, args.do_count, args.statement_consistent);
+
+                _this10.getCacheProviderObject(_this10.type).set(key, results, _this10.getCacheConfig(_this10.type));
+              }
+            } else {
+              results = yield _this10.database.search(_this10.type, args.columns || "", query || "", args.limit, args.offset, args.sort, args.do_count, args.statement_consistent);
+
+              if (_this10.type == "user") {
+                console.log("results from DB No Chache available", results);
+              }
+            }
           }
         }
 
         try {
-          yield _this9.run_hook(results.data, "list", "after");
-          results.data = yield _this9.do_serialize(results.data, "read", {}, args, (yield _this9.propsToBeRemoved(results.data)));
+          yield _this10.run_hook(results.data, "list", "after");
+          results.data = yield _this10.do_serialize(results.data, "read", {}, args, (yield _this10.propsToBeRemoved(results.data)));
         } catch (e) {
           console.log(e);
         }
@@ -782,26 +857,26 @@ class SpiceModel {
   }
 
   run_hook(data, op, when, old_data) {
-    var _this10 = this;
+    var _this11 = this;
 
     return _asyncToGenerator(function* () {
       try {
-        if (_this10[_disable_lifecycle_events] == false) {
+        if (_this11[_disable_lifecycle_events] == false) {
           var resourceLifecycleTriggered = new _ResourceLifecycleTriggered.default({
             data: {
               data,
               operation: op,
               when,
               old_data,
-              resource: _this10.type,
-              ctx: _this10[_ctx]
+              resource: _this11.type,
+              ctx: _this11[_ctx]
             }
           });
           resourceLifecycleTriggered.dispatch();
         }
 
-        if (_this10[_hooks] && _this10[_hooks][op] && _this10[_hooks][op][when]) {
-          for (var i of _this10[_hooks][op][when]) {
+        if (_this11[_hooks] && _this11[_hooks][op] && _this11[_hooks][op][when]) {
+          for (var i of _this11[_hooks][op][when]) {
             data = yield i(data, old_data);
           }
         }
@@ -834,7 +909,7 @@ class SpiceModel {
   }
 
   mapToObject(data, Class, source_property, store_property, property) {
-    var _this11 = this;
+    var _this12 = this;
 
     return _asyncToGenerator(function* () {
       var original_is_array = _.isArray(data);
@@ -863,7 +938,7 @@ class SpiceModel {
       });
 
       var returned_all = yield Promise.allSettled(_.map(classes, obj => {
-        return new obj(_this11[_args]).getMulti({
+        return new obj(_this12[_args]).getMulti({
           ids: ids
         });
       }));
@@ -885,7 +960,7 @@ class SpiceModel {
   }
 
   mapToObjectArray(data, Class, source_property, store_property, property) {
-    var _this12 = this;
+    var _this13 = this;
 
     return _asyncToGenerator(function* () {
       var original_is_array = _.isArray(data);
@@ -914,7 +989,7 @@ class SpiceModel {
 
       var classes = _.isArray(Class) ? Class : [Class];
       var returned_all = yield Promise.allSettled(_.map(classes, obj => {
-        return new obj(_this12[_args]).getMulti({
+        return new obj(_this13[_args]).getMulti({
           ids: ids
         });
       }));
@@ -974,7 +1049,7 @@ class SpiceModel {
   }
 
   createMofifier(properties) {
-    var _this13 = this;
+    var _this14 = this;
 
     var _loop = function _loop(i) {
       if (properties[i].map) {
@@ -985,11 +1060,11 @@ class SpiceModel {
                 case String:
                 case "string":
                   {
-                    _this13.addModifier({
+                    _this14.addModifier({
                       when: properties[i].map.when || "read",
                       execute: function () {
                         var _execute = _asyncToGenerator(function* (data) {
-                          return yield _this13.mapToObject(data, _.isString(properties[i].map.reference) ? spice.models[properties[i].map.reference] : properties[i].map.reference, i, properties[i].map.destination || i, properties[i]);
+                          return yield _this14.mapToObject(data, _.isString(properties[i].map.reference) ? spice.models[properties[i].map.reference] : properties[i].map.reference, i, properties[i].map.destination || i, properties[i]);
                         });
 
                         function execute(_x) {
@@ -1006,11 +1081,11 @@ class SpiceModel {
                 case Array:
                 case "array":
                   {
-                    _this13.addModifier({
+                    _this14.addModifier({
                       when: properties[i].map.when || "read",
                       execute: function () {
                         var _execute2 = _asyncToGenerator(function* (data) {
-                          return yield _this13.mapToObjectArray(data, _.isString(properties[i].map.reference) ? spice.models[properties[i].map.reference] : properties[i].map.reference, i, properties[i].map.destination || i, properties[i]);
+                          return yield _this14.mapToObjectArray(data, _.isString(properties[i].map.reference) ? spice.models[properties[i].map.reference] : properties[i].map.reference, i, properties[i].map.destination || i, properties[i]);
                         });
 
                         function execute(_x2) {
@@ -1042,7 +1117,7 @@ class SpiceModel {
   }
 
   do_serialize(data, type, old_data, args, path_to_be_removed) {
-    var _this14 = this;
+    var _this15 = this;
 
     return _asyncToGenerator(function* () {
       //console.log("CTX INside Model DO", this[_ctx]);
@@ -1052,16 +1127,16 @@ class SpiceModel {
           path_to_be_removed = [];
         }
 
-        if (_this14.shouldSerializerRun(args, type)) {
-          if (_this14.type != "" && _this14.type != undefined && _this14[_external_modifier_loaded] != true) {
-            _this14.addExternalModifiers(_this14.type);
+        if (_this15.shouldSerializerRun(args, type)) {
+          if (_this15.type != "" && _this15.type != undefined && _this15[_external_modifier_loaded] != true) {
+            _this15.addExternalModifiers(_this15.type);
 
-            _this14[_external_modifier_loaded] = true;
+            _this15[_external_modifier_loaded] = true;
           }
 
-          for (var i of _this14[_serializers][type]["modifiers"]) {
+          for (var i of _this15[_serializers][type]["modifiers"]) {
             try {
-              data = yield i(data, old_data, _this14[_ctx], _this14.type);
+              data = yield i(data, old_data, _this15[_ctx], _this15.type);
             } catch (e) {
               console.log(e.stack);
             }
@@ -1077,12 +1152,12 @@ class SpiceModel {
 
           var defaults = {};
 
-          for (var _i in _this14.props) {
-            if (_this14.props[_i].defaults != undefined && _this14.props[_i].defaults[type] != undefined && _this14.props[_i].defaults[type] != undefined) {
-              defaults[_i] = _.isFunction(_this14.props[_i].defaults[type]) ? _this14.props[_i].defaults[type]({
+          for (var _i in _this15.props) {
+            if (_this15.props[_i].defaults != undefined && _this15.props[_i].defaults[type] != undefined && _this15.props[_i].defaults[type] != undefined) {
+              defaults[_i] = _.isFunction(_this15.props[_i].defaults[type]) ? _this15.props[_i].defaults[type]({
                 old_data: data,
                 new_data: old_data
-              }) : _this14.props[_i].defaults[type];
+              }) : _this15.props[_i].defaults[type];
             }
           } // apply defaults
 
@@ -1095,8 +1170,8 @@ class SpiceModel {
           if (type == "read") {
             var props_to_clean = ["deleted", "type", ...path_to_be_removed];
 
-            for (var _i3 in _this14.props) {
-              if (_this14.props[_i3].hide) {
+            for (var _i3 in _this15.props) {
+              if (_this15.props[_i3].hide) {
                 props_to_clean.push(_i3);
               }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spice-js",
-  "version": "2.5.37",
+  "version": "2.6.0",
   "description": "spice",
   "main": "build/index.js",
   "repository": {
@@ -32,6 +32,7 @@
     "koa-views": "^6.2.3",
     "koa2-swagger-ui": "^5.5.1",
     "lodash": "^4.17.15",
+    "node-cache": "^5.1.2",
     "nunjucks": "^3.2.0",
     "open": "7.0.0",
     "parse-comments": "^1.0.0",

package/src/bootstrap/cache.js

@@ -0,0 +1,17 @@
+"use strict";
+
+async function connect() {
+  try {
+    spice.cache_providers = {};
+    for (let key of Object.keys(spice.config.cache.providers)) {
+      spice.cache_providers[key] = new spice.config.cache.providers[key](
+        spice.config.cache.drivers[key] || {}
+      );
+      await spice.cache_providers[key].initialize();
+    }
+  } catch (e) {
+    console.log(e.stack);
+    throw e;
+  }
+}
+module.exports = connect;