Merge branch 'develop'

Author: jue89

README.md

@@ -2,7 +2,7 @@
 
 Node.js module for native bindings to the ~~dearly beloved~~ systemd-journald.
 
-Successfully tested under NodeJS v0.10.36, v0.11.16, v0.12.12, v4.4.1, v5.9.1.
+Successfully tested under NodeJS v0.10.47, v0.12.16, v4.6.0, v6.7.0
 
 
 ## Example
@@ -43,14 +43,15 @@ app.get( '/:a/:b', ( req, res ) => {
 
     // Log this request with priority 7
     log.debug( "Just answered a request", {
-      'DIVIDEND'   : a,
-      'DIVISOR'    : b,
-      'QUOTIENT'   : q,
-      'REMOTE_ADDR': req.connection.remoteAddress
+      'dividend'   : a,
+      'divisor'    : b,
+      'quotient'   : q,
+      'remote_addr': req.connection.remoteAddress
     } );
 
     // Are you interested in the requests of a specific IP? Try:
     // $ journalctl -t awesome-devide REMOTE_ADDR={IP}
+    // As you can see, you have to enter the field names in capital letters.
 
   } catch( e ) {
 
@@ -79,7 +80,7 @@ sudo apt-get install build-essential \
                      libsystemd-dev
 ```
 
-If the above doesn't work, it is likely that you are using an older version of systemd as it is shipped with Ubuntu <= 14.04 or Mint <= 17. No problem - [ianare](https://github.com/ianare) fixed that for you - just try this instead:
+If the above doesn't work, it is likely that you are using an older version of systemd as it is shipped with Ubuntu <= 14.04 or Mint <= 17. No problem just try this instead:
 
 ```bash
 sudo apt-get install build-essential \
@@ -107,21 +108,30 @@ npm install systemd-journald --save
 ```javascript
 const log = require( 'systemd-journald' );
 
-                                // Log level:
-log.emerg( message, fields );   // - 0
-log.alert( message, fields );   // - 1
-log.crit( message, fields );    // - 2
-log.err( message, fields );     // - 3
-log.warning( message, fields ); // - 4
-log.notice( message, fields );  // - 5
-log.info( message, fields );    // - 6
-log.debug( message, fields );   // - 7
+                                // Corresponding syslog level:
+log.emerg( message, fields );   // - LOG_EMERG
+log.alert( message, fields );   // - LOG_ALERT
+log.crit( message, fields );    // - LOG_CRIT
+log.err( message, fields );     // - LOG_ERR
+log.warning( message, fields ); // - LOG_WARNING
+log.notice( message, fields );  // - LOG_NOTICE
+log.info( message, fields );    // - LOG_INFO
+log.debug( message, fields );   // - LOG_DEBUG
 ```
 
  * ```message```: String or instance of Error.
  * ```fields```: Further key-value data attached to the journal. Nested objects will be also included in the journal. ```{ "OBJ": { "NESTED": "Chuck Norris" } }``` will become ```OBJ_NESTED=Chuck Norris```. Quite handy for filtering the journal.
 
 
+## Acknowledgement
+
+Sepcial thanks to:
+ * [ianare](https://github.com/ianare) for improving compatibility with older systemd versions.
+ * [jez9999](https://github.com/jez9999) for making this module immune to future changes of syslog levels.
+
+I owe you a drink!
+
+
 ## Why?
 
 This module has been written after some unsuccessful attempts to get the module [journald](https://www.npmjs.com/package/journald) version 0.0.5 working under NodeJS 4.x / 5.x. Due to massive API changes of the v8 engine this module is fully broken from the point of view of recent NodeJS releases. So I rewrote it - this time with a little help of *Native Abstractions for Node.js* (nan). The nice guys from nan promised to ensure compatibility even on future API changes of v8. We will see ;)

index.js

@@ -8,10 +8,11 @@ function obj2iovec( iovec, obj, prefix ) {
 
 	// Go through all fields
 	for( var o in obj ) {
+		var name = o.toUpperCase();
 		if( typeof obj[o] == 'object' ) {
-			obj2iovec( iovec, obj[o], prefix + o + "_" );
-		} else {
-			iovec.push( prefix + o + '=' + obj[o].toString() );
+			obj2iovec( iovec, obj[o], prefix + name + "_" );
+		} else if( prefix.length > 0 || (name != 'PRIORITY' && name != 'MESSAGE') ) {
+			iovec.push( prefix + name + '=' + obj[o].toString() );
 		}
 	}
 
@@ -40,15 +41,13 @@ function log( priority, message, fields ) {
 	var iovec = [];
 
 	// Add default fields
-	iovec.push( "PRIORITY=" + priority );
 	iovec.push( "MESSAGE=" + message );
 
 	// Add additional fields
 	obj2iovec( iovec, fields );
 
 	// Send it to out beloved journald
-
-	journal.send.apply( null, iovec );
+	journal.send.apply( null, [ parseInt( priority ) ].concat( iovec ) );
 
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "systemd-journald",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Native bindings to journald",
   "keywords": [
     "logging",
@@ -22,12 +22,12 @@
     "pretest": "jshint *.js"
   },
   "dependencies": {
-    "nan": "^2.2.1"
+    "nan": "^2.4.0"
   },
   "devDependencies": {
-    "jshint": "^2.9.1",
-    "mocha": "^2.4.5",
-    "mockery": "^1.4.1"
+    "jshint": "^2.9.3",
+    "mocha": "^2.5.3",
+    "mockery": "^1.7.0"
   },
   "os": [
     "linux"

src/journal_send.cc

@@ -2,26 +2,73 @@
 // Internet. It just copies an ordinary JavaScript string array into an iovec
 // and then finally calls sd_journal_sendv. Rocket science included!
 
+// Priority is a special case as it needs to be taken from the syslog.h
+// preprocessor definitions, which aren't available from JavaScript.
+
 #include <nan.h>
 #include <systemd/sd-journal.h>
+#include <syslog.h>
+
+// Macros for int to string conversion
+#define TO_STR_H(x) "" #x
+#define TO_STR(x) TO_STR_H(x)
+
+// Create an array of all Syslog priority numbers
+#define SYSLOG_PRIO_CNT 8
+const char *const syslogPrio[] = {
+	TO_STR( LOG_EMERG ),   // jsPrio: 0
+	TO_STR( LOG_ALERT ),   // jsPrio: 1
+	TO_STR( LOG_CRIT ),    // jsPrio: 2
+	TO_STR( LOG_ERR ),     // jsPrio: 3
+	TO_STR( LOG_WARNING ), // jsPrio: 4
+	TO_STR( LOG_NOTICE ),  // jsPrio: 5
+	TO_STR( LOG_INFO ),    // jsPrio: 6
+	TO_STR( LOG_DEBUG )    // jsPrio: 7
+};
+
+#define PRIO_FIELD_NAME "PRIORITY="
+#define PRIO_FIELD_NAME_LEN 9
+
 
 void send( const Nan::FunctionCallbackInfo<v8::Value>& args ) {
 
 	int argc = args.Length();
 	struct iovec iov[ argc ];
 
+
 	// Make sure nobody forgot the arguments
-	if( argc == 0 ) {
-		Nan::ThrowTypeError( "Wrong number of arguments" );
+	if( argc < 2 ) {
+		Nan::ThrowTypeError( "Not enough arugments" );
 		return;
 	}
 
-	// Copy all arguments to an iovec
-	for( int i = 0; i < argc; i++ ) {
+	// Make sure first argument is a number
+	if( ! args[0]->IsNumber() ) {
+		Nan::ThrowTypeError( "First argument must be a number" );
+		return;
+	}
+
+	// Get the priority
+	int64_t jsPrio = ( args[0]->ToInteger() )->Value();
+	if( jsPrio < 0 || jsPrio >= SYSLOG_PRIO_CNT ) {
+		Nan::ThrowTypeError( "Unknown priority" );
+		return;
+	}
+
+	// Convert JavaScript priority to Syslog priority
+	size_t strLen = PRIO_FIELD_NAME_LEN + strlen( syslogPrio[jsPrio] );
+	iov[0].iov_len = strLen;
+	iov[0].iov_base = (char*) malloc( strLen + 1 );
+	snprintf( (char*) iov[0].iov_base, strLen + 1,
+	          "%s%s", PRIO_FIELD_NAME, syslogPrio[jsPrio] );
+
+
+	// Copy all remaining arguments to the iovec
+	for( int i = 1; i < argc; i++ ) {
 
 		// First ensure that the argument is a string
-		if( ! args[0]->IsString() ) {
-			Nan::ThrowTypeError( "Arguments must be string" );
+		if( ! args[i]->IsString() ) {
+			Nan::ThrowTypeError( "Arguments must be strings" );
 			return;
 		}
 

test/index.js

@@ -161,11 +161,11 @@ describe( "node-systemd-journald", function() {
 	it( "should append specified fields", function( done ) {
 
 		log.debug( 'Test', {
-			NUMBER: 3,
-			BOOLEAN: true,
-			STRING: 'Chuck Norris',
+			number: 3,
+			boolean: true,
+			string: 'Chuck Norris',
 			OBJ: {
-				NUMBER: 4
+				nUmBer: 4
 			},
 			ARR: [ 5 ]
 		} );

test/mocks/journal_send.js

@@ -1,30 +1,32 @@
 "use strict";
 
-var last = {};
+var lastField = {};
+var lastPrio = 0;
 
-function send() {
+function send( prio ) {
 
-	last = {};
+	lastField = {};
 
-	for( var i = 0; i < arguments.length; i++ ) {
+	lastField['PRIORITY'] = prio.toString();
+
+	for( var i = 1; i < arguments.length; i++ ) {
 		var line = arguments[i];
 
 		var delimiterPosition = line.indexOf( '=' );
 		var name = line.substr( 0, delimiterPosition );
 		var value = line.substr( delimiterPosition + 1 );
 
-		last[ name ] = value;
+		lastField[ name ] = value;
 
 	}
 
 }
 
 function getField( name ) {
-
-	return last[ name ];
-
+	return lastField[ name ];
 }
 
+
 module.exports = {
 	send: send,
 	getField: getField