gina 0.1.6-alpha.16 → 0.1.6-alpha.161

package/framework/{v0.1.6-alpha.16 → v0.1.6-alpha.161}/core/connectors/couchbase/index.js

@@ -1,12 +1,14 @@
 //"use strict";
 // Imports.
 var fs              = require('fs');
-const { version } = require('os');
+const { version }   = require('os');
 //var util            = require('util');
 //var promisify       = require('util').promisify;
 // Use couchbase module from the user's project dependencies if not found
 var couchbasePath   = _(getPath('project') +'/node_modules/couchbase');
 var couchbase       = require(couchbasePath);
+// globalized
+// N1qlQuery           = couchbase.N1qlQuery;
 
 var lib             = require('./../../../lib') || require.cache[require.resolve('./../../../lib')];
 var inherits        = lib.inherits;
@@ -32,7 +34,7 @@ function Couchbase(conn, infos) {
      * */
     var init = function(conn, infos) {
         // load on startup
-        var cacheless           = (process.env.NODE_ENV_IS_DEV == 'false') ? false : true;
+        var isCacheless         = (process.env.NODE_ENV_IS_DEV == 'false') ? false : true;
         var path                = getPath('bundle') + '/models/'+ infos.database +'/entities'
             , n1qlDefault       = __dirname + '/lib'
             , files             = fs.readdirSync(path)
@@ -46,7 +48,7 @@ function Couchbase(conn, infos) {
 
         // superEntity
         filename = getPath('gina').core + '/model/entity.js';
-        if (cacheless)
+        if (isCacheless)
             delete require.cache[require.resolve(_(filename, true))]; //EntitySuperClass
 
         EntitySuperClass = require(_(filename, true));
@@ -58,12 +60,12 @@ function Couchbase(conn, infos) {
 
             if ( ! /^\./.test(files[f]) || f == len-1 ) {
 
-                if (cacheless && files[f] != 'n1ql.js') {
+                if (isCacheless && files[f] != 'n1ql.js') {
                     delete require.cache[require.resolve(_(path + '/' +files[f], true))];//child
                 }
 
                 entityName      = files[f].replace(/.js/, '');
-                className       = entityName.substr(0,1).toUpperCase() + entityName.substr(1);
+                className       = entityName.substring(0,1).toUpperCase() + entityName.substring(1);
 
                 if ( files[f] == 'n1ql.js' ) {
                     Entity = require(_(n1qlDefault + '/' +files[f], true));
@@ -113,6 +115,7 @@ function Couchbase(conn, infos) {
         return entities
     };
 
+
     var loadN1QL = function(entities, filename, originalInfos) {
         var arr = null
             , entityName = null
@@ -185,6 +188,8 @@ function Couchbase(conn, infos) {
         var arr             = source.split(/\//g)
             , name          = altMethodName || arr[arr.length-1].replace(/\.sql/, '') || null
             , comments      = ''
+            , optionsArr    = null
+            , options       = null
             , queryString   = null
             , includes      = null
             , queryStatement= null // this is the usable queryString
@@ -216,7 +221,7 @@ function Couchbase(conn, infos) {
 
                     ) {
                         let dir = new _(source).toUnixStyle();
-                        dir = dir.substr(0, dir.lastIndexOf('/')) + '/'
+                        dir = dir.substring(0, dir.lastIndexOf('/')) + '/'
                         filename = _(dir + filename.replace(/^\.\//, ''), true);
                     }
                     // remove @include calls
@@ -224,6 +229,13 @@ function Couchbase(conn, infos) {
                     queryString = queryString.replace(includes[i], fs.readFileSync( filename ).toString() );
                 }
             }
+
+            optionsArr = queryString.match(/\@options \{(.*)\}/gm);
+            if (optionsArr) {
+                eval('options='+optionsArr[0].replace(/\@options\ /, ''));
+            }
+            optionsArr = null;
+
             paramTypes = queryString.match(/\@param \{(.*)\}/gm);
             if ( paramTypes && Array.isArray(paramTypes) ) {
                 for (let t=0, tLen = paramTypes.length; t<tLen; t++) {
@@ -282,7 +294,7 @@ function Couchbase(conn, infos) {
 
                     entities[entityName] = inherits(EntityN1qlClass, EntitySuperClass);
 
-                    entities[entityName].prototype.name           = entityName.substr(0,1).toUpperCase() + entityName.substr(1);
+                    entities[entityName].prototype.name           = entityName.substring(0,1).toUpperCase() + entityName.substring(1);
                     entities[entityName].prototype.model          = infos.model;
                     entities[entityName].prototype.bundle         = infos.bundle;
                     entities[entityName].prototype._collection    = entityName;
@@ -393,8 +405,12 @@ function Couchbase(conn, infos) {
                         }
                         // EO - patch
                     }
+                    queryStatement = queryStatement.replace(/^\s+/, '');
 
-                    var query = null, execQuery = null, _collection = null;
+                    var query           = null
+                        , execQuery     = null
+                        , _collection   = null
+                    ;
                     // adhoc option: @param {boolean} options.adhoc [ true | false ]
                     // default is set to false
                     //queryOptions.adhoc = false;
@@ -407,14 +423,14 @@ function Couchbase(conn, infos) {
                     //  number      : 1
                     //  description : This is the default (for single-statement requests).
                     //
-                    // Request plus
+                    // Request plus (Recommended for insert,read right after)
                     //  code        : REQUEST_PLUS
                     //  number      : 2
                     //  description : This implements strong consistency per request.
                     //                Update cycle every «20ms for memdb & 200ms for forestdb»
                     //
-                    // Statement plus
-                    //  code        : STATEMENT_PLUS
+                    // Statement plus (Not available on SDKv4)
+                    //  code        : STATEMENT_PLUS or AT_PLUS
                     //  number      : 3
                     //  description : This implements strong consistency per statement.
                     //                Update cycle every «20ms for memdb & 200ms for forestdb»
@@ -427,16 +443,61 @@ function Couchbase(conn, infos) {
                     var queryOptions = {
                         // Do not turn off the adhoc flag for each query since
                         // only a finite number of query plans (currently 5000) can be stored in the SDK
-                        adhoc: false, // false to use plan optimization, but need a statement `name param` or `num param`
-                        consistency: 1 // NOT_BOUNDED, but STATEMENT_PLUS is set by default for insert & update
+                        // false to use plan optimization, but need a statement `name param` or `num param`
+                        adhoc: false
                     };
 
+                    // NOT_BOUNDED, but REQUEST_PLUS should be set for SELECT operation following an INSERT or an UPDATE
+                    // starting from SDK v3
+                    var userConsistencyOpt = null;
+                    if ( sdkVersion > 2 ) {
+                        queryOptions.scanConsistency = couchbase.QueryScanConsistency.NotBounded;
+                        if (options && typeof(options.consistency) != 'undefined') {
+                            // request_plus -> RequestPlus
+                            userConsistencyOpt = options.consistency.replace(/(^[a-z]{0,1}|_[a-z]{0,1})/g, str => str.toUpperCase().replace(/\_/, ''));
+                            if ( typeof(couchbase.QueryScanConsistency[userConsistencyOpt]) != 'undefined' ) {
+                                queryOptions.scanConsistency = couchbase.QueryScanConsistency[userConsistencyOpt];
+                            } else {
+                                console.warn('couchbase.QueryScanConsistency['+ userConsistencyOpt +'] option is being ignore: might not be a real option or the optoins is not handled by your SDK.\nFound on: '+ queryStatement );
+                            }
+
+                            for (let o in options) {
+                                if (o == 'consistency') continue;
+                                queryOptions[o] = options[o];
+                            }
+                        }
+                    }
+                    // v2
+                    else {
+                        queryOptions.consistency = N1qlQuery.Consistency.NOT_BOUNDED;
+                        if (options && typeof(options.consistency) != 'undefined') {
+                            // request_plus -> REQUEST_PLUS
+                            userConsistencyOpt = options.consistency.toUpperCase();
+                            if ( typeof(N1qlQuery.Consistency[userConsistencyOpt]) != 'undefined' ) {
+                                queryOptions.consistency = N1qlQuery.Consistency[userConsistencyOpt];
+                            } else {
+                                console.warn('N1qlQuery.Consistency['+ userConsistencyOpt +'] option is being ignore: might not be a real option or the optoins is not handled by your SDK.\nFound on: '+ queryStatement );
+                            }
 
-                    if ( /^(insert|update)/i.test(statement) ) {
-                        queryOptions.adhoc = true;
-                        queryOptions.consistency = 3; // STATEMENT_PLUS
+                            for (let o in options) {
+                                if (o == 'consistency') continue;
+                                queryOptions[o] = options[o];
+                            }
+                        }
                     }
 
+
+                    // if ( /^(insert\ into|update)/i.test(queryStatement) ) {
+                    //     queryOptions.adhoc = true;
+                    //     if ( sdkVersion > 2 ) {
+                    //         queryOptions.scanConsistency = couchbase.QueryScanConsistency.RequestPlus;
+                    //     }
+                    //     // v2
+                    //     else {
+                    //         queryOptions.consistency = N1qlQuery.Consistency.REQUEST_PLUS;
+                    //     }
+                    // }
+
                     if ( sdkVersion > 2 ) { // starting from SDK v3
                         // _collection = queryStatement.match(/\_collection(\s+\=|=)(.*)(\'|\")/);
                         // if (_collection.length > 0) {
@@ -458,7 +519,7 @@ function Couchbase(conn, infos) {
 
                     } else { // version 2
                         // prepared statement
-                        query = N1qlQuery.fromString(queryStatement.replace(/^\s+/, ''));
+                        query = N1qlQuery.fromString(queryStatement);
                         // query options
                         // @param {object} options
                         // @param {string} options.sample
@@ -546,6 +607,14 @@ function Couchbase(conn, infos) {
                             err.stack   = '[ '+source+' ]\n'+ err.stack;
                         }
 
+                        if (err) {
+                            if ( typeof(self.emit) != 'undefined' ) {
+                                self.emit(trigger, err);
+                            } else { // Promise case
+                                throw new Error('[ Couchbase ][ onQueryCallback Exception] '+ trigger + '\n'+ err.stack)
+                            }
+                        }
+
                         // handle return type
                         if ( returnType && returnType == 'boolean' ) {
                             // CASE #1
@@ -615,7 +684,7 @@ function Couchbase(conn, infos) {
 
                     self._isRegisteredFromProto = false;
                     // `register()` is only used for v2
-                    var register = function (trigger, queryParams, onQueryCallback, cb) {
+                    var register = async function (trigger, queryParams, onQueryCallback, cb) {
                         // // JUNE 2021 patch
                         // // Adding support for FTS since it is not implemented in sdkVersion 2:
                         // // variables not replaced by value
@@ -654,6 +723,11 @@ function Couchbase(conn, infos) {
                             // }
 
                             if (sdkVersion > 2) {
+                                if ( /^true$/i.test(conn.useRestApi) ) {
+                                    conn._cluster.restQuery(trigger, query, queryParams, onQueryCallback);
+                                    return;
+                                }
+
                                 conn._cluster.query(query, queryParams)
                                     .catch( function onError(err) {
                                         try {
@@ -666,14 +740,17 @@ function Couchbase(conn, infos) {
                                     })
                                     .then( function onResult(data, meta) {
                                         try {
+                                            if ( typeof(data) == 'undefined' ) {
+                                                data = { rows: []}
+                                            }
                                             onQueryCallback(false, data.rows, data.meta);
                                         } catch (_err) {
                                             _err.stack = '[ ' + trigger + '] onQueryCallbackError: \n\t- Did you leave any bad comments ?\n\t- Did you try to run your query ?\r\n'+ query +'\r\n'+ _err.stack;
                                             console.error(_err.stack);
                                         }
                                     });
-                                    // Added on 2023-03-25
-                                    return;
+                                // Added on 2023-03-25
+                                return;
                             } else {
                                 conn.query(query, queryParams, onQueryCallback);
                             }
@@ -689,6 +766,10 @@ function Couchbase(conn, infos) {
                             // }
 
                             if (sdkVersion > 2) {
+                                if ( /^true$/i.test(conn.useRestApi) ) {
+                                    conn._cluster.restQuery(trigger, query, queryParams, onQueryCallback);
+                                    return;
+                                }
                                 conn._cluster.query(query, queryParams)
                                     .catch( function onError(err) {
                                         try {
@@ -701,7 +782,9 @@ function Couchbase(conn, infos) {
                                     })
                                     .then( function onResult(data) {
                                         try {
-                                            onQueryCallback(false, data.rows, data.meta);
+                                            let rows = (data && typeof(data.rows) != 'undefined') ? data.rows : [];
+                                            let meta = (data && typeof(data.meta) != 'undefined') ? data.meta : {};
+                                            onQueryCallback(false, rows, meta);
                                         } catch (_err) {
                                             console.error(_err.stack);
                                         }
@@ -792,10 +875,10 @@ function Couchbase(conn, infos) {
             var sdkVersion  = conn.sdk.version || 2;
             // by default
             var queryOptions = {
-                adhoc: true,
-                consistency: 3
+                adhoc: true
             };
 
+
             if ( typeof(options) != 'undefined' ) {
                 queryOptions = merge(options, queryOptions)
             }
@@ -822,18 +905,17 @@ function Couchbase(conn, infos) {
                 recCount++;
             }
 
-            queryString = queryString.substr(0, queryString.length-1);
+            queryString = queryString.substring(0, queryString.length-1);
             queryString += '\nRETURNING '+ this.database +'.*;';
 
 
             var query = null;
             if ( sdkVersion > 2) { // starting SDK v3
                 query = queryString;
-                // queryOptions.parameters = queryParams;
             } else {
                 // prepared statement
                 query = N1qlQuery.fromString(queryString);
-                query.consistency(queryOptions.consistency);
+                query.consistency(N1qlQuery.Consistency.REQUEST_PLUS);
                 // merge options
                 for (var qOpt in queryOptions) {
                     if ( typeof(query[ qOpt ]) == 'undefined' ) {