TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-18 16:01:40 +03:00
Code Issues Projects Releases Wiki Activity
0f925dde8c
Ghost/ghost/email-service/test/sending-service.test.js

377 lines
13 KiB
JavaScript
Raw Normal View History

Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
const SendingService = require('../lib/sending-service');
const sinon = require('sinon');
Added 100% test coverage to SendingService refs https://github.com/TryGhost/Team/issues/2339
2023-01-11 15:38:54 +03:00
const assert = require('assert');
Added short lived caching to email batch body (#16233) fixes https://github.com/TryGhost/Team/issues/2522 When sending an email for multiple batches at the same time, we now reuse the same email body for each batch in the same segment. This reduces the amount of database queries and makes the sending more reliable in case of database failures. The cache is short lived. After sending the email it is automatically garbage collected.
2023-02-07 13:01:49 +03:00
const EmailBodyCache = require('../lib/email-body-cache');
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
describe('Sending service', function () {
describe('send', function () {
let emailProvider;
let emailRenderer;
let sendStub;
Added 100% test coverage to SendingService refs https://github.com/TryGhost/Team/issues/2339
2023-01-11 15:38:54 +03:00
let replyTo;
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
beforeEach(function () {
sendStub = sinon.stub().resolves({
id: 'provider-123'
});
Added 100% test coverage to SendingService refs https://github.com/TryGhost/Team/issues/2339
2023-01-11 15:38:54 +03:00
replyTo = 'ghost+reply@example.com';
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
emailRenderer = {
renderBody: sinon.stub().resolves({
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
replacements: [
{
id: 'name',
token: '{{name}}',
getValue: (member) => {
return member.name;
}
}
]
}),
getSubject: sinon.stub().returns('Hi'),
getFromAddress: sinon.stub().returns('ghost@example.com'),
Added 100% test coverage to SendingService refs https://github.com/TryGhost/Team/issues/2339
2023-01-11 15:38:54 +03:00
getReplyToAddress: () => {
return replyTo;
}
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
};
emailProvider = {
send: sendStub
};
});
afterEach(function () {
sinon.restore();
});
it('calls mailgun client with correct data', async function () {
const sendingService = new SendingService({
emailRenderer,
emailProvider
});
const response = await sendingService.send({
post: {},
newsletter: {},
segment: null,
emailId: '123',
members: [
{
email: 'member@example.com',
name: 'John'
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true
});
Added 100% test coverage to SendingService refs https://github.com/TryGhost/Team/issues/2339
2023-01-11 15:38:54 +03:00
assert.equal(response.id, 'provider-123');
sinon.assert.calledOnce(sendStub);
assert(sendStub.calledWith(
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
{
subject: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost+reply@example.com',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
emailId: '123',
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: sinon.match.func
}
Updated email sending to remove invalid recipient emails (#16171) closes https://github.com/TryGhost/Team/issues/2388 We have seen examples of sites with member emails that have invalid characters that can cause an entire email send to fail, or just cause a failure to those addresses. The issue that allowed members with invalid email address to be saved was patched earlier, but its possible there are still sites that contain some of those invalid email addresses. This change updates new sending service to filter out the recipients with invalid email address before passing them to mail provider, so these rogue addresses don't affect the whole batch in anyway. We also trim the recipient emails to clear out any spaces first, which is the most likely culprit. - uses new email validator that detects invalid email addresses with special chars
2023-01-24 13:43:10 +03:00
],
recipients: [
{
email: 'member@example.com',
replacements: [{
id: 'name',
token: '{{name}}',
value: 'John'
}]
}
]
},
{
clickTrackingEnabled: true,
openTrackingEnabled: true
}
));
});
🐛 Fixed email replacements without fallback fixes https://github.com/TryGhost/Team/issues/2557 When a member doen't have a name, and the first_name replacement doesn't have a fallback, we did show %recipient.first_name% instead of an empty string.
2023-02-13 17:49:43 +03:00
it('defaults to empty string if replacement returns undefined', async function () {
const sendingService = new SendingService({
emailRenderer,
emailProvider
});
const response = await sendingService.send({
post: {},
newsletter: {},
segment: null,
emailId: '123',
members: [
{
email: 'member@example.com',
name: undefined
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true
});
assert.equal(response.id, 'provider-123');
sinon.assert.calledOnce(sendStub);
assert(sendStub.calledWith(
{
subject: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost+reply@example.com',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
emailId: '123',
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: sinon.match.func
}
],
recipients: [
{
email: 'member@example.com',
replacements: [{
id: 'name',
token: '{{name}}',
value: ''
}]
}
]
},
{
clickTrackingEnabled: true,
openTrackingEnabled: true
}
));
});
Added short lived caching to email batch body (#16233) fixes https://github.com/TryGhost/Team/issues/2522 When sending an email for multiple batches at the same time, we now reuse the same email body for each batch in the same segment. This reduces the amount of database queries and makes the sending more reliable in case of database failures. The cache is short lived. After sending the email it is automatically garbage collected.
2023-02-07 13:01:49 +03:00
it('supports cache', async function () {
const emailBodyCache = new EmailBodyCache();
const sendingService = new SendingService({
emailRenderer,
emailProvider
});
const response = await sendingService.send({
post: {},
newsletter: {},
segment: null,
emailId: '123',
members: [
{
email: 'member@example.com',
name: 'John'
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true,
emailBodyCache
});
assert.equal(response.id, 'provider-123');
sinon.assert.calledOnce(sendStub);
sinon.assert.calledOnce(emailRenderer.renderBody);
assert(sendStub.calledWith(
{
subject: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost+reply@example.com',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
emailId: '123',
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: sinon.match.func
}
],
recipients: [
{
email: 'member@example.com',
replacements: [{
id: 'name',
token: '{{name}}',
value: 'John'
}]
}
]
},
{
clickTrackingEnabled: true,
openTrackingEnabled: true
}
));
// Do again and see if cache is used
const response2 = await sendingService.send({
post: {},
newsletter: {},
segment: null,
emailId: '123',
members: [
{
email: 'member@example.com',
name: 'John'
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true,
emailBodyCache
});
assert.equal(response2.id, 'provider-123');
sinon.assert.calledTwice(sendStub);
assert(sendStub.getCall(1).calledWith(
{
subject: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost+reply@example.com',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
emailId: '123',
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: sinon.match.func
}
],
recipients: [
{
email: 'member@example.com',
replacements: [{
id: 'name',
token: '{{name}}',
value: 'John'
}]
}
]
},
{
clickTrackingEnabled: true,
openTrackingEnabled: true
}
));
// Didn't call renderBody again
sinon.assert.calledOnce(emailRenderer.renderBody);
});
Updated email sending to remove invalid recipient emails (#16171) closes https://github.com/TryGhost/Team/issues/2388 We have seen examples of sites with member emails that have invalid characters that can cause an entire email send to fail, or just cause a failure to those addresses. The issue that allowed members with invalid email address to be saved was patched earlier, but its possible there are still sites that contain some of those invalid email addresses. This change updates new sending service to filter out the recipients with invalid email address before passing them to mail provider, so these rogue addresses don't affect the whole batch in anyway. We also trim the recipient emails to clear out any spaces first, which is the most likely culprit. - uses new email validator that detects invalid email addresses with special chars
2023-01-24 13:43:10 +03:00
it('removes invalid recipients before sending', async function () {
const sendingService = new SendingService({
emailRenderer,
emailProvider
});
const response = await sendingService.send({
post: {},
newsletter: {},
segment: null,
emailId: '123',
members: [
{
email: 'member@example.com',
name: 'John'
},
{
email: 'member+invalid@example.com<6F>',
name: 'John'
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true
});
assert.equal(response.id, 'provider-123');
sinon.assert.calledOnce(sendStub);
assert(sendStub.calledWith(
{
subject: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost+reply@example.com',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
emailId: '123',
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: sinon.match.func
}
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
],
recipients: [
{
email: 'member@example.com',
replacements: [{
id: 'name',
token: '{{name}}',
value: 'John'
}]
}
]
},
{
clickTrackingEnabled: true,
openTrackingEnabled: true
}
Added 100% test coverage to SendingService refs https://github.com/TryGhost/Team/issues/2339
2023-01-11 15:38:54 +03:00
));
});
it('maps null replyTo to undefined', async function () {
const sendingService = new SendingService({
emailRenderer,
emailProvider
});
replyTo = null;
const response = await sendingService.send({
post: {},
newsletter: {},
segment: null,
emailId: '123',
members: [
{
email: 'member@example.com',
name: 'John'
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true
});
assert.equal(response.id, 'provider-123');
sinon.assert.calledOnce(sendStub);
const firstCall = sendStub.getCall(0);
assert.equal(firstCall.args[0].replyTo, undefined);
});
});
describe('getMaximumRecipients', function () {
it('returns maximum recipients of email provider', function () {
const emailProvider = {
getMaximumRecipients: sinon.stub().returns(12)
};
const sendingService = new SendingService({
emailProvider
});
assert.equal(sendingService.getMaximumRecipients(), 12);
sinon.assert.calledOnce(emailProvider.getMaximumRecipients);
Updated unit test coverage for email service (#15913) refs https://github.com/TryGhost/Team/issues/2339 - adds unit test for email renderer, segmenter and sending service
2022-12-01 22:03:28 +03:00
});
});
});
Reference in New Issue Copy Permalink