Haraka 3.1.4 → 3.1.6

package/test/outbound/index.js

@@ -152,6 +152,195 @@ describe('outbound', () => {
             })
             assert.ok(true)
         })
+
+        it('waits for drain when stream backpressure is applied', async () => {
+            const todo = {
+                queue_time: Date.now(),
+                domain: 'example.com',
+                rcpt_to: [],
+                mail_from: {},
+                notes: {},
+                uuid: 'u1',
+            }
+            let drained = false
+
+            await new Promise((resolve) => {
+                const ws = {
+                    write() {
+                        return false
+                    },
+                    once(event, cb) {
+                        assert.equal(event, 'drain')
+                        setImmediate(() => {
+                            drained = true
+                            cb()
+                            resolve()
+                        })
+                    },
+                }
+                outbound.build_todo(todo, ws, () => {})
+            })
+
+            assert.equal(drained, true)
+        })
+    })
+
+    describe('send_trans_email', () => {
+        const queueDir = path.resolve('test', 'test-queue')
+
+        beforeEach(() => {
+            process.env.HARAKA_TEST_DIR = path.resolve('test')
+            fs.mkdirSync(queueDir, { recursive: true })
+        })
+
+        afterEach(() => {
+            delete process.env.HARAKA_TEST_DIR
+            try {
+                for (const f of fs.readdirSync(queueDir)) {
+                    fs.unlinkSync(path.join(queueDir, f))
+                }
+            } catch (ignore) {}
+        })
+
+        // Regression test for haraka/Haraka#3551:
+        // When dkim_verify (data_post) pipes the message_stream and DKIMVerifyStream
+        // fires its callback early via process.nextTick (no DKIM-Signature found),
+        // the chain runs synchronously into process_delivery → pipe() while the
+        // first pipe is still in flight. pre_send_trans_email_respond must yield
+        // (via setImmediate) before opening a new pipe.
+        it('yields to setImmediate before opening process_delivery pipes', async () => {
+            const stream = require('node:stream')
+            const Transaction = require('../../transaction')
+            const Address = require('address-rfc2821').Address
+            const outbound = require('../../outbound')
+            const plugins = require('../../plugins')
+
+            const txn = Transaction.createTransaction()
+            const origRunHooks = plugins.run_hooks
+            try {
+                txn.mail_from = new Address('<from@example.com>')
+                txn.rcpt_to = [new Address('<to@example.com>')]
+                txn.message_stream.add_line(Buffer.from('From: from@example.com\r\n'))
+                txn.message_stream.add_line(Buffer.from('To: to@example.com\r\n'))
+                txn.message_stream.add_line(Buffer.from('\r\n'))
+                txn.message_stream.add_line(Buffer.from('body\r\n'))
+                await new Promise((r) => txn.message_stream.add_line_end(r))
+
+                // Start a pipe on the message_stream and fire a synchronous callback
+                // before it drains — this models what dkim_verify does.
+                const verifierFiredCb = new Promise((resolve) => {
+                    let scheduled = false
+                    const verifier = new stream.Writable({
+                        write(_chunk, _enc, cb) {
+                            if (!scheduled) {
+                                scheduled = true
+                                process.nextTick(resolve)
+                            }
+                            cb()
+                        },
+                    })
+                    txn.message_stream.pipe(verifier)
+                })
+                await verifierFiredCb
+
+                // Now invoke send_trans_email — its pre_send_trans_email_respond
+                // should yield (await setImmediate) before calling process_delivery,
+                // letting the verifier pipe drain so the new pipe can succeed.
+                await new Promise((resolve, reject) => {
+                    // Stub the heavy bits: we only care that the chain doesn't throw
+                    // "Cannot pipe while currently piping" before queuing happens.
+                    plugins.run_hooks = (hook, obj) => {
+                        if (hook === 'pre_send_trans_email') {
+                            // Mimic empty-hook synchronous callback (no plugins)
+                            obj.pre_send_trans_email_respond(constants.cont).catch(reject)
+                        } else {
+                            origRunHooks.call(plugins, hook, obj)
+                        }
+                    }
+
+                    outbound.send_trans_email(txn, (retval) => {
+                        if (retval === constants.ok) resolve()
+                        else reject(new Error(`unexpected retval ${retval}`))
+                    })
+                })
+            } finally {
+                plugins.run_hooks = origRunHooks
+                txn.message_stream.destroy()
+            }
+        })
+
+        it('adds missing Message-Id/Date and prepends Received before queueing', async () => {
+            process.env.HARAKA_TEST_DIR = path.resolve('test')
+            const Address = require('address-rfc2821').Address
+            const outbound = require('../../outbound')
+            const plugins = require('../../plugins')
+
+            const added = []
+            const leading = []
+            const queued = []
+            const transaction = {
+                uuid: 'txn-add-headers',
+                header: {
+                    get_all(_name) {
+                        return []
+                    },
+                    get() {
+                        return null
+                    },
+                },
+                rcpt_to: [new Address('<user@example.com>')],
+                notes: {},
+                add_header(name, value) {
+                    added.push([name, value])
+                },
+                remove_header() {},
+                add_leading_header(name, value) {
+                    leading.push([name, value])
+                },
+                results: {
+                    add() {},
+                },
+            }
+
+            const originalRunHooks = plugins.run_hooks
+            const originalProcessDelivery = outbound.process_delivery
+            const originalPush = outbound.delivery_queue.push
+            outbound.delivery_queue.push = (hmail) => {
+                queued.push(hmail)
+            }
+            outbound.process_delivery = async (_okPaths, _todo, hmails) => {
+                hmails.push({ queued: true })
+            }
+            plugins.run_hooks = (hook, conn) => {
+                if (hook === 'pre_send_trans_email') {
+                    conn.pre_send_trans_email_respond(constants.cont)
+                }
+            }
+
+            try {
+                const result = await new Promise((resolve) => {
+                    outbound.send_trans_email(transaction, (retval, msg) => resolve({ retval, msg }))
+                })
+
+                assert.equal(result.retval, constants.ok)
+                assert.match(result.msg, /Message Queued/)
+                assert.equal(queued.length, 1)
+                assert.equal(
+                    added.some(([name]) => name === 'Message-Id'),
+                    true,
+                )
+                assert.equal(
+                    added.some(([name]) => name === 'Date'),
+                    true,
+                )
+                assert.equal(leading[0][0], 'Received')
+            } finally {
+                plugins.run_hooks = originalRunHooks
+                outbound.process_delivery = originalProcessDelivery
+                outbound.delivery_queue.push = originalPush
+                delete process.env.HARAKA_TEST_DIR
+            }
+        })
     })
 
     describe('timer_queue', () => {

package/test/outbound/queue.js

@@ -230,4 +230,96 @@ describe('outbound/queue', () => {
             }
         })
     })
