gina 0.1.1-alpha.157 → 0.1.1-alpha.159

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+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

package/README-4Contributors.md

@@ -68,9 +68,22 @@ Check if everything is working fine
 gina version
 ```
 
+Starting the framework
+
 ```tty
 gina start
 ```
+Or in debug mode 
+
+```tty
+gina start --inspect-gina
+```
+
+Retrieve logs
+
+```tty
+gina tail --keep-alive
+```
 
 #### Setting the framework default environment
 
@@ -88,6 +101,23 @@ This only means that if you omit the env in the command line while trying to sta
 > __NB:__ Unlike for the projects `envs`, the framework env list cannot be changed; it is `dev` or `prod`.
 
 
+### Debugging
+
+#### Framework
+```tty
+gina start --inspect-gina
+```
+
+#### Bundles
+
+> gina bundle:restart {bundle_name} @${project_name} --inspect=<port_number>
+
+```tty
+gina bundle:restart <bundle_name> @<project_name> --inspect=<port_number>
+```
+
+
+
 ### Publishing
 ---
 

package/README.md

@@ -1,13 +1,14 @@
 # Gina
-[![GitHub version](https://badge.fury.io/gh/Rhinostone%2Fgina.svg)](https://badge.fury.io/gh/Rhinostone%2Fgina) [![npm version](https://badge.fury.io/js/gina.svg)](https://badge.fury.io/js/gina)
+
+[![GitHub version](https://badge.fury.io/gh/Rhinostone%2Fgina.svg)](https://badge.fury.io/gh/Rhinostone%2Fgina) [![npm version](https://badge.fury.io/js/gina.svg)](https://badge.fury.io/js/gina) [![node version](https://badge.fury.io/node/v/gina.svg)](https://badge.fury.io/node/v/gina)
 
 <strong>Gina I/O</strong> - Node.js MVC and Event Driven framework
 
 > This is a `preview release`. We are looking for people to help us test and improve `Windows` support.
 > Meanwhile, __Windows users__ can use Docker or an alternative to run Gina and their projects.
-> 
+>
 > Some commands or features might not work since the framework is still under development & testing
-> 
+>
 > We have some applications using the framework in production and we are improving our code in order to release the `1.0.0` version: which should come by the end of 2022. Thank you for your patience.
 
 ## Philosophy behind
@@ -25,6 +26,13 @@ Gina aims to be at the same time a framework, a deployment and monitoring enviro
 > For Microsoft Windows, you might have to run the command line with Administrator privileges.
 > For Linux & Mac OS X, __the use of `sudo` is discouraged.__
 
+#### Versions
+
+| versions | description |
+|--------|--------|
+| alpha       | Preview release: ==not recomanded for production==      |
+| latest       | Latest stable relase        |
+
 #### 1st method (prefered) - Custom PREFIX
 
 This will install Gina in the user's home directory avoiding at the same time the need to use `sudo` or the `root` user.
@@ -211,10 +219,10 @@ Please, note that you have 2 types of environments : one for the framework, and
 
 > By default, Gina (the framework) comes with 2 environments : `dev` and `prod`. The default is `prod`. if you are [contributing](./README-4Contributors.md) to the framework or prototyping your application or service, we advise using the `dev` environment.
 > ```tty
-> gina framework:set --env=dev 
+> gina framework:set --env=dev
 > ```
 > ```tty
-> gina framework:set --log-level=debug 
+> gina framework:set --log-level=debug
 > ```
 
 You can check which are the environments set for your projects
@@ -291,7 +299,7 @@ gina tail
 __NB.:__ This is an alias for `gina framework:tail`
 > __Attention__
 > Everytime a bundle exits, the tail process will be closed. To prevent tail from exiting, you can use the `--keep-alive` argument.
-> E.g.: `gina tail --keep-alive` 
+> E.g.: `gina tail --keep-alive`
 
 By default, Gina does not store logs. Logs are treated like any other events then printed out to the `process.stdout`.
 
@@ -306,11 +314,11 @@ __2nd Method - Old school way__
 > __Attention: __ You will have to handle yourself [log rotation](https://linux.die.net/man/8/logrotate)
 
 ```tty
