Merge pull request #2864 from tsedio/fix-prisma-circular-esm-ref

fix(prisma): fix circular reference when column is optional

packages/orm/prisma/package.json

@@ -28,6 +28,7 @@
     "generate:postgres:esm": "yarn build && cd test/postgres-esm && prisma -v && prisma generate",
     "generate:mongo": "yarn build &&  cd test/mongo && prisma -v && prisma generate",
     "generate:mongo:esm": "yarn build && cd test/mongo-esm && prisma -v && prisma generate",
+    "generate:circular:esm": "yarn build && cd test/circular-ref && prisma -v && prisma generate",
     "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {

packages/orm/prisma/src/generator/transform/transformScalarToType.spec.ts

@@ -107,19 +107,19 @@ describe("transformScalarToType()", () => {
     });
     // @ts-ignore
     field.model.name = "User";
-    expect(transformScalarToType(field, ctx)).toEqual("UserModel | null");
-    expect(field.model.addImportDeclaration).not.toHaveBeenCalled();
+    expect(transformScalarToType(field, ctx)).toEqual("Relation<UserModel> | null");
+    expect(field.model.addImportDeclaration).toHaveBeenCalledWith("@tsed/core", "Relation", true);
   });
 
-  it("should transform User to User", () => {
+  it("should transform Role to User", () => {
     const ctx = createContextFixture();
     const field = createDmmfFieldFixture({
       kind: "object",
       type: "Role"
     });
     // @ts-ignore
     field.model.name = "User";
-    expect(transformScalarToType(field, ctx)).toEqual("RoleModel | null");
+    expect(transformScalarToType(field, ctx)).toEqual("Relation<RoleModel> | null");
     expect(field.model.addImportDeclaration).toHaveBeenCalledWith("./RoleModel", "RoleModel");
   });
 });

packages/orm/prisma/src/generator/transform/transformScalarToType.ts

@@ -31,6 +31,11 @@ export function transformScalarToType(field: DmmfField, ctx: TransformContext):
     TSType += "[]";
   }
 
+  if (!isList && hasCircularRef && ["inputObjectTypes", "enumTypes"].includes(location)) {
+    hasCircularRef && !isList && field.model.addImportDeclaration("@tsed/core", "Relation", true);
+    TSType = `Relation<${TSType}>`;
+  }
+
   if (!isRequired) {
     if (model.isInputType) {
       TSType += " | undefined";
@@ -41,10 +46,7 @@ export function transformScalarToType(field: DmmfField, ctx: TransformContext):
     TSType += " | null";
   }
 
-  if (isRequired && !isList && !isNullable && hasCircularRef && ["inputObjectTypes", "enumTypes"].includes(location)) {
-    hasCircularRef && !isList && field.model.addImportDeclaration("@tsed/core", "Relation", true);
-    TSType = `Relation<${TSType}>`;
-  }
+
 
   return TSType;
 }

packages/orm/prisma/src/generator/utils/__snapshots__/generateModels.spec.ts.snap

@@ -21,6 +21,7 @@ exports[`generateModels > should generate models (post) 1`] = `
 "import { Post } from "../client/index";
 import { Integer, Required, Property, Allow } from "@tsed/schema";
 import { UserModel } from "./UserModel";
+import type { Relation } from "@tsed/core";
 
 export class PostModel implements Post {
   @Property(Number)
@@ -30,7 +31,7 @@ export class PostModel implements Post {
 
   @Property(() => UserModel)
   @Allow(null)
-  user: UserModel | null;
+  user: Relation<UserModel> | null;
 
   @Property(Number)
   @Integer()
@@ -44,6 +45,7 @@ export class PostModel implements Post {
 exports[`generateModels > should generate models (user) 1`] = `
 "import { User } from "../client/index";
 import { Integer, Required, Property, Groups, Format, Email, Description, Allow, Enum, CollectionOf } from "@tsed/schema";
+import type { Relation } from "@tsed/core";
 import { Role } from "../enums/index";
 import { PostModel } from "./PostModel";
 
