OpenSourceArk/Ghost
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
62aad6fd84
Ghost/ghost/email-service/test/mailgun-email-provider.test.js

246 lines
8.4 KiB
JavaScript
Raw Normal View History

Added eslint rule for file naming convention As discussed with the product team we want to enforce kebab-case file names for all files, with the exception of files which export a single class, in which case they should be PascalCase and reflect the class which they export. This will help find classes faster, and should push better naming for them too. Some files and packages have been excluded from this linting, specifically when a library or framework depends on the naming of a file for the functionality e.g. Ember, knex-migrator, adapter-manager
2023-05-02 23:43:47 +03:00
const MailgunEmailProvider = require('../lib/MailgunEmailProvider');
Added mailgun provider for sending emails (#15896) closes https://github.com/TryGhost/Team/issues/2309 - adds new mailgun provider to send out batch emails - updates sending service to send email id for mailgun provider, allows tagging mail with email id
2022-11-30 13:51:58 +03:00
const sinon = require('sinon');
const should = require('should');
Updated to use assert/strict everywhere (#17047) refs: https://github.com/TryGhost/Toolbox/issues/595 We're rolling out new rules around the node assert library, the first of which is enforcing the use of assert/strict. This means we don't need to use the strict version of methods, as the standard version will work that way by default. This caught some gotchas in our existing usage of assert where the lack of strict mode had unexpected results: - Url matching needs to be done on `url.href` see https://github.com/TryGhost/Ghost/pull/17047/commits/aa58b354a40751326fe3c00902b202099b2223d2 - Null and undefined are not the same thing, there were a few cases of this being confused - Particularly questionable changes in [PostExporter tests](https://github.com/TryGhost/Ghost/pull/17047/commits/c1a468744beeca4c09ebfe4ac4f87fb3a685f25e) tracked [here](https://github.com/TryGhost/Team/issues/3505). - A typo see https://github.com/TryGhost/Ghost/pull/17047/commits/eaac9c293a87fe0c9646eb52f5f5ef3ecd6d56b0 Moving forward, using assert strict should help us to catch unexpected behaviour, particularly around nulls and undefineds during implementation.
2023-06-21 11:56:59 +03:00
const assert = require('assert/strict');
Added mailgun provider for sending emails (#15896) closes https://github.com/TryGhost/Team/issues/2309 - adds new mailgun provider to send out batch emails - updates sending service to send email id for mailgun provider, allows tagging mail with email id
2022-11-30 13:51:58 +03:00
describe('Mailgun Email Provider', function () {
describe('send', function () {
let mailgunClient;
let sendStub;
beforeEach(function () {
sendStub = sinon.stub().resolves({
id: 'provider-123'
});
mailgunClient = {
send: sendStub
};
});
afterEach(function () {
sinon.restore();
});
it('calls mailgun client with correct data', async function () {
const mailgunEmailProvider = new MailgunEmailProvider({
mailgunClient,
errorHandler: () => {}
});
const response = await mailgunEmailProvider.send({
subject: 'Hi',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost@example.com',
emailId: '123',
recipients: [
{
email: 'member@example.com',
replacements: [
{
id: 'name',
token: '{{name}}',
value: 'John'
}
]
}
],
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: () => 'John'
}
]
}, {
clickTrackingEnabled: true,
openTrackingEnabled: true
});
should(response.id).eql('provider-123');
should(sendStub.calledOnce).be.true();
sendStub.calledWith(
{
subject: 'Hi',
html: '<html><body>Hi %recipient.name%</body></html>',
plaintext: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost@example.com',
id: '123',
track_opens: true,
track_clicks: true
},
{'member@example.com': {name: 'John'}},
[]
).should.be.true();
});
it('handles mailgun client error correctly', async function () {
const mailgunErr = new Error('Bad Request');
mailgunErr.details = 'Invalid domain';
mailgunErr.status = 400;
sendStub = sinon.stub().throws({
error: mailgunErr,
messageData: {}
});
mailgunClient = {
send: sendStub
};
const mailgunEmailProvider = new MailgunEmailProvider({
mailgunClient,
errorHandler: () => {}
});
try {
const response = await mailgunEmailProvider.send({
subject: 'Hi',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost@example.com',
emailId: '123',
recipients: [
{
email: 'member@example.com',
replacements: [
{
id: 'name',
token: '{{name}}',
value: 'John'
}
]
}
],
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: () => 'John'
}
]
}, {});
should(response).be.undefined();
} catch (e) {
Restricted email-service package to 100% test coverage fixes https://github.com/TryGhost/Team/issues/2339 The email service is now fully covered by tests, and this commit also forces the test coverage to remain 100% after future changes.
2023-01-11 15:52:52 +03:00
should(e.message).eql('Bad Request: Invalid domain');
Added mailgun provider for sending emails (#15896) closes https://github.com/TryGhost/Team/issues/2309 - adds new mailgun provider to send out batch emails - updates sending service to send email id for mailgun provider, allows tagging mail with email id
2022-11-30 13:51:58 +03:00
should(e.statusCode).eql(400);
should(e.errorDetails).eql('{"error":{"details":"Invalid domain","status":400},"messageData":{}}');
}
});
Restricted email-service package to 100% test coverage fixes https://github.com/TryGhost/Team/issues/2339 The email service is now fully covered by tests, and this commit also forces the test coverage to remain 100% after future changes.
2023-01-11 15:52:52 +03:00
it('handles unknown error correctly', async function () {
const mailgunErr = new Error('Unknown Error');
sendStub = sinon.stub().throws(mailgunErr);
mailgunClient = {
send: sendStub
};
const mailgunEmailProvider = new MailgunEmailProvider({
mailgunClient,
errorHandler: () => {}
});
try {
const response = await mailgunEmailProvider.send({
subject: 'Hi',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost@example.com',
emailId: '123',
recipients: [
{
email: 'member@example.com',
replacements: [
{
id: 'name',
token: '{{name}}',
value: 'John'
}
]
}
],
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: () => 'John'
}
]
}, {});
should(response).be.undefined();
} catch (e) {
should(e.message).eql('Unknown Error');
should(e.errorDetails).eql(undefined);
}
});
it('handles empty error correctly', async function () {
const mailgunErr = new Error('');
sendStub = sinon.stub().throws(mailgunErr);
mailgunClient = {
send: sendStub
};
const mailgunEmailProvider = new MailgunEmailProvider({
mailgunClient,
errorHandler: () => {}
});
try {
const response = await mailgunEmailProvider.send({
subject: 'Hi',
html: '<html><body>Hi {{name}}</body></html>',
plaintext: 'Hi',
from: 'ghost@example.com',
replyTo: 'ghost@example.com',
emailId: '123',
recipients: [
{
email: 'member@example.com',
replacements: [
{
id: 'name',
token: '{{name}}',
value: 'John'
}
]
}
],
replacementDefinitions: [
{
id: 'name',
token: '{{name}}',
getValue: () => 'John'
}
]
}, {});
should(response).be.undefined();
} catch (e) {
should(e.message).eql('Mailgun Error');
should(e.errorDetails).eql(undefined);
}
});
});
describe('getMaximumRecipients', function () {
Added `bulkEmail.batchSize` option to configure batch size refs https://github.com/TryGhost/Ghost/issues/15725 This pull request adds a new configuration option for the Mailgun email provider that allows the user to set the maximum number of recipients per email batch via a new config option `bulkEmail.batchSize`
2023-06-26 13:57:44 +03:00
let mailgunClient;
let getBatchSizeStub;
Restricted email-service package to 100% test coverage fixes https://github.com/TryGhost/Team/issues/2339 The email service is now fully covered by tests, and this commit also forces the test coverage to remain 100% after future changes.
2023-01-11 15:52:52 +03:00
it('returns 1000', function () {
Added `bulkEmail.batchSize` option to configure batch size refs https://github.com/TryGhost/Ghost/issues/15725 This pull request adds a new configuration option for the Mailgun email provider that allows the user to set the maximum number of recipients per email batch via a new config option `bulkEmail.batchSize`
2023-06-26 13:57:44 +03:00
getBatchSizeStub = sinon.stub().returns(1000);
mailgunClient = {
getBatchSize: getBatchSizeStub
};
const provider = new MailgunEmailProvider({
mailgunClient,
errorHandler: () => {}
});
Updated to use assert/strict everywhere (#17047) refs: https://github.com/TryGhost/Toolbox/issues/595 We're rolling out new rules around the node assert library, the first of which is enforcing the use of assert/strict. This means we don't need to use the strict version of methods, as the standard version will work that way by default. This caught some gotchas in our existing usage of assert where the lack of strict mode had unexpected results: - Url matching needs to be done on `url.href` see https://github.com/TryGhost/Ghost/pull/17047/commits/aa58b354a40751326fe3c00902b202099b2223d2 - Null and undefined are not the same thing, there were a few cases of this being confused - Particularly questionable changes in [PostExporter tests](https://github.com/TryGhost/Ghost/pull/17047/commits/c1a468744beeca4c09ebfe4ac4f87fb3a685f25e) tracked [here](https://github.com/TryGhost/Team/issues/3505). - A typo see https://github.com/TryGhost/Ghost/pull/17047/commits/eaac9c293a87fe0c9646eb52f5f5ef3ecd6d56b0 Moving forward, using assert strict should help us to catch unexpected behaviour, particularly around nulls and undefineds during implementation.
2023-06-21 11:56:59 +03:00
assert.equal(provider.getMaximumRecipients(), 1000);
Restricted email-service package to 100% test coverage fixes https://github.com/TryGhost/Team/issues/2339 The email service is now fully covered by tests, and this commit also forces the test coverage to remain 100% after future changes.
2023-01-11 15:52:52 +03:00
});
Added mailgun provider for sending emails (#15896) closes https://github.com/TryGhost/Team/issues/2309 - adds new mailgun provider to send out batch emails - updates sending service to send email id for mailgun provider, allows tagging mail with email id
2022-11-30 13:51:58 +03:00
});
});
Reference in New Issue Copy Permalink