Merge pull request #204 from kdroidFilter/feat/scheduler-typed-api

refactor(scheduler)!: typed TaskId, LocalTime, @serializable inputData

Author: kdroidFilter

docs/runtime/scheduler.md

@@ -6,6 +6,7 @@ plugins {
     kotlin("jvm")
     alias(libs.plugins.kotlinComposePlugin)
     alias(libs.plugins.jetbrainsCompose)
+    alias(libs.plugins.kotlinxSerialization)
     id("io.github.kdroidfilter.nucleus")
 }
 

scheduler-demo/build.gradle.kts

@@ -17,15 +17,18 @@ import org.jetbrains.jewel.intui.standalone.theme.default
 import org.jetbrains.jewel.intui.standalone.theme.lightThemeDefinition
 import org.jetbrains.jewel.ui.ComponentStyling
 import schedulerdemo.task.BackupTask
+import schedulerdemo.task.BackupTaskId
 import schedulerdemo.task.NotificationTask
+import schedulerdemo.task.NotificationTaskId
 import schedulerdemo.task.SyncTask
+import schedulerdemo.task.SyncTaskId
 
 private fun buildRegistry() =
     TaskRegistry
         .Builder()
-        .register("sync") { SyncTask() }
-        .register("backup") { BackupTask() }
-        .register("notification") { NotificationTask() }
+        .register(SyncTaskId) { SyncTask() }
+        .register(BackupTaskId) { BackupTask() }
+        .register(NotificationTaskId) { NotificationTask() }
         .build()
 
 fun main(args: Array<String>) {

scheduler-demo/src/main/kotlin/schedulerdemo/Main.kt

@@ -31,7 +31,14 @@ import org.jetbrains.jewel.ui.component.DefaultButton
 import org.jetbrains.jewel.ui.component.GroupHeader
 import org.jetbrains.jewel.ui.component.OutlinedButton
 import org.jetbrains.jewel.ui.component.Text
+import schedulerdemo.task.BackupInput
+import schedulerdemo.task.BackupTaskId
+import schedulerdemo.task.NotificationInput
+import schedulerdemo.task.NotificationTaskId
+import schedulerdemo.task.ReportTaskId
+import schedulerdemo.task.SyncTaskId
 import java.time.Instant
+import java.time.LocalTime
 import java.time.ZoneId
 import java.time.format.DateTimeFormatter
 import kotlin.time.Duration.Companion.hours
@@ -87,7 +94,7 @@ fun SchedulerDemoView(openedByScheduler: Boolean = false) {
 
         Row(horizontalArrangement = Arrangement.spacedBy(8.dp)) {
             DefaultButton(onClick = {
-                val ok = scheduler.enqueue(TaskRequest.periodic("sync", 1.hours))
+                val ok = scheduler.enqueue(TaskRequest.periodic(SyncTaskId, 1.hours))
                 log(if (ok) "Enqueued 'sync' (every 1h)" else "Failed to enqueue 'sync'")
                 refreshTasks()
             }) {
@@ -97,8 +104,8 @@ fun SchedulerDemoView(openedByScheduler: Boolean = false) {
             DefaultButton(onClick = {
                 val ok =
                     scheduler.enqueue(
-                        TaskRequest.periodic("backup", 30.minutes) {
-                            inputData("target", "/tmp/backup")
+                        TaskRequest.periodic(BackupTaskId, 30.minutes) {
+                            inputData(BackupInput(target = "/tmp/backup"))
                         },
                     )
                 log(if (ok) "Enqueued 'backup' (every 30min)" else "Failed to enqueue 'backup'")
@@ -108,7 +115,10 @@ fun SchedulerDemoView(openedByScheduler: Boolean = false) {
             }
 
             DefaultButton(onClick = {
-                val ok = scheduler.enqueue(TaskRequest.calendar("report", CronExpression.everyDayAt(9)))
+                val ok =
+                    scheduler.enqueue(
+                        TaskRequest.calendar(ReportTaskId, CronExpression.everyDayAt(LocalTime.of(9, 0))),
+                    )
                 log(if (ok) "Enqueued 'report' (daily at 9h)" else "Failed to enqueue 'report'")
                 refreshTasks()
             }) {
@@ -118,9 +128,13 @@ fun SchedulerDemoView(openedByScheduler: Boolean = false) {
             DefaultButton(onClick = {
                 val ok =
                     scheduler.enqueue(
-                        TaskRequest.periodic("notification", 15.minutes) {
-                            inputData("title", "Scheduled Notification")
-                            inputData("message", "This notification was scheduled 15 minutes ago!")
+                        TaskRequest.periodic(NotificationTaskId, 15.minutes) {
+                            inputData(
+                                NotificationInput(
+                                    title = "Scheduled Notification",
+                                    message = "This notification was scheduled 15 minutes ago!",
+                                ),
+                            )
                         },
                     )
                 log(if (ok) "Enqueued 'notification' (every 15min)" else "Failed to enqueue 'notification'")

scheduler-demo/src/main/kotlin/schedulerdemo/SchedulerDemoView.kt

@@ -2,11 +2,30 @@ package schedulerdemo.task
 
 import io.github.kdroidfilter.nucleus.scheduler.DesktopTask
 import io.github.kdroidfilter.nucleus.scheduler.TaskContext
+import io.github.kdroidfilter.nucleus.scheduler.TaskId
 import io.github.kdroidfilter.nucleus.scheduler.TaskResult
+import io.github.kdroidfilter.nucleus.scheduler.inputData
+import kotlinx.serialization.Serializable
 import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
 import java.util.logging.Logger
 
+val SyncTaskId: TaskId = TaskId("sync")
+val BackupTaskId: TaskId = TaskId("backup")
+val NotificationTaskId: TaskId = TaskId("notification")
+val ReportTaskId: TaskId = TaskId("report")
+
+@Serializable
+data class BackupInput(
+    val target: String,
+)
+
+@Serializable
+data class NotificationInput(
+    val title: String,
+    val message: String,
+)
+
 class SyncTask : DesktopTask {
     private val logger = Logger.getLogger(SyncTask::class.java.name)
 
@@ -21,7 +40,7 @@ class BackupTask : DesktopTask {
     private val logger = Logger.getLogger(BackupTask::class.java.name)
 
     override suspend fun doWork(context: TaskContext): TaskResult {
-        val target = context.inputData["target"] ?: "default"
+        val target = context.inputData<BackupInput>()?.target ?: "default"
         val timestamp = LocalDateTime.now().format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)
         logger.info("BackupTask to '$target' executed at $timestamp")
         return TaskResult.Success

scheduler-demo/src/main/kotlin/schedulerdemo/task/SampleTasks.kt

@@ -2,6 +2,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 plugins {
     kotlin("jvm")
+    alias(libs.plugins.kotlinxSerialization)
     alias(libs.plugins.vanniktechMavenPublish)
 }