@studious-lms/server 1.4.9 → 1.5.0

package/prisma/migrations/20260506162500_consolidate_run_job_and_unify_job_status/migration.sql

@@ -0,0 +1,166 @@
+-- Consolidate background-job tracking onto RunJob and unify domain status.
+--
+-- 1. Replace the bare-bones RunJob table with a fully-typed audit row that
+--    carries job type, status, input/result, error, attempts, timestamps.
+-- 2. Replace the catch-all GenerationStatus enum with a single shared
+--    JobStatus enum used by every domain row that has a user-observable
+--    async lifecycle (Message, StudentQuestionProgress).
+-- 3. Add a nullable runJobId FK on Message and StudentQuestionProgress so we
+--    can trace a domain row back to the job that produced it. Operational
+--    state (retries, errors, attempts) lives on RunJob, not on the row.
+-- 4. Drop the unused Comment.status column.
+
+-- ---------------------------------------------------------------------------
+-- 1. New enum types
+-- ---------------------------------------------------------------------------
+
+CREATE TYPE "RunJobType" AS ENUM (
+  'PDF_TO_WORKSHEET',
+  'GRADE_WORKSHEET',
+  'AI_LAB_CHAT',
+  'AI_NEWTON_CHAT',
+  'STUDENT_PROGRESS_CHAT'
+);
+
+-- Queue-internal lifecycle. Distinct from JobStatus because PENDING (queued
+-- but not picked up) vs RUNNING (worker actively executing) is a real
+-- operational distinction we want when debugging.
+CREATE TYPE "RunJobStatus" AS ENUM (
+  'PENDING',
+  'RUNNING',
+  'SUCCEEDED',
+  'FAILED',
+  'CANCELLED'
+);
+
+-- Shared UI-shaped status for domain rows. Not every row uses every value
+-- (e.g. Message never gets NOT_STARTED) but we keep one enum to avoid an
+-- explosion of near-duplicate types.
+CREATE TYPE "JobStatus" AS ENUM (
+  'NOT_STARTED',
+  'PENDING',
+  'COMPLETED',
+  'FAILED',
+  'CANCELLED'
+);
+
+-- ---------------------------------------------------------------------------
+-- 2. Replace the legacy RunJob table.
+--
+-- The previous schema only had `id` and `createdAt`, and was applied via
+-- `prisma db push` (no migration history) — so any rows in it are throwaway.
+-- We DROP IF EXISTS to handle both fresh production DBs and dev DBs that have
+-- the old shape.
+-- ---------------------------------------------------------------------------
+
+DROP TABLE IF EXISTS "RunJob" CASCADE;
+
+CREATE TABLE "RunJob" (
+  "id"         TEXT NOT NULL,
+  "type"       "RunJobType" NOT NULL,
+  "status"     "RunJobStatus" NOT NULL DEFAULT 'PENDING',
+  "classId"    TEXT,
+  "userId"     TEXT,
+  "bullJobId"  TEXT,
+  "input"      JSONB NOT NULL,
+  "result"     JSONB,
+  "error"      TEXT,
+  "attempts"   INTEGER NOT NULL DEFAULT 0,
+  "startedAt"  TIMESTAMP(3),
+  "finishedAt" TIMESTAMP(3),
+  "createdAt"  TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  "updatedAt"  TIMESTAMP(3) NOT NULL,
+
+  CONSTRAINT "RunJob_pkey" PRIMARY KEY ("id")
+);
+
+CREATE INDEX "RunJob_userId_type_status_idx" ON "RunJob"("userId", "type", "status");
+CREATE INDEX "RunJob_classId_status_idx"     ON "RunJob"("classId", "status");
+CREATE INDEX "RunJob_status_createdAt_idx"   ON "RunJob"("status", "createdAt");
+
+-- ---------------------------------------------------------------------------
+-- 2b. Track PDF source URLs on worksheets for idempotent PDF conversion.
+-- ---------------------------------------------------------------------------
+
+ALTER TABLE "Worksheet" ADD COLUMN "sourceUrl" TEXT;
+
+CREATE UNIQUE INDEX "Worksheet_classId_sourceUrl_key"
+  ON "Worksheet"("classId", "sourceUrl");
+
+-- ---------------------------------------------------------------------------
+-- 3. Message.status: GenerationStatus -> JobStatus.
+--
+-- Old enum had NOT_STARTED / PENDING / GENERATING / COMPLETED / FAILED /
+-- CANCELLED. New JobStatus drops GENERATING (never written). The old default
+-- of NOT_STARTED is dropped: a row without an AI lifecycle now has NULL.
+-- GENERATING is mapped to PENDING defensively in case any row carries it.
+-- ---------------------------------------------------------------------------
+
+ALTER TABLE "Message" ALTER COLUMN "status" DROP DEFAULT;
+
+ALTER TABLE "Message"
+  ALTER COLUMN "status" TYPE "JobStatus"
+  USING (
+    CASE "status"::text
+      WHEN 'NOT_STARTED' THEN NULL
+      WHEN 'GENERATING'  THEN 'PENDING'::"JobStatus"
+      WHEN 'PENDING'     THEN 'PENDING'::"JobStatus"
+      WHEN 'COMPLETED'   THEN 'COMPLETED'::"JobStatus"
+      WHEN 'FAILED'      THEN 'FAILED'::"JobStatus"
+      WHEN 'CANCELLED'   THEN 'CANCELLED'::"JobStatus"
+      ELSE NULL
+    END
+  );
+
+-- ---------------------------------------------------------------------------
+-- 4. StudentQuestionProgress.status: GenerationStatus -> JobStatus.
+--
+-- Default kept at NOT_STARTED. GENERATING -> PENDING defensively.
+-- ---------------------------------------------------------------------------
+
+ALTER TABLE "StudentQuestionProgress" ALTER COLUMN "status" DROP DEFAULT;
+
+ALTER TABLE "StudentQuestionProgress"
+  ALTER COLUMN "status" TYPE "JobStatus"
+  USING (
+    CASE "status"::text
+      WHEN 'NOT_STARTED' THEN 'NOT_STARTED'::"JobStatus"
+      WHEN 'PENDING'     THEN 'PENDING'::"JobStatus"
+      WHEN 'GENERATING'  THEN 'PENDING'::"JobStatus"
+      WHEN 'COMPLETED'   THEN 'COMPLETED'::"JobStatus"
+      WHEN 'FAILED'      THEN 'FAILED'::"JobStatus"
+      WHEN 'CANCELLED'   THEN 'CANCELLED'::"JobStatus"
+      ELSE NULL
+    END
+  );
+
+ALTER TABLE "StudentQuestionProgress"
+  ALTER COLUMN "status" SET DEFAULT 'NOT_STARTED';
+
+-- ---------------------------------------------------------------------------
+-- 5. Drop the unused Comment.status column and the legacy enum.
+-- ---------------------------------------------------------------------------
+
+ALTER TABLE "Comment" DROP COLUMN "status";
+
+DROP TYPE "GenerationStatus";
+
+-- ---------------------------------------------------------------------------
+-- 6. Add runJobId FKs and supporting indexes.
+-- ---------------------------------------------------------------------------
+
+ALTER TABLE "Message"
+  ADD COLUMN "runJobId" TEXT,
+  ADD CONSTRAINT "Message_runJobId_fkey"
+    FOREIGN KEY ("runJobId") REFERENCES "RunJob"("id")
+    ON DELETE SET NULL ON UPDATE CASCADE;
+
+CREATE INDEX "Message_runJobId_idx" ON "Message"("runJobId");
+
+ALTER TABLE "StudentQuestionProgress"
+  ADD COLUMN "runJobId" TEXT,
+  ADD CONSTRAINT "StudentQuestionProgress_runJobId_fkey"
+    FOREIGN KEY ("runJobId") REFERENCES "RunJob"("id")
+    ON DELETE SET NULL ON UPDATE CASCADE;
+
+CREATE INDEX "StudentQuestionProgress_runJobId_idx" ON "StudentQuestionProgress"("runJobId");