@rvoh/psychic-workers 2.9.0 → 2.9.1

package/dist/cjs/src/background/BaseScheduledService.js

@@ -46,6 +46,9 @@ export default class BaseScheduledService {
      * ```ts
      * await MySchedulableClass.schedule('0 * * * *', 'myHourlyMethod', 'abc', 123)
      * ```
+     * The cron `pattern` is evaluated in UTC, independent of the worker
+     * process's time zone. For example, `'0 9 * * *'` runs daily at 09:00 UTC.
+     *
      * Awaiting `schedule` confirms that the BullMQ job scheduler has been
      * registered or updated in Redis. It does not invoke the method inline or
      * wait for any scheduled run to complete. Independent queue workers may
@@ -56,7 +59,7 @@ export default class BaseScheduledService {
      * the scheduled job, call `WorkerTestUtils.workScheduled()`, or invoke the
      * method directly to test its body.
      *
-     * @param pattern - A cron string representing the time interval you wish this to run on
+     * @param pattern - A cron string evaluated in UTC, representing the time interval you wish this to run on
      * @param methodName - the name of the static method you wish to run in the background
      * @param args - a variadic list of arguments to be sent to your method
      */

package/dist/cjs/src/background/index.js

@@ -723,7 +723,7 @@ export class Background {
      * to be scheduled to run at a specified cron pattern
      *
      * @param ObjectClass - the class you wish to background
-     * @param pattern - the cron string you wish to use to govern the scheduling for this job
+     * @param pattern - the cron string, evaluated in UTC, governing the scheduling for this job
      * @param method - the method you wish to background
      * @param globalName - the globalName of the class you are processing
      * @param args - (optional) a list of arguments to provide to your method when it is called
@@ -736,7 +736,7 @@ export class Background {
         const queueInstance = this.queueInstance(jobConfig);
         if (!queueInstance)
             throw new Error(`Missing queue for: ${jobConfig.queue?.toString()}`);
-        await queueInstance.upsertJobScheduler(schedulerId, { pattern }, {
+        await queueInstance.upsertJobScheduler(schedulerId, { pattern, tz: 'UTC' }, {
             name: 'BackgroundJobQueueStaticJob',
             // the priority from the service's `backgroundJobConfig`, written where open-source
             // BullMQ reads it. Without it BullMQ enqueues every cron run at no priority at all,

package/dist/esm/src/background/BaseScheduledService.js

@@ -46,6 +46,9 @@ export default class BaseScheduledService {
      * ```ts
      * await MySchedulableClass.schedule('0 * * * *', 'myHourlyMethod', 'abc', 123)
      * ```
+     * The cron `pattern` is evaluated in UTC, independent of the worker
+     * process's time zone. For example, `'0 9 * * *'` runs daily at 09:00 UTC.
+     *
      * Awaiting `schedule` confirms that the BullMQ job scheduler has been
      * registered or updated in Redis. It does not invoke the method inline or
      * wait for any scheduled run to complete. Independent queue workers may
@@ -56,7 +59,7 @@ export default class BaseScheduledService {
      * the scheduled job, call `WorkerTestUtils.workScheduled()`, or invoke the
      * method directly to test its body.
      *
-     * @param pattern - A cron string representing the time interval you wish this to run on
+     * @param pattern - A cron string evaluated in UTC, representing the time interval you wish this to run on
      * @param methodName - the name of the static method you wish to run in the background
      * @param args - a variadic list of arguments to be sent to your method
      */

package/dist/esm/src/background/index.js

@@ -723,7 +723,7 @@ export class Background {
      * to be scheduled to run at a specified cron pattern
      *
      * @param ObjectClass - the class you wish to background
-     * @param pattern - the cron string you wish to use to govern the scheduling for this job
+     * @param pattern - the cron string, evaluated in UTC, governing the scheduling for this job
      * @param method - the method you wish to background
      * @param globalName - the globalName of the class you are processing
      * @param args - (optional) a list of arguments to provide to your method when it is called
@@ -736,7 +736,7 @@ export class Background {
         const queueInstance = this.queueInstance(jobConfig);
         if (!queueInstance)
             throw new Error(`Missing queue for: ${jobConfig.queue?.toString()}`);
-        await queueInstance.upsertJobScheduler(schedulerId, { pattern }, {
+        await queueInstance.upsertJobScheduler(schedulerId, { pattern, tz: 'UTC' }, {
             name: 'BackgroundJobQueueStaticJob',
             // the priority from the service's `backgroundJobConfig`, written where open-source
             // BullMQ reads it. Without it BullMQ enqueues every cron run at no priority at all,

package/dist/types/src/background/BaseScheduledService.d.ts

@@ -38,6 +38,9 @@ export default class BaseScheduledService {
      * ```ts
      * await MySchedulableClass.schedule('0 * * * *', 'myHourlyMethod', 'abc', 123)
      * ```
+     * The cron `pattern` is evaluated in UTC, independent of the worker
+     * process's time zone. For example, `'0 9 * * *'` runs daily at 09:00 UTC.
+     *
      * Awaiting `schedule` confirms that the BullMQ job scheduler has been
      * registered or updated in Redis. It does not invoke the method inline or
      * wait for any scheduled run to complete. Independent queue workers may
@@ -48,7 +51,7 @@ export default class BaseScheduledService {
      * the scheduled job, call `WorkerTestUtils.workScheduled()`, or invoke the
      * method directly to test its body.
      *
-     * @param pattern - A cron string representing the time interval you wish this to run on
+     * @param pattern - A cron string evaluated in UTC, representing the time interval you wish this to run on
      * @param methodName - the name of the static method you wish to run in the background
      * @param args - a variadic list of arguments to be sent to your method
      */

package/dist/types/src/background/index.d.ts

@@ -273,7 +273,7 @@ export declare class Background {
      * to be scheduled to run at a specified cron pattern
      *
      * @param ObjectClass - the class you wish to background
-     * @param pattern - the cron string you wish to use to govern the scheduling for this job
+     * @param pattern - the cron string, evaluated in UTC, governing the scheduling for this job
      * @param method - the method you wish to background
      * @param globalName - the globalName of the class you are processing
      * @param args - (optional) a list of arguments to provide to your method when it is called

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic-workers",
   "description": "Background job system for Psychic applications",
-  "version": "2.9.0",
+  "version": "2.9.1",
   "author": "RVO Health",
   "publishConfig": {
     "access": "public"