Merge pull request #90 from oliver-oloughlin/feature/cron-on-exit

added onExit option to cron jobs, renamed retries option to retry
oliver-oloughlin · Oct 8, 2023 · 4597cf1 · 4597cf1
2 parents 9b1a7a0 + 2007602
commit 4597cf1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -18,5 +18,7 @@ export const GET_MANY_KEY_LIMIT = 10
 
 export const LARGE_COLLECTION_STRING_LIMIT = 25_000
 
-// Time constants
-export const DEFAULT_CRON_INTERVAL = 1_000
+// Cron constants
+export const DEFAULT_CRON_INTERVAL = 60 * 60 * 1_000 // 1 hour
+
+export const DEFAULT_CRON_RETRY = 10
diff --git a/src/kvdex.ts b/src/kvdex.ts
@@ -28,6 +28,7 @@ import {
 import { AtomicBuilder } from "./atomic_builder.ts"
 import {
   DEFAULT_CRON_INTERVAL,
+  DEFAULT_CRON_RETRY,
   KVDEX_KEY_PREFIX,
   UNDELIVERED_KEY_PREFIX,
 } from "./constants.ts"
@@ -356,7 +357,7 @@ export class KvDex<const T extends Schema<SchemaDefinition>> {
       delay: number | undefined,
     ) => {
       // Enqueue cron job until delivered
-      for (let i = 0; i <= (options?.retries ?? 10); i++) {
+      for (let i = 0; i <= (options?.retry ?? DEFAULT_CRON_RETRY); i++) {
         await this.enqueue(msg, {
           idsIfUndelivered: [id],
           delay,
@@ -379,8 +380,8 @@ export class KvDex<const T extends Schema<SchemaDefinition>> {
     this.listenQueue<CronMessage>(async (msg) => {
       // Check if exit criteria is met, end repeating cron job if true
       const exit = await options?.exitOn?.(msg) ?? false
-
       if (exit) {
+        await options?.onExit?.(msg)
         return
       }
 

diff --git a/src/types.ts b/src/types.ts
@@ -33,7 +33,7 @@ export type CronOptions = {
   /**
    * Interval in milliseconds for cron job.
    *
-   * @default 1000 // Defaults to 1 second
+   * @default 3_600_000 // Defaults to 1 hour
    */
   interval?: number
 
@@ -43,6 +43,9 @@ export type CronOptions = {
   /** Exit predicate used to end cron job. */
   exitOn?: (msg: CronMessage) => boolean | Promise<boolean>
 
+  /** Task to be run when terminating a cron job (after ```exitOn()``` returns true) */
+  onExit?: (msg: CronMessage) => unknown
+
   /**
    * Delay before running the first job.
    *
@@ -57,7 +60,7 @@ export type CronOptions = {
    *
    * @default 10
    */
-  retries?: number
+  retry?: number
 }
 
 export type CronMessage = {