-gina bundle:start frontend @myproject --log > /usr/local/var/log/gina/frontend.myproject.domain.log 2>&1
+gina bundle:start frontend @myproject --log > /usr/local/var/log/gina/frontend.myproject.app.log 2>&1
 ```
 You can now check
 ```tty
-tail - f /usr/local/var/log/gina/frontend.myproject.domain.log
+tail - f /usr/local/var/log/gina/frontend.myproject.app.log
 ```
 
 __3rd Method - Create your own container/transport by extending gina default container__
@@ -351,13 +359,17 @@ gina framework:set --log-level=debug
 ## HTTPS, HTTP/2 and certificates
 
 ### Installing a certificate
+
+> __Attention__
+> ==One certificate per bundle/service==
+
 You now want to install a certificate for your project in order to run your project with HTTPS scheme or with HTTP/2 protocol ?
-At this moment, Gina does not generate a cetificate for you, but you can use a service like [sslforfree](https://www.sslforfree.com) to genreate a free 90 days certificate, then install it into your Gina home directory depending on the scope of your host (targeted machine: local or production). 
+At this moment, Gina does not generate a cetificate for you, but you can use a service like [sslforfree](https://www.sslforfree.com) to genreate a free 90 days certificate, then install it into your Gina home directory depending on the scope of your host (targeted machine: local or production).
 [SSL For Free](https://www.sslforfree.com) will provide you with a folder named with the domain you have used to setup your certificate. You just need to paste its content into the right location.
 
 The directory should be located @`~/.gina/certificates/scopes`.
 By default, `local` scope is set. But when you will go live, you should set the scope to production and paste your certificate into the right folder.
-__E.g:__ The `myproject.domain` folder should be placed into:
+__E.g:__ The `frontend.myproject.app` folder should be placed into:
 - `~/.gina/certificates/scopes/local` for your dev host
 - `~/.gina/certificates/scopes/production` for you production host
 
@@ -401,10 +413,10 @@ Error: unable to get issuer certificate
     at TLSSocket.onConnectSecure (node:_tls_wrap:1530:34)
     at TLSSocket.emit (node:events:390:28)
     at TLSSocket._finishInit (node:_tls_wrap:944:8)
-    at TLSWrap.ssl.onhandshakedone (node:_tls_wrap:725:12) 
+    at TLSWrap.ssl.onhandshakedone (node:_tls_wrap:725:12)
 ```
 
-Do not panic, and follow the steps provided in the following section.
+Do not panic, and follow the steps to solve this issue are provided in the following section.
 
 ### Local scope & certificate consideration
 > __Ignore__ the following instructions __if you can start your application__ without any certificate errors.
@@ -414,12 +426,12 @@ Since in most cases you will not have the `Root Certificate` included in your ce
 
 __Attention:__ We are assuming that for the following example, you have a wildcard certificate. If this is not possible, you will have to generate a certificate for each bundle and treat each bundle like a subdomain.
 
