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

package/framework/{v0.1.1-alpha.98 → v0.1.2-alpha.1}/lib/cmd/index.js

@@ -1,7 +1,7 @@
 'use strict';
 /**
- * Gina.Utils.cmd
- * Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+ * Gina.Lib.cmd
+ * Copyright (c) 2009-2023 Rhinostone <contact@gina.io>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -37,7 +37,7 @@ cmd.setOption = function(option) {
             cmd.option[option[i].name] = option[i].content
         }
     } else {
-        cmd.option[options.name] = option.content
+        cmd.option[options.name] = option.content// jshint ignore:line
     }
 }
 
@@ -46,8 +46,8 @@ cmd.getString = function() {
         .toString()
         .replace(/,/g,' ')
         .replace(/node\s/g, 'gina ');
-        //.replace(/node/g, 'gina');    
-    
+        //.replace(/node/g, 'gina');
+
     var cmdArr = cmd.split('/');
     cmd = cmdArr[cmdArr.length-1];
     return cmd
@@ -71,14 +71,14 @@ cmd.getOptions = function() {
 
 
 cmd.onExec = function(client, isFromFramework, opt) {
-    
-    var console = lib.logger;
+
+    var console = lib.logger;// jshint ignore:line
     cmd.option = opt;
-        
-    var Proc = require( getPath('gina').lib + '/proc');
+
+    var Proc = require( getPath('gina').lib + '/proc');// jshint ignore:line
     var self = {};
 
-    cmd.msg = require( _(__dirname + '/framework/msg.json') );
+    cmd.msg = require( _(__dirname + '/framework/msg.json') );// jshint ignore:line
     self.isFromFramework = opt.isFromFramework || isFromFramework || false;
     self.isOnlineCommand = opt.isOnlineCommand || false;
 
@@ -93,38 +93,38 @@ cmd.onExec = function(client, isFromFramework, opt) {
 
     var init = null;
     if (self.isFromFramework) {
-        
+
         init = require('./framework/init')(opt);
         //Framework CMD.
         if (opt.task.action == 'start') {
-            // Current version of the framework by default 
+            // Current version of the framework by default
             // But can be overriden with argument: @{version_number}
             // eg.: gina stop @1.0.0
-            self.version = getEnvVar('GINA_VERSION');
+            self.version = getEnvVar('GINA_VERSION');// jshint ignore:line
             // checkcking version number
             if ( typeof(opt.argv[3]) != 'undefined' && /^@/.test(opt.argv[3]) ) {
                 var err = null;
-                var version = opt.argv[3].replace(/\@/, '');            
+                var version = opt.argv[3].replace(/\@/, '');
                 var shortVersion = version.split('.').splice(0,2).join('.');
                 if ( !/^\d\.\d/.test(shortVersion) ) {
                     err = new Error('Wrong version: '+ version);
                     console.log(err.message);
                     return;
                 }
-                var availableVersions = requireJSON(_(getEnvVar('GINA_HOMEDIR') +'/main.json', true)).frameworks[shortVersion];
+                var availableVersions = requireJSON(_(getEnvVar('GINA_HOMEDIR') +'/main.json', true)).frameworks[shortVersion];// jshint ignore:line
                 if ( availableVersions.indexOf(version) < 0 ) {
                     err = new Error('Version not installed: '+ version);
                     console.log(err.message);
                     return;
                 }
-                
+
                 self.version = version;
             }
-            
+
             init.onComplete( function done(err, run){
                 console.debug('loading task `',  opt.task.topic +':'+ opt.task.action, '`');
-                
-                //Setting master process with its own PID file.                
+
+                //Setting master process with its own PID file.
                 cmd.proc = new Proc('gina-v' + self.version, process);
                 cmd.proc.setMaster(process.pid);
 
@@ -142,7 +142,7 @@ cmd.onExec = function(client, isFromFramework, opt) {
                 })
             })
         } else { // Offline CMD
-            init.onComplete( function done(err, run, opt){                
+            init.onComplete( function done(err, run, opt){
                 run(opt)
             })
         }
@@ -154,11 +154,11 @@ cmd.onExec = function(client, isFromFramework, opt) {
         }
         opt.task.topic  = arr[0];
         opt.task.action = arr[1];
-        
+
         console.debug('[ FRAMEWORK ] is starting online CLI '+ arr[0] +':'+arr[1]);
-        
+
         init = require('./framework/init')(opt);
-        init.onListen( function done(err, run, opt){            
+        init.onListen( function done(err, run, opt){
             run(opt, cmd)
         })
 

package/framework/v0.1.2-alpha.1/lib/cmd/port/inc/scan.js

@@ -0,0 +1,142 @@
+var net     = require('net');
+var console = lib.logger;
+/**
+ * Scan for available port between ranges
+ *
+ * @param {object} [opt]
+ *
+ * @callback cb
+ *  @param {object|bool} err
+ *  @param {array} ports
+ * */
+module.exports = function Scanner(opt, cb){
+
+    var defaultOptions = {
+        // default binding for localhost
+        // remote scan can be added later if needed (e.g: for remote setup)
+        host: '127.0.0.1',
+        // --start-port-from
+        startFrom: null,
+        start: 3100,
+        // max 65535, but user assigned == 49151 - see [RFC6335](https://www.rfc-editor.org/rfc/rfc6335.html)
+        end: null,
+        maxEnd: 49151,
+        timeout: 2000,
+        ignore: [],
+        limit: 1
+    };
+
+    if ( arguments.length < 2 ) {
+        console.warn('[SCAN] No options defined for your scan');
+        cb  = opt;
+        opt = defaultOptions;
+    } else {
+        opt = merge(opt, defaultOptions)
+    }
+    if (opt.startFrom) {
+        opt.startFrom = ~~opt.startFrom;
+        if (opt.start < opt.startFrom ) {
+            opt.start = opt.startFrom;
+        }
+    }
+    opt.end = (~~(opt.start)+899) // Shouldn't it be opt.limit+1 ?
+
+    // Just in case
+    opt.end = ~~(opt.end);
+    opt.ignore.sort();
+
+    console.debug('[SCAN] Init with options: ', opt);
+
+    var self    = opt
+        , port  = ~~self.start
+        , ports = []
+        , total = ~~opt.limit
+    ;
+
+    var find = function(port, cb) {
+
+        // Not available port found
+        if (port > self.end) {
+            console.warn('[SCAN] Found '+ ports.length +'/'+ total);
+            var err = new Error('[SCAN] Maximum port number reached: '+ self.end);
+            cb(err);
+            return;
+        }
+
+        // Skip port present in the `ignore list`
+        if ( opt.ignore.length > 0 && opt.ignore.indexOf( ''+port ) > -1 ) {
+            port++;
+            return find(port, cb);
+        }
+
+        // Creating socket
+        var s = new net.Socket();
+
+        // Starting connection
+        s.connect(port, self.host);
+
+        // Just in case
+        s.setTimeout(opt.timeout);
+        s.on('timeout', function() {
+            var err = new Error('[SCAN] '+ self.timeout +' timeout reached');
+            s.destroy(err);
+            cb(err)
+        });
+
+
+        // No one is listening ... port is available
+        s.on('error', function(err) {
+            s.destroy();
+            // Silently catch all errors - assume the port is closed => available for use
+            if ( /ECONNREFUSED/i.test(err.message) ) {
+                if ( !opt.ignore.length || opt.ignore.length > 0 && opt.ignore.indexOf( port ) == -1 ) {
+                    // ports.push(''+port);
+                    ports.push(port);
+                    ports.sort();
+                    console.debug('[SCAN] Available port found '+ port +' ['+ ports.length +'/'+ total +']');
+                    opt.limit--;
+                }
+
+                if (opt.limit <= 0) {
+                    cb(false, ports);
+                } else {
+                    port++;
+                    find(port, cb);
+                }
+                return;
+            }
+
+            if ( err instanceof AggregateError ) {
+                var error = '', errors = err.errors;
+                for (let i=0, len=errors.length; i<len; i++) {
+                    if (/\:\:1/.test(errors[0]) ) {
+                        error = '\n[SCAN] You shoud check your host definition: use local IP like `127.0.0.1` instead of `localhost`'
+                        break;
+                    }
+                    error += '\n[SCAN] '+ errors[0].stack;
+                }
+                // console.warn('[SCAN] Errors:\n'+ error);
+
+                cb( new Error(error) );
+
+                error = null;
+                return;
+            }
+
+            console.warn('[SCAN] Exeption not handled: '+ err);
+            cb(err);
+
+            return;
+        });
+
+        // If connection is made, this only means that service is using it
+        s.on('connect', function() {
+            s.destroy();
+
+            port++;
+            find(port, cb);
+        })
+    };
+
+    find(port, cb)
+}