different fixes

Author: alexk-blackops

README.md

@@ -29,7 +29,7 @@ The following options could be passed. 'apiKey' is the only one that required:
 * __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false
 * __proxy:__ proxy server if you want to send requests via proxy.
 
-*Notice:* stackify-logger sends synchronous requests before any `process.exit()` calls in your code. Sending via proxy wouldn't be possible in this case.
+*Notice:* stackify-logger sends synchronous requests if you call `process.exit()`. Sending via proxy wouldn't be possible in this case.
 
 #### Using with Winston
 
@@ -62,8 +62,6 @@ stackify.error(message [, meta1, ... , metaN])
 
 **meta1 ... metaN** - a list of additional parameters of any type.
 
-The timestamp will be added to every message by default.
-
 Examples of usage:
 ```js
 // Add the module to all the script files where you want to log any messages.
@@ -75,33 +73,15 @@ stackify.info('any message', {anything: 'this is metadata'});
 stackify.warn('attention');
 stackify.log('error', {error : new Error()});
 ```
-When logging an error message you could pass an Error object in metadata like in the last case so the exception details would be available.
+When logging an error message you can pass an Error object in metadata like in the last example, so the exception details would be available.
 
 #### Exception handling
-By executing `stackify.start()` you set handler for uncaught exceptions.
-Be sure to run it before any methods that set exception handlers.
-
-##### Using with pure NodeJS app
-If you want to get web details of an exception to be sent with it you should run `stackify.exceptionHandler(req)` first line inside of native `createServer` method :
-
-```js
-var http = require('http');
-var stackify = require('stackify-logger');
-http.createServer(function (req, res) {
-    stackify.exceptionHandler(req);
-    res.setHeader('content-type', 'text/plain');
-    res.end('hello');
-  });
-});
-```
-where req is request object, an instance of native NodeJS `http.IncomingMessage` object
-
-You can use it also with any framework that doesn’t modify native createServer method.
-
+By executing `stackify.start()` you set a handler for uncaught exceptions.
+Make sure you run it before any methods that set exception handlers.
 
 ##### Using with Express
 Global handler doesn't work inside Express route methods.
