node package manager
It’s your turn. Help us improve JavaScript. Take the 2017 JavaScript Ecosystem Survey »

yocto-mongoose

NPM

alt text Code Climate Test Coverage Issue Count Build Status

Overview

This module is a part of yocto node modules for NodeJS.

Please see our NPM repository for complete list of available tools (completed day after day).

This module provide a simple config validator tools for your node app.

Motivation

Create an easy and ready to use connector & model builder based on mongoose / redis / elasticsearch.

Folder structure

A specific folder structure was setup for database configuration :

  • enums : Contains all enums defined for database
  • models : Contains all model definition for an automatic build
  • validators : Contains all validator function defined on model configuration files
  • methods : Contains all methods defined on model configuration

All of these folders must be set up before any usage. For sure it's possible to set your own directory for each items. (See How to setup path directory part)

Dependencies & Validator

  • Validate rules MUST be build with joi package
  • Promise was build with Q package

Model type & list defintiion

  • String
  • ObjectId
  • Boolean
  • Object
  • Array or []

How to set directories path

A method was defined for each path

  • models(path) : set directory for models files
  • validators(path) : set directory for validators files
  • methods(path) : set directory for methods files
  • enums(path) : set directory for enums files

How to define a new model

For this example we want to define "Notify" model.

First you need to go in your models directory Create your own folder (not mandatory) Create a json file in created folder named like your model name (notify.json) Add you model definition on it (see below for example)

{
  "model" : {
    "name" : "Notify", // !!! IMPORANT !!! => This is your model name. 
    "crud" : { // !!! MANDATORY !!! you need define it all the time 
      "enable"  : true, // Set to false if you d'ont need enable automatic add of crud method 
      "exclude" : [] // define here witch method we want to exlude (see CRUD parts for available method) 
    },
    "properties" : { // Define here your property 
      "status" : {
        "required" : true,
        "type"     : "String"
      },
      "notify_type" : {
        "required" : true,
        "type"     : "String"
      }
    }
  }
}

Save file, Build & Use (See How To use part)

How to define a validator / function / enums attached to the previous define model

How to add a new validator

First edit you notify.json file created before and set the validator properties by the name of needed function, for example my Function name is "testValidator"

{
  "model" : {
    "name" : "Notify",
     .....
    "validator" : "testValidator",
  }
}

Create your structure of directory in validators directory (not mandatory). Create your notify.js files that will be contain your validation rules. Add into this files your new validation rules

'use strict';
 
var joi = require('joi');
 
// valid account schema 
exports.testValidator = function(data) {
  return joi.object().keys({
    a : joi.string()
  });
};

Save file, Build & Use (See How To use part)

How to add new function(s)

First edit your notify.json file and add an "fn" properties, and add list of your methods :