+
+    describe('queue maintenance', () => {
+        it('delete_dot_files removes leftover dot files only', async () => {
+            const tmpDir = path.join(os.tmpdir(), `haraka-dot-clean-${Date.now()}`)
+            fs.mkdirSync(tmpDir, { recursive: true })
+            const dotName = `${qfile.platformDOT}leftover`
+            const normalName = 'keep-me'
+            fs.writeFileSync(path.join(tmpDir, dotName), 'x')
+            fs.writeFileSync(path.join(tmpDir, normalName), 'x')
+
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = tmpDir
+            try {
+                await queue.delete_dot_files()
+                assert.equal(fs.existsSync(path.join(tmpDir, dotName)), false)
+                assert.equal(fs.existsSync(path.join(tmpDir, normalName)), true)
+            } finally {
+                queue.queue_dir = originalQueueDir
+                fs.rmSync(tmpDir, { recursive: true, force: true })
+            }
+        })
+
+        it('_add_hmail pushes immediate items and schedules delayed ones', () => {
+            const originalPush = queue.delivery_queue.push
+            const originalAdd = queue.temp_fail_queue.add
+            const pushed = []
+            const delayed = []
+            let delayedCb
+
+            queue.delivery_queue.push = (item) => pushed.push(item)
+            queue.temp_fail_queue.add = (id, ms, cb) => {
+                delayed.push([id, ms])
+                delayedCb = cb
+            }
+            queue.cur_time = new Date()
+
+            const immediate = { filename: 'a', next_process: queue.cur_time - 1 }
+            const future = { filename: 'b', next_process: queue.cur_time.getTime() + 1000 }
+
+            try {
+                queue._add_hmail(immediate)
+                queue._add_hmail(future)
+                assert.equal(pushed.length, 1)
+                assert.equal(delayed.length, 1)
+                assert.equal(delayed[0][0], 'b')
+                delayedCb()
+                assert.equal(pushed.length, 2)
+            } finally {
+                queue.delivery_queue.push = originalPush
+                queue.temp_fail_queue.add = originalAdd
+            }
+        })
+
+        it('scan_queue_pids returns unique pids from queue files', async () => {
+            populateTestQueue()
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = testQueueDir
+
+            try {
+                const pids = await queue.scan_queue_pids()
+                assert.ok(Array.isArray(pids))
+                assert.equal(pids.length >= 1, true)
+            } finally {
+                queue.queue_dir = originalQueueDir
+                clearTestQueue()
+            }
+        })
+
+        it('scan_queue_pids throws when queue dir cannot be read', async () => {
+            const originalQueueDir = queue.queue_dir
+            const badPath = path.join(os.tmpdir(), `queue-not-dir-${Date.now()}`)
+            fs.writeFileSync(badPath, 'x')
+            queue.queue_dir = badPath
+            try {
+                await assert.rejects(() => queue.scan_queue_pids())
+            } finally {
+                queue.queue_dir = originalQueueDir
+                fs.rmSync(badPath, { force: true })
+            }
+        })
+
+        it('delete_dot_files handles readdir errors without throwing', async () => {
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = path.join(os.tmpdir(), `missing-dot-${Date.now()}`)
+            try {
+                await queue.delete_dot_files()
+                assert.ok(true)
+            } finally {
+                queue.queue_dir = originalQueueDir
+            }
+        })
+    })
 })

