TREK/server/tests/unit/nest/mailer.service.test.ts

/**
 * mailer.service.test.ts
 *
 * Covers the SMTP transport options MailerService hands to nodemailer, and in
 * particular the skip-TLS opt-out: it must stay reachable for operators behind an
 * internal relay, and it must announce itself instead of downgrading quietly.
 * The second half covers what the admin sees when a send goes wrong (#2196):
 * bounded phases, a classified reason in the response, a line in the log, and
 * the password in neither.
 * Constructed directly (no TestingModule, repo convention).
 */

vi.mock('../../../src/db/database', async () => {

  const { createSnapshotTestDb } = await import('../../helpers/db-mock');
  const db = createSnapshotTestDb();
  const mock = {
    db,
    closeDb: () => {},
    reinitialize: () => {},
    canAccessTrip: () => undefined,
    isOwner: () => false,
  };
    return mock;
});


const { sendMail, createTransport } = vi.hoisted(() => {
  const send = vi.fn().mockResolvedValue({ messageId: 'test' });
  return {
    sendMail: send,
    createTransport: vi.fn((_options: Record<string, unknown>) => ({ sendMail: send })),
  };
});

vi.mock('nodemailer', () => ({ default: { createTransport } }));
vi.mock('../../../src/nest/audit/audit-log.logger', () => ({
  logInfo: vi.fn(),
  logDebug: vi.fn(),
  logError: vi.fn(),
  logWarn: vi.fn(),
}));

import { db as testDb } from '../../../src/db/database';
import { describe, it, expect, beforeAll, beforeEach, afterAll, vi } from 'vitest';
import { resetTestDb } from '../../helpers/test-db';
import { MailerService } from '../../../src/nest/notifications/mailer/mailer.service';
import { logError, logInfo, logWarn } from '../../../src/nest/audit/audit-log.logger';
import { createTestOrm, type TestOrm } from '../../helpers/test-orm';
import { Users } from '../../../src/db/entities/Users.entity';
import { Settings } from '../../../src/db/entities/Settings.entity';
import { AppSettings } from '../../../src/db/entities/AppSettings.entity';
import { setAppSetting as storeAppSetting } from '../../helpers/factories/settings';

function setAppSetting(key: string, value: string): Promise<void> {
  return storeAppSetting(testOrm, key, value);
}

/** The minimum that makes getSmtpConfig() return a config instead of null. */
async function configureSmtp(): Promise<void> {
  await setAppSetting('smtp_host', 'mail.internal.example');
  await setAppSetting('smtp_port', '587');
  await setAppSetting('smtp_from', 'trek@example.com');
}

let testOrm: TestOrm;

function newMailer(): MailerService {
  return new MailerService(testOrm.repo(Users), testOrm.repo(Settings), testOrm.repo(AppSettings));
}

/** The options object of the most recent nodemailer.createTransport() call. */
function lastTransportOptions(): Record<string, unknown> {
  const calls = createTransport.mock.calls;
  return calls[calls.length - 1][0] as Record<string, unknown>;
}

beforeAll(async () => {
  testOrm = await createTestOrm(testDb);
});

beforeEach(() => {
  resetTestDb(testDb);
  vi.clearAllMocks();
});

afterAll(() => {
  testDb.close();
});

