Improve Self host setup (#30)

* Add self host setup * Improve blunders * Move to bull mq * More changes * Add example code for sending test emails
2024-06-24 08:21:37 +10:00
parent 8a2769621c
commit f77a8829be
67 changed files with 1771 additions and 688 deletions
--- a/apps/web/prisma/migrations/20240429231118_add_is_beta_user/migration.sql
+++ b/apps/web/prisma/migrations/20240429231118_add_is_beta_user/migration.sql
@@ -1,2 +0,0 @@
-- AlterTable
-ALTER TABLE "User" ADD COLUMN     "isBetaUser" BOOLEAN NOT NULL DEFAULT false;
--- a/apps/web/prisma/migrations/20240510004745_add_queue_enum/migration.sql
+++ b/apps/web/prisma/migrations/20240510004745_add_queue_enum/migration.sql
@@ -1,5 +0,0 @@
-- AlterEnum
-ALTER TYPE "EmailStatus" ADD VALUE 'QUEUED';
-
-- AlterTable
-ALTER TABLE "Email" ADD COLUMN     "attachments" TEXT;
--- a/apps/web/prisma/migrations/20240510004808_change_default_queued/migration.sql
+++ b/apps/web/prisma/migrations/20240510004808_change_default_queued/migration.sql
@@ -1,2 +0,0 @@
-- AlterTable
-ALTER TABLE "Email" ALTER COLUMN "latestStatus" SET DEFAULT 'QUEUED';
--- a/apps/web/prisma/migrations/20240515211820_add_reply_to/migration.sql
+++ b/apps/web/prisma/migrations/20240515211820_add_reply_to/migration.sql
@@ -1,2 +0,0 @@
-- AlterTable
-ALTER TABLE "Email" ADD COLUMN     "replyTo" TEXT;
--- a/apps/web/prisma/migrations/20240527202531_add_is_verifying/migration.sql
+++ b/apps/web/prisma/migrations/20240527202531_add_is_verifying/migration.sql
@@ -1,2 +0,0 @@
-- AlterTable
-ALTER TABLE "Domain" ADD COLUMN     "isVerifying" BOOLEAN NOT NULL DEFAULT false;
--- a/apps/web/prisma/migrations/20240610073426_add_ses_settings/migration.sql
+++ b/apps/web/prisma/migrations/20240610073426_add_ses_settings/migration.sql
@@ -1,25 +0,0 @@
-- CreateTable
-CREATE TABLE "SesSetting" (
-    "id" TEXT NOT NULL,
-    "region" TEXT NOT NULL,
-    "idPrefix" TEXT NOT NULL,
-    "topic" TEXT NOT NULL,
-    "topicArn" TEXT,
-    "callbackUrl" TEXT NOT NULL,
-    "callbackSuccess" BOOLEAN NOT NULL DEFAULT false,
-    "configGeneral" TEXT,
-    "configGeneralSuccess" BOOLEAN NOT NULL DEFAULT false,
-    "configClick" TEXT,
-    "configClickSuccess" BOOLEAN NOT NULL DEFAULT false,
-    "configOpen" TEXT,
-    "configOpenSuccess" BOOLEAN NOT NULL DEFAULT false,
-    "configFull" TEXT,
-    "configFullSuccess" BOOLEAN NOT NULL DEFAULT false,
-    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    "updatedAt" TIMESTAMP(3) NOT NULL,
-
-    CONSTRAINT "SesSetting_pkey" PRIMARY KEY ("id")
-);
-
-- CreateIndex
-CREATE UNIQUE INDEX "SesSetting_region_key" ON "SesSetting"("region");
--- a/apps/web/prisma/migrations/20240619211232_init/migration.sql
+++ b/apps/web/prisma/migrations/20240619211232_init/migration.sql
@@ -8,7 +8,7 @@ CREATE TYPE "DomainStatus" AS ENUM ('NOT_STARTED', 'PENDING', 'SUCCESS', 'FAILED
 CREATE TYPE "ApiPermission" AS ENUM ('FULL', 'SENDING');

 -- CreateEnum
-CREATE TYPE "EmailStatus" AS ENUM ('SENT', 'OPENED', 'CLICKED', 'BOUNCED', 'COMPLAINED', 'DELIVERED', 'REJECTED', 'RENDERING_FAILURE', 'DELIVERY_DELAYED');
+CREATE TYPE "EmailStatus" AS ENUM ('QUEUED', 'SENT', 'OPENED', 'CLICKED', 'BOUNCED', 'COMPLAINED', 'DELIVERED', 'REJECTED', 'RENDERING_FAILURE', 'DELIVERY_DELAYED', 'FAILED');

 -- CreateTable
 CREATE TABLE "AppSetting" (
@@ -18,6 +18,30 @@ CREATE TABLE "AppSetting" (
    CONSTRAINT "AppSetting_pkey" PRIMARY KEY ("key")
 );

+-- CreateTable
+CREATE TABLE "SesSetting" (
+    "id" TEXT NOT NULL,
+    "region" TEXT NOT NULL,
+    "idPrefix" TEXT NOT NULL,
+    "topic" TEXT NOT NULL,
+    "topicArn" TEXT,
+    "callbackUrl" TEXT NOT NULL,
+    "callbackSuccess" BOOLEAN NOT NULL DEFAULT false,
+    "configGeneral" TEXT,
+    "configGeneralSuccess" BOOLEAN NOT NULL DEFAULT false,
+    "configClick" TEXT,
+    "configClickSuccess" BOOLEAN NOT NULL DEFAULT false,
+    "configOpen" TEXT,
+    "configOpenSuccess" BOOLEAN NOT NULL DEFAULT false,
+    "configFull" TEXT,
+    "configFullSuccess" BOOLEAN NOT NULL DEFAULT false,
+    "sesEmailRateLimit" INTEGER NOT NULL DEFAULT 1,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "SesSetting_pkey" PRIMARY KEY ("id")
+);
+
 -- CreateTable
 CREATE TABLE "Account" (
    "id" TEXT NOT NULL,
@@ -61,6 +85,7 @@ CREATE TABLE "User" (
    "email" TEXT,
    "emailVerified" TIMESTAMP(3),
    "image" TEXT,
+    "isBetaUser" BOOLEAN NOT NULL DEFAULT false,

    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
 );
@@ -97,6 +122,7 @@ CREATE TABLE "Domain" (
    "dmarcAdded" BOOLEAN NOT NULL DEFAULT false,
    "errorMessage" TEXT,
    "subdomain" TEXT,
+    "isVerifying" BOOLEAN NOT NULL DEFAULT false,
    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "updatedAt" TIMESTAMP(3) NOT NULL,

@@ -122,28 +148,38 @@ CREATE TABLE "ApiKey" (
 CREATE TABLE "Email" (
    "id" TEXT NOT NULL,
    "sesEmailId" TEXT,
-    "to" TEXT NOT NULL,
    "from" TEXT NOT NULL,
+    "to" TEXT[],
+    "replyTo" TEXT[],
+    "cc" TEXT[],
+    "bcc" TEXT[],
    "subject" TEXT NOT NULL,
    "text" TEXT,
    "html" TEXT,
-    "latestStatus" "EmailStatus" NOT NULL DEFAULT 'SENT',
+    "latestStatus" "EmailStatus" NOT NULL DEFAULT 'QUEUED',
    "teamId" INTEGER NOT NULL,
    "domainId" INTEGER,
    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "attachments" TEXT,

    CONSTRAINT "Email_pkey" PRIMARY KEY ("id")
 );

 -- CreateTable
 CREATE TABLE "EmailEvent" (
+    "id" TEXT NOT NULL,
    "emailId" TEXT NOT NULL,
    "status" "EmailStatus" NOT NULL,
    "data" JSONB,
-    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "EmailEvent_pkey" PRIMARY KEY ("id")
 );

+-- CreateIndex
+CREATE UNIQUE INDEX "SesSetting_region_key" ON "SesSetting"("region");
+
 -- CreateIndex
 CREATE UNIQUE INDEX "Account_provider_providerAccountId_key" ON "Account"("provider", "providerAccountId");

@@ -171,9 +207,6 @@ CREATE UNIQUE INDEX "ApiKey_tokenHash_key" ON "ApiKey"("tokenHash");
 -- CreateIndex
 CREATE UNIQUE INDEX "Email_sesEmailId_key" ON "Email"("sesEmailId");

-- CreateIndex
-CREATE UNIQUE INDEX "EmailEvent_emailId_status_key" ON "EmailEvent"("emailId", "status");
-
 -- AddForeignKey
 ALTER TABLE "Account" ADD CONSTRAINT "Account_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;

--- a/apps/web/prisma/schema.prisma
+++ b/apps/web/prisma/schema.prisma
@@ -35,6 +35,7 @@ model SesSetting {
  configOpenSuccess    Boolean  @default(false)
  configFull           String?
  configFullSuccess    Boolean  @default(false)
+  sesEmailRateLimit    Int      @default(1)
  createdAt            DateTime @default(now())
  updatedAt            DateTime @updatedAt
 }
@@ -162,23 +163,26 @@ model ApiKey {
 enum EmailStatus {
  QUEUED
  SENT
+  BOUNCED
+  DELIVERED
  OPENED
  CLICKED
-  BOUNCED
  COMPLAINED
-  DELIVERED
  REJECTED
  RENDERING_FAILURE
  DELIVERY_DELAYED
+  FAILED
 }

 model Email {
  id           String       @id @default(cuid())
  sesEmailId   String?      @unique
-  to           String
  from         String
+  to           String[]
+  replyTo      String[]
+  cc           String[]
+  bcc          String[]
  subject      String
-  replyTo      String?
  text         String?
  html         String?
  latestStatus EmailStatus  @default(QUEUED)
@@ -192,11 +196,10 @@ model Email {
 }

 model EmailEvent {
+  id        String      @id @default(cuid())
  emailId   String
  status    EmailStatus
  data      Json?
  createdAt DateTime    @default(now())
  email     Email       @relation(fields: [emailId], references: [id], onDelete: Cascade)
-
-  @@unique([emailId, status])
 }