Merge pull request #22 from linked-planet/feature/improve_errors

Feature/improve errors

Author: HighKo

kotlin-atlassian-client-core-common/src/main/kotlin/com/linkedplanet/kotlinatlassianclientcore/common/api/Page.kt

@@ -56,4 +56,12 @@ open class Page<T> (
         return "Page(items=$items, totalItems=$totalItems, totalPages=$totalPages, currentPageIndex=$currentPageIndex, pageSize=$pageSize)"
     }
 
+    fun <T> copy(items: List<T>): Page<T> =
+        Page(
+            items = items,
+            totalItems = this.totalItems,
+            totalPages = this.totalPages,
+            currentPageIndex = this.currentPageIndex,
+            pageSize = this.pageSize,
+        )
 }

kotlin-atlassian-client-core-common/src/main/kotlin/com/linkedplanet/kotlinatlassianclientcore/common/error/AtlassianClientError.kt

@@ -27,7 +27,8 @@ import javax.validation.constraints.NotNull
 open class AtlassianClientError(
     @field:NotNull val error: String,
     @field:NotNull val message: String,
-    @field:NotNull val stacktrace: String = ""
+    @field:NotNull val stacktrace: String = "",
+    val statusCode: Int? = null
 ) {
 
     override fun equals(other: Any?): Boolean {
@@ -37,6 +38,7 @@ open class AtlassianClientError(
         if (error != other.error) return false
         if (message != other.message) return false
         if (stacktrace != other.stacktrace) return false
+        if (statusCode != other.statusCode) return false
 
         return true
     }
@@ -45,11 +47,12 @@ open class AtlassianClientError(
         var result = error.hashCode()
         result = 31 * result + message.hashCode()
         result = 31 * result + stacktrace.hashCode()
+        result = 31 * result + (statusCode ?: 0)
         return result
     }
 
     override fun toString(): String {
-        return "AtlassianClientError(error='$error', message='$message', stacktrace='$stacktrace')"
+        return "AtlassianClientError(error='$error', message='$message', stacktrace='$stacktrace', httpStatusCode=$statusCode)"
     }
 
     companion object

kotlin-insight-client/kotlin-insight-client-api/src/main/kotlin/com/linkedplanet/kotlininsightclient/api/error/InsightClientError.kt

@@ -47,8 +47,9 @@ import io.swagger.v3.oas.annotations.media.Schema
 sealed class InsightClientError(
     error: String,
     message: String,
-    stacktrace: String = ""
-) : AtlassianClientError(error, message, stacktrace) {
+    stacktrace: String = "",
+    statusCode: Int? = null
+) : AtlassianClientError(error, message, stacktrace, statusCode) {
 
     companion object {
         private const val internalErrorString = "Jira/Insight hat ein internes Problem festgestellt"
@@ -81,6 +82,9 @@ open class OtherInsightClientError(error: String, message: String) : InsightClie
 /**
  * Somewhere inside an HTTP connection failed.
  */
-class HttpInsightClientError(val statusCode: Int, error: String, message: String) : InsightClientError(error,
-    "$message StatusCode:$statusCode"
+class HttpInsightClientError(statusCode: Int, error: String, message: String) :
+    InsightClientError(
+        error = error,
+        message = "$message StatusCode:$statusCode",
+        statusCode = statusCode
 )

kotlin-jira-client/kotlin-jira-client-api/src/main/kotlin/com/linkedplanet/kotlinjiraclient/api/error/JiraClientError.kt

@@ -25,8 +25,9 @@ import com.linkedplanet.kotlinatlassianclientcore.common.error.AtlassianClientEr
 open class JiraClientError(
     error: String,
     message: String,
-    stacktrace: String = ""
-) : AtlassianClientError(error, message, stacktrace) {
+    stacktrace: String = "",
+    statusCode: Int? = null // http status code equivalent
+) : AtlassianClientError(error, message, stacktrace, statusCode) {
 
     companion object
 }

kotlin-jira-client/kotlin-jira-client-http/src/main/kotlin/com/linkedplanet/kotlinjiraclient/http/HttpJiraUserOperator.kt

@@ -132,7 +132,8 @@ class HttpJiraUserOperator(private val context: HttpJiraClientContext) : JiraUse
 
             else -> JiraClientError(
                 "Unknown actor type",
-                "Actor type ${actor.type} for actor ${actor.name} is not known."
+                "Actor type ${actor.type} for actor ${actor.name} is not known.",
+                statusCode = 404
             ).left()
         }
 

kotlin-jira-client/kotlin-jira-client-http/src/main/kotlin/com/linkedplanet/kotlinjiraclient/http/util/JiraClientErrorExtension.kt

@@ -23,4 +23,4 @@ import com.linkedplanet.kotlinhttpclient.error.HttpDomainError
 import com.linkedplanet.kotlinjiraclient.api.error.JiraClientError
 
 fun JiraClientError.Companion.fromHttpDomainError(e: HttpDomainError): JiraClientError =
-    JiraClientError(e.error, e.message, "HttpStatusCode-${e.statusCode}")
+    JiraClientError(e.error, e.message, "HttpStatusCode-${e.statusCode}", statusCode = e.statusCode)

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

@@ -57,7 +57,7 @@ object SdkJiraIssueLinkOperator : JiraIssueLinkOperator {
         }
 
     private fun issueLinkTypeNotFound(relationName: String): Either<JiraClientError, Unit> = Either.Left(
-        JiraClientError("IssueLinkType not found", "No IssueLinkType named $relationName found.")
+        JiraClientError("IssueLinkType not found", "No IssueLinkType named $relationName found.", statusCode = 404)
     )
 
     override suspend fun deleteIssueLink(linkId: String): Either<JiraClientError, Unit> =

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

@@ -54,13 +54,13 @@ import kotlin.math.ceil
 object SdkJiraIssueOperator : JiraIssueOperator<SdkJiraField> {
     override var RESULTS_PER_PAGE: Int = 10
 
-    private val issueService by lazy { ComponentAccessor.getIssueService() }
-    private val customFieldManager by lazy { ComponentAccessor.getCustomFieldManager() }
-    private val searchService: SearchService by lazy { ComponentAccessor.getComponent(SearchService::class.java) }
-    private val jiraAuthenticationContext by lazy { ComponentAccessor.getJiraAuthenticationContext() }
-    private val jqlParser by lazy { ComponentAccessor.getComponent(JqlQueryParser::class.java) }
-    private val applicationProperties by lazy { ComponentAccessor.getApplicationProperties() }
-    private val webResourceUrlProvider by lazy { ComponentAccessor.getWebResourceUrlProvider() }
+    private val issueService = ComponentAccessor.getIssueService()
+    private val customFieldManager = ComponentAccessor.getCustomFieldManager()
+    private val searchService: SearchService = ComponentAccessor.getComponent(SearchService::class.java)
+    private val jiraAuthenticationContext = ComponentAccessor.getJiraAuthenticationContext()
+    private val jqlParser = ComponentAccessor.getComponent(JqlQueryParser::class.java)
+    private val applicationProperties = ComponentAccessor.getApplicationProperties()
+    private val webResourceUrlProvider = ComponentAccessor.getWebResourceUrlProvider()
     private val issueJsonConverter = IssueJsonConverter()
 
     private fun user() = jiraAuthenticationContext.loggedInUser
@@ -146,7 +146,10 @@ object SdkJiraIssueOperator : JiraIssueOperator<SdkJiraField> {
         val httpStatusSuffix = worstReason?.let { " (${it.httpStatusCode})" } ?: ""
         return JiraClientError(
             errorTitle,
-            errorCollection.errorMessages.joinToString() + httpStatusSuffix
+            errorCollection.errorMessages.joinToString(",\n")
+                    + errorCollection.errors.map { "'$it.key':${it.value}" }.joinToString(",\n")
+                    + httpStatusSuffix,
+            statusCode = worstReason?.httpStatusCode
         )
     }
 
@@ -217,7 +220,7 @@ object SdkJiraIssueOperator : JiraIssueOperator<SdkJiraField> {
     private suspend fun <T> issueToConcreteType(
         issue: Issue,
         parser: suspend (JsonObject, Map<String, String>) -> Either<JiraClientError, T>
-    ): Either<JiraClientError, T> {
+    ): Either<JiraClientError, T> = Either.catchJiraClientError {
         val jsonIssue: JsonObject = issueJsonConverter.createJsonIssue(issue)
         val customFieldMap = customFieldManager.getCustomFieldObjects(issue).associate { it.name to it.id }
         return parser(jsonIssue, customFieldMap)
@@ -229,8 +232,8 @@ object SdkJiraIssueOperator : JiraIssueOperator<SdkJiraField> {
         parser: suspend (JsonObject, Map<String, String>) -> Either<JiraClientError, T>
     ): Either<JiraClientError, Page<T>> = either {
         val user = userOrError().bind()
-        val query = jqlParser.parseQuery(jql)
-        val search = searchService.search(user, query, pagerFilter)
+        val query = Either.catchJiraClientError { jqlParser.parseQuery(jql) }.bind()
+        val search = Either.catchJiraClientError { searchService.search(user, query, pagerFilter) }.bind()
         val issues = search.results
             .map { issue -> issueToConcreteType(issue, parser) }
             .bindAll()

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

@@ -70,7 +70,10 @@ object SdkJiraTransitionOperator : JiraTransitionOperator {
         }
 
     private fun createTransitionIdNoIntError(transitionId: String) =
-        JiraClientError("Illegal Argument", "Transition with id $transitionId must be of type Int.")
+        JiraClientError("Illegal Argument",
+            "Transition with id $transitionId must be of type Int.",
+            statusCode = 400
+        )
 
     private fun createParams(comment: String? = null): IssueInputParameters? =
         issueService.newIssueInputParameters().apply {

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

@@ -89,7 +89,8 @@ object SdkJiraUserOperator : JiraUserOperator {
 
     private fun createProjectNotFoundError(projectKey: String) = JiraClientError(
         "Project not found",
-        "No Project with projectKey $projectKey found."
+        "No Project with projectKey $projectKey found.",
+        statusCode = 404
     )
 
     private fun ApplicationUser.hasPermissionWithName(permissionName: String, project: Project): Boolean {