feat: migrate DAO from Hibernate to jOOQ

not really a feature, but the change is significant enough to warrant a release
tahngarth · Jun 1, 2020 · 75e1079 · 75e1079
1 parent de953a4
commit 75e1079
Show file tree

Hide file tree

Showing 127 changed files with 4,886 additions and 2,596 deletions.
diff --git a/.idea/runConfigurations/komga__bootRun__dev_noflyway.xml b/.idea/runConfigurations/komga__bootRun__dev_noflyway.xml
diff --git a/.idea/runConfigurations/komga__bootRun__generatesql.xml b/.idea/runConfigurations/komga__bootRun__generatesql.xml
diff --git a/komga-webui/src/types/komga-users.ts b/komga-webui/src/types/komga-users.ts
@@ -13,8 +13,7 @@ interface UserWithSharedLibrariesDto {
 }
 
 interface SharedLibraryDto {
-  id: number,
-  name: string
+  id: number
 }
 
 interface UserCreationDto {

diff --git a/komga/build.gradle.kts b/komga/build.gradle.kts
@@ -1,3 +1,8 @@
+import com.rohanprabhu.gradle.plugins.kdjooq.database
+import com.rohanprabhu.gradle.plugins.kdjooq.generator
+import com.rohanprabhu.gradle.plugins.kdjooq.jdbc
+import com.rohanprabhu.gradle.plugins.kdjooq.jooqCodegenConfiguration
+import com.rohanprabhu.gradle.plugins.kdjooq.target
 import org.apache.tools.ant.taskdefs.condition.Os
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
@@ -11,9 +16,10 @@ plugins {
     kotlin("kapt") version kotlinVersion
   }
   id("org.springframework.boot") version "2.2.6.RELEASE"
-  id("io.spring.dependency-management") version "1.0.9.RELEASE"
   id("com.github.ben-manes.versions") version "0.28.0"
   id("com.gorylenko.gradle-git-properties") version "2.2.2"
+  id("com.rohanprabhu.kotlin-dsl-jooq") version "0.4.5"
+  id("org.flywaydb.flyway") version "6.4.0"
   jacoco
 }
 
