4c166e11df
refs https://github.com/TryGhost/Team/issues/2339 - Includes a new pattern in the job manager that allows us to properly await jobs. - Added new convenience mocking methods to stub settings - Tests the main flows for bulk sending: - Sending in multiple batches - Sending to multiple segments - Handling a failed batch and retrying that batch - Fixes bug in batch generation (ordering not working) In a different PR I'll add more detailed tests.
128 lines
3.5 KiB
JavaScript
128 lines
3.5 KiB
JavaScript
/**
|
|
* @typedef {object} EmailData
|
|
* @prop {string} html
|
|
* @prop {string} plaintext
|
|
* @prop {string} subject
|
|
* @prop {string} from
|
|
* @prop {string} emailId
|
|
* @prop {string} [replyTo]
|
|
* @prop {Recipient[]} recipients
|
|
* @prop {import("./email-renderer").ReplacementDefinition[]} replacementDefinitions
|
|
*
|
|
* @typedef {object} IEmailProviderService
|
|
* @prop {(emailData: EmailData, options: EmailSendingOptions) => Promise<EmailProviderSuccessResponse>} send
|
|
* @prop {() => number} getMaximumRecipients
|
|
*
|
|
* @typedef {object} Post
|
|
* @typedef {object} Newsletter
|
|
*/
|
|
|
|
/**
|
|
* @typedef {import("./email-renderer")} EmailRenderer
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} EmailSendingOptions
|
|
* @prop {boolean} clickTrackingEnabled
|
|
* @prop {boolean} openTrackingEnabled
|
|
*/
|
|
|
|
/**
|
|
* @typedef {import("./email-renderer").MemberLike} MemberLike
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} Recipient
|
|
* @prop {string} email
|
|
* @prop {Replacement[]} replacements
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} Replacement
|
|
* @prop {string} id
|
|
* @prop {RegExp} token
|
|
* @prop {string} value
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} EmailProviderSuccessResponse
|
|
* @prop {string} id
|
|
*/
|
|
|
|
class SendingService {
|
|
#emailProvider;
|
|
#emailRenderer;
|
|
|
|
/**
|
|
* @param {object} dependencies
|
|
* @param {IEmailProviderService} dependencies.emailProvider
|
|
* @param {EmailRenderer} dependencies.emailRenderer
|
|
*/
|
|
constructor({
|
|
emailProvider,
|
|
emailRenderer
|
|
}) {
|
|
this.#emailProvider = emailProvider;
|
|
this.#emailRenderer = emailRenderer;
|
|
}
|
|
|
|
getMaximumRecipients() {
|
|
return this.#emailProvider.getMaximumRecipients();
|
|
}
|
|
|
|
/**
|
|
* Send a given post, rendered for a given newsletter and segment to the members provided in the list
|
|
* @param {object} data
|
|
* @param {Post} data.post
|
|
* @param {Newsletter} data.newsletter
|
|
* @param {string|null} data.segment
|
|
* @param {string|null} data.emailId
|
|
* @param {MemberLike[]} data.members
|
|
* @param {EmailSendingOptions} options
|
|
* @returns {Promise<EmailProviderSuccessResponse>}
|
|
*/
|
|
async send({post, newsletter, segment, members, emailId}, options) {
|
|
const emailBody = await this.#emailRenderer.renderBody(
|
|
post,
|
|
newsletter,
|
|
segment,
|
|
options
|
|
);
|
|
|
|
const recipients = this.buildRecipients(members, emailBody.replacements);
|
|
return await this.#emailProvider.send({
|
|
subject: this.#emailRenderer.getSubject(post),
|
|
from: this.#emailRenderer.getFromAddress(post, newsletter),
|
|
replyTo: this.#emailRenderer.getReplyToAddress(post, newsletter) ?? undefined,
|
|
html: emailBody.html,
|
|
plaintext: emailBody.plaintext,
|
|
recipients,
|
|
emailId: emailId,
|
|
replacementDefinitions: emailBody.replacements
|
|
}, options);
|
|
}
|
|
|
|
/**
|
|
* @private
|
|
* @param {MemberLike[]} members
|
|
* @param {import("./email-renderer").ReplacementDefinition[]} replacementDefinitions
|
|
* @returns {Recipient[]}
|
|
*/
|
|
buildRecipients(members, replacementDefinitions) {
|
|
return members.map((member) => {
|
|
return {
|
|
email: member.email,
|
|
replacements: replacementDefinitions.map((def) => {
|
|
return {
|
|
id: def.id,
|
|
token: def.token,
|
|
value: def.getValue(member)
|
|
};
|
|
})
|
|
};
|
|
});
|
|
}
|
|
}
|
|
|
|
module.exports = SendingService;
|