@stacksjs/scheduler 0.58.51 → 0.58.52

package/src/job.ts

@@ -0,0 +1,315 @@
+/**
+ * Many thanks to https://github.com/kelektiv/node-cron for the inspiration
+ */
+
+import { spawn } from 'node:child_process'
+import { CronError, ExclusiveParametersError } from './errors'
+import { CronTime } from './time'
+import type {
+  CronCallback,
+  CronCommand,
+  CronContext,
+  CronJobParams,
+  CronOnCompleteCallback,
+  CronOnCompleteCommand,
+  WithOnComplete,
+} from './types/cron'
+import { getTimeZoneAndOffset } from './utils'
+
+export class CronJob<OC extends CronOnCompleteCommand | null = null, C = null> {
+  cronTime: CronTime
+  running = false
+  unrefTimeout = false
+  lastExecution: Date | null = null
+  runOnce = false
+  context: CronContext<C>
+  onComplete?: WithOnComplete<OC> extends true
+    ? CronOnCompleteCallback
+    : undefined
+
+  private _timeout?: NodeJS.Timeout
+  private _callbacks: CronCallback<C, WithOnComplete<OC>>[] = []
+  private _errorHandler?: (error: Error) => void
+
+  constructor(
+    cronTime: CronJobParams<OC, C>['cronTime'],
+    onTick: CronJobParams<OC, C>['onTick'],
+    onComplete?: CronJobParams<OC, C>['onComplete'],
+    start?: CronJobParams<OC, C>['start'],
+    timeZone?: CronJobParams<OC, C>['timeZone'],
+    context?: CronJobParams<OC, C>['context'],
+    runOnInit?: CronJobParams<OC, C>['runOnInit'],
+    utcOffset?: null,
+    unrefTimeout?: CronJobParams<OC, C>['unrefTimeout'],
+    errorHandler?: (error: Error) => void
+  )
+  constructor(
+    cronTime: CronJobParams<OC, C>['cronTime'],
+    onTick: CronJobParams<OC, C>['onTick'],
+    onComplete?: CronJobParams<OC, C>['onComplete'],
+    start?: CronJobParams<OC, C>['start'],
+    timeZone?: null,
+    context?: CronJobParams<OC, C>['context'],
+    runOnInit?: CronJobParams<OC, C>['runOnInit'],
+    utcOffset?: CronJobParams<OC, C>['utcOffset'],
+    unrefTimeout?: CronJobParams<OC, C>['unrefTimeout'],
+    errorHandler?: (error: Error) => void
+  )
+  constructor(
+    cronTime: CronJobParams<OC, C>['cronTime'],
+    onTick: CronJobParams<OC, C>['onTick'],
+    onComplete?: CronJobParams<OC, C>['onComplete'],
+    start?: CronJobParams<OC, C>['start'],
+    timeZone?: CronJobParams<OC, C>['timeZone'],
+    context?: CronJobParams<OC, C>['context'],
+    runOnInit?: CronJobParams<OC, C>['runOnInit'],
+    utcOffset?: CronJobParams<OC, C>['utcOffset'],
+    unrefTimeout?: CronJobParams<OC, C>['unrefTimeout'],
+    errorHandler?: (error: Error) => void,
+  ) {
+    this._errorHandler = errorHandler
+    this.context = (context ?? this) as CronContext<C>
+
+    const { timeZone: tz, utcOffset: uo } = getTimeZoneAndOffset(
+      timeZone,
+      utcOffset,
+    )
+
+    this.cronTime = new CronTime(cronTime, tz, uo as null | undefined)
+
+    if (unrefTimeout != null)
+      this.unrefTimeout = unrefTimeout
+
+    if (onComplete != null) {
+      // casting to the correct type since we just made sure that WithOnComplete<OC> = true
+      this.onComplete = this._fnWrap(
+        onComplete,
+      ) as WithOnComplete<OC> extends true ? CronOnCompleteCallback : undefined
+    }
+
+    if (this.cronTime.realDate)
+      this.runOnce = true
+
+    this.addCallback(this._fnWrap(onTick))
+
+    if (runOnInit) {
+      this.lastExecution = new Date()
+      this.fireOnTick()
+    }
+
+    if (start)
+      this.start()
+  }
+
+  static from<OC extends CronOnCompleteCommand | null = null, C = null>(
+    params: CronJobParams<OC, C>,
+  ) {
+    // runtime check for JS users
+    if (params.timeZone != null && params.utcOffset != null)
+      throw new ExclusiveParametersError('timeZone', 'utcOffset')
+
+    if (params.timeZone != null) {
+      return new CronJob<OC, C>(
+        params.cronTime,
+        params.onTick,
+        params.onComplete,
+        params.start,
+        params.timeZone,
+        params.context,
+        params.runOnInit,
+        params.utcOffset,
+        params.unrefTimeout,
+      )
+    }
+    else if (params.utcOffset != null) {
+      return new CronJob<OC, C>(
+        params.cronTime,
+        params.onTick,
+        params.onComplete,
+        params.start,
+        null,
+        params.context,
+        params.runOnInit,
+        params.utcOffset,
+        params.unrefTimeout,
+      )
+    }
+    else {
+      return new CronJob<OC, C>(
+        params.cronTime,
+        params.onTick,
+        params.onComplete,
+        params.start,
+        params.timeZone,
+        params.context,
+        params.runOnInit,
+        params.utcOffset,
+        params.unrefTimeout,
+      )
+    }
+  }
+
+  private _fnWrap(cmd: CronCommand<C, boolean>): CronCallback<C, boolean> {
+    switch (typeof cmd) {
+      case 'function': {
+        return cmd
+      }
+
+      case 'string': {
+        const [command, ...args] = cmd.split(' ')
+
+        return spawn.bind(undefined, command ?? cmd, args, {}) as () => void
+      }
+
+      case 'object': {
+        return spawn.bind(
+          undefined,
+          cmd.command,
+          cmd.args ?? [],
+          cmd.options ?? {},
+        ) as () => void
+      }
+    }
+  }
+
+  addCallback(callback: CronCallback<C, WithOnComplete<OC>>) {
+    if (typeof callback === 'function')
+      this._callbacks.push(callback)
+  }
+
+  setTime(time: CronTime) {
+    if (!(time instanceof CronTime))
+      throw new CronError('time must be an instance of CronTime.')
+
+    const wasRunning = this.running
+    this.stop()
+
+    this.cronTime = time
+    if (time.realDate)
+      this.runOnce = true
+
+    if (wasRunning)
+      this.start()
+  }
+
+  nextDate() {
+    return this.cronTime.sendAt()
+  }
+
+  fireOnTick() {
+    try {
+      void callback.call(
+        this.context,
+        this.onComplete as WithOnComplete<OC> extends true
+          ? CronOnCompleteCallback
+          : never,
+      )
+    }
+    catch (error) {
+      if (this._errorHandler && error instanceof Error) {
+        this._errorHandler(error)
+      }
+      else {
+        // Handle the case where no error handler is provided or the caught object is not an Error
+        console.error('An error occurred in the cron job callback:', error)
+      }
+    }
+  }
+
+  nextDates(i?: number) {
+    return this.cronTime.sendAt(i ?? 0)
+  }
+
+  start() {
+    if (this.running)
+      return
+
+    const MAXDELAY = 2147483647 // The maximum number of milliseconds setTimeout will wait.
+    let timeout = this.cronTime.getTimeout()
+    let remaining = 0
+    let startTime: number
+
+    const setCronTimeout = (t: number) => {
+      startTime = Date.now()
+      // eslint-disable-next-line ts/no-use-before-define
+      this._timeout = setTimeout(callbackWrapper, t)
+      if (this.unrefTimeout && typeof this._timeout.unref === 'function')
+        this._timeout.unref()
+    }
+
+    // The callback wrapper checks if it needs to sleep another period or not
+    // and does the real callback logic when it's time.
+    const callbackWrapper = () => {
+      const diff = startTime + timeout - Date.now()
+
+      if (diff > 0) {
+        let newTimeout = this.cronTime.getTimeout()
+
+        if (newTimeout > diff)
+          newTimeout = diff
+
+        remaining += newTimeout
+      }
+
+      // If there is sleep time remaining, calculate how long and go to sleep
+      // again. This processing might make us miss the deadline by a few ms
+      // times the number of sleep sessions. Given a MAXDELAY of almost a
+      // month, this should be no issue.
+      if (remaining) {
+        if (remaining > MAXDELAY) {
+          remaining -= MAXDELAY
+          timeout = MAXDELAY
+        }
+        else {
+          timeout = remaining
+          remaining = 0
+        }
+
+        setCronTimeout(timeout)
+      }
+      else {
+        // We have arrived at the correct point in time.
+        this.lastExecution = new Date()
+
+        this.running = false
+
+        // start before calling back so the callbacks have the ability to stop the cron job
+        if (!this.runOnce)
+          this.start()
+
+        this.fireOnTick()
+      }
+    }
+
+    if (timeout >= 0) {
+      this.running = true
+
+      // Don't try to sleep more than MAXDELAY ms at a time.
+
+      if (timeout > MAXDELAY) {
+        remaining = timeout - MAXDELAY
+        timeout = MAXDELAY
+      }
+
+      setCronTimeout(timeout)
+    }
+    else {
+      this.stop()
+    }
+  }
+
+  lastDate() {
+    return this.lastExecution
+  }
+
+  /**
+   * Stop the cronjob.
+   */
+  stop() {
+    if (this._timeout)
+      clearTimeout(this._timeout)
+    this.running = false
+    if (typeof this.onComplete === 'function')
+      void this.onComplete.call(this.context)
+  }
+}

