mirror of
https://github.com/xtr-dev/payload-mailing.git
synced 2025-12-10 16:23:23 +00:00
Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0fa10164bf | |||
| ada13d27cb | |||
| de57dd4102 | |||
| d69f7c1f98 | |||
| d15fa454a0 | |||
| f431786907 | |||
| 107f67e22b | |||
| 7b853cbd4a | |||
| 59ce8c031a | |||
| 08ba814da0 | |||
| f303eda652 |
@@ -123,123 +123,6 @@ export default buildConfig({
|
||||
retryDelay: 60000, // 1 minute for dev
|
||||
queue: 'default',
|
||||
|
||||
// Example: Collection overrides for customization
|
||||
// Uncomment and modify as needed for your use case
|
||||
/*
|
||||
collections: {
|
||||
templates: {
|
||||
// Custom access controls - restrict who can manage templates
|
||||
access: {
|
||||
read: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin' || user.permissions?.includes('mailing:read')
|
||||
},
|
||||
create: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin' || user.permissions?.includes('mailing:create')
|
||||
},
|
||||
update: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin' || user.permissions?.includes('mailing:update')
|
||||
},
|
||||
delete: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin'
|
||||
},
|
||||
},
|
||||
// Custom admin UI settings
|
||||
admin: {
|
||||
group: 'Marketing',
|
||||
description: 'Email templates with enhanced security and categorization'
|
||||
},
|
||||
// Add custom fields to templates
|
||||
fields: [
|
||||
// Default plugin fields are automatically included
|
||||
{
|
||||
name: 'category',
|
||||
type: 'select',
|
||||
options: [
|
||||
{ label: 'Marketing', value: 'marketing' },
|
||||
{ label: 'Transactional', value: 'transactional' },
|
||||
{ label: 'System Notifications', value: 'system' }
|
||||
],
|
||||
defaultValue: 'transactional',
|
||||
admin: {
|
||||
position: 'sidebar',
|
||||
description: 'Template category for organization'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'tags',
|
||||
type: 'text',
|
||||
hasMany: true,
|
||||
admin: {
|
||||
position: 'sidebar',
|
||||
description: 'Tags for easy template filtering'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'isActive',
|
||||
type: 'checkbox',
|
||||
defaultValue: true,
|
||||
admin: {
|
||||
position: 'sidebar',
|
||||
description: 'Only active templates can be used'
|
||||
}
|
||||
}
|
||||
],
|
||||
// Custom validation hooks
|
||||
hooks: {
|
||||
beforeChange: [
|
||||
({ data, req }) => {
|
||||
// Example: Only admins can create system templates
|
||||
if (data.category === 'system' && req.user?.role !== 'admin') {
|
||||
throw new Error('Only administrators can create system notification templates')
|
||||
}
|
||||
|
||||
// Example: Auto-generate slug if not provided
|
||||
if (!data.slug && data.name) {
|
||||
data.slug = data.name.toLowerCase()
|
||||
.replace(/[^a-z0-9]/g, '-')
|
||||
.replace(/-+/g, '-')
|
||||
.replace(/^-|-$/g, '')
|
||||
}
|
||||
|
||||
return data
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
emails: {
|
||||
// Restrict access to emails collection
|
||||
access: {
|
||||
read: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin' || user.permissions?.includes('mailing:read')
|
||||
},
|
||||
create: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin' || user.permissions?.includes('mailing:create')
|
||||
},
|
||||
update: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin' || user.permissions?.includes('mailing:update')
|
||||
},
|
||||
delete: ({ req: { user } }) => {
|
||||
if (!user) return false
|
||||
return user.role === 'admin'
|
||||
},
|
||||
},
|
||||
// Custom admin configuration for emails
|
||||
admin: {
|
||||
group: 'Marketing',
|
||||
description: 'Email delivery tracking and management',
|
||||
defaultColumns: ['subject', 'to', 'status', 'priority', 'scheduledAt'],
|
||||
}
|
||||
}
|
||||
},
|
||||
*/
|
||||
|
||||
// Optional: Custom rich text editor configuration
|
||||
// Comment out to use default lexical editor
|
||||
richTextEditor: lexicalEditor({
|
||||
@@ -256,12 +139,6 @@ export default buildConfig({
|
||||
// etc.
|
||||
],
|
||||
}),
|
||||
|
||||
|
||||
// Called after mailing plugin is fully initialized
|
||||
onReady: async (payload) => {
|
||||
await seedUser(payload)
|
||||
},
|
||||
}),
|
||||
],
|
||||
secret: process.env.PAYLOAD_SECRET || 'test-secret_key',
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@xtr-dev/payload-mailing",
|
||||
"version": "0.4.13",
|
||||
"version": "0.4.21",
|
||||
"description": "Template-based email system with scheduling and job processing for PayloadCMS",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import type { CollectionConfig } from 'payload'
|
||||
import { findExistingJobs, ensureEmailJob, updateEmailJobRelationship } from '../utils/jobScheduler.js'
|
||||
import { createContextLogger } from '../utils/logger.js'
|
||||
import { resolveID } from '../utils/helpers.js'
|
||||
|
||||
const Emails: CollectionConfig = {
|
||||
slug: 'emails',
|
||||
@@ -10,6 +11,26 @@ const Emails: CollectionConfig = {
|
||||
group: 'Mailing',
|
||||
description: 'Email delivery and status tracking',
|
||||
},
|
||||
defaultPopulate: {
|
||||
templateSlug: true,
|
||||
to: true,
|
||||
cc: true,
|
||||
bcc: true,
|
||||
from: true,
|
||||
replyTo: true,
|
||||
jobs: true,
|
||||
status: true,
|
||||
attempts: true,
|
||||
lastAttemptAt: true,
|
||||
error: true,
|
||||
priority: true,
|
||||
scheduledAt: true,
|
||||
sentAt: true,
|
||||
variables: true,
|
||||
html: true,
|
||||
text: true,
|
||||
createdAt: true,
|
||||
},
|
||||
fields: [
|
||||
{
|
||||
name: 'template',
|
||||
@@ -19,6 +40,14 @@ const Emails: CollectionConfig = {
|
||||
description: 'Email template used (optional if custom content provided)',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'templateSlug',
|
||||
type: 'text',
|
||||
admin: {
|
||||
description: 'Slug of the email template (auto-populated from template relationship)',
|
||||
readOnly: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'to',
|
||||
type: 'text',
|
||||
@@ -177,15 +206,37 @@ const Emails: CollectionConfig = {
|
||||
readOnly: true,
|
||||
},
|
||||
filterOptions: ({ id }) => {
|
||||
const emailId = resolveID(id)
|
||||
return {
|
||||
'input.emailId': {
|
||||
equals: id,
|
||||
equals: emailId ? String(emailId) : '',
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
],
|
||||
hooks: {
|
||||
beforeChange: [
|
||||
async ({ data, req }) => {
|
||||
// Auto-populate templateSlug from template relationship
|
||||
if (data.template) {
|
||||
try {
|
||||
const template = await req.payload.findByID({
|
||||
collection: 'email-templates',
|
||||
id: typeof data.template === 'string' ? data.template : data.template.id,
|
||||
})
|
||||
data.templateSlug = template.slug
|
||||
} catch (error) {
|
||||
// If template lookup fails, clear the slug
|
||||
data.templateSlug = undefined
|
||||
}
|
||||
} else {
|
||||
// Clear templateSlug if template is removed
|
||||
data.templateSlug = undefined
|
||||
}
|
||||
return data
|
||||
}
|
||||
],
|
||||
// Simple approach: Only use afterChange hook for job management
|
||||
// This avoids complex interaction between hooks and ensures document ID is always available
|
||||
afterChange: [
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
import { Payload } from 'payload'
|
||||
import { getMailing, renderTemplate, parseAndValidateEmails, sanitizeFromName } from './utils/helpers.js'
|
||||
import { getMailing, renderTemplateWithId, parseAndValidateEmails, sanitizeFromName } from './utils/helpers.js'
|
||||
import { BaseEmailDocument } from './types/index.js'
|
||||
import { processJobById } from './utils/emailProcessor.js'
|
||||
import { createContextLogger } from './utils/logger.js'
|
||||
import { pollForJobId } from './utils/jobPolling.js'
|
||||
|
||||
// Options for sending emails
|
||||
export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
|
||||
@@ -48,17 +49,17 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
||||
|
||||
let emailData: Partial<TEmail> = { ...options.data } as Partial<TEmail>
|
||||
|
||||
// If using a template, render it first
|
||||
if (options.template) {
|
||||
const { html, text, subject } = await renderTemplate(
|
||||
// Look up and render the template in a single operation to avoid duplicate lookups
|
||||
const { html, text, subject, templateId } = await renderTemplateWithId(
|
||||
payload,
|
||||
options.template.slug,
|
||||
options.template.variables || {}
|
||||
)
|
||||
|
||||
// Template values take precedence over data values
|
||||
emailData = {
|
||||
...emailData,
|
||||
template: templateId,
|
||||
subject,
|
||||
html,
|
||||
text,
|
||||
@@ -70,20 +71,16 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
||||
throw new Error('Field "to" is required for sending emails')
|
||||
}
|
||||
|
||||
// Validate required fields based on whether template was used
|
||||
if (options.template) {
|
||||
// When using template, subject and html should have been set by renderTemplate
|
||||
if (!emailData.subject || !emailData.html) {
|
||||
throw new Error(`Template rendering failed: template "${options.template.slug}" did not provide required subject and html content`)
|
||||
}
|
||||
} else {
|
||||
// When not using template, user must provide subject and html directly
|
||||
if (!emailData.subject || !emailData.html) {
|
||||
throw new Error('Fields "subject" and "html" are required when sending direct emails without a template')
|
||||
}
|
||||
}
|
||||
|
||||
// Process email addresses using shared validation (handle null values)
|
||||
if (emailData.to) {
|
||||
emailData.to = parseAndValidateEmails(emailData.to as string | string[])
|
||||
}
|
||||
@@ -95,19 +92,15 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
||||
}
|
||||
if (emailData.replyTo) {
|
||||
const validated = parseAndValidateEmails(emailData.replyTo as string | string[])
|
||||
// replyTo should be a single email, so take the first one if array
|
||||
emailData.replyTo = validated && validated.length > 0 ? validated[0] : undefined
|
||||
}
|
||||
if (emailData.from) {
|
||||
const validated = parseAndValidateEmails(emailData.from as string | string[])
|
||||
// from should be a single email, so take the first one if array
|
||||
emailData.from = validated && validated.length > 0 ? validated[0] : undefined
|
||||
}
|
||||
|
||||
// Sanitize fromName to prevent header injection
|
||||
emailData.fromName = sanitizeFromName(emailData.fromName as string)
|
||||
|
||||
// Normalize Date objects to ISO strings for consistent database storage
|
||||
if (emailData.scheduledAt instanceof Date) {
|
||||
emailData.scheduledAt = emailData.scheduledAt.toISOString()
|
||||
}
|
||||
@@ -124,19 +117,15 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
||||
emailData.updatedAt = emailData.updatedAt.toISOString()
|
||||
}
|
||||
|
||||
// Create the email in the collection with proper typing
|
||||
// The hooks will automatically create and populate the job relationship
|
||||
const email = await payload.create({
|
||||
collection: collectionSlug,
|
||||
data: emailData
|
||||
})
|
||||
|
||||
// Validate that the created email has the expected structure
|
||||
if (!email || typeof email !== 'object' || !email.id) {
|
||||
throw new Error('Failed to create email: invalid response from database')
|
||||
}
|
||||
|
||||
// If processImmediately is true, get the job from the relationship and process it now
|
||||
if (options.processImmediately) {
|
||||
const logger = createContextLogger(payload, 'IMMEDIATE')
|
||||
|
||||
@@ -144,71 +133,14 @@ export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocu
|
||||
throw new Error('PayloadCMS jobs not configured - cannot process email immediately')
|
||||
}
|
||||
|
||||
// Poll for the job with optimized backoff and timeout protection
|
||||
// This handles the async nature of hooks and ensures we wait for job creation
|
||||
const maxAttempts = 5 // Reduced from 10 to minimize delay
|
||||
const initialDelay = 25 // Reduced from 50ms for faster response
|
||||
const maxTotalTime = 3000 // 3 second total timeout
|
||||
const startTime = Date.now()
|
||||
let jobId: string | undefined
|
||||
|
||||
|
||||
for (let attempt = 0; attempt < maxAttempts; attempt++) {
|
||||
// Check total timeout before continuing
|
||||
if (Date.now() - startTime > maxTotalTime) {
|
||||
throw new Error(
|
||||
`Job polling timed out after ${maxTotalTime}ms for email ${email.id}. ` +
|
||||
`The auto-scheduling may have failed or is taking longer than expected.`
|
||||
)
|
||||
}
|
||||
|
||||
// Calculate delay with exponential backoff (25ms, 50ms, 100ms, 200ms, 400ms)
|
||||
// Cap at 400ms per attempt for better responsiveness
|
||||
const delay = Math.min(initialDelay * Math.pow(2, attempt), 400)
|
||||
|
||||
if (attempt > 0) {
|
||||
await new Promise(resolve => setTimeout(resolve, delay))
|
||||
}
|
||||
|
||||
// Refetch the email to check for jobs
|
||||
const emailWithJobs = await payload.findByID({
|
||||
collection: collectionSlug,
|
||||
id: email.id,
|
||||
})
|
||||
|
||||
|
||||
if (emailWithJobs.jobs && emailWithJobs.jobs.length > 0) {
|
||||
// Job found! Get the first job ID (should only be one for a new email)
|
||||
const firstJob = Array.isArray(emailWithJobs.jobs) ? emailWithJobs.jobs[0] : emailWithJobs.jobs
|
||||
jobId = typeof firstJob === 'string' ? firstJob : String(firstJob.id || firstJob)
|
||||
break
|
||||
}
|
||||
|
||||
// Log on later attempts to help with debugging (reduced threshold)
|
||||
if (attempt >= 1) {
|
||||
if (attempt >= 2) {
|
||||
logger.debug(`Waiting for job creation for email ${email.id}, attempt ${attempt + 1}/${maxAttempts}`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!jobId) {
|
||||
// Distinguish between different failure scenarios for better error handling
|
||||
const timeoutMsg = Date.now() - startTime >= maxTotalTime
|
||||
const errorType = timeoutMsg ? 'POLLING_TIMEOUT' : 'JOB_NOT_FOUND'
|
||||
|
||||
const baseMessage = timeoutMsg
|
||||
? `Job polling timed out after ${maxTotalTime}ms for email ${email.id}`
|
||||
: `No processing job found for email ${email.id} after ${maxAttempts} attempts (${Date.now() - startTime}ms)`
|
||||
|
||||
throw new Error(
|
||||
`${errorType}: ${baseMessage}. ` +
|
||||
`This indicates the email was created but job auto-scheduling failed. ` +
|
||||
`The email exists in the database but immediate processing cannot proceed. ` +
|
||||
`You may need to: 1) Check job queue configuration, 2) Verify database hooks are working, ` +
|
||||
`3) Process the email later using processEmailById('${email.id}').`
|
||||
)
|
||||
}
|
||||
// Poll for the job ID using configurable polling mechanism
|
||||
const { jobId } = await pollForJobId({
|
||||
payload,
|
||||
collectionSlug,
|
||||
emailId: email.id,
|
||||
config: mailingConfig.jobPolling,
|
||||
logger,
|
||||
})
|
||||
|
||||
try {
|
||||
await processJobById(payload, jobId)
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import { Payload } from 'payload'
|
||||
import {CollectionSlug, EmailAdapter, Payload, SendEmailOptions} from 'payload'
|
||||
import { Liquid } from 'liquidjs'
|
||||
import {
|
||||
MailingPluginConfig,
|
||||
TemplateVariables,
|
||||
MailingService as IMailingService,
|
||||
BaseEmail, BaseEmailTemplate, BaseEmailDocument, BaseEmailTemplateDocument
|
||||
BaseEmailDocument, BaseEmailTemplateDocument
|
||||
} from '../types/index.js'
|
||||
import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
|
||||
import { sanitizeDisplayName } from '../utils/helpers.js'
|
||||
@@ -12,7 +12,6 @@ import { sanitizeDisplayName } from '../utils/helpers.js'
|
||||
export class MailingService implements IMailingService {
|
||||
public payload: Payload
|
||||
private config: MailingPluginConfig
|
||||
private emailAdapter: any
|
||||
private templatesCollection: string
|
||||
private emailsCollection: string
|
||||
private liquid: Liquid | null | false = null
|
||||
@@ -31,14 +30,13 @@ export class MailingService implements IMailingService {
|
||||
if (!this.payload.email) {
|
||||
throw new Error('Payload email configuration is required. Please configure email in your Payload config.')
|
||||
}
|
||||
this.emailAdapter = this.payload.email
|
||||
}
|
||||
|
||||
private ensureInitialized(): void {
|
||||
if (!this.payload || !this.payload.db) {
|
||||
throw new Error('MailingService payload not properly initialized')
|
||||
}
|
||||
if (!this.emailAdapter) {
|
||||
if (!this.payload.email) {
|
||||
throw new Error('Email adapter not configured. Please ensure Payload has email configured.')
|
||||
}
|
||||
}
|
||||
@@ -127,6 +125,17 @@ export class MailingService implements IMailingService {
|
||||
throw new Error(`Email template not found: ${templateSlug}`)
|
||||
}
|
||||
|
||||
return this.renderTemplateDocument(template, variables)
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a template document (for when you already have the template loaded)
|
||||
* This avoids duplicate template lookups
|
||||
* @internal
|
||||
*/
|
||||
async renderTemplateDocument(template: BaseEmailTemplateDocument, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }> {
|
||||
this.ensureInitialized()
|
||||
|
||||
const emailContent = await this.renderEmailTemplate(template, variables)
|
||||
const subject = await this.renderTemplateString(template.subject || '', variables)
|
||||
|
||||
@@ -142,7 +151,7 @@ export class MailingService implements IMailingService {
|
||||
const currentTime = new Date().toISOString()
|
||||
|
||||
const { docs: pendingEmails } = await this.payload.find({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
where: {
|
||||
and: [
|
||||
{
|
||||
@@ -182,7 +191,7 @@ export class MailingService implements IMailingService {
|
||||
const retryTime = new Date(Date.now() - retryDelay).toISOString()
|
||||
|
||||
const { docs: failedEmails } = await this.payload.find({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
where: {
|
||||
and: [
|
||||
{
|
||||
@@ -222,7 +231,7 @@ export class MailingService implements IMailingService {
|
||||
async processEmailItem(emailId: string): Promise<void> {
|
||||
try {
|
||||
await this.payload.update({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
id: emailId,
|
||||
data: {
|
||||
status: 'processing',
|
||||
@@ -231,8 +240,9 @@ export class MailingService implements IMailingService {
|
||||
})
|
||||
|
||||
const email = await this.payload.findByID({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
id: emailId,
|
||||
depth: 1,
|
||||
}) as BaseEmailDocument
|
||||
|
||||
// Combine from and fromName for nodemailer using proper sanitization
|
||||
@@ -243,7 +253,7 @@ export class MailingService implements IMailingService {
|
||||
fromField = this.getDefaultFrom()
|
||||
}
|
||||
|
||||
let mailOptions: any = {
|
||||
let mailOptions: SendEmailOptions = {
|
||||
from: fromField,
|
||||
to: email.to,
|
||||
cc: email.cc || undefined,
|
||||
@@ -254,6 +264,19 @@ export class MailingService implements IMailingService {
|
||||
text: email.text || undefined,
|
||||
}
|
||||
|
||||
if (!mailOptions.from) {
|
||||
throw new Error('Email from field is required')
|
||||
}
|
||||
if (!mailOptions.to || (Array.isArray(mailOptions.to) && mailOptions.to.length === 0)) {
|
||||
throw new Error('Email to field is required')
|
||||
}
|
||||
if (!mailOptions.subject) {
|
||||
throw new Error('Email subject is required')
|
||||
}
|
||||
if (!mailOptions.html && !mailOptions.text) {
|
||||
throw new Error('Email content is required')
|
||||
}
|
||||
|
||||
// Call beforeSend hook if configured
|
||||
if (this.config.beforeSend) {
|
||||
try {
|
||||
@@ -279,10 +302,10 @@ export class MailingService implements IMailingService {
|
||||
}
|
||||
|
||||
// Send email using Payload's email adapter
|
||||
await this.emailAdapter.sendEmail(mailOptions)
|
||||
await this.payload.email.sendEmail(mailOptions)
|
||||
|
||||
await this.payload.update({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
id: emailId,
|
||||
data: {
|
||||
status: 'sent',
|
||||
@@ -296,7 +319,7 @@ export class MailingService implements IMailingService {
|
||||
const maxAttempts = this.config.retryAttempts || 3
|
||||
|
||||
await this.payload.update({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
id: emailId,
|
||||
data: {
|
||||
status: attempts >= maxAttempts ? 'failed' : 'pending',
|
||||
@@ -313,14 +336,14 @@ export class MailingService implements IMailingService {
|
||||
|
||||
private async incrementAttempts(emailId: string): Promise<number> {
|
||||
const email = await this.payload.findByID({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
id: emailId,
|
||||
})
|
||||
|
||||
const newAttempts = ((email as any).attempts || 0) + 1
|
||||
|
||||
await this.payload.update({
|
||||
collection: this.emailsCollection as any,
|
||||
collection: this.emailsCollection as CollectionSlug,
|
||||
id: emailId,
|
||||
data: {
|
||||
attempts: newAttempts,
|
||||
|
||||
@@ -1,6 +1,12 @@
|
||||
import { Payload } from 'payload'
|
||||
import {Payload, SendEmailOptions} from 'payload'
|
||||
import type { CollectionConfig, RichTextField } from 'payload'
|
||||
|
||||
// Payload ID type (string or number)
|
||||
export type PayloadID = string | number
|
||||
|
||||
// Payload relation type - can be populated (object with id) or unpopulated (just the ID)
|
||||
export type PayloadRelation<T extends { id: PayloadID }> = T | PayloadID
|
||||
|
||||
// JSON value type that matches Payload's JSON field type
|
||||
export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
|
||||
|
||||
@@ -8,6 +14,7 @@ export type JSONValue = string | number | boolean | { [k: string]: unknown } | u
|
||||
export interface BaseEmailDocument {
|
||||
id: string | number
|
||||
template?: any
|
||||
templateSlug?: string | null
|
||||
to: string[]
|
||||
cc?: string[] | null
|
||||
bcc?: string[] | null
|
||||
@@ -39,28 +46,18 @@ export interface BaseEmailTemplateDocument {
|
||||
updatedAt?: string | Date | null
|
||||
}
|
||||
|
||||
export type BaseEmail<TEmail extends BaseEmailDocument = BaseEmailDocument, TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'> | TEmailTemplate['id'] | undefined | null}
|
||||
|
||||
export type BaseEmailTemplate<TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmailTemplate, 'id'>
|
||||
|
||||
export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>
|
||||
|
||||
export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
|
||||
|
||||
export interface BeforeSendMailOptions {
|
||||
from: string
|
||||
to: string[]
|
||||
cc?: string[]
|
||||
bcc?: string[]
|
||||
replyTo?: string
|
||||
subject: string
|
||||
html: string
|
||||
text?: string
|
||||
attachments?: any[]
|
||||
[key: string]: any
|
||||
}
|
||||
export type BeforeSendHook = (options: SendEmailOptions, email: BaseEmailDocument) => SendEmailOptions | Promise<SendEmailOptions>
|
||||
|
||||
export type BeforeSendHook = (options: BeforeSendMailOptions, email: BaseEmailDocument) => BeforeSendMailOptions | Promise<BeforeSendMailOptions>
|
||||
export interface JobPollingConfig {
|
||||
maxAttempts?: number // Maximum number of polling attempts (default: 5)
|
||||
initialDelay?: number // Initial delay in milliseconds (default: 25)
|
||||
maxTotalTime?: number // Maximum total polling time in milliseconds (default: 3000)
|
||||
maxBackoffDelay?: number // Maximum delay between attempts in milliseconds (default: 400)
|
||||
}
|
||||
|
||||
export interface MailingPluginConfig {
|
||||
collections?: {
|
||||
@@ -77,6 +74,7 @@ export interface MailingPluginConfig {
|
||||
richTextEditor?: RichTextField['editor']
|
||||
beforeSend?: BeforeSendHook
|
||||
initOrder?: 'before' | 'after'
|
||||
jobPolling?: JobPollingConfig
|
||||
}
|
||||
|
||||
export interface QueuedEmail {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { Payload } from 'payload'
|
||||
import { TemplateVariables } from '../types/index.js'
|
||||
import { TemplateVariables, PayloadID, PayloadRelation } from '../types/index.js'
|
||||
|
||||
/**
|
||||
* Parse and validate email addresses
|
||||
@@ -74,6 +74,49 @@ export const sanitizeFromName = (fromName: string | null | undefined): string |
|
||||
return sanitized.length > 0 ? sanitized : undefined
|
||||
}
|
||||
|
||||
/**
|
||||
* Type guard to check if a Payload relation is populated (object) or unpopulated (ID)
|
||||
*/
|
||||
export const isPopulated = <T extends { id: PayloadID }>(
|
||||
value: PayloadRelation<T> | null | undefined
|
||||
): value is T => {
|
||||
return value !== null && value !== undefined && typeof value === 'object' && 'id' in value
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves a Payload relation to just the ID
|
||||
* Handles both populated (object with id) and unpopulated (string/number) values
|
||||
*/
|
||||
export const resolveID = <T extends { id: PayloadID }>(
|
||||
value: PayloadRelation<T> | null | undefined
|
||||
): PayloadID | undefined => {
|
||||
if (value === null || value === undefined) return undefined
|
||||
|
||||
if (typeof value === 'string' || typeof value === 'number') {
|
||||
return value
|
||||
}
|
||||
|
||||
if (typeof value === 'object' && 'id' in value) {
|
||||
return value.id
|
||||
}
|
||||
|
||||
return undefined
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves an array of Payload relations to an array of IDs
|
||||
* Handles mixed arrays of populated and unpopulated values
|
||||
*/
|
||||
export const resolveIDs = <T extends { id: PayloadID }>(
|
||||
values: (PayloadRelation<T> | null | undefined)[] | null | undefined
|
||||
): PayloadID[] => {
|
||||
if (!values || !Array.isArray(values)) return []
|
||||
|
||||
return values
|
||||
.map(value => resolveID(value))
|
||||
.filter((id): id is PayloadID => id !== undefined)
|
||||
}
|
||||
|
||||
export const getMailing = (payload: Payload) => {
|
||||
const mailing = (payload as any).mailing
|
||||
if (!mailing) {
|
||||
@@ -87,6 +130,53 @@ export const renderTemplate = async (payload: Payload, templateSlug: string, var
|
||||
return mailing.service.renderTemplate(templateSlug, variables)
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a template and return both rendered content and template ID
|
||||
* This is used by sendEmail to avoid duplicate template lookups
|
||||
* @internal
|
||||
*/
|
||||
export const renderTemplateWithId = async (
|
||||
payload: Payload,
|
||||
templateSlug: string,
|
||||
variables: TemplateVariables
|
||||
): Promise<{ html: string; text: string; subject: string; templateId: PayloadID }> => {
|
||||
const mailing = getMailing(payload)
|
||||
const templatesCollection = mailing.config.collections?.templates || 'email-templates'
|
||||
|
||||
// Runtime validation: Ensure the collection exists in Payload
|
||||
if (!payload.collections[templatesCollection]) {
|
||||
throw new Error(
|
||||
`Templates collection '${templatesCollection}' not found. ` +
|
||||
`Available collections: ${Object.keys(payload.collections).join(', ')}`
|
||||
)
|
||||
}
|
||||
|
||||
// Look up the template document once
|
||||
const { docs: templateDocs } = await payload.find({
|
||||
collection: templatesCollection as any,
|
||||
where: {
|
||||
slug: {
|
||||
equals: templateSlug,
|
||||
},
|
||||
},
|
||||
limit: 1,
|
||||
})
|
||||
|
||||
if (!templateDocs || templateDocs.length === 0) {
|
||||
throw new Error(`Template not found: ${templateSlug}`)
|
||||
}
|
||||
|
||||
const templateDoc = templateDocs[0]
|
||||
|
||||
// Render using the document directly to avoid duplicate lookup
|
||||
const rendered = await mailing.service.renderTemplateDocument(templateDoc, variables)
|
||||
|
||||
return {
|
||||
...rendered,
|
||||
templateId: templateDoc.id,
|
||||
}
|
||||
}
|
||||
|
||||
export const processEmails = async (payload: Payload): Promise<void> => {
|
||||
const mailing = getMailing(payload)
|
||||
return mailing.service.processEmails()
|
||||
|
||||
115
src/utils/jobPolling.ts
Normal file
115
src/utils/jobPolling.ts
Normal file
@@ -0,0 +1,115 @@
|
||||
import { Payload } from 'payload'
|
||||
import { JobPollingConfig } from '../types/index.js'
|
||||
|
||||
export interface PollForJobIdOptions {
|
||||
payload: Payload
|
||||
collectionSlug: string
|
||||
emailId: string | number
|
||||
config?: JobPollingConfig
|
||||
logger?: {
|
||||
debug: (message: string, ...args: any[]) => void
|
||||
info: (message: string, ...args: any[]) => void
|
||||
warn: (message: string, ...args: any[]) => void
|
||||
error: (message: string, ...args: any[]) => void
|
||||
}
|
||||
}
|
||||
|
||||
export interface PollForJobIdResult {
|
||||
jobId: string
|
||||
attempts: number
|
||||
elapsedTime: number
|
||||
}
|
||||
|
||||
// Default job polling configuration values
|
||||
const DEFAULT_JOB_POLLING_CONFIG: Required<JobPollingConfig> = {
|
||||
maxAttempts: 5,
|
||||
initialDelay: 25,
|
||||
maxTotalTime: 3000,
|
||||
maxBackoffDelay: 400,
|
||||
}
|
||||
|
||||
/**
|
||||
* Polls for a job ID associated with an email document using exponential backoff.
|
||||
* This utility handles the complexity of waiting for auto-scheduled jobs to be created.
|
||||
*
|
||||
* The polling mechanism uses exponential backoff with configurable parameters:
|
||||
* - Starts with an initial delay and doubles on each retry
|
||||
* - Caps individual delays at maxBackoffDelay
|
||||
* - Enforces a maximum total polling time
|
||||
*
|
||||
* @param options - Polling options including payload, collection, email ID, and config
|
||||
* @returns Promise resolving to job ID and timing information
|
||||
* @throws Error if job is not found within the configured limits
|
||||
*/
|
||||
export const pollForJobId = async (options: PollForJobIdOptions): Promise<PollForJobIdResult> => {
|
||||
const { payload, collectionSlug, emailId, logger } = options
|
||||
|
||||
// Merge user config with defaults
|
||||
const config: Required<JobPollingConfig> = {
|
||||
...DEFAULT_JOB_POLLING_CONFIG,
|
||||
...options.config,
|
||||
}
|
||||
|
||||
const { maxAttempts, initialDelay, maxTotalTime, maxBackoffDelay } = config
|
||||
const startTime = Date.now()
|
||||
let jobId: string | undefined
|
||||
|
||||
for (let attempt = 0; attempt < maxAttempts; attempt++) {
|
||||
const elapsedTime = Date.now() - startTime
|
||||
|
||||
// Check if we've exceeded the maximum total polling time
|
||||
if (elapsedTime > maxTotalTime) {
|
||||
throw new Error(
|
||||
`Job polling timed out after ${maxTotalTime}ms for email ${emailId}. ` +
|
||||
`The auto-scheduling may have failed or is taking longer than expected.`
|
||||
)
|
||||
}
|
||||
|
||||
// Calculate exponential backoff delay, capped at maxBackoffDelay
|
||||
const delay = Math.min(initialDelay * Math.pow(2, attempt), maxBackoffDelay)
|
||||
|
||||
// Wait before checking (skip on first attempt)
|
||||
if (attempt > 0) {
|
||||
await new Promise(resolve => setTimeout(resolve, delay))
|
||||
}
|
||||
|
||||
// Fetch the email document to check for associated jobs
|
||||
const emailWithJobs = await payload.findByID({
|
||||
collection: collectionSlug,
|
||||
id: emailId,
|
||||
})
|
||||
|
||||
// Check if jobs array exists and has entries
|
||||
if (emailWithJobs.jobs && emailWithJobs.jobs.length > 0) {
|
||||
const firstJob = Array.isArray(emailWithJobs.jobs) ? emailWithJobs.jobs[0] : emailWithJobs.jobs
|
||||
jobId = typeof firstJob === 'string' ? firstJob : String(firstJob.id || firstJob)
|
||||
|
||||
return {
|
||||
jobId,
|
||||
attempts: attempt + 1,
|
||||
elapsedTime: Date.now() - startTime,
|
||||
}
|
||||
}
|
||||
|
||||
// Log progress for attempts after the second try
|
||||
if (attempt >= 2 && logger) {
|
||||
logger.debug(`Waiting for job creation for email ${emailId}, attempt ${attempt + 1}/${maxAttempts}`)
|
||||
}
|
||||
}
|
||||
|
||||
// If we reach here, job was not found
|
||||
const elapsedTime = Date.now() - startTime
|
||||
const timeoutMsg = elapsedTime >= maxTotalTime
|
||||
const errorType = timeoutMsg ? 'POLLING_TIMEOUT' : 'JOB_NOT_FOUND'
|
||||
const baseMessage = timeoutMsg
|
||||
? `Job polling timed out after ${maxTotalTime}ms for email ${emailId}`
|
||||
: `No processing job found for email ${emailId} after ${maxAttempts} attempts (${elapsedTime}ms)`
|
||||
|
||||
throw new Error(
|
||||
`${errorType}: ${baseMessage}. ` +
|
||||
`This indicates the email was created but job auto-scheduling failed. ` +
|
||||
`The email exists in the database but immediate processing cannot proceed. ` +
|
||||
`You may need to: 1) Check job queue configuration, 2) Verify database hooks are working, ` +
|
||||
`3) Process the email later using processEmailById('${emailId}').`
|
||||
)
|
||||
}
|
||||
@@ -129,7 +129,11 @@ export async function updateEmailJobRelationship(
|
||||
id: normalizedEmailId,
|
||||
})
|
||||
|
||||
const currentJobs = (currentEmail.jobs || []).map((job: any) => String(job))
|
||||
// Extract IDs from job objects or use the value directly if it's already an ID
|
||||
// Jobs can be populated (objects with id field) or just IDs (strings/numbers)
|
||||
const currentJobs = (currentEmail.jobs || []).map((job: any) =>
|
||||
typeof job === 'object' && job !== null && job.id ? String(job.id) : String(job)
|
||||
)
|
||||
const allJobs = [...new Set([...currentJobs, ...normalizedJobIds])] // Deduplicate with normalized strings
|
||||
|
||||
await payload.update({
|
||||
|
||||
Reference in New Issue
Block a user