@@ -84,121 +86,11 @@ export class UserModel implements User {
 
   @Property(() => UserModel)
   @Allow(null)
-  successor: UserModel | null;
+  successor: Relation<UserModel> | null;
 
   @Property(() => UserModel)
   @Allow(null)
-  predecessor: UserModel | null;
-
-  @Required()
-  @Enum(Role)
-  role: Role;
-
-  @CollectionOf(() => PostModel)
-  @Required()
-  posts: PostModel[];
-
-  @CollectionOf(String)
-  @Required()
-  keywords: string[];
-
-  @Property(Object)
-  @Required()
-  biography: any;
-}
-
-"
-`;
-
-exports[`generateModels should generate models (info) 1`] = `
-"import { Info } from \\"../client/index\\";
-import { Required, Property } from \\"@tsed/schema\\";
-
-export class InfoModel implements Info {
-  @Property(String)
-  @Required()
-  firstName: string;
-
-  @Property(String)
-  @Required()
-  lastName: string;
-}
-
-"
-`;
-
-exports[`generateModels should generate models (post) 1`] = `
-"import { Post } from \\"../client/index\\";
-import { Integer, Required, Property, Allow } from \\"@tsed/schema\\";
-import { UserModel } from \\"./UserModel\\";
-
-export class PostModel implements Post {
-  @Property(Number)
-  @Integer()
-  @Required()
-  id: number;
-
-  @Property(() => UserModel)
-  @Allow(null)
-  user: UserModel | null;
-
-  @Property(Number)
-  @Integer()
-  @Allow(null)
-  userId: number | null;
-}
-
-"
-`;
-
-exports[`generateModels should generate models (user) 1`] = `
-"import { User } from \\"../client/index\\";
-import { Integer, Required, Property, Groups, Format, Email, Description, Allow, Enum, CollectionOf } from \\"@tsed/schema\\";
-import { Role } from \\"../enums/index\\";
-import { PostModel } from \\"./PostModel\\";
-
-export class UserModel implements User {
-  @Property(Number)
-  @Integer()
-  @Required()
-  @Groups(\\"!creation\\")
-  id: number;
-
-  @Property(Date)
-  @Format(\\"date-time\\")
-  @Required()
-  createdAt: Date;
-
-  @Property(String)
-  @Required()
-  @Email()
-  @Description(\\"User email. This email must be unique!\\")
-  email: string;
-
-  @Property(Number)
-  @Allow(null)
-  weight: number | null;
-
-  @Property(Boolean)
-  @Allow(null)
-  is18: boolean | null;
-
-  @Property(String)
-  @Allow(null)
-  name: string | null;
-
-  @Property(Number)
-  @Integer()
-  @Allow(null)
-  successorId: number | null;
-
-  @Property(() => UserModel)
-  @Allow(null)
-  successor: UserModel | null;
-
-  @Property(() => UserModel)
-  @Allow(null)
-  predecessor: UserModel | null;
+  predecessor: Relation<UserModel> | null;
 
   @Required()
   @Enum(Role)

packages/orm/prisma/test/circular-ref/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@tsed/prisma-test",
+  "type": "commonjs",
+  "devDependencies": {
+    "prisma": "^4.0.0"
+  },
+  "dependencies": {
+    "@prisma/client": "^4.0.0"
+  }
+}

packages/orm/prisma/test/circular-ref/prisma/schema.prisma

