- Refactor pre and post step hooks

- Add javadocs to few steps

Signed-off-by: Gopal S Akshintala <[email protected]>

Author: overfullstack

src/main/kotlin/com/salesforce/revoman/input/config/KickDef.kt

@@ -60,8 +60,8 @@ internal interface KickDef {
 
   @Value.Derived fun postHooks(): List<HookConfig> = hooks().filter { it.pick is PostTxnStepPick }
 
-  // * NOTE 29/10/23 gopala.akshintala: requestConfig/responseConfig are decoupled from pre- /
-  // post-hook to allow setting up unmarshalling to strong types on the final rundown for
+  // * NOTE 29/10/23 gopala.akshintala: requestConfig/responseConfig are decoupled from pre-step /
+  // post-step hook to allow setting up unmarshalling to strong types on the final rundown for
   // post-execution assertions agnostic of whether the step has any hooks
 
   fun requestConfig(): Set<RequestConfig>

src/main/kotlin/com/salesforce/revoman/input/config/StepPick.kt

@@ -35,6 +35,13 @@ sealed interface StepPick {
     fun pick(currentStep: Step, currentRequestInfo: TxnInfo<Request>, rundown: Rundown): Boolean
 
     companion object PickUtils {
+      /**
+       * If there are steps with the same name, you may pass the stepName along with the folderPath,
+       * where each folder is seperated by FOLDER_DELIMITER {@see com.salesforce.revoman.output.report.Folder.FOLDER_DELIMITER}
+       * You may not have to pass the entire path,
+       * you can pass the path from the Least common Ancestor
+       * to uniquely identify the step of your interest to add this Hook
+       */
       @JvmStatic
       fun beforeStepName(vararg stepNameSubstrings: String) = PreTxnStepPick { currentStep, _, _ ->
         stepNameSubstrings.any { currentStep.stepNameMatches(it) }
@@ -50,6 +57,9 @@ sealed interface StepPick {
         requestInfo.containsHeader(key)
       }
 
+      /**
+       * Provide either a full URI path or a partial URI path that can uniquely identify the request
+       */
       @JvmStatic
       fun beforeStepContainingURIPathOfAny(vararg paths: String) =
         PreTxnStepPick { _, requestInfo, _ ->
@@ -62,6 +72,13 @@ sealed interface StepPick {
     @Throws(Throwable::class) fun pick(currentStepReport: StepReport, rundown: Rundown): Boolean
 
     companion object PickUtils {
+      /**
+       * If there are steps with the same name, you may pass the stepName along with the folderPath, 
+       * where each folder is seperated by FOLDER_DELIMITER {@see com.salesforce.revoman.output.report.Folder.FOLDER_DELIMITER}
+       * You may not have to pass the entire path,
+       * you can pass the path from the Least common Ancestor
+       * to uniquely identify the step of your interest to add this Hook 
+       */
       @JvmStatic
       fun afterStepName(vararg stepNameSubstrings: String) = PostTxnStepPick { stepReport, _ ->
         stepNameSubstrings.any { stepReport.step.stepNameMatches(it) }
@@ -77,6 +94,9 @@ sealed interface StepPick {
         stepReport.requestInfo.containsHeader(key)
       }
 
+      /**
+       * Provide either a full URI path or a partial URI path that can uniquely identify the request
+       */
       @JvmStatic
       fun afterStepContainingURIPathOfAny(vararg paths: String) = PostTxnStepPick { stepReport, _ ->
         paths.any { stepReport.requestInfo.uriPathContains(it) }

src/main/kotlin/com/salesforce/revoman/internal/exe/PostStepHook.kt

@@ -20,7 +20,6 @@ import io.github.oshai.kotlinlogging.KotlinLogging
 
 internal fun postHookExe(kick: Kick, pm: PostmanSDK): PostStepHookFailure? =
   pickPostHooks(kick.postHooks(), pm.currentStepReport, pm.rundown)
-    .asSequence()
     .map { postHook ->
       runChecked(pm.currentStepReport.step, POST_STEP_HOOK) {
           postHook.accept(pm.currentStepReport, pm.rundown)
@@ -34,16 +33,15 @@ private fun pickPostHooks(
   postHooks: List<HookConfig>,
   currentStepReport: StepReport,
   rundown: Rundown,
-): List<PostStepHook> =
+): Sequence<PostStepHook> =
   postHooks
     .asSequence()
     .filter { (it.pick as PostTxnStepPick).pick(currentStepReport, rundown) }
     .map { it.stepHook as PostStepHook }
-    .toList()
     .also {
-      if (it.isNotEmpty()) {
-        logger.info { "${currentStepReport.step} Picked Post hook count : ${it.size}" }
-        currentStepReport.step.postHookCount = it.size
+      if (it.iterator().hasNext()) {
+        logger.info { "${currentStepReport.step} Picked Post hook count : ${it.count()}" }
+        currentStepReport.step.postHookCount = it.count()
       }
     }
 

src/main/kotlin/com/salesforce/revoman/internal/exe/PreStepHook.kt

@@ -27,7 +27,6 @@ internal fun preHookExe(
   pm: PostmanSDK,
 ): PreStepHookFailure? =
   pickPreHooks(kick.preHooks(), currentStep, requestInfo, pm.rundown)
-    .asSequence()
     .map { preHook ->
       runChecked(currentStep, PRE_STEP_HOOK) {
           preHook.accept(currentStep, requestInfo, pm.rundown)
@@ -42,16 +41,15 @@ private fun pickPreHooks(
   currentStep: Step,
   requestInfo: TxnInfo<Request>,
   rundown: Rundown,
-): List<PreStepHook> =
+): Sequence<PreStepHook> =
   preHooks
     .asSequence()
     .filter { (it.pick as PreTxnStepPick).pick(currentStep, requestInfo, rundown) }
     .map { it.stepHook as PreStepHook }
-    .toList()
     .also {
-      if (it.isNotEmpty()) {
-        logger.info { "$currentStep Picked Pre hook count : ${it.size}" }
-        currentStep.preHookCount = it.size
+      if (it.iterator().hasNext()) {
+        logger.info { "$currentStep Picked Pre hook count : ${it.count()}" }
+        currentStep.preHookCount = it.count()
       }
     }
 

src/main/kotlin/com/salesforce/revoman/internal/exe/UnmarshallRequest.kt

@@ -41,7 +41,7 @@ internal fun unmarshallRequest(
       ?.objType ?: Any::class.java
   return when {
     isJson(httpRequest) ->
-      runChecked<Any?>(currentStep, UNMARSHALL_REQUEST) {
+      runChecked(currentStep, UNMARSHALL_REQUEST) {
           pmRequest.body?.let { body -> moshiReVoman.asA(body.raw, requestType.rawType.kotlin) }
         }
         .mapLeft { UnmarshallRequestFailure(it, TxnInfo(requestType, null, httpRequest)) }

src/main/kotlin/com/salesforce/revoman/output/report/Step.kt

@@ -69,11 +69,12 @@ constructor(
   @JvmField val path: List<Folder> = parentPath + this
 
   override fun toString(): String =
-    if (isRoot) name
-    else
-      parentPath.joinToString(separator = FOLDER_DELIMITER, postfix = FOLDER_DELIMITER) {
-        it.name
-      } + name
+    when {
+        isRoot -> name
+        else -> parentPath.joinToString(separator = FOLDER_DELIMITER, postfix = FOLDER_DELIMITER) {
+          it.name
+        } + name
+    }
 
   companion object {
     const val FOLDER_DELIMITER = "|>"