Replace ConfigurableMoshi with MoshiReVoman, to make use of ParameterizedTypes

overfullstack · overfullstack · commit fa45e231c9fb · 2025-03-08T23:45:06.000+05:30
Signed-off-by: Gopal S Akshintala &lt;gopala.akshintala@salesforce.com&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -7,8 +7,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-java@v4
         with:
-          distribution: zulu
-          java-version: 17
+          distribution: jetbrains
+          java-version: 21
 
       - name: 'Setup Gradle'
         uses: gradle/gradle-build-action@v3
diff --git a/README.adoc b/README.adoc
@@ -344,11 +344,11 @@ endif::[]
 [.lead]
 Config built using `Kick.configure()` is *Immutable*.
 
-When there are many tests leveraging the same config with minor modifications, You can define a common config and add your variations (like add more hooks), 
+When there are many tests leveraging the same config with minor modifications, You can define a common config and add your variations (like add more hooks),
 using `override...()` methods,
 which are present for all config attributes, to create a new instance of config.
 
-CAUTION: The new instance created from common config using `override...()` replaces the attributes. 
+CAUTION: The new instance created from common config using `override...()` replaces the attributes.
 
 * For iterable attributes (like `List`, `Map` etc), intentionally there are no methods to `add` or `append` or `prepend` attributes when creating new instance, to prevent any mix-up with the order of attributes. You can use any collection appending utilities to prepend/append previous hooks.
 
diff --git a/detekt/baseline.xml b/detekt/baseline.xml
@@ -4,7 +4,7 @@
     <ID>TooManyFunctions:ResponseConfig.kt$ResponseConfig$Companion</ID>
     <ID>TooManyFunctions:PostmanEnvironment.kt$PostmanEnvironment&lt;ValueT : Any?> : MutableMap</ID>
     <ID>TooManyFunctions:ExeUtils.kt$com.salesforce.revoman.internal.exe.ExeUtils.kt</ID>
-    <ID>LongMethod:ReVoman.kt$ReVoman$private fun executeStepsSerially( pmStepsFlattened: List&lt;Pair&lt;Step, Item>>, kick: Kick, moshiReVoman: ConfigurableMoshi, ): List&lt;StepReport></ID>
+    <ID>LongMethod:ReVoman.kt$ReVoman$private fun executeStepsSerially( pmStepsFlattened: List&lt;Pair&lt;Step, Item>>, kick: Kick, moshiReVoman: MoshiReVoman, ): List&lt;StepReport></ID>
     <ID>SpreadOperator:Step.kt$Step$(*FOLDER_DELIMITER.toCharArray())</ID>
     <ID>SpreadOperator:CaseInsensitiveEnumAdapter.kt$CaseInsensitiveEnumAdapter$(*nameStrings.toTypedArray())</ID>
     <ID>TooManyFunctions:JsonWriterUtils.kt$com.salesforce.revoman.input.json.JsonWriterUtils.kt</ID>
diff --git a/src/integrationTest/resources/pm-templates/restfulapidev/restful-api.dev.postman_collection.json b/src/integrationTest/resources/pm-templates/restfulapidev/restful-api.dev.postman_collection.json
@@ -46,7 +46,8 @@
 							"pm.environment.set(\"objId\", responseJson.id);",
 							""
 						],
-						"type": "text/javascript"
+						"type": "text/javascript",
+						"packages": {}
 					}
 				},
 				{
@@ -57,7 +58,8 @@
 							"pm.environment.set(\"$currentYear\", moment().year())",
 							"pm.environment.set(\"$randomPrice\", _.random(1, 1000))"
 						],
-						"type": "text/javascript"
+						"type": "text/javascript",
+						"packages": {}
 					}
 				}
 			],
@@ -66,7 +68,7 @@
 				"header": [],
 				"body": {
 					"mode": "raw",
-					"raw": "{\n   \"name\": \"AI Phone\",\n   \"data\": {\n      \"year\": {{$currentYear}},\n      \"price\": {{$randomPrice}}\n   }\n}",
+					"raw": "{\n   \"name\": \"AI Phone\",  \"data\": {\n      \"year\": {{$currentYear}},\n      \"price\": {{$randomPrice}}\n   }\n}",
 					"options": {
 						"raw": {
 							"language": "json"
@@ -106,4 +108,4 @@
 			"response": []
 		}
 	]
-}
+}
diff --git a/src/main/kotlin/com/salesforce/revoman/ReVoman.kt b/src/main/kotlin/com/salesforce/revoman/ReVoman.kt
@@ -25,6 +25,7 @@ import com.salesforce.revoman.internal.exe.shouldHaltExecution
 import com.salesforce.revoman.internal.exe.shouldStepBePicked
 import com.salesforce.revoman.internal.exe.unmarshallRequest
 import com.salesforce.revoman.internal.exe.unmarshallResponse