@@ -25,50 +31,51 @@ configurations.runtimeClasspath.get().extendsFrom(developmentOnly)
 repositories {
   jcenter()
   mavenCentral()
-  maven("https://jitpack.io")
 }
 
 dependencies {
   implementation(kotlin("stdlib-jdk8"))
   implementation(kotlin("reflect"))
 
+  constraints {
+    implementation("org.flywaydb:flyway-core:6.4.0") {
+      because("support for H2 1.4.200 requires 6.1.0+")
+    }
+  }
+
+  implementation(platform("org.springframework.boot:spring-boot-dependencies:2.2.6.RELEASE"))
+
   implementation("org.springframework.boot:spring-boot-starter-web")
-  implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+  implementation("org.springframework.boot:spring-boot-starter-data-jdbc")
   implementation("org.springframework.boot:spring-boot-starter-actuator")
-  implementation("org.springframework.boot:spring-boot-starter-cache")
   implementation("org.springframework.boot:spring-boot-starter-security")
   implementation("org.springframework.boot:spring-boot-starter-thymeleaf")
   implementation("org.springframework.boot:spring-boot-starter-artemis")
+  implementation("org.springframework.boot:spring-boot-starter-jooq")
 
-  kapt("org.springframework.boot:spring-boot-configuration-processor")
+  kapt("org.springframework.boot:spring-boot-configuration-processor:2.2.6.RELEASE")
 
   implementation("org.apache.activemq:artemis-jms-server")
 
   implementation("org.flywaydb:flyway-core")
-  implementation("org.hibernate:hibernate-jcache")
-
-  implementation("com.github.ben-manes.caffeine:caffeine")
-  implementation("com.github.ben-manes.caffeine:jcache")
 
   implementation("io.github.microutils:kotlin-logging:1.7.9")
   implementation("io.micrometer:micrometer-registry-influx")
   implementation("io.hawt:hawtio-springboot:2.10.0")
 
   run {
-    val springdocVersion = "1.3.3"
+    val springdocVersion = "1.3.4"
     implementation("org.springdoc:springdoc-openapi-ui:$springdocVersion")
     implementation("org.springdoc:springdoc-openapi-security:$springdocVersion")
   }
 
   implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
   implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-xml")
 
-  implementation("com.github.klinq:klinq-jpaspec:0.9")
-
   implementation("commons-io:commons-io:2.6")
   implementation("org.apache.commons:commons-lang3:3.10")
 
-  implementation("org.apache.tika:tika-core:1.24")
+  implementation("org.apache.tika:tika-core:1.24.1")
   implementation("org.apache.commons:commons-compress:1.20")
   implementation("com.github.junrar:junrar:4.0.0")
   implementation("org.apache.pdfbox:pdfbox:2.0.19")
@@ -85,21 +92,23 @@ dependencies {
 
   implementation("com.jakewharton.byteunits:byteunits:0.9.1")
 
-  runtimeOnly("com.h2database:h2")
+  runtimeOnly("com.h2database:h2:1.4.200")
+  jooqGeneratorRuntime("com.h2database:h2:1.4.200")
 
   testImplementation("org.springframework.boot:spring-boot-starter-test") {
     exclude(module = "mockito-core")
   }
   testImplementation("org.springframework.security:spring-security-test")
   testImplementation("com.ninja-squad:springmockk:2.0.1")
-  testImplementation("io.mockk:mockk:1.9.3")
+  testImplementation("io.mockk:mockk:1.10.0")
   testImplementation("com.google.jimfs:jimfs:1.1")
 
   testImplementation("com.tngtech.archunit:archunit-junit5:0.13.1")
 
   developmentOnly("org.springframework.boot:spring-boot-devtools")
 }
 
+val webui = "$rootDir/komga-webui"
 tasks {
   withType<KotlinCompile> {
     kotlinOptions {
@@ -119,20 +128,18 @@ tasks {
     }
   }
 
-  register<Copy>("unpack") {
+  //unpack Spring Boot's fat jar for better Docker image layering
+  register<Sync>("unpack") {
     dependsOn(bootJar)
     from(zipTree(getByName("bootJar").outputs.files.singleFile))
     into("$buildDir/dependency")
   }
 
-  register<Delete>("deletePublic") {
-    group = "web"
-    delete("$projectDir/src/main/resources/public/")
-  }
-
   register<Exec>("npmInstall") {
     group = "web"
-    workingDir("$rootDir/komga-webui")
+    workingDir(webui)
+    inputs.file("$webui/package.json")
+    outputs.dir("$webui/node_modules")
     commandLine(
       if (Os.isFamily(Os.FAMILY_WINDOWS)) {
         "npm.cmd"
@@ -146,7 +153,9 @@ tasks {
   register<Exec>("npmBuild") {
     group = "web"
     dependsOn("npmInstall")
-    workingDir("$rootDir/komga-webui")
+    workingDir(webui)
+    inputs.dir(webui)
+    outputs.dir("$webui/dist")
     commandLine(
       if (Os.isFamily(Os.FAMILY_WINDOWS)) {
         "npm.cmd"
@@ -158,20 +167,93 @@ tasks {
     )
   }
 
-  register<Copy>("copyWebDist") {
+  //copy the webui build into public
+  register<Sync>("copyWebDist") {
     group = "web"
-    dependsOn("deletePublic", "npmBuild")
-    from("$rootDir/komga-webui/dist/")
+    dependsOn("npmBuild")
+    from("$webui/dist/")
     into("$projectDir/src/main/resources/public/")
   }
 }
 
 springBoot {
-  buildInfo()
+  buildInfo {
+    properties {
+      // prevent task bootBuildInfo to rerun every time
+      time = null
+    }
+  }
 }
 
 allOpen {
   annotation("javax.persistence.Entity")
   annotation("javax.persistence.MappedSuperclass")
   annotation("javax.persistence.Embeddable")
 }
+
+sourceSets {
+  //add a flyway sourceSet
+  val flyway by creating {
+    compileClasspath += sourceSets.main.get().compileClasspath
+    runtimeClasspath += sourceSets.main.get().runtimeClasspath
+  }
+  //main sourceSet depends on the output of flyway sourceSet
+  main {
+    output.dir(flyway.output)
+  }
+}
+
+val jooqDb = mapOf(
+  "url" to "jdbc:h2:${project.buildDir}/generated/flyway/h2",
+  "schema" to "PUBLIC",
+  "user" to "sa",
+  "password" to ""
+)
+val migrationDirs = listOf(
+  "$projectDir/src/flyway/resources/db/migration",
+  "$projectDir/src/flyway/kotlin/db/migration"
+)
+flyway {
+  url = jooqDb["url"]
+  user = jooqDb["user"]
+  password = jooqDb["password"]
+  schemas = arrayOf(jooqDb["schema"])
+  locations = arrayOf("classpath:db/migration")
+}
+//in order to include the Java migrations, flywayClasses must be run before flywayMigrate
+tasks.flywayMigrate {
+  dependsOn("flywayClasses")
+  migrationDirs.forEach { inputs.dir(it) }
+  outputs.dir("${project.buildDir}/generated/flyway")
+  doFirst { delete(outputs.files) }
+}
+
+jooqGenerator {
+  jooqVersion = "3.13.1"
+  configuration("primary", project.sourceSets.getByName("main")) {
+    databaseSources = migrationDirs
+
+    configuration = jooqCodegenConfiguration {
+      jdbc {
+        username = jooqDb["user"]
+        password = jooqDb["password"]
+        driver = "org.h2.Driver"
+        url = jooqDb["url"]
+      }
+
+      generator {
+        target {
+          packageName = "org.gotson.komga.jooq"
+          directory = "${project.buildDir}/generated/jooq/primary"
+        }
+
+        database {
+          name = "org.jooq.meta.h2.H2Database"
+          inputSchema = jooqDb["schema"]
+        }
+      }
+    }
+  }
+}
+val `jooq-codegen-primary` by project.tasks
+`jooq-codegen-primary`.dependsOn("flywayMigrate")
diff --git a/...0926114415__create_library_from_series.kt → ...0926114415__create_library_from_series.kt b/...0926114415__create_library_from_series.kt → ...0926114415__create_library_from_series.kt
diff --git a/...34__create_series_metadata_from_series.kt → ...34__create_series_metadata_from_series.kt b/...34__create_series_metadata_from_series.kt → ...34__create_series_metadata_from_series.kt
diff --git a/...175848__create_book_metadata_from_book.kt → ...175848__create_book_metadata_from_book.kt b/...175848__create_book_metadata_from_book.kt → ...175848__create_book_metadata_from_book.kt
diff --git a/...ration/V20190819161603__First_Version.sql → ...ration/V20190819161603__First_Version.sql b/...ration/V20190819161603__First_Version.sql → ...ration/V20190819161603__First_Version.sql
diff --git a/...0190906100609__regenerate_webp_covers.sql → ...0190906100609__regenerate_webp_covers.sql b/...0190906100609__regenerate_webp_covers.sql → ...0190906100609__regenerate_webp_covers.sql
diff --git a/...on/V20190906152334__reparse_pdf_files.sql → ...on/V20190906152334__reparse_pdf_files.sql b/...on/V20190906152334__reparse_pdf_files.sql → ...on/V20190906152334__reparse_pdf_files.sql
diff --git a/...on/V20190907104615__reparse_pdf_files.sql → ...on/V20190907104615__reparse_pdf_files.sql b/...on/V20190907104615__reparse_pdf_files.sql → ...on/V20190907104615__reparse_pdf_files.sql
diff --git a/...on/V20190907143337__reparse_pdf_files.sql → ...on/V20190907143337__reparse_pdf_files.sql b/...on/V20190907143337__reparse_pdf_files.sql → ...on/V20190907143337__reparse_pdf_files.sql
diff --git a/...ration/V20190910082852__rescan_series.sql → ...ration/V20190910082852__rescan_series.sql b/...ration/V20190910082852__rescan_series.sql → ...ration/V20190910082852__rescan_series.sql
diff --git a/...ation/V20190926112211__library_entity.sql → ...ation/V20190926112211__library_entity.sql b/...ation/V20190926112211__library_entity.sql → ...ation/V20190926112211__library_entity.sql
diff --git a/...0927132225__serie_library_id_not_null.sql → ...0927132225__serie_library_id_not_null.sql b/...0927132225__serie_library_id_not_null.sql → ...0927132225__serie_library_id_not_null.sql
diff --git a/...0191008135338__rename_serie_to_series.sql → ...0191008135338__rename_serie_to_series.sql b/...0191008135338__rename_serie_to_series.sql → ...0191008135338__rename_serie_to_series.sql
diff --git a/...mbnails_to_force_regeneration_in_jpeg.sql → ...mbnails_to_force_regeneration_in_jpeg.sql b/...mbnails_to_force_regeneration_in_jpeg.sql → ...mbnails_to_force_regeneration_in_jpeg.sql
diff --git a/...igration/V20191014143703__user_entity.sql → ...igration/V20191014143703__user_entity.sql b/...igration/V20191014143703__user_entity.sql → ...igration/V20191014143703__user_entity.sql
diff --git a/...V20191021101906__user_library_sharing.sql → ...V20191021101906__user_library_sharing.sql b/...V20191021101906__user_library_sharing.sql → ...V20191021101906__user_library_sharing.sql
diff --git a/...ration/V20191029153618__book_filesize.sql → ...ration/V20191029153618__book_filesize.sql b/...ration/V20191029153618__book_filesize.sql → ...ration/V20191029153618__book_filesize.sql
diff --git a/...igration/V20191122164159__book_number.sql → ...igration/V20191122164159__book_number.sql b/...igration/V20191122164159__book_number.sql → ...igration/V20191122164159__book_number.sql
diff --git a/...91230131239__rename_metadata_to_media.sql → ...91230131239__rename_metadata_to_media.sql b/...91230131239__rename_metadata_to_media.sql → ...91230131239__rename_metadata_to_media.sql
diff --git a/...0103170613__media_as_auditable_entity.sql → ...0103170613__media_as_auditable_entity.sql b/...0103170613__media_as_auditable_entity.sql → ...0103170613__media_as_auditable_entity.sql
diff --git a/...ration/V20200108103325__media_comment.sql → ...ration/V20200108103325__media_comment.sql b/...ration/V20200108103325__media_comment.sql → ...ration/V20200108103325__media_comment.sql
diff --git a/...tion/V20200121153351__series_metadata.sql → ...tion/V20200121153351__series_metadata.sql b/...tion/V20200121153351__series_metadata.sql → ...tion/V20200121153351__series_metadata.sql
diff --git a/...21154845__series_metadata_id_not_null.sql → ...21154845__series_metadata_id_not_null.sql b/...21154845__series_metadata_id_not_null.sql → ...21154845__series_metadata_id_not_null.sql
diff --git a/...20200131101624__series_metadata_title.sql → ...20200131101624__series_metadata_title.sql b/...20200131101624__series_metadata_title.sql → ...20200131101624__series_metadata_title.sql
diff --git a/...n/V20200306174948__book_number_to_int.sql → ...n/V20200306174948__book_number_to_int.sql b/...n/V20200306174948__book_number_to_int.sql → ...n/V20200306174948__book_number_to_int.sql
diff --git a/...ration/V20200306175821__book_metadata.sql → ...ration/V20200306175821__book_metadata.sql b/...ration/V20200306175821__book_metadata.sql → ...ration/V20200306175821__book_metadata.sql
diff --git a/...igration/V20200402103754__media_files.sql → ...igration/V20200402103754__media_files.sql b/...igration/V20200402103754__media_files.sql → ...igration/V20200402103754__media_files.sql
diff --git a/...0200410115036__rescan_series_for_epub.sql → ...0200410115036__rescan_series_for_epub.sql b/...0200410115036__rescan_series_for_epub.sql → ...0200410115036__rescan_series_for_epub.sql