Skip to content

feat: add gradual campaign delivery #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pankaj3112 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: add gradual campaign delivery #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
754f07d
feat: add gradual delivery data model
Pankaj3112 Jul 21, 2026
861fd46
feat: process campaigns in delivery waves
Pankaj3112 Jul 21, 2026
8a2dacb
feat: expose gradual campaign delivery
Pankaj3112 Jul 21, 2026
5ee95c7
feat: add gradual delivery campaign controls
Pankaj3112 Jul 21, 2026
5dc089a
fix: harden gradual campaign scheduling and delivery
Pankaj3112 Jul 21, 2026
db0a28b
fix: address gradual delivery review feedback
Pankaj3112 Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 156 additions & 0 deletions apps/docs/api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2085,6 +2085,39 @@
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"delivery": {
"oneOf": [
{
"type": "object",
"properties": {
"strategy": {
"type": "string",
"enum": ["all_at_once"]
}
},
"required": ["strategy"]
},
{
"type": "object",
"properties": {
"strategy": {
"type": "string",
"enum": ["gradual"]
},
"batchPercentage": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"interval": {
"type": "string",
"enum": ["minute", "hour"]
}
},
"required": ["strategy", "batchPercentage", "interval"]
}
]
}
},
"required": ["name", "from", "subject", "contactBookId"]
Expand Down Expand Up @@ -2116,6 +2149,29 @@
},
"batchSize": { "type": "integer" },
"batchWindowMinutes": { "type": "integer" },
"deliveryMode": {
"type": "string",
"enum": ["ALL_AT_ONCE", "GRADUAL"]
},
"deliveryBatchPercentage": {
"type": "integer",
"nullable": true
},
"deliveryIntervalMinutes": {
"type": "integer",
"nullable": true
},
"deliveryBatchSize": {
"type": "integer",
"nullable": true
},
"currentDeliveryBatch": { "type": "integer" },
"deliveryBatchProcessed": { "type": "integer" },
"nextDeliveryAt": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"total": { "type": "integer" },
"sent": { "type": "integer" },
"delivered": { "type": "integer" },
Expand Down Expand Up @@ -2147,6 +2203,13 @@
"scheduledAt",
"batchSize",
"batchWindowMinutes",
"deliveryMode",
"deliveryBatchPercentage",
"deliveryIntervalMinutes",
"deliveryBatchSize",
"currentDeliveryBatch",
"deliveryBatchProcessed",
"nextDeliveryAt",
"total",
"sent",
"delivered",
Expand Down Expand Up @@ -2302,6 +2365,29 @@
},
"batchSize": { "type": "integer" },
"batchWindowMinutes": { "type": "integer" },
"deliveryMode": {
"type": "string",
"enum": ["ALL_AT_ONCE", "GRADUAL"]
},
"deliveryBatchPercentage": {
"type": "integer",
"nullable": true
},
"deliveryIntervalMinutes": {
"type": "integer",
"nullable": true
},
"deliveryBatchSize": {
"type": "integer",
"nullable": true
},
"currentDeliveryBatch": { "type": "integer" },
"deliveryBatchProcessed": { "type": "integer" },
"nextDeliveryAt": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"total": { "type": "integer" },
"sent": { "type": "integer" },
"delivered": { "type": "integer" },
Expand Down Expand Up @@ -2333,6 +2419,13 @@
"scheduledAt",
"batchSize",
"batchWindowMinutes",
"deliveryMode",
"deliveryBatchPercentage",
"deliveryIntervalMinutes",
"deliveryBatchSize",
"currentDeliveryBatch",
"deliveryBatchProcessed",
"nextDeliveryAt",
"total",
"sent",
"delivered",
Expand Down Expand Up @@ -2391,6 +2484,29 @@
},
"batchSize": { "type": "integer" },
"batchWindowMinutes": { "type": "integer" },
"deliveryMode": {
"type": "string",
"enum": ["ALL_AT_ONCE", "GRADUAL"]
},
"deliveryBatchPercentage": {
"type": "integer",
"nullable": true
},
"deliveryIntervalMinutes": {
"type": "integer",
"nullable": true
},
"deliveryBatchSize": {
"type": "integer",
"nullable": true
},
"currentDeliveryBatch": { "type": "integer" },
"deliveryBatchProcessed": { "type": "integer" },
"nextDeliveryAt": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"total": { "type": "integer" },
"sent": { "type": "integer" },
"delivered": { "type": "integer" },
Expand Down Expand Up @@ -2422,6 +2538,13 @@
"scheduledAt",
"batchSize",
"batchWindowMinutes",
"deliveryMode",
"deliveryBatchPercentage",
"deliveryIntervalMinutes",
"deliveryBatchSize",
"currentDeliveryBatch",
"deliveryBatchProcessed",
"nextDeliveryAt",
"total",
"sent",
"delivered",
Expand Down Expand Up @@ -2473,6 +2596,39 @@
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"delivery": {
"oneOf": [
{
"type": "object",
"properties": {
"strategy": {
"type": "string",
"enum": ["all_at_once"]
}
},
"required": ["strategy"]
},
{
"type": "object",
"properties": {
"strategy": {
"type": "string",
"enum": ["gradual"]
},
"batchPercentage": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"interval": {
"type": "string",
"enum": ["minute", "hour"]
}
},
"required": ["strategy", "batchPercentage", "interval"]
}
]
}
}
}
Expand Down
26 changes: 26 additions & 0 deletions apps/web/prisma/migrations/20260721120000_add_gradual_campaign_sending/migration.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
-- CreateEnum
CREATE TYPE "CampaignDeliveryMode" AS ENUM ('ALL_AT_ONCE', 'GRADUAL');