describe('MailerService TLS options', () => {
  it('MAILER-001: leaves certificate verification on by default', async () => {
    await configureSmtp();

    expect(await newMailer().sendEmail('someone@example.com', 'Subject', 'Body')).toBe(true);

    expect(lastTransportOptions()).not.toHaveProperty('tls');
    expect(logWarn).not.toHaveBeenCalled();
  });

  it('MAILER-002: the smtp_skip_tls_verify setting turns verification off', async () => {
    await configureSmtp();
    await setAppSetting('smtp_skip_tls_verify', 'true');

    await newMailer().sendEmail('someone@example.com', 'Subject', 'Body');

    expect(lastTransportOptions().tls).toEqual({ rejectUnauthorized: false });
  });

  it('MAILER-003: anything other than "true" leaves verification on', async () => {
    await configureSmtp();
    await setAppSetting('smtp_skip_tls_verify', 'false');

    await newMailer().sendEmail('someone@example.com', 'Subject', 'Body');

    expect(lastTransportOptions()).not.toHaveProperty('tls');
    expect(logWarn).not.toHaveBeenCalled();
  });

  it('MAILER-004: skipping verification is announced, and names the host it applies to', async () => {
    await configureSmtp();
    await setAppSetting('smtp_skip_tls_verify', 'true');

    await newMailer().sendEmail('someone@example.com', 'Subject', 'Body');

    expect(logWarn).toHaveBeenCalledTimes(1);
    const warning = vi.mocked(logWarn).mock.calls[0][0];
    expect(warning).toContain('mail.internal.example:587');
    expect(warning).toContain('SECURITY');
  });

  it('MAILER-005: the warning is logged once per process, not once per mail', async () => {
    await configureSmtp();
    await setAppSetting('smtp_skip_tls_verify', 'true');
    const mailer = newMailer();

    await mailer.sendEmail('first@example.com', 'One', 'Body');
    await mailer.sendEmail('second@example.com', 'Two', 'Body');
    await mailer.sendPasswordResetEmail('third@example.com', 'https://trek.example/reset', null);

    expect(createTransport).toHaveBeenCalledTimes(3);
    expect(logWarn).toHaveBeenCalledTimes(1);
  });

  it('MAILER-006: a send with no SMTP configured builds no transport at all', async () => {
    expect(await newMailer().sendEmail('someone@example.com', 'Subject', 'Body')).toBe(false);

    expect(createTransport).not.toHaveBeenCalled();
    expect(sendMail).not.toHaveBeenCalled();
  });

  it('MAILER-007: connecting and greeting are bounded hard, the transfer is not', async () => {
    await configureSmtp();

    await newMailer().sendEmail('someone@example.com', 'Subject', 'Body');

    // Nodemailer's connect and greeting defaults (120s / 30s) outlive the client's
    // 8s API timeout, which is how #2196 produced a failure nobody could read. The
    // inactivity timeout keeps its ten minutes on a real send: it bounds the
    // transfer, a scanning relay can sit on DATA for minutes, and nobody is
    // waiting on the result.
    expect(lastTransportOptions()).toMatchObject({
      connectionTimeout: 10_000,
      greetingTimeout: 10_000,
      socketTimeout: 600_000,
    });
  });

  it('MAILER-007b: the admin test send bounds the transfer too, because somebody is waiting', async () => {
    await configureSmtp();

    await newMailer().testSmtp('someone@example.com');

    // The client gives this call 40s (CHANNEL_TEST_TIMEOUT), so a relay that
    // accepts the connection and then goes quiet still has to produce a verdict.
    expect(lastTransportOptions()).toMatchObject({
      connectionTimeout: 10_000,
      greetingTimeout: 10_000,
      socketTimeout: 30_000,
    });
  });
});