+import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.salesforce.revoman.internal.json.initMoshi
 import com.salesforce.revoman.internal.postman.Info
 import com.salesforce.revoman.internal.postman.PostmanSDK
@@ -42,7 +43,6 @@ import com.squareup.moshi.adapter
 import io.github.oshai.kotlinlogging.KotlinLogging
 import io.vavr.control.Either.left
 import org.http4k.core.Request
-import org.http4k.format.ConfigurableMoshi
 
 object ReVoman {
   @JvmStatic
@@ -127,7 +127,7 @@ object ReVoman {
   private fun executeStepsSerially(
     pmStepsFlattened: List<Step>,
     kick: Kick,
-    moshiReVoman: ConfigurableMoshi,
+    moshiReVoman: MoshiReVoman,
     regexReplacer: RegexReplacer,
     pm: PostmanSDK,
   ): List<StepReport> {
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/PMJSEval.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/PMJSEval.kt
@@ -21,12 +21,15 @@ import com.salesforce.revoman.output.report.failure.ResponseFailure.PostResJSFai
 
 internal fun executePreReqJS(
   currentStep: Step,
-  item: Item,
+  itemWithRegex: Item,
   pm: PostmanSDK,
 ): Either<PreReqJSFailure, Unit> {
-  val preReqJS = item.event?.find { it.listen == "prerequest" }?.script?.exec?.joinToString("\n")
+  val preReqJS =
+    itemWithRegex.event?.find { it.listen == "prerequest" }?.script?.exec?.joinToString("\n")
   return if (!preReqJS.isNullOrBlank()) {
-    runCatching(currentStep, PRE_REQ_JS) { executePreReqJSWithPolyglot(preReqJS, item.request, pm) }
+    runCatching(currentStep, PRE_REQ_JS) {
+        executePreReqJSWithPolyglot(preReqJS, itemWithRegex.request, pm)
+      }
       .mapLeft { PreReqJSFailure(it, pm.currentStepReport.requestInfo!!.get()) }
   } else {
     Right(Unit)
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallRequest.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallRequest.kt
@@ -10,24 +10,23 @@ package com.salesforce.revoman.internal.exe
 import arrow.core.Either
 import arrow.core.Either.Right
 import com.salesforce.revoman.input.config.Kick
+import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.salesforce.revoman.internal.postman.PostmanSDK
 import com.salesforce.revoman.output.ExeType.UNMARSHALL_REQUEST
 import com.salesforce.revoman.output.report.Step
 import com.salesforce.revoman.output.report.TxnInfo
 import com.salesforce.revoman.output.report.failure.RequestFailure.UnmarshallRequestFailure
-import com.squareup.moshi.rawType
 import io.exoquery.pprint
 import io.github.oshai.kotlinlogging.KotlinLogging
 import java.lang.reflect.Type
 import org.http4k.core.ContentType.Companion.APPLICATION_JSON
 import org.http4k.core.Request
-import org.http4k.format.ConfigurableMoshi
 
 internal fun unmarshallRequest(
   currentStep: Step,
   pmRequest: com.salesforce.revoman.internal.postman.template.Request,
   kick: Kick,
-  moshiReVoman: ConfigurableMoshi,
+  moshiReVoman: MoshiReVoman,
   pm: PostmanSDK,
 ): Either<UnmarshallRequestFailure, TxnInfo<Request>> {
   val httpRequest = pmRequest.toHttpRequest()
@@ -42,7 +41,7 @@ internal fun unmarshallRequest(
   return when {
     isJson(httpRequest) ->
       runCatching(currentStep, UNMARSHALL_REQUEST) {
-          pmRequest.body?.let { body -> moshiReVoman.asA(body.raw, requestType.rawType.kotlin) }
+          pmRequest.body?.let { body -> moshiReVoman.fromJson<Any>(body.raw, requestType) }
         }
         .mapLeft { UnmarshallRequestFailure(it, TxnInfo(requestType, null, httpRequest)) }
     else -> {
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallResponse.kt b/src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallResponse.kt
@@ -10,21 +10,20 @@ package com.salesforce.revoman.internal.exe
 import arrow.core.Either
 import arrow.core.Either.Right
 import com.salesforce.revoman.input.config.Kick
+import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.salesforce.revoman.internal.postman.PostmanSDK
 import com.salesforce.revoman.output.ExeType.UNMARSHALL_RESPONSE
 import com.salesforce.revoman.output.report.TxnInfo
 import com.salesforce.revoman.output.report.failure.ResponseFailure.UnmarshallResponseFailure
-import com.squareup.moshi.rawType
 import io.exoquery.pprint
 import io.github.oshai.kotlinlogging.KotlinLogging
 import java.lang.reflect.Type
 import org.http4k.core.ContentType.Companion.APPLICATION_JSON
 import org.http4k.core.Response
-import org.http4k.format.ConfigurableMoshi
 
 internal fun unmarshallResponse(
   kick: Kick,
-  moshiReVoman: ConfigurableMoshi,
+  moshiReVoman: MoshiReVoman,
   pm: PostmanSDK,
 ): Either<UnmarshallResponseFailure, TxnInfo<Response>> {
   val httpResponse = pm.currentStepReport.responseInfo!!.get().httpMsg
@@ -44,7 +43,7 @@ internal fun unmarshallResponse(
           ?.objType ?: Any::class.java
       val requestInfo = pm.currentStepReport.requestInfo!!.get()
       runCatching(currentStep, UNMARSHALL_RESPONSE) {
-          moshiReVoman.asA(httpResponse.bodyString(), responseType.rawType.kotlin)
+          moshiReVoman.fromJson<Any>(httpResponse.bodyString(), responseType)
         }
         .mapLeft {
           UnmarshallResponseFailure(it, requestInfo, TxnInfo(responseType, null, httpResponse))
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/json/MoshiReVoman.kt b/src/main/kotlin/com/salesforce/revoman/internal/json/MoshiReVoman.kt
@@ -5,8 +5,6 @@
  * http://www.apache.org/licenses/LICENSE-2.0
  * ************************************************************************************************
  */
-@file:JvmName("MoshiReVoman")
-
 package com.salesforce.revoman.internal.json
 
 import com.salesforce.revoman.internal.json.adapters.BigDecimalAdapter
@@ -24,23 +22,58 @@ import dev.zacsweers.moshix.adapters.AdaptedBy
 import dev.zacsweers.moshix.adapters.JsonString
 import io.vavr.control.Either
 import java.lang.reflect.Type
-import java.util.Date
-import org.http4k.format.ConfigurableMoshi
+import java.util.*
 import org.http4k.format.EventAdapter
 import org.http4k.format.ListAdapter
 import org.http4k.format.MapAdapter
 import org.http4k.format.ThrowableAdapter
 import org.http4k.format.asConfigurable
 import org.http4k.format.withStandardMappings
 
+open class MoshiReVoman(builder: Moshi.Builder) {
+  private val moshi = builder.build()
+
+  private fun <PojoT : Any> lenientAdapter(targetType: Type): JsonAdapter<PojoT?> =
+    moshi.adapter<PojoT>(targetType).lenient()
+
+  private inline fun <reified PojoT : Any> lenientAdapter(): JsonAdapter<PojoT?> =
+    moshi.adapter<PojoT>(PojoT::class.java).lenient()
+  
+  fun <PojoT : Any> fromJson(input: String?, targetType: Type = Any::class.java): PojoT? =
+    input?.let { lenientAdapter<PojoT>(targetType).fromJson(it) }
+
+  inline fun <reified PojoT : Any> fromJson(input: String?): PojoT? =
+    fromJson(input, PojoT::class.java)
+
+  fun <PojoT : Any> toJson(
+    input: PojoT?,
+    sourceType: Type = input?.javaClass ?: Any::class.java,
+  ): String = lenientAdapter<PojoT>(sourceType).toJson(input)
+
+  inline fun <reified PojoT : Any> toJson(input: PojoT?): String = toJson(input, PojoT::class.java)
+
+  fun <PojoT : Any> toPrettyJson(
+    input: PojoT?,
+    sourceType: Type = input?.javaClass ?: Any::class.java,
+    indent: String = "  "
+  ): String = lenientAdapter<PojoT>(sourceType).indent(indent).toJson(input)
+  
+  inline fun <reified PojoT : Any> toPrettyJson(input: PojoT?, indent: String = "  "): String = toPrettyJson(input, PojoT::class.java, indent)
+
+  fun <PojoT : Any> objToJsonStrToObj(
+    input: Any?,
+    targetType: Type = input?.javaClass ?: Any::class.java,
+  ): PojoT? = lenientAdapter<PojoT>(targetType).fromJson(toJson(input))
+}
+
 @JvmOverloads
 internal fun initMoshi(
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<out Any>, Factory>>> = emptyMap(),
   typesToIgnore: Set<Class<out Any>> = emptySet(),
-): ConfigurableMoshi {
+): MoshiReVoman {
   val moshiBuilder = buildMoshi(customAdapters, customAdaptersWithType, typesToIgnore)
-  return object : ConfigurableMoshi(moshiBuilder) {}
+  return object : MoshiReVoman(moshiBuilder) {}
 }
 
 @SuppressWarnings("kotlin:S3923")
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/postman/PostmanSDK.kt b/src/main/kotlin/com/salesforce/revoman/internal/postman/PostmanSDK.kt
@@ -8,6 +8,7 @@
 package com.salesforce.revoman.internal.postman
 
 import com.github.underscore.U
+import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.salesforce.revoman.internal.postman.template.Body
 import com.salesforce.revoman.internal.postman.template.Event
 import com.salesforce.revoman.internal.postman.template.Header
@@ -21,14 +22,13 @@ import org.graalvm.polyglot.Context
 import org.graalvm.polyglot.HostAccess
 import org.graalvm.polyglot.Source
 import org.graalvm.polyglot.Value
-import org.http4k.format.ConfigurableMoshi
 
 /**
  * SDK to execute pre-req and post-res js scripts, to be compatible with the Postman API reference:
  * https://learning.postman.com/docs/writing-scripts/script-references/postman-sandbox-api-reference/
  */
 class PostmanSDK(
-  private val moshiReVoman: ConfigurableMoshi,
+  private val moshiReVoman: MoshiReVoman,
   nodeModulesRelativePath: String? = null,
   val regexReplacer: RegexReplacer = RegexReplacer(),
   mutableEnv: MutableMap<String, Any?> = mutableMapOf(),
@@ -40,7 +40,7 @@ class PostmanSDK(
   lateinit var currentStepReport: StepReport
   @Suppress("unused") @JvmField val variables: Variables = Variables()
   lateinit var rundown: Rundown
-  @JvmField val xml2Json = Xml2Json { xml -> moshiReVoman.asA(U.xmlToJson(xml)) }
+  @JvmField val xml2Json = Xml2Json { xml -> moshiReVoman.fromJson(U.xmlToJson(xml)) }
   // * NOTE 28 Apr 2024 gopala.akshintala: This has to be initialized at last
   private val jsEvaluator: JSEvaluator = JSEvaluator(nodeModulesRelativePath)
 
diff --git a/src/main/kotlin/com/salesforce/revoman/internal/postman/template/Environment.kt b/src/main/kotlin/com/salesforce/revoman/internal/postman/template/Environment.kt
@@ -8,8 +8,8 @@
 package com.salesforce.revoman.internal.postman.template
 
 import com.salesforce.revoman.internal.json.AlwaysSerializeNulls
+import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.squareup.moshi.JsonClass
-import org.http4k.format.ConfigurableMoshi
 
 @JsonClass(generateAdapter = true)
 internal data class Environment(val name: String?, val values: List<EnvValue>) {
@@ -20,15 +20,15 @@ internal data class Environment(val name: String?, val values: List<EnvValue>) {
   companion object {
     const val POSTMAN_ENV_NAME = "env-from-revoman"
 
-    fun fromMap(envMap: Map<String, Any?>, moshiReVoman: ConfigurableMoshi): Environment {
+    fun fromMap(envMap: Map<String, Any?>, moshiReVoman: MoshiReVoman): Environment {
       val values =
         envMap.entries.map { (key, value) ->
           val valueStr =
             when (value) {
-              null,
               is String -> value
-              value::class.javaPrimitiveType?.isPrimitive -> value.toString()
-              else -> moshiReVoman.asFormatString(value)
+              // * NOTE 08 Mar 2025 gopala.akshintala: To be consistent with Postman app behavior
+              null -> "null"
+              else -> moshiReVoman.toJson(value)
             }
           EnvValue(key, valueStr, true)
         }
diff --git a/src/main/kotlin/com/salesforce/revoman/output/postman/PostmanEnvironment.kt b/src/main/kotlin/com/salesforce/revoman/output/postman/PostmanEnvironment.kt
@@ -7,27 +7,27 @@
  */
 package com.salesforce.revoman.output.postman
 
+import com.salesforce.revoman.internal.json.MoshiReVoman
 import com.salesforce.revoman.internal.json.initMoshi
 import com.salesforce.revoman.internal.postman.template.Environment.Companion.fromMap
 import com.squareup.moshi.rawType
 import io.exoquery.pprint
 import io.github.oshai.kotlinlogging.KotlinLogging
 import java.lang.reflect.Type
-import org.http4k.format.ConfigurableMoshi
 
 /** This is a Wrapper on `mutableEnv` map, providing some useful utilities */
 data class PostmanEnvironment<ValueT : Any?>
 @JvmOverloads
 constructor(
   val mutableEnv: MutableMap<String, ValueT> = mutableMapOf(),
-  val moshiReVoman: ConfigurableMoshi = initMoshi(),
+  val moshiReVoman: MoshiReVoman = initMoshi(),
 ) : MutableMap<String, ValueT> by mutableEnv {
 
   @get:JvmName("immutableEnv") val immutableEnv: Map<String, ValueT> by lazy { mutableEnv.toMap() }
 
   @get:JvmName("postmanEnvJSONFormat")
   val postmanEnvJSONFormat: String by lazy {
-    moshiReVoman.prettify(moshiReVoman.asFormatString(fromMap(mutableEnv, moshiReVoman)))
+    moshiReVoman.toJson(fromMap(mutableEnv, moshiReVoman))
   }
 
   fun set(key: String, value: ValueT) {
@@ -110,19 +110,12 @@ constructor(
     return when {
       value == null -> null
       objType.rawType.isInstance(value) -> value
-      else -> moshiReVoman.asA(moshiReVoman.asFormatString(value as Any), objType.rawType.kotlin)
+      else -> moshiReVoman.objToJsonStrToObj(value, objType)
     }
       as T?
   }
 
-  inline fun <reified T : Any> getObj(key: String): T? {
-    val value = mutableEnv[key]
-    return when (value) {
-      null,
-      is T -> value
-      else -> moshiReVoman.asA(moshiReVoman.asFormatString(value as Any), T::class)
-    }
-  }
+  inline fun <reified T : Any> getObj(key: String): T? = getTypedObj(key, T::class.java)
 
   fun <T> mutableEnvCopyWithKeysEndingWith(
     type: Class<T>,
diff --git a/src/test/kotlin/com/salesforce/revoman/output/report/PostmanEnvironmentKtTest.kt b/src/test/kotlin/com/salesforce/revoman/output/report/PostmanEnvironmentKtTest.kt
diff --git a/src/test/resources/env-from-revoman.json b/src/test/resources/env-from-revoman.json
diff --git a/src/test/resources/mutable-env-to-pm.json b/src/test/resources/mutable-env-to-pm.json

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,8 @@`
`46`	`46`	`"pm.environment.set(\"objId\", responseJson.id);",`
`47`	`47`	`""`
`48`	`48`	`],`
`49`		`- "type": "text/javascript"`
	`49`	`+ "type": "text/javascript",`
	`50`	`+ "packages": {}`
`50`	`51`	`}`
`51`	`52`	`},`
`52`	`53`	`{`
`@@ -57,7 +58,8 @@`
`57`	`58`	`"pm.environment.set(\"$currentYear\", moment().year())",`
`58`	`59`	`"pm.environment.set(\"$randomPrice\", _.random(1, 1000))"`
`59`	`60`	`],`
`60`		`- "type": "text/javascript"`
	`61`	`+ "type": "text/javascript",`
	`62`	`+ "packages": {}`
`61`	`63`	`}`
`62`	`64`	`}`
`63`	`65`	`],`
`@@ -66,7 +68,7 @@`
`66`	`68`	`"header": [],`
`67`	`69`	`"body": {`
`68`	`70`	`"mode": "raw",`
`69`		`- "raw": "{\n \"name\": \"AI Phone\",\n \"data\": {\n \"year\": {{$currentYear}},\n \"price\": {{$randomPrice}}\n }\n}",`
	`71`	`+ "raw": "{\n \"name\": \"AI Phone\", \"data\": {\n \"year\": {{$currentYear}},\n \"price\": {{$randomPrice}}\n }\n}",`
`70`	`72`	`"options": {`
`71`	`73`	`"raw": {`
`72`	`74`	`"language": "json"`
`@@ -106,4 +108,4 @@`
`106`	`108`	`"response": []`
`107`	`109`	`}`
`108`	`110`	`]`
`109`		`-}`
	`111`	`+}`