gina 0.1.1-alpha.146 → 0.1.1-alpha.147

package/framework/v0.1.1-alpha.147/core/connectors/couchbase/lib/connector.v4.js

@@ -0,0 +1,377 @@
+// "use strict";
+var fs              = require('fs');
+var util            = require('util');
+var EventEmitter    = require('events').EventEmitter;
+uuid                = require('uuid');
+var couchbase       = require(getPath('project') +'/node_modules/couchbase');// jshint ignore:line
+var gina            = require('../../../../core/gna');
+var utils           = gina.utils;
+var console         = utils.logger;
+var merge           = utils.merge;
+var modelUtil       = new utils.Model();
+
+//globalized
+// N1qlQuery           = couchbase.N1qlQuery || null;// jshint ignore:line
+// N1qlStringQuery     = couchbase.N1qlStringQuery || null;// jshint ignore:line
+// ViewQuery           = couchbase.ViewQuery || null;// jshint ignore:line
+// uuid                = require('uuid');// jshint ignore:line
+
+// uuid                = require('../../../../node_modules/uuid');
+
+
+
+/**
+ * Connector for couchbase module v4
+ *
+ * Options :
+ *  - keepAlive (default: true)
+ *      if set to `true`, will ping based on `pingInterval`
+ *      if set to `false`, will not ping the database server
+ *  - pingInterval (default: 2m)
+ *      `30s` will set the ping interval to 30 seconds
+ *      `1m` will set the ping interval to 1 minute
+ *      `1h` will set the ping interval to 1 hour
+ *      `1d` will set the ping interval to 1 day
+ *
+ * @class
+ * */
+function Connector(dbString) {
+    var self    = this
+        , local = {
+            bundle: null,
+            env: null,
+            options: {
+                useScopeAndCollections: true,
+                scope: '_default', // by default
+                collection: '_default', // by default
+                keepAlive: true,
+                pingInterval: "2m",
+                // https://docs.couchbase.com/sdk-api/couchbase-node-client/interfaces/TimeoutConfig.html
+                // timeouts:  {
+                //     kvTimeout: 10000, // milliseconds
+                // }
+            }
+        }
+        , sdk = {
+            version: 4
+        }
+    ;
+
+    /**
+     * connect
+     *
+     * @param {object} dbString
+     * @callback cb
+     * */
+    this.connect = async function(dbString, cb) {
+        // Attention: the connection is lost 5 minutes once the bucket is opened.
+        var conn = null, defaultCollection = null;
+
+        var onError = function (err, next) {
+            delete self.instance.reconnecting;
+            self.instance.reconnected = self.instance.connected = false;
+            console.error('[ CONNECTOR ][ ' + local.bundle +' ] couchbase could not be reached !!\n'+ ( err.stack || err.message || err ) );
+
+            // reconnecting
+            console.debug('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.database +' ] trying to reconnect in a few secs...');
+            self.instance.reconnecting = true;
+
+            setTimeout( function onRetry(){
+                if ( typeof(next) != 'undefined' ) {
+                    self.connect(dbString, next)
+                } else {
+                    self.connect(dbString)
+                }
+            }, 5000)
+
+        };
+
+        // once
+        var onConnect = function onConnect(cb){
+            console.debug('[ CONNECTOR ][ ' + local.bundle +' ] couchbase is alive !!');
+            console.debug('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.connector +' ] now connected...');
+
+            self.instance.reconnected  = self.instance.connected   = true;
+            var options = local.options;
+
+            // updating context
+            var ctx = getContext()// jshint ignore:line
+                , bundle = ctx.bundle
+                , env = ctx.env
+                , conf = ctx['gina'].config.envConf[bundle][env]
+                , name = dbString.database
+                //Reload models.
+                , modelsPath = _(conf.modelsPath)// jshint ignore:line
+            ;
+            // will send heartbeat every 4 minutes if keepAlive == `true`
+            self.ping(options.pingInterval, cb, function onPing(cb){
+
+                local.bundle    = bundle;
+                local.env       = env;
+
+                if ( typeof(cb) != 'undefined' ) { // this portition is not working yet on Mac OS X
+                    console.debug('[ CONNECTOR ][ ' + local.bundle +' ][ '+ env +' ] connected to couchbase !!');
+
+
+                    modelUtil.setConnection(bundle, name, self.instance);
+
+                    if ( fs.existsSync(modelsPath) ) {
+                        modelUtil.setConnection(bundle, name, self.instance);
+                        modelUtil.reloadModels(
+                            conf,
+                            function doneReloadingModel(err) {
+                                self.reconnecting = false;
+                                cb(err)
+                            })
+                    } else {
+                        cb(new Error('[ CONNECTOR ][ ' + local.bundle +' ][ '+ env +' ] '+ modelsPath+ ' not found') )
+                    }
+
+                } else {
+                    console.debug('[ CONNECTOR ][ ' + local.bundle +' ][ '+ env +' ] connection to bucket `'+ name +'` is being kept alive ...');
+                }
+            });
+            // intercepting conn event thru gina
+            gina.onError(function(err, req, res, next){
+                // (code)   message
+                // (16)     Generic network failure. Enable detailed error codes (via LCB_CNTL_DETAILED_ERRCODES, or via `detailed_errcodes` in the connection string) and/or enable logging to get more information
+                // (23)     Client-Side timeout exceeded for operation. Inspect network conditions or increase the timeout
+                //          cannot perform operations on a shutdown bucket
+                //          err instanceof CouchbaseError
+
+                if (!self.instance.connected) {
+                    self.instance.reconnected = false;
+                    self.instance.reconnecting = false;
+                }
+
+                if (
+                    err instanceof couchbase.Error && err.code == 16 && !self.reconnected
+                    //|| err instanceof couchbase.Error && err.code == 23 && !self.reconnecting
+                    || /cannot perform operations on a shutdown bucket/.test(err.message ) && !self.reconnecting && !self.reconnected
+                ) {
+                    // reconnecting
+                    console.debug('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.database +' ] trying to reconnect in 5 secs...');
+                    self.reconnecting = true;
+
+                    setTimeout( function onRetry(){
+                        if ( typeof(next) != 'undefined' ) {
+                            self.connect(dbString, next)
+                        } else {
+                            self.connect(dbString)
+                        }
+                    }, 5000)
+
+                } else if (err instanceof couchbase.Error && err.code == 23 && !self.reconnecting) {
+                    self.instance.disconnect();
+                    // express js patch
+                    if (typeof(next) != 'undefined') {
+                        next(err); // might just be a "false" error: `err` is replaced with cb() caller `data`
+                    } else {
+                        console.error('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.database +' ] gina fatal error ('+ err.code +'): ' + (err.message||err) + '\nstack: '+ err.stack);
+                        return;
+                    }
+                } else {
+
+                    if (err && err instanceof Error) {
+
+                        console.error('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.database +' ] gina fatal error ('+ err.code +'): ' + (err.message||err) + '\nstack: '+ err.stack);
+
+                        if ( typeof(err) == 'object' ) {
+                            res.end(JSON.stringify({
+                                status: 500,
+                                error: err.message,
+                                stack: err.stack
+                            }))
+                        } else {
+                            res.end(err)
+                        }
+
+                        res.headersSent = true;
+                    } else {
+                        // express js patch
+                        if (typeof(next) != 'undefined') {
+                            next(err); // might just be a "false" error: `err` is replaced with cb() caller `data`
+                        } else {
+                            console.error('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.database +' ] gina fatal error ('+ err.code +'): ' + (err.message||err) + '\nstack: '+ err.stack);
+                            return;
+                        }
+                    }
+                }
+            });
+
+            setTimeout(() => {
+                self.emit('ready', false, self.instance);
+            }, 300);
+
+        };
+
+
+        dbString.bucketName = dbString.database;
+
+        try {
+            // if ( typeof(dbString.password) != 'undefined' && typeof(self.cluster.authenticate) == 'undefined' ) {
+                // conn = await self.cluster.openBucket(dbString.database, dbString.password, function onBucketOpened(bErr) {
+                conn = await couchbase.connect(dbString.protocol + dbString.host, dbString, function onBucketOpened(bErr, conn) {
+                    if (bErr) {
+                        if ( typeof(cb) != 'undefined' ) {
+                            return cb(bErr)
+                        }
+                        return self.emit('ready', bErr, null);
+                    }
+                    conn.sdk        = sdk;
+
+                    // open bucket
+                    var bucketConn = conn.bucket(dbString.bucketName);
+                    bucketConn.sdk = sdk;
+                    // Get a reference to the default collection, required only for older Couchbase server versions
+                    // defaultCollection = bucketConn.defaultCollection();
+                    // default scope
+                    // default collection
+                    self.instance   = bucketConn;
+                    onConnect(cb);
+
+                    // return bucketConn
+                });
+
+                // return conn
+            // } else {
+            //     // conn = await self.cluster.openBucket(dbString.database, function onBucketOpened(bErr) {
+            //     self.cluster = conn =
+            //         if (bErr) {
+            //             cb(bErr)
+            //         } else {
+            //             conn.sdk        = sdk;
+            //             self.instance   = conn;
+            //             onConnect(cb);
+            //         }
+            //     });
+            // }
+
+        } catch (err) {
+            console.error('[ CONNECTOR ][ ' + local.bundle +' ] '+ local.env +' ] couchbase could not connect to bucket `'+ dbString.database +'`\n'+ (err.stack || err.message || err) );
+            onError(err, cb)
+        }
+
+
+        // return conn
+        return self.instance
+    }
+
+    /**
+     * init
+     *
+     * @param {object} dbString
+     *
+     * @contructor
+     * */
+    var init = function(dbString) {
+        try {
+            dbString        = merge(dbString, local.options);
+            local.options   = dbString;
+            local.bundle    = getConfig().bundle;// jshint ignore:line
+
+            console.info('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.connector +' ][ ' + dbString.database +' ] authenticating to couchbase cluster @'+ dbString.protocol + dbString.host);
+
+            try {
+                self.cluster = new couchbase.Cluster(dbString.protocol + dbString.host);
+                // version 5.x
+                if ( typeof(self.cluster.authenticate) != 'undefined' )
+                    self.cluster.authenticate(dbString.username, dbString.password);
+            } catch(_err) {
+                console.error('[ CONNECTOR ][ ' + local.bundle +' ] could not authenticate to couchbase @`'+ dbString.protocol + dbString.host +'`\n'+ (_err.stack || _err.message || _err) );
+            }
+
+            console.info('[ CONNECTOR ][ ' + local.bundle +' ][ ' + dbString.connector +' ][ ' + dbString.database +' ] connecting to couchbase cluster @'+ dbString.protocol + dbString.host);
+
+            self.connect(dbString)
+
+        } catch (err) {
+            console.error(err.stack);
+            self.emit('ready', err, null)
+        }
+    }
+
+
+
+    /**
+     * ping
+     * Heartbeat to keep connection alive
+     *
+     * @param {string} interval
+     * @callback cb
+     * */
+    this.ping = function(interval, cb, ncb) {
+        var options = local.options;
+        if (options.keepAlive) {
+            if ( self.pingId ) {
+                clearInterval(self.pingId)
+            }
+
+            interval    = interval || options.pingInterval; // for a minute
+            var value = interval.match(/\d+/);
+            var unit  = null; // will be seconds by default
+            try {
+                unit = interval.match(/[a-z]+/i)[0]
+            } catch(err) {
+                unit = 's'
+            }
+
+            switch ( unit.toLowerCase() ) {
+                case 's':
+                    interval = value * 1000;
+                    break;
+
+                case 'm':
+                    interval = value * 60 * 1000;
+                    break;
+
+                case 'h':
+                    interval = value * 60 * 60 * 1000;
+                    break;
+
+                case 'd':
+                    interval = value * 60 * 60 * 1000 * 24;
+                    break;
+
+                default: // seconds
+                    interval = value * 1000
+            }
+
+            self.pingId = setInterval(function onTimeout(){
+
+                if (!self.instance.connected) {
+                    console.debug('[ CONNECTOR ][ ' + local.bundle +' ] connecting to couchbase');
+
+                    self.instance.reconnected = false;
+                    self.instance.reconnecting = true;
+                    if ( typeof(cb) != 'undefined' ) {
+                        self.connect(dbString, cb)
+                    } else {
+                        self.connect(dbString)
+                    }
+
+                } else {
+                    self.ping(options.pingInterval, cb, ncb);
+                }
+
+            }, interval);
+
+            ncb(cb)
+        } else {
+            console.debug('[ CONNECTOR ][ ' + local.bundle +' ] sent ping to couchbase ...');
+            self.ping(interval, cb, ncb);
+        }
+    }
+
+    this.getInstance = function() {
+        return self.instance
+    }
+
+    this.onReady = function(cb) {
+        self.once('ready', cb);
+        init(dbString)
+    }
+}
+
+util.inherits(Connector, EventEmitter);
+module.exports = Connector;

