improve logging: input api fail + exceptions

- log detailed information when a measure is rejected by the input api
- make AppException herit from RuntimeException (vs Throwable), so that logs from ExceptionHandlerExceptionResolver are not throwing IllegalStateException, but actually showing the kind of error instead

Author: derlin

src/main/kotlin/ch/derlin/bbdata/common/Beans.kt

@@ -29,5 +29,8 @@ object Beans {
         val description: String? = null
     }
 
+}
 
-}
+
+fun String?.truncate(maxLength: Int = 30, ellipsis: String = "[${Typography.ellipsis}]"): String? =
+        if (this != null && this.length > maxLength) this.take(maxLength).plus(ellipsis) else this

src/main/kotlin/ch/derlin/bbdata/common/exceptions/Exceptions.kt

@@ -1,11 +1,13 @@
 package ch.derlin.bbdata.common.exceptions
 
+import java.lang.RuntimeException
+
 /**
  * date: 15.12.19
  * @author Lucy Linder <lucy.derlin@gmail.com>
  */
 
-open class AppException(val details: Any) : Throwable() {
+open class AppException(val details: Any) : RuntimeException("$details") {
     val name: String get() = this.javaClass.name.split('.').last()
 }
 

src/main/kotlin/ch/derlin/bbdata/input/InputController.kt

@@ -11,6 +11,7 @@ import com.fasterxml.jackson.databind.ObjectMapper
 import io.swagger.v3.oas.annotations.Operation
 import io.swagger.v3.oas.annotations.tags.Tag
 import org.joda.time.DateTime
+import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Value
 import org.springframework.kafka.core.KafkaTemplate
 import org.springframework.web.bind.annotation.PostMapping
@@ -35,6 +36,8 @@ class InputController(
         private val kafkaTemplate: KafkaTemplate<String, String> // note: ignore jetbrains [false] warning
 ) {
 
+    private final val log = LoggerFactory.getLogger(InputController::class.java)
+
     // Just for tests, if you don't want to have kafka running, do:
     // export BB_NO_KAFKA=true
     @Value("\${${HiddenEnvironmentVariables.NO_KAFKA}:false}")
@@ -84,6 +87,7 @@ class InputController(
             val measure = if (rawMeasure.timestamp != null) {
                 // check that date is in the past
                 if (rawMeasure.timestamp.millis > now.millis + MAX_LAG) {
+                    log.info("REJECTED: wrong timestamp: ${rawMeasure}")
                     throw WrongParamsException("objectId ${rawMeasure.objectId}: date should be in the past. input='${rawMeasure.timestamp}', now='$now'")
                 }
                 rawMeasure
@@ -94,17 +98,21 @@ class InputController(
 
             // get metadata
             val meta = inputRepository.getMeasureMeta(measure.objectId!!, measure.token!!).orElseThrow {
+                log.info("REJECTED: wrong token: $measure")
                 ItemNotFoundException(msg = "objectId ${measure.objectId}: the pair <objectId, token> does not exist")
             }
             // ensure the object is enabled. This is just a double check, as tokens cannot be created on disabled objects
             if (meta.disabled) {
+                log.info("REJECTED: object is disabled: $rawMeasure")
                 throw ForbiddenException("objectId ${rawMeasure.objectId} is disabled.")
             }
             // ensure the measure matches the type declared, and parse it
             val parsedValue = BaseType.parseType(measure.value!!, meta.type)
-            parsedValue
-                    ?: throw WrongParamsException("objectId ${rawMeasure.objectId}: the value '${measure.value}' does not match " +
-                            "the unit ${meta.unitSymbol} (${meta.type}) declared in the object definition.")
+            if(parsedValue == null) {
+                log.info("REJECTED: wrong value given the unit: $measure, $meta")
+                throw WrongParamsException("objectId ${rawMeasure.objectId}: the value '${measure.value}' does not match " +
+                        "the unit ${meta.unitSymbol} (${meta.type}) declared in the object definition.")
+            }
 
             measure.value = parsedValue.toString()
 
@@ -114,12 +122,14 @@ class InputController(
 
             // ensure no duplicate objectId/timestamp in the data sent
             if (valueKeys.contains(key)) {
+                log.info("REJECTED: duplicate in body: $measure")
                 throw WrongParamsException("objectId ${measure.objectId}: two or more values with the same timestamp")
             }
             valueKeys.add(key)
 
             // ensure it doesn't already exist in cassandra TODO: find a better way ?
             if (rawValueRepository.existsById(rawValue.key)) {
+                log.info("REJECTED: duplicate in cassandra: $measure")
                 throw WrongParamsException("objectId ${rawMeasure.objectId}: " +
                         "a value with the same timestamp (${measure.timestamp}) already exists for this object.")
             }

src/main/kotlin/ch/derlin/bbdata/input/InputRepository.kt

@@ -30,6 +30,10 @@ class InputRepository(private val em: EntityManager) {
             WHERE o.id = :objectId AND t.token = :token
             """.trimIndent()
         }
+
+        override fun toString(): String {
+            return "MeasureMeta(unitName='$unitName', unitSymbol='$unitSymbol', type='$type', owner=$owner, disabled=$disabled)"
+        }
     }
 
     @Cacheable(Constants.META_CACHE, key = "#objectId.toString().concat(':').concat(#token)", unless = "#result == null")

src/main/kotlin/ch/derlin/bbdata/input/NewValue.kt

@@ -2,6 +2,7 @@ package ch.derlin.bbdata.input
 
 import ch.derlin.bbdata.common.cassandra.RawValue
 import ch.derlin.bbdata.common.cassandra.RawValuePK
+import ch.derlin.bbdata.common.truncate
 import org.joda.time.DateTime
 import org.joda.time.YearMonth
 import javax.validation.constraints.Min
@@ -35,6 +36,7 @@ data class NewValue(
         val comment: String? = null
 ) {
 
+
     fun toRawValue(): RawValue = RawValue(
             key = RawValuePK(
                     objectId = objectId!!.toInt(),
@@ -43,4 +45,9 @@ data class NewValue(
             value = value!!,
             comment = comment
     )
+
+    override fun toString(): String {
+        return "NewValue(objectId=$objectId, token=$token, timestamp=$timestamp, " +
+                "value=${value.truncate()}, comment=${comment?.truncate(10)})"
+    }
 }