package/test/plugins/auth/auth_base.js

@@ -1,11 +1,12 @@
 'use strict'
 const assert = require('node:assert')
+const { describe, it, beforeEach } = require('node:test')
 
 const { Address } = require('address-rfc2821')
 const fixtures = require('haraka-test-fixtures')
 const utils = require('haraka-utils')
 
-const _set_up = (done) => {
+const _set_up = () => {
     this.plugin = new fixtures.plugin('auth/auth_base')
 
     this.plugin.get_plain_passwd = (user, cb) => {
@@ -15,11 +16,9 @@ const _set_up = (done) => {
 
     this.connection = fixtures.connection.createConnection()
     this.connection.capabilities = null
-
-    done()
 }
 
-const _set_up_2 = (done) => {
+const _set_up_2 = () => {
     this.plugin = new fixtures.plugin('auth/auth_base')
 
     this.plugin.get_plain_passwd = (user, connection, cb) => {
@@ -30,11 +29,9 @@ const _set_up_2 = (done) => {
 
     this.connection = fixtures.connection.createConnection()
     this.connection.capabilities = null
-
-    done()
 }
 
-const _set_up_custom_pwcb_opts = (done) => {
+const _set_up_custom_pwcb_opts = () => {
     this.plugin = new fixtures.plugin('auth/auth_base')
 
     this.plugin.check_plain_passwd = (connection, user, passwd, pwok_cb) => {
@@ -63,15 +60,13 @@ const _set_up_custom_pwcb_opts = (done) => {
         this.connection.notes.resp_strings.push([code, msg])
         return cb()
     }
-
-    done()
 }
 
 describe('auth_base', () => {
     describe('hook_capabilities', () => {
         beforeEach(_set_up)
 
-        it('no TLS, no auth', (done) => {
+        it('no TLS, no auth', (t, done) => {
             this.plugin.hook_capabilities((rc, msg) => {
                 assert.equal(undefined, rc)
                 assert.equal(undefined, msg)
@@ -80,7 +75,7 @@ describe('auth_base', () => {
             }, this.connection)
         })
 
-        it('with TLS, auth is offered', (done) => {
+        it('with TLS, auth is offered', (t, done) => {
             this.connection.tls.enabled = true
             this.connection.capabilities = []
             this.plugin.hook_capabilities((rc, msg) => {
@@ -97,13 +92,13 @@ describe('auth_base', () => {
     describe('get_plain_passwd', () => {
         beforeEach(_set_up)
 
-        it('get_plain_passwd, no result', (done) => {
+        it('get_plain_passwd, no result', (t, done) => {
             this.plugin.get_plain_passwd('user', (pass) => {
                 assert.equal(pass, null)
                 done()
             })
         })
-        it('get_plain_passwd, test user', (done) => {
+        it('get_plain_passwd, test user', (t, done) => {
             this.plugin.get_plain_passwd('test', (pass) => {
                 assert.equal(pass, 'testpass')
                 done()
@@ -114,21 +109,21 @@ describe('auth_base', () => {
     describe('check_plain_passwd', () => {
         beforeEach(_set_up)
 
-        it('valid password', (done) => {
+        it('valid password', (t, done) => {
             this.plugin.check_plain_passwd(this.connection, 'test', 'testpass', (pass) => {
                 assert.equal(pass, true)
                 done()
             })
         })
 
-        it('wrong password', (done) => {
+        it('wrong password', (t, done) => {
             this.plugin.check_plain_passwd(this.connection, 'test', 'test1pass', (pass) => {
                 assert.equal(pass, false)
                 done()
             })
         })
 
-        it('null password', (done) => {
+        it('null password', (t, done) => {
             this.plugin.check_plain_passwd(this.connection, 'test', null, (pass) => {
                 assert.equal(pass, false)
                 done()
@@ -139,7 +134,7 @@ describe('auth_base', () => {
     describe('select_auth_method', () => {
         beforeEach(_set_up)
 
-        it('no auth methods yield no result', (done) => {
+        it('no auth methods yield no result', (t, done) => {
             this.plugin.select_auth_method(
                 (code) => {
                     assert.equal(code, null)
@@ -151,7 +146,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('invalid AUTH method, no result', (done) => {
+        it('invalid AUTH method, no result', (t, done) => {
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN', 'CRAM-MD5']
             this.plugin.select_auth_method(
                 (code) => {
@@ -164,7 +159,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('valid AUTH method, valid attempt', (done) => {
+        it('valid AUTH method, valid attempt', (t, done) => {
             const method = `PLAIN ${utils.base64('discard\0test\0testpass')}`
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.select_auth_method(
@@ -182,7 +177,7 @@ describe('auth_base', () => {
     describe('auth_plain', () => {
         beforeEach(_set_up)
 
-        it('params type=string returns OK', (done) => {
+        it('params type=string returns OK', (t, done) => {
             this.plugin.auth_plain(
                 (rc) => {
                     assert.equal(rc, OK)
@@ -194,7 +189,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('params type=empty array, returns OK', (done) => {
+        it('params type=empty array, returns OK', (t, done) => {
             this.plugin.auth_plain(
                 (rc) => {
                     assert.equal(rc, OK)
@@ -206,7 +201,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('params type=array, successful auth', (done) => {
+        it('params type=array, successful auth', (t, done) => {
             const method = utils.base64('discard\0test\0testpass')
             this.plugin.auth_plain(
                 (rc) => {
@@ -219,7 +214,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('params type=with two line login', (done) => {
+        it('params type=with two line login', (t, done) => {
             this.plugin.auth_plain(
                 (rc) => {
                     assert.equal(this.connection.notes.auth_plain_asked_login, true)
@@ -235,7 +230,7 @@ describe('auth_base', () => {
     describe('check_user', () => {
         beforeEach(_set_up_2)
 
-        it('bad auth', (done) => {
+        it('bad auth', (t, done) => {
             const credentials = ['matt', 'ttam']
             this.plugin.check_user(
                 (code) => {
@@ -250,7 +245,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('good auth', (done) => {
+        it('good auth', (t, done) => {
             const credentials = ['test', 'testpass']
             this.plugin.check_user(
                 (code) => {
@@ -269,7 +264,7 @@ describe('auth_base', () => {
     describe('check_user_custom_opts', () => {
         beforeEach(_set_up_custom_pwcb_opts)
 
-        it('legacyok_nomessage', (done) => {
+        it('legacyok_nomessage', (t, done) => {
             this.plugin.check_user(
                 (code, msg) => {
                     assert.equal(code, OK)
@@ -283,7 +278,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('legacyfail_nomessage', (done) => {
+        it('legacyfail_nomessage', (t, done) => {
             this.plugin.check_user(
                 (code, msg) => {
                     assert.equal(code, OK)
@@ -297,7 +292,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('legacyok_message', (done) => {
+        it('legacyok_message', (t, done) => {
             this.plugin.check_user(
                 (code, msg) => {
                     assert.equal(code, OK)
@@ -311,7 +306,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('legacyfail_message', (done) => {
+        it('legacyfail_message', (t, done) => {
             this.plugin.check_user(
                 (code, msg) => {
                     assert.equal(code, OK)
@@ -325,7 +320,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('newok', (done) => {
+        it('newok', (t, done) => {
             this.plugin.check_user(
                 (code, msg) => {
                     assert.equal(code, OK)
@@ -339,7 +334,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('newfail', (done) => {
+        it('newfail', (t, done) => {
             this.plugin.check_user(
                 (code, msg) => {
                     assert.equal(code, OK)
@@ -357,7 +352,7 @@ describe('auth_base', () => {
     describe('auth_notes_are_set', () => {
         beforeEach(_set_up_2)
 
-        it('bad auth: no notes should be set', (done) => {
+        it('bad auth: no notes should be set', (t, done) => {
             const credentials = ['matt', 'ttam']
             this.plugin.check_user(
                 (code) => {
@@ -371,7 +366,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('good auth: dont store password', (done) => {
+        it('good auth: dont store password', (t, done) => {
             const creds = ['test', 'testpass']
             this.plugin.blankout_password = true
             this.plugin.check_user(
@@ -386,7 +381,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('good auth: store password (default)', (done) => {
+        it('good auth: store password (default)', (t, done) => {
             const creds = ['test', 'testpass']
             this.plugin.check_user(
                 (code) => {
@@ -404,7 +399,7 @@ describe('auth_base', () => {
     describe('hook_unrecognized_command', () => {
         beforeEach(_set_up)
 
-        it('AUTH type FOO', (done) => {
+        it('AUTH type FOO', (t, done) => {
             const params = ['AUTH', 'FOO']
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.hook_unrecognized_command(
@@ -418,7 +413,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('AUTH PLAIN', (done) => {
+        it('AUTH PLAIN', (t, done) => {
             const params = ['AUTH', 'PLAIN', utils.base64('discard\0test\0testpass')]
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.hook_unrecognized_command(
@@ -432,7 +427,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('AUTH PLAIN, authenticating', (done) => {
+        it('AUTH PLAIN, authenticating', (t, done) => {
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.connection.notes.authenticating = true
             this.connection.notes.auth_method = 'PLAIN'
@@ -451,7 +446,7 @@ describe('auth_base', () => {
     describe('auth_login', () => {
         beforeEach(_set_up)
 
-        it('AUTH LOGIN', (done) => {
+        it('AUTH LOGIN', (t, done) => {
             const params = ['AUTH', 'LOGIN']
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.hook_unrecognized_command(
@@ -484,7 +479,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('AUTH LOGIN <username>', (done) => {
+        it('AUTH LOGIN <username>', (t, done) => {
             const params = ['AUTH', 'LOGIN', utils.base64('test')]
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.hook_unrecognized_command(
@@ -509,7 +504,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('AUTH LOGIN <username>, bad protocol', (done) => {
+        it('AUTH LOGIN <username>, bad protocol', (t, done) => {
             const params = ['AUTH', 'LOGIN', utils.base64('test')]
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.hook_unrecognized_command(
@@ -535,7 +530,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('AUTH LOGIN, reauthentication', (done) => {
+        it('AUTH LOGIN, reauthentication', (t, done) => {
             const params = ['AUTH', 'LOGIN', utils.base64('test')]
             this.connection.notes.allowed_auth_methods = ['PLAIN', 'LOGIN']
             this.plugin.hook_unrecognized_command(
@@ -583,7 +578,7 @@ describe('auth_base', () => {
     describe('constrain_sender', () => {
         beforeEach(_set_up)
 
-        it('constrain_sender, domain match', (done) => {
+        it('constrain_sender, domain match', (t, done) => {
             this.mfrom = new Address('user@example.com')
             this.connection.results.add({ name: 'auth' }, { user: 'user@example.com' })
             this.plugin.constrain_sender(
@@ -596,7 +591,7 @@ describe('auth_base', () => {
             )
         })
 
-        it('constrain_sender, domain mismatch', (done) => {
+        it('constrain_sender, domain mismatch', (t, done) => {
             this.mfrom = new Address('user@example.net')
             this.connection.results.add({ name: 'auth' }, { user: 'user@example.com' })
             this.plugin.constrain_sender(
@@ -609,7 +604,7 @@ describe('auth_base', () => {
                 [this.mfrom],
             )
         })
-        it('constrain_sender, no domain', (done) => {
+        it('constrain_sender, no domain', (t, done) => {
             this.mfrom = new Address('user@example.com')
             this.connection.results.add({ name: 'auth' }, { user: 'user' })
             this.plugin.constrain_sender(