feat(referentialActions): add relationOnDelete (#16)

* feat(referentialActions): add relationOnDelete

* test: add referential actions onDelete test

Author: marcjulian

.gitignore

@@ -1,4 +1,4 @@
 node_modules
 dist
-prisma/dev.sqlite
+prisma/dev.db*
 .env

__tests__/dbml.test.ts

@@ -6,6 +6,7 @@ import {
   datamodelDbmlManyToManyInvalid,
   datamodelDbmlManyToManyRenameRelation,
   datamodelDbmlManyToManySelfRelation,
+  datamodelDbmlReferentialActions,
   datamodelDbmlRelations,
 } from './fixtures/dbml.datamodel';
 import { generateDMMF } from './utils/generateDMMF';
@@ -301,4 +302,36 @@ Table userReceivesPosts {
 
     expect(dbml).toEqual(expectedDbml);
   });
+
+  test('generating dbml schema with referential actions', async () => {
+    const dmmf = await generateDMMF(datamodelDbmlReferentialActions);
+
+    const expectedDbml = `${autoGeneratedComment}
+
+Table User {
+  id Int [pk, increment]
+  profile Profile
+  posts Post [not null]
+}
+
+Table Profile {
+  id Int [pk, increment]
+  user User [not null]
+  userId Int [unique, not null]
+}
+
+Table Post {
+  id Int [pk, increment]
+  author User
+  authorId Int
+}
+
+Ref: Profile.userId - User.id [delete: Cascade]
+
+Ref: Post.authorId > User.id [delete: SetNull]`;
+
+    const dbml = generateDBMLSchema(dmmf);
+
+    expect(dbml).toEqual(expectedDbml);
+  });
 });

__tests__/fixtures/dbml.datamodel.ts

@@ -131,3 +131,21 @@ export const datamodelDbmlManyToManyRenameRelation = /* Prisma */ `
     receivedBy User[] @relation("userReceivesPosts")
   }
 `;
+
+export const datamodelDbmlReferentialActions = /* Prisma */ `
+  model User {
+    id Int @id @default(autoincrement())
+    profile Profile? 
+    posts Post[]
+  }
+  model Profile {
+    id Int @id @default(autoincrement())
+    user   User    @relation(fields: [userId], references: [id], onDelete: Cascade, onUpdate: Cascade)
+    userId Int     @unique
+  }
+  model Post {
+    id Int @id @default(autoincrement())
+    author     User?      @relation(fields: [authorId], references: [id], onDelete: SetNull, onUpdate: Cascade)
+    authorId   Int?
+  }
+`;

package-lock.json

