gina 0.1.1-alpha.99 → 0.1.2-alpha.1

package/framework/{v0.1.1-alpha.99 → v0.1.2-alpha.1}/core/router.js

@@ -1,7 +1,7 @@
 //"use strict";
 /*
  * This file is part of the gina package.
- * Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+ * Copyright (c) 2009-2023 Rhinostone <contact@gina.io>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -10,13 +10,10 @@
 
 //Imports.
 var fs                = require('fs')
-    
     , lib               = require('./../lib')
     , console           = lib.logger
     , inherits          = lib.inherits
     , merge             = lib.merge
-    , routing           = lib.routing
-    
     , SuperController   = require('./controller')
     , Config            = require('./config')
 ;
@@ -30,10 +27,10 @@ var fs                = require('fs')
  * @author      Rhinostone <contact@gina.io>
  * @api         Public
  */
-function Router(env) {
+function Router(env, scope) {
 
     this.name = 'Router';
-    
+
     var self = this
         , local = {}
     ;
@@ -43,19 +40,19 @@ function Router(env) {
      * @constructor
      * */
     var init = function() {
-        
+
         if ( typeof(Router.initialized) != "undefined" ) {
             return self.getInstance()
-        } else {
-            self.initialized = true;
-            self.hasCompletedControlllerSetup = false; 
         }
+
+        self.initialized = true;
+        self.hasCompletedControlllerSetup = false;
     }
-    
+
     var isSetupRequired = function(control) {
-        
+
         if (local.isXMLRequest) return false;
-        
+
         return ([
             'redirect',
             'query',
@@ -64,7 +61,7 @@ function Router(env) {
             'downloadFromURL'
         ].indexOf(control) < 0 ) ? true : false;
     }
-    
+
     this.getInstance = function() {
         return self
     }
@@ -74,28 +71,28 @@ function Router(env) {
      *  - {core}/controller/controller.js
      */
     var refreshCoreDependencies= function() {
-        
+
         var corePath    = getPath('gina').core;
-        
+
         // Super controller
         delete require.cache[require.resolve(_(corePath +'/controller/controller.js', true))];
         delete require.cache[require.resolve(_(corePath +'/controller/index.js', true))];
         require.cache[_(corePath +'/controller/controller.js', true)] = require( _(corePath +'/controller/controller.js', true) );
         require.cache[_(corePath +'/controller/index.js', true)] = require( _(corePath +'/controller/index.js', true) );
-        
+
         SuperController = require.cache[_(corePath +'/controller/index.js', true)];
     }
-    
+
     this.setServerInstance = function(serverInstance) {
         serverInstance._http2streamEventInitalized = false;
         self.serverInstance = serverInstance;
     }
-    
+
     this.getServerInstance = function () {
         return self.serverInstance;
     }
 
-   
+
     /**
      * Route on the fly
      *
@@ -106,25 +103,89 @@ function Router(env) {
      * @callback next
      * */
     this.route = function(request, response, next, params) {
-        
+
+        /**
+         * Sample code to detect memory leaks before Router::route()
+         */
+        // response.end(JSON.stringify({ status: 'ok'}));
+        // request     = null;
+        // response    = null;
+        // params      = null;
+        // if (next) {
+        //     return next()
+        // }
+        // return ;
+
+        /**
+        * ExpressJS modules + HTTP2 fix
+        * Hack required until `express-<plugin>` get support for http2 `express-session`
+        * or similar modules
+        */
+        if (!response._implicitHeader) {
+            response._implicitHeader = function(){ return; }; // we need to force it
+        }
+
+        /**
+        * EO Passport JS HTTP2 fix
+        */
+
         /**
         * BO Passport JS HTTP2 fix : taken from passport/request.js
         */
-       if ( typeof(request._passport) != 'undefined' && typeof(request.isAuthenticated) == 'undefined' ) {
+       if (
+            typeof(request._passport) != 'undefined'
+            && typeof(request.isAuthenticated) == 'undefined'
+            ||
+            typeof(request.session) != 'undefined'
+            && typeof(request.isAuthenticated) == 'undefined'
+       ) {
             request.isAuthenticated = function() {
                 var property = 'user';
-                if (this._passport && this._passport.instance) {
-                    property = this._passport.instance._userProperty || 'user';
+                // by default
+                var sess = this;
+                if (sess._passport && sess._passport.instance) {
+                    property = sess._passport.instance._userProperty || 'user';
+                }
+                if ( !sess._passport
+                    && typeof(sess.session) != 'undefined'
+                ) {
+                    sess = sess.session;
                 }
-                var isAuthenticated = (this[property]) ? true : false;
+
+                var isAuthenticated = (sess[property]) ? true : false;
                 if (isAuthenticated) {
-                    request.session.user = this[property]
+                    request.session.user = sess[property]
                 }
+                // if (isAuthenticated && typeof(request.session.user.cached) == 'undefined' ) {
+                //     request.session.user.cached = {}
+                // }
                 return isAuthenticated;
             };
         }
-        
-        if ( typeof(request._passport) != 'undefined' && (typeof(request.logIn) == 'undefined' || typeof(request.login) == 'undefined') ) {
+
+        // if (
+        //     typeof(request._passport) != 'undefined'
+        //     && typeof(request.isScopeAllowed) == 'undefined'
+        // ) {
+        //     request.isScopeAllowed = function() {
+        //         var property = 'scope';
+        //         if (this._passport && this._passport.instance) {
+        //             property = this._passport.instance._scopeProperty || 'scope';
+        //         }
+        //         var isScopeAllowed = (this[property]) ? true : false;
+        //         if (isScopeAllowed) {
+        //             request.session.scope = this[property]
+        //         }
+        //         return isScopeAllowed;
+        //     };
+        // }
+
+        if (
+            typeof(request._passport) != 'undefined'
+            && typeof(request.logIn) == 'undefined'
+            ||
+            typeof(request.login) == 'undefined'
+        ) {
             request.login =
             request.logIn = function(user, options, done) {
                 if (typeof options == 'function') {
@@ -132,70 +193,101 @@ function Router(env) {
                     options = {};
                 }
                 options = options || {};
-                
+
                 var property = 'user';
                 if (this._passport && this._passport.instance) {
                     property = this._passport.instance._userProperty || 'user';
                 }
                 var session = (options.session === undefined) ? true : options.session;
-                
+
                 this[property] = user;
-                if (session) {
-                    if (!this._passport) { throw new Error('passport.initialize() middleware not in use'); }
-                    if (typeof done != 'function') { throw new Error('req#login requires a callback function'); }
-                    
-                    var self = this;
-                    this._passport.instance._sm.logIn(this, user, function(err) {
-                    if (err) { 
+
+                if (!session) {
+                    done && done();
+                    return;
+                }
+
+
+                if (!this._passport) {
+                    throw new Error('passport.initialize() middleware not in use');
+                }
+                if (typeof done != 'function') {
+                    throw new Error('req#login requires a callback function');
+                }
+
+                var self = this;
+                this._passport.instance._sm.logIn(this, user, function(err) {
+                    if (err) {
                         self[property] = null;
-                        return done(err); 
+                        return done(err);
                     }
                     done();
-                    });
-                } else {
-                    done && done();
-                }
+                });
             };
         }
-        
-        if ( typeof(request._passport) != 'undefined' && (typeof(request.logOut) == 'undefined' ||  typeof(request.logout) == 'undefined') ) {
+
+        if (
+            typeof(request._passport) != 'undefined'
+            && typeof(request.logOut) == 'undefined'
+            ||
+            typeof(request.session) != 'undefined'
+            && typeof(request.logout) == 'undefined'
+        ) {
             request.logout =
             request.logOut = function() {
                 var property = 'user';
-                if (this._passport && this._passport.instance) {
-                    property = this._passport.instance._userProperty || 'user';
+
+                // by default
+                var sess = this;
+                if (sess._passport && sess._passport.instance) {
+                    property = sess._passport.instance._userProperty || 'user';
                 }
-                
-                this[property] = null;
-                if (this._passport) {
-                    this._passport.instance._sm.logOut(this);
+                if ( !sess._passport
+                    && typeof(sess.session) != 'undefined'
+                ) {
+                    sess = sess.session;
                 }
+
+                sess[property] = null;
+                if (sess._passport) {
+                    sess._passport.instance._sm.logOut(sess);
+                }
+
+
+                // if (this._passport && this._passport.instance) {
+                //     property = this._passport.instance._userProperty || 'user';
+                // }
+                // this[property] = null;
+                // if (this._passport) {
+                //     this._passport.instance._sm.logOut(this);
+                // }
             };
         }
-        
+
         // for redirect with `hidden inheritedData`
-        if ( /get/i.test(request.method) && typeof(request.session) != 'undefined' ) {
+        if ( /^get$/i.test(request.method) && typeof(request.session) != 'undefined' ) {
             var userSession = request.session.user || request.session;
             if ( typeof(userSession.inheritedData) != 'undefined' ) {
                 if (!request.get) {
                     request.get = {};
                 }
                 request.get = merge(request.get, userSession.inheritedData);
-                
+
                 // if not persisted ... means that if you refresh the current page, `inheritedData` will be lost
                 delete userSession.inheritedData;
             }
         }
-        
+
         /**
         * EO Passport JS HTTP2 fix
         */
-       
+
        var serverInstance   = self.getServerInstance();
        var config               = null
             , conf              = null
             , bundle            = null
             , env               = null
+            , scope             = null
             , cacheless         = (/^true$/i.test(process.env.NODE_ENV_IS_DEV)) ? true : false
        ;
         try {
@@ -214,37 +306,38 @@ function Router(env) {
             }
             bundle      = local.bundle = params.bundle;
             env         = config.env;
-            conf        = config[bundle][env];            
-        } catch (configErr) {            
+            scope       = config.scope;
+            conf        = config[bundle][env];
+        } catch (configErr) {
             serverInstance.throwError(response, 500, new Error('syntax error(s) found in `'+ controllerFile +'` \nTrace: ') + (configErr.stack || configErr.message) );
             return;
-        }  
-        
+        }
+
         local.cacheless     = cacheless;
         local.request       = request;
         local.next          = next;
         local.conf          = conf;
-        local.isStandalone  = conf.isStandalone;     
-        
+        local.isStandalone  = conf.isStandalone;
+
         if (cacheless) {
             refreshCoreDependencies();
         }
-                       
+
 
         var action          = request.control = params.param.control;
         // more can be added ... but it will always start by `on`Something.
         var reservedActions = [
             'onReady',
             'setup'
-        ];        
-        
-        
+        ];
+
+
         if (reservedActions.indexOf(action) > -1) {
             serverInstance.throwError(response, 500, '[ this.'+action+' ] is reserved for the framework');
             return;
         }
-            
-        
+
+
         // Routing object
         var routerObj = {
             response                    : response,
@@ -256,21 +349,21 @@ function Router(env) {
         };
 
         setContext('router', routerObj);
-        
+
         var middleware      = params.middleware || [];
         var actionFile      = params.param.file || null; // matches rule name
         var namespace       = params.namespace;
         var routeHasViews   = routerObj.hasViews;
         var isUsingTemplate = conf.template;
-        var hasSetup        = false;        
-        
-        
+        var hasSetup        = false;
+
+
         local.isXMLRequest      = params.isXMLRequest;
         local.isWithCredentials = params.isWithCredentials;
         local.routeHasViews     = routeHasViews;
         local.isUsingTemplate   = isUsingTemplate;
-        
-            
+
+
         //Getting superCleasses & extending it with super Models.
         var mainControllerFile          = conf.bundlesPath +'/'+ bundle + '/controllers/controller.js'
             , controllerFile            = null
@@ -280,15 +373,15 @@ function Router(env) {
             , hasControllerNamespace    = (namespace) ? true : false
         ;
 
-        // TODO -  ?? merge all controllers into a single file while building for other env than `dev`
+        // TODO -  ?? Merge all controllers into a single file while building for other env than `dev`
 
         setupFile = conf.bundlesPath +'/'+ bundle + '/controllers/setup.js';
         var filename = '';
         if (hasControllerNamespace) {
             filename = conf.bundlesPath +'/'+ bundle + '/controllers/controller.'+ namespace +'.js';
-            if ( !fs.existsSync(filename) ) {                
+            if ( !fs.existsSync(filename) ) {
                 hasControllerNamespace = false;
-                console.warn('Namespace `'+ namespace +'` found, but no related controller file found at `'+filename+'` to load: just ignore this message if this is ok with you');                
+                console.warn('Namespace `'+ namespace +'` found, but no related controller file found at `'+filename+'` to load: just ignore this message if this is ok with you');
                 filename = conf.bundlesPath +'/'+ bundle + '/controllers/controller.js';
                 console.info('Switching to default controller: '+ mainControllerFile);
             }
@@ -296,7 +389,7 @@ function Router(env) {
             filename = mainControllerFile;
         }
         controllerFile = filename;
-        
+
         /**
          * BO routing configuration
          * Attention: this portion of code is replicated in `form-validator.js`
@@ -307,7 +400,7 @@ function Router(env) {
             params.rule = params.name;
         }
         var templateName = params.rule.replace('\@'+ bundle, '') || '_common';
-             
+
         var options = {
             // view namespace first
             namespace       : (/controller\.js$/i.test(controllerFile)) ? null : params.param.namespace || namespace,
@@ -325,13 +418,15 @@ function Router(env) {
             path: params.param.path || null, // user custom path : namespace should be ignored or left blank
             assets: {}
         };
-               
+
         if (routeHasViews) {
             options.template = (routeHasViews) ? conf.content.templates[templateName] || conf.content.templates._common : undefined;
         }
 
         // Options need to be protected by a clone to allow overrides
         options = merge(JSON.clone(options), params);
+        // options = merge(options, params);
+
         // We want to keep original conf untouched
         options.conf = JSON.clone(conf);
         // inheriting from _common
@@ -340,7 +435,7 @@ function Router(env) {
             && typeof(options.template.ginaLoader) == 'undefined'
         ) {
             options.template.ginaLoader = options.conf.content.templates._common.ginaLoader;
-        }            
+        }
         options.conf.content.routing[options.rule].param = params.param;
         delete options.middleware;
         delete options.param;
@@ -375,8 +470,8 @@ function Router(env) {
             serverInstance.throwError(response, 500, new Error('syntax error(s) found in `'+ controllerFile +'` \nTrace: ') + (err.stack || err.message) );
             return;
         }
-        
-        
+
+
         // about to contact Controller ...
         try {
             if (hasControllerNamespace) {
@@ -385,13 +480,13 @@ function Router(env) {
             } else {
                 Controller      = inherits(Controller, SuperController);
             }
-            
-            
-            var controller  = new Controller(options);                        
-            controller.name = options.control;            
+
+
+            var controller  = new Controller(options);
+            controller.name = options.control;
             controller.serverInstance = serverInstance;
             controller.setOptions(request, response, next, options);
-            
+
             /**
              * requireController
              * Allowing another controller (public methods) to be required inside the current controller
@@ -400,7 +495,7 @@ function Router(env) {
              * @param {object} [options] - Controller options
              *
              * @returns {object} controllerInstance
-             * */            
+             * */
             var requireController = function (namespace, options) {
 
                 var cacheless   = (process.env.NODE_ENV_IS_DEV == 'false') ? false : true;
@@ -408,6 +503,7 @@ function Router(env) {
                 var config      = getContext('gina').Config.instance;
                 var bundle      = config.bundle;
                 var env         = config.env;
+                var scope       = config.scope;
                 var bundleConf  = config.Env.getConf(bundle, env);
 
                 var controllerFile  = ( typeof(namespace) != 'undefined' && namespace != '' && namespace != 'null' && namespace != null ) ? 'controller.'+ namespace : 'controller';
@@ -431,50 +527,48 @@ function Router(env) {
                     //}
 
                     var SuperController     = require.cache[_(corePath +'/controller/index.js', true)];
-                                        
-                    
+
+
                     var RequiredController  = require(filename);
 
                     RequiredController      = inherits(RequiredController, SuperController);
-                    
+
                     var controller = null;
                     if ( typeof(options) != 'undefined' ) {
 
                         controller = new RequiredController( options );
                         controller.name = namespace;
-                        
+
                         controller.setOptions(request, response, next, options);
 
                     } else {
                         controller = new RequiredController();
                     }
-                    
-                    controller.serverInstance = serverInstance;       
-                    
+
+                    controller.serverInstance = serverInstance;
+
                     controller.requireController = requireController;
-                                        
+
                     return controller;
                 } catch (err) {
                     return serverInstance.throwError(response, 500, err );
                 }
             };
-            
+
             controller.requireController = requireController;
 
             if (hasSetup && isSetupRequired(params.param.control) || hasSetup && !self.hasCompletedControlllerSetup ) { // adding setup
-                
+
                 controller.setup = function(request, response, next) {
                     if (!this._setupDone) {
                         this._setupDone = true;
                         return function (request, response, next) { // getting rid of the controller context
                             var Setup = require(_(setupFile, true));
 
-                            
-                            // Inheriting SuperController functions & objects                            
+
+                            // Inheriting SuperController functions & objects
                             // Exporting config & common methods
                             Setup.engine                = controller.engine;
-                            // This is working, but too heavy
-                            // TODO- Allow user to target selected methods to be exported
                             // TODO - loop on a defiend SuperController property like SuperController._allowedForExport
                             // for ( let f in controller) {
                             //     if ( typeof(controller[f]) != 'function' ) {
@@ -492,18 +586,19 @@ function Router(env) {
                             Setup.renderJSON            = controller.renderJSON;
                             Setup.renderWithoutLayout   = controller.renderWithoutLayout;
                             Setup.isXMLRequest          = controller.isXMLRequest;
-                            Setup.isWithCredentials     = controller.isWithCredentials,
+                            Setup.isWithCredentials     = controller.isWithCredentials;
+                            Setup.isPopinContext        = controller.isPopinContext;
                             Setup.isCacheless           = controller.isCacheless;
                             Setup.requireController     = controller.requireController;
-                            
+
 
                             Setup.apply(Setup, arguments);
 
                             return Setup;
                         }(request, response, next)
                     }
-                }    
-                
+                }
+
                 if ( !self.hasCompletedControlllerSetup )
                     self.hasCompletedControlllerSetup = true;
             } else {
@@ -513,10 +608,10 @@ function Router(env) {
 
 
             if (middleware.length > 0) {
-                processMiddlewares(middleware, controller, action, request, response, next,
+                processMiddlewares(serverInstance, middleware, controller, action, request, response, next,
                     function onDone(action, request, response, next){
                         // handle superController events
-                        for (var e=0; e<reservedActions.length; ++e) {
+                        for (let e=0; e<reservedActions.length; ++e) {
                             if ( typeof(controller[reservedActions[e]]) == 'function' ) {
                                 controller[reservedActions[e]](request, response, next)
                             }
@@ -539,7 +634,7 @@ function Router(env) {
             } else {
                 // handle superController events
                 // e.g.: inside your controller, you can defined: `this.onReady = function(){...}` which will always be called before the main action
-                for (var e=0; e<reservedActions.length; ++e) {
+                for (let e=0; e<reservedActions.length; ++e) {
                     if ( typeof(controller[reservedActions[e]]) == 'function' ) {
                         controller[reservedActions[e]](request, response, next)
                     }
@@ -553,22 +648,31 @@ function Router(env) {
                         serverInstance.throwError(response, 500, err.stack);
                     }
                     return;
-                }                
+                }
             }
 
+            // controller = null;
+            // Controller = null;
+            // MainController = null;
+
         } catch (err) {
             if ( typeof(controller) != 'undefined' && typeof (controller[action]) == 'undefined') {
                 serverInstance.throwError(response, 500, (new Error('control not found: `' + action + '`. Please, check your routing.json or the related control in your `' + controllerFile + '`.')).stack);
             } else {
                 serverInstance.throwError(response, 500, err.stack);
             }
+
+            // controller = null;
+            // Controller = null;
+            // MainController = null;
+
             return;
         }
 
         action = null
     };//EO route()
 
-    var processMiddlewares = function(middlewares, controller, action, req, res, next, cb){
+    var processMiddlewares = function(serverInstance, middlewares, controller, action, req, res, next, cb){
 
         var filename        = _(local.conf.bundlePath)
             , middleware    = null
@@ -576,7 +680,7 @@ function Router(env) {
             , re            = new RegExp('^'+filename);
 
         if ( middlewares.length > 0 ) {
-            for (var m=0; m<middlewares.length; ++m) {
+            for (let m=0; m<middlewares.length; ++m) {
                 constructor = middlewares[m].split(/\./g);
                 constructor = constructor
                     .splice(constructor.length-1,1)
@@ -590,13 +694,13 @@ function Router(env) {
                     serverInstance.throwError(res, 501, new Error('middleware not found '+ middleware).stack);
                     return;
                 }
-                
+
                 if (local.cacheless) delete require.cache[require.resolve(_(filename, true))];
 
                 var MiddlewareClass = function(req, res, next) {
 
                     return function () { // getting rid of the middleware context
-                        
+
                         var Middleware = require(_(filename, true));
                         // TODO - loop on a defined SuperController property like SuperController._allowedForExport
 
@@ -638,7 +742,7 @@ function Router(env) {
                         function onMiddlewareProcessed(req, res, next){
                             middlewares.splice(m, 1);
                             if (middlewares.length > 0) {
-                                processMiddlewares(middlewares, controller, action,  req, res, next, cb)
+                                processMiddlewares(serverInstance, middlewares, controller, action,  req, res, next, cb)
                             } else {
                                 cb(action, req, res, next)
                             }
@@ -654,11 +758,6 @@ function Router(env) {
         }
     };
 
-    // var hasViews = function() {
-    //     return local.routeHasViews;
-    // };
-
     init()
-};
-
-module.exports = Router
+}
+module.exports = Router;