{
  "model" : {
    "name" : "Notify",
     .....
    "validator" : "testValidator",
    "fn"        : [
      {
        "type"  : "static", // create a static method on schema 
        "name"  : "test1"
      },
      {
        "type"  : "method", // create a instance method on schema 
        "name"  : "test2"
      }
  }
}

Create your structure of directory in methods directory (not mandatory).

// test 1 
exports.test1 = function() {
    console.log('test1')
};
// test2 
exports.test2 = function() {
  console.log('test2');
};

Save file, Build & Use (See How To use part)

!!! IMPORTANT !!! Each function will be executed in schema context, so crud or mongoose method was available.

Add enum value(s)

Create a "file.json" into enums directory

Add item like this :

[
  {
    "name"  : "notify_type_list",
    "value" : [ "email", "sms", "notification" ]
  },
  {
    "name"  : "notify_status_list",
    "value" : [ "pending", "processed", "error" ]
  }
]

Use it on your validator by injection dependencices to retreive a value :

exports.testValidator = function (enums) {
  var status  = enums().get('notify_status_list');
  var type    = enums().get('notify_type_list');
 // your code here 
}

Access to mongooseTypes from enums

exports.testTypes = function (enums) {
 // your code here 
 console.log(enums().Types);
}

CRUD methods

All defined model have CRUD Method attached by mongoose static function.

See Below list of method & aliases :

Operation Available Method Alias(es)
Create create insert
Read (Retrieve) get read
Update (Modify update modify
Delete (Destroy) delete destroy

Elasticsearch implementation

Setting up one host or multiple hosts

You can provide to our package a multiple hosts connection for elasticsearch part. A method elasticHosts are available to define which hosts to use on mongoosastic.

 
var db = require('yocto-mongoose')();
 
// Connect 
db.connect('MONGO_URL').then(function() {
  db.enableElasticsearch([ { host : '127.0.0.1', port : 9200 } ]);
});
 

Basic configuration

Elastic search implemantion are builed with mongoosastic package

Elastic search rules are setted up during model build. You can define index directly on model definition. See a simple example below :

{
  "model" : {
    "name" :
    "crud" : {
      "enable"  : true,
      "exclude" : []
    },
    "elastic" : {
      "enable" : true, // !!! IMPORTANT !!! must be provide to enable elastic search mapping 
      "options" : {} // see : https://github.com/mongoosastic/mongoosastic#setup (host, hosts, protocol, port is removed if given : See multiple host usage) 
    },
    "properties" : {
      "status" : {
        "required" : true,
        "type"     : "String"
        "es_indexed" : true // here we define that this properties must be indexed. 
        "es_type"    : "String" // another possible value 
        "es_include_in_parent" : true // same thing 
      },
      "notify_type" : {
        "required" : true,
        "type"     : "String"
      }
    }
  }
}

Usage

On each model, where elastic is enabled a method search was added.

To do an elasticsearch query just do :

 
  var query = {}; // Here define your query 
  var hydrate = false; // set to true if you wan use hydrate method 
  var hydrateOptions = {}; // set here your hydrate options 
 
  // process request 
  account.esearch(query, hydrate, hydrateOptions).then(function(success) {
    // your logic code here 
  }).catch(function (error) {
    // your logic code here 
  });

List of available keys

For more complex implementation see mongoosastic package documentation to see available keys

Use ssl connection or other options

 
var db = require('yocto-mongoose')();
 
// define here your elasticsearch options 
var options = {
  ssl : {
    ca: fs.readFileSync(__dirname + "/cert.pem"),
    rejectUnauthorized: true
  }
};
 
// Connect 
db.connect('MONGO_URL').then(function() {
  db.elasticHosts([ { host : '127.0.0.1', port : 9200, protocol : 'https' } ], options);
});
 

To discover a complete list of options see : official elastic configuration

Redis implementation

Our redis implementation use ioredis module but only use set/get method with expire time for the moment.

Be careful : Redis > 2.6 is required to use this module. In fact expire time is not implemented on Redis < 2.6. For more details please read official redis documentation

Setting up one host or multiple hosts

By default redis instance use single connection :

 
var db = require('yocto-mongoose')();
 
// Connect 
db.connect('MONGO_URL').then(function() {
  db.enableRedis([ { host : '127.0.0.1', port : 6379 }, { host : '127.0.0.1', port : 6379 }]);
});
 

Setting up one host or multiple host in a cluster mode

Just add true on second parameters of enableRedis method.

 
var db = require('yocto-mongoose')();
 
// Connect 
db.connect('MONGO_URL').then(function() {
  db.enableRedis([ { host : '127.0.0.1', port : 6379 }, { host : '127.0.0.1', port : 6379 }], true);
});
 

Usage

Redis is implemented in two ways in this modules, from custom methods and crud methods.

Redis on Crud methods

To use redis on Crud method just extend your config file like this :

{
  "model" : {
    "name" : "Notify",
    "crud" : {
      "enable"  : true,
      "exclude" : [],
      "redis"   : { // HERE YOUR REDIS PART 
        "enable"  : true, // MUST BE SET TO TRUE TO ENABLE THIS FUNCTIONALITY 
        "expire"  : 10, // EXPIRE TIME FOR STORAGE IN SECONDS 
        "include" : [ "get", "getOne" ] // CRUD METHODS ALLOWED TO USE REDIS 
      }
    },
    "properties" : {
      "status" : {
        "required" : true,
        "type"     : "String"
      },
      "notify_type" : {
        "required" : true,
        "type"     : "String"
      }
    }
  }
}

This configuration enable to your current model redis on include method (get or getOne). On each request on include method redis will be check if value exists before each mongo request. In case of value was found, we return founded value, otherwise we store the value, with given expire time before process the mongo access.

The storage key is build automatically by our redis implementation

To see your data from a GUI tool download Medis

Redis on custom methods

To use redis on custom method just extend your config file like this :

{
  "model" : {
    "name" : "Notify",
     .....
    "validator" : "testValidator",
    "fn"        : [
      {
        "type"  : "static", // create a static method on schema 
        "name"  : "test1",
        "redis"   : { // HERE YOUR REDIS PART 
          "enable"  : true, // MUST BE SET TO TRUE TO ENABLE THIS FUNCTIONALITY 
          "expire"  : 10, // EXPIRE TIME FOR STORAGE IN SECONDS 
        }
      },
      {
        "type"  : "method", // create a instance method on schema 
        "name"  : "test2"
      }
  }
}

After that your can access to the redis instance in your custom function and use add, get, delete or flush method.

An alias to the add method is provide by the set method. An alias to the delete method is provide by the remove method.

// valid account schema 
exports.test1 = function(data) {
  var redis   = this.redis().instance;
  var expire  = this.redis().expire;
 
  // add a new key/value 
  redis.add('aaa', { foo : 'abar' }, expire);
  // Or 
  redis.set('aaa', { foo : 'abar' }, expire);
 
  // get value 
  redis.get('aaa').then(function (success) {
    // do stuff 
  }).catch(function (error) {
    // do another stuff here 
  });
 
  // delete an value 
  redis.delete('aaa');
  // Or 
  redis.remove('aaa');
 
  // flush values 
  redis.flush().then(function (success) {
    // do stuff 
  })
  // flush values with a custom pattern 
  redis.flush('MY_PATTERN').then(function (success) {
    // do stuff 
  })
};