/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * license agreements; and to You under the Apache License, version 2.0:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * This file is part of the Apache Pekko project, which was derived from Akka.
 */

/*
 * Copyright (C) 2015-2022 Lightbend Inc. <https://www.lightbend.com>
 */

package org.apache.pekko.stream.scaladsl

import scala.concurrent.Promise
import scala.concurrent.duration._

import org.apache.pekko
import pekko.actor.{ Actor, ActorRef, Props }
import pekko.stream.Attributes.inputBuffer
import pekko.stream.Materializer
import pekko.stream.testkit._
import pekko.stream.testkit.scaladsl._
import pekko.testkit.TestProbe

object ActorRefBackpressureSinkSpec {
  val initMessage = "start"
  val completeMessage = "done"
  val failMessage = "failed"
  val ackMessage = "ack"

  class Fw(ref: ActorRef) extends Actor {
    def receive = {
      case `initMessage` =>
        sender() ! ackMessage
        ref.forward(initMessage)
      case `completeMessage` =>
        ref.forward(completeMessage)
      case msg: Int =>
        sender() ! ackMessage
        ref.forward(msg)
    }
  }

  case object TriggerAckMessage

  class Fw2(ref: ActorRef) extends Actor {
    var actorRef: ActorRef = Actor.noSender

    def receive = {
      case TriggerAckMessage =>
        actorRef ! ackMessage
      case msg =>
        actorRef = sender()
        ref.forward(msg)
    }
  }

}

class ActorRefBackpressureSinkSpec extends StreamSpec {
  import ActorRefBackpressureSinkSpec._

  def createActor[T](c: Class[T]) =
    system.actorOf(Props(c, testActor).withDispatcher("pekko.test.stream-dispatcher"))

  "An ActorRefBackpressureSink" must {

    "send the elements to the ActorRef" in {
      val fw = createActor(classOf[Fw])
      Source(List(1, 2, 3))
        .runWith(Sink.actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage))
      expectMsg("start")
      expectMsg(1)
      expectMsg(2)
      expectMsg(3)
      expectMsg(completeMessage)
    }

    "send the elements to the ActorRef2" in {
      val fw = createActor(classOf[Fw])
      val probe = TestSource
        .probe[Int]
        .to(Sink.actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage))
        .run()
      probe.sendNext(1)
      expectMsg("start")
      expectMsg(1)
      probe.sendNext(2)
      expectMsg(2)
      probe.sendNext(3)
      expectMsg(3)
      probe.sendComplete()
      expectMsg(completeMessage)
    }

    "cancel stream when actor terminates" in {
      val fw = createActor(classOf[Fw])
      val publisher =
        TestSource
          .probe[Int]
          .to(Sink.actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage))
          .run()
          .sendNext(1)
      expectMsg(initMessage)
      expectMsg(1)
      system.stop(fw)
      publisher.expectCancellation()
    }

    "send message only when backpressure received" in {
      val fw = createActor(classOf[Fw2])
      val publisher = TestSource
        .probe[Int]
        .to(Sink.actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage))
        .run()
      expectMsg(initMessage)

      publisher.sendNext(1)
      expectNoMessage(200.millis)
      fw ! TriggerAckMessage
      expectMsg(1)

      publisher.sendNext(2)
      publisher.sendNext(3)
      publisher.sendComplete()
      fw ! TriggerAckMessage
      expectMsg(2)
      fw ! TriggerAckMessage
      expectMsg(3)
      fw ! TriggerAckMessage

      expectMsg(completeMessage)
    }

    "send message only when backpressure received with any ack message" in {
      val fw = createActor(classOf[Fw2])
      val publisher = TestSource
        .probe[Int]
        .to(Sink.actorRefWithBackpressure(fw, initMessage, completeMessage, _ => failMessage))
        .run()
      expectMsg(initMessage)

      publisher.sendNext(1)
      expectNoMessage(200.millis)
      fw ! TriggerAckMessage
      expectMsg(1)

      publisher.sendNext(2)
      publisher.sendNext(3)
      publisher.sendComplete()
      fw ! TriggerAckMessage
      expectMsg(2)
      fw ! TriggerAckMessage
      expectMsg(3)
      fw ! TriggerAckMessage

      expectMsg(completeMessage)
    }

    "keep on sending even after the buffer has been full" in {
      val bufferSize = 16
      val streamElementCount = bufferSize + 4
      val fw = createActor(classOf[Fw2])
      val sink = Sink
        .actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage)
        .withAttributes(inputBuffer(bufferSize, bufferSize))
      val bufferFullProbe = Promise[pekko.Done.type]()
      Source(1 to streamElementCount)
        .alsoTo(Flow[Int].drop(bufferSize - 1).to(Sink.foreach(_ => bufferFullProbe.trySuccess(pekko.Done))))
        .to(sink)
        .run()
      bufferFullProbe.future.futureValue should ===(pekko.Done)
      expectMsg(initMessage)
      fw ! TriggerAckMessage
      for (i <- 1 to streamElementCount) {
        expectMsg(i)
        fw ! TriggerAckMessage
      }
      expectMsg(completeMessage)
    }

    "work with one element buffer" in {
      val fw = createActor(classOf[Fw2])
      val publisher =
        TestSource
          .probe[Int]
          .to(
            Sink
              .actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage)
              .withAttributes(inputBuffer(1, 1)))
          .run()

      expectMsg(initMessage)
      fw ! TriggerAckMessage

      publisher.sendNext(1)
      expectMsg(1)

      fw ! TriggerAckMessage
      expectNoMessage(200.millis) // Ack received but buffer empty

      publisher.sendNext(2) // Buffer this value
      fw ! TriggerAckMessage
      expectMsg(2)

      publisher.sendComplete()
      expectMsg(completeMessage)
    }

    "fail to materialize with zero sized input buffer" in {
      val fw = createActor(classOf[Fw])
      an[IllegalArgumentException] shouldBe thrownBy {
        val badSink =
          Sink
            .actorRefWithBackpressure(fw, initMessage, ackMessage, completeMessage, _ => failMessage)
            .withAttributes(inputBuffer(0, 0))
        Source.single(()).runWith(badSink)
      }
    }

    "signal failure on abrupt termination" in {
      val mat = Materializer(system)
      val probe = TestProbe()

      val sink = Sink
        .actorRefWithBackpressure[String](
          probe.ref,
          initMessage,
          ackMessage,
          completeMessage,
          (_: Throwable) => failMessage)
        .withAttributes(inputBuffer(1, 1))

      Source.maybe[String].to(sink).run()(mat)

      probe.expectMsg(initMessage)
      mat.shutdown()
      probe.expectMsg(failMessage)
    }

    "signal completion after last message has been acked" in {
      val probe = TestProbe()

      val sink = Sink
        .actorRefWithBackpressure[String](
          probe.ref,
          initMessage,
          ackMessage,
          completeMessage,
          (_: Throwable) => failMessage)
        .withAttributes(inputBuffer(1, 1))

      Source.single("hello world").runWith(sink)

      probe.expectMsg(initMessage)
      probe.reply(ackMessage)

      probe.expectMsg("hello world")
      probe.expectNoMessage(100.millis)

      probe.reply(ackMessage)
      probe.expectMsg(completeMessage)
    }
  }

}
