Use awaitable state machine in reversal info collection controller (#105)

* Use awaitable state machine in reversal info collection controller

* Address review comments

Author: ametke

gradle/libs.versions.toml

@@ -7,7 +7,7 @@ domainApiKfsmv2 = "0.1.0"
 guice = "7.0.0"
 jodaMoney = "1.0.7"
 kfsm = "0.12.0"
-kfsmv2 = "2.0.0"
+kfsmv2 = "2.1.0"
 kotest = "5.9.1"
 kotlinxCoroutines = "1.10.2"
 kotestArrow = "2.0.0"

innie/src/main/kotlin/xyz/block/bittycity/innie/controllers/ReversalInfoCollectionController.kt

@@ -5,6 +5,8 @@ import app.cash.kfsm.v2.StateMachine
 import app.cash.quiver.extensions.catch
 import arrow.core.raise.result
 import jakarta.inject.Inject
+import jakarta.inject.Named
+import kotlin.time.Duration.Companion.milliseconds
 import xyz.block.bittycity.common.client.CurrencyDisplayPreferenceClient
 import xyz.block.bittycity.common.utils.WalletAddressParser
 import xyz.block.bittycity.innie.fsm.DepositEffect
@@ -29,7 +31,8 @@ class ReversalInfoCollectionController @Inject constructor(
   awaitableStateMachine: AwaitableStateMachine<DepositToken, Deposit, DepositState, DepositEffect>,
   depositStore: DepositStore,
   private val currencyDisplayPreferenceClient: CurrencyDisplayPreferenceClient,
-  private val walletAddressParser: WalletAddressParser
+  private val walletAddressParser: WalletAddressParser,
+  @param:Named("deposit.stateMachineTimeoutInMilliSeconds") private val stateMachineTimeoutInMilliSeconds: Long,
 ) : DepositInfoCollectionController(
   pendingCollectionState = CollectingReversalInfo,
   stateMachine = stateMachine,
@@ -74,7 +77,11 @@ class ReversalInfoCollectionController @Inject constructor(
 
   override fun transition(value: Deposit): Result<Deposit> = result {
     when (value.state) {
-      is CollectingReversalInfo -> stateMachine.transition(value, ReversalInfoCollectionComplete()).bind()
+      is CollectingReversalInfo -> awaitableStateMachine.transitionAndAwait(
+        value,
+        ReversalInfoCollectionComplete(),
+        stateMachineTimeoutInMilliSeconds.milliseconds
+      ).bind()
       else -> raise(IllegalStateException("Unexpected state ${value.state}"))
     }
   }

innie/src/test/kotlin/xyz/block/bittycity/innie/controllers/ReversalInfoCollectionControllerTest.kt

@@ -5,11 +5,11 @@ import io.kotest.matchers.types.shouldBeInstanceOf
 import io.kotest.property.arbitrary.next
 import jakarta.inject.Inject
 import org.junit.jupiter.api.Test
-import xyz.block.bittycity.innie.models.CheckingReversalSanctions
 import xyz.block.bittycity.innie.models.CollectingReversalInfo
 import xyz.block.bittycity.innie.models.DepositFailureReason.RISK_BLOCKED
 import xyz.block.bittycity.innie.models.DepositReversal
 import xyz.block.bittycity.innie.models.DepositReversalHurdle
+import xyz.block.bittycity.innie.models.WaitingForReversalPendingConfirmationStatus
 import xyz.block.bittycity.innie.testing.Arbitrary
 import xyz.block.bittycity.innie.testing.Arbitrary.amount
 import xyz.block.bittycity.innie.testing.Arbitrary.balanceId
@@ -82,14 +82,19 @@ class ReversalInfoCollectionControllerTest : BittyCityTestCase() {
       it.copy(failureReason = RISK_BLOCKED)
     }
 
-    val result = subject.processInputs(
-      deposit,
-      emptyList(),
-      Operation.EXECUTE
-    ).getOrThrow()
+    try {
+      startProcessingEffects()
+      val result = subject.processInputs(
+        deposit,
+        emptyList(),
+        Operation.EXECUTE
+      ).getOrThrow()
 
-    result.shouldBeInstanceOf<ProcessingState.Complete<*, *>>()
+      result.shouldBeInstanceOf<ProcessingState.Complete<*, *>>()
 
-    depositWithToken(deposit.id).state shouldBe CheckingReversalSanctions
+      depositWithToken(deposit.id).state shouldBe WaitingForReversalPendingConfirmationStatus
+    } finally {
+      stopProcessingEffects()
+    }
   }
 }

innie/src/test/kotlin/xyz/block/bittycity/innie/controllers/ReversalSanctionsControllerTest.kt

@@ -1,7 +1,9 @@
 package xyz.block.bittycity.innie.controllers
 
+import app.cash.kfsm.v2.WorkflowFailedException
 import app.cash.quiver.extensions.failure
 import app.cash.quiver.extensions.success
+import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.should
 import io.kotest.matchers.shouldBe
@@ -10,13 +12,12 @@ import jakarta.inject.Inject
 import org.junit.jupiter.api.Test
 import xyz.block.bittycity.common.client.Evaluation
 import xyz.block.bittycity.innie.api.DepositDomainController
-import xyz.block.bittycity.innie.models.CheckingReversalRisk
-import xyz.block.bittycity.innie.models.CheckingReversalSanctions
 import xyz.block.bittycity.innie.models.CollectingReversalInfo
 import xyz.block.bittycity.innie.models.CollectingReversalSanctionsInfo
 import xyz.block.bittycity.innie.models.DepositFailureReason.RISK_BLOCKED
 import xyz.block.bittycity.innie.models.DepositReversal
 import xyz.block.bittycity.innie.models.DepositReversalFailureReason
+import xyz.block.bittycity.innie.models.WaitingForReversalPendingConfirmationStatus
 import xyz.block.bittycity.innie.testing.Arbitrary
 import xyz.block.bittycity.innie.testing.Arbitrary.amount
 import xyz.block.bittycity.innie.testing.Arbitrary.balanceId
@@ -60,10 +61,13 @@ class ReversalSanctionsControllerTest : BittyCityTestCase() {
 
     sanctionsClient.nextEvaluation = Evaluation.APPROVE.success()
 
-    subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
-    app.effectProcessor.processAll()
-
-    depositWithToken(deposit.id).state shouldBe CheckingReversalRisk
+    try {
+      startProcessingEffects()
+      subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
+      depositWithToken(deposit.id).state shouldBe WaitingForReversalPendingConfirmationStatus
+    } finally {
+      stopProcessingEffects()
+    }
   }
 
   @Test
@@ -94,13 +98,16 @@ class ReversalSanctionsControllerTest : BittyCityTestCase() {
 
     sanctionsClient.nextEvaluation = Evaluation.FAIL.success()
 
-    subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
-    app.processAllEffects()
-
-    depositWithToken(deposit.id) should {
-      it.state shouldBe CollectingReversalInfo
-      it.currentReversal.shouldNotBeNull()
-      it.currentReversal?.failureReason shouldBe DepositReversalFailureReason.SANCTIONS_FAILED
+    try {
+      startProcessingEffects()
+      subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
+      depositWithToken(deposit.id) should {
+        it.state shouldBe CollectingReversalInfo
+        it.currentReversal.shouldNotBeNull()
+        it.currentReversal?.failureReason shouldBe DepositReversalFailureReason.SANCTIONS_FAILED
+      }
+    } finally {
+      stopProcessingEffects()
     }
   }
 
@@ -132,10 +139,13 @@ class ReversalSanctionsControllerTest : BittyCityTestCase() {
 
     sanctionsClient.nextEvaluation = RuntimeException("Something went wrong").failure()
 
-    subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
-    app.processAllEffects()
-
-    depositWithToken(deposit.id).state shouldBe CheckingReversalSanctions
+    try {
+      startProcessingEffects()
+      shouldThrow<WorkflowFailedException> { subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow() }
+      depositWithToken(deposit.id).state shouldBe CollectingReversalInfo
+    } finally {
+      stopProcessingEffects()
+    }
   }
 
   @Test
@@ -166,9 +176,12 @@ class ReversalSanctionsControllerTest : BittyCityTestCase() {
 
     sanctionsClient.nextEvaluation = Evaluation.HOLD.success()
 
-    subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
-    app.processAllEffects()
-
-    depositWithToken(deposit.id).state shouldBe CollectingReversalSanctionsInfo
+    try {
+      startProcessingEffects()
+      subject.execute(deposit, emptyList(), Operation.EXECUTE).getOrThrow()
+      depositWithToken(deposit.id).state shouldBe CollectingReversalSanctionsInfo
+    } finally {
+      stopProcessingEffects()
+    }
   }
 }

innie/src/test/kotlin/xyz/block/bittycity/innie/testing/TestApp.kt

@@ -17,6 +17,9 @@ import xyz.block.bittycity.innie.models.DepositState
 import xyz.block.bittycity.innie.models.DepositToken
 import xyz.block.bittycity.innie.store.DepositStore
 import java.time.Instant
+import java.util.concurrent.Executors
+import java.util.concurrent.ScheduledExecutorService
+import java.util.concurrent.TimeUnit
 
 class TestApp {
 
@@ -49,6 +52,8 @@ class TestApp {
     depositOperations.clear()
   }
 
+  private var effectProcessingExecutor: ScheduledExecutorService? = null
+
   /**
    * Process all pending effects until no more remain.
    * This is useful for tests that need to wait for multi-step workflows to complete.
@@ -59,6 +64,24 @@ class TestApp {
     }
   }
 
+  /**
+   * Start continuously processing effects on a background thread.
+   * This is required for tests that use [AwaitableStateMachine.transitionAndAwait],
+   * since it blocks the calling thread while polling for a settled state.
+   */
+  fun startProcessingEffects() {
+    val executor = Executors.newSingleThreadScheduledExecutor { runnable ->
+      Thread(runnable, "effect-processor").apply { isDaemon = true }
+    }
+    executor.scheduleWithFixedDelay({ effectProcessor.processAll() }, 0, 10, TimeUnit.MILLISECONDS)
+    effectProcessingExecutor = executor
+  }
+
+  fun stopProcessingEffects() {
+    effectProcessingExecutor?.shutdownNow()
+    effectProcessingExecutor = null
+  }
+
   fun TestRunData.seedDeposit(
     id: DepositToken = Arbitrary.depositToken.next(),
     state: DepositState = newDeposit.state,

innie/src/test/kotlin/xyz/block/bittycity/innie/testing/TestModule.kt

@@ -4,6 +4,7 @@ import com.google.inject.AbstractModule
 import com.google.inject.Provides
 import com.google.inject.Scopes
 import com.google.inject.TypeLiteral
+import com.google.inject.name.Names
 import com.squareup.moshi.Moshi
 import io.kotest.property.arbitrary.next
 import jakarta.inject.Singleton
@@ -31,6 +32,8 @@ class TestModule : AbstractModule() {
     bind(TestApp::class.java).`in`(Scopes.SINGLETON)
     bind(TestRunData::class.java).toInstance(Arbitrary.testRunData.next())
 
+    bind(Long::class.java).annotatedWith(Names.named("deposit.stateMachineTimeoutInMilliSeconds")).toInstance(10000L)
+
     // Bind the concrete generic type that Guice expects
     bind(object : TypeLiteral<IdempotencyOperations<DepositToken, RequirementId>>() {})
       .to(FakeResponseOperations::class.java)