querydsl-ksp-codegen: Support @JdbcTypeCode in KSP code generation (#1127)

Fix KSP codegen not handling @JdbcTypeCode

Author: Gyeom

querydsl-examples/querydsl-example-ksp-codegen/build.gradle.kts

@@ -6,25 +6,26 @@ val querydslVersion = findProperty("querydsl.version") as String
 val assertjVersion = findProperty("assertj.version") as String
 
 plugins {
-	kotlin("jvm")
-	id("com.google.devtools.ksp")
-	kotlin("plugin.jpa")
-	kotlin("plugin.serialization")
+        kotlin("jvm")
+        id("com.google.devtools.ksp")
+        kotlin("plugin.jpa")
+        kotlin("plugin.serialization")
 }
 
 repositories {
-	mavenCentral()
-	mavenLocal()
+        mavenCentral()
+        mavenLocal()
 }
 
 dependencies {
-	implementation("jakarta.persistence:jakarta.persistence-api:${jpaVersion}")
-	implementation("io.github.openfeign.querydsl:querydsl-core:${querydslVersion}")
-	ksp("io.github.openfeign.querydsl:querydsl-ksp-codegen:${querydslVersion}")
-
-	testImplementation("io.github.openfeign.querydsl:querydsl-jpa:${querydslVersion}")
-	testImplementation("org.assertj:assertj-core:${assertjVersion}")
-	testImplementation("org.hibernate.orm:hibernate-core:${hibernateVersion}")
-	testImplementation("com.h2database:h2:${h2Version}")
-	testImplementation("org.jetbrains.kotlin:kotlin-test-junit:${kotlinVersion}")
+        implementation("jakarta.persistence:jakarta.persistence-api:${jpaVersion}")
+        implementation("io.github.openfeign.querydsl:querydsl-core:${querydslVersion}")
+        implementation("org.hibernate.orm:hibernate-core:${hibernateVersion}")
+        ksp("io.github.openfeign.querydsl:querydsl-ksp-codegen:${querydslVersion}")
+        implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.19.0")
+        testImplementation("io.github.openfeign.querydsl:querydsl-jpa:${querydslVersion}")
+        testImplementation("org.assertj:assertj-core:${assertjVersion}")
+        testImplementation("org.hibernate.orm:hibernate-core:${hibernateVersion}")
+        testImplementation("com.h2database:h2:${h2Version}")
+        testImplementation("org.jetbrains.kotlin:kotlin-test-junit:${kotlinVersion}")
 }

querydsl-examples/querydsl-example-ksp-codegen/src/main/kotlin/com/querydsl/example/ksp/Dog.kt

@@ -0,0 +1,17 @@
+package com.querydsl.example.ksp
+
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import jakarta.persistence.Id
+import org.hibernate.annotations.JdbcTypeCode
+import org.hibernate.type.SqlTypes
+
+@Entity
+class Dog(
+    @Id
+    val id: Int,
+    val name: String,
+    @JdbcTypeCode(SqlTypes.JSON)
+    @Column(columnDefinition = "json")
+    val tag: Tag
+)

querydsl-examples/querydsl-example-ksp-codegen/src/main/kotlin/com/querydsl/example/ksp/Tag.kt

@@ -0,0 +1,6 @@
+package com.querydsl.example.ksp
+
+class Tag(
+    val id: Int,
+    val name: String,
+)

querydsl-examples/querydsl-example-ksp-codegen/src/test/kotlin/Tests.kt

@@ -1,10 +1,13 @@
 import com.querydsl.example.ksp.Cat
 import com.querydsl.example.ksp.CatType
+import com.querydsl.example.ksp.Dog
 import com.querydsl.example.ksp.Person
 import com.querydsl.example.ksp.QCat
+import com.querydsl.example.ksp.QDog
 import com.querydsl.example.ksp.QPerson
 import com.querydsl.example.ksp.QPersonClassDTO
 import com.querydsl.example.ksp.QPersonClassConstructorDTO
+import com.querydsl.example.ksp.Tag
 import com.querydsl.jpa.impl.JPAQueryFactory
 import jakarta.persistence.EntityManagerFactory
 import org.hibernate.cfg.AvailableSettings
@@ -162,6 +165,47 @@ class Tests {
         }
     }
 
+    @Test
+    fun `create and query dog with jsonb tag`() {
+        val emf = initialize()
+
+        run {
+            val em = emf.createEntityManager()
+            em.transaction.begin()
+
+            val dogTag = Tag(
+                id = 10,
+                name = "Playful"
+            )
+            em.persist(Dog(300, "Buddy", dogTag))
+
+            em.transaction.commit()
+            em.close()
+        }
+
+        run {
+            val em = emf.createEntityManager()
+            val queryFactory = JPAQueryFactory(em)
+            val q = QDog.dog
+
+            val dog = queryFactory
+                .selectFrom(q)
+                .where(q.name.eq("Buddy"))
+                .fetchOne()
+
+            if (dog == null) {
+                fail<Any>("No dog was returned")
+            } else {
+                assertThat(dog.id).isEqualTo(300)
+                assertThat(dog.name).isEqualTo("Buddy")
+                assertThat(dog.tag.id).isEqualTo(10)
+                assertThat(dog.tag.name).isEqualTo("Playful")
+            }
+
+            em.close()
+        }
+    }
+
     private fun initialize(): EntityManagerFactory {
         val configuration = Configuration()
             .setProperty(AvailableSettings.JAKARTA_JDBC_DRIVER, org.h2.Driver::class.qualifiedName!!)
@@ -170,9 +214,10 @@ class Tests {
             .setProperty(AvailableSettings.SHOW_SQL, "true")
             .addAnnotatedClass(Person::class.java)
             .addAnnotatedClass(Cat::class.java)
+            .addAnnotatedClass(Dog::class.java)
 
         return configuration
             .buildSessionFactory()
             .unwrap(EntityManagerFactory::class.java)
     }
-}
+}

querydsl-tooling/querydsl-ksp-codegen/src/main/kotlin/com/querydsl/ksp/codegen/TypeExtractor.kt

@@ -112,6 +112,7 @@ class TypeExtractor(
     private fun userType(type: KSType): QPropertyType.Unknown? {
         val userTypeAnnotations = listOf(
             ClassName("org.hibernate.annotations", "Type"),
+            ClassName("org.hibernate.annotations", "JdbcTypeCode"),
             Convert::class.asClassName()
         )
         if (property.annotations.any { userTypeAnnotations.contains(it.annotationType.resolve().toClassName()) }) {