-You should use error-handling middleware function `stackify.expressExceptionHandler`. Since middleware is executed serially, it's order of inclusion is important. Be sure to add it before any other error-handling middleware.
+You should use error-handling middleware function `stackify.expressExceptionHandler`. Since middleware is executed serially, it's order of inclusion is important. Make sure you add it before any other error-handling middleware.
 
 ```js
 var express = require('express');

config/config.js

@@ -14,7 +14,7 @@ module.exports = {
         QUEUE_CAP          : 10000,
         MIN_BATCH_SIZE     : 10,
         MAX_BATCH_SIZE     : 100,
-        MAX_DUP_ERROR_PER_MINUTE: 100, // Number of instances of a unique error that are allowed to be sent in one minute
+        MAX_DUP_ERROR_PER_MINUTE: 100, // number of instances of a unique error that are allowed to be sent in one minute
 
     },
     IDENTIFY_DELAY: 300000, // 5 minutes delay if identifyApp call failed

index.js

@@ -6,7 +6,7 @@ module.exports = {
     // start sending logs
     start: function (options) {
         api.methods.identifyApp(options);
-        exception.exceptionHandler(null, options.exitOnError);
+        exception.catchException(options.exitOnError || false);
         exception.gracefulExitHandler();
     },
 
@@ -16,9 +16,9 @@ module.exports = {
     info: logger.methods.info,
     warn: logger.methods.warn,
     error: logger.methods.error,
-
+    
+    //common method for handling logged messages
     push: logger.methods.push,
 
-    exceptionHandler: exception.exceptionHandler,
     expressExceptionHandler: exception.expressExceptionHandler
 };

lib/api.js

@@ -87,16 +87,15 @@ module.exports.methods = {
 
         sender.send(opt, cb, shutdown ? null : fail);
     },
-    /* 
-    *** posting logs synchronously in case if server is about to close *** 
+    /*
+    *** posting logs synchronously in case if server is about to close ***
     */
     postLogsSync: function postLogsSync(messages) {
         var options = {
             url: CONFIG.PROTOCOL + '://' + CONFIG.HOST + CONFIG.LOG_SAVE_PATH,
             headers : helpers.getHeaders(),
             data: helpers.getPostBody(messages)
         };
-        console.log(options);
         sender.sendSync(options);
     }
 };

lib/error.js

@@ -15,7 +15,8 @@ module.exports = {
     checkErrorLimitMessage : function checkErrorLimitMessage(ex) {
         var d = new Date(),
             min = d.getFullYear().toString() + d.getMonth().toString() + d.getDate().toString()
-                + d.getHours().toString() + d.getMinutes().toString();
+                + d.getHours().toString() + d.getMinutes().toString(),
+            key;
 
         if (!ex) {
             return true;

lib/exception.js

@@ -1,33 +1,23 @@
-var qs      = require('querystring'),
-
-    error   = require('./error'),
+var error   = require('./error'),
     logger  = require('./logger'),
     CONFIG  = require('../config/config');
 
 module.exports = {
     // flag used to prevent catching the same exception twice (inside and outside of the createServer method)
     excCaught : false,
-    // Pure Node apps exception catching
-    exceptionHandler : function exceptionHandler(req, exit) {
+
+    // General exception handler
+    catchException : function catchException(exit) {
         var self = this;
-        CONFIG.EXIT_ON_ERROR = CONFIG.EXIT_ON_ERROR || exit;
-        return (function () {
-            var body = '';
-            if (req) {
-                req.on('data', function (chunk) {
-                    body += chunk;
-                });
-                req.on('end', function () {
-                    var json = qs.parse(body);
-                    req.body = json;
-                });
-            }
 
+        CONFIG.EXIT_ON_ERROR = exit;
+
+        return (function () {
             process.on('uncaughtException', function (err) {
                 if (!self.excCaught) {
                     self.excCaught = true;
-                    logger.methods.sendException(err, req, function () {
-                        if (CONFIG.EXIT_ON_ERROR === true) {
+                    logger.methods.sendException(err, null, function () {
+                        if (exit === true) {
                             process.exit(1);
                         }
                     });
@@ -56,29 +46,38 @@ module.exports = {
     },
     // drain the queue and send the messages before server closes
     gracefulExitHandler : function gracefulExitHandler() {
+
         return (function () {
+            // if any signal has been caught
+            var exit = false,
+                shutdown = function () {
+                    logger.methods.drain();
+                    exit = true;
+                    process.exit(1);
+                };
+
             // Start reading from stdin so we don't exit instantly
             process.stdin.resume();
 
             process.on('exit', function () {
-                logger.methods.drain();
+                if (!exit) {
+                    logger.methods.drain();
+                }
             });
 
             // catch some signal events too
             process.on('SIGINT', function () {
-                logger.methods.drain();
-                process.exit(1);
+                shutdown();
             });
 
             process.on('SIGTERM', function () {
-                logger.methods.drain();
-                process.exit(1);
+                shutdown();
             });
 
             process.on('SIGHUP', function () {
-                logger.methods.drain();
-                process.exit(1);
+                shutdown();
             });
         }());
-    },
+    }
+
 };

lib/helpers.js

@@ -2,6 +2,7 @@ var stackTrace = require('stack-trace'),
 
     path       = require('path'),
     os         = require('os'),
+    qs         = require('querystring'),
 
     CONFIG     = require('../config/config');
 
@@ -183,8 +184,30 @@ module.exports.getOptions = function getOptions(path, body, proxy) {
 
 module.exports.getHeaders = function getHeaders() {
     return {
+        'Accept': 'application/json',
         'Content-Type': 'application/json',
         'X-Stackify-Key': CONFIG.APIKEY,
         'X-Stackify-PV': CONFIG.X_STACKIFY_PV
     };
+};
+/*
+*** Function for getting post data from the request
+*/
+module.exports.getPostData = function getPostData (req) {
+    return (function() {
+        if (request.method == 'POST') {
+            var body = '';
+            request.on('data', function (data) {
+                body += data;
+
+                // Too much POST data, kill the connection!
+                if (body.length > 1e6)
+                    request.connection.destroy();
+            });
+            request.on('end', function () {
+                var json = qs.parse(body);
+                req.body = json;
+            });
+        }
+    }());
 };

lib/sender.js

@@ -35,9 +35,14 @@ module.exports.send = function send(options, cb, fail) {
 
 module.exports.sendSync = function sendSync(options) {
 
-    var res = requestSync('POST', options.url, {
-        json: options.data,
-        headers: options.headers
-    });
+    try {
+        var res = requestSync('POST', options.url, {
+            json: options.data,
+            headers: options.headers
+        });
+    } catch (err) {
+        console.error(err.stack);
+        process.exit(1);
+    }
 
 };

package.json

@@ -19,11 +19,8 @@
   },
   "homepage": "https://github.com/stackify/stackify-log-nodejs",
   "dependencies": {
-    "http-sync": "0.0.5",
-    "pkginfo": "~0.3.x",
     "request": "~2.48.x",
     "stack-trace": "0.0.9",
-    "sync-request": "^1.0.1",
-    "urllib-sync": "^1.0.1"
+    "sync-request": "^1.0.1"
   }
 }