fix(db): address PR #208 review issues

- Add Prisma middleware to auto-generate NanoID for missing IDs on create
- Add foreign key relation from Consumption.courseId to Course
- Update mock builders to use generateId() instead of faker UUID
- Update testing principles docs to use NanoID examples

Author: zainfathoni

app/components/__tests__/transaction-item.test.tsx

@@ -1,17 +1,18 @@
-import { build, fake, oneOf } from '@jackfranklin/test-data-bot'
+import { build, fake, oneOf, perBuild } from '@jackfranklin/test-data-bot'
 import { screen } from '@testing-library/react'
 import { TransactionItem, TransactionItemProps } from '../transaction-item'
 import { render } from '#test/test-utils'
 import { printLocaleDateTimeString } from '~/utils/format'
 import { TRANSACTION_STATUS } from '~/models/enum'
+import { generateId } from '~/utils/nanoid'
 
 const transactionItemBuilder = build<TransactionItemProps>('TransactionItem', {
   fields: {
-    to: fake(
-      (f) =>
-        `${f.datatype.uuid()}?status=${oneOf(
-          TRANSACTION_STATUS
-        )}&page=${f.datatype.number()}`
+    to: perBuild(
+      () =>
+        `${generateId()}?status=${oneOf(TRANSACTION_STATUS)}&page=${Math.floor(
+          Math.random() * 100
+        )}`
     ),
     bankAccountName: fake((f) => f.finance.accountName()),
     bankAccountNumber: fake((f) => f.finance.account()),

app/models/__mocks__/audit-log.ts

@@ -1,13 +1,14 @@
-import { build, fake, perBuild } from '@jackfranklin/test-data-bot'
+import { build, perBuild } from '@jackfranklin/test-data-bot'
 import { AuditLog } from '@prisma/client'
 import { AUDIT_ACTION, AUDIT_ENTITY_TYPE } from '../enum'
+import { generateId } from '~/utils/nanoid'
 
 export const auditLogBuilder = build<Omit<AuditLog, 'id' | 'createdAt'>>({
   fields: {
     userId: null,
     action: perBuild(() => AUDIT_ACTION.CREATE),
     entityType: perBuild(() => AUDIT_ENTITY_TYPE.USER),
-    entityId: fake((f) => f.datatype.uuid()),
+    entityId: perBuild(() => generateId()),
     oldValue: null,
     newValue: null,
     metadata: null,
@@ -38,7 +39,7 @@ export const auditLogBuilder = build<Omit<AuditLog, 'id' | 'createdAt'>>({
     },
     withUser: {
       overrides: {
-        userId: fake((f) => f.datatype.uuid()),
+        userId: perBuild(() => generateId()),
       },
     },
     withMetadata: {

app/utils/db.server.ts

@@ -1,4 +1,5 @@
 import { PrismaClient } from '@prisma/client'
+import { generateId } from './nanoid'
 
 let db: PrismaClient
 
@@ -7,15 +8,32 @@ declare global {
   var __db: PrismaClient | undefined
 }
 
+function createPrismaClient(): PrismaClient {
+  const client = new PrismaClient()
+
+  // Middleware to auto-generate NanoID for models missing an id on create.
+  // This serves as a safety net in case `id: generateId()` is forgotten.
+  client.$use(async (params, next) => {
+    if (params.action === 'create' && params.args?.data) {
+      if (!params.args.data.id) {
+        params.args.data.id = generateId()
+      }
+    }
+    return next(params)
+  })
+
+  return client
+}
+
 // this is needed because in development we don't want to restart
 // the server with every change, but we want to make sure we don't
 // create a new connection to the DB with every change either.
 if (process.env.NODE_ENV === 'production') {
-  db = new PrismaClient()
+  db = createPrismaClient()
   db.$connect()
 } else {
   if (!global.__db) {
-    global.__db = new PrismaClient()
+    global.__db = createPrismaClient()
     global.__db.$connect()
   }
   db = global.__db

docs/testing-principles.md

@@ -231,11 +231,12 @@ test.use({
 For generating consistent test data, use `@jackfranklin/test-data-bot`:
 
 ```typescript
-import { build, fake } from '@jackfranklin/test-data-bot'
+import { build, fake, perBuild } from '@jackfranklin/test-data-bot'
+import { generateId } from '~/utils/nanoid'
 
 const userBuilder = build('User', {
   fields: {
-    id: fake((f) => f.datatype.uuid()),
+    id: perBuild(() => generateId()),
     email: fake((f) => f.internet.email()),
     name: fake((f) => f.name.fullName()),
   },

prisma/migrations/20260115044602_add_consumption_course_fk/migration.sql

@@ -0,0 +1,22 @@
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_Consumption" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL,
+    "userId" TEXT NOT NULL,
+    "contentId" TEXT NOT NULL,
+    "courseId" TEXT NOT NULL,
+    "progress" INTEGER NOT NULL DEFAULT 0,
+    "status" TEXT NOT NULL DEFAULT 'PRISTINE',
+    CONSTRAINT "Consumption_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
+    CONSTRAINT "Consumption_contentId_fkey" FOREIGN KEY ("contentId") REFERENCES "Content" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
+    CONSTRAINT "Consumption_courseId_fkey" FOREIGN KEY ("courseId") REFERENCES "Course" ("id") ON DELETE CASCADE ON UPDATE CASCADE
+);
+INSERT INTO "new_Consumption" ("contentId", "courseId", "createdAt", "id", "progress", "status", "updatedAt", "userId") SELECT "contentId", "courseId", "createdAt", "id", "progress", "status", "updatedAt", "userId" FROM "Consumption";
+DROP TABLE "Consumption";
+ALTER TABLE "new_Consumption" RENAME TO "Consumption";
+CREATE UNIQUE INDEX "Consumption_userId_contentId_key" ON "Consumption"("userId", "contentId");
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

prisma/schema.prisma

@@ -54,6 +54,7 @@ model Course {
   transactions  Transaction[]
   chapters      Chapter[]
   contents      Content[]
+  consumptions  Consumption[]
 }
 
 model Transaction {
@@ -139,6 +140,7 @@ model Consumption {
   status    String   @default("PRISTINE")
   user      User     @relation(fields: [userId], references: [id], onDelete: Cascade)
   content   Content  @relation(fields: [contentId], references: [id], onDelete: Cascade)
+  course    Course   @relation(fields: [courseId], references: [id], onDelete: Cascade)
 
   @@unique([userId, contentId])
 }