Merge pull request #381 from underctrl-io/sqlite-job

feat: sqlite task driver

Author: twlite

apps/test-bot/src/app.ts

@@ -1,7 +1,7 @@
 import { Client } from 'discord.js';
 import { Logger, commandkit } from 'commandkit';
 import { setDriver } from '@commandkit/tasks';
-import { HyperCronDriver } from '@commandkit/tasks/hypercron';
+import { SQLiteDriver } from '@commandkit/tasks/sqlite';
 import './ai.ts';
 
 const client = new Client({
@@ -14,7 +14,7 @@ const client = new Client({
   ],
 });
 
-setDriver(new HyperCronDriver());
+setDriver(new SQLiteDriver('./tasks.db'));
 
 Logger.log('Application bootstrapped successfully!');
 

apps/test-bot/src/app/commands/remind.ts

@@ -36,10 +36,7 @@ export const chatInput: ChatInputCommand = async (ctx) => {
       channelId: ctx.interaction.channelId,
       setAt: Date.now(),
     } satisfies RemindTaskData,
-    schedule: {
-      type: 'date',
-      value: timeMs,
-    },
+    schedule: timeMs,
   });
 
   await ctx.interaction.reply(
@@ -60,10 +57,7 @@ export const message: MessageCommand = async (ctx) => {
       channelId: ctx.message.channelId,
       setAt: Date.now(),
     } satisfies RemindTaskData,
-    schedule: {
-      type: 'date',
-      value: timeMs,
-    },
+    schedule: timeMs,
   });
 
   await ctx.message.reply(

apps/website/docs/api-reference/tasks/classes/hyper-cron-driver.mdx

@@ -0,0 +1,78 @@
+---
+title: "SQLiteDriver"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
+
+
+## SQLiteDriver
+
+<GenerationInfo sourceFile="packages/tasks/src/drivers/sqlite.ts" sourceLine="20" packageName="@commandkit/tasks" />
+
+SQLite-based persistent job queue manager for CommandKit tasks.
+
+- Jobs are recoverable on restart (pending jobs from the past are run on startup)
+- Job data is persisted in SQLite
+- Supports both cron and date-based schedules (uses cron-parser for cron)
+
+
+
+*Example*
+
+```ts
+import { SQLiteDriver } from '@commandkit/tasks/sqlite';
+import { setDriver } from '@commandkit/tasks';
+
+const driver = new SQLiteDriver('./tasks.db');
+setDriver(driver);
+```
+
+```ts title="Signature"
+class SQLiteDriver implements TaskDriver {
+    constructor(dbPath:  = './commandkit-tasks.db')
+    destroy() => ;
+    create(task: TaskData) => Promise<string>;
+    delete(identifier: string) => Promise<void>;
+    setTaskRunner(runner: TaskRunner) => Promise<void>;
+}
+```
+* Implements: <code><a href='/docs/next/api-reference/tasks/interfaces/task-driver#taskdriver'>TaskDriver</a></code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(dbPath:  = './commandkit-tasks.db') => SQLiteDriver`}   />
+
+Create a new SQLiteDriver instance.
+### destroy
+
+<MemberInfo kind="method" type={`() => `}   />
+
+Destroy the SQLite driver and stop the polling loop.
+### create
+
+<MemberInfo kind="method" type={`(task: <a href='/docs/next/api-reference/tasks/interfaces/task-data#taskdata'>TaskData</a>) => Promise&#60;string&#62;`}   />
+
+Schedule a new job.
+### delete
+
+<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;void&#62;`}   />
+
+Delete a scheduled job by its ID.
+### setTaskRunner
+
+<MemberInfo kind="method" type={`(runner: <a href='/docs/next/api-reference/tasks/types/task-runner#taskrunner'>TaskRunner</a>) => Promise&#60;void&#62;`}   />
+
+Set the task runner function to be called when a job is due.
+
+
+</div>

apps/website/docs/api-reference/tasks/classes/sqlite-driver.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## TaskDriverManager
 
-<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="27" packageName="@commandkit/tasks" />
+<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="26" packageName="@commandkit/tasks" />
 
 Manages the active task driver and provides a unified interface for task operations.
 
@@ -27,10 +27,9 @@ any operations are performed.
 
 ```ts
 import { TaskDriverManager } from '@commandkit/tasks';
-import { HyperCronDriver } from '@commandkit/tasks/hypercron';
 
 const manager = new TaskDriverManager();
-manager.setDriver(new HyperCronDriver());
+// Set your preferred driver here
 
 // Now you can create and manage tasks
 const taskId = await manager.createTask({

apps/website/docs/api-reference/tasks/classes/task-driver-manager.mdx

@@ -51,6 +51,7 @@ class Task<T extends Record<string, any> = Record<string, any>> {
     schedule: TaskSchedule | null
     isCron() => boolean;
     isDate() => boolean;
+    timezone: string | undefined
     prepare(ctx: TaskContext<T>) => Promise<boolean>;
     execute(ctx: TaskContext<T>) => Promise<void>;
 }
@@ -90,6 +91,12 @@ Checks if this task uses cron-based scheduling.
 <MemberInfo kind="method" type={`() => boolean`}   />
 
 Checks if this task uses date-based scheduling.
+### timezone
+
+<MemberInfo kind="property" type={`string | undefined`}   />
+
+The timezone for the task schedule.
+Returns undefined if no timezone is defined.
 ### prepare
 
 <MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/tasks/classes/task-context#taskcontext'>TaskContext</a>&#60;T&#62;) => Promise&#60;boolean&#62;`}   />

apps/website/docs/api-reference/tasks/classes/task.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## createTask
 
-<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="135" packageName="@commandkit/tasks" />
+<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="134" packageName="@commandkit/tasks" />
 
 Creates a new scheduled task using the global driver manager.
 

apps/website/docs/api-reference/tasks/functions/create-task.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## deleteTask
 
-<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="153" packageName="@commandkit/tasks" />
+<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="152" packageName="@commandkit/tasks" />
 
 Deletes a scheduled task using the global driver manager.
 

apps/website/docs/api-reference/tasks/functions/delete-task.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## setDriver
 
-<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="112" packageName="@commandkit/tasks" />
+<GenerationInfo sourceFile="packages/tasks/src/driver-manager.ts" sourceLine="111" packageName="@commandkit/tasks" />
 
 Sets the global task driver.
 
@@ -25,9 +25,9 @@ This is a convenience function that sets the driver on the global task driver ma
 
 ```ts
 import { setDriver } from '@commandkit/tasks';
-import { HyperCronDriver } from '@commandkit/tasks/hypercron';
+import { SQLiteDriver } from '@commandkit/tasks/sqlite';
 
-setDriver(new HyperCronDriver());
+setDriver(new SQLiteDriver('./tasks.db'));
 ```
 
 ```ts title="Signature"

apps/website/docs/api-reference/tasks/functions/set-driver.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## task
 
-<GenerationInfo sourceFile="packages/tasks/src/task.ts" sourceLine="130" packageName="@commandkit/tasks" />
+<GenerationInfo sourceFile="packages/tasks/src/task.ts" sourceLine="139" packageName="@commandkit/tasks" />
 
 Creates a new task definition.