Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bridge between ApplicativeError and ApplicativeThrow #4616

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion core/src/main/scala/cats/ApplicativeError.scala
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

package cats

import cats.ApplicativeError.CatchOnlyPartiallyApplied
import cats.ApplicativeError.{CatchOnlyAsPartiallyApplied, CatchOnlyPartiallyApplied}
import cats.data.{EitherT, Validated}
import cats.data.Validated.{Invalid, Valid}

Expand Down Expand Up @@ -287,6 +287,26 @@ trait ApplicativeError[F[_], E] extends Applicative[F] {
def catchOnly[T >: Null <: Throwable]: CatchOnlyPartiallyApplied[T, F, E] =
new CatchOnlyPartiallyApplied[T, F, E](this)

/**
* Often E can be created from Throwable. Here we try to call pure or
* catch, adapt into E, and raise.
*
* Exceptions that cannot be adapted to E will be propagated
*/
def catchNonFatalAs[A](adaptIfPossible: Throwable => Option[E])(a: => A): F[A] =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably prefer to deal with PartialFunction in such a case. Not only it allows to avoid an extra allocation, but also simpler to write a handler, e.g:

def catchNonFatalAs[A](adaptIfPossible: PartialFunction[Throwable, E])...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not mentioning that the handler would look more like a regular catch in that case.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, using PFs for error handling is a common practice 👍🏻

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would expect most times adaptIfPossible will be a method reference, so it would look like this:

ApplicativeError[Either[E, *], E].catchNonFatalAs(E.fromThrowable) { 
  // block
}

I'm open to being wrong about this, I just expect this sort of transformation won't generally written at the call sites because, if you need to do this, you probably need to do it more than once.

try pure(a)
catch {
case e if NonFatal(e) => adaptIfPossible(e).map(raiseError[A]).getOrElse(throw e)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line concerns me quite a lot, particularly throw e.
It means that the exception will be re-thrown out of the F context, which is not what I would expect from any ApplicativeError instance.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless we require the adaptation function to be total, we're going to need to rethrow these, because there isn't a way to raise a Throwable into an arbitrary ApplicativeError[F, E]

Copy link
Member

@armanbilge armanbilge Jun 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, exactly. This is why we must not use a PartialFunction as you suggested in #4616 (comment). See my comments in #4286 (comment).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@armanbilge , PartialFunction[A, B] and A => Option[B] are isomorphic. Do I understand correctly your point that we must not use either of them?

}

/**
* Evaluates the specified block, catching exceptions of the specified type and attempting to map them to `E`.
*
* Uncaught exceptions and those that cannot be adapted to E will be propagated.
*/
def catchOnlyAs[T >: Null <: Throwable]: CatchOnlyAsPartiallyApplied[T, F, E] =
morgen-peschke marked this conversation as resolved.
Show resolved Hide resolved
new CatchOnlyAsPartiallyApplied[T, F, E](this)

/**
* If the error type is Throwable, we can convert from a scala.util.Try
*/
Expand Down Expand Up @@ -383,6 +403,16 @@ object ApplicativeError {
}
}

final private[cats] class CatchOnlyAsPartiallyApplied[T >: Null <: Throwable, F[_], E](
private val F: ApplicativeError[F, E]
) extends AnyVal {
def apply[A](adaptIfPossible: T => Option[E])(f: => A)(implicit CT: ClassTag[T], NT: NotNull[T]): F[A] =
try F.pure(f)
catch {
case CT(t) => adaptIfPossible(t).map(F.raiseError[A]).getOrElse(throw t)
}
}

/**
* lift from scala.Option[A] to a F[A]
*
Expand Down
33 changes: 33 additions & 0 deletions tests/shared/src/test/scala/cats/tests/EitherSuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ package cats.tests

import cats._
import cats.data.{EitherT, NonEmptyChain, NonEmptyList, NonEmptySet, NonEmptyVector, Validated}
import cats.syntax.option._
import cats.syntax.bifunctor._
import cats.kernel.laws.discipline.{EqTests, MonoidTests, OrderTests, PartialOrderTests, SemigroupTests}
import cats.laws.discipline._
Expand Down Expand Up @@ -136,6 +137,38 @@ class EitherSuite extends CatsSuite {
assert(Either.catchNonFatal(throw new Throwable("blargh")).isLeft)
}

test("ApplicativeError instance catchNonFatalAs maps exceptions to E") {
val res = ApplicativeError[Either[String, *], String].catchNonFatalAs(_.getMessage.some)("foo".toInt)
assert(res === Left("For input string: \"foo\""))
}

test("ApplicativeError instance catchNonFatalAs propagates unmappable exceptions") {
val _ = intercept[NumberFormatException] {
ApplicativeError[Either[String, *], String].catchNonFatalAs(_ => none[String])("foo".toInt)
}
}

test("ApplicativeError instance catchOnlyAs maps exceptions to E") {
val res =
ApplicativeError[Either[String, *], String]
.catchOnlyAs[NumberFormatException](_.getMessage.some)("foo".toInt)
assert(res === Left("For input string: \"foo\""))
}

test("ApplicativeError instance catchOnlyAs propagates unmappable exceptions") {
val _ = intercept[NumberFormatException] {
ApplicativeError[Either[String, *], String]
.catchOnlyAs[NumberFormatException](_ => none[String])("foo".toInt)
}
}

test("ApplicativeError instance catchOnlyAs propagates non-matching exceptions") {
val _ = intercept[NumberFormatException] {
ApplicativeError[Either[String, *], String]
.catchOnlyAs[IndexOutOfBoundsException](_.getMessage.some)("foo".toInt)
}
}

test("fromTry is left for failed Try") {
forAll { (t: Try[Int]) =>
assert(t.isFailure === (Either.fromTry(t).isLeft))
Expand Down