Replacing SpringBoot 2 by SpringBoot 3, handling Hibernate changes as well, fixing tests.

Author: kinow

pom.xml

@@ -15,7 +15,7 @@
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
-    <version>2.7.18</version>
+    <version>3.1.4</version>
     <relativePath/>
   </parent>
 
@@ -68,12 +68,25 @@
     <dependency>
       <groupId>org.springframework.data</groupId>
       <artifactId>spring-data-commons</artifactId>
-      <version>2.7.18</version>
     </dependency>
     <dependency>
-      <groupId>com.vladmihalcea</groupId>
-      <artifactId>hibernate-types-55</artifactId>
-      <version>2.21.1</version>
+      <groupId>org.springframework.data</groupId>
+      <artifactId>spring-data-jpa</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>jakarta.persistence</groupId>
+      <artifactId>jakarta.persistence-api</artifactId>
+      <version>3.1.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.hypersistence</groupId>
+      <artifactId>hypersistence-utils-hibernate-62</artifactId>
+      <version>3.8.2</version>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.module</groupId>
+      <artifactId>jackson-module-jakarta-xmlbind-annotations</artifactId>
+      <version>2.17.2</version>
     </dependency>
     <!-- Liquibase; note that Flyway, while probably having more documentation and users,
          changed its license model. Similarly to mongo, we prefer an open license that

src/main/java/org/commonwl/view/CwlViewerApplication.java

@@ -21,12 +21,14 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
 import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.scheduling.annotation.EnableScheduling;
 import org.springframework.transaction.annotation.EnableTransactionManagement;
 
 @SpringBootApplication
 @EnableAsync