-- CreateEnum
CREATE TYPE "CampaignRecipientStatus" AS ENUM ('PENDING', 'PROCESSING', 'QUEUED', 'SUPPRESSED', 'SKIPPED', 'FAILED');

-- AlterTable
ALTER TABLE "CampaignEmail" ALTER COLUMN "emailId" DROP NOT NULL;
-- PostgreSQL 11+ stores a constant default as metadata instead of rewriting
-- every existing row. Existing recipients are already queued, while new rows
-- created by the gradual delivery worker should default to pending.
ALTER TABLE "CampaignEmail" ADD COLUMN "status" "CampaignRecipientStatus" NOT NULL DEFAULT 'QUEUED';
ALTER TABLE "CampaignEmail" ADD COLUMN "processedAt" TIMESTAMP(3);
ALTER TABLE "CampaignEmail" ALTER COLUMN "status" SET DEFAULT 'PENDING';

-- AlterTable
ALTER TABLE "Campaign" ADD COLUMN "deliveryMode" "CampaignDeliveryMode" NOT NULL DEFAULT 'ALL_AT_ONCE';
ALTER TABLE "Campaign" ADD COLUMN "deliveryBatchPercentage" INTEGER;
ALTER TABLE "Campaign" ADD COLUMN "deliveryIntervalMinutes" INTEGER;
ALTER TABLE "Campaign" ADD COLUMN "deliveryBatchSize" INTEGER;
ALTER TABLE "Campaign" ADD COLUMN "currentDeliveryBatch" INTEGER NOT NULL DEFAULT 0;
ALTER TABLE "Campaign" ADD COLUMN "deliveryBatchProcessed" INTEGER NOT NULL DEFAULT 0;
ALTER TABLE "Campaign" ADD COLUMN "nextDeliveryAt" TIMESTAMP(3);
ALTER TABLE "Campaign" ADD COLUMN "audienceCapturedAt" TIMESTAMP(3);
ALTER TABLE "Campaign" ADD COLUMN "audiencePreparedAt" TIMESTAMP(3);
ALTER TABLE "Campaign" ADD COLUMN "pausedAt" TIMESTAMP(3);
4 changes: 4 additions & 0 deletions .../prisma/migrations/20260721170000_add_campaign_email_recipient_status_index/migration.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
-- CreateIndex
-- Keep this as the migration's only SQL statement so PostgreSQL can build the
-- index without blocking inserts or updates.
CREATE INDEX CONCURRENTLY "CampaignEmail_campaignId_status_contactId_idx" ON "CampaignEmail"("campaignId", "status", "contactId");
4 changes: 4 additions & 0 deletions apps/web/prisma/migrations/20260721180000_add_campaign_next_delivery_index/migration.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
-- CreateIndex
-- Keep this as the migration's only SQL statement so PostgreSQL can build the
-- index without blocking inserts or updates.
CREATE INDEX CONCURRENTLY "Campaign_status_nextDeliveryAt_idx" ON "Campaign"("status", "nextDeliveryAt");
4 changes: 4 additions & 0 deletions apps/web/prisma/migrations/20260721190000_add_campaign_email_status_index/migration.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
-- CreateIndex
-- Keep this as the migration's only SQL statement so Prisma runs it outside a
-- transaction and PostgreSQL can build it without blocking inserts or updates.
CREATE INDEX CONCURRENTLY "Email_campaignId_latestStatus_idx" ON "Email"("campaignId", "latestStatus");
99 changes: 64 additions & 35 deletions apps/web/prisma/schema.prisma
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,16 +267,20 @@ model Email {
emailEvents EmailEvent[]

@@index([campaignId, contactId])
@@index([campaignId, latestStatus])
@@index([createdAt(sort: Desc)])
}