@@ -0,0 +1,32 @@
+
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+generator client {
+  provider        = "prisma-client-js"
+  binaryTargets   = ["native", "windows", "debian-openssl-1.1.x"]
+  output          = "../prisma/generated/client"
+}
+
+generator tsed {
+  provider                 = "node ../../lib/cjs/generator.js"
+  output                   = "../prisma/generated/tsed"
+  emitDMMF                 = true
+}
+
+model Conversation {
+  id           String      @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+  assignmentId String?     @map("assignment_id") @db.Uuid
+  assignment   Assignment? @relation(fields: [assignmentId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+
+  @@map("conversation")
+}
+
+model Assignment {
+  id                String         @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+  conversations     Conversation[]
+
+  @@map("assignment")
+}

packages/orm/prisma/test/snapshots/generate_code/enums/index.ts

@@ -1 +1 @@
-export {Role} from "./Role";
+export { Role } from "./Role";

packages/orm/prisma/test/snapshots/generate_code/interfaces/index.ts

@@ -1,4 +1,4 @@
-import {Prisma} from "../client/index";
+import { Prisma } from "../client/index";
 
 declare global {
   namespace TsED {

packages/orm/prisma/test/snapshots/generate_code/models/PostModel.ts

@@ -1,6 +1,7 @@
-import {Post} from "../client/index";
-import {Integer, Required, Property, Allow} from "@tsed/schema";
-import {UserModel} from "./UserModel";
+import { Post } from "../client/index";
+import { Integer, Required, Property, Allow } from "@tsed/schema";
+import { UserModel } from "./UserModel";
+import type { Relation } from "@tsed/core";
 
 export class PostModel implements Post {
   @Property(Number)
@@ -10,10 +11,11 @@ export class PostModel implements Post {
 
   @Property(() => UserModel)
   @Allow(null)
-  user: UserModel | null;
+  user: Relation<UserModel> | null;
 
   @Property(Number)
   @Integer()
   @Allow(null)
   userId: number | null;
 }
+

packages/orm/prisma/test/snapshots/generate_code/models/UserModel.ts

@@ -1,7 +1,8 @@
-import {User} from "../client/index";
-import {Integer, Required, Property, Groups, Format, Email, Description, Allow, Enum, CollectionOf} from "@tsed/schema";
-import {Role} from "../enums/index";
-import {PostModel} from "./PostModel";
+import { User } from "../client/index";
+import { Integer, Required, Property, Groups, Format, Email, Description, Allow, Enum, CollectionOf } from "@tsed/schema";
+import type { Relation } from "@tsed/core";
+import { Role } from "../enums/index";
+import { PostModel } from "./PostModel";
 
 export class UserModel implements User {
   @Property(Number)
@@ -40,11 +41,11 @@ export class UserModel implements User {
 
   @Property(() => UserModel)
   @Allow(null)
-  successor: UserModel | null;
+  successor: Relation<UserModel> | null;
 
   @Property(() => UserModel)
   @Allow(null)
-  predecessor: UserModel | null;
+  predecessor: Relation<UserModel> | null;
 
   @Required()
   @Enum(Role)
@@ -62,3 +63,4 @@ export class UserModel implements User {
   @Required()
   biography: any;
 }
+

packages/orm/prisma/test/snapshots/generate_code/models/index.ts

@@ -1,2 +1,2 @@
-export {PostModel} from "./PostModel";
-export {UserModel} from "./UserModel";
+export { PostModel } from "./PostModel";
+export { UserModel } from "./UserModel";

packages/orm/prisma/test/snapshots/generate_code/repositories/PostsRepository.ts

@@ -1,25 +1,25 @@
-import {isArray} from "@tsed/core";
-import {deserialize} from "@tsed/json-mapper";
-import {Injectable, Inject} from "@tsed/di";
-import {PrismaService} from "../services/PrismaService";
-import {Prisma, Post} from "../client/index";
-import {PostModel} from "../models/index";
+import { isArray } from "@tsed/core";
+import { deserialize } from "@tsed/json-mapper";
+import { Injectable, Inject } from "@tsed/di";
+import { PrismaService } from "../services/PrismaService";
+import { Prisma, Post } from "../client/index";
+import { PostModel } from "../models/index";
 
 @Injectable()
 export class PostsRepository {
   @Inject()
   protected prisma: PrismaService;
 
   get collection() {
-    return this.prisma.post;
+    return this.prisma.post
   }
 
   get groupBy() {
-    return this.collection.groupBy.bind(this.collection);
+    return this.collection.groupBy.bind(this.collection)
   }
 
   protected deserialize<T>(obj: null | Post | Post[]): T {
-    return deserialize<T>(obj, {type: PostModel, collectionType: isArray(obj) ? Array : undefined});
+    return deserialize<T>(obj, { type: PostModel, collectionType: isArray(obj) ? Array : undefined })
   }
 
   async findUnique(args: Prisma.PostFindUniqueArgs): Promise<PostModel | null> {
@@ -58,14 +58,14 @@ export class PostsRepository {
   }
 
   deleteMany(args: Prisma.PostDeleteManyArgs) {
-    return this.collection.deleteMany(args);
+    return this.collection.deleteMany(args)
   }
 
   updateMany(args: Prisma.PostUpdateManyArgs) {
-    return this.collection.updateMany(args);
+    return this.collection.updateMany(args)
   }
 
   aggregate(args: Prisma.PostAggregateArgs) {
-    return this.collection.aggregate(args);
+    return this.collection.aggregate(args)
   }
 }