@@ -10,7 +10,6 @@ Table User {
   name String
   posts Post [not null]
   profile Profile
-  role Role [not null, default: 'USER', note: 'user\'s role']
 }
 
 Table Profile {
@@ -53,11 +52,6 @@ Table CategoryToPost {
   postsId Int [ref: > Post.id]
 }
 
-Enum Role {
-  ADMIN
-  USER
-}
-
-Ref: Profile.userId - User.id
+Ref: Profile.userId - User.id [delete: Cascade]
 
-Ref: Post.authorId > User.id
+Ref: Post.authorId > User.id [delete: SetNull]

prisma/dbml/schema.dbml

@@ -0,0 +1,62 @@
+-- CreateTable
+CREATE TABLE "User" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL,
+    "email" TEXT NOT NULL,
+    "name" TEXT
+);
+
+-- CreateTable
+CREATE TABLE "Profile" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "bio" TEXT,
+    "userId" INTEGER NOT NULL,
+    FOREIGN KEY ("userId") REFERENCES "User" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
+);
+
+-- CreateTable
+CREATE TABLE "Post" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "title" TEXT NOT NULL DEFAULT '',
+    "content" TEXT,
+    "published" BOOLEAN NOT NULL DEFAULT false,
+    "authorId" INTEGER,
+    FOREIGN KEY ("authorId") REFERENCES "User" ("id") ON DELETE SET NULL ON UPDATE CASCADE
+);
+
+-- CreateTable
+CREATE TABLE "Category" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "name" TEXT NOT NULL
+);
+
+-- CreateTable
+CREATE TABLE "Token" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "device" TEXT NOT NULL,
+    "operatingSystem" TEXT NOT NULL
+);
+
+-- CreateTable
+CREATE TABLE "_CategoryToPost" (
+    "A" INTEGER NOT NULL,
+    "B" INTEGER NOT NULL,
+    FOREIGN KEY ("A") REFERENCES "Category" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
+    FOREIGN KEY ("B") REFERENCES "Post" ("id") ON DELETE CASCADE ON UPDATE CASCADE
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User.email_unique" ON "User"("email");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Profile.userId_unique" ON "Profile"("userId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Token.device_operatingSystem_unique" ON "Token"("device", "operatingSystem");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "_CategoryToPost_AB_unique" ON "_CategoryToPost"("A", "B");
+
+-- CreateIndex
+CREATE INDEX "_CategoryToPost_B_index" ON "_CategoryToPost"("B");

prisma/migrations/20210121125958_init/migration.sql

@@ -1,2 +1,3 @@
 # Please do not edit this file manually
-provider = "postgresql"
+# It should be added in your version-control system (i.e. Git)
+provider = "sqlite"

prisma/migrations/20210729110945_init/migration.sql

@@ -2,12 +2,12 @@
 // learn more about it in the docs: https://pris.ly/d/prisma-schema
 
 datasource db {
-  provider = "postgres"
-  url      = env("POSTGRESQL_URL")
+  provider = "sqlite"
+  url      = env("DATABASE_URL")
 }
 
 generator client {
-  provider = "prisma-client-js"
+  provider        = "prisma-client-js"
 }
 
 generator dbml {
@@ -22,15 +22,13 @@ model User {
   name      String?
   posts     Post[]
   profile   Profile?
-  /// user's role
-  role      Role     @default(USER)
 }
 
 /// User profile
 model Profile {
   id     Int     @id @default(autoincrement())
   bio    String?
-  user   User    @relation(fields: [userId], references: [id])
+  user   User    @relation(fields: [userId], references: [id], onDelete: Cascade, onUpdate: Cascade)
   userId Int     @unique
 }
 
@@ -39,7 +37,7 @@ model Post {
   title      String     @default("")
   content    String?
   published  Boolean    @default(false)
-  author     User?      @relation(fields: [authorId], references: [id])
+  author     User?      @relation(fields: [authorId], references: [id], onDelete: SetNull)
   authorId   Int?
   categories Category[]
 }
@@ -57,9 +55,3 @@ model Token {
 
   @@unique([device, operatingSystem])
 }
-
-/// user role
-enum Role {
-  ADMIN /// allowed to do everything
-  USER
-}

prisma/migrations/migration_lock.toml

@@ -24,13 +24,19 @@ export function generateRelations(models: DMMF.Model[]): string[] {
           relationTo
         );
 
-        refs.push(
-          `Ref: ${relationFrom}.${combineKeys(
-            field.relationFromFields!
-          )} ${relationOperator} ${relationTo}.${combineKeys(
-            field.relationToFields!!
-          )}`
+        const ref = `Ref: ${relationFrom}.${combineKeys(
+          field.relationFromFields!
+        )} ${relationOperator} ${relationTo}.${combineKeys(
+          field.relationToFields!!
+        )}`;
+
+        const referentialActions = getReferentialActions(
+          models,
+          relationFrom,
+          relationTo
         );
+
+        refs.push(`${ref}${referentialActions}`);
       });
   });
   return refs;
@@ -51,3 +57,22 @@ const getRelationOperator = (
 const combineKeys = (keys: string[]): string => {
   return keys.length > 1 ? `(${keys.join(', ')})` : keys[0];
 };
+
+const getReferentialActions = (
+  models: DMMF.Model[],
+  from: string,
+  to: string
+): string => {
+  const model = models.find((model) => model.name === from);
+  const field = model?.fields.find((field) => field.type === to);
+  const referentialActions: string[] = [];
+
+  if (field?.relationOnDelete) {
+    referentialActions.push(`delete: ${field.relationOnDelete}`);
+  }
+
+  if (referentialActions.length) {
+    return ' [' + referentialActions.join(', ') + ']';
+  }
+  return '';
+};