TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-23 11:55:01 +03:00
Code Issues Projects Releases Wiki Activity

Implemented retrying for sending email via Mailgun API

Browse Source 
no issue

Retry sending an email up to 5 times if it failed.
This commit is contained in:
Simon Backx 2023-02-21 15:41:00 +01:00
parent b665b1a3cc
commit 7781c2da07
3 changed files with 62 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
ghost/email-service/lib/batch-sending-service.js
View File

@ -35,6 +35,7 @@ class BatchSendingService {
// Retry database queries happening before sending the email // Retry database queries happening before sending the email
#BEFORE_RETRY_CONFIG = {maxRetries: 10, maxTime: 10 * 60 * 1000, sleep: 2000}; #BEFORE_RETRY_CONFIG = {maxRetries: 10, maxTime: 10 * 60 * 1000, sleep: 2000};
#AFTER_RETRY_CONFIG = {maxRetries: 20, maxTime: 30 * 60 * 1000, sleep: 2000}; #AFTER_RETRY_CONFIG = {maxRetries: 20, maxTime: 30 * 60 * 1000, sleep: 2000};
#MAILGUN_API_RETRY_CONFIG = {sleep: 10 * 1000, maxRetries: 5};
/** /**
* @param {Object} dependencies * @param {Object} dependencies
@ -61,7 +62,8 @@ class BatchSendingService {
db, db,
sentry, sentry,
BEFORE_RETRY_CONFIG, BEFORE_RETRY_CONFIG,
AFTER_RETRY_CONFIG AFTER_RETRY_CONFIG,
MAILGUN_API_RETRY_CONFIG
}) { }) {
this.#emailRenderer = emailRenderer; this.#emailRenderer = emailRenderer;
this.#sendingService = sendingService; this.#sendingService = sendingService;
@ -77,6 +79,13 @@ class BatchSendingService {
if (AFTER_RETRY_CONFIG) { if (AFTER_RETRY_CONFIG) {
this.#AFTER_RETRY_CONFIG = AFTER_RETRY_CONFIG; this.#AFTER_RETRY_CONFIG = AFTER_RETRY_CONFIG;
} }
if (MAILGUN_API_RETRY_CONFIG) {
this.#MAILGUN_API_RETRY_CONFIG = MAILGUN_API_RETRY_CONFIG;
} else {
if (process.env.NODE_ENV.startsWith('test')) {
this.#MAILGUN_API_RETRY_CONFIG = {maxRetries: 0};
}
}
} }
#getBeforeRetryConfig(email) { #getBeforeRetryConfig(email) {
@ -393,17 +402,19 @@ class BatchSendingService {
{...this.#getBeforeRetryConfig(email), description: `getBatchMembers batch ${originalBatch.id}`} {...this.#getBeforeRetryConfig(email), description: `getBatchMembers batch ${originalBatch.id}`}
); );
const response = await this.#sendingService.send({ const response = await this.retryDb(async () => {
emailId: email.id, return await this.#sendingService.send({
post, emailId: email.id,
newsletter, post,
segment: batch.get('member_segment'), newsletter,
members segment: batch.get('member_segment'),
}, { members
openTrackingEnabled: !!email.get('track_opens'), }, {
clickTrackingEnabled: !!email.get('track_clicks'), openTrackingEnabled: !!email.get('track_opens'),
emailBodyCache clickTrackingEnabled: !!email.get('track_clicks'),
}); emailBodyCache
});
}, {...this.#MAILGUN_API_RETRY_CONFIG, description: `Sending email batch ${originalBatch.id}`});
succeeded = true; succeeded = true;
await this.retryDb( await this.retryDb(
@ -420,8 +431,13 @@ class BatchSendingService {
{...this.#AFTER_RETRY_CONFIG, description: `save batch ${originalBatch.id} -> submitted`} {...this.#AFTER_RETRY_CONFIG, description: `save batch ${originalBatch.id} -> submitted`}
); );
} catch (err) { } catch (err) {
if (!err.code || err.code !== 'BULK_EMAIL_SEND_FAILED') { if (err.code && err.code === 'BULK_EMAIL_SEND_FAILED') {
// BULK_EMAIL_SEND_FAILED are already logged in mailgun-email-provider logging.error(err);
if (this.#sentry) {
// Log the original error to Sentry
this.#sentry.captureException(err);
}
} else {
const ghostError = new errors.EmailError({ const ghostError = new errors.EmailError({
err, err,
code: 'BULK_EMAIL_SEND_FAILED', code: 'BULK_EMAIL_SEND_FAILED',
@ -533,17 +549,18 @@ class BatchSendingService {
return await func(); return await func();
} catch (e) { } catch (e) {
const retryCount = (options.retryCount ?? 0); const retryCount = (options.retryCount ?? 0);
const sleep = (options.sleep ?? 0) * (retryCount + 1); const sleep = (options.sleep ?? 0);
if (retryCount >= options.maxRetries || (options.stopAfterDate && (new Date(Date.now() + sleep)) > options.stopAfterDate)) { if (retryCount >= options.maxRetries || (options.stopAfterDate && (new Date(Date.now() + sleep)) > options.stopAfterDate)) {
const ghostError = new errors.EmailError({ if (retryCount > 0) {
err: e, const ghostError = new errors.EmailError({
code: 'BULK_EMAIL_DB_RETRY', err: e,
message: `[BULK_EMAIL_DB_RETRY] ${options.description} - Stopped retrying`, code: 'BULK_EMAIL_DB_RETRY',
context: e.message message: `[BULK_EMAIL_DB_RETRY] ${options.description} - Stopped retrying`,
}); context: e.message
});
logging.error(ghostError);
logging.error(ghostError);
}
throw e; throw e;
} }
@ -561,7 +578,7 @@ class BatchSendingService {
setTimeout(resolve, sleep); setTimeout(resolve, sleep);
}); });
} }
return await this.retryDb(func, {...options, retryCount: retryCount + 1}); return await this.retryDb(func, {...options, retryCount: retryCount + 1, sleep: sleep * 2});
} }
} }
} }

3
ghost/email-service/lib/mailgun-email-provider.js
View File

@ -165,11 +165,8 @@ class MailgunEmailProvider {
}); });
} }
logging.error(ghostError);
debug(`failed to send message (${Date.now() - startTime}ms)`); debug(`failed to send message (${Date.now() - startTime}ms)`);
// log error to custom error handler. ex sentry
this.#errorHandler(ghostError);
throw ghostError; throw ghostError;
} }
} }

27
ghost/email-service/test/batch-sending-service.test.js
View File

@ -661,7 +661,10 @@ describe('Batch Sending Service', function () {
const findOne = sinon.spy(EmailBatch, 'findOne'); const findOne = sinon.spy(EmailBatch, 'findOne');
const service = new BatchSendingService({ const service = new BatchSendingService({
models: {EmailBatch, EmailRecipient}, models: {EmailBatch, EmailRecipient},
sendingService sendingService,
MAILGUN_API_RETRY_CONFIG: {
sleep: 10, maxRetries: 5
}
}); });
const result = await service.sendBatch({ const result = await service.sendBatch({
@ -672,8 +675,8 @@ describe('Batch Sending Service', function () {
}); });
assert.equal(result, false); assert.equal(result, false);
sinon.assert.calledOnce(errorLog); sinon.assert.callCount(errorLog, 7);
sinon.assert.calledOnce(sendingService.send); sinon.assert.callCount(sendingService.send, 6);
sinon.assert.calledOnce(findOne); sinon.assert.calledOnce(findOne);
const batch = await findOne.firstCall.returnValue; const batch = await findOne.firstCall.returnValue;
@ -701,6 +704,9 @@ describe('Batch Sending Service', function () {
sendingService, sendingService,
sentry: { sentry: {
captureException captureException
},
MAILGUN_API_RETRY_CONFIG: {
maxRetries: 0
} }
}); });
@ -748,11 +754,17 @@ describe('Batch Sending Service', function () {
code: 'BULK_EMAIL_SEND_FAILED' code: 'BULK_EMAIL_SEND_FAILED'
})) }))
}; };
const captureException = sinon.stub();
const findOne = sinon.spy(EmailBatch, 'findOne'); const findOne = sinon.spy(EmailBatch, 'findOne');
const service = new BatchSendingService({ const service = new BatchSendingService({
models: {EmailBatch, EmailRecipient}, models: {EmailBatch, EmailRecipient},
sendingService sendingService,
sentry: {
captureException
},
MAILGUN_API_RETRY_CONFIG: {
maxRetries: 0
}
}); });
const result = await service.sendBatch({ const result = await service.sendBatch({
@ -763,8 +775,11 @@ describe('Batch Sending Service', function () {
}); });
assert.equal(result, false); assert.equal(result, false);
sinon.assert.notCalled(errorLog); sinon.assert.calledOnce(errorLog);
sinon.assert.calledOnce(sendingService.send); sinon.assert.calledOnce(sendingService.send);
sinon.assert.calledOnce(captureException);
const sentryExeption = captureException.firstCall.args[0];
assert.equal(sentryExeption.message, 'Test error');
sinon.assert.calledOnce(findOne); sinon.assert.calledOnce(findOne);
const batch = await findOne.firstCall.returnValue; const batch = await findOne.firstCall.returnValue;