feat: batch campaigns (#227)

Author: KMKoushik

AGENTS.md

@@ -19,6 +19,7 @@
 - `pnpm format`: Prettier over ts/tsx/md.
 - `pnpm dx` / `pnpm dx:up` / `pnpm dx:down`: Spin up/down local infra via Docker Compose, then run migrations.
 - Database (apps/web filter): `pnpm db:generate` | `db:migrate-dev` | `db:push` | `db:studio`.
+- Never run migrations unless users explicitly asked
 
 ## Coding Style & Naming Conventions
 

apps/web/package.json

@@ -14,7 +14,11 @@
     "db:migrate-dev": "prisma migrate dev",
     "db:migrate-deploy": "prisma migrate deploy",
     "db:studio": "prisma studio",
-    "db:migrate-reset": "prisma migrate reset"
+    "db:migrate-reset": "prisma migrate reset",
+    "memory:monitor": "node --expose-gc scripts/memory-monitor.js",
+    "memory:profile": "node --expose-gc scripts/memory-profiler.js",
+    "memory:test": "node --expose-gc -e \"const MemoryMonitor = require('./scripts/memory-monitor'); const monitor = new MemoryMonitor(); monitor.start(1000); setTimeout(() => monitor.stop(), 30000)\"",
+    "memory:baseline": "node --expose-gc scripts/baseline-test.js"
   },
   "dependencies": {
     "@auth/prisma-adapter": "^2.9.0",
@@ -100,4 +104,4 @@
     "initVersion": "7.30.0"
   },
   "packageManager": "pnpm@8.9.2"
-}
+}

apps/web/prisma/migrations/20251006185736_campaign_batching/migration.sql

@@ -0,0 +1,36 @@
+-- AlterEnum
+-- This migration adds more than one value to an enum.
+-- With PostgreSQL versions 11 and earlier, this is not possible
+-- in a single migration. This can be worked around by creating
+-- multiple migrations, each migration adding only one value to
+-- the enum.
+
+
+ALTER TYPE "CampaignStatus" ADD VALUE 'RUNNING';
+ALTER TYPE "CampaignStatus" ADD VALUE 'PAUSED';
+
+-- AlterTable
+ALTER TABLE "Campaign" ADD COLUMN     "batchSize" INTEGER NOT NULL DEFAULT 500,
+ADD COLUMN     "batchWindowMinutes" INTEGER NOT NULL DEFAULT 0,
+ADD COLUMN     "lastCursor" TEXT,
+ADD COLUMN     "lastSentAt" TIMESTAMP(3),
+ADD COLUMN     "scheduledAt" TIMESTAMP(3);
+
+-- CreateTable
+CREATE TABLE "CampaignEmail" (
+    "campaignId" TEXT NOT NULL,
+    "contactId" TEXT NOT NULL,
+    "emailId" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "CampaignEmail_pkey" PRIMARY KEY ("campaignId","contactId")
+);
+
+-- CreateIndex
+CREATE INDEX "Campaign_status_scheduledAt_idx" ON "Campaign"("status", "scheduledAt");
+
+-- CreateIndex
+CREATE INDEX "Contact_contactBookId_id_idx" ON "Contact"("contactBookId", "id");
+
+-- CreateIndex
+CREATE INDEX "Email_campaignId_contactId_idx" ON "Email"("campaignId", "contactId");

apps/web/prisma/schema.prisma

@@ -263,9 +263,19 @@ model Email {
   team         Team         @relation(fields: [teamId], references: [id], onDelete: Cascade)
   emailEvents  EmailEvent[]
 
+  @@index([campaignId, contactId])
   @@index([createdAt(sort: Desc)])
 }
 
