spice-js 2.5.38 → 2.6.0

package/src/cache/providers/SpiceCache.js

@@ -0,0 +1,30 @@
+const NodeCache = require("node-cache");
+module.exports = class SpiceCache {
+  constructor(args = {}) {
+    this.options = args;
+    this.client = null;
+  }
+  async initialize(options = {}) {
+    this.options = { ...this.options, ...options };
+    this.client = new NodeCache();
+  }
+
+  async set(key, value, options = {}) {
+    let working_options = { ...this.options, ...options };
+    const { ttl, namespace = "" } = working_options;
+    if (value === undefined) return console.log("Value is undefined");
+    this.client.set(namespace + key, value, ttl || 60);
+  }
+
+  async get(key, options = {}) {
+    try {
+      return this.client.get(key);
+    } catch (e) {
+      return null;
+    }
+  }
+
+  async exists(key) {
+    return await this.client.exists(key);
+  }
+};

package/src/config/cache.js

@@ -0,0 +1,3 @@
+module.exports = {
+    
+}

package/src/index.js

@@ -35,6 +35,7 @@ export { default as LocalStorage } from "./storage/providers/Local";
 export { default as Storage } from "./storage/Storage";
 
 export { default as MailFile } from "./mail/providers/File";
+export { default as SpiceCache } from "./cache/providers/SpiceCache";
 export { default as MapType } from "./utility/MapType";
 export { default as addTask } from "./bootstrap/tasks";
 const convert = require("koa-convert");

package/src/models/SpiceModel.js

@@ -365,6 +365,27 @@ export default class SpiceModel {
     return return_string;
   }
 
