Misc README and test-server additions (#79)

* Misc README and test-server additions * Add safe navigation for return type of SendEventsResponse? --------- Co-authored-by: Dan Farrelly <[email protected]> Co-authored-by: Albert Chae <[email protected]>
inngest · Sep 9, 2024 · 70ac4e3 · 70ac4e3
1 parent c1b962d
commit 70ac4e3
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ class TranscodeVideo : InngestFunction() {
   <summary>Java (Coming soon)</summary>
 </details>
 
-## Defining configuration
+## Creating functions
 
 Define your function's configuration using the `config` method and the `InngestFunctionConfigBuilder` class.
 The `config` method must be overridden and an `id` is required. All options should are discoverable via
@@ -63,15 +63,38 @@ the builder class passed as the only argument to the `config` method.
   <summary>Kotlin</summary>
 
 ```kotlin
+import java.time.Duration
+
 class TranscodeVideo : InngestFunction() {
   override fun config(builder: InngestFunctionConfigBuilder): InngestFunctionConfigBuilder =
     builder
       .id("process-video")
       .name("Process video upload")
       .triggerEvent("media/video.uploaded")
       .retries(2)
+      .batchEvents(50, Duration.ofSeconds(30))
       .concurrency(10)
+}
+```
+
+</details>
+
+## Sending events (_triggering functions_)
+
+<details open>
+  <summary>Kotlin</summary>
 
+```kotlin
+import java.time.Duration
+
+class TranscodeVideo : InngestFunction() {
+  override fun config(builder: InngestFunctionConfigBuilder): InngestFunctionConfigBuilder =
+    builder
+      .id("process-video")
+      .name("Process video upload")
+      .triggerEvent("media/video.uploaded")
+      .batchEvents(50, Duration.ofSeconds(30))
+      .concurrency(10)
 }
 ```
 

diff --git a/inngest-test-server/src/main/kotlin/com/inngest/testserver/App.kt b/inngest-test-server/src/main/kotlin/com/inngest/testserver/App.kt
@@ -6,6 +6,7 @@ import com.inngest.ktor.*
 import io.ktor.server.application.*
 import io.ktor.server.engine.*
 import io.ktor.server.netty.*
+import io.ktor.server.response.*
 import io.ktor.server.routing.*
 
 data class Result(
@@ -28,8 +29,28 @@ fun Application.module() {
                 TranscodeVideo(),
                 ImageFromPrompt(),
                 PushToSlackChannel(),
+                WeeklyCleanup(),
             ),
         )
+        get("/send") {
+            println("Sending event...")
+            try {
+                val event =
+                    InngestEvent(
+                        "delivery/process.requested",
+                        mapOf(
+                            "albumId" to "3d345a93-57c0-478b-a8ff-4d5f6a7df3b0",
+                            "title" to "The Teal Album",
+                        ),
+                    )
+                val res = inngest.send(event)
+                println(res)
+                call.respondText(res?.ids.toString())
+            } catch (e: Exception) {
+                println(e)
+                call.respondText(e.toString())
+            }
+        }
     }
 }
 

diff --git a/inngest-test-server/src/main/kotlin/com/inngest/testserver/ProcessAlbum.kt b/inngest-test-server/src/main/kotlin/com/inngest/testserver/ProcessAlbum.kt
@@ -12,7 +12,6 @@ class ProcessAlbum : InngestFunction() {
             .id("ProcessAlbum")
             .name("Process Album!")
             .triggerEvent("delivery/process.requested")
-            .trigger(InngestFunctionTriggers.Cron("5 0 * 8 *"))
             .batchEvents(30, Duration.ofSeconds(10))
 
     override fun execute(

diff --git a/inngest-test-server/src/main/kotlin/com/inngest/testserver/WeeklyCleanup.kt b/inngest-test-server/src/main/kotlin/com/inngest/testserver/WeeklyCleanup.kt
@@ -0,0 +1,24 @@
+package com.inngest.testserver
+
+import com.inngest.*
+
+/**
+ * A demo function that runs on a given cron schedule
+ */
+class WeeklyCleanup : InngestFunction() {
+    override fun config(builder: InngestFunctionConfigBuilder): InngestFunctionConfigBuilder =
+        builder
+            .id("weekly-cleanup")
+            .name("Weekly cleanup")
+            .triggerCron("0 0 * * 0") // Every Sunday at midnight
+
+    override fun execute(
+        ctx: FunctionContext,
+        step: Step,
+    ): LinkedHashMap<String, Any> {
+        // this function will not have an event or events to utilize as it's a triggered on a cron schedule
+        // this is ideal for periodic jobs that don't fit an event-trigger pattern.
+
+        return linkedMapOf("hello" to true)
+    }
+}