cartodb4/log4js-node
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SMTP appender migrated to nodemailer 0.3.x

Browse Source
This commit is contained in:
druciak 2012-06-27 18:00:32 +02:00
parent 6f0dfa0c5f
commit 077302c772
2 changed files with 152 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
lib/appenders/smtp.js
View File

@ -1,59 +1,57 @@
var layouts = require("../layouts"), var layouts = require("../layouts"),
mailer = require("nodemailer"); mailer = require("nodemailer"),
os = require('os');
/** /**
* SMTP Appender. Sends logging events using SMTP protocol. * SMTP Appender. Sends logging events using SMTP protocol.
* It can either send an email on each event or group several logging events gathered during specified interval. * It can either send an email on each event or group several logging events gathered during specified interval.
* *
* @param recipients comma separated list of email recipients * @param config appender configuration data
* @param sender sender of all emails (defaults to SMTP user)
* @param subject subject of all email messages (defaults to first event's message)
* @param layout a function that takes a logevent and returns a string (defaults to basicLayout). * @param layout a function that takes a logevent and returns a string (defaults to basicLayout).
* @param smtpConfig SMTP configuration for 'nodemailer'
* @param sendInterval the time in seconds between sending attempts (defaults to 0);
* all events are buffered and sent in one email during this time; if 0 than every event sends an email * all events are buffered and sent in one email during this time; if 0 than every event sends an email
*/ */
function smtpAppender(recipients, sender, subject, layout, smtpConfig, sendInterval) { function smtpAppender(config, layout) {
sender = sender || smtpConfig.user;
layout = layout || layouts.basicLayout; layout = layout || layouts.basicLayout;
subjectLayout = layouts.messagePassThroughLayout; var subjectLayout = layouts.messagePassThroughLayout;
mailer.SMTP = smtpConfig; var sendInterval = config.sendInterval*1000 || 0;
sendInterval = sendInterval*1000 || 0;
var logEventBuffer = []; var logEventBuffer = [];
var sendTimer; var sendTimer;
var transport = mailer.createTransport(config.transport, config[config.transport]);
function sendBuffer() { function sendBuffer() {
if (logEventBuffer.length == 0) if (logEventBuffer.length == 0)
return; return;
var firstEvent = logEventBuffer[0]; var firstEvent = logEventBuffer[0];
var body = ""; var body = "";
while (logEventBuffer.length > 0) { while (logEventBuffer.length > 0) {
body += layout(logEventBuffer.shift()) + "\n"; body += layout(logEventBuffer.shift()) + "\n";
} }
var msg = { var msg = {
sender: sender, to: config.recipients,
to: recipients, subject: config.subject || subjectLayout(firstEvent),
subject: subject || subjectLayout(firstEvent), text: body,
body: body headers: {"Hostname": os.hostname()}
}; };
mailer.send_mail(msg, function(error, success) { if (config.sender)
msg.from = config.sender;
transport.sendMail(msg, function(error, success) {
if (error) { if (error) {
console.error("log4js.smtpAppender - Error happened ", error); console.error("log4js.smtpAppender - Error happened ", error);
} }
}); });
} }
function scheduleSend() { function scheduleSend() {
if (!sendTimer) if (!sendTimer)
sendTimer = setTimeout(function() { sendTimer = setTimeout(function() {
sendTimer = null; sendTimer = null;
sendBuffer(); sendBuffer();
}, sendInterval); }, sendInterval);
} }
return function(loggingEvent) { return function(loggingEvent) {
logEventBuffer.push(loggingEvent); logEventBuffer.push(loggingEvent);
if (sendInterval > 0) if (sendInterval > 0)
@ -68,8 +66,10 @@ function configure(config) {
if (config.layout) { if (config.layout) {
layout = layouts.layout(config.layout.type, config.layout); layout = layouts.layout(config.layout.type, config.layout);
} }
return smtpAppender(config.recipients, config.sender, config.subject, layout, config.smtp, config.sendInterval); return smtpAppender(config, layout);
} }
exports.name = "smtp";
exports.appender = smtpAppender; exports.appender = smtpAppender;
exports.configure = configure; exports.configure = configure;

248
test/smtpAppender.js
View File

@ -7,156 +7,162 @@ function setupLogging(category, options) {
var msgs = []; var msgs = [];
var fakeMailer = { var fakeMailer = {
send_mail: function (msg, callback) { createTransport: function (name, options) {
msgs.push(msg); return {
callback(null, true); config: options,
} sendMail: function (msg, callback) {
msgs.push(msg);
callback(null, true);
}
};
}
}; };
var smtpModule = sandbox.require('../lib/appenders/smtp', { var smtpModule = sandbox.require('../lib/appenders/smtp', {
requires: { requires: {
'nodemailer': fakeMailer 'nodemailer': fakeMailer
} }
}); });
log4js.addAppender(smtpModule.configure(options), category); log4js.addAppender(smtpModule.configure(options), category);
return { return {
logger: log4js.getLogger(category), logger: log4js.getLogger(category),
mailer: fakeMailer, mailer: fakeMailer,
results: msgs results: msgs
}; };
} }
function checkMessages (result, sender, subject) { function checkMessages (result, sender, subject) {
for (var i = 0; i < result.results.length; ++i) { for (var i = 0; i < result.results.length; ++i) {
assert.equal(result.results[i].sender, sender ? sender : result.mailer.SMTP.user); assert.equal(result.results[i].from, sender);
assert.equal(result.results[i].to, 'recipient@domain.com'); assert.equal(result.results[i].to, 'recipient@domain.com');
assert.equal(result.results[i].subject, subject ? subject : 'Log event #' + (i+1)); assert.equal(result.results[i].subject, subject ? subject : 'Log event #' + (i+1));
assert.ok(new RegExp('.+Log event #' + (i+1) + '\n$').test(result.results[i].body)); assert.ok(new RegExp('.+Log event #' + (i+1) + '\n$').test(result.results[i].text));
} }
} }
log4js.clearAppenders(); log4js.clearAppenders();
vows.describe('log4js smtpAppender').addBatch({ vows.describe('log4js smtpAppender').addBatch({
'minimal config': { 'minimal config': {
topic: function() { topic: function() {
var setup = setupLogging('minimal config', { var setup = setupLogging('minimal config', {
recipients: 'recipient@domain.com', recipients: 'recipient@domain.com',
smtp: { transport: "SMTP",
port: 25, SMTP: {
user: 'user@domain.com' port: 25,
auth: {
user: 'user@domain.com'
}
}
});
setup.logger.info('Log event #1');
return setup;
},
'there should be one message only': function (result) {
assert.equal(result.results.length, 1);
},
'message should contain proper data': function (result) {
checkMessages(result);
} }
});
setup.logger.info('Log event #1');
return setup;
},
'mailer should be configured properly': function (result) {
assert.ok(result.mailer.SMTP);
assert.equal(result.mailer.SMTP.port, 25);
assert.equal(result.mailer.SMTP.user, 'user@domain.com');
},
'there should be one message only': function (result) {
assert.equal(result.results.length, 1);
},
'message should contain proper data': function (result) {
checkMessages(result);
}
}, },
'fancy config': { 'fancy config': {
topic: function() { topic: function() {
var setup = setupLogging('fancy config', { var setup = setupLogging('fancy config', {
recipients: 'recipient@domain.com', recipients: 'recipient@domain.com',
sender: 'sender@domain.com', sender: 'sender@domain.com',
subject: 'This is subject', subject: 'This is subject',
smtp: { transport: "SMTP",
port: 25, SMTP: {
user: 'user@domain.com' port: 25,
auth: {
user: 'user@domain.com'
}
}
});
setup.logger.info('Log event #1');
return setup;
},
'there should be one message only': function (result) {
assert.equal(result.results.length, 1);
},
'message should contain proper data': function (result) {
checkMessages(result, 'sender@domain.com', 'This is subject');
} }
});
setup.logger.info('Log event #1');
return setup;
},
'mailer should be configured properly': function (result) {
assert.ok(result.mailer.SMTP);
assert.equal(result.mailer.SMTP.port, 25);
assert.equal(result.mailer.SMTP.user, 'user@domain.com');
},
'there should be one message only': function (result) {
assert.equal(result.results.length, 1);
},
'message should contain proper data': function (result) {
checkMessages(result, 'sender@domain.com', 'This is subject');
}
}, },
'separate email for each event': { 'separate email for each event': {
topic: function() { topic: function() {
var self = this; var self = this;
var setup = setupLogging('separate email for each event', { var setup = setupLogging('separate email for each event', {
recipients: 'recipient@domain.com', recipients: 'recipient@domain.com',
smtp: { transport: "SMTP",
port: 25, SMTP: {
user: 'user@domain.com' port: 25,
auth: {
user: 'user@domain.com'
}
}
});
setTimeout(function () {
setup.logger.info('Log event #1');
}, 0);
setTimeout(function () {
setup.logger.info('Log event #2');
}, 500);
setTimeout(function () {
setup.logger.info('Log event #3');
}, 1050);
setTimeout(function () {
self.callback(null, setup);
}, 2100);
},
'there should be three messages': function (result) {
assert.equal(result.results.length, 3);
},
'messages should contain proper data': function (result) {
checkMessages(result);
} }
});
setTimeout(function () {
setup.logger.info('Log event #1');
}, 0);
setTimeout(function () {
setup.logger.info('Log event #2');
}, 500);
setTimeout(function () {
setup.logger.info('Log event #3');
}, 1050);
setTimeout(function () {
self.callback(null, setup);
}, 2100);
},
'there should be three messages': function (result) {
assert.equal(result.results.length, 3);
},
'messages should contain proper data': function (result) {
checkMessages(result);
}
}, },
'multiple events in one email': { 'multiple events in one email': {
topic: function() { topic: function() {
var self = this; var self = this;
var setup = setupLogging('multiple events in one email', { var setup = setupLogging('multiple events in one email', {
recipients: 'recipient@domain.com', recipients: 'recipient@domain.com',
sendInterval: 1, sendInterval: 1,
smtp: { transport: "SMTP",
port: 25, SMTP: {
user: 'user@domain.com' port: 25,
auth: {
user: 'user@domain.com'
}
}
});
setTimeout(function () {
setup.logger.info('Log event #1');
}, 0);
setTimeout(function () {
setup.logger.info('Log event #2');
}, 500);
setTimeout(function () {
setup.logger.info('Log event #3');
}, 1050);
setTimeout(function () {
self.callback(null, setup);
}, 2100);
},
'there should be two messages': function (result) {
assert.equal(result.results.length, 2);
},
'messages should contain proper data': function (result) {
assert.equal(result.results[0].to, 'recipient@domain.com');
assert.equal(result.results[0].subject, 'Log event #1');
assert.equal(result.results[0].text.match(new RegExp('.+Log event #[1-2]$', 'gm')).length, 2);
assert.equal(result.results[1].to, 'recipient@domain.com');
assert.equal(result.results[1].subject, 'Log event #3');
assert.ok(new RegExp('.+Log event #3\n$').test(result.results[1].text));
} }
});
setTimeout(function () {
setup.logger.info('Log event #1');
}, 0);
setTimeout(function () {
setup.logger.info('Log event #2');
}, 500);
setTimeout(function () {
setup.logger.info('Log event #3');
}, 1050);
setTimeout(function () {
self.callback(null, setup);
}, 2100);
},
'there should be two messages': function (result) {
assert.equal(result.results.length, 2);
},
'messages should contain proper data': function (result) {
assert.equal(result.results[0].sender, result.mailer.SMTP.user);
assert.equal(result.results[0].to, 'recipient@domain.com');
assert.equal(result.results[0].subject, 'Log event #1');
assert.equal(result.results[0].body.match(new RegExp('.+Log event #[1-2]$', 'gm')).length, 2);
assert.equal(result.results[1].sender, result.mailer.SMTP.user);
assert.equal(result.results[1].to, 'recipient@domain.com');
assert.equal(result.results[1].subject, 'Log event #3');
assert.ok(new RegExp('.+Log event #3\n$').test(result.results[1].body));
}
} }
}).export(module); }).export(module);