model CampaignEmail {
campaignId String
contactId String
emailId String
createdAt DateTime @default(now())
campaignId String
contactId String
emailId String?
status CampaignRecipientStatus @default(PENDING)
processedAt DateTime?
createdAt DateTime @default(now())

@@id([campaignId, contactId])
@@index([campaignId, status, contactId])
}

model EmailEvent {
Expand Down Expand Up @@ -349,43 +353,68 @@ enum CampaignStatus {
SENT
}

enum CampaignDeliveryMode {
ALL_AT_ONCE
GRADUAL
}

enum CampaignRecipientStatus {
PENDING
PROCESSING
QUEUED
SUPPRESSED
SKIPPED
FAILED
}

model Campaign {
id String @id @default(cuid())
name String
teamId Int
from String
cc String[]
bcc String[]
replyTo String[]
domainId Int
subject String
previewText String?
html String?
content String?
contactBookId String?
scheduledAt DateTime?
total Int @default(0)
sent Int @default(0)
delivered Int @default(0)
opened Int @default(0)
clicked Int @default(0)
unsubscribed Int @default(0)
bounced Int @default(0)
hardBounced Int @default(0)
complained Int @default(0)
isApi Boolean @default(false)
status CampaignStatus @default(DRAFT)
batchSize Int @default(500)
batchWindowMinutes Int @default(0)
lastCursor String?
lastSentAt DateTime?
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
id String @id @default(cuid())
name String
teamId Int
from String
cc String[]
bcc String[]
replyTo String[]
domainId Int
subject String
previewText String?
html String?
content String?
contactBookId String?
scheduledAt DateTime?
total Int @default(0)
sent Int @default(0)
delivered Int @default(0)
opened Int @default(0)
clicked Int @default(0)
unsubscribed Int @default(0)
bounced Int @default(0)
hardBounced Int @default(0)
complained Int @default(0)
isApi Boolean @default(false)
status CampaignStatus @default(DRAFT)
batchSize Int @default(500)
batchWindowMinutes Int @default(0)
lastCursor String?
lastSentAt DateTime?
deliveryMode CampaignDeliveryMode @default(ALL_AT_ONCE)
deliveryBatchPercentage Int?
deliveryIntervalMinutes Int?
deliveryBatchSize Int?
currentDeliveryBatch Int @default(0)
deliveryBatchProcessed Int @default(0)
nextDeliveryAt DateTime?
audienceCapturedAt DateTime?
audiencePreparedAt DateTime?
pausedAt DateTime?
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt

team Team @relation(fields: [teamId], references: [id], onDelete: Cascade)

@@index([createdAt(sort: Desc)])
@@index([status, scheduledAt])
@@index([status, nextDeliveryAt])
}

model Template {
Expand Down
Loading