package/src/schedule.ts

@@ -0,0 +1,111 @@
+/* eslint-disable no-new */
+import { log } from '@stacksjs/cli'
+import type { DateTime } from 'luxon'
+import { CronTime } from './time'
+
+export class Schedule {
+  private cronPattern: string = ''
+  private timezone: string = 'America/Los_Angeles'
+  private task: () => void
+  private cmd?: string
+
+  constructor(task: () => void) {
+    this.task = task
+  }
+
+  everySecond() {
+    this.cronPattern = '* * * * * *'
+    return this
+  }
+
+  everyMinute() {
+    this.cronPattern = '0 * * * * *'
+    return this
+  }
+
+  everyFiveMinutes() {
+    this.cronPattern = '*/5 * * * *'
+    return this
+  }
+
+  everyTenMinutes() {
+    this.cronPattern = '*/10 * * * *'
+    return this
+  }
+
+  everyThirtyMinutes() {
+    this.cronPattern = '*/30 * * * *'
+    return this
+  }
+
+  hourly() {
+    this.cronPattern = '0 0 * * * *'
+    return this
+  }
+
+  daily() {
+    this.cronPattern = '0 0 0 * * *'
+    return this
+  }
+
+  weekly() {
+    this.cronPattern = '0 0 0 * * 0'
+    return this
+  }
+
+  monthly() {
+    this.cronPattern = '0 0 0 1 * *'
+    return this
+  }
+
+  yearly() {
+    this.cronPattern = '0 0 0 1 1 *'
+    return this
+  }
+
+  onDays(days: number[]) {
+    const dayPattern = days.join(',')
+    this.cronPattern = `0 0 0 * * ${dayPattern}`
+    return this
+  }
+
+  // between(startTime: string, endTime: string) {
+  //   // This method is a placeholder. Actual implementation will vary based on requirements.
+  //   // Cron does not directly support "between" times without additional logic.
+  //   console.warn('The "between" method is not directly supported by cron patterns and requires additional logic.')
+  //   return this
+  // }
+
+  at(time: string) {
+    // Assuming time is in "HH:MM" format
+    const [hour, minute] = time.split(':').map(Number)
+    this.cronPattern = `${minute} ${hour} * * *`
+    return this
+  }
+
+  setTimeZone(timezone: string) {
+    this.timezone = timezone
+    return this
+  }
+
+  start() {
+    new CronJob(this.cronPattern, this.task, null, true, this.timezone)
+    log.info(`Scheduled task with pattern: ${this.cronPattern} in timezone: ${this.timezone}`)
+  }
+
+  static command(cmd: string) {
+    // log.info(`Executing command: ${cmd}`)
+    this.cmd = cmd
+    return this
+  }
+}
+
+export function sendAt(cronTime: string | Date | DateTime): DateTime {
+  return new CronTime(cronTime).sendAt()
+}
+
+export function timeout(cronTime: string | Date | DateTime): number {
+  return new CronTime(cronTime).getTimeout()
+}
+
+export default Schedule