+@EnableJpaRepositories
 @EnableScheduling
 @EnableTransactionManagement
 public class CwlViewerApplication {

src/main/java/org/commonwl/view/cwl/CWLValidationException.java

@@ -19,7 +19,7 @@
 
 package org.commonwl.view.cwl;
 
-import javax.validation.ValidationException;
+import jakarta.validation.ValidationException;
 
 /** Exception thrown when a workflow failed CWLTool validation */
 public class CWLValidationException extends ValidationException {

src/main/java/org/commonwl/view/git/GitDetails.java

@@ -19,6 +19,7 @@
 
 package org.commonwl.view.git;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -34,7 +35,7 @@
 
 /** Represents all the parameters necessary to access a file/directory with Git */
 @JsonIgnoreProperties(
-    value = {"internalUrl"},
+    value = {"internalUrl", "logger"},
     ignoreUnknown = true)
 public class GitDetails implements Serializable {
 
@@ -45,6 +46,7 @@ public class GitDetails implements Serializable {
   private String path;
   private String packedId;
 
+  @JsonCreator
   public GitDetails(String repoUrl, String branch, String path) {
     this.repoUrl = repoUrl;
 
@@ -110,16 +112,12 @@ public GitType getType() {
       if (domain.startsWith("www.")) {
         domain = domain.substring(4);
       }
-      switch (domain) {
-        case "github.com":
-          return GitType.GITHUB;
-        case "gitlab.com":
-          return GitType.GITLAB;
-        case "bitbucket.org":
-          return GitType.BITBUCKET;
-        default:
-          return GitType.GENERIC;
-      }
+      return switch (domain) {
+        case "github.com" -> GitType.GITHUB;
+        case "gitlab.com" -> GitType.GITLAB;
+        case "bitbucket.org" -> GitType.BITBUCKET;
+        default -> GitType.GENERIC;
+      };
     } catch (URISyntaxException ex) {
       return GitType.GENERIC;
     }
@@ -133,27 +131,25 @@ public GitType getType() {
    */
   public String getUrl(String branchOverride) {
     String packedPart = packedId == null ? "" : "#" + packedId;
-    switch (getType()) {
-      case GITHUB:
-      case GITLAB:
-        return "https://"
-            + normaliseUrl(repoUrl).replace(".git", "")
-            + "/blob/"
-            + branchOverride
-            + "/"
-            + path
-            + packedPart;
-      case BITBUCKET:
-        return "https://"
-            + normaliseUrl(repoUrl).replace(".git", "")
-            + "/src/"
-            + branchOverride
-            + "/"
-            + path
-            + packedPart;
-      default:
-        return repoUrl;
-    }
+    return switch (getType()) {
+      case GITHUB, GITLAB ->
+          "https://"
+              + normaliseUrl(repoUrl).replace(".git", "")
+              + "/blob/"
+              + branchOverride
+              + "/"
+              + path
+              + packedPart;
+      case BITBUCKET ->
+          "https://"
+              + normaliseUrl(repoUrl).replace(".git", "")
+              + "/src/"
+              + branchOverride
+              + "/"
+              + path
+              + packedPart;
+      default -> repoUrl;
+    };
   }
 
   /**
@@ -174,18 +170,17 @@ public String getUrl() {
   public String getInternalUrl(String branchOverride) {
     String packedPart = packedId == null ? "" : "%23" + packedId;
     String pathPart = path.equals("/") ? "" : "/" + path;
-    switch (getType()) {
-      case GITHUB:
-      case GITLAB:
-        return "/workflows/"
-            + normaliseUrl(repoUrl).replace(".git", "")
-            + "/blob/"
-            + branchOverride
-            + pathPart
-            + packedPart;
-      default:
-        return "/workflows/" + normaliseUrl(repoUrl) + "/" + branchOverride + pathPart + packedPart;
-    }
+    return switch (getType()) {
+      case GITHUB, GITLAB ->
+          "/workflows/"
+              + normaliseUrl(repoUrl).replace(".git", "")
+              + "/blob/"
+              + branchOverride
+              + pathPart
+              + packedPart;
+      default ->
+          "/workflows/" + normaliseUrl(repoUrl) + "/" + branchOverride + pathPart + packedPart;
+    };
   }
 
   /**
@@ -211,25 +206,23 @@ public String getRawUrl(String branchOverride, String pathOverride) {
     if (pathOverride == null) {
       pathOverride = path;
     }
-    switch (getType()) {
-      case GITHUB:
-        return "https://raw.githubusercontent.com/"
-            + normaliseUrl(repoUrl).replace("github.com/", "").replace(".git", "")
-            + "/"
-            + branchOverride
-            + "/"
-            + pathOverride;
-      case GITLAB:
-      case BITBUCKET:
-        return "https://"
-            + normaliseUrl(repoUrl).replace(".git", "")
-            + "/raw/"
-            + branchOverride
-            + "/"
-            + pathOverride;
-      default:
-        return repoUrl;
-    }
+    return switch (getType()) {
+      case GITHUB ->
+          "https://raw.githubusercontent.com/"
+              + normaliseUrl(repoUrl).replace("github.com/", "").replace(".git", "")
+              + "/"
+              + branchOverride
+              + "/"
+              + pathOverride;
+      case GITLAB, BITBUCKET ->
+          "https://"
+              + normaliseUrl(repoUrl).replace(".git", "")
+              + "/raw/"
+              + branchOverride
+              + "/"
+              + pathOverride;
+      default -> repoUrl;
+    };
   }
 
   /**

src/main/java/org/commonwl/view/git/GitLicenseException.java

@@ -1,6 +1,6 @@
 package org.commonwl.view.git;
 
-import javax.validation.ValidationException;
+import jakarta.validation.ValidationException;
 
 public class GitLicenseException extends ValidationException {
 

src/main/java/org/commonwl/view/util/BaseEntity.java

@@ -1,10 +1,6 @@
 package org.commonwl.view.util;
 
-import com.vladmihalcea.hibernate.type.json.JsonBinaryType;
-import javax.persistence.MappedSuperclass;
-import org.hibernate.annotations.TypeDef;
-import org.hibernate.annotations.TypeDefs;
+import jakarta.persistence.MappedSuperclass;
 
-@TypeDefs({@TypeDef(name = "json", typeClass = JsonBinaryType.class)})
 @MappedSuperclass
 public class BaseEntity {}

src/main/java/org/commonwl/view/workflow/QueuedWorkflow.java

@@ -2,16 +2,17 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.hypersistence.utils.hibernate.type.json.JsonType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Convert;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
 import java.io.Serializable;
 import java.util.List;
 import java.util.Objects;
-import javax.persistence.Column;
-import javax.persistence.Convert;
-import javax.persistence.Entity;
-import javax.persistence.GeneratedValue;
-import javax.persistence.GenerationType;
-import javax.persistence.Id;
-import javax.persistence.Table;
 import org.commonwl.view.cwl.CWLToolStatus;
 import org.commonwl.view.util.BaseEntity;
 import org.hibernate.annotations.GenericGenerator;
@@ -22,7 +23,6 @@
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 @Entity
 @Table(name = "queued_workflow")
-@SuppressWarnings("JpaAttributeTypeInspection")
 public class QueuedWorkflow extends BaseEntity implements Serializable {
 
   // ID for database
@@ -34,20 +34,20 @@ public class QueuedWorkflow extends BaseEntity implements Serializable {
 
   // Very barebones workflow to build loading thumbnail and overview
   @Column(columnDefinition = "jsonb")
-  @Type(type = "json")
+  @Type(value = JsonType.class)
   @Convert(disableConversion = true)
   private Workflow tempRepresentation;
 
   // List of packed workflows for packed workflows
   // TODO: Refactor so this is not necessary
   @Column(columnDefinition = "jsonb")
-  @Type(type = "json")
+  @Type(value = JsonType.class)
   @Convert(disableConversion = true)
   private List<WorkflowOverview> workflowList;
 
   // Cwltool details
   @Column(columnDefinition = "jsonb")
-  @Type(type = "json")
+  @Type(value = JsonType.class)
   @Convert(disableConversion = true)
   private CWLToolStatus cwltoolStatus = CWLToolStatus.RUNNING;
 

src/main/java/org/commonwl/view/workflow/QueuedWorkflowRepository.java

@@ -5,6 +5,7 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Modifying;
 import org.springframework.data.jpa.repository.Query;
+import org.springframework.stereotype.Repository;
 import org.springframework.transaction.annotation.Transactional;
 
 /**
@@ -13,6 +14,7 @@
  * <p>Use only queries without objects and JSON here. For other methods use the Impl class to avoid
  * issues with serialization.
  */
+@Repository
 public interface QueuedWorkflowRepository
     extends JpaRepository<QueuedWorkflow, String>, QueuedWorkflowRepositoryCustom {
 

src/main/java/org/commonwl/view/workflow/QueuedWorkflowRepositoryImpl.java

@@ -1,8 +1,8 @@
 package org.commonwl.view.workflow;
 
-import com.vladmihalcea.hibernate.type.json.JsonBinaryType;
-import javax.persistence.EntityManager;
-import javax.persistence.PersistenceContext;
+import io.hypersistence.utils.hibernate.type.json.JsonType;
+import jakarta.persistence.EntityManager;
+import jakarta.persistence.PersistenceContext;
 import org.commonwl.view.git.GitDetails;
 import org.hibernate.query.Query;
 
@@ -19,12 +19,19 @@ public class QueuedWorkflowRepositoryImpl implements QueuedWorkflowRepositoryCus
 
   @Override
   public QueuedWorkflow findByRetrievedFrom(GitDetails retrievedFrom) {
+    // N.B. The migration from Spring Boot 2 to 3 got blocked for a while as
+    //      we couldn't figure out a way to get the mapping of types to work.
+    //      We always ended up the error about the invalid operator for the
+    //      jsonb = bytea types. Found this comment from the author of the
+    //      mapping library we use, with what was the fix for our issue (ran
+    //      out of ideas, so started testing everything found online):
+    //      Use `new JsonType(GitDetails.class)`. That finally solved it.
+    //      Ref: https://github.com/common-workflow-language/cwlviewer/pull/568
     return (QueuedWorkflow)
         entityManager
             .createNativeQuery(QUERY_FIND_BY_RETRIEVED_FROM, QueuedWorkflow.class)
             .unwrap(Query.class)
-            .setParameter("retrievedFrom", retrievedFrom, JsonBinaryType.INSTANCE)
-            .getResultList()
+            .setParameter("retrievedFrom", retrievedFrom, new JsonType(GitDetails.class))
             .stream()
             .findFirst()
             .orElse(null);
@@ -35,7 +42,7 @@ public void deleteByTempRepresentation_RetrievedFrom(GitDetails retrievedFrom) {
     entityManager
         .createNativeQuery(QUERY_DELETE_BY_RETRIEVED_FROM, QueuedWorkflow.class)
         .unwrap(Query.class)
-        .setParameter("retrievedFrom", retrievedFrom, JsonBinaryType.INSTANCE)
+        .setParameter("retrievedFrom", retrievedFrom, new JsonType(GitDetails.class))
         .executeUpdate();
   }
 }