From aace2c7e6ccb6e74df83faac74c427d43bfaf79b Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Wed, 23 Apr 2025 15:06:54 -0700 Subject: Fix ReferenceError: nodemailerTransporter is not defined Part of https://github.com/lowercasename/gathio/pull/200 was migrating more code to use the shared init email function, but all the local usages of nodemailerTransporter were missed --- src/app.ts | 39 +++- src/lib/email.ts | 57 +++-- src/lib/handlebars.ts | 27 +++ src/routes.js | 568 +++++++++++++++++-------------------------------- src/routes/frontend.ts | 5 +- 5 files changed, 302 insertions(+), 394 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 0708081..85ee64e 100755 --- a/src/app.ts +++ b/src/app.ts @@ -15,16 +15,28 @@ import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; +import getConfig from "./lib/config.js"; const app = express(); +const config = getConfig(); -app.locals.sendEmails = initEmailService(); +initEmailService().then((sendEmails) => (app.locals.sendEmails = sendEmails)); // View engine // const hbsInstance = hbs.create({ defaultLayout: "main", partialsDir: ["views/partials/"], layoutsDir: "views/layouts/", + runtimeOptions: { + data: { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + }, + }, helpers: { plural: function (number: number, text: string) { var singular = number === 1; @@ -46,6 +58,31 @@ const hbsInstance = hbs.create({ }, }, }); +app.locals.renderEmail = async function renderEmail( + template: string, + data: object +) { + const [html, text] = await Promise.all([ + hbsInstance.renderView( + `./views/emails/${template}Html.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + hbsInstance.renderView( + `./views/emails/${template}Text.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + ]); + return { html, text } +} + app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); app.set("hbsInstance", hbsInstance); diff --git a/src/lib/email.ts b/src/lib/email.ts index 7b7a7a1..e7243aa 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -1,10 +1,10 @@ -import { Request } from "express"; import sgMail from "@sendgrid/mail"; import nodemailer, { Transporter } from "nodemailer"; import { getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; import { renderTemplate } from "./handlebars.js"; +import { ExpressHandlebars } from "express-handlebars"; const config = getConfig(); type EmailTemplate = @@ -36,10 +36,12 @@ export const initEmailService = async (): Promise => { sgMail.setApiKey(config.sendgrid.api_key); console.log("Sendgrid is ready to send emails."); return true; - case "nodemailer": - let nodemailerTransporter:Transporter|undefined = undefined; + case "nodemailer": { + let nodemailerTransporter: Transporter | undefined = undefined; if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport(config.nodemailer?.smtp_url); + nodemailerTransporter = nodemailer.createTransport( + config.nodemailer?.smtp_url, + ); } else { if ( !config.nodemailer?.smtp_server || @@ -52,7 +54,7 @@ export const initEmailService = async (): Promise => { const nodemailerConfig = { host: config.nodemailer?.smtp_server, port: Number(config.nodemailer?.smtp_port) || 587, - tls: { + tls: { // do not fail on invalid certs rejectUnauthorized: false, }, @@ -61,10 +63,11 @@ export const initEmailService = async (): Promise => { if (config.nodemailer?.smtp_username) { nodemailerConfig.auth = { user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password + pass: config.nodemailer?.smtp_password, }; } - nodemailerTransporter = nodemailer.createTransport(nodemailerConfig); + nodemailerTransporter = + nodemailer.createTransport(nodemailerConfig); } const nodemailerVerified = await nodemailerTransporter.verify(); @@ -76,6 +79,7 @@ export const initEmailService = async (): Promise => { "Error verifying Nodemailer transporter. Please check your Nodemailer configuration.", ); } + } case "none": default: console.warn( @@ -85,10 +89,34 @@ export const initEmailService = async (): Promise => { } }; -export const sendEmail = async ( +export const sendTemplatedEmail = async ( + hbs: ExpressHandlebars, to: string, bcc: string, subject: string, + template: string, + data: object, +): Promise => { + const [html, text] = await Promise.all([ + hbs.renderView(`./views/emails/${template}Html.handlebars`, { + cache: true, + layout: "email.handlebars", + ...data, + }), + hbs.renderView(`./views/emails/${template}Text.handlebars`, { + cache: true, + layout: "email.handlebars", + ...data, + }), + ]); + + return await sendEmail(to, bcc, subject, text, html); +}; + +export const sendEmail = async ( + to: string | string[], + bcc: string | string[] | undefined, + subject: string, text: string, html?: string, ): Promise => { @@ -104,7 +132,7 @@ export const sendEmail = async ( html, }); return true; - } catch (e: any) { + } catch (e: Error) { if (e.response) { console.error(e.response.body); } else { @@ -114,9 +142,11 @@ export const sendEmail = async ( } case "nodemailer": try { - let nodemailerTransporter:Transporter|undefined = undefined; + let nodemailerTransporter: Transporter | undefined = undefined; if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport(config.nodemailer?.smtp_url); + nodemailerTransporter = nodemailer.createTransport( + config.nodemailer?.smtp_url, + ); } else { const nodemailerConfig = { host: config.nodemailer?.smtp_server, @@ -126,11 +156,12 @@ export const sendEmail = async ( if (config.nodemailer?.smtp_username) { nodemailerConfig.auth = { user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password + pass: config.nodemailer?.smtp_password, }; } - nodemailerTransporter = nodemailer.createTransport(nodemailerConfig); + nodemailerTransporter = + nodemailer.createTransport(nodemailerConfig); } await nodemailerTransporter.sendMail({ envelope: { diff --git a/src/lib/handlebars.ts b/src/lib/handlebars.ts index d5a8b6e..42f8010 100644 --- a/src/lib/handlebars.ts +++ b/src/lib/handlebars.ts @@ -1,4 +1,5 @@ import { Request } from "express"; +import { ExpressHandlebars } from "express-handlebars"; export const renderTemplate = async ( req: Request, @@ -21,3 +22,29 @@ export const renderTemplate = async ( ); }); }; + +export const renderEmail = async ( + hbsInstance: ExpressHandlebars, + templateName: string, + data: Record, +): Promise<{ html: string, text: string }> => { + const [html, text] = await Promise.all([ + hbsInstance.renderView( + `./views/emails/${templateName}Html.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + hbsInstance.renderView( + `./views/emails/${templateName}Text.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + ]); + return { html, text } +} diff --git a/src/routes.js b/src/routes.js index e758e6b..f609f94 100755 --- a/src/routes.js +++ b/src/routes.js @@ -19,12 +19,13 @@ import { broadcastDeleteMessage, processInbox, } from "./activitypub.js"; +import { renderEmail } from "./lib/handlebars.js"; import Event from "./models/Event.js"; import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; -import { initEmailService } from "./lib/email.js"; +import { initEmailService, sendEmail } from "./lib/email.js"; const config = getConfig(); const domain = config.general.domain; @@ -44,9 +45,7 @@ const nanoid = customAlphabet( const router = express.Router(); let sendEmails = false; -initEmailService().then((emailService) => { - sendEmails = emailService -}); +initEmailService().then((emailService) => (sendEmails = emailService)); router.use(fileUpload()); @@ -58,7 +57,10 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { return; } - const too_old = moment.tz("Etc/UTC").subtract(deleteAfterDays, "days").toDate(); + const too_old = moment + .tz("Etc/UTC") + .subtract(deleteAfterDays, "days") + .toDate(); console.log( "Old event deletion running! Deleting all events concluding before ", too_old, @@ -81,9 +83,9 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { "deleteOldEvents", "error", "Attempt to delete old event " + - id + - " failed with error: " + - err, + id + + " failed with error: " + + err, ); }); }; @@ -100,9 +102,9 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { "deleteOldEvents", "error", "Attempt to delete event image for old event " + - event.id + - " failed with error: " + - err, + event.id + + " failed with error: " + + err, ); } // Image removed @@ -149,9 +151,9 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { "deleteOldEvents", "error", "Attempt to delete old event " + - event.id + - " failed with error: " + - err, + event.id + + " failed with error: " + + err, ); }); @@ -204,9 +206,9 @@ router.post("/deleteimage/:eventID/:editToken", (req, res) => { "deleteEventImage", "error", "Attempt to delete event image for event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); } // Image removed @@ -227,9 +229,9 @@ router.post("/deleteimage/:eventID/:editToken", (req, res) => { "deleteEventImage", "error", "Attempt to delete event image for event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -271,9 +273,9 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); } }, @@ -293,9 +295,9 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event image for event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); } // Image removed @@ -303,8 +305,8 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "success", "Event " + - req.params.eventID + - " deleted", + req.params.eventID + + " deleted", ); }, ); @@ -316,63 +318,29 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { // Send emails here otherwise they don't exist lol if (sendEmails) { - const attendeeEmails = event.attendees - .filter( + const attendeeEmails = event?.attendees?.filter( (o) => o.status === "attending" && o.email, ) - .map((o) => o.email); + .map((o) => o.email || '') || []; if (attendeeEmails.length) { console.log( "Sending emails to: " + - attendeeEmails, + attendeeEmails, ); - req.app.get("hbsInstance").renderView( - "./views/emails/deleteEvent/deleteEventHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "deleteEvent/deleteEvent", { - siteName, - siteLogo, - domain, - eventName: event.name, - cache: true, - layout: "email.handlebars", + eventName: event?.name, }, - function (err, html) { - const msg = { - to: attendeeEmails, - from: contactEmail, - subject: `${siteName}: ${event.name} was deleted`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail - .sendMultiple(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: ${event?.name} was deleted`, text, html) + ).catch((e) => { + console.error('error sending attendy email', e.toString()); + res.status(500).end(); + }); } else { console.log("Nothing to send!"); } @@ -381,15 +349,15 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -401,8 +369,8 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: token does not match", + req.params.eventID + + " failed with error: token does not match", ); } }) @@ -412,9 +380,9 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }); @@ -447,9 +415,9 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); } }, @@ -469,9 +437,9 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event image for event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); } }, @@ -487,8 +455,8 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "success", "Event group " + - req.params.eventGroupID + - " deleted", + req.params.eventGroupID + + " deleted", ); res.writeHead(302, { Location: "/", @@ -498,30 +466,30 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); }); }) .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); }); } else { @@ -531,8 +499,8 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: token does not match", + req.params.eventGroupID + + " failed with error: token does not match", ); } }) @@ -542,9 +510,9 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); }); }); @@ -562,9 +530,9 @@ router.post("/attendee/provision", async (req, res) => { "provisionEventAttendee", "error", "Attempt to provision attendee in event " + - req.query.eventID + - " failed with error: " + - e, + req.query.eventID + + " failed with error: " + + e, ); return res.sendStatus(500); }); @@ -580,9 +548,9 @@ router.post("/attendee/provision", async (req, res) => { "provisionEventAttendee", "error", "Attempt to provision attendee in event " + - req.query.eventID + - " failed with error: " + - e, + req.query.eventID + + " failed with error: " + + e, ); return res.sendStatus(500); }); @@ -618,9 +586,9 @@ router.post("/attendevent/:eventID", async (req, res) => { "attendEvent", "error", "Attempt to attend event " + - req.params.eventID + - " failed with error: " + - e, + req.params.eventID + + " failed with error: " + + e, ); return res.sendStatus(500); }); @@ -659,7 +627,9 @@ router.post("/attendevent/:eventID", async (req, res) => { "attendees.$.name": req.body.attendeeName, "attendees.$.email": req.body.attendeeEmail, "attendees.$.number": req.body.attendeeNumber, - "attendees.$.visibility": !!req.body.attendeeVisible ? "public" : "private", + "attendees.$.visibility": req.body.attendeeVisible + ? "public" + : "private", }, }, ) @@ -670,44 +640,23 @@ router.post("/attendevent/:eventID", async (req, res) => { "Attendee added to event " + req.params.eventID, ); if (sendEmails) { - if (req.body.attendeeEmail) { - req.app.get("hbsInstance").renderView( - "./views/emails/addEventAttendee/addEventAttendeeHtml.handlebars", + if (req.body.attendeeEmail) { + renderEmail( + req.app.get("hbsInstance"), + "addEventAttendee/addEventAttendee", { eventID: req.params.eventID, - siteName, - siteLogo, - domain, removalPassword: req.body.removalPassword, - removalPasswordHash: hashString(req.body.removalPassword), - cache: true, - layout: "email.handlebars", - }, - function (err, html) { - const msg = { - to: req.body.attendeeEmail, - from: contactEmail, - subject: `${siteName}: You're RSVPed to ${event.name}`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } + removalPasswordHash: hashString( + req.body.removalPassword, + ), }, - ); + ).then( + ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You're RSVPed to ${event.name}`, text, html) + ).catch((e) => { + console.error('error sending addEventAttendee email', e.toString()); + res.status(500).end(); + }); } } res.redirect(`/${req.params.eventID}`); @@ -718,9 +667,9 @@ router.post("/attendevent/:eventID", async (req, res) => { "addEventAttendee", "error", "Attempt to add attendee to event " + - req.params.eventID + - " failed with error: " + - error, + req.params.eventID + + " failed with error: " + + error, ); }); }); @@ -750,40 +699,18 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - req.app.get("hbsInstance").renderView( - "./views/emails/removeEventAttendee/removeEventAttendeeHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "removeEventAttendee/removeEventAttendee", { eventName: req.params.eventName, - siteName, - domain, - cache: true, - layout: "email.handlebars", }, - function (err, html) { - const msg = { - to: req.body.attendeeEmail, - from: contactEmail, - subject: `${siteName}: You have been removed from an event`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } } res.writeHead(302, { @@ -797,9 +724,9 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { "removeEventAttendee", "error", "Attempt to remove attendee by admin from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }); @@ -818,41 +745,18 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - req.app.get("hbsInstance").renderView( - "./views/emails/removeEventAttendee/removeEventAttendeeHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "removeEventAttendee/removeEventAttendee", { eventName: req.params.eventName, - siteName, - siteLogo, - domain, - cache: true, - layout: "email.handlebars", - }, - function (err, html) { - const msg = { - to: req.body.attendeeEmail, - from: contactEmail, - subject: `${siteName}: You have been removed from an event`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } }, - ); + ).then( + ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } } res.writeHead(302, { @@ -866,9 +770,9 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { "removeEventAttendee", "error", "Attempt to remove attendee by admin from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }); @@ -894,43 +798,20 @@ router.post("/subscribe/:eventGroupID", (req, res) => { eventGroup.subscribers.push(subscriber); eventGroup.save(); if (sendEmails) { - req.app.get("hbsInstance").renderView( - "./views/emails/subscribed/subscribedHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "subscribed/subscribed", { eventGroupName: eventGroup.name, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(subscriber.email), - siteName, - siteLogo, - domain, - cache: true, - layout: "email.handlebars", }, - function (err, html) { - const msg = { - to: subscriber.email, - from: contactEmail, - subject: `${siteName}: You have subscribed to an event group`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(subscriber.email, '', `${siteName}: You have subscribed to an event group`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } return res.redirect(`/group/${eventGroup.id}`); }) @@ -939,11 +820,11 @@ router.post("/subscribe/:eventGroupID", (req, res) => { "addSubscription", "error", "Attempt to subscribe " + - req.body.emailAddress + - " to event group " + - req.params.eventGroupID + - " failed with error: " + - error, + req.body.emailAddress + + " to event group " + + req.params.eventGroupID + + " failed with error: " + + error, ); return res.sendStatus(500); }); @@ -970,11 +851,11 @@ router.get("/unsubscribe/:eventGroupID", (req, res) => { "removeSubscription", "error", "Attempt to unsubscribe " + - req.query.email + - " from event group " + - req.params.eventGroupID + - " failed with error: " + - error, + req.query.email + + " from event group " + + req.params.eventGroupID + + " failed with error: " + + error, ); return res.sendStatus(500); }); @@ -1028,58 +909,24 @@ router.post("/post/comment/:eventID", (req, res) => { (o) => o.status === "attending" && o.email, ) - .map((o) => o.email); + .map((o) => o.email || '') || []; if (attendeeEmails.length) { console.log( "Sending emails to: " + attendeeEmails, ); - req.app.get("hbsInstance").renderView( - "./views/emails/addEventComment/addEventCommentHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "addEventComment/addEventComment", { - siteName, - siteLogo, - domain, eventID: req.params.eventID, - commentAuthor: - req.body.commentAuthor, - cache: true, - layout: "email.handlebars", - }, - function (err, html) { - const msg = { - to: attendeeEmails, - from: contactEmail, - subject: `${siteName}: New comment in ${event.name}`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail - .sendMultiple(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - } + commentAuthor: req.body.commentAuthor, }, - ); + ).then( + ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } else { console.log("Nothing to send!"); } @@ -1097,9 +944,9 @@ router.post("/post/comment/:eventID", (req, res) => { "addEventComment", "error", "Attempt to add comment to event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -1130,9 +977,9 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { "addEventReply", "success", "Reply added to comment " + - commentID + - " in event " + - req.params.eventID, + commentID + + " in event " + + req.params.eventID, ); // broadcast an identical message to all followers, will show in their home timeline const guidObject = crypto.randomBytes(16).toString("hex"); @@ -1157,57 +1004,24 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { (o) => o.status === "attending" && o.email, ) - .map((o) => o.email); + .map((o) => o.email || '') || []; if (attendeeEmails.length) { console.log( "Sending emails to: " + attendeeEmails, ); - req.app.get("hbsInstance").renderView( - "./views/emails/addEventComment/addEventCommentHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "addEventComment/addEventComment", { - siteName, - siteLogo, - domain, eventID: req.params.eventID, commentAuthor: req.body.replyAuthor, - cache: true, - layout: "email.handlebars", }, - function (err, html) { - const msg = { - to: attendeeEmails, - from: contactEmail, - subject: `${siteName}: New comment in ${event.name}`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail - .sendMultiple(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } else { console.log("Nothing to send!"); } @@ -1225,11 +1039,11 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { "addEventReply", "error", "Attempt to add reply to comment " + - commentID + - " in event " + - req.params.eventID + - " failed with error: " + - err, + commentID + + " in event " + + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -1265,17 +1079,17 @@ router.post("/deletecomment/:eventID/:commentID/:editToken", (req, res) => { .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteComment", "error", "Attempt to delete comment " + - req.params.commentID + - "from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.commentID + + "from event " + + req.params.eventID + + " failed with error: " + + err, ); }); } else { @@ -1285,10 +1099,10 @@ router.post("/deletecomment/:eventID/:commentID/:editToken", (req, res) => { "deleteComment", "error", "Attempt to delete comment " + - req.params.commentID + - "from event " + - req.params.eventID + - " failed with error: token does not match", + req.params.commentID + + "from event " + + req.params.eventID + + " failed with error: token does not match", ); } }) @@ -1298,11 +1112,11 @@ router.post("/deletecomment/:eventID/:commentID/:editToken", (req, res) => { "deleteComment", "error", "Attempt to delete comment " + - req.params.commentID + - "from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.commentID + + "from event " + + req.params.eventID + + " failed with error: " + + err, ); }); }); diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 14bb779..1b95763 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -1,5 +1,4 @@ import { Router, Request, Response } from "express"; -import fs from "fs"; import moment from "moment-timezone"; import { marked } from "marked"; import { markdownToSanitizedHTML, renderPlain } from "../util/markdown.js"; @@ -25,7 +24,7 @@ const router = Router(); // Add config middleware to all routes router.use(getConfigMiddleware); -router.get("/", (_: Request, res: Response) => { +router.get("/", (_, res) => { if (res.locals.config?.general.show_public_event_list) { return res.redirect("/events"); } @@ -44,7 +43,7 @@ router.get("/about", (_: Request, res: Response) => { }); }); -router.get("/new", (req: Request, res: Response) => { +router.get("/new", (_: Request, res: Response) => { if (res.locals.config?.general.creator_email_addresses?.length) { return res.render("createEventMagicLink", frontendConfig(res)); } -- cgit v1.2.3 From a8a17443c2d070d2d23920ffff7e4a43c905698c Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Wed, 23 Apr 2025 17:27:55 -0700 Subject: Refactor for everywhere to use sendEmailFromTemplate everywhere * Created a singleton to house handlebars so req doesn't need to be passed everywhere (should make unit testing easier later) * Subjectline for sendgrid and nodemailer are both always prefixed in sendEmail() * removed prefix subjectline from all other email places * added a couple if (!event) { return 404 } to help make typescript happy * some minor eslint auto fixes (looks like let => const where it can) --- src/app.ts | 68 ++--------------------------- src/lib/email.ts | 101 ++++++++++++++++++++----------------------- src/lib/handlebars.ts | 97 +++++++++++++++++++++-------------------- src/routes.js | 112 ++++++++++++++++++++++++++---------------------- src/routes/event.ts | 51 ++++++---------------- src/routes/group.ts | 6 +-- src/routes/magicLink.ts | 6 +-- 7 files changed, 176 insertions(+), 265 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 85ee64e..5f7c024 100755 --- a/src/app.ts +++ b/src/app.ts @@ -1,5 +1,4 @@ import express from "express"; -import hbs from "express-handlebars"; import cookieParser from "cookie-parser"; import routes from "./routes.js"; @@ -15,77 +14,16 @@ import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; -import getConfig from "./lib/config.js"; +import { HandlebarsSingleton } from "./lib/handlebars.js"; const app = express(); -const config = getConfig(); initEmailService().then((sendEmails) => (app.locals.sendEmails = sendEmails)); // View engine // -const hbsInstance = hbs.create({ - defaultLayout: "main", - partialsDir: ["views/partials/"], - layoutsDir: "views/layouts/", - runtimeOptions: { - data: { - domain: config.general.domain, - contactEmail: config.general.email, - siteName: config.general.site_name, - mailService: config.general.mail_service, - siteLogo: config.general.email_logo_url, - isFederated: config.general.is_federated || true, - }, - }, - helpers: { - plural: function (number: number, text: string) { - var singular = number === 1; - // If no text parameter was given, just return a conditional s. - if (typeof text !== "string") return singular ? "" : "s"; - // Split with regex into group1/group2 or group1(group3) - var match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); - // If no match, just append a conditional s. - if (!match) return text + (singular ? "" : "s"); - // We have a good match, so fire away - return ( - (singular && match[1]) || // Singular case - match[2] || // Plural case: 'bagel/bagels' --> bagels - match[1] + (match[3] || "s") - ); // Plural case: 'bagel(s)' or 'bagel' --> bagels - }, - json: function (context: any) { - return JSON.stringify(context); - }, - }, -}); -app.locals.renderEmail = async function renderEmail( - template: string, - data: object -) { - const [html, text] = await Promise.all([ - hbsInstance.renderView( - `./views/emails/${template}Html.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - hbsInstance.renderView( - `./views/emails/${template}Text.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - ]); - return { html, text } -} - -app.engine("handlebars", hbsInstance.engine); +app.engine("handlebars", HandlebarsSingleton.instance.engine); app.set("view engine", "handlebars"); -app.set("hbsInstance", hbsInstance); +app.set("hbsInstance", HandlebarsSingleton.instance); // Static files // app.use(express.static("public")); diff --git a/src/lib/email.ts b/src/lib/email.ts index e7243aa..57f69f5 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -1,13 +1,15 @@ import sgMail from "@sendgrid/mail"; +import sgHelpers from "@sendgrid/helpers"; + import nodemailer, { Transporter } from "nodemailer"; import { getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; -import { renderTemplate } from "./handlebars.js"; -import { ExpressHandlebars } from "express-handlebars"; +import { HandlebarsSingleton } from "./handlebars.js"; + const config = getConfig(); -type EmailTemplate = +type EmailTemplateName = | "addEventAttendee" | "addEventComment" | "createEvent" @@ -16,6 +18,7 @@ type EmailTemplate = | "deleteEvent" | "editEvent" | "eventGroupUpdated" + | "removeEventAttendee" | "subscribed" | "unattendEvent"; @@ -89,30 +92,6 @@ export const initEmailService = async (): Promise => { } }; -export const sendTemplatedEmail = async ( - hbs: ExpressHandlebars, - to: string, - bcc: string, - subject: string, - template: string, - data: object, -): Promise => { - const [html, text] = await Promise.all([ - hbs.renderView(`./views/emails/${template}Html.handlebars`, { - cache: true, - layout: "email.handlebars", - ...data, - }), - hbs.renderView(`./views/emails/${template}Text.handlebars`, { - cache: true, - layout: "email.handlebars", - ...data, - }), - ]); - - return await sendEmail(to, bcc, subject, text, html); -}; - export const sendEmail = async ( to: string | string[], bcc: string | string[] | undefined, @@ -132,11 +111,11 @@ export const sendEmail = async ( html, }); return true; - } catch (e: Error) { - if (e.response) { - console.error(e.response.body); + } catch (e: unknown | sgHelpers.classes.ResponseError) { + if (e instanceof sgHelpers.classes.ResponseError) { + console.error('sendgrid error', e.response.body); } else { - console.error(e); + console.error('sendgrid error', e); } return false; } @@ -164,15 +143,10 @@ export const sendEmail = async ( nodemailer.createTransport(nodemailerConfig); } await nodemailerTransporter.sendMail({ - envelope: { - from: config.general.email, - to, - bcc, - }, from: config.general.email, to, bcc, - subject, + subject: `${config.general.site_name}: ${subject}`, text, html, }); @@ -187,25 +161,42 @@ export const sendEmail = async ( }; export const sendEmailFromTemplate = async ( - to: string, - bcc: string, + to: string | string[], + bcc: string | string[] | undefined, subject: string, - template: EmailTemplate, - templateData: Record, - req: Request, + templateName: EmailTemplateName, + templateData: object, ): Promise => { - const html = await renderTemplate(req, `${template}/${template}Html`, { - siteName: config.general.site_name, - siteLogo: config.general.email_logo_url, - domain: config.general.domain, - cache: true, - layout: "email.handlebars", - ...templateData, - }); - const text = await renderTemplate( - req, - `${template}/${template}Text`, - templateData, - ); + const [html, text] = await Promise.all([ + HandlebarsSingleton.instance.renderView( + `./views/emails/${templateName}/${templateName}Html.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + HandlebarsSingleton.instance.renderView( + `./views/emails/${templateName}/${templateName}Text.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + ]); + return await sendEmail(to, bcc, subject, text, html); }; diff --git a/src/lib/handlebars.ts b/src/lib/handlebars.ts index 42f8010..6d4f796 100644 --- a/src/lib/handlebars.ts +++ b/src/lib/handlebars.ts @@ -1,50 +1,55 @@ -import { Request } from "express"; -import { ExpressHandlebars } from "express-handlebars"; +import hbs, { ExpressHandlebars } from "express-handlebars"; +import { RenderViewOptions } from "express-handlebars/types/index.js"; -export const renderTemplate = async ( - req: Request, - templateName: string, - data: Record, -): Promise => { - return new Promise((resolve, reject) => { - req.app - .get("hbsInstance") - .renderView( - `./views/emails/${templateName}.handlebars`, - data, - (err: any, html: string) => { - if (err) { - console.error(err); - reject(err); - } - resolve(html); +export class HandlebarsSingleton { + static #instance: HandlebarsSingleton; + hbsInstance: hbs.ExpressHandlebars; + + private constructor() { + this.hbsInstance = hbs.create({ + defaultLayout: "main", + partialsDir: ["views/partials/"], + layoutsDir: "views/layouts/", + helpers: { + plural: function (number: number, text: string) { + const singular = number === 1; + // If no text parameter was given, just return a conditional s. + if (typeof text !== "string") return singular ? "" : "s"; + // Split with regex into group1/group2 or group1(group3) + const match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); + // If no match, just append a conditional s. + if (!match) return text + (singular ? "" : "s"); + // We have a good match, so fire away + return ( + (singular && match[1]) || // Singular case + match[2] || // Plural case: 'bagel/bagels' --> bagels + match[1] + (match[3] || "s") + ); // Plural case: 'bagel(s)' or 'bagel' --> bagels + }, + json: function (context: object) { + return JSON.stringify(context); }, - ); - }); -}; + }, + }); + } + + public static get instance(): HandlebarsSingleton { + if (!HandlebarsSingleton.#instance) { + HandlebarsSingleton.#instance = new HandlebarsSingleton(); + } + + return HandlebarsSingleton.#instance; + } + + public get engine(): ExpressHandlebars["engine"] { + return this.hbsInstance.engine; + } -export const renderEmail = async ( - hbsInstance: ExpressHandlebars, - templateName: string, - data: Record, -): Promise<{ html: string, text: string }> => { - const [html, text] = await Promise.all([ - hbsInstance.renderView( - `./views/emails/${templateName}Html.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - hbsInstance.renderView( - `./views/emails/${templateName}Text.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - ]); - return { html, text } + /** + * Finally, any singleton can define some business logic, which can be + * executed on its instance. + */ + public renderView(viewPath: string, options: RenderViewOptions): Promise { + return this.hbsInstance.renderView(viewPath, options); + } } diff --git a/src/routes.js b/src/routes.js index f609f94..d5b5877 100755 --- a/src/routes.js +++ b/src/routes.js @@ -9,8 +9,6 @@ import crypto from "crypto"; import request from "request"; import niceware from "niceware"; import ical from "ical"; -import sgMail from "@sendgrid/mail"; -import nodemailer from "nodemailer"; import fileUpload from "express-fileupload"; import Jimp from "jimp"; import schedule from "node-schedule"; @@ -19,20 +17,15 @@ import { broadcastDeleteMessage, processInbox, } from "./activitypub.js"; -import { renderEmail } from "./lib/handlebars.js"; import Event from "./models/Event.js"; import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; -import { initEmailService, sendEmail } from "./lib/email.js"; +import { initEmailService, sendEmailFromTemplate } from "./lib/email.js"; const config = getConfig(); const domain = config.general.domain; -const contactEmail = config.general.email; -const siteName = config.general.site_name; -const mailService = config.general.mail_service; -const siteLogo = config.general.email_logo_url; const isFederated = config.general.is_federated || true; // This alphabet (used to generate all event, group, etc. IDs) is missing '-' @@ -329,14 +322,14 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "Sending emails to: " + attendeeEmails, ); - renderEmail( - req.app.get("hbsInstance"), - "deleteEvent/deleteEvent", + sendEmailFromTemplate( + attendeeEmails, + '', + `${event?.name} was deleted`, + "deleteEvent", { eventName: event?.name, }, - ).then( - ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: ${event?.name} was deleted`, text, html) ).catch((e) => { console.error('error sending attendy email', e.toString()); res.status(500).end(); @@ -634,6 +627,10 @@ router.post("/attendevent/:eventID", async (req, res) => { }, ) .then((event) => { + if (!event) { + return res.sendStatus(404); + } + addToLog( "addEventAttendee", "success", @@ -641,9 +638,11 @@ router.post("/attendevent/:eventID", async (req, res) => { ); if (sendEmails) { if (req.body.attendeeEmail) { - renderEmail( - req.app.get("hbsInstance"), - "addEventAttendee/addEventAttendee", + sendEmailFromTemplate( + req.body.attendeeEmail, + '', + `You're RSVPed to ${event.name}`, + "addEventAttendee", { eventID: req.params.eventID, removalPassword: req.body.removalPassword, @@ -651,8 +650,6 @@ router.post("/attendevent/:eventID", async (req, res) => { req.body.removalPassword, ), }, - ).then( - ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You're RSVPed to ${event.name}`, text, html) ).catch((e) => { console.error('error sending addEventAttendee email', e.toString()); res.status(500).end(); @@ -686,11 +683,14 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { ) { return res.sendStatus(200); } - Event.updateOne( + Event.findOneAndUpdate( { id: req.params.eventID }, { $pull: { attendees: { _id: req.params.attendeeID } } }, ) - .then((response) => { + .then((event) => { + if (!event) { + return res.sendStatus(404); + } addToLog( "oneClickUnattend", "success", @@ -699,14 +699,14 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - renderEmail( - req.app.get("hbsInstance"), - "removeEventAttendee/removeEventAttendee", + sendEmailFromTemplate( + req.body.attendeeEmail, + '', + `You have been removed from an event`, + "removeEventAttendee", { - eventName: req.params.eventName, + eventName: event.name, }, - ).then( - ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -732,11 +732,14 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { }); router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { - Event.updateOne( + Event.findOneAndUpdate( { id: req.params.eventID }, { $pull: { attendees: { _id: req.params.attendeeID } } }, ) - .then((response) => { + .then((event) => { + if (!event) { + return res.sendStatus(404); + } addToLog( "removeEventAttendee", "success", @@ -745,14 +748,14 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - renderEmail( - req.app.get("hbsInstance"), - "removeEventAttendee/removeEventAttendee", + sendEmailFromTemplate( + req.body.attendeeEmail, + '', + `You have been removed from an event`, + "removeEventAttendee", { - eventName: req.params.eventName, + eventName: event.name, }, - ).then( - ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -798,16 +801,16 @@ router.post("/subscribe/:eventGroupID", (req, res) => { eventGroup.subscribers.push(subscriber); eventGroup.save(); if (sendEmails) { - renderEmail( - req.app.get("hbsInstance"), - "subscribed/subscribed", + sendEmailFromTemplate( + subscriber.email, + '', + `You have subscribed to an event group`, + "subscribed", { eventGroupName: eventGroup.name, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(subscriber.email), }, - ).then( - ({ html, text }) => sendEmail(subscriber.email, '', `${siteName}: You have subscribed to an event group`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -875,7 +878,9 @@ router.post("/post/comment/:eventID", (req, res) => { id: req.params.eventID, }, function (err, event) { - if (!event) return; + if (!event) { + return res.sendStatus(404); + } event.comments.push(newComment); event .save() @@ -914,15 +919,15 @@ router.post("/post/comment/:eventID", (req, res) => { console.log( "Sending emails to: " + attendeeEmails, ); - renderEmail( - req.app.get("hbsInstance"), - "addEventComment/addEventComment", + sendEmailFromTemplate( + event?.creatorEmail || config.general.email, + attendeeEmails, + `New comment in ${event.name}`, + "addEventComment", { eventID: req.params.eventID, commentAuthor: req.body.commentAuthor, }, - ).then( - ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -967,7 +972,9 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { id: req.params.eventID, }, function (err, event) { - if (!event) return; + if (!event) { + return res.sendStatus(404); + } var parentComment = event.comments.id(commentID); parentComment.replies.push(newReply); event @@ -999,6 +1006,9 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { if (sendEmails) { Event.findOne({ id: req.params.eventID }).then( (event) => { + if (!event) { + return res.sendStatus(404); + } const attendeeEmails = event.attendees .filter( (o) => @@ -1009,15 +1019,15 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { console.log( "Sending emails to: " + attendeeEmails, ); - renderEmail( - req.app.get("hbsInstance"), - "addEventComment/addEventComment", + sendEmailFromTemplate( + event?.creatorEmail || config.general.email, + attendeeEmails, + `New comment in ${event.name}`, + "addEventComment", { eventID: req.params.eventID, commentAuthor: req.body.replyAuthor, }, - ).then( - ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); diff --git a/src/routes/event.ts b/src/routes/event.ts index de5cb4c..f97adc9 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -80,8 +80,8 @@ router.post( }); } - let eventID = generateEventID(); - let editToken = generateEditToken(); + const eventID = generateEventID(); + const editToken = generateEditToken(); let eventImageFilename; let isPartOfEventGroup = false; @@ -125,7 +125,7 @@ router.post( } // generate RSA keypair for ActivityPub - let { publicKey, privateKey } = generateRSAKeypair(); + const { publicKey, privateKey } = generateRSAKeypair(); const event = new Event({ id: eventID, @@ -202,11 +202,7 @@ router.post( { eventID, editToken, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, - }, - req, + } ); } // If the event was added to a group, send an email to any group @@ -237,17 +233,12 @@ router.post( `New event in ${eventGroup.name}`, "eventGroupUpdated", { - siteName: res.locals.config?.general.site_name, - siteLogo: - res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, eventGroupName: eventGroup.name, eventName: event.name, eventID: event.id, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(emailAddress), - }, - req, + } ); }); } catch (err) { @@ -332,7 +323,7 @@ router.put( } // Token matches // If there is a new image, upload that first - let eventID = req.params.eventID; + const eventID = req.params.eventID; let eventImageFilename = event.image; if (req.file?.buffer) { Jimp.read(req.file.buffer) @@ -452,7 +443,7 @@ router.put( "Event " + req.params.eventID + " edited", ); // send update to ActivityPub subscribers - let attendees = updatedEventObject.attendees?.filter((el) => el.id); + const attendees = updatedEventObject.attendees?.filter((el) => el.id); // broadcast an identical message to all followers, will show in home timeline const guidObject = crypto.randomBytes(16).toString("hex"); const jsonObject = { @@ -495,21 +486,17 @@ router.put( if (req.app.locals.sendEmails) { const attendeeEmails = event.attendees ?.filter((o) => o.status === "attending" && o.email) - .map((o) => o.email); + .map((o) => o.email!); if (attendeeEmails?.length) { sendEmailFromTemplate( config.general.email, - attendeeEmails.join(","), + attendeeEmails, `${event.name} was just edited`, "editEvent", { diffText, eventID: req.params.eventID, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } } @@ -550,12 +537,12 @@ router.post( }); } - let eventID = generateEventID(); - let editToken = generateEditToken(); + const eventID = generateEventID(); + const editToken = generateEditToken(); - let iCalObject = ical.parseICS(req.file.buffer.toString("utf8")); + const iCalObject = ical.parseICS(req.file.buffer.toString("utf8")); - let importedEventData = iCalObject[Object.keys(iCalObject)[0]]; + const importedEventData = iCalObject[Object.keys(iCalObject)[0]]; let creatorEmail: string | undefined; if (req.body.creatorEmail) { @@ -620,11 +607,7 @@ router.post( { eventID, editToken, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } return res.json({ @@ -700,11 +683,7 @@ router.delete( "unattendEvent", { eventID: req.params.eventID, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } res.sendStatus(200); @@ -752,11 +731,7 @@ router.get( "unattendEvent", { event, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } return res.redirect(`/${req.params.eventID}?m=unattend`); diff --git a/src/routes/group.ts b/src/routes/group.ts index 9f4105c..c63413e 100644 --- a/src/routes/group.ts +++ b/src/routes/group.ts @@ -101,11 +101,7 @@ router.post( { eventGroupID: eventGroup.id, editToken: eventGroup.editToken, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } @@ -182,7 +178,7 @@ router.put( } // Token matches // If there is a new image, upload that first - let eventGroupID = req.params.eventGroupID; + const eventGroupID = req.params.eventGroupID; let eventGroupImageFilename = eventGroup.image; if (req.file?.buffer) { Jimp.read(req.file.buffer) diff --git a/src/routes/magicLink.ts b/src/routes/magicLink.ts index b4afca6..8d0f147 100644 --- a/src/routes/magicLink.ts +++ b/src/routes/magicLink.ts @@ -54,12 +54,8 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { `Magic link to create an event`, "createEventMagicLink", { - token, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, + token }, - req, ); res.render("createEventMagicLink", { ...frontendConfig(res), -- cgit v1.2.3 From 14041a319cace03cfc23c0a919ed81fb141f88ce Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Fri, 25 Apr 2025 21:43:39 -0700 Subject: Refactor to have email service MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Move hbsInstance back to app * Add email and hbs to req so typescript 🎉🎉🎉 * Init Email and config once --- src/app.ts | 47 +++++++- src/index.d.ts | 17 +-- src/lib/config.ts | 70 +++++++---- src/lib/email.ts | 263 ++++++++++++++++++++-------------------- src/lib/handlebars.ts | 55 --------- src/routes.js | 313 +++++++++++++++++++++++------------------------- src/routes/event.ts | 146 +++++++++++----------- src/routes/group.ts | 22 ++-- src/routes/magicLink.ts | 14 +-- 9 files changed, 458 insertions(+), 489 deletions(-) delete mode 100644 src/lib/handlebars.ts (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 5f7c024..7ed535c 100755 --- a/src/app.ts +++ b/src/app.ts @@ -1,5 +1,6 @@ import express from "express"; import cookieParser from "cookie-parser"; +import { create as createHandlebars, ExpressHandlebars } from "express-handlebars"; import routes from "./routes.js"; import frontend from "./routes/frontend.js"; @@ -8,22 +9,56 @@ import event from "./routes/event.js"; import group from "./routes/group.js"; import staticPages from "./routes/static.js"; import magicLink from "./routes/magicLink.js"; - -import { initEmailService } from "./lib/email.js"; import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; -import { HandlebarsSingleton } from "./lib/handlebars.js"; +import { EmailService } from "./lib/email.js"; +import getConfig from "./lib/config.js"; const app = express(); +const config = getConfig(); + +const hbsInstance = createHandlebars({ + defaultLayout: "main", + partialsDir: ["views/partials/"], + layoutsDir: "views/layouts/", + helpers: { + plural: function (number: number, text: string) { + const singular = number === 1; + // If no text parameter was given, just return a conditional s. + if (typeof text !== "string") return singular ? "" : "s"; + // Split with regex into group1/group2 or group1(group3) + const match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); + // If no match, just append a conditional s. + if (!match) return text + (singular ? "" : "s"); + // We have a good match, so fire away + return ( + (singular && match[1]) || // Singular case + match[2] || // Plural case: 'bagel/bagels' --> bagels + match[1] + (match[3] || "s") + ); // Plural case: 'bagel(s)' or 'bagel' --> bagels + }, + json: function (context: object) { + return JSON.stringify(context); + }, + }, +}); + +const emailService = new EmailService(config, hbsInstance); +emailService.verify(); -initEmailService().then((sendEmails) => (app.locals.sendEmails = sendEmails)); +app.use((req: express.Request, _: express.Response, next: express.NextFunction) => { + req.hbsInstance = hbsInstance; + req.emailService = emailService; + next() + return +}) // View engine // -app.engine("handlebars", HandlebarsSingleton.instance.engine); +app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); -app.set("hbsInstance", HandlebarsSingleton.instance); +app.set("hbsInstance", hbsInstance); // Static files // app.use(express.static("public")); diff --git a/src/index.d.ts b/src/index.d.ts index 292e5d3..4811f7f 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -1,14 +1,17 @@ import "express"; -import { GathioConfig } from "./lib/config.js"; +import { GathioConfig } from "./lib/config.ts"; +import { EmailService } from "./lib/email.ts"; +import { ExpressHandlebars } from "express-handlebars"; interface Locals { config: GathioConfig; } -declare module "express" { - export interface Response { - locals: { - config?: GathioConfig; - }; +declare global { + namespace Express { + interface Request extends Express.Request { + hbsInstance: ExpressHandlebars; + emailService: EmailService; + } } -} +} \ No newline at end of file diff --git a/src/lib/config.ts b/src/lib/config.ts index 003a714..6642eef 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -110,46 +110,46 @@ export const instanceRules = (): InstanceRule[] => { rules.push( config.general.show_public_event_list ? { - text: "Public events and groups are displayed on the homepage", - icon: "fas fa-eye", - } + text: "Public events and groups are displayed on the homepage", + icon: "fas fa-eye", + } : { - text: "Events and groups can only be accessed by direct link", - icon: "fas fa-eye-slash", - }, + text: "Events and groups can only be accessed by direct link", + icon: "fas fa-eye-slash", + }, ); rules.push( config.general.creator_email_addresses?.length ? { - text: "Only specific people can create events and groups", - icon: "fas fa-user-check", - } + text: "Only specific people can create events and groups", + icon: "fas fa-user-check", + } : { - text: "Anyone can create events and groups", - icon: "fas fa-users", - }, + text: "Anyone can create events and groups", + icon: "fas fa-users", + }, ); rules.push( config.general.delete_after_days > 0 ? { - text: `Events are automatically deleted ${config.general.delete_after_days} days after they end`, - icon: "far fa-calendar-times", - } + text: `Events are automatically deleted ${config.general.delete_after_days} days after they end`, + icon: "far fa-calendar-times", + } : { - text: "Events are permanent, and are never automatically deleted", - icon: "far fa-calendar-check", - }, + text: "Events are permanent, and are never automatically deleted", + icon: "far fa-calendar-check", + }, ); rules.push( config.general.is_federated ? { - text: "This instance federates with other instances using ActivityPub", - icon: "fas fa-globe", - } + text: "This instance federates with other instances using ActivityPub", + icon: "fas fa-globe", + } : { - text: "This instance does not federate with other instances", - icon: "fas fa-globe", - }, + text: "This instance does not federate with other instances", + icon: "fas fa-globe", + }, ); return rules; }; @@ -179,17 +179,35 @@ export const instanceDescription = (): string => { } }; +let _resolvedConfig: GathioConfig | null = null; // Attempt to load our global config. Will stop the app if the config file // cannot be read (there's no point trying to continue!) export const getConfig = (): GathioConfig => { + if (_resolvedConfig) { + return _resolvedConfig; + } + try { const config = toml.parse( fs.readFileSync("./config/config.toml", "utf-8"), ) as GathioConfig; - return { + const resolvedConfig = { ...defaultConfig, ...config, - }; + } + if (process.env.CYPRESS || process.env.CI) { + config.general.mail_service = "none"; + console.log( + "Running in Cypress or CI, not initializing email service.", + ); + } else if (config.general.mail_service === "none") { + console.warn( + "You have not configured this Gathio instance to send emails! This means that event creators will not receive emails when their events are created, which means they may end up locked out of editing events. Consider setting up an email service.", + ); + } + + _resolvedConfig = resolvedConfig; + return resolvedConfig; } catch { exitWithError( "Configuration file not found! Have you renamed './config/config-example.toml' to './config/config.toml'?", diff --git a/src/lib/email.ts b/src/lib/email.ts index 57f69f5..7c7c2dd 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -1,11 +1,10 @@ import sgMail from "@sendgrid/mail"; import sgHelpers from "@sendgrid/helpers"; - +import { ExpressHandlebars } from "express-handlebars"; import nodemailer, { Transporter } from "nodemailer"; -import { getConfig } from "./config.js"; +import { GathioConfig, getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; -import { HandlebarsSingleton } from "./handlebars.js"; const config = getConfig(); @@ -22,58 +21,65 @@ type EmailTemplateName = | "subscribed" | "unattendEvent"; -export const initEmailService = async (): Promise => { - if (process.env.CYPRESS || process.env.CI) { - console.log( - "Running in Cypress or CI, not initializing email service.", - ); - return false; - } - switch (config.general.mail_service) { - case "sendgrid": - if (!config.sendgrid?.api_key) { - return exitWithError( - "Sendgrid is configured as the email service, but no API key is provided. Please provide an API key in the config file.", - ); - } - sgMail.setApiKey(config.sendgrid.api_key); - console.log("Sendgrid is ready to send emails."); - return true; - case "nodemailer": { - let nodemailerTransporter: Transporter | undefined = undefined; - if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport( - config.nodemailer?.smtp_url, - ); - } else { - if ( - !config.nodemailer?.smtp_server || - !config.nodemailer?.smtp_port - ) { +export class EmailService { + nodemailerTransporter: Transporter | undefined = undefined; + sgMail: typeof sgMail | undefined = undefined; + hbs: ExpressHandlebars + + public constructor(config: GathioConfig, hbs: ExpressHandlebars) { + this.hbs = hbs; + switch (config.general.mail_service) { + case "sendgrid": { + if (!config.sendgrid?.api_key) { return exitWithError( - "Nodemailer is configured as the email service, but not all required fields are provided. Please provide all required fields in the config file.", + "Sendgrid is configured as the email service, but no API key is provided. Please provide an API key in the config file.", ); } - const nodemailerConfig = { - host: config.nodemailer?.smtp_server, - port: Number(config.nodemailer?.smtp_port) || 587, - tls: { - // do not fail on invalid certs - rejectUnauthorized: false, - }, - } as SMTPTransport.Options; + this.sgMail = sgMail; + this.sgMail.setApiKey(config.sendgrid.api_key); + console.log("Sendgrid is ready to send emails."); + break; + } + case "nodemailer": { + if (config.nodemailer?.smtp_url) { + this.nodemailerTransporter = nodemailer.createTransport( + config.nodemailer?.smtp_url, + ); + } else { + if ( + !config.nodemailer?.smtp_server || + !config.nodemailer?.smtp_port + ) { + return exitWithError( + "Nodemailer is configured as the email service, but not all required fields are provided. Please provide all required fields in the config file.", + ); + } + const nodemailerConfig = { + host: config.nodemailer?.smtp_server, + port: Number(config.nodemailer?.smtp_port) || 587, + tls: { + // do not fail on invalid certs + rejectUnauthorized: false, + }, + } as SMTPTransport.Options; - if (config.nodemailer?.smtp_username) { - nodemailerConfig.auth = { - user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password, - }; + if (config.nodemailer?.smtp_username) { + nodemailerConfig.auth = { + user: config.nodemailer?.smtp_username, + pass: config.nodemailer?.smtp_password, + }; + } + this.nodemailerTransporter = + nodemailer.createTransport(nodemailerConfig); } - nodemailerTransporter = - nodemailer.createTransport(nodemailerConfig); } - const nodemailerVerified = await nodemailerTransporter.verify(); + } + } + + public async verify(): Promise { + if (this.nodemailerTransporter) { + const nodemailerVerified = await this.nodemailerTransporter.verify(); if (nodemailerVerified) { console.log("Nodemailer is ready to send emails."); return true; @@ -83,30 +89,29 @@ export const initEmailService = async (): Promise => { ); } } - case "none": - default: - console.warn( - "You have not configured this Gathio instance to send emails! This means that event creators will not receive emails when their events are created, which means they may end up locked out of editing events. Consider setting up an email service.", - ); - return false; + return true; } -}; -export const sendEmail = async ( - to: string | string[], - bcc: string | string[] | undefined, - subject: string, - text: string, - html?: string, -): Promise => { - switch (config.general.mail_service) { - case "sendgrid": + public async sendEmail({ + to, + bcc, + subject, + text, + html, + }: { + to: string | string[]; + bcc?: string | string[]; + subject: string; + text: string; + html?: string; + }): Promise { + if (this.sgMail) { try { - await sgMail.send({ + await this.sgMail.send({ to, bcc, from: config.general.email, - subject: `${config.general.site_name}: ${subject}`, + subject, text, html, }); @@ -119,34 +124,13 @@ export const sendEmail = async ( } return false; } - case "nodemailer": + } else if (this.nodemailerTransporter) { try { - let nodemailerTransporter: Transporter | undefined = undefined; - if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport( - config.nodemailer?.smtp_url, - ); - } else { - const nodemailerConfig = { - host: config.nodemailer?.smtp_server, - port: Number(config.nodemailer?.smtp_port) || 587, - } as SMTPTransport.Options; - - if (config.nodemailer?.smtp_username) { - nodemailerConfig.auth = { - user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password, - }; - } - - nodemailerTransporter = - nodemailer.createTransport(nodemailerConfig); - } - await nodemailerTransporter.sendMail({ + await this.nodemailerTransporter.sendMail({ from: config.general.email, to, bcc, - subject: `${config.general.site_name}: ${subject}`, + subject, text, html, }); @@ -155,48 +139,63 @@ export const sendEmail = async ( console.error(e); return false; } - default: - return false; + } else { + // no mailer, so noop + return true; + } } -}; -export const sendEmailFromTemplate = async ( - to: string | string[], - bcc: string | string[] | undefined, - subject: string, - templateName: EmailTemplateName, - templateData: object, -): Promise => { - const [html, text] = await Promise.all([ - HandlebarsSingleton.instance.renderView( - `./views/emails/${templateName}/${templateName}Html.handlebars`, - { - domain: config.general.domain, - contactEmail: config.general.email, - siteName: config.general.site_name, - mailService: config.general.mail_service, - siteLogo: config.general.email_logo_url, - isFederated: config.general.is_federated || true, - cache: true, - layout: "email.handlebars", - ...templateData, - } - ), - HandlebarsSingleton.instance.renderView( - `./views/emails/${templateName}/${templateName}Text.handlebars`, - { - domain: config.general.domain, - contactEmail: config.general.email, - siteName: config.general.site_name, - mailService: config.general.mail_service, - siteLogo: config.general.email_logo_url, - isFederated: config.general.is_federated || true, - cache: true, - layout: "email.handlebars", - ...templateData, - } - ), - ]); + public async sendEmailFromTemplate({ + to, + bcc = "", + subject, + templateName, + templateData = {} + }: { + to: string | string[]; + bcc?: string | string[] | undefined; + subject: string; + templateName: EmailTemplateName; + templateData?: object; + }, + ): Promise { + const [html, text] = await Promise.all([ + this.hbs.renderView( + `./views/emails/${templateName}/${templateName}Html.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + this.hbs.renderView( + `./views/emails/${templateName}/${templateName}Text.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + ]); - return await sendEmail(to, bcc, subject, text, html); -}; + return this.sendEmail({ + to, + bcc, + subject: `${config.general.site_name}: ${subject}`, + text, + html + }); + } +} diff --git a/src/lib/handlebars.ts b/src/lib/handlebars.ts deleted file mode 100644 index 6d4f796..0000000 --- a/src/lib/handlebars.ts +++ /dev/null @@ -1,55 +0,0 @@ -import hbs, { ExpressHandlebars } from "express-handlebars"; -import { RenderViewOptions } from "express-handlebars/types/index.js"; - -export class HandlebarsSingleton { - static #instance: HandlebarsSingleton; - hbsInstance: hbs.ExpressHandlebars; - - private constructor() { - this.hbsInstance = hbs.create({ - defaultLayout: "main", - partialsDir: ["views/partials/"], - layoutsDir: "views/layouts/", - helpers: { - plural: function (number: number, text: string) { - const singular = number === 1; - // If no text parameter was given, just return a conditional s. - if (typeof text !== "string") return singular ? "" : "s"; - // Split with regex into group1/group2 or group1(group3) - const match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); - // If no match, just append a conditional s. - if (!match) return text + (singular ? "" : "s"); - // We have a good match, so fire away - return ( - (singular && match[1]) || // Singular case - match[2] || // Plural case: 'bagel/bagels' --> bagels - match[1] + (match[3] || "s") - ); // Plural case: 'bagel(s)' or 'bagel' --> bagels - }, - json: function (context: object) { - return JSON.stringify(context); - }, - }, - }); - } - - public static get instance(): HandlebarsSingleton { - if (!HandlebarsSingleton.#instance) { - HandlebarsSingleton.#instance = new HandlebarsSingleton(); - } - - return HandlebarsSingleton.#instance; - } - - public get engine(): ExpressHandlebars["engine"] { - return this.hbsInstance.engine; - } - - /** - * Finally, any singleton can define some business logic, which can be - * executed on its instance. - */ - public renderView(viewPath: string, options: RenderViewOptions): Promise { - return this.hbsInstance.renderView(viewPath, options); - } -} diff --git a/src/routes.js b/src/routes.js index d5b5877..d0fd9fc 100755 --- a/src/routes.js +++ b/src/routes.js @@ -22,7 +22,7 @@ import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; -import { initEmailService, sendEmailFromTemplate } from "./lib/email.js"; +import { EmailService } from "./lib/email.js"; const config = getConfig(); const domain = config.general.domain; @@ -36,10 +36,6 @@ const nanoid = customAlphabet( ); const router = express.Router(); - -let sendEmails = false; -initEmailService().then((emailService) => (sendEmails = emailService)); - router.use(fileUpload()); // SCHEDULED DELETION @@ -309,34 +305,30 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { }); res.end(); - // Send emails here otherwise they don't exist lol - if (sendEmails) { - const attendeeEmails = event?.attendees?.filter( - (o) => - o.status === "attending" && - o.email, - ) - .map((o) => o.email || '') || []; - if (attendeeEmails.length) { - console.log( - "Sending emails to: " + - attendeeEmails, - ); - sendEmailFromTemplate( - attendeeEmails, - '', - `${event?.name} was deleted`, - "deleteEvent", - { - eventName: event?.name, - }, - ).catch((e) => { - console.error('error sending attendy email', e.toString()); - res.status(500).end(); - }); - } else { - console.log("Nothing to send!"); - } + const attendeeEmails = event?.attendees?.filter( + (o) => + o.status === "attending" && + o.email, + ) + .map((o) => o.email || '') || []; + if (attendeeEmails.length) { + console.log( + "Sending emails to: " + + attendeeEmails, + ); + req.emailService.sendEmailFromTemplate({ + to: attendeeEmails, + subject: `${event?.name} was deleted`, + templateName: "deleteEvent", + templateData: { + eventName: event?.name, + }, + }).catch((e) => { + console.error('error sending attendee email', e.toString()); + res.status(500).end(); + }); + } else { + console.log("Nothing to send!"); } }) .catch((err) => { @@ -636,25 +628,22 @@ router.post("/attendevent/:eventID", async (req, res) => { "success", "Attendee added to event " + req.params.eventID, ); - if (sendEmails) { - if (req.body.attendeeEmail) { - sendEmailFromTemplate( - req.body.attendeeEmail, - '', - `You're RSVPed to ${event.name}`, - "addEventAttendee", - { - eventID: req.params.eventID, - removalPassword: req.body.removalPassword, - removalPasswordHash: hashString( - req.body.removalPassword, - ), - }, - ).catch((e) => { - console.error('error sending addEventAttendee email', e.toString()); - res.status(500).end(); - }); - } + if (req.body.attendeeEmail) { + req.emailService.sendEmailFromTemplate({ + to: req.body.attendeeEmail, + subject: `You're RSVPed to ${event.name}`, + templateName: "addEventAttendee", + templateData:{ + eventID: req.params.eventID, + removalPassword: req.body.removalPassword, + removalPasswordHash: hashString( + req.body.removalPassword, + ), + }, + }).catch((e) => { + console.error('error sending addEventAttendee email', e.toString()); + res.status(500).end(); + }); } res.redirect(`/${req.params.eventID}`); }) @@ -696,22 +685,19 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { "success", "Attendee removed via one click unattend " + req.params.eventID, ); - if (sendEmails) { - // currently this is never called because we don't have the email address - if (req.body.attendeeEmail) { - sendEmailFromTemplate( - req.body.attendeeEmail, - '', - `You have been removed from an event`, - "removeEventAttendee", - { - eventName: event.name, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } + // currently this is never called because we don't have the email address + if (req.body.attendeeEmail) { + req.emailService.sendEmailFromTemplate({ + to: req.body.attendeeEmail, + subject: `You have been removed from an event`, + templateName: "removeEventAttendee", + templateData:{ + eventName: event.name, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } res.writeHead(302, { Location: "/" + req.params.eventID, @@ -745,22 +731,19 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { "success", "Attendee removed by admin from event " + req.params.eventID, ); - if (sendEmails) { - // currently this is never called because we don't have the email address - if (req.body.attendeeEmail) { - sendEmailFromTemplate( - req.body.attendeeEmail, - '', - `You have been removed from an event`, - "removeEventAttendee", - { - eventName: event.name, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } + // currently this is never called because we don't have the email address + if (req.body.attendeeEmail) { + req.emailService.sendEmailFromTemplate({ + to: req.body.attendeeEmail, + subject: `You have been removed from an event`, + templateName: "removeEventAttendee", + templateData: { + eventName: event.name, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } res.writeHead(302, { Location: "/" + req.params.eventID, @@ -800,22 +783,20 @@ router.post("/subscribe/:eventGroupID", (req, res) => { } eventGroup.subscribers.push(subscriber); eventGroup.save(); - if (sendEmails) { - sendEmailFromTemplate( - subscriber.email, - '', - `You have subscribed to an event group`, - "subscribed", - { - eventGroupName: eventGroup.name, - eventGroupID: eventGroup.id, - emailAddress: encodeURIComponent(subscriber.email), - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } + req.emailService.sendEmailFromTemplate({ + to: subscriber.email, + subject: "You have subscribed to an event group", + templateName: "subscribed", + templateData:{ + eventGroupName: eventGroup.name, + eventGroupID: eventGroup.id, + emailAddress: encodeURIComponent(subscriber.email), + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); + return res.redirect(`/group/${eventGroup.id}`); }) .catch((error) => { @@ -906,38 +887,40 @@ router.post("/post/comment/:eventID", (req, res) => { event.followers, req.params.eventID, ); - if (sendEmails) { - Event.findOne({ id: req.params.eventID }).then( - (event) => { - const attendeeEmails = event.attendees - .filter( - (o) => - o.status === "attending" && o.email, - ) - .map((o) => o.email || '') || []; - if (attendeeEmails.length) { - console.log( - "Sending emails to: " + attendeeEmails, - ); - sendEmailFromTemplate( - event?.creatorEmail || config.general.email, - attendeeEmails, - `New comment in ${event.name}`, - "addEventComment", - { - eventID: req.params.eventID, - commentAuthor: req.body.commentAuthor, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } else { - console.log("Nothing to send!"); - } - }, - ); + if (!event) { + return res.sendStatus(404); } + + Event.findOne({ id: req.params.eventID }).then( + (event) => { + const attendeeEmails = event.attendees + .filter( + (o) => + o.status === "attending" && o.email, + ) + .map((o) => o.email || '') || []; + if (attendeeEmails.length) { + console.log( + "Sending emails to: " + attendeeEmails, + ); + req.emailService.sendEmailFromTemplate({ + to: event?.creatorEmail || config.general.email, + bcc: attendeeEmails, + subject: `New comment in ${event.name}`, + templateName: "addEventComment", + templateData:{ + eventID: req.params.eventID, + commentAuthor: req.body.commentAuthor, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); + } else { + console.log("Nothing to send!"); + } + }, + ); res.writeHead(302, { Location: "/" + req.params.eventID, }); @@ -1003,41 +986,39 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { event.followers, req.params.eventID, ); - if (sendEmails) { - Event.findOne({ id: req.params.eventID }).then( - (event) => { - if (!event) { - return res.sendStatus(404); - } - const attendeeEmails = event.attendees - .filter( - (o) => - o.status === "attending" && o.email, - ) - .map((o) => o.email || '') || []; - if (attendeeEmails.length) { - console.log( - "Sending emails to: " + attendeeEmails, - ); - sendEmailFromTemplate( - event?.creatorEmail || config.general.email, - attendeeEmails, - `New comment in ${event.name}`, - "addEventComment", - { - eventID: req.params.eventID, - commentAuthor: req.body.replyAuthor, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } else { - console.log("Nothing to send!"); - } - }, - ); - } + Event.findOne({ id: req.params.eventID }).then( + (event) => { + if (!event) { + return res.sendStatus(404); + } + const attendeeEmails = event.attendees + .filter( + (o) => + o.status === "attending" && o.email, + ) + .map((o) => o.email || '') || []; + if (attendeeEmails.length) { + console.log( + "Sending emails to: " + attendeeEmails, + ); + req.emailService.sendEmailFromTemplate({ + to: event?.creatorEmail || config.general.email, + bcc: attendeeEmails, + subject: `New comment in ${event.name}`, + templateName: "addEventComment", + templateData: { + eventID: req.params.eventID, + commentAuthor: req.body.replyAuthor, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); + } else { + console.log("Nothing to send!"); + } + }, + ); res.writeHead(302, { Location: "/" + req.params.eventID, }); diff --git a/src/routes/event.ts b/src/routes/event.ts index f97adc9..ee45d96 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -22,14 +22,13 @@ import { updateActivityPubActor, updateActivityPubEvent, } from "../activitypub.js"; -import { sendEmailFromTemplate } from "../lib/email.js"; import crypto from "crypto"; import ical from "ical"; import { markdownToSanitizedHTML } from "../util/markdown.js"; import { checkMagicLink, getConfigMiddleware } from "../lib/middleware.js"; import { getConfig } from "../lib/config.js"; -const config = getConfig(); +const config = getConfig(); const storage = multer.memoryStorage(); // Accept only JPEG, GIF or PNG images, up to 10MB @@ -193,21 +192,20 @@ router.post( const savedEvent = await event.save(); addToLog("createEvent", "success", "Event " + eventID + "created"); // Send email with edit link - if (eventData.creatorEmail && req.app.locals.sendEmails) { - sendEmailFromTemplate( - eventData.creatorEmail, - "", - `${eventData.eventName}`, - "createEvent", - { + if (eventData.creatorEmail) { + req.emailService.sendEmailFromTemplate({ + to: eventData.creatorEmail, + subject: eventData.eventName, + templateName: "createEvent", + templateData: { eventID, editToken, } - ); + }); } // If the event was added to a group, send an email to any group // subscribers - if (event.eventGroup && req.app.locals.sendEmails) { + if (event.eventGroup) { try { const eventGroup = await EventGroup.findOne({ _id: event.eventGroup.toString(), @@ -227,19 +225,18 @@ router.post( [] as string[], ); subscribers?.forEach((emailAddress) => { - sendEmailFromTemplate( - emailAddress, - "", - `New event in ${eventGroup.name}`, - "eventGroupUpdated", - { + req.emailService.sendEmailFromTemplate({ + to: emailAddress, + subject: `New event in ${eventGroup.name}`, + templateName: "eventGroupUpdated", + templateData: { eventGroupName: eventGroup.name, eventName: event.name, eventID: event.id, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(emailAddress), } - ); + }); }); } catch (err) { console.error(err); @@ -247,7 +244,7 @@ router.post( "createEvent", "error", "Attempt to send event group emails failed with error: " + - err, + err, ); } } @@ -379,24 +376,24 @@ router.put( eventGroup: isPartOfEventGroup ? eventGroup?._id : null, activityPubActor: event.activityPubActor ? updateActivityPubActor( - JSON.parse(event.activityPubActor), - eventData.eventDescription, - eventData.eventName, - eventData.eventLocation, - eventImageFilename, - startUTC, - endUTC, - eventData.timezone, - ) + JSON.parse(event.activityPubActor), + eventData.eventDescription, + eventData.eventName, + eventData.eventLocation, + eventImageFilename, + startUTC, + endUTC, + eventData.timezone, + ) : undefined, activityPubEvent: event.activityPubEvent ? updateActivityPubEvent( - JSON.parse(event.activityPubEvent), - eventData.eventName, - startUTC, - endUTC, - eventData.timezone, - ) + JSON.parse(event.activityPubEvent), + eventData.eventName, + startUTC, + endUTC, + eventData.timezone, + ) : undefined, }; let diffText = @@ -483,22 +480,20 @@ router.put( } } // Send update to all attendees - if (req.app.locals.sendEmails) { - const attendeeEmails = event.attendees - ?.filter((o) => o.status === "attending" && o.email) - .map((o) => o.email!); - if (attendeeEmails?.length) { - sendEmailFromTemplate( - config.general.email, - attendeeEmails, - `${event.name} was just edited`, - "editEvent", - { - diffText, - eventID: req.params.eventID, - }, - ); - } + const attendeeEmails = event.attendees + ?.filter((o) => o.status === "attending" && o.email) + .map((o) => o.email!); + if (attendeeEmails?.length) { + req.emailService.sendEmailFromTemplate({ + to: config.general.email, + bcc: attendeeEmails, + subject: `${event.name} was just edited`, + templateName: "editEvent", + templateData: { + diffText, + eventID: req.params.eventID, + }, + }); } res.sendStatus(200); } catch (err) { @@ -507,9 +502,9 @@ router.put( "editEvent", "error", "Attempt to edit event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); return res.status(500).json({ errors: [ @@ -598,17 +593,16 @@ router.post( await event.save(); addToLog("createEvent", "success", `Event ${eventID} created`); // Send email with edit link - if (creatorEmail && req.app.locals.sendEmails) { - sendEmailFromTemplate( - creatorEmail, - "", - `${importedEventData.summary}`, - "createEvent", - { + if (creatorEmail) { + req.emailService.sendEmailFromTemplate({ + to: creatorEmail, + subject: importedEventData.summary || "", + templateName: "createEvent", + templateData: { eventID, editToken, }, - ); + }); } return res.json({ eventID: eventID, @@ -675,16 +669,15 @@ router.delete( "success", `Attendee removed self from event ${req.params.eventID}`, ); - if (attendeeEmail && req.app.locals.sendEmails) { - await sendEmailFromTemplate( - attendeeEmail, - "", - "You have been removed from an event", - "unattendEvent", - { + if (attendeeEmail) { + await req.emailService.sendEmailFromTemplate({ + to: attendeeEmail, + subject: "You have been removed from an event", + templateName: "unattendEvent", + templateData: { eventID: req.params.eventID, }, - ); + }); } res.sendStatus(200); } catch (e) { @@ -723,16 +716,15 @@ router.get( ); await event.save(); // Send email to the attendee - if (req.app.locals.sendEmails && attendee.email) { - sendEmailFromTemplate( - attendee.email, - "", - `You have been removed from ${event.name}`, - "unattendEvent", - { + if (attendee.email) { + req.emailService.sendEmailFromTemplate({ + to: attendee.email, + subject: `You have been removed from ${event.name}`, + templateName: "unattendEvent", + templateData: { event, }, - ); + }); } return res.redirect(`/${req.params.eventID}?m=unattend`); }, diff --git a/src/routes/group.ts b/src/routes/group.ts index c63413e..cc53976 100644 --- a/src/routes/group.ts +++ b/src/routes/group.ts @@ -5,7 +5,6 @@ import { validateGroupData } from "../util/validation.js"; import Jimp from "jimp"; import { addToLog } from "../helpers.js"; import EventGroup from "../models/EventGroup.js"; -import { sendEmailFromTemplate } from "../lib/email.js"; import { marked } from "marked"; import { renderPlain } from "../util/markdown.js"; import { checkMagicLink, getConfigMiddleware } from "../lib/middleware.js"; @@ -92,17 +91,16 @@ router.post( ); // Send email with edit link - if (groupData.creatorEmail && req.app.locals.sendEmails) { - sendEmailFromTemplate( - groupData.creatorEmail, - "", - `${eventGroup.name}`, - "createEventGroup", - { + if (groupData.creatorEmail) { + req.emailService.sendEmailFromTemplate({ + to: groupData.creatorEmail, + subject: eventGroup.name, + templateName: "createEventGroup", + templateData: { eventGroupID: eventGroup.id, editToken: eventGroup.editToken, }, - ); + }); } res.status(200).json({ @@ -224,9 +222,9 @@ router.put( "editEventGroup", "error", "Attempt to edit event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); return res.status(500).json({ errors: [ diff --git a/src/routes/magicLink.ts b/src/routes/magicLink.ts index 8d0f147..e0a6310 100644 --- a/src/routes/magicLink.ts +++ b/src/routes/magicLink.ts @@ -1,6 +1,5 @@ import { Router, Request, Response } from "express"; import { frontendConfig } from "../lib/config.js"; -import { sendEmailFromTemplate } from "../lib/email.js"; import { generateMagicLinkToken } from "../util/generator.js"; import MagicLink from "../models/MagicLink.js"; import { getConfigMiddleware } from "../lib/middleware.js"; @@ -48,15 +47,14 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { // Take this opportunity to delete any expired magic links await MagicLink.deleteMany({ expiryTime: { $lt: new Date() } }); - sendEmailFromTemplate( - email, - "", - `Magic link to create an event`, - "createEventMagicLink", - { + req.emailService.sendEmailFromTemplate({ + to: email, + subject: "Magic link to create an event", + templateName: "createEventMagicLink", + templateData: { token }, - ); + }); res.render("createEventMagicLink", { ...frontendConfig(res), message: { -- cgit v1.2.3 From 53e7e321d20cd7071ff617ecfcf42f6122020bcd Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Mon, 28 Apr 2025 19:16:28 -0700 Subject: switch to 3rd party merge which doesn't mutate config --- src/lib/middleware.ts | 2 +- src/util/object.ts | 30 ------------------------------ 2 files changed, 1 insertion(+), 31 deletions(-) delete mode 100644 src/util/object.ts (limited to 'src') diff --git a/src/lib/middleware.ts b/src/lib/middleware.ts index 5073137..69fbe4e 100644 --- a/src/lib/middleware.ts +++ b/src/lib/middleware.ts @@ -1,7 +1,7 @@ import { NextFunction, Request, Response } from "express"; import MagicLink from "../models/MagicLink.js"; import getConfig, { GathioConfig } from "../lib/config.js"; -import { deepMerge } from "../util/object.js"; +import { merge as deepMerge } from "ts-deepmerge"; export const checkMagicLink = async ( req: Request, diff --git a/src/util/object.ts b/src/util/object.ts deleted file mode 100644 index 1ecc89b..0000000 --- a/src/util/object.ts +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Simple object check. - */ -export function isObject(item: any) { - return item && typeof item === "object" && !Array.isArray(item); -} - -/** - * Deep merge two objects. - */ -export function deepMerge( - target: Record, - ...sources: Record[] -): T { - if (!sources.length) return target; - const source = sources.shift(); - - if (isObject(target) && isObject(source)) { - for (const key in source) { - if (isObject(source[key])) { - if (!target[key]) Object.assign(target, { [key]: {} }); - deepMerge(target[key], source[key]); - } else { - Object.assign(target, { [key]: source[key] }); - } - } - } - - return deepMerge(target, ...sources) as T; -} -- cgit v1.2.3