Haraka 3.1.3 → 3.1.5

package/test/outbound/bounce_rfc3464.js

@@ -0,0 +1,226 @@
+'use strict'
+
+// Testing bounce email contents related to errors occurring during SMTP dialog.
+// These tests simulate a remote SMTP server responding with various error codes
+// and verify that Haraka generates correctly formatted RFC 3464 DSN bounce messages.
+
+const { describe, it, beforeEach, afterEach } = require('node:test')
+const assert = require('node:assert')
+const fs = require('node:fs')
+const path = require('node:path')
+
+// Load outbound/index FIRST to avoid the circular-dependency boot-order issue.
+const outbound = require('../../outbound')
+const HMailItem = outbound.HMailItem
+const TODOItem = require('../../outbound/todo')
+const obc = require('../../outbound/config')
+
+const util_hmailitem = require('../fixtures/util_hmailitem')
+const mock_sock = require('../fixtures/line_socket')
+
+obc.cfg.pool_concurrency_max = 0
+
+const outbound_context = { TODOItem, exports: outbound }
+const queue_dir = path.resolve(__dirname, '../test-queue')
+
+// ── Helpers ───────────────────────────────────────────────────────────────────
+
+const ensureQueueDir = () => fs.promises.mkdir(queue_dir, { recursive: true })
+
+const cleanQueueDir = async () => {
+    if (!fs.existsSync(queue_dir)) return
+    for (const file of fs.readdirSync(queue_dir)) {
+        const full = path.resolve(queue_dir, file)
+        if (fs.lstatSync(full).isDirectory()) throw new Error(`unexpected subdirectory: ${full}`)
+        fs.unlinkSync(full)
+    }
+}
+
+const mockHMailItem = (ctx, opts = {}) =>
+    new Promise((resolve, reject) => {
+        util_hmailitem.newMockHMailItem(ctx, reject, opts, resolve)
+    })
+
+/** Spies on HMailItem.prototype.temp_fail and resolves when called. */
+const interceptTempFail = (mock_hmail, mock_socket, assertion, conversation) =>
+    new Promise((resolve, reject) => {
+        const orig = HMailItem.prototype.temp_fail
+        HMailItem.prototype.temp_fail = function () {
+            try {
+                assertion(this)
+                resolve()
+            } catch (e) {
+                reject(e)
+            } finally {
+                HMailItem.prototype.temp_fail = orig
+            }
+        }
+        util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, reject, conversation, () => {})
+    })
+
+/** Spies on outbound.send_email and resolves when called. */
+const interceptSendEmail = (mock_hmail, mock_socket, assertion, conversation) =>
+    new Promise((resolve, reject) => {
+        const orig = outbound_context.exports.send_email
+        outbound_context.exports.send_email = (from, to, contents) => {
+            try {
+                assertion(contents)
+                resolve()
+            } catch (e) {
+                reject(e)
+            } finally {
+                outbound_context.exports.send_email = orig
+            }
+        }
+        util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, reject, conversation, () => {})
+    })
+
+// ── Shared conversation building blocks ───────────────────────────────────────
+
+const EHLO_PREAMBLE = [
+    { from: 'remote', line: '220 testing-smtp' },
+    { from: 'haraka', test: (l) => l.match(/^EHLO /), description: 'EHLO' },
+    { from: 'remote', line: '220-testing-smtp' },
+    { from: 'remote', line: '220 8BITMIME' },
+]
+const MAIL_OK = [
+    { from: 'haraka', test: 'MAIL FROM:<sender@domain>' },
+    { from: 'remote', line: '250 2.1.0 Ok' },
+]
+const RCPT_OK = [
+    { from: 'haraka', test: 'RCPT TO:<recipient@domain>' },
+    { from: 'remote', line: '250 2.1.5 Ok' },
+]
+const QUIT = { from: 'haraka', test: 'QUIT', end_test: true }
+
+// ── Tests ─────────────────────────────────────────────────────────────────────
+
+// Permanent bounce tests: spy on send_email, check DSN bounce contents
+const bounceCases = [
+    {
+        name: 'MAIL FROM 500 triggers RFC3464 bounce with status 5.0.0',
+        statusRe: /^Status: 5\.0\.0/m,
+        messageRe: /Absolutely not acceptable\. Basic Test Only\./,
+        conversation: [
+            ...EHLO_PREAMBLE,
+            { from: 'haraka', test: 'MAIL FROM:<sender@domain>' },
+            { from: 'remote', line: '500 5.0.0 Absolutely not acceptable. Basic Test Only.' },
+            QUIT,
+        ],
+    },
+    {
+        name: 'RCPT-TO 5XX triggers RFC3464 bounce with status 5.1.1',
+        statusRe: /^Status: 5\.1\.1/m,
+        messageRe: /Not available and will not come back/,
+        conversation: [
+            ...EHLO_PREAMBLE,
+            ...MAIL_OK,
+            { from: 'haraka', test: 'RCPT TO:<recipient@domain>' },
+            { from: 'remote', line: '550 5.1.1 Not available and will not come back' },
+            QUIT,
+        ],
+    },
+    {
+        name: 'DATA 5XX triggers RFC3464 bounce with status 5.6.0',
+        statusRe: /^Status: 5\.6\.0/m,
+        messageRe: /I never did and will like ascii art cats/,
+        conversation: [
+            ...EHLO_PREAMBLE,
+            ...MAIL_OK,
+            ...RCPT_OK,
+            { from: 'haraka', test: 'DATA' },
+            { from: 'remote', line: '550 5.6.0 I never did and will like ascii art cats.' },
+            QUIT,
+        ],
+    },
+]
+
+// Temporary failure tests: spy on temp_fail, check DSN rcpt fields
+const tempFailCases = [
+    {
+        name: 'early 3XX response triggers temp_fail with status 3.0.0',
+        dsn_status: '3.0.0',
+        dsn_action: 'delayed',
+        smtpRe: /No time for you right now/,
+        conversation: [
+            ...EHLO_PREAMBLE,
+            { from: 'haraka', test: 'MAIL FROM:<sender@domain>' },
+            { from: 'remote', line: '300 3.0.0 No time for you right now' },
+            QUIT,
+        ],
+    },
+    {
+        name: 'RCPT-TO 4XX triggers temp_fail with status 4.0.0',
+        dsn_status: '4.0.0',
+        dsn_action: 'delayed',
+        smtpRe: /Currently not available\. Try again later\./,
+        conversation: [
+            ...EHLO_PREAMBLE,
+            ...MAIL_OK,
+            { from: 'haraka', test: 'RCPT TO:<recipient@domain>' },
+            { from: 'remote', line: '400 4.0.0 Currently not available. Try again later.' },
+            QUIT,
+        ],
+    },
+    {
+        name: 'DATA 4XX triggers temp_fail with status 4.6.0',
+        dsn_status: '4.6.0',
+        dsn_action: 'delayed',
+        smtpRe: /Currently I do not like ascii art cats\./,
+        conversation: [
+            ...EHLO_PREAMBLE,
+            ...MAIL_OK,
+            ...RCPT_OK,
+            { from: 'haraka', test: 'DATA' },
+            { from: 'remote', line: '450 4.6.0 Currently I do not like ascii art cats.' },
+            QUIT,
+        ],
+    },
+]
+
+describe('outbound_bounce_rfc3464', () => {
+    beforeEach(ensureQueueDir)
+    afterEach(cleanQueueDir)
+
+    describe('permanent bounce (send_email)', () => {
+        for (const { name, statusRe, messageRe, conversation } of bounceCases) {
+            it(name, async () => {
+                const mock_hmail = await mockHMailItem(outbound_context)
+                const mock_socket = mock_sock.connect('testhost', 'testport')
+                mock_socket.writable = true
+                await interceptSendEmail(
+                    mock_hmail,
+                    mock_socket,
+                    (contents) => {
+                        assert.match(contents, /^Content-type: message\/delivery-status/m)
+                        assert.match(contents, /^Final-Recipient: rfc822;recipient@domain/m)
+                        assert.match(contents, /^Action: failed/m)
+                        assert.match(contents, statusRe)
+                        assert.match(contents, messageRe)
+                    },
+                    conversation,
+                )
+            })
+        }
+    })
+
+    describe('temporary failure (temp_fail)', () => {
+        for (const { name, dsn_status, dsn_action, smtpRe, conversation } of tempFailCases) {
+            it(name, async () => {
+                const mock_hmail = await mockHMailItem(outbound_context)
+                const mock_socket = mock_sock.connect('testhost', 'testport')
+                mock_socket.writable = true
+                await interceptTempFail(
+                    mock_hmail,
+                    mock_socket,
+                    (h) => {
+                        assert.equal(h.todo.rcpt_to[0].dsn_status, dsn_status)
+                        assert.equal(h.todo.rcpt_to[0].dsn_action, dsn_action)
+                        assert.match(h.todo.rcpt_to[0].dsn_smtp_response, smtpRe)
+                    },
+                    conversation,
+                )
+            })
+        }
+    })
+})

