Merge pull request #24653 from shkoder/fix-trigger-in-digest-cookbook

fix Trigger references in the stream cookbook example for digest #24317

akka-docs/src/test/java/jdocs/stream/javadsl/cookbook/RecipeDigest.java

@@ -17,7 +17,6 @@ import org.junit.Test;
 
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
-import java.util.Arrays;
 import java.util.concurrent.TimeUnit;
 
 import static org.junit.Assert.assertEquals;
@@ -39,12 +38,11 @@ public class RecipeDigest extends RecipeTest {
     mat = null;
   }
 
-
   //#calculating-digest
   class DigestCalculator extends GraphStage<FlowShape<ByteString, ByteString>> {
     private final String algorithm;
-    public Inlet<ByteString> in = Inlet.<ByteString>create("DigestCalculator.in");
+    public Inlet<ByteString> in = Inlet.create("DigestCalculator.in");
-    public Outlet<ByteString> out = Outlet.<ByteString>create("DigestCalculator.out");
+    public Outlet<ByteString> out = Outlet.create("DigestCalculator.out");
     private FlowShape<ByteString, ByteString> shape = FlowShape.of(in, out);
 
     public DigestCalculator(String algorithm) {
@@ -70,20 +68,21 @@ public class RecipeDigest extends RecipeTest {
 
           setHandler(out, new AbstractOutHandler() {
             @Override
-            public void onPull() throws Exception {
+            public void onPull() {
               pull(in);
             }
           });
+
           setHandler(in, new AbstractInHandler() {
             @Override
-            public void onPush() throws Exception {
+            public void onPush() {
               ByteString chunk = grab(in);
               digest.update(chunk.toArray());
               pull(in);
             }
 
             @Override
-            public void onUpstreamFinish() throws Exception {
+            public void onUpstreamFinish() {
               // If the stream is finished, we need to emit the digest
               // before completing
               emit(out, ByteString.fromArray(digest.digest()));
@@ -91,38 +90,32 @@ public class RecipeDigest extends RecipeTest {
             }
           });
         }
-
-
       };
     }
-
   }
   //#calculating-digest
 
   @Test
   public void work() throws Exception {
     new TestKit(system) {
-
       {
-        Source<ByteString, NotUsed> data = Source.from(Arrays.asList(
+        Source<ByteString, NotUsed> data = Source.single(ByteString.fromString("abc"));
-          ByteString.fromString("abcdbcdecdef"),
-          ByteString.fromString("defgefghfghighijhijkijkljklmklmnlmnomnopnopq")));
 
         //#calculating-digest2
-        final Source<ByteString, NotUsed> digest = data
+        final Source<ByteString, NotUsed> digest = data.via(new DigestCalculator("SHA-256"));
-          .via(new DigestCalculator("SHA-256"));
         //#calculating-digest2
 
         ByteString got = digest.runWith(Sink.head(), mat).toCompletableFuture().get(3, TimeUnit.SECONDS);
+
         assertEquals(ByteString.fromInts(
-          0x24, 0x8d, 0x6a, 0x61,
+          0xba, 0x78, 0x16, 0xbf,
-          0xd2, 0x06, 0x38, 0xb8,
+          0x8f, 0x01, 0xcf, 0xea,
-          0xe5, 0xc0, 0x26, 0x93,
+          0x41, 0x41, 0x40, 0xde,
-          0x0c, 0x3e, 0x60, 0x39,
+          0x5d, 0xae, 0x22, 0x23,
-          0xa3, 0x3c, 0xe4, 0x59,
+          0xb0, 0x03, 0x61, 0xa3,
-          0x64, 0xff, 0x21, 0x67,
+          0x96, 0x17, 0x7a, 0x9c,
-          0xf6, 0xec, 0xed, 0xd4,
+          0xb4, 0x10, 0xff, 0x61,
-          0x19, 0xdb, 0x06, 0xc1), got);
+          0xf2, 0x00, 0x15, 0xad), got);
       }
     };
   }

akka-docs/src/test/java/jdocs/stream/javadsl/cookbook/RecipeTest.java

@@ -33,10 +33,4 @@ public abstract class RecipeTest extends AbstractJavaTest {
       return msg != null ? msg.hashCode() : 0;
     }
   }
-
-  final class Trigger {
-  }
-
-  final class Job {
-  }
 }

akka-docs/src/test/scala/docs/stream/cookbook/RecipeAdhocSource.scala

