Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix Potential Nontermination When Layer Fails With Error #3994

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 22, 2020
Merged

Fix Potential Nontermination When Layer Fails With Error #3994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
108063f
fix ZIO#foreachPar_
adamgfraser Jul 21, 2020
b8e8905
Merge branch 'master' of https://github.com/zio/zio into zlayer
adamgfraser Jul 21, 2020
f816658
cleanup
adamgfraser Jul 22, 2020
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
11 changes: 11 additions & 0 deletions core-tests/shared/src/test/scala/zio/ZLayerSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package zio

import zio.clock._
import zio.duration._
import zio.test.Assertion._
import zio.test.TestAspect.nonFlaky
import zio.test._
Expand Down Expand Up @@ -354,6 +356,15 @@ object ZLayerSpec extends ZIOBaseSpec {
_ <- layer.build.useNow.ignore
result <- ref.get
} yield assert(result)(equalTo(4))
},
testM("error handling") {
val sleep = ZIO.sleep(100.milliseconds).provideLayer(Clock.live)
val layer1 = ZLayer.fail("foo")
val layer2 = ZLayer.succeed("bar")
val layer3 = ZLayer.succeed("baz")
val layer4 = ZLayer.fromAcquireRelease(sleep)(_ => sleep)
val env = layer1 ++ ((layer2 ++ layer3) >+> layer4)
assertM(ZIO.unit.provideCustomLayer(env).run)(fails(equalTo("foo")))
}
)
}
19 changes: 9 additions & 10 deletions core/shared/src/main/scala/zio/ZIO.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2812,11 +2812,10 @@ object ZIO extends ZIOCompanionPlatformSpecific {
else {
val size = as.size
for {
parentId <- ZIO.fiberId
causes <- Ref.make[Cause[E]](Cause.empty)
result <- Promise.make[Nothing, Boolean]
failureTrigger <- Promise.make[Unit, Unit]
status <- Ref.make((0, 0, false))
parentId <- ZIO.fiberId
causes <- Ref.make[Cause[E]](Cause.empty)
result <- Promise.make[Unit, Unit]
status <- Ref.make((0, 0, false))

startTask = status.modify {
case (started, done, failing) =>
Expand All @@ -2829,7 +2828,7 @@ object ZIO extends ZIOCompanionPlatformSpecific {

startFailure = status.update {
case (started, done, _) => (started, done, true)
} *> failureTrigger.fail(())
} *> result.fail(())

task = ZIOFn(f)((a: A) =>
ZIO
Expand All @@ -2845,21 +2844,21 @@ object ZIO extends ZIOCompanionPlatformSpecific {
((if (failing) started else size) == newDone, (started, newDone, failing))
}
ZIO.whenM(isComplete) {
result.complete(failureTrigger.succeed(()))
result.succeed(())
}
}
}
.uninterruptible
)

fibers <- ZIO.foreach(as)(a => task(a).fork)
interrupter = failureTrigger.await
interrupter = result.await
.catchAll(_ => ZIO.foreach(fibers)(_.interruptAs(parentId).fork) >>= Fiber.joinAll)
.forkManaged
_ <- interrupter.use_ {
ZIO
.whenM(result.await.map(!_)) {
causes.get.flatMap(ZIO.halt(_))
.whenM(ZIO.foreach(fibers)(_.await).map(_.exists(!_.succeeded))) {
Copy link
Member

Choose a reason for hiding this comment

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

Nothing is awaiting the result with this change. Is it still required?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right. Deleted the old result and renamed failureTrigger to result.

result.fail(()) *> causes.get.flatMap(ZIO.halt(_))
}
.refailWithTrace
}
Expand Down
54 changes: 33 additions & 21 deletions core/shared/src/main/scala/zio/ZLayer.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* A symbolic alias for `orElse`.
*/
def <>[RIn1 <: RIn, E1, ROut1 >: ROut](
that: => ZLayer[RIn1, E1, ROut1]
that: ZLayer[RIn1, E1, ROut1]
)(implicit ev: CanFail[E]): ZLayer[RIn1, E1, ROut1] =
self.orElse(that)

Expand All @@ -72,7 +72,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* outputs of both this layer and the specified layer.
*/
final def >+>[E1 >: E, RIn2 >: ROut, ROut1 >: ROut, ROut2](
that: => ZLayer[RIn2, E1, ROut2]
that: ZLayer[RIn2, E1, ROut2]
)(implicit ev: Has.AreHas[ROut1, ROut2], tagged: Tag[ROut2]): ZLayer[RIn, E1, ROut1 with ROut2] =
self ++ (self >>> that)

Expand All @@ -81,8 +81,8 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* layer, resulting in a new layer with the inputs of this layer, and the
* outputs of the specified layer.
*/
final def >>>[E1 >: E, ROut2](that: => ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2] =
fold(ZLayer.second >>> ZLayer.fromFunctionManyM(ZIO.halt(_)), that)
final def >>>[E1 >: E, ROut2](that: ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2] =
fold(ZLayer.fromFunctionManyM { case (_, cause) => ZIO.halt(cause) }, that)

/**
* A named alias for `++`.
Expand All @@ -96,7 +96,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* A named alias for `>+>`.
*/
final def andTo[E1 >: E, RIn2 >: ROut, ROut1 >: ROut, ROut2](
that: => ZLayer[RIn2, E1, ROut2]
that: ZLayer[RIn2, E1, ROut2]
)(implicit ev: Has.AreHas[ROut1, ROut2], tagged: Tag[ROut2]): ZLayer[RIn, E1, ROut1 with ROut2] =
self >+> that

Expand All @@ -114,7 +114,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* Recovers from all errors.
*/
final def catchAll[RIn1 <: RIn, E1, ROut1 >: ROut](
handler: => ZLayer[(RIn1, E), E1, ROut1]
handler: ZLayer[(RIn1, E), E1, ROut1]
): ZLayer[RIn1, E1, ROut1] = {
val failureOrDie: ZLayer[(RIn1, Cause[E]), Nothing, (RIn1, E)] =
ZLayer.fromFunctionManyM {
Expand All @@ -133,10 +133,10 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* the inputs of this layer, and the error or outputs of the specified layer.
*/
final def fold[E1, RIn1 <: RIn, ROut2](
failure: => ZLayer[(RIn1, Cause[E]), E1, ROut2],
success: => ZLayer[ROut, E1, ROut2]
failure: ZLayer[(RIn1, Cause[E]), E1, ROut2],
success: ZLayer[ROut, E1, ROut2]
)(implicit ev: CanFail[E]): ZLayer[RIn1, E1, ROut2] =
ZLayer.Fold(self, () => failure, () => success)
ZLayer.Fold(self, failure, success)

/**
* Creates a fresh version of this layer that will not be shared.
Expand Down Expand Up @@ -183,7 +183,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
* executes the specified layer.
*/
final def orElse[RIn1 <: RIn, E1, ROut1 >: ROut](
that: => ZLayer[RIn1, E1, ROut1]
that: ZLayer[RIn1, E1, ROut1]
)(implicit ev: CanFail[E]): ZLayer[RIn1, E1, ROut1] =
catchAll(ZLayer.first >>> that)

Expand All @@ -205,7 +205,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
s => ZIO.succeed((r, s))
)
}
update >>> loop.fresh
update >>> ZLayer.suspend(loop.fresh)
}
ZLayer.identity <&> ZLayer.fromEffectMany(schedule.initial) >>> loop
}
Expand All @@ -219,7 +219,7 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
/**
* A named alias for `>>>`.
*/
final def to[E1 >: E, ROut2](that: => ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2] =
final def to[E1 >: E, ROut2](that: ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2] =
self >>> that

/**
Expand Down Expand Up @@ -260,14 +260,16 @@ sealed trait ZLayer[-RIn, +E, +ROut] { self =>
memoMap
.getOrElseMemoize(self)
.foldCauseM(
e => ZManaged.environment[RIn].flatMap(r => memoMap.getOrElseMemoize(failure()).provide((r, e))),
r => memoMap.getOrElseMemoize(success()).provide(r)(NeedsEnv.needsEnv)
e => ZManaged.environment[RIn].flatMap(r => memoMap.getOrElseMemoize(failure).provide((r, e))),
r => memoMap.getOrElseMemoize(success).provide(r)(NeedsEnv.needsEnv)
)
)
case ZLayer.Fresh(self) =>
Managed.succeed(_ => self.build)
case ZLayer.Managed(self) =>
Managed.succeed(_ => self)
case ZLayer.Suspend(self) =>
ZManaged.succeed(memoMap => memoMap.getOrElseMemoize(self()))
case ZLayer.ZipWithPar(self, that, f) =>
ZManaged.succeed(memoMap => memoMap.getOrElseMemoize(self).zipWithPar(memoMap.getOrElseMemoize(that))(f))
}
Expand All @@ -279,11 +281,12 @@ object ZLayer {

private final case class Fold[RIn, E, E1, ROut, ROut1](
self: ZLayer[RIn, E, ROut],
failure: () => ZLayer[(RIn, Cause[E]), E1, ROut1],
success: () => ZLayer[ROut, E1, ROut1]
failure: ZLayer[(RIn, Cause[E]), E1, ROut1],
success: ZLayer[ROut, E1, ROut1]
) extends ZLayer[RIn, E1, ROut1]
private final case class Fresh[RIn, E, ROut](self: ZLayer[RIn, E, ROut]) extends ZLayer[RIn, E, ROut]
private final case class Managed[-RIn, +E, +ROut](self: ZManaged[RIn, E, ROut]) extends ZLayer[RIn, E, ROut]
private final case class Suspend[-RIn, +E, +ROut](self: () => ZLayer[RIn, E, ROut]) extends ZLayer[RIn, E, ROut]
private final case class ZipWithPar[-RIn, +E, ROut, ROut2, ROut3](
self: ZLayer[RIn, E, ROut],
that: ZLayer[RIn, E, ROut2],
Expand All @@ -299,7 +302,7 @@ object ZLayer {
/**
* Constructs a layer that fails with the specified value.
*/
def fail[E](e: => E): Layer[E, Nothing] =
def fail[E](e: E): Layer[E, Nothing] =
ZLayer(ZManaged.fail(e))

/**
Expand Down Expand Up @@ -2161,15 +2164,24 @@ object ZLayer {
/**
* Constructs a layer from the specified value.
*/
def succeed[A: Tag](a: => A): ULayer[Has[A]] =
ZLayer(ZManaged.succeed(Has(a)))
def succeed[A: Tag](a: A): ULayer[Has[A]] =
ZLayer(ZManaged.succeedNow(Has(a)))

/**
* Constructs a layer from the specified value, which must return one or more
* services.
*/
def succeedMany[A](a: => A): ULayer[A] =
ZLayer(ZManaged.succeed(a))
def succeedMany[A](a: A): ULayer[A] =
ZLayer(ZManaged.succeedNow(a))

/**
* Lazily constructs a layer. This is useful to avoid infinite recursion when
* creating layers that refer to themselves.
*/
def suspend[RIn, E, ROut](layer: => ZLayer[RIn, E, ROut]): ZLayer[RIn, E, ROut] = {
lazy val self = layer
Suspend(() => self)
}

implicit final class ZLayerPassthroughOps[RIn, E, ROut](private val self: ZLayer[RIn, E, ROut]) extends AnyVal {

Expand Down