package/framework/{v0.1.1-alpha.146 → v0.1.1-alpha.147}/core/connectors/couchbase/lib/n1ql.js

@@ -10,5 +10,6 @@
  */
 function N1QLEntity() {
     var n1ql       = this.getConnection();
-};
-module.exports = N1QLEntity
+}
+
+module.exports = N1QLEntity;

package/framework/{v0.1.1-alpha.146 → v0.1.1-alpha.147}/core/connectors/couchbase/lib/session-store.js

@@ -5,16 +5,17 @@ var utils           = gina.utils;
 var console         = utils.logger;
 
 var version = 2; // by default
-var dependencies = JSON.parse(fs.readFileSync(GINA_FRAMEWORK_DIR + '/package.json')).dependencies;
+var dependenciesPath = getPath('project') + '/package.json';// jshint ignore:line
+var dependencies = JSON.parse(fs.readFileSync(dependenciesPath)).dependencies;// jshint ignore:line
 if ( dependencies.couchbase ) {
-    version = JSON.parse(fs.readFileSync(GINA_FRAMEWORK_DIR + '/package.json')).dependencies.couchbase;
+    version = JSON.parse(fs.readFileSync(dependenciesPath)).dependencies.couchbase;// jshint ignore:line
     version = version.replace(/\^/, '').split(/\./)[0];
-} 
+}
 
-var filename = _(GINA_FRAMEWORK_DIR + '/core/connectors/couchbase/lib/session-store.v'+ version +'.js', true);
+var filename = _(GINA_FRAMEWORK_DIR + '/core/connectors/couchbase/lib/session-store.v'+ version +'.js', true);// jshint ignore:line
 if ( !fs.existsSync(filename) ) {
     console.warn('Couchbase session-store file not found: ', filename);
-    filename = filename = _(GINA_FRAMEWORK_DIR + '/core/connectors/couchbase/lib/session-store.v'+ version +'.js', true);
+    filename = filename = _(GINA_FRAMEWORK_DIR + '/core/connectors/couchbase/lib/session-store.v'+ version +'.js', true);// jshint ignore:line
     console.warn('Couchbase session-store will instead use: ', filename);
 }