@@ -2,9 +2,8 @@ package docs.stream.cookbook
 
 import java.util.concurrent.atomic.{ AtomicBoolean, AtomicInteger }
 
-import akka.stream.scaladsl.{ Keep, Sink, Source }
+import akka.stream.scaladsl.Source
 import akka.stream.testkit.scaladsl.TestSink
-import akka.stream.{ Graph, SourceShape }
 import akka.testkit.TimingTest
 import akka.{ Done, NotUsed }
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeDecompress.scala

@@ -3,16 +3,10 @@
  */
 package docs.stream.cookbook
 
-import java.io.ByteArrayOutputStream
-import java.nio.charset.StandardCharsets
-import java.util.zip.GZIPOutputStream
-
-import akka.stream.impl.io.compression.GzipCompressor
 import akka.stream.scaladsl.Sink
 import akka.stream.scaladsl.Source
 import akka.util.ByteString
 
-import scala.annotation.tailrec
 import scala.concurrent.Await
 import scala.concurrent.duration._
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeDigest.scala

@@ -1,12 +1,5 @@
 package docs.stream.cookbook
 
-import java.security.MessageDigest
-
-import akka.NotUsed
-import akka.stream.{ Attributes, Outlet, Inlet, FlowShape }
-import akka.stream.scaladsl.{ Sink, Source }
-import akka.util.ByteString
-
 import scala.concurrent.Await
 import scala.concurrent.duration._
 
@@ -16,28 +9,32 @@ class RecipeDigest extends RecipeSpec {
 
     "work" in {
 
-      val data = Source(List(
-        ByteString("abcdbcdecdef"),
-        ByteString("defgefghfghighijhijkijkljklmklmnlmnomnopnopq")))
-
       //#calculating-digest
+      import java.security.MessageDigest
+
+      import akka.NotUsed
+      import akka.stream.{ Attributes, Outlet, Inlet, FlowShape }
+      import akka.stream.scaladsl.{ Sink, Source }
+      import akka.util.ByteString
+
       import akka.stream.stage._
+
+      val data: Source[ByteString, NotUsed] = Source.single(ByteString("abc"))
+
       class DigestCalculator(algorithm: String) extends GraphStage[FlowShape[ByteString, ByteString]] {
         val in = Inlet[ByteString]("DigestCalculator.in")
         val out = Outlet[ByteString]("DigestCalculator.out")
-        override val shape = FlowShape.of(in, out)
+        override val shape = FlowShape(in, out)
 
         override def createLogic(inheritedAttributes: Attributes): GraphStageLogic = new GraphStageLogic(shape) {
-          val digest = MessageDigest.getInstance(algorithm)
+          private val digest = MessageDigest.getInstance(algorithm)
 
           setHandler(out, new OutHandler {
-            override def onPull(): Trigger = {
+            override def onPull(): Unit = pull(in)
-              pull(in)
-            }
           })
 
           setHandler(in, new InHandler {
-            override def onPush(): Trigger = {
+            override def onPush(): Unit = {
               val chunk = grab(in)
               digest.update(chunk.toArray)
               pull(in)
@@ -48,25 +45,22 @@ class RecipeDigest extends RecipeSpec {
               completeStage()
             }
           })
-
         }
       }
+
       val digest: Source[ByteString, NotUsed] = data.via(new DigestCalculator("SHA-256"))
       //#calculating-digest
 
       Await.result(digest.runWith(Sink.head), 3.seconds) should be(
         ByteString(
-          0x24, 0x8d, 0x6a, 0x61,
+          0xba, 0x78, 0x16, 0xbf,
-          0xd2, 0x06, 0x38, 0xb8,
+          0x8f, 0x01, 0xcf, 0xea,
-          0xe5, 0xc0, 0x26, 0x93,
+          0x41, 0x41, 0x40, 0xde,
-          0x0c, 0x3e, 0x60, 0x39,
+          0x5d, 0xae, 0x22, 0x23,
-          0xa3, 0x3c, 0xe4, 0x59,
+          0xb0, 0x03, 0x61, 0xa3,
-          0x64, 0xff, 0x21, 0x67,
+          0x96, 0x17, 0x7a, 0x9c,
-          0xf6, 0xec, 0xed, 0xd4,
+          0xb4, 0x10, 0xff, 0x61,
-          0x19, 0xdb, 0x06, 0xc1))
+          0xf2, 0x00, 0x15, 0xad))
-
     }
-
   }
-
 }

akka-docs/src/test/scala/docs/stream/cookbook/RecipeDroppyBroadcast.scala

