Reduce SonarQube alert by cleaning the code a bit.

Author: jreynard-code

common/src/main/kotlin/com/cosmotech/common/config/CsmApiConfiguration.kt

@@ -34,7 +34,6 @@ open class CsmApiConfiguration {
 
   @Bean(name = ["csm-in-process-event-executor"])
   open fun inProcessEventHandlerExecutor(): Executor =
-      // TODO A better strategy could be with a limited core pool size off an unbounded queue ?
       Executors.newCachedThreadPool(
           BasicThreadFactory.builder().namingPattern("csm-event-handler-%d").build()
       )
@@ -92,8 +91,8 @@ class YamlMessageConverter(objectMapper: ObjectMapper) :
   constructor() : this(yamlObjectMapper())
 
   override fun setObjectMapper(objectMapper: ObjectMapper) {
-    if (objectMapper.factory !is YAMLFactory) {
-      throw IllegalArgumentException("ObjectMapper must be configured with YAMLFactory")
+    require(objectMapper.factory is YAMLFactory) {
+      "ObjectMapper must be configured with YAMLFactory"
     }
     super.setObjectMapper(objectMapper)
   }

common/src/main/kotlin/com/cosmotech/common/config/CsmOpenAPIConfiguration.kt

@@ -28,12 +28,12 @@ open class CsmOpenAPIConfiguration(val csmPlatformProperties: CsmPlatformPropert
     val openApiYamlContent =
         openApiYamlInputStream.use { it.bufferedReader().use(BufferedReader::readText) }
     val openApiYamlParseResult = OpenAPIV3Parser().readContents(openApiYamlContent)
-    if (!openApiYamlParseResult.messages.isNullOrEmpty()) {
-      throw IllegalStateException(
-          "Unable to parse OpenAPI definition from 'classpath:/static/openapi.yaml' : " +
-              openApiYamlParseResult.messages
-      )
+
+    check(openApiYamlParseResult.messages.isNullOrEmpty()) {
+      "Unable to parse OpenAPI definition from 'classpath:/static/openapi.yaml' : " +
+          openApiYamlParseResult.messages
     }
+
     val openAPI =
         openApiYamlParseResult.openAPI
             ?: throw IllegalStateException(

common/src/main/kotlin/com/cosmotech/common/id/CsmIdGenerator.kt

@@ -11,9 +11,8 @@ private const val MIN_HASH_LENGTH = 0
 private const val ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789"
 
 fun generateId(scope: String, prependPrefix: String? = null): String {
-  if (scope.isBlank()) {
-    throw IllegalArgumentException("scope must not be blank")
-  }
+
+  require(scope.isNotBlank()) { "scope must not be blank" }
 
   // We do not intend to decode generated IDs afterwards => we can safely generate a unique salt.
   // This will give us different ids even with equal numbers to encode

common/src/main/kotlin/com/cosmotech/common/metrics/MonitorServiceAspect.kt

@@ -50,8 +50,9 @@ class MonitorServiceAspect(
   @Pointcut(
       "within(@org.springframework.web.bind.annotation.RestController *) && within(com.cosmotech..*Controller)"
   )
-  @Suppress("EmptyFunctionBlock")
-  fun cosmotechPointcut() {}
+  fun cosmotechPointcut() {
+    // Empty function block to define a pointcut
+  }
 
   @Before("cosmotechPointcut()")
   fun monitorBefore(joinPoint: JoinPoint) {

common/src/main/kotlin/com/cosmotech/common/rbac/CsmRbac.kt

@@ -29,10 +29,8 @@ open class CsmRbac(
     // Check for duplicate identities
     val accessControls = mutableListOf<String>()
     objectSecurity.accessControlList.forEach {
-      if (accessControls.contains(it.id)) {
-        throw IllegalArgumentException(
-            "Entity ${it.id} is referenced multiple times in the security"
-        )
+      require(!(accessControls.contains(it.id))) {
+        "Entity ${it.id} is referenced multiple times in the security"
       }
       accessControls.add(it.id)
     }

common/src/main/kotlin/com/cosmotech/common/utils/AnyExtensions.kt

@@ -79,15 +79,13 @@ inline fun <reified T> T.compareToAndMutateIfNeeded(
           if (changed) {
             membersChanged.add(member.name)
             if (mutateIfChanged) {
-              if (member !is KMutableProperty) {
-                throw IllegalArgumentException(
-                    "Detected change but cannot mutate " +
-                        "this object because property ${member.name} " +
-                        "(on class ${T::class}) is not mutable. " +
-                        "Either exclude this field or call this function with " +
-                        "mutateIfChanged=false to view the changes detected"
-                )
+              require(member is KMutableProperty) {
+                """Detected change but cannot mutate this object 
+                    because property ${member.name} (on class ${T::class}) is not mutable.
+                    Either exclude this field or call this function with mutateIfChanged=false 
+                    to view the changes detected"""
               }
+
               member.setter.call(this, newValue)
             }
           }

common/src/main/kotlin/com/cosmotech/common/utils/SecurityUtils.kt

@@ -56,35 +56,34 @@ fun getCurrentAccountIdentifier(configuration: CsmPlatformProperties): String {
 }
 
 fun getCurrentAccountGroups(configuration: CsmPlatformProperties): List<String> {
-  return (getValueFromAuthenticatedToken(configuration) {
+  return getValueFromAuthenticatedToken(configuration) {
     try {
       val jwt = JWTParser.parse(it)
       jwt.jwtClaimsSet.getStringListClaim(configuration.authorization.groupJwtClaim)
     } catch (e: ParseException) {
       JSONObjectUtils.parse(it)[configuration.authorization.groupJwtClaim] as List<String>
     }
-  } ?: emptyList())
+  }
 }
 
 fun getCurrentAuthenticatedRoles(configuration: CsmPlatformProperties): List<String> {
-  return (getValueFromAuthenticatedToken(configuration) {
+  return getValueFromAuthenticatedToken(configuration) {
     try {
       val jwt = JWTParser.parse(it)
       jwt.jwtClaimsSet.getStringListClaim(configuration.authorization.rolesJwtClaim)
     } catch (e: ParseException) {
       JSONObjectUtils.parse(it)[configuration.authorization.rolesJwtClaim] as List<String>
     }
-  } ?: emptyList())
+  }
 }
 
 fun <T> getValueFromAuthenticatedToken(
     configuration: CsmPlatformProperties,
     actionLambda: (String) -> T,
 ): T {
-  if (getCurrentAuthentication() == null) {
-    throw IllegalStateException("User Authentication not found in Security Context")
-  }
   val authentication = getCurrentAuthentication()
+  checkNotNull(authentication) { "User Authentication not found in Security Context" }
+
   if (authentication is JwtAuthenticationToken) {
     return authentication.token.tokenValue.let { actionLambda(it) }
   }

dataset/src/main/kotlin/com/cosmotech/dataset/part/services/RelationalDatasetPartManagementService.kt

@@ -11,7 +11,6 @@ import java.io.BufferedReader
 import java.io.ByteArrayOutputStream
 import java.io.InputStream
 import java.sql.SQLException
-import kotlin.use
 import org.apache.commons.lang3.StringUtils
 import org.postgresql.copy.CopyManager
 import org.postgresql.core.BaseConnection
@@ -50,10 +49,8 @@ class RelationalDatasetPartManagementService(
 
     val tableExists = writerJdbcTemplate.existTable(datasetPart.id)
 
-    if (tableExists && !overwrite) {
-      throw IllegalArgumentException(
-          "Table ${datasetPart.id} already exists and overwrite is set to false."
-      )
+    require(!tableExists || overwrite) {
+      "Table ${datasetPart.id} already exists and overwrite is set to false."
     }
 
     inputStream.bufferedReader().use { reader ->

dataset/src/main/kotlin/com/cosmotech/dataset/service/DatasetServiceImpl.kt

@@ -44,8 +44,6 @@ import com.cosmotech.workspace.WorkspaceApiServiceInterface
 import com.cosmotech.workspace.service.toGenericSecurity
 import java.io.ByteArrayOutputStream
 import java.time.Instant
-import kotlin.String
-import kotlin.use
 import org.apache.commons.lang3.StringUtils
 import org.postgresql.copy.CopyManager
 import org.postgresql.core.BaseConnection
@@ -671,16 +669,18 @@ class DatasetServiceImpl(
     val query =
         constructQuery(
             datasetPartId,
-            selects,
-            sums,
-            avgs,
-            counts,
-            mins,
-            maxs,
-            offset,
-            limit,
-            groupBys,
-            orderBys,
+            QueryParams(
+                selects,
+                sums,
+                avgs,
+                counts,
+                mins,
+                maxs,
+                offset,
+                limit,
+                groupBys,
+                orderBys,
+            ),
         )
 
     val outputStream = ByteArrayOutputStream()
@@ -715,28 +715,15 @@ class DatasetServiceImpl(
     }
   }
 
-  @Suppress("LongParameterList")
-  private fun constructQuery(
-      datasetPartId: String,
-      selects: List<String>?,
-      sums: List<String>?,
-      avgs: List<String>?,
-      counts: List<String>?,
-      mins: List<String>?,
-      maxs: List<String>?,
-      offset: Int?,
-      limit: Int?,
-      groupBys: List<String>?,
-      orderBys: List<String>?,
-  ): String {
+  private fun constructQuery(datasetPartId: String, queryParams: QueryParams): String {
     val tableName = "${DATASET_INPUTS_SCHEMA}.${datasetPartId.sanitizeDatasetPartId()}"
 
-    val selectClauses = constructClause(selects, null, null)
-    val sumClauses = constructClause(sums, AggregationType.Sum, "float8")
-    val avgClauses = constructClause(avgs, AggregationType.Avg, "float8")
-    val countClauses = constructClause(counts, AggregationType.Count, null)
-    val minClauses = constructClause(mins, AggregationType.Min, "float8")
-    val maxClauses = constructClause(maxs, AggregationType.Max, "float8")
+    val selectClauses = constructClause(queryParams.selects, null, null)
+    val sumClauses = constructClause(queryParams.sums, AggregationType.Sum, "float8")
+    val avgClauses = constructClause(queryParams.avgs, AggregationType.Avg, "float8")
+    val countClauses = constructClause(queryParams.counts, AggregationType.Count, null)
+    val minClauses = constructClause(queryParams.mins, AggregationType.Min, "float8")
+    val maxClauses = constructClause(queryParams.maxs, AggregationType.Max, "float8")
 
     val allSelectClauses =
         mutableListOf(selectClauses, sumClauses, avgClauses, countClauses, minClauses, maxClauses)
@@ -746,17 +733,17 @@ class DatasetServiceImpl(
     val query =
         StringBuilder("SELECT %s FROM %s ".format(allSelectClauses.ifBlank { "*" }, tableName))
 
-    val groupByClauses = constructClause(groupBys, null, null)
+    val groupByClauses = constructClause(queryParams.groupBys, null, null)
     if (groupByClauses.isNotBlank()) {
       query.append("GROUP BY $groupByClauses ")
     }
 
-    val orderByClauses = constructClause(orderBys, null, null, true)
+    val orderByClauses = constructClause(queryParams.orderBys, null, null, true)
     if (orderByClauses.isNotBlank()) {
       query.append("ORDER BY $orderByClauses ")
     }
 
-    addLimitOffset(limit, offset, query)
+    addLimitOffset(queryParams.limit, queryParams.offset, query)
 
     logger.debug(query.toString())
     return query.toString()
@@ -1139,6 +1126,19 @@ class DatasetServiceImpl(
   }
 }
 
+class QueryParams(
+    val selects: List<String>?,
+    val sums: List<String>?,
+    val avgs: List<String>?,
+    val counts: List<String>?,
+    val mins: List<String>?,
+    val maxs: List<String>?,
+    val offset: Int?,
+    val limit: Int?,
+    val groupBys: List<String>?,
+    val orderBys: List<String>?,
+)
+
 enum class AggregationType {
   Sum,
   Avg,

metrics/src/main/kotlin/com/cosmotech/metrics/MetricsService.kt

@@ -4,7 +4,7 @@ package com.cosmotech.metrics
 
 import com.cosmotech.common.metrics.PersistentMetric
 
-interface MetricsService {
+fun interface MetricsService {
   /**
    * Store a metric in the persistent database.
    *