Release v1.3.1 (#11)

- fix: add a compat shim for dot_stuffing on Haraka < 3.1, fixes #10

Author: msimerson

CHANGELOG.md

@@ -4,6 +4,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 ### Unreleased
 
+### [1.3.1] - 2025-07-23
+
+- fix: add a compat shim for dot_stuffing on Haraka < 3.1
+
 ### [1.3.0] - 2025-06-27
 
 - fix: also remove dot-stuffing from leftovers #9
@@ -56,3 +60,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 [1.2.3]: https://github.com/haraka/message-stream/releases/tag/v1.2.3
 [1.0.0]: https://github.com/haraka/message-stream/releases/tag/v1.0.0
 [1.3.0]: https://github.com/haraka/message-stream/releases/tag/v1.3.0
+[1.3.1]: https://github.com/haraka/message-stream/releases/tag/v1.3.1

CONTRIBUTORS.md

@@ -2,7 +2,7 @@
 
 This handcrafted artisanal software is brought to you by:
 
-| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/message-stream/commits?author=msimerson">7</a>) |
+| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/message-stream/commits?author=msimerson">8</a>) |
 | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
 
 <sub>this file is generated by [.release](https://github.com/msimerson/.release).

index.js

@@ -337,7 +337,16 @@ class MessageStream extends Stream {
     Stream.prototype.pipe.call(this, destination, options)
     // Options
     this.line_endings = options?.line_endings ?? '\r\n'
-    this.dot_stuffed = options?.dot_stuffed ?? true
+    if (
+      options.dot_stuffed === undefined &&
+      options.dot_stuffing !== undefined
+    ) {
+      // sunset: delete this if block, leaving only the else when Haraka < 3.1 is
+      // no longer supported (2026-?)
+      this.dot_stuffed = !options.dot_stuffing
+    } else {
+      this.dot_stuffed = options?.dot_stuffed ?? true
+    }
     this.ending_dot = options?.ending_dot ?? false
     this.clamd_style = !!options?.clamd_style
     this.buffer_size = options?.buffer_size ?? 1024 * 64

package.json

@@ -1,6 +1,6 @@
 {
   "name": "haraka-message-stream",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Haraka email message stream",
   "main": "index.js",
   "files": [
@@ -32,7 +32,7 @@
   },
   "homepage": "https://github.com/haraka/message-stream#readme",
   "devDependencies": {
-    "@haraka/eslint-config": "^2.0.3",
+    "@haraka/eslint-config": "^2.0.2",
     "haraka-test-fixtures": "^1.3.10"
   },
   "dependencies": {},

test/message-stream.js

@@ -25,31 +25,56 @@ describe('message-stream', () => {
   })
 })
 
-function getOutputFromStream(inputLines) {
+function getOutputFromStream(inputLines, pipeOpts) {
   return new Promise((resolve) => {
     const ms = new MessageStream({ main: {} }, 'msg', [])
     const output = new stream.PassThrough()
     const chunks = []
 
-    output.on('data', chunk => chunks.push(chunk.toString()))
+    output.on('data', (chunk) => chunks.push(chunk.toString()))
     output.on('end', () => resolve(chunks.join('')))
 
-    ms.pipe(output, { dot_stuffed: true })
+    ms.pipe(output, pipeOpts)
 
-    inputLines.forEach(line => ms.add_line(line))
+    inputLines.forEach((line) => ms.add_line(line))
     ms.add_line_end()
   })
 }
 
-describe('dot-unstuffing', function () {
+describe('dot_stuffed = false', function () {
+  const pipeOpts = { dot_stuffed: false }
+
+  it('does not stuff "..\\r\\n', async () => {
+    const result = await getOutputFromStream(['..\r\n'], pipeOpts)
+    assert.match(result, /^..\r\n/m)
+  })
+
+  it('does not stuff "..dot start\\r\\n"', async () => {
+    const result = await getOutputFromStream(['..dot start\r\n'], pipeOpts)
+    assert.match(result, /^..dot start\r\n/m)
+  })
+
+  it('leaves normal lines untouched', async () => {
+    const result = await getOutputFromStream([
+      'hello\r\n',
+      '..dot line\r\n',
+      '..\r\n',
+    ], pipeOpts)
+
+    assert.equal(result, 'hello\r\n..dot line\r\n..\r\n')
+  })
+})
+
+describe('dot_stuffed = true', function () {
+  const pipeOpts = { dot_stuffed: true }
 
   it('unstuffs "..\\r\\n" to ".\\r\\n"', async () => {
-    const result = await getOutputFromStream(['..\r\n'])
+    const result = await getOutputFromStream(['..\r\n'], pipeOpts)
     assert.match(result, /^.\r\n/m)
   })
 
   it('unstuffs "..dot start\\r\\n" to ".dot start\\r\\n"', async () => {
-    const result = await getOutputFromStream(['..dot start\r\n'])
+    const result = await getOutputFromStream(['..dot start\r\n'], pipeOpts)
     assert.match(result, /^.dot start\r\n/m)
   })
 
@@ -58,13 +83,36 @@ describe('dot-unstuffing', function () {
       'hello\r\n',
       '..dot line\r\n',
       '..\r\n',
-    ])
+    ], pipeOpts)
 
     assert.equal(result, 'hello\r\n.dot line\r\n.\r\n')
     assert.match(result, /^hello\r\n/m)
     assert.match(result, /^.dot line\r\n/m)
     assert.match(result, /^.\r\n/m)
   })
+})
 
+describe('dot_stuffing = false (legacy)', function () {
+  // sunset, delete after 2026
+  const pipeOpts = { dot_stuffing: false }
 
+  it('unstuffs "..\\r\\n" to ".\\r\\n"', async () => {
+    const result = await getOutputFromStream(['..\r\n'], pipeOpts)
+    assert.match(result, /^.\r\n/m)
+  })
+
+  it('unstuffs "..dot start\\r\\n" to ".dot start\\r\\n"', async () => {
+    const result = await getOutputFromStream(['..dot start\r\n'], pipeOpts)
+    assert.match(result, /^.dot start\r\n/m)
+  })
+
+  it('leaves normal lines untouched', async () => {
+    const result = await getOutputFromStream([
+      'hello\r\n',
+      '..dot line\r\n',
+      '..\r\n',
+    ], pipeOpts)
+
+    assert.equal(result, 'hello\r\n.dot line\r\n.\r\n')
+  })
 })