+  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
+    ];
+  }
+
+  async exists(item_type, key) {
+    let obj = this.getCacheProviderObject(item_type);
+    if (obj) return await obj.exists(key);
+    return false;
+  }
+
   async get(args) {
     try {
       if (!args) {
@@ -372,7 +393,33 @@ export default class SpiceModel {
       }
       if (_.isString(args.id)) {
         await this.run_hook(args, "get", "before");
-        let results = await this.database.get(args.id);
+        let key = `${this.type}::${args.id}`;
+        let results = {};
+        if (this.shouldCache(this.type)) {
+          let cached_results = await this.getCacheProviderObject(this.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 = await this.database.get(args.id);
+            /* if (this.type == "user") {
+              console.log("results from DB", results);
+            } */
+            await this.getCacheProviderObject(this.type).set(
+              key,
+              results,
+              this.getCacheConfig(this.type)
+            );
+          }
+        } else {
+          results = await this.database.get(args.id);
+        }
 
         if (results.type != undefined) {
           if (results.type != this.type)
@@ -420,9 +467,26 @@ export default class SpiceModel {
 
       await this.run_hook(this, "list", "before");
       _.remove(args.ids, (o) => o == undefined);
+      let key = `${this.type}::${_.join(args.ids, "|")}`;
       let results = [];
       if (args.ids.length > 0) {
-        results = await this.database.multi_get(args.ids, true);
+        if (this.shouldCache(this.type)) {
+          let cached_results = await this.getCacheProviderObject(this.type).get(
+            key
+          );
+          if (cached_results) {
+            results = cached_results;
+          } else {
+            results = await this.database.multi_get(args.ids, true);
+            this.getCacheProviderObject(this.type).set(
+              key,
+              results,
+              this.getCacheConfig(this.type)
+            );
+          }
+        } else {
+          results = await this.database.multi_get(args.ids, true);
+        }
       }
       _.remove(results, (o) => o.type != this.type);
 
@@ -495,7 +559,7 @@ export default class SpiceModel {
         form = await this.do_serialize(this, "write", cover_obj.new, args);
       }
       let db_data = form || this;
-      
+
       await this.database.update(args.id, db_data);
       if (args.skip_hooks != true) {
         await this.run_hook(
@@ -612,7 +676,7 @@ export default class SpiceModel {
         query = args.query;
       } else {
         if (args.filters) {
-          query = await this.makeQueryFromFilter(args.filters);
+          query = this.makeQueryFromFilter(args.filters);
         } else {
           if (args.query) {
             query =
@@ -635,28 +699,102 @@ export default class SpiceModel {
       }
 
       await this.run_hook(this, "list", "before");
+      function removeSpaceAndSpecialCharacters(str) {
+        return str.replace(/[^a-zA-Z0-9]/g, "");
+      }
+      let key = removeSpaceAndSpecialCharacters(
+        `${this.type}::${query}::${args.limit}::${args.offset}::${args.sort}::${args.do_count}::${args.statement_consistent}::${args.columns}::${args.is_full_text}::${args.is_custom_query}`
+      );
+
       let results;
       if (args.is_custom_query && args.is_custom_query === "true") {
-        results = await this.database.query(query);
+        if (args.ids.length > 0) {
+          if (this.shouldCache(this.type)) {
+            let cached_results = await this.getCacheProviderObject(
+              this.type
+            ).get(key);
+            if (cached_results) {
+              results = cached_results;
+            } else {
+              results = await this.database.query(query);
+              this.getCacheProviderObject(this.type).set(
+                key,
+                results,
+                this.getCacheConfig(this.type)
+              );
+            }
+          } else {
+            results = await this.database.query(query);
+          }
+        }
       } else {
         if (args.is_full_text && args.is_full_text === "true") {
-          results = await this.database.full_text_search(
-            this.type,
-            query || "",
-            args.limit,
-            args.offset
-          );
+          if (this.shouldCache(this.type)) {
+            let cached_results = await this.getCacheProviderObject(
+              this.type
+            ).get(key);
+            if (cached_results) {
+              results = cached_results;
+            } else {
+              results = await this.database.full_text_search(
+                this.type,
+                query || "",
+                args.limit,
+                args.offset
+              );
+              this.getCacheProviderObject(this.type).set(
+                key,
+                results,
+                this.getCacheConfig(this.type)
+              );
+            }
+          } else {
+            results = await this.database.full_text_search(
+              this.type,
+              query || "",
+              args.limit,
+              args.offset
+            );
+          }
         } else {
-          results = await this.database.search(
-            this.type,
-            args.columns || "",
-            query || "",
-            args.limit,
-            args.offset,
-            args.sort,
-            args.do_count,
-            args.statement_consistent
-          );
+          if (this.shouldCache(this.type)) {
+            let cached_results = await this.getCacheProviderObject(
+              this.type
+            ).get(key);
+            if (cached_results) {
+              results = cached_results;
+            } else {
+              results = await this.database.search(
+                this.type,
+                args.columns || "",
+                query || "",
+                args.limit,
+                args.offset,
+                args.sort,
+                args.do_count,
+                args.statement_consistent
+              );
+              this.getCacheProviderObject(this.type).set(
+                key,
+                results,
+                this.getCacheConfig(this.type)
+              );
+            }
+          } else {
+            results = await this.database.search(
+              this.type,
+              args.columns || "",
+              query || "",
+              args.limit,
+              args.offset,
+              args.sort,
+              args.do_count,
+              args.statement_consistent
+            );
+            if (this.type == "user") {
+              console.log("results from DB No Chache available", results);
+            }
+          }
         }
       }
       try {

package/build/bootstrap/agenda.js

@@ -1,36 +0,0 @@
-"use strict";
-
-var _path = _interopRequireDefault(require("path"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Created by chadfraser on 25/02/2017.
- */
-module.exports = function () {
-  return new Promise(function (resolve, reject) {
-    try {
-      var locations = [spice.module_root_path + '/tasks', spice.root_path + '/tasks'];
-
-      var _loop = function _loop(i) {
-        var files = require('fs').readdirSync(i);
-
-        files.forEach(function (file) {
-          file.split('.')[0];
-
-          require(_path.default.join(i, file));
-
-          console.log('Loading Task', _path.default.join(i, file));
-        });
-      };
-
-      for (var i of locations) {
-        _loop(i);
-      }
-
-      resolve({});
-    } catch (e) {
-      reject(e);
-    }
-  });
-};

package/build/events/Stage.js

@@ -1,24 +0,0 @@
-/**
- * Created by chadfraser on 09/12/15.
- */
-
-/*
-var _ = require('underscore');
-var Date = require('sonover-date');
-var Event = function(stage, data)
-{
-
-    this.stage = stage;
-    this.data = data;
-    this.time  = new Date().now();
-
-    if(_.isUndefined(this.stage)){
-        this.stage = "";
-    }
-    if(_.isUndefined(this.data)){
-        this.data = null;
-    }
-}
-
-module.exports =  Event;*/
-"use strict";

package/build/events/index.js

@@ -1,12 +0,0 @@
-/*import { inherits } from 'util';
-var EventRegistry;
-var EventRegistryInstance;
-
-EventRegistry = function () {};
-inherits(EventRegistry, EventEmitter);
-
-EventRegistryInstance = new EventRegistry();
-EventRegistryInstance.(1000);
-
-export default EventRegistryInstance;*/
-"use strict";

package/build/events/providers/SpiceEventDriver copy.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-class SpiceEventDriver {
-  dispatch() {
-    var {
-      topic,
-      data
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    spice.EventEmitter.emit(topic, data);
-  }
-
-  on(topic, callback) {
-    spice.EventEmitter.on(topic, callback);
-  }
-
-}
-
-exports.default = SpiceEventDriver;

package/build/storage/providers/File.js

@@ -1,53 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
-var fs = require('fs-extra');
-
-var path = require('path');
-
-var open = require("open");
-
-class File {
-  constructor() {
-    var args = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    this.sender = args.sender;
-    this.subject = args.subject;
-    this.htmlText = args.htmlText;
-    this.dest = path.join(path.resolve('./'), 'storage/mail');
-
-    if (args.path) {
-      this.dest = path.resolve(args.path);
-    }
-  }
-
-  send(htmlText) {
-    var _arguments = arguments,
-        _this = this;
-
-    return _asyncToGenerator(function* () {
-      var options = _arguments.length > 1 && _arguments[1] !== undefined ? _arguments[1] : {};
-      var email = {
-        to: options.to,
-        from: options.sender || _this.sender,
-        subject: options.subject || _this.subject,
-        htmlText: htmlText || _this.htmlText
-      };
-      var time = new Date().getTime();
-      fs.ensureDirSync("".concat(_this.dest, "/").concat(email.subject, "/").concat(time));
-      var full_path = "".concat(_this.dest, "/").concat(email.subject, "/").concat(time, "/to:").concat(email.to, " from:").concat(email.from, ".html");
-      fs.writeFileSync(full_path, email.htmlText);
-      open(full_path);
-    })();
-  }
-
-}
-
-exports.default = File;

package/build/utility/DataType copy.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-var DataType = function DataType() {
-  _classCallCheck(this, DataType);
-};
-
-exports["default"] = DataType;
-
-_defineProperty(DataType, "ARRAY", "array");
-
-_defineProperty(DataType, "BOOLEAN", "boolean");
-
-_defineProperty(DataType, "OBJECT", "object");
-
-_defineProperty(DataType, "STRING", "string");
-
-_defineProperty(DataType, "NUMBER", "number");
-
-_defineProperty(DataType, "DATE", "date");

package/build/validators/UserGroup.js

@@ -1,44 +0,0 @@
-"use strict";
-
-var _UserGroup = _interopRequireDefault(require("../models/UserGroup"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var Rules = spice.classes.validate.Rules;
-
-Rules.prototype.shouldExist = function* (field, value, args, message) {
-  try {
-    var loaded = require("../models/".concat(args));
-
-    var Class = loaded.default;
-    var obj = new Class();
-    var found = yield obj.exist(value);
-
-    if (found) {
-      return true;
-    }
-  } catch (e) {
-    this.validator.addError(field, 'rule', field + 'ShouldExist', 'Cannot Validate ' + args);
-  }
-
-  return false;
-};
-
-Rules.prototype.userGroupIsUnique = function* (field, value, message) {
-  try {
-    var group = new _UserGroup.default();
-    var group_found = yield group.get({
-      id: value
-    });
-    console.log(group_found);
-    this.validator.addError(field, 'rule', 'usergroupIsUnique', message || 'This usergroup has already been created');
-    return false;
-  } catch (e) {
-    if (e.message == 'user_group does not exist') {
-      return true;
-    } else {
-      this.validator.addError(field, 'rule', 'userGroupIsUnique', 'Cannot Validate usergroup');
-      return false;
-    }
-  }
-};

package/build/validators/Utility.js

@@ -1,17 +0,0 @@
-"use strict";
-/* let Rules = spice.classes.validate.Rules;
-
-Rules.prototype.shouldExist = function* (field, value, args, message) {
-    try {
-        let loaded = require(spice.root_path + `/models/${args}`);
-        let Class = loaded.default;
-        let obj = new Class();
-        let found = yield obj.exist(value);
-        if (found) {
-            return true;
-        }
-    } catch (e) {
-        this.validator.addError(field, 'rule', field + 'ShouldExist', 'Cannot Validate ' + args);
-    }
-    return false;
-} */