WIP: Reusable Raise

arrow-libs/core/arrow-core/api/arrow-core.api

@@ -1024,7 +1024,9 @@ public final class arrow/core/raise/RaiseKt {
 	public static final fun recover (Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
 	public static final fun recover (Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;)Lkotlin/jvm/functions/Function1;
 	public static final fun recover (Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function3;)Lkotlin/jvm/functions/Function2;
+	public static final fun recoverReused-W4bXG9A (Larrow/core/raise/DefaultRaise;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
 	public static final fun result (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
+	public static final fun reusableRaise (Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
 	public static final fun singleton (Lkotlin/jvm/functions/Function0;Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
 	public static final fun toEither (Lkotlin/jvm/functions/Function1;)Larrow/core/Either;
 	public static final fun toEither (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
@@ -1057,6 +1059,10 @@ public final class arrow/core/raise/RaiseKt {
 	public static final fun zipOrAccumulate (Larrow/core/raise/Raise;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;)Ljava/lang/Object;
 }
 
+public final class arrow/core/raise/RaiseLeakedException : java/lang/IllegalStateException {
+	public fun <init> ()V
+}
+
 public final class arrow/core/raise/ResultRaise : arrow/core/raise/Raise {
 	public fun <init> (Larrow/core/raise/Raise;)V
 	public fun bind (Larrow/core/Either;)Ljava/lang/Object;
@@ -1078,6 +1084,20 @@ public final class arrow/core/raise/ResultRaise : arrow/core/raise/Raise {
 	public final fun recover (Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
 }
 
+public final class arrow/core/raise/ReusableRaise {
+	public static final synthetic fun box-impl (Larrow/core/raise/DefaultRaise;)Larrow/core/raise/ReusableRaise;
+	public static fun constructor-impl (Larrow/core/raise/DefaultRaise;)Larrow/core/raise/DefaultRaise;
+	public fun equals (Ljava/lang/Object;)Z
+	public static fun equals-impl (Larrow/core/raise/DefaultRaise;Ljava/lang/Object;)Z
+	public static final fun equals-impl0 (Larrow/core/raise/DefaultRaise;Larrow/core/raise/DefaultRaise;)Z
+	public final fun getRaise ()Larrow/core/raise/DefaultRaise;
+	public fun hashCode ()I
+	public static fun hashCode-impl (Larrow/core/raise/DefaultRaise;)I
+	public fun toString ()Ljava/lang/String;
+	public static fun toString-impl (Larrow/core/raise/DefaultRaise;)Ljava/lang/String;
+	public final synthetic fun unbox-impl ()Larrow/core/raise/DefaultRaise;
+}
+
 public final class arrow/core/raise/SingletonRaise : arrow/core/raise/Raise {
 	public fun <init> (Larrow/core/raise/Raise;)V
 	public fun bind (Larrow/core/Either;)Ljava/lang/Object;

arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Fold.kt

@@ -138,7 +138,7 @@ public inline fun <Error, A, B> fold(
     callsInPlace(recover, AT_MOST_ONCE)
     callsInPlace(transform, AT_MOST_ONCE)
   }
-  val raise = DefaultRaise(false)
+  val raise = DefaultRaise<Error>(false)
   return try {
     val res = block(raise)
     raise.complete()
@@ -201,7 +201,7 @@ public inline fun <Error, A> Raise<Error>.traced(
     callsInPlace(block, AT_MOST_ONCE)
     callsInPlace(trace, AT_MOST_ONCE)
   }
-  val nested = DefaultRaise(true)
+  val nested = DefaultRaise<Error>(true)
   return try {
     block(nested).also { nested.complete() }
   } catch (e: Traced) {
@@ -227,21 +227,20 @@ internal fun Traced.withCause(cause: Traced): Traced =
 @PublishedApi
 @DelicateRaiseApi
 @Suppress("UNCHECKED_CAST")
-internal fun <R> CancellationException.raisedOrRethrow(raise: DefaultRaise): R =
+internal fun <R> CancellationException.raisedOrRethrow(raise: DefaultRaise<R>): R =
   when {
     this is RaiseCancellationException && this.raise === raise -> raised as R
     else -> throw this
   }
 
 /** Serves as both purposes of a scope-reference token, and a default implementation for Raise. */
-@PublishedApi
-internal class DefaultRaise(@PublishedApi internal val isTraced: Boolean) : Raise<Any?> {
+public class DefaultRaise<Error>(@PublishedApi internal val isTraced: Boolean) : Raise<Error> {
   private val isActive = AtomicBoolean(true)
 
   @PublishedApi
   internal fun complete(): Boolean = isActive.getAndSet(false)
   @OptIn(DelicateRaiseApi::class)
-  override fun raise(r: Any?): Nothing = when {
+  override fun raise(r: Error): Nothing = when {
     isActive.value -> throw if (isTraced) Traced(r, this) else NoTrace(r, this)
     else -> throw RaiseLeakedException()
   }
@@ -259,17 +258,18 @@ public annotation class DelicateRaiseApi
 @DelicateRaiseApi
 public sealed class RaiseCancellationException(
   internal val raised: Any?,
-  internal val raise: Raise<Any?>
+  internal val raise: Raise<*>
 ) : CancellationException(RaiseCancellationExceptionCaptured)
 
 @DelicateRaiseApi
 @Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
-internal expect class NoTrace(raised: Any?, raise: Raise<Any?>) : RaiseCancellationException
+internal expect class NoTrace(raised: Any?, raise: Raise<*>) : RaiseCancellationException
 
 @DelicateRaiseApi
-internal class Traced(raised: Any?, raise: Raise<Any?>, override val cause: Traced? = null): RaiseCancellationException(raised, raise)
+internal class Traced(raised: Any?, raise: Raise<*>, override val cause: Traced? = null): RaiseCancellationException(raised, raise)
 
-private class RaiseLeakedException : IllegalStateException(
+@PublishedApi
+internal class RaiseLeakedException : IllegalStateException(
   """
   'raise' or 'bind' was leaked outside of its context scope.
   Make sure all calls to 'raise' and 'bind' occur within the lifecycle of nullable { }, either { } or similar builders.

arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Raise.kt

@@ -16,6 +16,7 @@ import kotlin.contracts.ExperimentalContracts
 import kotlin.contracts.InvocationKind.AT_MOST_ONCE
 import kotlin.contracts.contract
 import kotlin.experimental.ExperimentalTypeInference
+import kotlin.jvm.JvmInline
 import kotlin.jvm.JvmMultifileClass
 import kotlin.jvm.JvmName
 
@@ -309,6 +310,43 @@ public interface Raise<in Error> {
     map { it.bind() }.toNonEmptySet()
 }
 
+@JvmInline public value class ReusableRaise<Error>(public val raise: DefaultRaise<Error>)
+
+@DelicateRaiseApi
+@RaiseDSL
+public inline fun <Error, A> reusableRaise(
+  @BuilderInference block: ReusableRaise<Error>.() -> A,
+): A {
+  contract {
+    callsInPlace(block, AT_MOST_ONCE)
+  }
+  val raise = DefaultRaise<Error>(false)
+  try {
+    return block(ReusableRaise(raise))
+  } catch(e: RaiseCancellationException) {
+    e.raisedOrRethrow(raise)
+    throw RaiseLeakedException()
+  } finally {
+    raise.complete()
+  }
+}
+
+@DelicateRaiseApi
+@RaiseDSL
+public inline fun <Error, A> ReusableRaise<Error>.recoverReused(
+  @BuilderInference block: Raise<Error>.() -> A,
+  recover: (error: Error) -> A
+): A {
+  contract {
+    callsInPlace(block, AT_MOST_ONCE)
+  }
+  return try {
+    block(raise)
+  } catch (e: RaiseCancellationException) {
+    recover(e.raisedOrRethrow(raise))
+  }
+}
+
 /**
  * Execute the [Raise] context function resulting in [A] or any _logical error_ of type [Error],
  * and recover by providing a transform [Error] into a fallback value of type [A].

arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/RaiseAccumulate.kt

@@ -521,21 +521,22 @@ public inline fun <Error, A> Raise<Error>.forEachAccumulating(
   @BuilderInference block: RaiseAccumulate<Error>.(A) -> Unit
 ): Unit = forEachAccumulatingImpl(iterator, combine) { item, _ -> block(item) }
 
+@OptIn(DelicateRaiseApi::class)
 @PublishedApi @JvmSynthetic
 internal inline fun <Error, A> Raise<Error>.forEachAccumulatingImpl(
   iterator: Iterator<A>,
   combine: (Error, Error) -> Error,
   @BuilderInference block: RaiseAccumulate<Error>.(item: A, hasErrors: Boolean) -> Unit
-) {
+): Unit = reusableRaise<NonEmptyList<Error>, _> {
   var error: Any? = EmptyValue
   for (item in iterator) {
-    recover({
+    recoverReused({
       block(RaiseAccumulate(this), item, error != EmptyValue)
     }) { errors ->
       error = combine(error, errors.reduce(combine), combine)
     }
   }
-  return if (error === EmptyValue) Unit else raise(unbox<Error>(error))
+  return if (error === EmptyValue) Unit else this@forEachAccumulatingImpl.raise(unbox<Error>(error))
 }
 
 @RaiseDSL
@@ -560,20 +561,21 @@ public inline fun <Error, A> Raise<NonEmptyList<Error>>.forEachAccumulating(
  * Allows to change what to do once the first error is raised.
  * Used to provide more performant [mapOrAccumulate].
  */
+@OptIn(DelicateRaiseApi::class)
 @PublishedApi @JvmSynthetic
 internal inline fun <Error, A> Raise<NonEmptyList<Error>>.forEachAccumulatingImpl(
   iterator: Iterator<A>,
   @BuilderInference block: RaiseAccumulate<Error>.(item: A, hasErrors: Boolean) -> Unit
-) {
+): Unit = reusableRaise {
   val error: MutableList<Error> = mutableListOf()
   for (item in iterator) {
-    recover({
+    recoverReused({
       block(RaiseAccumulate(this), item, error.isNotEmpty())
     }) {
       error.addAll(it)
     }
   }
-  error.toNonEmptyListOrNull()?.let(::raise)
+  error.toNonEmptyListOrNull()?.let(this@forEachAccumulatingImpl::raise)
 }
 
 /**

arrow-libs/core/arrow-core/src/jvmMain/kotlin/arrow/core/raise/CancellationExceptionNoTrace.kt

@@ -10,7 +10,7 @@ import kotlin.coroutines.cancellation.CancellationException
   "EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING",
   "SEALED_INHERITOR_IN_DIFFERENT_MODULE"
 )
-internal actual class NoTrace actual constructor(raised: Any?, raise: Raise<Any?>) : RaiseCancellationException(raised, raise) {
+internal actual class NoTrace actual constructor(raised: Any?, raise: Raise<*>) : RaiseCancellationException(raised, raise) {
   override fun fillInStackTrace(): Throwable {
     // Prevent Android <= 6.0 bug.
     stackTrace = emptyArray()

arrow-libs/core/arrow-core/src/nonJvmMain/kotlin/arrow/core/raise/CancellationExceptionNoTrace.kt

@@ -4,4 +4,4 @@ package arrow.core.raise
   "EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING",
   "SEALED_INHERITOR_IN_DIFFERENT_MODULE"
 )
-internal actual class NoTrace actual constructor(raised: Any?, raise: Raise<Any?>) : RaiseCancellationException(raised, raise)
+internal actual class NoTrace actual constructor(raised: Any?, raise: Raise<*>) : RaiseCancellationException(raised, raise)

arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/ParMap.kt

@@ -5,7 +5,10 @@ import arrow.core.Either
 import arrow.core.NonEmptyList
 import arrow.core.raise.Raise
 import arrow.core.raise.either
-import arrow.core.flattenOrAccumulate
+import arrow.core.raise.DelicateRaiseApi
+import arrow.core.raise.mapOrAccumulate
+import arrow.core.raise.recoverReused
+import arrow.core.raise.reusableRaise
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.async
 import kotlinx.coroutines.awaitAll
@@ -52,68 +55,100 @@ public class ScopedRaiseAccumulate<Error>(
   scope: CoroutineScope
 ) : CoroutineScope by scope, RaiseAccumulate<Error>(raise)
 
+@OptIn(DelicateRaiseApi::class)
 public suspend fun <Error, A, B> Iterable<A>.parMapOrAccumulate(
   context: CoroutineContext = EmptyCoroutineContext,
   concurrency: Int,
   combine: (Error, Error) -> Error,
   transform: suspend ScopedRaiseAccumulate<Error>.(A) -> B
 ): Either<Error, List<B>> =
-  coroutineScope {
-    val semaphore = Semaphore(concurrency)
-    map {
-      async(context) {
-        either {
-          semaphore.withPermit {
-            transform(ScopedRaiseAccumulate(this, this@coroutineScope), it)
+  either {
+    coroutineScope {
+      reusableRaise<NonEmptyList<Error>, _> {
+        val semaphore = Semaphore(concurrency)
+        val asyncs = map {
+          async(context) {
+            semaphore.withPermit {
+              transform(ScopedRaiseAccumulate(raise, this@coroutineScope), it)
+            }
+          }
+        }
+        mapOrAccumulate(asyncs, combine) {
+          withNel {
+            recoverReused({ it.await() }, this::raise)
           }
         }
       }
-    }.awaitAll().flattenOrAccumulate(combine)
+    }
   }
 
+@OptIn(DelicateRaiseApi::class)
 public suspend fun <Error, A, B> Iterable<A>.parMapOrAccumulate(
   context: CoroutineContext = EmptyCoroutineContext,
   combine: (Error, Error) -> Error,
   transform: suspend ScopedRaiseAccumulate<Error>.(A) -> B
 ): Either<Error, List<B>> =
-  coroutineScope {
-    map {
-      async(context) {
-        either {
-          transform(ScopedRaiseAccumulate(this, this@coroutineScope), it)
+  either {
+    coroutineScope {
+      reusableRaise<NonEmptyList<Error>, _> {
+        val asyncs = map {
+          async(context) {
+            transform(ScopedRaiseAccumulate(raise, this@coroutineScope), it)
+          }
+        }
+        mapOrAccumulate(asyncs, combine) {
+          withNel {
+            recoverReused({ it.await() }, this::raise)
+          }
         }
       }
-    }.awaitAll().flattenOrAccumulate(combine)
+    }
   }
 
+@OptIn(DelicateRaiseApi::class)
 public suspend fun <Error, A, B> Iterable<A>.parMapOrAccumulate(
   context: CoroutineContext = EmptyCoroutineContext,
   concurrency: Int,
   transform: suspend ScopedRaiseAccumulate<Error>.(A) -> B
 ): Either<NonEmptyList<Error>, List<B>> =
-  coroutineScope {
-    val semaphore = Semaphore(concurrency)
-    map {
-      async(context) {
-        either {
-          semaphore.withPermit {
-            transform(ScopedRaiseAccumulate(this, this@coroutineScope), it)
+  either {
+    coroutineScope {
+      reusableRaise<NonEmptyList<Error>, _> {
+        val semaphore = Semaphore(concurrency)
+        val asyncs = map {
+          async(context) {
+            semaphore.withPermit {
+              transform(ScopedRaiseAccumulate(raise, this@coroutineScope), it)
+            }
+          }
+        }
+        mapOrAccumulate(asyncs) {
+          withNel {
+            recoverReused({ it.await() }, this::raise)
           }
         }
       }
-    }.awaitAll().flattenOrAccumulate()
+    }
   }
 
+@OptIn(DelicateRaiseApi::class)
 public suspend fun <Error, A, B> Iterable<A>.parMapOrAccumulate(
   context: CoroutineContext = EmptyCoroutineContext,
   transform: suspend ScopedRaiseAccumulate<Error>.(A) -> B
 ): Either<NonEmptyList<Error>, List<B>> =
-  coroutineScope {
-    map {
-      async(context) {
-        either {
-          transform(ScopedRaiseAccumulate(this, this@coroutineScope), it)
+  either {
+    coroutineScope {
+      reusableRaise<NonEmptyList<Error>, _> {
+        val asyncs = map {
+          async(context) {
+            transform(ScopedRaiseAccumulate(raise, this@coroutineScope), it)
+          }
+        }
+        mapOrAccumulate(asyncs) {
+          withNel {
+            recoverReused({ it.await() }, this::raise)
+          }
         }
       }
-    }.awaitAll().flattenOrAccumulate()
+    }
   }