+model CampaignEmail {
+  campaignId String
+  contactId  String
+  emailId    String
+  createdAt  DateTime @default(now())
+
+  @@id([campaignId, contactId])
+}
+
 model EmailEvent {
   id        String      @id @default(cuid())
   emailId   String
@@ -320,44 +330,53 @@ model Contact {
   contactBook ContactBook @relation(fields: [contactBookId], references: [id], onDelete: Cascade)
 
   @@unique([contactBookId, email])
+  @@index([contactBookId, id])
 }
 
 enum CampaignStatus {
   DRAFT
   SCHEDULED
+  RUNNING
+  PAUSED
   SENT
 }
 
 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?
-  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)
-  status        CampaignStatus @default(DRAFT)
-  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)
+  status             CampaignStatus @default(DRAFT)
+  batchSize          Int            @default(500)
+  batchWindowMinutes Int            @default(0)
+  lastCursor         String?
+  lastSentAt         DateTime?
+  createdAt          DateTime       @default(now())
+  updatedAt          DateTime       @updatedAt
 
   team Team @relation(fields: [teamId], references: [id], onDelete: Cascade)
 
   @@index([createdAt(sort: Desc)])
+  @@index([status, scheduledAt])
 }
 
 model Template {

apps/web/src/app/(dashboard)/campaigns/[campaignId]/edit/page.tsx

@@ -41,6 +41,8 @@ import {
   AccordionItem,
   AccordionTrigger,
 } from "@usesend/ui/src/accordion";
+import ScheduleCampaign from "../../schedule-campaign";
+import { useRouter } from "next/navigation";
 
 const sendSchema = z.object({
   confirmation: z.string(),
@@ -63,7 +65,7 @@ export default function EditCampaignPage({
     { campaignId },
     {
       enabled: !!campaignId,
-    },
+    }
   );
 
   if (isLoading) {
@@ -94,38 +96,33 @@ function CampaignEditor({
 }: {
   campaign: Campaign & { imageUploadSupported: boolean };
 }) {
+  const router = useRouter();
   const contactBooksQuery = api.contacts.getContactBooks.useQuery({});
   const utils = api.useUtils();
 
   const [json, setJson] = useState<Record<string, any> | undefined>(
-    campaign.content ? JSON.parse(campaign.content) : undefined,
+    campaign.content ? JSON.parse(campaign.content) : undefined
   );
   const [isSaving, setIsSaving] = useState(false);
   const [name, setName] = useState(campaign.name);
   const [subject, setSubject] = useState(campaign.subject);
   const [from, setFrom] = useState(campaign.from);
   const [contactBookId, setContactBookId] = useState(campaign.contactBookId);
   const [replyTo, setReplyTo] = useState<string | undefined>(
-    campaign.replyTo[0],
+    campaign.replyTo[0]
   );
   const [previewText, setPreviewText] = useState<string | null>(
-    campaign.previewText,
+    campaign.previewText
   );
-  const [openSendDialog, setOpenSendDialog] = useState(false);
 
   const updateCampaignMutation = api.campaign.updateCampaign.useMutation({
     onSuccess: () => {
       utils.campaign.getCampaign.invalidate();
       setIsSaving(false);
     },
   });
-  const sendCampaignMutation = api.campaign.sendCampaign.useMutation();
   const getUploadUrl = api.campaign.generateImagePresignedUrl.useMutation();
 
-  const sendForm = useForm<z.infer<typeof sendSchema>>({
-    resolver: zodResolver(sendSchema),
-  });
-
   function updateEditorContent() {
     updateCampaignMutation.mutate({
       campaignId: campaign.id,
@@ -135,39 +132,13 @@ function CampaignEditor({
 
   const deboucedUpdateCampaign = useDebouncedCallback(
     updateEditorContent,
-    1000,
+    1000
   );
 
-  async function onSendCampaign(values: z.infer<typeof sendSchema>) {
-    if (
-      values.confirmation?.toLocaleLowerCase() !== "Send".toLocaleLowerCase()
-    ) {
-      sendForm.setError("confirmation", {
-        message: "Please type 'Send' to confirm",
-      });
-      return;
-    }
-
-    sendCampaignMutation.mutate(
-      {
-        campaignId: campaign.id,
-      },
-      {
-        onSuccess: () => {
-          setOpenSendDialog(false);
-          toast.success(`Campaign sent successfully`);
-        },
-        onError: (error) => {
-          toast.error(`Failed to send campaign: ${error.message}`);
-        },
-      },
-    );
-  }
-
   const handleFileChange = async (file: File) => {
     if (file.size > IMAGE_SIZE_LIMIT) {
       throw new Error(
-        `File should be less than ${IMAGE_SIZE_LIMIT / 1024 / 1024}MB`,
+        `File should be less than ${IMAGE_SIZE_LIMIT / 1024 / 1024}MB`
       );
     }
 
@@ -191,10 +162,8 @@ function CampaignEditor({
     return imageUrl;
   };
 
-  const confirmation = sendForm.watch("confirmation");
-
   const contactBook = contactBooksQuery.data?.find(
-    (book) => book.id === contactBookId,
+    (book) => book.id === contactBookId
   );
 
   return (
@@ -220,7 +189,7 @@ function CampaignEditor({
                     toast.error(`${e.message}. Reverting changes.`);
                     setName(campaign.name);
                   },
-                },
+                }
               );
             }}
           />
@@ -235,56 +204,13 @@ function CampaignEditor({
                 ? "just now"
                 : `${formatDistanceToNow(campaign.updatedAt)} ago`}
             </div>
-            <Dialog open={openSendDialog} onOpenChange={setOpenSendDialog}>
-              <DialogTrigger asChild>
-                <Button variant="default">Send Campaign</Button>
-              </DialogTrigger>
-              <DialogContent>
-                <DialogHeader>
-                  <DialogTitle>Send Campaign</DialogTitle>
-                  <DialogDescription>
-                    Are you sure you want to send this campaign? This action
-                    cannot be undone.
-                  </DialogDescription>
-                </DialogHeader>
-                <div className="py-2">
-                  <Form {...sendForm}>
-                    <form
-                      onSubmit={sendForm.handleSubmit(onSendCampaign)}
-                      className="space-y-4"
-                    >
-                      <FormField
-                        control={sendForm.control}
-                        name="confirmation"
-                        render={({ field }) => (
-                          <FormItem>
-                            <FormLabel>Type 'Send' to confirm</FormLabel>
-                            <FormControl>
-                              <Input {...field} />
-                            </FormControl>
-                            <FormMessage />
-                          </FormItem>
-                        )}
-                      />
-                      <div className="flex justify-end">
-                        <Button
-                          type="submit"
-                          disabled={
-                            sendCampaignMutation.isPending ||
-                            confirmation?.toLocaleLowerCase() !==
-                              "Send".toLocaleLowerCase()
-                          }
-                        >
-                          {sendCampaignMutation.isPending
-                            ? "Sending..."
-                            : "Send"}
-                        </Button>
-                      </div>
-                    </form>
-                  </Form>
-                </div>
-              </DialogContent>
-            </Dialog>
+
+            <ScheduleCampaign
+              campaign={campaign}
+              onScheduled={() => {
+                router.push(`/campaigns/${campaign.id}`);
+              }}
+            />
           </div>
         </div>
 
@@ -315,7 +241,7 @@ function CampaignEditor({
                           toast.error(`${e.message}. Reverting changes.`);
                           setSubject(campaign.subject);
                         },
-                      },
+                      }
                     );
                   }}
                   className="mt-1 py-1 text-sm block w-full outline-none border-b border-transparent  focus:border-border bg-transparent"
@@ -350,7 +276,7 @@ function CampaignEditor({
                             toast.error(`${e.message}. Reverting changes.`);
                             setFrom(campaign.from);
                           },
-                        },
+                        }
                       );
                     }}
                   />
@@ -381,7 +307,7 @@ function CampaignEditor({
                             toast.error(`${e.message}. Reverting changes.`);
                             setReplyTo(campaign.replyTo[0]);
                           },
-                        },
+                        }
                       );
                     }}
                   />
@@ -414,7 +340,7 @@ function CampaignEditor({
                             toast.error(`${e.message}. Reverting changes.`);
                             setPreviewText(campaign.previewText ?? "");
                           },
-                        },
+                        }
                       );
                     }}
                     className="mt-1 py-1 text-sm block w-full outline-none border-b border-transparent bg-transparent  focus:border-border"
@@ -440,7 +366,7 @@ function CampaignEditor({
                             onError: () => {
                               setContactBookId(campaign.contactBookId);
                             },
-                          },
+                          }
                         );
                         setContactBookId(val);
                       }}