141dfc3321
## Description This PR fixes an issue where Twilio WhatsApp messages were losing newlines and markdown formatting. The problem had two root causes: 1. Text-based renderers (WhatsApp, Instagram, SMS) were converting newlines to spaces when processing plain text without markdown list markers 2. Twilio WhatsApp channels were incorrectly using the plain text renderer instead of the WhatsApp renderer, stripping all markdown formatting The fix updates the markdown rendering system to: - Preserve newlines by overriding the `softbreak` method in WhatsApp, Instagram, and PlainText renderers - Detect Twilio WhatsApp channels (via the `medium` field) and route them to use the WhatsApp renderer - Maintain backward compatibility with existing code ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? Added comprehensive test coverage: - 3 new tests for newline preservation in WhatsApp, Instagram, and SMS channels - 4 new tests for Twilio WhatsApp specific behavior (medium detection, formatting preservation, backward compatibility) - All 53 tests passing (up from 50) Manual testing verified: - Twilio WhatsApp messages with plain text preserve newlines - Twilio WhatsApp messages with markdown preserve formatting (bold, italic, links) - Regular WhatsApp, Instagram, and SMS channels continue to work correctly - Backward compatibility maintained when channel parameter is not provided ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules
410 lines
15 KiB
Ruby
410 lines
15 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Messages::MarkdownRendererService, type: :service do
|
|
describe '#render' do
|
|
context 'when content is blank' do
|
|
it 'returns the content as-is for nil' do
|
|
result = described_class.new(nil, 'Channel::Whatsapp').render
|
|
expect(result).to be_nil
|
|
end
|
|
|
|
it 'returns the content as-is for empty string' do
|
|
result = described_class.new('', 'Channel::Whatsapp').render
|
|
expect(result).to eq('')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Whatsapp' do
|
|
let(:channel_type) { 'Channel::Whatsapp' }
|
|
|
|
it 'converts bold from double to single asterisk' do
|
|
content = '**bold text**'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('*bold text*')
|
|
end
|
|
|
|
it 'keeps italic with underscore' do
|
|
content = '_italic text_'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('_italic text_')
|
|
end
|
|
|
|
it 'keeps code with backticks' do
|
|
content = '`code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('`code`')
|
|
end
|
|
|
|
it 'converts links to URLs only' do
|
|
content = '[link text](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('https://example.com')
|
|
end
|
|
|
|
it 'handles combined formatting' do
|
|
content = '**bold** _italic_ `code` [link](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('*bold* _italic_ `code` https://example.com')
|
|
end
|
|
|
|
it 'handles nested formatting' do
|
|
content = '**bold _italic_**'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('*bold _italic_*')
|
|
end
|
|
|
|
it 'converts bullet lists' do
|
|
content = "- item 1\n- item 2"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to include('- item 1')
|
|
expect(result.strip).to include('- item 2')
|
|
expect(result).to include("- item 1\n- item 2")
|
|
end
|
|
|
|
it 'preserves newlines in plain text without list markers' do
|
|
content = "Line 1\nLine 2\nLine 3"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include("Line 1\nLine 2\nLine 3")
|
|
expect(result).not_to include('Line 1 Line 2')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Instagram' do
|
|
let(:channel_type) { 'Channel::Instagram' }
|
|
|
|
it 'converts bold from double to single asterisk' do
|
|
content = '**bold text**'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('*bold text*')
|
|
end
|
|
|
|
it 'keeps italic with underscore' do
|
|
content = '_italic text_'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('_italic text_')
|
|
end
|
|
|
|
it 'strips code backticks' do
|
|
content = '`code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('code')
|
|
end
|
|
|
|
it 'converts links to URLs only' do
|
|
content = '[link text](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('https://example.com')
|
|
end
|
|
|
|
it 'preserves bullet list markers' do
|
|
content = "- first item\n- second item"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('- first item')
|
|
expect(result).to include('- second item')
|
|
end
|
|
|
|
it 'preserves ordered list markers with numbering' do
|
|
content = "1. first step\n2. second step"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('1. first step')
|
|
expect(result).to include('2. second step')
|
|
end
|
|
|
|
it 'preserves newlines in plain text without list markers' do
|
|
content = "Line 1\nLine 2\nLine 3"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include("Line 1\nLine 2\nLine 3")
|
|
expect(result).not_to include('Line 1 Line 2')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Line' do
|
|
let(:channel_type) { 'Channel::Line' }
|
|
|
|
it 'adds spaces around bold markers' do
|
|
content = '**bold**'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include(' *bold* ')
|
|
end
|
|
|
|
it 'adds spaces around italic markers' do
|
|
content = '_italic_'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include(' _italic_ ')
|
|
end
|
|
|
|
it 'adds spaces around code markers' do
|
|
content = '`code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include(' `code` ')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Sms' do
|
|
let(:channel_type) { 'Channel::Sms' }
|
|
|
|
it 'strips all markdown formatting' do
|
|
content = '**bold** _italic_ `code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('bold italic code')
|
|
end
|
|
|
|
it 'preserves URLs from links in plain text format' do
|
|
content = '[link text](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq('link text https://example.com')
|
|
end
|
|
|
|
it 'preserves URLs in messages with multiple links' do
|
|
content = 'Visit [our site](https://example.com) or [help center](https://help.example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq('Visit our site https://example.com or help center https://help.example.com')
|
|
end
|
|
|
|
it 'preserves link text and URL when both are present' do
|
|
content = '[Reset password](https://example.com/reset)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq('Reset password https://example.com/reset')
|
|
end
|
|
|
|
it 'handles complex markdown' do
|
|
content = "# Heading\n\n**bold** _italic_ [link](https://example.com)"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('Heading')
|
|
expect(result).to include('bold')
|
|
expect(result).to include('italic')
|
|
expect(result).to include('link https://example.com')
|
|
expect(result).not_to include('**')
|
|
expect(result).not_to include('_')
|
|
expect(result).not_to include('[')
|
|
end
|
|
|
|
it 'preserves bullet list markers' do
|
|
content = "- first item\n- second item\n- third item"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('- first item')
|
|
expect(result).to include('- second item')
|
|
expect(result).to include('- third item')
|
|
end
|
|
|
|
it 'preserves ordered list markers with numbering' do
|
|
content = "1. first step\n2. second step\n3. third step"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('1. first step')
|
|
expect(result).to include('2. second step')
|
|
expect(result).to include('3. third step')
|
|
end
|
|
|
|
it 'preserves newlines in plain text without list markers' do
|
|
content = "Line 1\nLine 2\nLine 3"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include("Line 1\nLine 2\nLine 3")
|
|
expect(result).not_to include('Line 1 Line 2')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Telegram' do
|
|
let(:channel_type) { 'Channel::Telegram' }
|
|
|
|
it 'converts to HTML format' do
|
|
content = '**bold** _italic_ `code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<strong>bold</strong>')
|
|
expect(result).to include('<em>italic</em>')
|
|
expect(result).to include('<code>code</code>')
|
|
end
|
|
|
|
it 'handles links' do
|
|
content = '[link text](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<a href="https://example.com">link text</a>')
|
|
end
|
|
|
|
it 'preserves newlines' do
|
|
content = "line 1\nline 2"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include("\n")
|
|
end
|
|
|
|
it 'converts strikethrough to HTML' do
|
|
content = '~~strikethrough text~~'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<del>strikethrough text</del>')
|
|
end
|
|
|
|
it 'converts blockquotes to HTML' do
|
|
content = '> quoted text'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<blockquote>')
|
|
expect(result).to include('quoted text')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Email' do
|
|
let(:channel_type) { 'Channel::Email' }
|
|
|
|
it 'renders full HTML' do
|
|
content = '**bold** _italic_'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<strong>bold</strong>')
|
|
expect(result).to include('<em>italic</em>')
|
|
end
|
|
|
|
it 'renders ordered lists as HTML' do
|
|
content = "1. first\n2. second"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<ol>')
|
|
expect(result).to include('<li>first</li>')
|
|
end
|
|
|
|
it 'converts strikethrough to HTML' do
|
|
content = '~~strikethrough text~~'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<del>strikethrough text</del>')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::WebWidget' do
|
|
let(:channel_type) { 'Channel::WebWidget' }
|
|
|
|
it 'renders full HTML like Email' do
|
|
content = '**bold** _italic_ `code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<strong>bold</strong>')
|
|
expect(result).to include('<em>italic</em>')
|
|
expect(result).to include('<code>code</code>')
|
|
end
|
|
|
|
it 'converts strikethrough to HTML' do
|
|
content = '~~strikethrough text~~'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('<del>strikethrough text</del>')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::FacebookPage' do
|
|
let(:channel_type) { 'Channel::FacebookPage' }
|
|
|
|
it 'converts bold to single asterisk like Instagram' do
|
|
content = '**bold text**'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('*bold text*')
|
|
end
|
|
|
|
it 'strips unsupported formatting' do
|
|
content = '`code` ~~strike~~'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('code ~~strike~~')
|
|
end
|
|
|
|
it 'preserves bullet list markers like Instagram' do
|
|
content = "- first item\n- second item"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('- first item')
|
|
expect(result).to include('- second item')
|
|
end
|
|
|
|
it 'preserves ordered list markers with numbering like Instagram' do
|
|
content = "1. first step\n2. second step"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('1. first step')
|
|
expect(result).to include('2. second step')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::TwilioSms' do
|
|
let(:channel_type) { 'Channel::TwilioSms' }
|
|
|
|
it 'strips all markdown like SMS when medium is sms' do
|
|
content = '**bold** _italic_'
|
|
channel = instance_double(Channel::TwilioSms, whatsapp?: false)
|
|
result = described_class.new(content, channel_type, channel).render
|
|
expect(result.strip).to eq('bold italic')
|
|
end
|
|
|
|
it 'uses WhatsApp renderer when medium is whatsapp' do
|
|
content = '**bold** _italic_ [link](https://example.com)'
|
|
channel = instance_double(Channel::TwilioSms, whatsapp?: true)
|
|
result = described_class.new(content, channel_type, channel).render
|
|
expect(result.strip).to eq('*bold* _italic_ https://example.com')
|
|
end
|
|
|
|
it 'preserves newlines in Twilio WhatsApp' do
|
|
content = "Line 1\nLine 2\nLine 3"
|
|
channel = instance_double(Channel::TwilioSms, whatsapp?: true)
|
|
result = described_class.new(content, channel_type, channel).render
|
|
expect(result).to include("Line 1\nLine 2\nLine 3")
|
|
end
|
|
|
|
it 'backwards compatible when channel is not provided' do
|
|
content = '**bold** _italic_'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result.strip).to eq('bold italic')
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::Api' do
|
|
let(:channel_type) { 'Channel::Api' }
|
|
|
|
it 'preserves markdown as-is' do
|
|
content = '**bold** _italic_ `code`'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq('**bold** _italic_ `code`')
|
|
end
|
|
|
|
it 'preserves links with markdown syntax' do
|
|
content = '[Click here](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq('[Click here](https://example.com)')
|
|
end
|
|
|
|
it 'preserves lists with markdown syntax' do
|
|
content = "- Item 1\n- Item 2"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq("- Item 1\n- Item 2")
|
|
end
|
|
end
|
|
|
|
context 'when channel is Channel::TwitterProfile' do
|
|
let(:channel_type) { 'Channel::TwitterProfile' }
|
|
|
|
it 'strips all markdown like SMS' do
|
|
content = '**bold** [link](https://example.com)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('bold')
|
|
expect(result).to include('link https://example.com')
|
|
expect(result).not_to include('**')
|
|
expect(result).not_to include('[')
|
|
end
|
|
|
|
it 'preserves URLs from links' do
|
|
content = '[Reset password](https://example.com/reset)'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq('Reset password https://example.com/reset')
|
|
end
|
|
end
|
|
|
|
context 'when testing all formatting types' do
|
|
let(:channel_type) { 'Channel::Whatsapp' }
|
|
|
|
it 'handles ordered lists' do
|
|
content = "1. first\n2. second\n3. third"
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to include('first')
|
|
expect(result).to include('second')
|
|
expect(result).to include('third')
|
|
end
|
|
end
|
|
|
|
context 'when channel is unknown' do
|
|
let(:channel_type) { 'Channel::Unknown' }
|
|
|
|
it 'returns content as-is' do
|
|
content = '**bold** _italic_'
|
|
result = described_class.new(content, channel_type).render
|
|
expect(result).to eq(content)
|
|
end
|
|
end
|
|
end
|
|
end
|