From 8989284e107014ae635d7963bdd8dd37936349a9 Mon Sep 17 00:00:00 2001 From: Oliver Matthews Date: Thu, 6 Mar 2014 15:37:25 +0000 Subject: [PATCH 1/2] move from node-ses to nodemailer --- .../coffee/Features/Email/EmailSender.coffee | 40 ++++++++++++------- services/web/package.json | 2 +- .../coffee/Email/EmailSenderTests.coffee | 33 +++++++-------- 3 files changed, 44 insertions(+), 31 deletions(-) diff --git a/services/web/app/coffee/Features/Email/EmailSender.coffee b/services/web/app/coffee/Features/Email/EmailSender.coffee index 97ffa1e2db..bbf07ae09f 100644 --- a/services/web/app/coffee/Features/Email/EmailSender.coffee +++ b/services/web/app/coffee/Features/Email/EmailSender.coffee @@ -2,37 +2,49 @@ logger = require('logger-sharelatex') metrics = require('../../infrastructure/Metrics') Settings = require('settings-sharelatex') metrics = require("../../infrastructure/Metrics") -ses = require('node-ses') +nodemailer = require("nodemailer") if Settings.email? and Settings.email.fromAddress? defaultFromAddress = Settings.email.fromAddress -else +else defaultFromAddress = "" -if Settings.email?.ses? and Settings.email.ses?.key? and Settings.email.ses?.key != "" and Settings.email.ses?.secret? and Settings.email.ses?.secret != "" - client = ses.createClient({ key: Settings.email.ses.key, secret: Settings.email.ses.secret }); -else - logger.warn "AWS SES credentials are not configured. No emails will be sent." - client = - sendemail: (options, callback = (err, data, res) ->) -> - logger.log options: options, "would send email if SES credentials enabled" - callback() +# provide dummy mailer unless we have a better one configured. +client = + sendMail: (options, callback = (err,status) ->) -> + logger.log options:options, "Would send email if enabled." + callback() + +createSesClient = (settings) -> + if settings? and settings.key? and settings.key != "" and settings.secret? and settings.secret != "" + client = nodemailer.createTransport("SES", {AWSAccessKeyID: settings.key, AWSSecretKey: settings.secret} ) + else + logger.warn "AWS SES credentials are not configured. No emails will be sent." + +if Settings.email? + switch Settings.email.transport + when "ses" + createSesClient( Settings.email.ses) + # TODO direct, client + when undefined,null,"" + logger.warn "No Email transport defined. No emails will be sent." + else + logger.warn "Uknown email transport #{Settings.email.transport}. No emails will be sent." module.exports = - sendEmail : (options, callback = (error) ->)-> logger.log receiver:options.receiver, subject:options.subject, "sending email" metrics.inc "email" - options = + options = to: options.to from: defaultFromAddress subject: options.subject message: options.html replyTo: options.replyTo || Settings.email.replyToAddress - client.sendemail options, (err, data, res)-> + client.sendMail options, (err, res)-> if err? logger.err err:err, "error sending message" else logger.log "Message sent to #{options.to}" callback(err) - \ No newline at end of file + diff --git a/services/web/package.json b/services/web/package.json index 46830b5875..4d08ecc1f2 100644 --- a/services/web/package.json +++ b/services/web/package.json @@ -32,7 +32,7 @@ "fairy": "0.0.2", "node-uuid": "1.4.0", "mongojs": "0.9.8", - "node-ses": "0.0.3", + "nodemailer": "0.6.1", "bcrypt": "0.7.5", "archiver": "0.5.1", "nodetime": "0.8.15", diff --git a/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee b/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee index 92b5908173..0d94512163 100644 --- a/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee +++ b/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee @@ -12,20 +12,21 @@ describe "Email", -> @settings = email: + transport: "ses" ses: key: "key" secret: "secret" fromAddress: "bob@bob.com" replyToAddress: "sally@gmail.com" - @sesClient = - sendemail: sinon.stub() - @ses = - createClient: => @sesClient + @sesClient = + sendMail: sinon.stub() + @ses = + createTransport: => @sesClient @sender = SandboxedModule.require modulePath, requires: - 'node-ses': @ses + 'nodemailer': @ses "settings-sharelatex":@settings - "logger-sharelatex": + "logger-sharelatex": log:-> warn:-> err:-> @@ -38,44 +39,44 @@ describe "Email", -> describe "sendEmail", -> it "should set the properties on the email to send", (done)-> - @sesClient.sendemail.callsArgWith(1) + @sesClient.sendMail.callsArgWith(1) @sender.sendEmail @opts, => - args = @sesClient.sendemail.args[0][0] + args = @sesClient.sendMail.args[0][0] args.message.should.equal @opts.html args.to.should.equal @opts.to args.subject.should.equal @opts.subject done() - it "should return the error", (done)-> - @sesClient.sendemail.callsArgWith(1, "error") + it "should return the error", (done)-> + @sesClient.sendMail.callsArgWith(1, "error") @sender.sendEmail {}, (err)=> err.should.equal "error" done() it "should use the from address from settings", (done)-> - @sesClient.sendemail.callsArgWith(1) + @sesClient.sendMail.callsArgWith(1) @sender.sendEmail @opts, => - args = @sesClient.sendemail.args[0][0] + args = @sesClient.sendMail.args[0][0] args.from.should.equal @settings.email.fromAddress done() it "should use the reply to address from settings", (done)-> - @sesClient.sendemail.callsArgWith(1) + @sesClient.sendMail.callsArgWith(1) @sender.sendEmail @opts, => - args = @sesClient.sendemail.args[0][0] + args = @sesClient.sendMail.args[0][0] args.replyTo.should.equal @settings.email.replyToAddress done() it "should use the reply to address in options as an override", (done)-> - @sesClient.sendemail.callsArgWith(1) + @sesClient.sendMail.callsArgWith(1) @opts.replyTo = "someone@else.com" @sender.sendEmail @opts, => - args = @sesClient.sendemail.args[0][0] + args = @sesClient.sendMail.args[0][0] args.replyTo.should.equal @opts.replyTo done() From efbb17a3b9c25a600103d13ff933f1460172f856 Mon Sep 17 00:00:00 2001 From: Oliver Matthews Date: Wed, 12 Mar 2014 11:43:36 +0000 Subject: [PATCH 2/2] move all parameter handling to nodemailer. --- .../coffee/Features/Email/EmailSender.coffee | 22 ++++++---------- .../web/config/settings.development.coffee | 25 ++++++++++++------- .../coffee/Email/EmailSenderTests.coffee | 8 +++--- 3 files changed, 28 insertions(+), 27 deletions(-) diff --git a/services/web/app/coffee/Features/Email/EmailSender.coffee b/services/web/app/coffee/Features/Email/EmailSender.coffee index bbf07ae09f..68d3956085 100644 --- a/services/web/app/coffee/Features/Email/EmailSender.coffee +++ b/services/web/app/coffee/Features/Email/EmailSender.coffee @@ -15,21 +15,15 @@ client = logger.log options:options, "Would send email if enabled." callback() -createSesClient = (settings) -> - if settings? and settings.key? and settings.key != "" and settings.secret? and settings.secret != "" - client = nodemailer.createTransport("SES", {AWSAccessKeyID: settings.key, AWSSecretKey: settings.secret} ) - else - logger.warn "AWS SES credentials are not configured. No emails will be sent." - if Settings.email? - switch Settings.email.transport - when "ses" - createSesClient( Settings.email.ses) - # TODO direct, client - when undefined,null,"" - logger.warn "No Email transport defined. No emails will be sent." + if Settings.email.transport? and Settings.email.parameters? + nm_client = nodemailer.createTransport( Settings.email.transport, Settings.email.parameters ) + if nm_client + client = nm_client else - logger.warn "Uknown email transport #{Settings.email.transport}. No emails will be sent." + logger.warn "Failed to create email transport. Please check your settings. No email will be sent." + else + logger.warn "Email transport and/or parameters not defined. No emails will be sent." module.exports = sendEmail : (options, callback = (error) ->)-> @@ -39,7 +33,7 @@ module.exports = to: options.to from: defaultFromAddress subject: options.subject - message: options.html + html: options.html replyTo: options.replyTo || Settings.email.replyToAddress client.sendMail options, (err, res)-> if err? diff --git a/services/web/config/settings.development.coffee b/services/web/config/settings.development.coffee index 5d10678a19..52feafc2af 100644 --- a/services/web/config/settings.development.coffee +++ b/services/web/config/settings.development.coffee @@ -134,6 +134,22 @@ module.exports = {name: "English", code: "en"} ] + # Email support + # ------------- + # + # ShareLaTeX uses nodemailer (http://www.nodemailer.com/) to send transactional emails. + # To see the range of transport and options they support, see http://www.nodemailer.com/docs/transports + #email: + # fromAddress: "" + # replyTo: "" + # lifecycle: false + ## Example transport and parameter settings for Amazon SES + # transport: "SES" + # parameters: + # AWSAccessKeyID: "" + # AWSSecretKey: "" + + # Third party services # -------------------- # @@ -157,15 +173,6 @@ module.exports = # tenderUrl: "" # - # email: - # fromAddress: "" - # replyTo: "" - # lifecycle: false - # ShareLaTeX uses Amazon's SES api to send transactional emails. - # Uncomment these lines and provide your credentials to be able to send emails. - # ses: - # "key":"" - # "secret":"" # Production Settings # ------------------- diff --git a/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee b/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee index 0d94512163..555e9c1a1e 100644 --- a/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee +++ b/services/web/test/UnitTests/coffee/Email/EmailSenderTests.coffee @@ -13,9 +13,9 @@ describe "Email", -> @settings = email: transport: "ses" - ses: - key: "key" - secret: "secret" + parameters: + AWSAccessKeyID: "key" + AWSSecretKey: "secret" fromAddress: "bob@bob.com" replyToAddress: "sally@gmail.com" @@ -43,7 +43,7 @@ describe "Email", -> @sender.sendEmail @opts, => args = @sesClient.sendMail.args[0][0] - args.message.should.equal @opts.html + args.html.should.equal @opts.html args.to.should.equal @opts.to args.subject.should.equal @opts.subject done()