Merge pull request #3837 from egeoztass/fix/email-error-propagation

fix: propagate SMTP transport errors from EmailService.sendEmail
This commit is contained in:
Alexander Holliday authored and GitHub committed 2026-08-18 10:36:02 -07:00
commit 6eba53d716
9 files changed
+119 -49

No files matched your search

@@ -50,9 +50,9 @@ describe("EmailProvider", () => {
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ message: "Failed to build test email content" }));
});
it("returns false when sendEmail returns falsy", async () => {
it("returns false when sendEmail rejects", async () => {
const { provider, emailService, logger } = createProvider();
(emailService.sendEmail as jest.Mock).mockResolvedValue(false);
(emailService.sendEmail as jest.Mock).mockRejectedValue(new Error("SMTP auth failed"));
expect(await provider.sendTestAlert(makeNotification())).toBe(false);
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ message: "Email test alert failed" }));
});
@@ -82,9 +82,11 @@ describe("EmailProvider", () => {
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ message: "Failed to build email content" }));
});
it("returns false when sendEmail returns falsy", async () => {
// NotificationsService fans providers out through Promise.all, so a failed email must
// resolve to false rather than reject and take the other channels down with it.
it("returns false when sendEmail rejects", async () => {
const { provider, emailService, logger } = createProvider();
(emailService.sendEmail as jest.Mock).mockResolvedValue(undefined);
(emailService.sendEmail as jest.Mock).mockRejectedValue(new Error("SMTP auth failed"));
expect(await provider.sendMessage(makeNotification() as any, makeMessage())).toBe(false);
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ message: "Email notification failed" }));
});
+27 -14
View File
@@ -326,15 +326,17 @@ describe("EmailService", () => {
expect(nodemailer.createTransport).toHaveBeenCalledWith(expect.objectContaining({ name: "localhost" }));
});
it("returns false when transporter verification fails", async () => {
// Callers wrap sendEmail in .catch()/try-catch to react to delivery failures, so a
// transport error has to reject rather than resolve to a falsy value.
it("throws when transporter verification fails", async () => {
const transporter = createMockTransporter();
(transporter.verify as jest.Mock).mockRejectedValue(new Error("SMTP auth failed"));
const nodemailer = createMockNodemailer(transporter);
const { service, logger } = createService({ nodemailer });
const result = await service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig());
expect(result).toBe(false);
await expect(service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig())).rejects.toThrow(
"Email transporter verification failed"
);
expect(logger.warn).toHaveBeenCalledWith(
expect.objectContaining({
message: "Email transporter verification failed",
@@ -344,27 +346,38 @@ describe("EmailService", () => {
);
});
it("reports the underlying cause when verification fails", async () => {
const transporter = createMockTransporter();
(transporter.verify as jest.Mock).mockRejectedValue(new Error("SMTP auth failed"));
const nodemailer = createMockNodemailer(transporter);
const { service } = createService({ nodemailer });
await expect(service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig())).rejects.toMatchObject({
status: 500,
details: { cause: "SMTP auth failed" },
});
});
it("logs stack as undefined when verification fails with non-Error", async () => {
const transporter = createMockTransporter();
(transporter.verify as jest.Mock).mockRejectedValue("connection refused");
const nodemailer = createMockNodemailer(transporter);
const { service, logger } = createService({ nodemailer });
const result = await service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig());
expect(result).toBe(false);
await expect(service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig())).rejects.toThrow();
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ stack: undefined }));
});
it("returns undefined and logs error when sendMail throws", async () => {
it("throws and logs error when sendMail throws", async () => {
const transporter = createMockTransporter();
(transporter.sendMail as jest.Mock).mockRejectedValue(new Error("Recipient rejected"));
const nodemailer = createMockNodemailer(transporter);
const { service, logger } = createService({ nodemailer });
const result = await service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig());
expect(result).toBeUndefined();
await expect(service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig())).rejects.toMatchObject({
message: "Failed to send email",
details: { cause: "Recipient rejected" },
});
expect(logger.error).toHaveBeenCalledWith(
expect.objectContaining({
message: "Recipient rejected",
@@ -380,9 +393,9 @@ describe("EmailService", () => {
const nodemailer = createMockNodemailer(transporter);
const { service, logger } = createService({ nodemailer });
const result = await service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig());
expect(result).toBeUndefined();
await expect(service.sendEmail("to@example.com", "Subject", "<p>body</p>", makeTransportConfig())).rejects.toMatchObject({
details: { cause: "Unknown error" },
});
expect(logger.error).toHaveBeenCalledWith(
expect.objectContaining({
message: "Unknown error",
@@ -127,11 +127,11 @@ describe("InviteService", () => {
).rejects.toThrow("Failed to build invite e-mail");
});
it("throws 500 when sendEmail returns falsy", async () => {
it("throws 500 when sendEmail rejects", async () => {
const { service } = createService({
emailService: {
buildEmail: jest.fn().mockResolvedValue("<html>ok</html>"),
sendEmail: jest.fn().mockResolvedValue(false),
sendEmail: jest.fn().mockRejectedValue(new Error("SMTP auth failed")),
},
});
@@ -196,6 +196,22 @@ describe("UserService", () => {
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ method: "registerUser" }));
});
// The welcome email is fire-and-forget, but its .catch() only runs if sendEmail
// actually rejects; swallowing the transport error made that handler dead code.
it("logs a warning when the welcome email fails to send", async () => {
const { service, logger } = createService({
emailService: {
buildEmail: jest.fn().mockResolvedValue("<html>Welcome</html>"),
sendEmail: jest.fn().mockRejectedValue(new Error("SMTP auth failed")),
},
});
const result = await service.registerUser({ password: "pass" }, "invite-token", null);
expect(result.user).toBeDefined();
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({ method: "registerUser", message: "SMTP auth failed" }));
});
it("uses default role when invite has no role", async () => {
const { service, usersRepository } = createService({
invitesRepository: {
@@ -423,6 +439,19 @@ describe("UserService", () => {
await expect(service.requestRecovery("test@example.com")).rejects.toThrow("Failed to build password reset email HTML");
});
// Previously the send failure was swallowed and the endpoint still reported
// "Password recovery email sent successfully" while the user got nothing.
it("propagates the failure when the recovery email cannot be sent", async () => {
const { service } = createService({
emailService: {
buildEmail: jest.fn().mockResolvedValue("<html>Reset</html>"),
sendEmail: jest.fn().mockRejectedValue(new Error("SMTP auth failed")),
},
});
await expect(service.requestRecovery("test@example.com")).rejects.toThrow("SMTP auth failed");
});
});
// ── validateRecovery ────────────────────────────────────────────────────