@@ -4,9 +4,6 @@ import akka.stream.{ ClosedShape, OverflowStrategy }
 import akka.stream.scaladsl._
 import akka.stream.testkit._
 
-import scala.collection.immutable
-import scala.concurrent.Await
-
 class RecipeDroppyBroadcast extends RecipeSpec {
 
   "Recipe for a droppy broadcast" must {

akka-docs/src/test/scala/docs/stream/cookbook/RecipeFlattenSeq.scala

@@ -3,7 +3,6 @@ package docs.stream.cookbook
 import akka.NotUsed
 import akka.stream.scaladsl.{ Sink, Source }
 
-import scala.collection.immutable
 import scala.concurrent.Await
 import scala.concurrent.duration._
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeHold.scala

@@ -91,7 +91,7 @@ class RecipeHold extends RecipeSpec {
         .run()
 
       val subscription = sub.expectSubscription()
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       subscription.request(1)
       sub.expectNext(0)
@@ -121,10 +121,10 @@ class RecipeHold extends RecipeSpec {
       source.via(new HoldWithWait).to(sink).run()
 
       val subscription = sub.expectSubscription()
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       subscription.request(1)
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(1)
       sub.expectNext(1)

akka-docs/src/test/scala/docs/stream/cookbook/RecipeKeepAlive.scala

@@ -1,7 +1,6 @@
 package docs.stream.cookbook
 
 import akka.NotUsed
-import akka.stream.ClosedShape
 import akka.stream.scaladsl._
 import akka.util.ByteString
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeManualTrigger.scala

@@ -8,6 +8,7 @@ import scala.concurrent.duration._
 class RecipeManualTrigger extends RecipeSpec {
 
   "Recipe for triggering a stream manually" must {
+    type Trigger = Unit
 
     "work" in {
 
@@ -31,17 +32,17 @@ class RecipeManualTrigger extends RecipeSpec {
       graph.run()
 
       sub.expectSubscription().request(1000)
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(())
       sub.expectNext("1")
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(())
       pub.sendNext(())
       sub.expectNext("2")
       sub.expectNext("3")
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(())
       sub.expectNext("4")
@@ -71,17 +72,17 @@ class RecipeManualTrigger extends RecipeSpec {
       graph.run()
 
       sub.expectSubscription().request(1000)
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(())
       sub.expectNext("1")
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(())
       pub.sendNext(())
       sub.expectNext("2")
       sub.expectNext("3")
-      sub.expectNoMsg(100.millis)
+      sub.expectNoMessage(100.millis)
 
       pub.sendNext(())
       sub.expectNext("4")

akka-docs/src/test/scala/docs/stream/cookbook/RecipeParseLines.scala

@@ -4,7 +4,6 @@ import akka.stream.scaladsl.Sink
 import akka.stream.scaladsl.Source
 import akka.util.ByteString
 
-import scala.annotation.tailrec
 import scala.concurrent.Await
 import scala.concurrent.duration._
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeReduceByKey.scala

@@ -1,11 +1,9 @@
 package docs.stream.cookbook
 
 import akka.NotUsed
-import akka.stream.{ Graph, FlowShape, Inlet, Outlet, Attributes, OverflowStrategy }
 import akka.stream.scaladsl._
-import scala.concurrent.{ Await, Future }
+import scala.concurrent.Await
 import scala.concurrent.duration._
-import akka.stream.stage.{ GraphStage, GraphStageLogic }
 
 class RecipeReduceByKey extends RecipeSpec {
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeSeq.scala

@@ -5,8 +5,6 @@ package docs.stream.cookbook
 
 import akka.stream.scaladsl._
 import scala.concurrent.Future
-import org.scalatest.concurrent.ScalaFutures
-import scala.concurrent.duration._
 
 class RecipeSeq extends RecipeSpec {
 

akka-docs/src/test/scala/docs/stream/cookbook/RecipeSpec.scala

@@ -7,7 +7,5 @@ trait RecipeSpec extends AkkaSpec {
 
   implicit val m = ActorMaterializer()
   type Message = String
-  type Trigger = Unit
-  type Job = String
 
 }

akka-docs/src/test/scala/docs/stream/cookbook/RecipeWorkerPool.scala

@@ -3,7 +3,6 @@ package docs.stream.cookbook
 import akka.NotUsed
 import akka.stream.FlowShape
 import akka.stream.scaladsl._
-import akka.testkit.TestProbe
 
 import scala.concurrent.Await
 import scala.concurrent.duration._