@cleverbrush/scheduler 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/types.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schemas = exports.schemaRegistry = void 0;
+const schema_1 = require("@cleverbrush/schema");
+const registry = new schema_1.SchemaRegistry()
+    .addPreprocessor('StringToDate', (value) => {
+    if (typeof value === 'undefined')
+        return value;
+    if (typeof value === 'string') {
+        const time = Date.parse(value);
+        if (Number.isNaN(time))
+            return value;
+        return new Date(time);
+    }
+    return value;
+})
+    .addSchema('Common.Date', ({ object }) => object()
+    .mapToType()
+    .addValidator((value) => value instanceof Date && !Number.isNaN(value)
+    ? {
+        valid: true
+    }
+    : {
+        valid: false,
+        errors: ['should be a valid Date object']
+    }))
+    .addSchema('Templates.Schedule', ({ object, number, alias }) => object({
+    /** Number of days between repeats */
+    interval: number().min(1).max(356),
+    /** Hour (0-23) */
+    hour: number().min(0).max(23).optional(),
+    /** Minute (0-59) */
+    minute: number().min(0).max(59).optional(),
+    /** Do not start earlier than this date */
+    startsOn: alias('Common.Date').optional(),
+    /** Do not repeat after this date */
+    endsOn: alias('Common.Date').optional(),
+    /** Max number of repeats (min 1) */
+    maxOccurences: number().min(1).optional(),
+    /** Skip this number of repeats. Min value is 1.  */
+    skipFirst: number().min(1).optional()
+})
+    .setPropPreprocessor('endsOn', 'StringToDate')
+    .addValidator((val) => {
+    if ('endsOn' in val &&
+        'maxOccurences' in val &&
+        // TODO: remove this clause when object validator is fixed in a new version
+        typeof val.endsOf !== 'undefined') {
+        return {
+            valid: false,
+            errors: ['either endsOn or maxOccurences is required']
+        };
+    }
+    return { valid: true };
+}))
+    .addSchemaFrom('Templates.Schedule', 'Models.TaskScheduleMinute', ({ string, base }) => base
+    .removeProp('hour')
+    .removeProp('minute')
+    .addProps({
+    /** Repeat every minute */
+    every: string('minute')
+}))
+    .addSchemaFrom('Templates.Schedule', 'Models.TaskScheduleDay', ({ string, base }) => base.addProps({
+    /** Repeat every day */
+    every: string('day')
+}))
+    .addSchemaFrom('Templates.Schedule', 'Models.TaskScheduleWeek', ({ base, number, string, array }) => base.addProps({
+    /** Repeat every week */
+    every: string('week'),
+    /** Day of week: array of no more than 7 numbers numbers (from 1 to 7 where 1 is Monday). */
+    dayOfWeek: array()
+        .ofType(number().min(1).max(7))
+        .minLength(1)
+        .maxLength(7)
+        .addValidator((val) => {
+        const map = {};
+        for (let i = 0; i < val.length; i++) {
+            if (map[val[i]]) {
+                return {
+                    valid: false,
+                    errors: ['no duplicates allowed']
+                };
+            }
+            map[val[i]] = true;
+        }
+        return {
+            valid: true
+        };
+    })
+}))
+    .addSchemaFrom('Templates.Schedule', 'Models.TaskScheduleMonth', ({ base, string, number, union }) => base.addProps({
+    /** Repeat every month */
+    every: string('month'),
+    /** Day - 'last' or number from 1 to 28 */
+    day: union(string('last'), number().min(1).max(28))
+}))
+    .addSchemaFrom('Templates.Schedule', 'Models.TaskScheduleYear', ({ base, string, number, union }) => base.addProps({
+    /** Repeat every year */
+    every: string('year'),
+    /** Day - 'last' or number from 1 to 28 */
+    day: union(string('last')).or(number().min(1).max(28)),
+    /** Month - number from 1 to 12 */
+    month: number().min(1).max(12)
+}));
+exports.schemaRegistry = registry
+    .addSchema('Models.Schedule', ({ alias, union }) => union(alias('Models.TaskScheduleMinute'), alias('Models.TaskScheduleDay'), alias('Models.TaskScheduleWeek'), alias('Models.TaskScheduleMonth'), alias('Models.TaskScheduleYear')))
+    .addSchema('Models.CreateJobRequest', ({ object, number, string, alias, union, func }) => object({
+    /** Id of job, must be uniq */
+    id: string(),
+    /** Path to js file (relative to root folder) */
+    path: string().minLength(1),
+    /** Job's schedule */
+    schedule: alias('Models.Schedule'),
+    /** Timeout for job (in milliseconds) */
+    timeout: number().min(0).optional(),
+    /** Arbitrary props for job (can be a callback returning props or Promise<props>) */
+    props: union(object().canHaveUnknownProps(), func()).optional(),
+    /** Job will be considered as disabled when more than that count of runs fails consequently
+     * unlimited if negative
+     */
+    maxConsequentFails: number().optional(),
+    /**
+     * Job will be retried right away this times. Job will be retried on next schedule run if this number is exceeded.
+     */
+    maxRetries: number().optional().min(1)
+}));
+exports.Schemas = exports.schemaRegistry;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,gDAAgE;AAIhE,MAAM,QAAQ,GAAG,IAAI,uBAAc,EAAE;KAChC,eAAe,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE;IACvC,IAAI,OAAO,KAAK,KAAK,WAAW;QAAE,OAAO,KAAK,CAAC;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QACrC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;KACzB;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;KACD,SAAS,CAAC,aAAa,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CACrC,MAAM,EAAE;KACH,SAAS,EAAQ;KACjB,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE,CACpB,KAAK,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACzC,CAAC,CAAC;QACI,KAAK,EAAE,IAAI;KACd;IACH,CAAC,CAAC;QACI,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE,CAAC,+BAA+B,CAAC;KAC5C,CACV,CACR;KACA,SAAS,CAAC,oBAAoB,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAC3D,MAAM,CAAC;IACH,qCAAqC;IACrC,QAAQ,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAClC,kBAAkB;IAClB,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxC,oBAAoB;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,0CAA0C;IAC1C,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;IACzC,oCAAoC;IACpC,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;IACvC,oCAAoC;IACpC,aAAa,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACzC,oDAAoD;IACpD,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC;KACG,mBAAmB,CAAC,QAAQ,EAAE,cAAc,CAAC;KAC7C,YAAY,CAAC,CAAC,GAAG,EAAE,EAAE;IAClB,IACI,QAAQ,IAAI,GAAG;QACf,eAAe,IAAI,GAAG;QACtB,2EAA2E;QAC3E,OAAO,GAAG,CAAC,MAAM,KAAK,WAAW,EACnC;QACE,OAAO;YACH,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,CAAC,4CAA4C,CAAC;SACzD,CAAC;KACL;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC,CACT;KACA,aAAa,CACV,oBAAoB,EACpB,2BAA2B,EAC3B,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CACjB,IAAI;KACC,UAAU,CAAC,MAAM,CAAC;KAClB,UAAU,CAAC,QAAQ,CAAC;KACpB,QAAQ,CAAC;IACN,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC;CAC1B,CAAC,CACb;KACA,aAAa,CACV,oBAAoB,EACpB,wBAAwB,EACxB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CACjB,IAAI,CAAC,QAAQ,CAAC;IACV,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;CACvB,CAAC,CACT;KACA,aAAa,CACV,oBAAoB,EACpB,yBAAyB,EACzB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAChC,IAAI,CAAC,QAAQ,CAAC;IACV,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IACrB,4FAA4F;IAC5F,SAAS,EAAE,KAAK,EAAE;SACb,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SAC9B,SAAS,CAAC,CAAC,CAAC;SACZ,SAAS,CAAC,CAAC,CAAC;SACZ,YAAY,CAAC,CAAC,GAAG,EAAE,EAAE;QAClB,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACjC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;gBACb,OAAO;oBACH,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,CAAC,uBAAuB,CAAC;iBACpC,CAAC;aACL;YACD,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;SACtB;QACD,OAAO;YACH,KAAK,EAAE,IAAI;SACd,CAAC;IACN,CAAC,CAAC;CACT,CAAC,CACT;KACA,aAAa,CACV,oBAAoB,EACpB,0BAA0B,EAC1B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAChC,IAAI,CAAC,QAAQ,CAAC;IACV,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC;IACtB,0CAA0C;IAC1C,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CACtD,CAAC,CACT;KACA,aAAa,CACV,oBAAoB,EACpB,yBAAyB,EACzB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAChC,IAAI,CAAC,QAAQ,CAAC;IACV,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IACrB,0CAA0C;IAC1C,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtD,kCAAkC;IAClC,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;CACjC,CAAC,CACT,CAAC;AAEO,QAAA,cAAc,GAAG,QAAQ;KACjC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAC/C,KAAK,CACD,KAAK,CAAC,2BAA2B,CAAC,EAClC,KAAK,CAAC,wBAAwB,CAAC,EAC/B,KAAK,CAAC,yBAAyB,CAAC,EAChC,KAAK,CAAC,0BAA0B,CAAC,EACjC,KAAK,CAAC,yBAAyB,CAAC,CACnC,CACJ;KACA,SAAS,CACN,yBAAyB,EACzB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAC/C,MAAM,CAAC;IACH,8BAA8B;IAC9B,EAAE,EAAE,MAAM,EAAE;IACZ,gDAAgD;IAChD,IAAI,EAAE,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3B,qBAAqB;IACrB,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAClC,wCAAwC;IACxC,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnC,oFAAoF;IACpF,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/D;;OAEG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACzC,CAAC,CACT,CAAC;AAUO,QAAA,OAAO,GAAG,sBAAc,CAAC"}

