use Jackson for serialization, continue to use GSON for users of this client

Author: HighKo

kotlin-jira-client/kotlin-jira-client-sdk/pom.xml

@@ -26,6 +26,16 @@
             <!-- <version>defined by the platform dependency management </version> -->
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${fasterxml.jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.module</groupId>
+            <artifactId>jackson-module-kotlin</artifactId>
+            <version>${fasterxml.jackson.version}</version>
+        </dependency>
 
         <dependency>
             <groupId>com.atlassian.jira</groupId>

kotlin-jira-client/kotlin-jira-client-sdk/src/main/kotlin/com/linkedplanet/kotlinjiraclient/sdk/util/IssueJsonConverter.kt

@@ -29,12 +29,14 @@ import com.atlassian.jira.issue.fields.rest.json.beans.JiraBaseUrls
 import com.atlassian.jira.rest.v2.issue.IncludedFields
 import com.atlassian.jira.rest.v2.issue.IssueBean
 import com.atlassian.jira.rest.v2.issue.builder.BeanBuilderFactory
-import com.google.gson.*
+import com.fasterxml.jackson.databind.JsonNode
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import com.google.gson.JsonObject
+import com.google.gson.JsonParser as GsonJsonParser
 import com.linkedplanet.kotlinjiraclient.api.model.IssueQueryParams
 import com.linkedplanet.kotlinjiraclient.sdk.field.FieldAccessorImpl
 import org.slf4j.LoggerFactory
 import javax.ws.rs.core.UriBuilder
-import javax.xml.bind.annotation.XmlTransient
 
 /**
  * Converts a Jira Issue to Json.
@@ -65,8 +67,6 @@ class IssueJsonConverter {
         }
     private val jiraBaseUrls: JiraBaseUrls = ComponentAccessor.getComponent(JiraBaseUrls::class.java)
     private val uriBuilder: UriBuilder = UriBuilder.fromPath(jiraBaseUrls.restApi2BaseUrl())
-    private val gson = setupGson()
-
 
     @Throws(FieldException::class)
     fun createJsonIssue(
@@ -80,7 +80,11 @@ class IssueJsonConverter {
         this.addOrderableFieldsToBean(issueBean, issue)
         this.addAvailableNavigableFieldsToBean(issueBean, issue)
 
-        return gson.toJsonTree(issueBean).asJsonObject
+        // Jackson is the official way now to serialize Beans. GSON will fail due to infinite loops in the model.
+        val jackson = jacksonObjectMapper()
+        val jacksonJson: JsonNode = jackson.valueToTree(issueBean)
+
+        return GsonJsonParser.parseString(jacksonJson.toString()).asJsonObject // expose as GSON for API compatibility
     }
 
     @Throws(FieldException::class)
@@ -111,17 +115,4 @@ class IssueJsonConverter {
             bean.addField(this, json, false)
         }
     }
-
-    private fun setupGson() =
-        GsonBuilder()
-            .setExclusionStrategies(object : ExclusionStrategy {
-                override fun shouldSkipField(f: FieldAttributes?): Boolean {
-                    return f?.getAnnotation(XmlTransient::class.java) != null
-                }
-
-                override fun shouldSkipClass(clazz: Class<*>?): Boolean {
-                    return false
-                }
-            })
-            .create()
 }

kotlin-jira-client/kotlin-jira-client-test-sdk/pom.xml

@@ -204,6 +204,9 @@
                 <configuration>
                     <banningExcludes>
                         <exclude>com.google.code.gson:gson</exclude>
+                        <exclude>com.fasterxml.jackson.core:jackson-core</exclude>
+                        <exclude>com.fasterxml.jackson.core:jackson-databind</exclude>
+                        <exclude>com.fasterxml.jackson.core:jackson-annotations</exclude>
                     </banningExcludes>
                     <productVersion>${jira.version}</productVersion>
                     <productDataVersion>${jira.version}</productDataVersion>

pom.xml

@@ -41,6 +41,8 @@
         <insight.version>10.12.1-QR-0157</insight.version>
         <confluence.version>9.2.3</confluence.version>
         <atlassian-plugins-osgi-testrunner.version>2.0.9</atlassian-plugins-osgi-testrunner.version>
+        <!-- fasterxml.jackson.version is defined inside platform 6.5 deps, but not exposed -->
+        <fasterxml.jackson.version>2.16.2</fasterxml.jackson.version>
     </properties>
 
     <dependencies>