package/test/outbound/hmail.js

@@ -1,155 +1,191 @@
+'use strict'
+
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
 const assert = require('node:assert')
+const { EventEmitter } = require('node:events')
 const fs = require('node:fs')
 const path = require('node:path')
 
-const Hmail = require('../../outbound/hmail')
-const outbound = require('../../outbound/index')
+// Load outbound/index FIRST to avoid the circular-dependency boot-order issue.
+const outbound = require('../../outbound')
+const Hmail = outbound.HMailItem
+const client_pool = require('../../outbound/client_pool')
+
+// ── Helpers ───────────────────────────────────────────────────────────────────
+
+const onEvent = (emitter, event) => new Promise((resolve) => emitter.once(event, resolve))
+
+// ── Tests ─────────────────────────────────────────────────────────────────────
 
 describe('outbound/hmail', () => {
-    beforeEach((done) => {
-        this.hmail = new Hmail(
+    let hmail
+
+    beforeEach(() => {
+        hmail = new Hmail(
             '1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka',
             'test/queue/1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka',
             {},
         )
-        done()
     })
 
-    it('sort_mx', (done) => {
-        const sorted = this.hmail.sort_mx([
+    describe('socket error/timeout handler robustness (#3388)', () => {
+        const mx = { using_lmtp: false, port: 25, exchange: 'mx.example.com', bind: null, bind_helo: 'test' }
+        let origRelease
+
+        function makeSocket() {
+            const s = new EventEmitter()
+            s.name = 'mock'
+            s.writable = true
+            s.write = () => {}
+            s.destroy = () => {}
+            return s
+        }
+
+        beforeEach(() => {
+            origRelease = client_pool.release_client
+            client_pool.release_client = () => {}
+            hmail.todo = { rcpt_to: [] }
+            hmail.try_deliver = () => {}
+            hmail.logerror = () => {}
+        })
+
+        afterEach(() => {
+            client_pool.release_client = origRelease
+        })
+
+        it('error then timeout does not throw ERR_UNHANDLED_ERROR', () => {
+            const socket = makeSocket()
+            hmail.try_deliver_host_on_socket(mx, '1.2.3.4', 25, socket)
+            socket.emit('error', new Error('connection refused'))
+            assert.doesNotThrow(() => socket.emit('timeout'), 'timeout after error must not crash')
+        })
+
+        it('timeout then error does not throw ERR_UNHANDLED_ERROR', () => {
+            const socket = makeSocket()
+            hmail.try_deliver_host_on_socket(mx, '1.2.3.4', 25, socket)
+            socket.emit('timeout')
+            assert.doesNotThrow(
+                () => socket.emit('error', new Error('late error')),
+                'error after timeout must not crash',
+            )
+        })
+
+        it('multiple timeouts do not throw ERR_UNHANDLED_ERROR', () => {
+            const socket = makeSocket()
+            hmail.try_deliver_host_on_socket(mx, '1.2.3.4', 25, socket)
+            socket.emit('timeout')
+            assert.doesNotThrow(() => socket.emit('timeout'), 'second timeout must not crash')
+        })
+    })
+
+    it('sort_mx orders by priority ascending', () => {
+        const sorted = hmail.sort_mx([
             { exchange: 'mx2.example.com', priority: 5 },
             { exchange: 'mx1.example.com', priority: 6 },
         ])
         assert.equal(sorted[0].exchange, 'mx2.example.com')
-        done()
     })
-    it('sort_mx, shuffled', (done) => {
-        const sorted = this.hmail.sort_mx([
+
+    it('sort_mx shuffles equal-priority entries', () => {
+        const sorted = hmail.sort_mx([
             { exchange: 'mx2.example.com', priority: 5 },
             { exchange: 'mx1.example.com', priority: 6 },
             { exchange: 'mx3.example.com', priority: 6 },
         ])
         assert.equal(sorted[0].exchange, 'mx2.example.com')
-        assert.ok(sorted[1].exchange == 'mx3.example.com' || sorted[1].exchange == 'mx1.example.com')
-        done()
+        assert.ok(['mx1.example.com', 'mx3.example.com'].includes(sorted[1].exchange))
     })
-    it('force_tls', (done) => {
-        this.hmail.todo = { domain: 'miss.example.com' }
-        this.hmail.obtls.cfg = {
-            force_tls_hosts: ['1.2.3.4', 'hit.example.com'],
-        }
-        assert.equal(this.hmail.get_force_tls({ exchange: '1.2.3.4' }), true)
-        assert.equal(this.hmail.get_force_tls({ exchange: '1.2.3.5' }), false)
-        this.hmail.todo = { domain: 'hit.example.com' }
-        assert.equal(this.hmail.get_force_tls({ exchange: '1.2.3.5' }), true)
-        done()
+
+    it('get_force_tls matches by IP and domain', () => {
+        hmail.todo = { domain: 'miss.example.com' }
+        hmail.obtls.cfg = { force_tls_hosts: ['1.2.3.4', 'hit.example.com'] }
+        assert.equal(hmail.get_force_tls({ exchange: '1.2.3.4' }), true)
+        assert.equal(hmail.get_force_tls({ exchange: '1.2.3.5' }), false)
+        hmail.todo = { domain: 'hit.example.com' }
+        assert.equal(hmail.get_force_tls({ exchange: '1.2.3.5' }), true)
     })
 })
 
-describe('outbound/hmail.HMailItem', () => {
-    it('normal queue file', (done) => {
-        this.hmail = new Hmail(
+const TOOLONG_FIXTURE = 'test/queue/1509000000000_1509000000000_0_99999_ToLong_1_haraka'
+
+const makeToolongFixture = () => {
+    const buf = Buffer.alloc(50)
+    buf.writeUInt32BE(9999, 0) // declares 9999 bytes but file has only 46 after the header
+    buf.write('{"domain":"example.com"', 4)
+    fs.writeFileSync(TOOLONG_FIXTURE, buf)
+}
+
+describe('outbound/hmail.HMailItem — queue file loading', () => {
+    before(makeToolongFixture)
+
+    it('loads a valid queue file', async () => {
+        const h = new Hmail(
             '1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka',
             'test/queue/1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka',
             {},
         )
-        this.hmail.on('ready', () => {
-            // console.log(this.hmail);
-            assert.ok(this.hmail)
-            done()
-        })
-        this.hmail.on('error', (err) => {
-            console.log(err)
-            assert.equal(err, undefined)
-            done()
-        })
+        await onEvent(h, 'ready')
+        assert.ok(h)
     })
-    it('normal TODO w/multibyte chars loads w/o error', (done) => {
-        this.hmail = new Hmail('1507509981169_1507509981169_0_61403_e0Y0Ym_1_qfile', 'test/fixtures/todo_qfile.txt', {})
-        this.hmail.on('ready', () => {
-            // console.log(this.hmail);
-            assert.ok(this.hmail)
-            done()
-        })
-        this.hmail.on('error', (err) => {
-            console.log(err)
-            assert.equal(err, undefined)
-            done()
-        })
+
+    it('loads a TODO with multibyte chars without error', async () => {
+        const h = new Hmail('1507509981169_1507509981169_0_61403_e0Y0Ym_1_qfile', 'test/fixtures/todo_qfile.txt', {})
+        await onEvent(h, 'ready')
+        assert.ok(h)
     })
-    it('too short TODO length declared', (done) => {
-        this.hmail = new Hmail(
+
+    it('emits error on too-short declared TODO length', async () => {
+        const h = new Hmail(
             '1507509981169_1507509981169_0_61403_e0Y0Ym_1_haraka',
             'test/queue/1507509981169_1507509981169_0_61403_e0Y0Ym_1_haraka',
             {},
         )
-        this.hmail.on('ready', () => {
-            // console.log(this.hmail);
-            assert.ok(this.hmail)
-            done()
-        })
-        this.hmail.on('error', (err) => {
-            console.log(err)
-            assert.ok(err)
-            done()
+        const err = await new Promise((resolve) => {
+            h.once('ready', () => resolve(null))
+            h.once('error', resolve)
         })
+        assert.ok(err, 'expected an error for truncated TODO')
     })
-    it('too long TODO length declared', (done) => {
-        this.hmail = new Hmail(
-            '1508269674999_1508269674999_0_34002_socVUF_1_haraka',
-            'test/queue/1508269674999_1508269674999_0_34002_socVUF_1_haraka',
-            {},
-        )
-        this.hmail.on('ready', () => {
-            // console.log(this.hmail);
-            assert.ok(this.hmail)
-            done()
-        })
-        this.hmail.on('error', (err) => {
-            console.log(err)
-            assert.ok(err)
-            done()
+
+    it('emits error on too-long declared TODO length', async () => {
+        // Recreate fixture in case a prior run renamed it to the error queue
+        makeToolongFixture()
+        const h = new Hmail('1509000000000_1509000000000_0_99999_ToLong_1_haraka', TOOLONG_FIXTURE, {})
+        const err = await new Promise((resolve) => {
+            h.once('ready', () => resolve(null))
+            h.once('error', resolve)
         })
+        assert.ok(err, 'expected an error for oversized TODO')
     })
-    it('zero-length file load skip w/o crash', (done) => {
-        this.hmail = new Hmail('1507509981169_1507509981169_0_61403_e0Y0Ym_2_zero', 'test/queue/zero-length', {})
-        this.hmail.on('ready', () => {
-            assert.ok(this.hmail)
-            done()
-        })
-        this.hmail.on('error', (err) => {
-            console.error(err)
-            assert.ok(err)
-            done()
+
+    it('skips zero-length file without crash', async () => {
+        const h = new Hmail('1507509981169_1507509981169_0_61403_e0Y0Ym_2_zero', 'test/queue/zero-length', {})
+        await new Promise((resolve) => {
+            h.once('ready', resolve)
+            h.once('error', resolve)
         })
+        assert.ok(h)
     })
-    it('lifecycle, reads and writes a haraka queue file', (done) => {
-        this.hmail = new Hmail('1507509981169_1507509981169_0_61403_e0Y0Ym_2_qfile', 'test/fixtures/todo_qfile.txt', {})
 
-        this.hmail.on('error', (err) => {
-            // console.log(err);
-            assert.equals(err, undefined)
-            done()
-        })
+    it('lifecycle: reads and writes a queue file', async () => {
+        const h = new Hmail('1507509981169_1507509981169_0_61403_e0Y0Ym_2_qfile', 'test/fixtures/todo_qfile.txt', {})
 
-        this.hmail.on('ready', () => {
-            const tmpfile = path.resolve('test', 'test-queue', 'delete-me')
-            const ws = new fs.createWriteStream(tmpfile)
+        await onEvent(h, 'ready')
 
-            outbound.build_todo(this.hmail.todo, ws, () => {
-                // console.log('returned from build_todo, piping')
-                // console.log(this.hmail.todo)
-                // assert.equals(this.hmail.todo.message_stream.headers.length, 22);
+        const tmpfile = path.resolve('test', 'test-queue', 'delete-me')
+        await fs.promises.mkdir(path.dirname(tmpfile), { recursive: true })
+        const ws = new fs.WriteStream(tmpfile)
 
-                const ds = this.hmail.data_stream()
+        await new Promise((resolve, reject) => {
+            outbound.build_todo(h.todo, ws, () => {
+                const ds = h.data_stream()
                 ds.pipe(ws)
-
-                ws.on('close', () => {
-                    // console.log(this.hmail.todo)
-                    assert.equal(fs.statSync(tmpfile).size, 4204)
-                    done()
-                })
+                ws.on('close', resolve)
+                ws.on('error', reject)
             })
         })
+
+        assert.equal(fs.statSync(tmpfile).size, 4204)
+        fs.unlinkSync(tmpfile)
     })
 })