Fix up docs and examples

Change example slightly
zio · Jan 9, 2025 · 2f16b34 · 2f16b34
1 parent fa69525
commit 2f16b34
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -22,7 +22,7 @@ libraryDependencies += "dev.zio" %% "zio-sqs" % "@VERSION@"
 
 ## Example
 
-In this example we produce a stream of events to the `MyQueue` and then consume them from that queue:
+In this example we produce a stream of events to the `MyQueue` and then consume them from that queue (at-most-once delivery semantics):
 
 ```scala mdoc:compile-only
 import zio._
@@ -47,7 +47,10 @@ object ProducerConsumerExample extends ZIOAppDefault {
     _        <- ZIO.scoped(producer.flatMap(_.sendStream(stream).runDrain))
     _        <- SqsStream(
                   queueUrl,
-                  SqsStreamSettings(stopWhenQueueEmpty = true, waitTimeSeconds = Some(3))
+                  SqsStreamSettings.default
+                    .withAutoDelete(true)
+                    .withStopWhenQueueEmpty(true)
+                    .withWaitTimeSeconds(3)
                 ).foreach(msg => Console.printLine(msg.body))
   } yield ()
 
@@ -59,3 +62,5 @@ object ProducerConsumerExample extends ZIOAppDefault {
     )
 }
 ```
+
+Check out the examples folder in `zio-sqs/src/test/scala/examples` for additional examples that cover at-least-once and at-most-once delivery semantics.
diff --git a/zio-sqs/src/test/scala/examples/AtLeastOnceExample.scala b/zio-sqs/src/test/scala/examples/AtLeastOnceExample.scala
@@ -12,11 +12,12 @@ import zio.sqs._
 import zio.aws.sqs.model.Message
 
 object AtLeastOnceExample extends ZIOAppDefault {
+  val queueUrl = "https://sqs.us-east-1.amazonaws.com/00000/calq.fifo"
 
   val producerLayer: RLayer[Sqs, Producer[String]] =
     ZLayer.scoped(
       Producer.make(
-        queueUrl = "https://sqs.us-east-1.amazonaws.com/000/calq.fifo",
+        queueUrl = queueUrl,
         serializer = Serializer.serializeString,
         settings = ProducerSettings(parallelism = 1)
       )
@@ -25,7 +26,7 @@ object AtLeastOnceExample extends ZIOAppDefault {
   val producerExample =
     ZIO.serviceWithZIO[Producer[String]] { producer =>
       producer.produceBatch(
-        (200 to 300).map(i =>
+        (0 to 200).map(i =>
           ProducerEvent(
             data = s"Message $i",
             attributes = Map.empty,
@@ -41,18 +42,24 @@ object AtLeastOnceExample extends ZIOAppDefault {
 
   val consumerExample =
     SqsStream.consumeChunkAtLeastOnce(
-      queueUrl = "https://sqs.us-east-1.amazonaws.com/000/calq.fifo",
-      settings = SqsStreamSettings.default.copy(
-        maxNumberOfMessages = Option(10),
-        visibilityTimeout = Some(5),
-        waitTimeSeconds = Some(20)
-      ),
+      queueUrl = queueUrl,
+      settings = SqsStreamSettings.default
+        .withMaxNumberOfMessages(10)
+        .withVisibilityTimeout(5)
+        .withWaitTimeSeconds(20),
       extensionSettings = SqsMessageLifetimeExtensionSettings.default,
       consumerParallelism = 10
     ) { (messages: Chunk[Message.ReadOnly]) =>
       ZIO.debug(messages.map(_.body.getOrElse(""))) *> ZIO.sleep(14.seconds)
     }
 
+  val consumerStreamExample =
+    SqsStream(
+      queueUrl = queueUrl,
+      settings = SqsStreamSettings.default.withAutoDelete(false)
+    ).tap(message => ZIO.debug(message.body.getOrElse("")))
+      .run(SqsStream.deleteMessageBatchSink(queueUrl))
+
   override val run: ZIO[Environment with ZIOAppArgs with Scope, Any, Any] =
     (producerExample *> consumerExample)
       .provide(

diff --git a/...sqs/src/test/scala/examples/TestApp.scala → ...st/scala/examples/AtMostOnceExample.scala b/...sqs/src/test/scala/examples/TestApp.scala → ...st/scala/examples/AtMostOnceExample.scala
@@ -9,7 +9,7 @@ import zio.sqs.serialization.Serializer
 import zio.sqs.{ SqsStream, SqsStreamSettings, Utils }
 import zio._
 
-object TestApp extends zio.ZIOAppDefault {
+object AtMostOnceExample extends zio.ZIOAppDefault {
   val queueName = "TestQueue"
 
   val client: ZLayer[Any, Throwable, Sqs] =
@@ -36,7 +36,7 @@ object TestApp extends zio.ZIOAppDefault {
                 }
     _        <- SqsStream(
                   queueUrl,
-                  SqsStreamSettings.default.withStopWhenQueueEmpty(true).withWaitTimeSeconds(3)
+                  SqsStreamSettings.default.withStopWhenQueueEmpty(true).withWaitTimeSeconds(3).withAutoDelete(true)
                 ).foreach(msg => ZIO.succeed(println(msg.body)))
   } yield ()