package/package.json

@@ -1,11 +1,15 @@
 {
     "name": "@cleverbrush/scheduler",
-    "version": "1.0.0-beta.3",
+    "version": "1.0.0-beta.5",
     "keywords": [
         "task scheduler"
     ],
     "author": "Andrew Zolotukhin <andrew_zol@cleverbrush.com>",
     "license": "BSD",
+    "files": [
+        "*",
+        "dist/*"
+    ],
     "main": "./dist/index.js",
     "readme": "https://github.com/cleverbrush/libs/tree/master/libs/scheduler#readme",
     "scripts": {
@@ -17,7 +21,7 @@
         "url": "github:cleverbrush/libs"
     },
     "dependencies": {
-        "@cleverbrush/schema": "1.0.0-beta.3"
+        "@cleverbrush/schema": "1.0.0-beta.5"
     },
     "types": "./dist/index.d.ts"
 }

package/src/ScheduleCalculator.test.ts

@@ -86,7 +86,7 @@ test('day - 4', () => {
         interval: 2,
         startsOn: new Date(Date.UTC(2022, 9, 12, 21, 0, 0, 0)),
         endsOn: new Date(Date.UTC(2022, 11, 12, 0, 0, 0, 0)),
-        startingFromIndex: 3,
+        skipFirst: 2,
         maxOccurences: 10
     });
 
