control mapping lookup logging: logger/stdout

hauner · hauner · commit ab034c047a36 · 2024-10-27T16:45:31.000+01:00
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/LoggingOptions.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/LoggingOptions.kt
@@ -5,9 +5,26 @@
 
 package io.openapiprocessor.core.converter
 
+import io.openapiprocessor.core.converter.mapping.steps.Target
+import io.openapiprocessor.core.converter.mapping.steps.LoggingOptions
+
+
 class LoggingOptions(
     /**
      * log mapping lookups
      */
-    var mapping: Boolean = false
-)
+    override var mapping: Boolean = false,
+
+    /**
+     * log mapping lookups with logging library (slf4j) or to stdout
+     *
+     * this is a workaround for gradle.
+     * Unfortunately gradle can only globally enable/disable log levels, i.e. enabling info will enable info logging
+     * for everything which would hide the mapping lookup logging in a lot of noise. To avoid that we just log to
+     * stdout.
+     */
+    override var mappingTarget: Target = Target.LOGGER
+): LoggingOptions {
+    val logger = mappingTarget == Target.LOGGER
+    val stdout = mappingTarget == Target.STDOUT
+}
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/MappingFinder.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/MappingFinder.kt
@@ -25,7 +25,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return getResultTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -48,7 +48,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findResultStyleMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -72,7 +72,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return getSingleTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -96,7 +96,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return getMultiTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -131,7 +131,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findAnyTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -185,7 +185,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -218,7 +218,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findAnnotationTypeMappings(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -236,7 +236,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findParameterTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -259,7 +259,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findAnnotationParameterTypeMappings(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -287,7 +287,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findParameterNameTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -310,7 +310,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findAnnotationParameterNameTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -328,7 +328,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findAddParameterTypeMappings(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -346,7 +346,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findContentTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -369,7 +369,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findNullTypeMapping(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -386,7 +386,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return findExtensionAnnotations(extension, values, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -401,7 +401,7 @@ class MappingFinder(val options: ApiOptions) {
         try {
             return isEndpointExcluded(query, step)
         } finally {
-            step.write()
+            step.log()
         }
     }
 
@@ -416,10 +416,4 @@ class MappingFinder(val options: ApiOptions) {
     private fun rootStep(message: String, extension: String): MappingStep {
         return RootStepX(message, extension)
     }
-
-    private fun MappingStep.write() {
-        if (options.loggingOptions.mapping) {
-            log()
-        }
-    }
 }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/OptionsConverter.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/OptionsConverter.kt
@@ -5,6 +5,8 @@
 
 package io.openapiprocessor.core.converter
 
+import io.openapiprocessor.core.converter.mapping.steps.MappingStepBase
+import io.openapiprocessor.core.converter.mapping.steps.Target
 import io.openapiprocessor.core.converter.options.TargetDirLayout
 import io.openapiprocessor.core.processor.MappingConverter
 import io.openapiprocessor.core.processor.MappingReader
@@ -103,8 +105,12 @@ class OptionsConverter(private val checkObsoleteProcessorOptions: Boolean = fals
                         log.warn("is 'options.package-name' set in mapping? found default: '{}'.", options.packageName)
                     }
 
-                    if (mapping.debug.mapping) {
-                        options.loggingOptions.mapping = true
+                    with(mapping) {
+                        options.loggingOptions.mapping = debug.mapping
+                        if (debug.mappingTarget == "stdout") {
+                            options.loggingOptions.mappingTarget = Target.STDOUT
+                        }
+                        MappingStepBase.options.set(options.loggingOptions)
                     }
                 }
             }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/mapping/steps/LoggingOptions.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/mapping/steps/LoggingOptions.kt
@@ -0,0 +1,15 @@
+/*
+ * Copyright 2024 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.converter.mapping.steps
+
+enum class Target {
+    LOGGER, STDOUT
+}
+
+interface LoggingOptions {
+    var mapping: Boolean
+    var mappingTarget: Target
+}
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/mapping/steps/MappingStepBase.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/mapping/steps/MappingStepBase.kt
@@ -7,11 +7,38 @@ package io.openapiprocessor.core.converter.mapping.steps
 
 import org.slf4j.LoggerFactory
 
-abstract class MappingStepBase: MappingStep {
+abstract class MappingStepBase : MappingStep {
     private val log = LoggerFactory.getLogger(this::class.java)
 
     fun log(message: String, vararg args: Any?) {
-        // would like to log this as debug or info, but gradle can only globally enable/disable log levels.
-        log.warn(message, *args)
+        if (!enabled())
+            return
+
+        if (useLogger()) {
+            log.debug(message, *args)
+        } else {
+            var resolved = message
+            args.forEach {
+                resolved = resolved.replaceFirst("{}", it.toString())
+            }
+            println(resolved)
+        }
+    }
+
+    private fun enabled(): Boolean {
+        return options.get().mapping
+    }
+
+    private fun useLogger(): Boolean {
+        return options.get().mappingTarget == Target.LOGGER
+    }
+
+    companion object {
+        val options: ThreadLocal<LoggingOptions> = ThreadLocal.withInitial {
+            object : LoggingOptions {
+                override var mapping = false
+                override var mappingTarget = Target.LOGGER
+            }
+        }
     }
 }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Debug.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Debug.kt
@@ -9,5 +9,10 @@ data class Debug(
     /**
      * enable/disable tracing of mapping lookups (optional).
      */
-    val mapping: Boolean = false
+    val mapping: Boolean = false,
+
+    /**
+     * logging target
+     */
+    val mappingTarget: String = "logger"
 )

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class MappingFinder(val options: ApiOptions) {`
`25`	`25`	`try {`
`26`	`26`	`return getResultTypeMapping(query, step)`
`27`	`27`	`} finally {`
`28`		`- step.write()`
	`28`	`+ step.log()`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`
`@@ -48,7 +48,7 @@ class MappingFinder(val options: ApiOptions) {`
`48`	`48`	`try {`
`49`	`49`	`return findResultStyleMapping(query, step)`
`50`	`50`	`} finally {`
`51`		`- step.write()`
	`51`	`+ step.log()`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`
`@@ -72,7 +72,7 @@ class MappingFinder(val options: ApiOptions) {`
`72`	`72`	`try {`
`73`	`73`	`return getSingleTypeMapping(query, step)`
`74`	`74`	`} finally {`
`75`		`- step.write()`
	`75`	`+ step.log()`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
`@@ -96,7 +96,7 @@ class MappingFinder(val options: ApiOptions) {`
`96`	`96`	`try {`
`97`	`97`	`return getMultiTypeMapping(query, step)`
`98`	`98`	`} finally {`
`99`		`- step.write()`
	`99`	`+ step.log()`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`
`@@ -131,7 +131,7 @@ class MappingFinder(val options: ApiOptions) {`
`131`	`131`	`try {`
`132`	`132`	`return findAnyTypeMapping(query, step)`
`133`	`133`	`} finally {`
`134`		`- step.write()`
	`134`	`+ step.log()`
`135`	`135`	`}`
`136`	`136`	`}`
`137`	`137`
`@@ -185,7 +185,7 @@ class MappingFinder(val options: ApiOptions) {`
`185`	`185`	`try {`
`186`	`186`	`return findTypeMapping(query, step)`
`187`	`187`	`} finally {`
`188`		`- step.write()`
	`188`	`+ step.log()`
`189`	`189`	`}`
`190`	`190`	`}`
`191`	`191`
`@@ -218,7 +218,7 @@ class MappingFinder(val options: ApiOptions) {`
`218`	`218`	`try {`
`219`	`219`	`return findAnnotationTypeMappings(query, step)`
`220`	`220`	`} finally {`
`221`		`- step.write()`
	`221`	`+ step.log()`
`222`	`222`	`}`
`223`	`223`	`}`
`224`	`224`
`@@ -236,7 +236,7 @@ class MappingFinder(val options: ApiOptions) {`
`236`	`236`	`try {`
`237`	`237`	`return findParameterTypeMapping(query, step)`
`238`	`238`	`} finally {`
`239`		`- step.write()`
	`239`	`+ step.log()`
`240`	`240`	`}`
`241`	`241`	`}`
`242`	`242`
`@@ -259,7 +259,7 @@ class MappingFinder(val options: ApiOptions) {`
`259`	`259`	`try {`
`260`	`260`	`return findAnnotationParameterTypeMappings(query, step)`
`261`	`261`	`} finally {`
`262`		`- step.write()`
	`262`	`+ step.log()`
`263`	`263`	`}`
`264`	`264`	`}`
`265`	`265`
`@@ -287,7 +287,7 @@ class MappingFinder(val options: ApiOptions) {`
`287`	`287`	`try {`
`288`	`288`	`return findParameterNameTypeMapping(query, step)`
`289`	`289`	`} finally {`
`290`		`- step.write()`
	`290`	`+ step.log()`
`291`	`291`	`}`
`292`	`292`	`}`
`293`	`293`
`@@ -310,7 +310,7 @@ class MappingFinder(val options: ApiOptions) {`
`310`	`310`	`try {`
`311`	`311`	`return findAnnotationParameterNameTypeMapping(query, step)`
`312`	`312`	`} finally {`
`313`		`- step.write()`
	`313`	`+ step.log()`
`314`	`314`	`}`
`315`	`315`	`}`
`316`	`316`
`@@ -328,7 +328,7 @@ class MappingFinder(val options: ApiOptions) {`
`328`	`328`	`try {`
`329`	`329`	`return findAddParameterTypeMappings(query, step)`
`330`	`330`	`} finally {`
`331`		`- step.write()`
	`331`	`+ step.log()`
`332`	`332`	`}`
`333`	`333`	`}`
`334`	`334`
`@@ -346,7 +346,7 @@ class MappingFinder(val options: ApiOptions) {`
`346`	`346`	`try {`
`347`	`347`	`return findContentTypeMapping(query, step)`
`348`	`348`	`} finally {`
`349`		`- step.write()`
	`349`	`+ step.log()`
`350`	`350`	`}`
`351`	`351`	`}`
`352`	`352`
`@@ -369,7 +369,7 @@ class MappingFinder(val options: ApiOptions) {`
`369`	`369`	`try {`
`370`	`370`	`return findNullTypeMapping(query, step)`
`371`	`371`	`} finally {`
`372`		`- step.write()`
	`372`	`+ step.log()`
`373`	`373`	`}`
`374`	`374`	`}`
`375`	`375`
`@@ -386,7 +386,7 @@ class MappingFinder(val options: ApiOptions) {`
`386`	`386`	`try {`
`387`	`387`	`return findExtensionAnnotations(extension, values, step)`
`388`	`388`	`} finally {`
`389`		`- step.write()`
	`389`	`+ step.log()`
`390`	`390`	`}`
`391`	`391`	`}`
`392`	`392`
`@@ -401,7 +401,7 @@ class MappingFinder(val options: ApiOptions) {`
`401`	`401`	`try {`
`402`	`402`	`return isEndpointExcluded(query, step)`
`403`	`403`	`} finally {`
`404`		`- step.write()`
	`404`	`+ step.log()`
`405`	`405`	`}`
`406`	`406`	`}`
`407`	`407`
`@@ -416,10 +416,4 @@ class MappingFinder(val options: ApiOptions) {`
`416`	`416`	`private fun rootStep(message: String, extension: String): MappingStep {`
`417`	`417`	`return RootStepX(message, extension)`
`418`	`418`	`}`
`419`		`-`
`420`		`- private fun MappingStep.write() {`
`421`		`- if (options.loggingOptions.mapping) {`
`422`		`- log()`
`423`		`- }`
`424`		`- }`
`425`	`419`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`
`6`	`6`	`package io.openapiprocessor.core.converter`
`7`	`7`
	`8`	`+import io.openapiprocessor.core.converter.mapping.steps.MappingStepBase`
	`9`	`+import io.openapiprocessor.core.converter.mapping.steps.Target`
`8`	`10`	`import io.openapiprocessor.core.converter.options.TargetDirLayout`
`9`	`11`	`import io.openapiprocessor.core.processor.MappingConverter`
`10`	`12`	`import io.openapiprocessor.core.processor.MappingReader`
`@@ -103,8 +105,12 @@ class OptionsConverter(private val checkObsoleteProcessorOptions: Boolean = fals`
`103`	`105`	`log.warn("is 'options.package-name' set in mapping? found default: '{}'.", options.packageName)`
`104`	`106`	`}`
`105`	`107`
`106`		`- if (mapping.debug.mapping) {`
`107`		`- options.loggingOptions.mapping = true`
	`108`	`+ with(mapping) {`
	`109`	`+ options.loggingOptions.mapping = debug.mapping`
	`110`	`+ if (debug.mappingTarget == "stdout") {`
	`111`	`+ options.loggingOptions.mappingTarget = Target.STDOUT`
	`112`	`+ }`
	`113`	`+ MappingStepBase.options.set(options.loggingOptions)`
`108`	`114`	`}`
`109`	`115`	`}`
`110`	`116`	`}`