Merge pull request #6 from Climactic/feat/cancel-jobs

feat: cancel jobs

.changeset/green-jars-impress.md

@@ -0,0 +1,8 @@
+---
+"tinyjobs": patch
+"@tinyjobs/cli": patch
+---
+
+fix(cli): support non-args jobs
+feat(tinyjobs): add support for canceling jobs
+chore: better readme

README.md

@@ -69,6 +69,11 @@ export default class FirstJob extends Job {
 }
 ```
 
+
+## Roadmap
+TinyJobs is not feature complete and still in early stages, you can refer to the roadmap for the list of currently planend features and their progress [here](https://github.com/orgs/Climactic/projects/1/views/4).
+
+
 ## Develop
 
 To develop all apps and packages, run the following command:

apps/example/src/index.ts

@@ -15,14 +15,22 @@ const tinyJobs = new TinyJobs<TinyJobsTypes>({
 await tinyJobs.loadJobs();
 
 // Run Jobs which are not scheduled via cron
-tinyJobs.invoke("exampleJob", { name: "exampleJob" });
-tinyJobs.invoke("delayedJob", { name: "DelayedJob" });
+const cancelJobId = await tinyJobs.invoke("cancelExample");
+await tinyJobs.invoke("exampleJob", { name: "exampleJob" });
+await tinyJobs.invoke("delayedJob", { name: "DelayedJob" });
+
+// Cancel a job
+tinyJobs.cancel("cancelExample", cancelJobId);
 
 // Logging
 tinyJobs.events.on(TinyJobEvents.JOB_COMPLETE, (job) => {
-  console.log(job);
+  console.log("[COMPLETED]\n", job);
 });
 
 tinyJobs.events.on(TinyJobEvents.JOB_FAILED, (job) => {
-  console.error(job);
+  console.error("[FAILED]\n", job);
+});
+
+tinyJobs.events.on(TinyJobEvents.JOB_CANCELLED, (job) => {
+  console.log("[CANCELLED]\n", job);
 });

apps/example/src/jobs/CancelExample.ts

@@ -0,0 +1,15 @@
+import { sleep } from "bun";
+import { Job } from "tinyjobs";
+
+export default class CancelExample extends Job {
+  constructor() {
+    super({
+      name: "cancelExample",
+      delay: 50000,
+    });
+  }
+
+  async run() {
+    sleep(100000);
+  }
+}

apps/example/src/jobs/jobs.types.d.ts

@@ -1,8 +1,10 @@
+interface cancelExampleParams {};
 interface cronExampleParams { name: string };
 interface delayedJobParams { name: string };
 interface exampleJobParams { name: string };
 
 type TinyJobsTypes = {
+  'cancelExample': cancelExampleParams;
   'cronExample': cronExampleParams;
   'delayedJob': delayedJobParams;
   'exampleJob': exampleJobParams

packages/cli/src/commands/generate/generateTypes.ts

@@ -6,7 +6,7 @@ import { log } from "@clack/prompts";
 
 interface JobTypeDefinition {
   jobName: string;
-  paramsType: string;
+  paramsType?: string;
 }
 
 function extractJobTypes(filePath: string): JobTypeDefinition | null {
@@ -63,13 +63,17 @@ function extractJobTypes(filePath: string): JobTypeDefinition | null {
           const param = member.parameters[0];
           if (param && param.type) {
             paramsType = param.type.getFullText().trim();
+          } else {
+            // If no parameters, set paramsType to an empty object type
+            paramsType = "{}";
           }
         }
       });
     }
   });
 
-  if (jobName && paramsType) {
+  // Return the job type even if paramsType is empty
+  if (jobName) {
     return { jobName, paramsType };
   }
   return null;

packages/tinyjobs/README.md

@@ -162,7 +162,7 @@ const tinyJobs = new TinyJobs<TinyJobsTypes>();
 This will provide type safety for the parameters passed to the job during invocation.
 
 ## Roadmap
-TinyJobs is not feature complete and still in early stages, you can refer to the roadmap for the list of currently planend features and their progress [here](https://github.com/orgs/Climactic/projects/1/views/1).
+TinyJobs is not feature complete and still in early stages, you can refer to the roadmap for the list of currently planend features and their progress [here](https://github.com/orgs/Climactic/projects/1/views/4).
 
 ## License
 TinyJobs is licensed under the [Apache-2.0](LICENSE).

packages/tinyjobs/src/lib/TinyJobsEventsHandler.ts

@@ -3,7 +3,11 @@ import { EventEmitter } from "events";
 import IORedis from "ioredis";
 
 import { TinyJobEvents } from "../types";
-import type { JobCompletedData, JobFailedData } from "./types/eventsData";
+import type {
+  JobCancelledData,
+  JobCompletedData,
+  JobFailedData,
+} from "./types/eventsData";
 import { getJobNameRedisKey } from "../utils/utils";
 
 type TinyJobEventsConstructorTypes = {
@@ -73,6 +77,7 @@ class TinyJobEventsHandler extends EventEmitter {
   // Override the emit method with proper typing
   emit(event: TinyJobEvents.JOB_COMPLETE, job: JobCompletedData): boolean;
   emit(event: TinyJobEvents.JOB_FAILED, job: JobFailedData): boolean;
+  emit(event: TinyJobEvents.JOB_CANCELLED, job: JobCancelledData): boolean;
   emit(event: string | symbol, ...args: any[]): boolean {
     return super.emit(event, ...args);
   }
@@ -86,6 +91,10 @@ class TinyJobEventsHandler extends EventEmitter {
     event: TinyJobEvents.JOB_FAILED,
     listener: (job: JobFailedData) => void
   ): this;
+  on(
+    event: TinyJobEvents.JOB_CANCELLED,
+    listener: (job: JobCancelledData) => void
+  ): this;
   on(event: string | symbol, listener: (...args: any[]) => void): this {
     return super.on(event, listener);
   }

packages/tinyjobs/src/lib/TinyJobsHandler.ts

@@ -10,6 +10,7 @@ import { generateRandomUid, getJobNameRedisKey } from "../utils/utils";
 import { getConfig } from "../utils/config";
 import { loadJobsFromDir } from "../utils/jobs";
 import { TinyJobEvents } from "../types";
+import { string } from "valibot";
 
 /**
  * TinyJobsConstructorTypes
@@ -299,7 +300,20 @@ class TinyJobs<T> {
       jobName as string
     );
 
-    return queuedJob.id;
+    return queuedJob.id as string;
+  }
+
+  public async cancel<K extends keyof T>(jobName: K, jobId: string) {
+    const job = await this.queue.getJob(jobId);
+    if (!job) throw new Error(`Job with id ${jobId} not found.`);
+
+    await job.remove().then(async () => {
+      await this.redis.hdel(getJobNameRedisKey(jobName as string), jobId);
+      this.events.emit(TinyJobEvents.JOB_CANCELLED, {
+        jobId,
+        jobName: jobName as string,
+      });
+    });
   }
 }
 

packages/tinyjobs/src/lib/types/eventsData.ts

@@ -9,3 +9,8 @@ export type JobFailedData = {
   jobName: string;
   failedReason: string;
 };
+
+export type JobCancelledData = {
+  jobId: string;
+  jobName: string;
+};

packages/tinyjobs/src/types.ts

@@ -1,4 +1,5 @@
 export enum TinyJobEvents {
   "JOB_COMPLETE" = "JOB_COMPLETE",
   "JOB_FAILED" = "JOB_FAILED",
+  "JOB_CANCELLED" = "JOB_CANCELLED",
 }