@@ -102,8 +102,10 @@ test('day - 4', () => {
     ];
 
     for (let i = 0; i < results.length; i++) {
-        expect(calculator.hasNext()).toEqual(true);
-        expect(calculator.next().date.getTime()).toEqual(results[i].getTime());
+        const hasNext = calculator.hasNext();
+        expect(hasNext).toEqual(true);
+        const next = calculator.next();
+        expect(next.date.getTime()).toEqual(results[i].getTime());
     }
 
     expect(calculator.hasNext()).toEqual(false);

package/src/ScheduleCalculator.ts

@@ -86,9 +86,12 @@ export class ScheduleCalculator {
             this.#hasNext = true;
         }
 
-        let leftToSkip = this.#schedule.startingFromIndex || 1;
+        let leftToSkip =
+            typeof this.#schedule.skipFirst === 'number'
+                ? this.#schedule.skipFirst
+                : 0;
 
-        while (leftToSkip-- > 1 && this.#hasNext) {
+        while (leftToSkip-- > 0 && this.#hasNext) {
             this.next();
         }
     }

package/src/index.ts

@@ -35,6 +35,7 @@ const CHECK_INTERVAL = 1000 * 10; // every 10 seconds
 const SCHEDULE_JOB_SPAN = 1000 * 60; // 1 hour
 const DEFAULT_JOB_TIMEOUT = 1000 * 20; // 20 seconds
 const DEFAULT_MAX_CONSEQUENT_FAILS = 3;
+const DEFAULT_MAX_RETRIES = 2;
 
 type JobStartItem = {
     jobId: string;
@@ -53,11 +54,16 @@ type JobErrorItem = JobStartItem & {
     error?: Error;
 };
 
+type JobMessageItem = Omit<JobStartItem, 'stdout' | 'stderr'> & {
+    value: any;
+};
+
 type Events = {
     'job:start': (job: JobStartItem) => any;
     'job:end': (job: JobEndItem) => any;
     'job:error': (job: JobErrorItem) => any;
     'job:timeout': (job: JobErrorItem) => any;
+    'job:message': (msg: JobMessageItem) => any;
 };
 
 interface IJobScheduler {
@@ -102,7 +108,7 @@ export class JobScheduler extends EventEmitter implements IJobScheduler {
         }
 
         if (typeof job.successfullTimesRunned === 'number') {
-            schedule.startingFromIndex = job.successfullTimesRunned + 1;
+            schedule.skipFirst = job.successfullTimesRunned - 1;
         }
 
         const res = new ScheduleCalculator(schedule);
@@ -152,8 +158,7 @@ export class JobScheduler extends EventEmitter implements IJobScheduler {
 
         return {
             promise,
-            stderr: worker.stderr,
-            stdout: worker.stdout
+            worker
         };
     }
 
@@ -193,45 +198,54 @@ export class JobScheduler extends EventEmitter implements IJobScheduler {
                 status: 'running'
             });
 
-            const { promise, stderr, stdout } = this.runWorkerWithTimeout(
+            const { promise, worker } = this.runWorkerWithTimeout(
                 fileName,
                 finalProps,
                 job.timeout
             );
 
-            const stdOutPass = stdout.pipe(
+            const stdOutPass = worker.stdout.pipe(
                 new PassThrough({
                     highWaterMark: MAX_BUFFER_SIZE
                 })
             );
-            const stdErrPass = stderr.pipe(
+            const stdErrPass = worker.stderr.pipe(
                 new PassThrough({
                     highWaterMark: MAX_BUFFER_SIZE
                 })
             );
 
-            const stdOutForJobStart = stdout.pipe(
+            const stdOutForJobStart = worker.stdout.pipe(
                 new PassThrough({
                     highWaterMark: MAX_BUFFER_SIZE
                 })
             );
-            const stdErrForJobStart = stderr.pipe(
+            const stdErrForJobStart = worker.stderr.pipe(
                 new PassThrough({
                     highWaterMark: MAX_BUFFER_SIZE
                 })
             );
 
-            const stdOutForJobEnd = stdout.pipe(
+            const stdOutForJobEnd = worker.stdout.pipe(
                 new PassThrough({
                     highWaterMark: MAX_BUFFER_SIZE
                 })
             );
-            const stdErrForJobEnd = stderr.pipe(
+            const stdErrForJobEnd = worker.stderr.pipe(
                 new PassThrough({
                     highWaterMark: MAX_BUFFER_SIZE
                 })
             );
 
+            worker.on('message', (value) => {
+                this.emit('job:message', {
+                    instanceId: instance.id,
+                    jobId: job.id,
+                    startDate,
+                    value
+                });
+            });
+
             this.emit('job:start', {
                 instanceId: instance.id,
                 jobId: job.id,
@@ -323,8 +337,11 @@ export class JobScheduler extends EventEmitter implements IJobScheduler {
 
             await this._jobsRepository.saveJob(job);
 
-            if (shouldRetry) {
-                await this.startJobInstance(instance);
+            if (shouldRetry && instance.retryIndex < instance.maxRetries) {
+                await this.startJobInstance({
+                    ...instance,
+                    retryIndex: instance.retryIndex + 1
+                });
             }
         }
     }
@@ -347,7 +364,9 @@ export class JobScheduler extends EventEmitter implements IJobScheduler {
                 scheduledTo: date,
                 status: 'scheduled',
                 timeout: job.timeout,
-                index
+                index,
+                retryIndex: 0,
+                maxRetries: job.maxRetries
             });
 
             timer = setTimeout(async () => {
@@ -467,7 +486,11 @@ export class JobScheduler extends EventEmitter implements IJobScheduler {
             maxConsequentFails:
                 typeof job.maxConsequentFails === 'number'
                     ? job.maxConsequentFails
-                    : DEFAULT_MAX_CONSEQUENT_FAILS
+                    : DEFAULT_MAX_CONSEQUENT_FAILS,
+            maxRetries:
+                typeof job.maxRetries === 'number'
+                    ? job.maxRetries
+                    : DEFAULT_MAX_RETRIES
         });
     }
 

package/src/types.ts

@@ -40,8 +40,8 @@ const registry = new SchemaRegistry()
             endsOn: alias('Common.Date').optional(),
             /** Max number of repeats (min 1) */
             maxOccurences: number().min(1).optional(),
-            /** Skip this number of repeats - 1. Min value is 1.  */
-            startingFromIndex: number().min(1).optional()
+            /** Skip this number of repeats. Min value is 1.  */
+            skipFirst: number().min(1).optional()
         })
             .setPropPreprocessor('endsOn', 'StringToDate')
             .addValidator((val) => {
@@ -161,7 +161,11 @@ export const schemaRegistry = registry
                 /** Job will be considered as disabled when more than that count of runs fails consequently
                  * unlimited if negative
                  */
-                maxConsequentFails: number().optional()
+                maxConsequentFails: number().optional(),
+                /**
+                 * Job will be retried right away this times. Job will be retried on next schedule run if this number is exceeded.
+                 */
+                maxRetries: number().optional().min(1)
             })
     );
 
@@ -188,6 +192,7 @@ export type Job = {
     successfullTimesRunned?: number;
     consequentFailsCount: number;
     maxConsequentFails: number;
+    maxRetries: number;
 };
 
 export type JobInstance = {
@@ -202,6 +207,8 @@ export type JobInstance = {
     stdOut?: string;
     stdErr?: string;
     exitCode?: number;
+    retryIndex: number;
+    maxRetries: number;
 };
 
 export type JobSchedulerProps = {