-Let say that you have downloaded your certificates from __[Ssl For Free](https://sslforfree.com)__ which you have then placed under: `~/.gina/certificates/scopes/local/myproject.domain`.
+Let say that you have downloaded your certificates from __[Ssl For Free](https://sslforfree.com)__ which you have then placed under: `~/.gina/certificates/scopes/local/frontend.myproject.app`.
 
 __Step 1__
 Go to the folder
 ```tty
-cd ~/.gina/certificates/scopes/local/myproject.domain
+cd ~/.gina/certificates/scopes/local/frontend.myproject.app
 ```
 
 List your files
@@ -443,11 +455,11 @@ Go to the `Generate the Correct Chain` tool.
 Paste the content you have just copied out of your `certificate.crt` into the field, then __do not forget to check the option__ `Include Root Certificate`.
 
 __It will download a chained certificate__.
-Rename it to `certificate.chained+root.crt` and copy/paste the file to your certificates location (~/.gina/certificates/scopes/local/myproject.domain)
+Rename it to `certificate.chained+root.crt` and copy/paste the file to your certificates location (~/.gina/certificates/scopes/local/frontend.myproject.app)
 
 __Step 2__
 You now need to combine your private key with your new certificate
-Still @ `~/.gina/certificates/scopes/local/myproject.domain` ?
+Still @ `~/.gina/certificates/scopes/local/frontend.myproject.app` ?
 
 ```tty
 cat private.key certificate.chained+root.crt > certificate.combined.pem
@@ -472,6 +484,13 @@ Do this for all of you `myproject`'s bundles, then restart your bundles
 gina bundle:restart @myproject
 ```
 
+__Remember__
+You will need a certificate for each bundle/service, unless you get a `wildcard certificates`.
+If you have a  `wildcard certificates`, you only need to follow the folling steps once, then create a symling for each bundle/service to the main certificate.
+
+```tty
+ln -s ~/.gina/certificates/scopes/local/myproject.app ~/.gina/certificates/scopes/local/frontend.myproject.app
+```
 
 ### Uninstalling Gina
 
@@ -540,7 +559,7 @@ More documentation and tutorials are coming soon !
 
 ## License (MIT)
 
-Copyright © 2009-2022 [Rhinostone](http://www.rhinostone.com/)
+Copyright © 2009-2023 [Rhinostone](http://www.rhinostone.com/)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/bin/cli

@@ -12,6 +12,8 @@ async function onExec() {
     // process.stdout.write('GINA CLI LOADED !! ' + JSON.stringify(process.argv, null, 2) + '\n');
 
     var isWin32         = (process.platform === 'win32') ? true : false;
+    var arch            = process.arch;
+    var platform        = process.platform;
     var binPath         = __dirname;
     var ginaPath        = (binPath.replace(/\\/g, '/')).replace('/bin', '');
     ginaPath = (isWin32) ? ginaPath.replace(/\//g, '\\') : ginaPath;
@@ -42,6 +44,7 @@ async function onExec() {
 
         // catching debug|inspect arg
         //process.stdout.write('params '+ params.join(', ') + '\n');
+
         if ( params.length > 0 ) {
             for (var p = 0, len = params.length; p < len; ++p) {
 
@@ -80,7 +83,7 @@ async function onExec() {
                     continue;
                 }
 
-                if ( /^\-\-(inspect|debug)/.test(params[p]) ) {
+                if ( /^\-\-(inspect|debug)/.test(params[p]) && !/^\-\-(inspect|debug)-gina/.test(params[p]) ) {
                     debugBrkEnabled = ( /\-brk/.test(params[p]) ) ? true : false;
                     debugPort       = params[p].split(/\=/)[1];
                     params.splice(p,1);
@@ -117,9 +120,21 @@ async function onExec() {
         setEnvVar('GINA_ENV', settings['env']);// jshint ignore:line
 
         // prior to what settings says
-        if (hostname != settings['hostname'] && !isUpdateRequired) {
-            setEnvVar('GINA_TMPDIR', settings['hostname']);// jshint ignore:line
+        if ( !settings['arch'] ) {
+            settings['arch'] = arch;
+            setEnvVar('GINA_ARCH', settings['arch']);// jshint ignore:line
+            isUpdateRequired = true;
+        }
+        if ( !settings['platform'] ) {
+            settings['platform'] = platform;
+            setEnvVar('GINA_PLATFORM', settings['platform']);// jshint ignore:line
+            isUpdateRequired = true;
+        }
+
+        if (hostname != settings['hostname'] /**&& !isUpdateRequired*/) {
+            setEnvVar('GINA_HOSTNAME', settings['hostname']);// jshint ignore:line
             hostname = settings['hostname'];
+            isUpdateRequired = true;
         }
         hostV4 = getEnvVar('GINA_HOST_V4') || settings['host_v4'] || '127.0.0.1';// jshint ignore:line
         mqPort = getEnvVar('GINA_MQ_PORT')|| settings['mq_port'] || 8125;// jshint ignore:line
@@ -201,6 +216,8 @@ async function onExec() {
     }
     if (isUpdateRequired) {
         console.debug('Updating debug settings ...');// jshint ignore:line
+        settings['arch'] = getEnvVar('GINA_ARCH') || settings['arch'] || null;// jshint ignore:line
+        settings['platform'] = getEnvVar('GINA_PLATFORM') || settings['platform'] || null;// jshint ignore:line
         settings['port'] = getEnvVar('GINA_PORT') || settings['port'] || null;// jshint ignore:line
         settings['debug_port'] = getEnvVar('GINA_DEBUG_PORT') || settings['debug_port'] || null;// jshint ignore:line
 
@@ -255,20 +272,25 @@ async function onExec() {
             && process.argv[2] === 'framework:start'
     ) {
 
-        //Start framework || launch online CMD.
-        require(binPath + '/cmd')({
-            binPath         : binPath,
-            ginaPath        : ginaPath,
-            frameworkPath   : frameworkPath,
-            homedir         : home,
-            port            : port,
-            hostV4          : hostV4,
-            mqPort          : mqPort,
-            hostname        : hostname,
-            debugPort       : debugPort,
-            debugBrkEnabled : debugBrkEnabled,
-            pack            : pack
-        });
+        try {
+            //Start framework || launch online CMD.
+            require(binPath + '/cmd')({
+                binPath         : binPath,
+                ginaPath        : ginaPath,
+                frameworkPath   : frameworkPath,
+                homedir         : home,
+                port            : port,
+                hostV4          : hostV4,
+                mqPort          : mqPort,
+                hostname        : hostname,
+                debugPort       : debugPort,
+                debugBrkEnabled : debugBrkEnabled,
+                pack            : pack
+            });
+        } catch (err) {
+            console.err(err)
+        }
+
 
 
     } else if (
@@ -298,7 +320,8 @@ async function onExec() {
     ) {
         // check allowedOffline ;)
         process.argv.splice(0,2);
-        console.error( '[ $ gina ' + process.argv.join(' ') + ' ] is not a valid command line' )
+        console.error( '[ $ gina ' + process.argv.join(' ') + ' ] is not a valid command line' );
+        process.exit(1)
     } else {
 
         //Connect to framework.

package/bin/cli-debug

@@ -8,6 +8,8 @@
  */
 const fs    = require('fs');
 const {exec} = require('child_process');
+const {execSync}   = require('child_process');
+const {spawn}   = require('child_process');
 const os    = require('os');
 
 var isWin32 = function() {
@@ -15,9 +17,9 @@ var isWin32 = function() {
 }
 
 var argv = process.argv.splice(2);
-argv = argv.join(' ');
+var argvStr = argv.join(' ');
 
-console.log('running: gina ' + argv );
+console.log('running: gina ' + argvStr );
 
 // fetching config
 var homeDir = (process.env[(isWin32()) ? 'USERPROFILE' : 'HOME'] );
@@ -30,9 +32,9 @@ version = version.splice(0, 2).join('.');
 var settings = require(homeDir + ((isWin32()) ? '\\' + version + '\\settings.json' : '/' + version +'/settings.json'));
 
 var debugPort = null;
-var params = argv.split(/\s+/g);
+var params = argvStr.split(/\s+/g);
 if ( params.length > 0 ) {
-    for (var p = 0, len = params.length; p < len; ++p) {
+    for (let p = 0, len = params.length; p < len; ++p) {
         if ( /^\-\-port/.test(params[p]) ) {
             setEnvVar('GINA_PORT', ~~params[p].split(/\=/)[1]);// jshint ignore:line
             continue;
@@ -41,20 +43,49 @@ if ( params.length > 0 ) {
             setEnvVar('GINA_DEBUG_PORT', ~~params[p].split(/\=/)[1]);// jshint ignore:line
             continue;
         }
-        if ( /^\-\-(inspect|debug)/.test(params[p]) ) {
-            debugPort = ~~params[p].split(/\=/)[1];
-            process.argv.splice(p,1);
+        if ( /^\-\-(inspect|debug)\-gina/.test(params[p]) ) {
+            debugPort = ~~params[p].split(/\=/)[1] || null;
+
+            argv.splice(argv.indexOf('--inspect-gina'), 1);
+            Array.prototype.splice.call(process.argv, argv.indexOf('--inspect-gina'), 1);
+            argvStr = argv.join(' ');
         }
     }
 }
 
-// gina defaullt debug port
+// gina default debug port
 debugPort = (debugPort != null) ? debugPort : '--inspect-brk=' + settings.debug_port;
-console.log('You should now start debug on port #'+ settings.debug_port);
-exec('node ' + debugPort +' '+ __dirname +'/cli ' + argv, (error, stdout, stderr) => {
-    if (error) {
-        console.error(`exec error: ${error}`);
-        return;
+
+// console.debug('OK ? ', 'node ' + debugPort +' '+ __dirname +'/cli ' + argvStr);
+// console.debug('\r\nDebugger attached.');
+console.log('\nYou should now start debug on port #'+ settings.debug_port +' before doing anything else ...');
+
+var nodeBin         = execSync('which node').toString().trim();
+var cliBin          = __dirname + '/cli';
+
+argv.splice(0, 0, debugPort);
+argv.splice(1, 0, cliBin);
+
+// console.debug('node ' + debugPort +' '+ __dirname +'/cli ' + argvStr);
+// console.debug('debugPort ', debugPort);
+// console.debug('argvStr ', argvStr);
+// console.debug('argv ', argv);
+
+var child = spawn(nodeBin, argv,
+    {
+        detached: true
     }
-    console.log(`${stdout}`);
-});
+);
+
+// set encoding
+child.stdout.setEncoding('utf8');
+child.stdout.on('data', function(data) {
+    process.stdout.write(data);
+});
+
+// when an exception is thrown, it is sent to the client
+child.stderr.setEncoding('utf8');
+child.stderr.on('data', function(data) {
+    process.stdout.write(data)
+});
+// exit is handle by the parent process

package/bin/gina

@@ -40,6 +40,7 @@ function runAsSubProcess() {
     var fakeDaemonPid   = '--fake-daemon-pid='+ process.pid;
 
     if ( argv.indexOf('--inspect-gina') > -1 ) {
+
         cliBin  = __dirname + '/cli-debug';
         argv.splice(argv.indexOf('--inspect-gina'), 1);
         // removing `--inspect-gina`
@@ -113,6 +114,8 @@ function runAsSubProcess() {
             process.exit(0);
         }
 
+        // console.debug('[gina][runAsSubProcess]', data);
+
     });
 
     //when an exception is thrown, it is sent to the client
@@ -129,7 +132,7 @@ function runAsSubProcess() {
 
     //  TODO - Remove this, we should be able to check the logs in case of troubles
     child.on('exit', function(code, signal) {
-        // handles only signals that cannot be cannot be caught or ignored
+        // handles only signals that cannot be caught or ignored
         // ref.: `framework/<version>/lib/proc.js`
         if (/(SIGKILL|SIGSTOP)/i.test(signal)) {
             console.emerg('[' + this.pid + '] exiting with signal: ', signal);
@@ -177,8 +180,10 @@ function runCMD() {
     var cliBin  = __dirname + '/cli';
     if ( argv.indexOf('--inspect-gina') > -1 ) {
         cliBin  = __dirname + '/cli-debug';
-        argv.splice(argv.indexOf('--inspect-gina'), 1);
-        Array.prototype.splice.call(process.argv, argv.indexOf('--inspect-gina'), 1);
+
+        // TODO - Remove this, not needed anymore since 2023-01-07 debug fix
+        // argv.splice(argv.indexOf('--inspect-gina'), 1);
+        // Array.prototype.splice.call(process.argv, argv.indexOf('--inspect-gina'), 1);
     }
     require(cliBin);
 }

package/framework/{v0.1.1-alpha.157/lib/inherits → v0.1.1-alpha.159}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+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

package/framework/v0.1.1-alpha.159/VERSION

@@ -0,0 +1 @@
+0.1.1-alpha.159