describe('MailerService test send', () => {
  /** The nodemailer shape: an Error carrying the SMTP code and the relay's reply. */
  function smtpError(message: string, code: string): Error {
    return Object.assign(new Error(message), { code });
  }

  it('MAILER-008: an incomplete configuration names the fields that are missing', async () => {
    await setAppSetting('smtp_host', 'mail.internal.example');
    await setAppSetting('smtp_port', '587');

    const result = await newMailer().testSmtp('admin@example.com');

    expect(result.success).toBe(false);
    expect(result.error).toContain('SMTP_FROM');
    expect(createTransport).not.toHaveBeenCalled();
  });

  it('MAILER-009: an unusable port is refused before anything reaches a socket', async () => {
    await setAppSetting('smtp_host', 'mail.internal.example');
    await setAppSetting('smtp_port', 'smtp.example.com');
    await setAppSetting('smtp_from', 'trek@example.com');

    const result = await newMailer().testSmtp('admin@example.com');

    expect(result.success).toBe(false);
    expect(result.error).toContain('smtp.example.com');
    expect(result.error).toContain('65535');
    expect(createTransport).not.toHaveBeenCalled();
  });

  it('MAILER-010: a rejected login comes back as a reason, not as a bare failure', async () => {
    await configureSmtp();
    sendMail.mockRejectedValueOnce(smtpError('Invalid login: 535 5.7.8 Username and Password not accepted', 'EAUTH'));

    const result = await newMailer().testSmtp('admin@example.com');

    expect(result.success).toBe(false);
    expect(result.error).toContain('rejected the credentials');
    expect(result.error).toContain('535 5.7.8');
  });

  it('MAILER-011: a refused connection is classified and reaches the log with its code', async () => {
    await configureSmtp();
    sendMail.mockRejectedValueOnce(smtpError('connect ECONNREFUSED 10.0.0.5:587', 'ESOCKET'));

    const result = await newMailer().testSmtp('admin@example.com');

    expect(result.error).toContain('refused the connection');
    expect(logError).toHaveBeenCalledTimes(1);
    const line = vi.mocked(logError).mock.calls[0][0];
    expect(line).toContain('SMTP test email failed to=admin@example.com');
    expect(line).toContain('smtp=mail.internal.example:587');
    expect(line).toContain('code=ESOCKET');
  });

  it('MAILER-012: a stalled relay is named as a timeout and points at the 465/587 split', async () => {
    await setAppSetting('smtp_host', 'mail.internal.example');
    await setAppSetting('smtp_port', '465');
    await setAppSetting('smtp_from', 'trek@example.com');
    sendMail.mockRejectedValueOnce(smtpError('Greeting never received', 'ETIMEDOUT'));

    const result = await newMailer().testSmtp('admin@example.com');

    expect(result.error).toContain('did not answer in time');
    expect(result.error).toContain('587');
  });

  it('MAILER-013: the password appears in neither the response nor the log', async () => {
    await configureSmtp();
    await setAppSetting('smtp_user', 'trek@example.com');
    await setAppSetting('smtp_pass', 'correct-horse-battery');
    sendMail.mockRejectedValueOnce(smtpError('Invalid login for correct-horse-battery', 'EAUTH'));

    const result = await newMailer().testSmtp('admin@example.com');

    expect(result.error).not.toContain('correct-horse-battery');
    expect(vi.mocked(logError).mock.calls[0][0]).not.toContain('correct-horse-battery');
  });

  it('MAILER-014: a successful test leaves a line in the log naming the relay', async () => {
    await configureSmtp();

    expect(await newMailer().testSmtp('admin@example.com')).toEqual({ success: true });

    const lines = vi.mocked(logInfo).mock.calls.map(call => call[0]);
    expect(lines.some(line => line.includes('SMTP test email sent to=admin@example.com smtp=mail.internal.example:587'))).toBe(true);
  });
});

describe('MailerService header logo (#2507)', () => {
  interface SentAttachment {
    cid?: string;
    contentType?: string;
    contentDisposition?: string;
    content?: Buffer;
  }

  /** The options object of the most recent sendMail() call. */
  function lastMail(): { html?: string; attachments?: SentAttachment[] } {
    const calls = sendMail.mock.calls;
    return calls[calls.length - 1][0] as { html?: string; attachments?: SentAttachment[] };
  }

  /**
   * The attachment the HTML's header image resolves to. Before #2507 the logo was
   * an SVG data: URI, which Gmail strips and Outlook blocks; it has to be a PNG
   * part inside the message, marked inline and addressed by Content-ID.
   */
  function expectLogoResolves(mail: { html?: string; attachments?: SentAttachment[] }): void {
    const cid = /<img src="cid:([^"]+)"/.exec(mail.html ?? '')?.[1];
    expect(cid).toBeTruthy();
    const logo = mail.attachments?.find(a => a.cid === cid);
    expect(logo).toBeDefined();
    expect(logo!.contentType).toBe('image/png');
    expect(logo!.contentDisposition).toBe('inline');
    const png = logo!.content!;
    expect(png.subarray(0, 8).toString('hex')).toBe('89504e470d0a1a0a');
    // IHDR width and height: twice the 48px the header shows it at.
    expect([png.readUInt32BE(16), png.readUInt32BE(20)]).toEqual([96, 96]);
  }

  it('MAILER-015: a notification mail carries the logo its HTML points to', async () => {
    await configureSmtp();

    expect(await newMailer().sendEmail('someone@example.com', 'Subject', 'Body')).toBe(true);

    expectLogoResolves(lastMail());
  });

  it('MAILER-016: the password-reset mail carries it too', async () => {
    await configureSmtp();

    expect((await newMailer().sendPasswordResetEmail('someone@example.com', 'https://trek.example/reset', null)).delivered).toBe('email');

    expectLogoResolves(lastMail());
  });

  it('MAILER-017: the plain-text test mail has no HTML, so it carries no logo either', async () => {
    await configureSmtp();

    await newMailer().testSmtp('admin@example.com');

    expect(lastMail().html).toBeUndefined();
    expect(lastMail().attachments).toBeUndefined();
  });
});