Merge pull request #108 from DEFRA/feat/DF-721-generate-and-send-answers-with-confirmation-email-receipt

More Escaping

Author: Scullyon

docs/notify.md

@@ -33,6 +33,7 @@ A more advanced escape function was required and has been developed with the fol
 - Single and double quotes are escaped with a backslash (eg `'` becomes `\'` and `"` becomes `\"`), first escaping any backslashes that would be escape characters for the quotes.
   - WARNING: Notify only supports up to 2 consecutive backslashes before quotes without formating issues and supporting that adds needless complexity.
   - NOTE: When escaping the backslash in `\'` for Notify, it needs to be escaped with an additional two backslashes, because Notify treats `\\'` the same as `\'` which results in no backslash in the final output.
+- A number followed by a period at the start of a line is escaped with a backslash (eg `1.` becomes `\1.`).
 
 ### E-mail Body Content to Test Escaping
 
@@ -102,5 +103,14 @@ _ abc _ def abc_ def abc _def abc_def abc	_	def
 
 ## Exclamation (!)
 ! abc ! def abc! def abc !def abc!def abc	!	def
+
+## Numbered List
+1.1 First item
+
+2. Second item
+
+3.2	Third item
+
+  4. Fourth item with leading spaces
 `
 ```

src/lib/notify.js

@@ -63,7 +63,8 @@ export function escapeFileLabel(str) {
 
 /**
  * Advanced escape function for Markdown content with the following rules:
- * - A `-` or `*` or `#` character at the start of a line is escaped with a backslash.
+ * - A `-` or `*` or `#` character at the start of a line (ignoring leading whitespace) is escaped with a backslash.
+ * - A number immediately followed by a period at the start of a line (ignoring leading whitespace) has the period escaped with a backslash (e.g., `1.` becomes `1\.`).
  * - Tab characters are replaced with 4 HTML encoded spaces (` `).
  * - A `-` character surrounded by spaces or tabs has those spaces or tabs replaced with HTML encoded spaces (` `).
  * - ``` being the only content on a single line is replaced with ` ` `
@@ -92,8 +93,14 @@ export function escapeContent(str) {
       return line.replace('```', '` ` `')
     }
 
-    // Rule: A `-` or `*` or `#` character at the start of a line is escaped with a backslash
-    const processedLine = line.replace(/^([-*#])/, String.raw`\$1`)
+    // Rule: A `-` or `*` or `#` character at the start of a line (allowing leading whitespace) is escaped with a backslash
+    let processedLine = line.replace(/^([ \t]*)([-*#])/, String.raw`$1\$2`)
+
+    // Rule: A number immediately followed by a period at the start of a line (allowing leading whitespace) has the period escaped
+    processedLine = processedLine.replace(
+      /^([ \t]*)(\d+)\./,
+      String.raw`$1$2\.`
+    )
 
     return processedLine
   })

src/lib/notify.test.js

@@ -241,5 +241,65 @@ describe('Utils: Notify', () => {
       const result = escapeContent(input)
       expect(result).toBe('He said: \\\\\\\\\\"it\\\\\\\\\\\'s fine\\\\\\\\\\"')
     })
+
+    it('should escape period after number at start of line', () => {
+      expect(escapeContent('1.1 abc')).toBe('1\\.1 abc')
+    })
+
+    it('should escape period after number at start of line with no following content', () => {
+      expect(escapeContent('3.')).toBe('3\\.')
+    })
+
+    it('should not escape period when space between number and period at start of line', () => {
+      expect(escapeContent('1 . abc')).toBe('1 . abc')
+    })
+
+    it('should not escape number-period sequence in the middle of text', () => {
+      expect(escapeContent('abc 1.1 hello')).toBe('abc 1.1 hello')
+    })
+
+    it('should escape number-period on multiple lines', () => {
+      expect(escapeContent('1. first\n2. second\n3. third')).toBe(
+        '1\\. first\n2\\. second\n3\\. third'
+      )
+    })
+
+    it('should escape multi-digit number followed by period at start of line', () => {
+      expect(escapeContent('123.456')).toBe('123\\.456')
+    })
+
+    it('should escape hyphen with leading spaces', () => {
+      expect(escapeContent('  - list item')).toBe('  \\- list item')
+    })
+
+    it('should escape hyphen with leading tab', () => {
+      expect(escapeContent('\t- list item')).toBe(
+        '    \\- list item'
+      )
+    })
+
+    it('should escape asterisk with leading spaces', () => {
+      expect(escapeContent('   *bold')).toBe('   \\*bold')
+    })
+
+    it('should escape hash with leading spaces', () => {
+      expect(escapeContent('  #heading')).toBe('  \\#heading')
+    })
+
+    it('should escape number-period with leading spaces', () => {
+      expect(escapeContent('  1. item')).toBe('  1\\. item')
+    })
+
+    it('should escape number-period with leading tab', () => {
+      expect(escapeContent('\t1. item')).toBe(
+        '    1\\. item'
+      )
+    })
+
+    it('should escape indented numbered list across multiple lines', () => {
+      expect(escapeContent('  1. first\n  2. second')).toBe(
+        '  1\\. first\n  2\\. second'
+      )
+    })
   })
 })