Feat/mailer

.env.example

@@ -24,4 +24,10 @@ MYBADGES_SERVERADMIN_USERNAME = ""
 MYBADGES_SERVERADMIN_PASSWORD = ""
 MYBADGES_ISSUERID_OSEM = ""
 MYBADGES_CLIENT_ID = ""
-MYBADGES_CLIENT_SECRET = ""
+MYBADGES_CLIENT_SECRET = ""
+
+SMTP_HOST = "localhost"
+SMTP_PORT = "1025"
+SMTP_SECURE = "false"
+SMTP_USERNAME = "ignored"
+SMTP_PASSWORD = "ignored"

app/components/device-detail/device-detail-box.tsx

@@ -107,8 +107,8 @@ export default function DeviceDetailBox() {
 
   const [sensors, setSensors] = useState<SensorWithLatestMeasurement[]>();
   useEffect(() => {
-    const sortedSensors = [...data.sensors as any].sort(
-      (a, b) => (a.id as unknown as number) - (b.id as unknown as number),
+    const sortedSensors = [...(data.sensors as any)].sort(
+      (a, b) => (a.id as unknown as number) - (b.id as unknown as number)
     );
     setSensors(sortedSensors);
   }, [data]);
@@ -373,13 +373,13 @@ export default function DeviceDetailBox() {
                                   ?.split(",")
                                   .includes(tag)
                                   ? "bg-green-100 dark:bg-dark-green"
-                                  : "",
+                                  : ""
                               )}
                               onClick={(event) => {
                                 event.stopPropagation();
 
                                 const currentParams = new URLSearchParams(
-                                  searchParams.toString(),
+                                  searchParams.toString()
                                 );
 
                                 // Safely retrieve and parse the current tags
@@ -395,7 +395,7 @@ export default function DeviceDetailBox() {
                                 if (updatedTags.length > 0) {
                                   currentParams.set(
                                     "tags",
-                                    updatedTags.join(","),
+                                    updatedTags.join(",")
                                   );
                                 } else {
                                   currentParams.delete("tags");
@@ -494,7 +494,7 @@ export default function DeviceDetailBox() {
                                           id={sensor.id}
                                           value={sensor.id}
                                           defaultChecked={sensorIds.has(
-                                            sensor.id,
+                                            sensor.id
                                           )}
                                         />
                                         <CardHeader className="flex flex-row items-center justify-between space-y-0 pb-2">
@@ -560,7 +560,7 @@ export default function DeviceDetailBox() {
                                           id={sensor.id}
                                           value={sensor.id}
                                           defaultChecked={sensorIds.has(
-                                            sensor.id,
+                                            sensor.id
                                           )}
                                         />
                                         <CardHeader className="flex flex-row items-center justify-between space-y-0 pb-2">
@@ -603,7 +603,7 @@ export default function DeviceDetailBox() {
                                     </Card>
                                   </Link>
                                 );
-                              },
+                              }
                             )}
                         </div>
                       </div>

app/lib/mail.server.ts

@@ -0,0 +1,130 @@
+import { render } from '@react-email/components'
+import * as dotenv from 'dotenv'
+import nodemailer from 'nodemailer'
+import type SMTPTransport from 'nodemailer/lib/smtp-transport'
+dotenv.config()
+
+// Interface to load env variables
+// Note these variables can possibly be undefined
+// as someone could skip these varibales or not setup a .env file at all
+
+/**
+ * Interface for our configuration.
+ * Note these variables can possibly be undefined,
+ * as varibales may be skipped or  there is no .env file at all
+ */
+interface Config {
+	SMTP_HOST: string | undefined
+	SMTP_PORT: number | undefined
+	SMTP_SECURE: boolean | undefined
+	SMTP_USERNAME: string | undefined
+	SMTP_PASSWORD: string | undefined
+}
+
+/**
+ * Processes environment variables and
+ * builds a configuration object from it.
+ * @returns {Config} A mailer configuration
+ */
+const getConfig = (): Config => {
+	const config = {
+		SMTP_HOST: process.env.SMTP_HOST,
+		SMTP_PORT: process.env.SMTP_PORT
+			? Number(process.env.SMTP_PORT)
+			: undefined,
+		SMTP_SECURE: process.env.SMTP_SECURE
+			? Boolean(JSON.parse(process.env.SMTP_SECURE))
+			: undefined,
+		SMTP_USERNAME: process.env.SMTP_USERNAME,
+		SMTP_PASSWORD: process.env.SMTP_PASSWORD,
+	}
+
+	// check the config for missing entries and throw an error if necessary
+	for (const [key, value] of Object.entries(config)) {
+		if (value === undefined) {
+			throw new Error(`Missing key ${key} in config.env`)
+		}
+	}
+
+	return config
+}
+
+const config = getConfig()
+
+class OSEMTransporter {
+	private static _instance: nodemailer.Transporter | null = null
+	private constructor() {}
+	public static async getInstance(): Promise<nodemailer.Transporter> {
+		if (this._instance !== null) return this._instance
+
+		if (process.env.TEST) {
+			return await new Promise((resolve, reject) => {
+				nodemailer.createTestAccount((err, account) => {
+					if (err) reject(err)
+					else {
+						this._instance = nodemailer.createTransport({
+							host: 'smtp.ethereal.email',
+							port: 587,
+							secure: false,
+							auth: {
+								user: account.user,
+								pass: account.pass,
+							},
+						})
+						resolve(this._instance)
+					}
+				})
+			})
+		} else {
+			const transportOptions: SMTPTransport.Options = {
+				host: config.SMTP_HOST,
+				port: config.SMTP_PORT,
+				secure: config.SMTP_SECURE,
+			}
+			if (
+				config.SMTP_USERNAME !== 'ignored' &&
+				config.SMTP_PASSWORD !== 'ignored'
+			) {
+				transportOptions['auth'] = {
+					user: config.SMTP_USERNAME,
+					pass: config.SMTP_PASSWORD,
+				}
+			}
+			this._instance = nodemailer.createTransport(transportOptions)
+			return this._instance
+		}
+	}
+}
+void OSEMTransporter.getInstance() // eagerly initialize the transporter
+
+export interface MailAttachment {
+	filename: string
+	content: string
+}
+
+export const sendMail = async (mailConfig: {
+	recipientAddress: string
+	recipientName?: string
+	subject?: string
+	body: React.ReactElement
+	attachments?: MailAttachment[]
+}) => {
+	try {
+		const mailHtml = await render(mailConfig.body)
+
+		await (
+			await OSEMTransporter.getInstance()
+		).sendMail({
+			from: '"openSenseMap 🌍" <[email protected]>',
+			to: mailConfig.recipientName
+				? `"${mailConfig.recipientName}" <${mailConfig.recipientAddress}>`
+				: mailConfig.recipientAddress,
+			subject: mailConfig.subject ?? 'openSenseMap',
+			html: mailHtml,
+			attachments: mailConfig.attachments,
+		})
+	} catch (err) {
+		console.error(err)
+		throw err
+	}
+}