fix: allow data type defintions for jobs

Author: simllll

package.json

@@ -1,9 +1,12 @@
 {
   "name": "@hokify/agenda",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Light weight job scheduler for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "files": [
     "dist"
   ],

src/Job.ts

@@ -4,6 +4,7 @@ import { parsePriority } from './utils/priority';
 import type { Agenda } from './index';
 import { computeFromInterval, computeFromRepeatAt } from './utils/nextRunAt';
 import { IJobParameters } from './types/JobParameters';
+import type { DefinitionProcessor } from './types/JobDefinition';
 
 const log = debug('agenda:job');
 
@@ -13,12 +14,31 @@ const log = debug('agenda:job');
  * @property {Object} agenda - The Agenda instance
  * @property {Object} attrs
  */
-export class Job {
-	readonly attrs: IJobParameters;
+export class Job<DATA = any | void> {
+	readonly attrs: IJobParameters<DATA>;
 
+	constructor(
+		agenda: Agenda,
+		args: Partial<IJobParameters<void>> & {
+			name: string;
+			type: 'normal' | 'single';
+		}
+	);
+	constructor(
+		agenda: Agenda,
+		args: Partial<IJobParameters<DATA>> & {
+			name: string;
+			type: 'normal' | 'single';
+			data: DATA;
+		}
+	);
 	constructor(
 		readonly agenda: Agenda,
-		args: Partial<IJobParameters> & { name: string; type: 'normal' | 'single' }
+		args: Partial<IJobParameters<DATA>> & {
+			name: string;
+			type: 'normal' | 'single';
+			data: any;
+		}
 	) {
 		// Remove special args
 
@@ -35,10 +55,11 @@ export class Job {
 		};
 	}
 
-	toJson() {
+	toJson(): Partial<IJobParameters> {
 		const attrs = this.attrs || {};
 		const result = {};
 
+		// eslint-disable-next-line no-restricted-syntax
 		for (const prop in attrs) {
 			if ({}.hasOwnProperty.call(attrs, prop)) {
 				result[prop] = attrs[prop];
@@ -155,18 +176,17 @@ export class Job {
 		return this.agenda.db.saveJob(this);
 	}
 
-	remove() {
+	remove(): Promise<number> {
 		return this.agenda.cancel({ _id: this.attrs._id });
 	}
 
-	async touch(progress?: number) {
-		// eslint-disable-next-line prefer-rest-params
+	async touch(progress?: number): Promise<void> {
 		this.attrs.lockedAt = new Date();
 		this.attrs.progress = progress;
-		return this.save();
+		await this.save();
 	}
 
-	computeNextRunAt() {
+	private computeNextRunAt() {
 		try {
 			if (this.attrs.repeatInterval) {
 				this.attrs.nextRunAt = computeFromInterval(this.attrs);
@@ -222,23 +242,26 @@ export class Job {
 				log('[%s:%s] process function being called', this.attrs.name, this.attrs._id);
 				await new Promise((resolve, reject) => {
 					try {
-						const result = definition.fn(this, err => {
-							if (err) {
-								reject(err);
-								return;
+						const result = (definition.fn as DefinitionProcessor<DATA, (err?) => void>)(
+							this,
+							err => {
+								if (err) {
+									reject(err);
+									return;
+								}
+								resolve();
 							}
-							resolve();
-						});
+						);
 						if (this.isPromise(result)) {
-							result.catch(err => reject(err));
+							(result as any).catch(err => reject(err));
 						}
 					} catch (err) {
 						reject(err);
 					}
 				});
 			} else {
 				log('[%s:%s] process function being called', this.attrs.name, this.attrs._id);
-				await definition.fn(this);
+				await (definition.fn as DefinitionProcessor<DATA, void>)(this);
 			}
 
 			this.attrs.lastFinishedAt = new Date();
@@ -271,6 +294,6 @@ export class Job {
 	}
 
 	private isPromise(value): value is Promise<void> {
-		return Boolean(value && typeof value.then === 'function');
+		return !!(value && typeof value.then === 'function');
 	}
 }

src/JobDbRepository.ts

@@ -8,7 +8,7 @@ import {
 	UpdateQuery,
 	ObjectId
 } from 'mongodb';
-import { Job } from './Job';
+import type { Job } from './Job';
 import { hasMongoProtocol } from './utils/mongodb';
 import type { Agenda } from './index';
 import { IDatabaseOptions, IDbConfig, IMongoOptions } from './types/DbOptions';
@@ -207,22 +207,23 @@ export class JobDbRepository {
 	 * @param {Job} job job to save into MongoDB
 	 * @returns {Promise} resolves when job is saved or errors
 	 */
-	async saveJob(job: Job) {
+	async saveJob<T = any>(job: Job<T>): Promise<Job<T>> {
 		try {
 			log('attempting to save a job into Agenda instance');
 
 			// Grab information needed to save job but that we don't want to persist in MongoDB
 			const id = job.attrs._id;
-			const { unique, uniqueOpts } = job.attrs;
+			// const { unique, uniqueOpts } = job.attrs;
 
 			// Store job as JSON and remove props we don't want to store from object
-			const props: Partial<IJobParameters> = job.toJson();
-			delete props._id;
-			delete props.unique;
-			delete props.uniqueOpts;
+			// _id, unique, uniqueOpts
+			// eslint-disable-next-line @typescript-eslint/no-unused-vars
+			const { _id, unique, uniqueOpts, ...props } = {
+				...job.toJson(),
+				// Store name of agenda queue as last modifier in job data
+				lastModifiedBy: this.agenda.attrs.name
+			};
 
-			// Store name of agenda queue as last modifier in job data
-			props.lastModifiedBy = this.agenda.attrs.name;
 			log('[job %s] set job props: \n%O', id, props);
 
 			// Grab current time and set default query options for MongoDB
@@ -291,11 +292,11 @@ export class JobDbRepository {
 				return this.processDbResult(job, result.value);
 			}
 
-			if (unique) {
+			if (job.attrs.unique) {
 				// If we want the job to be unique, then we can upsert based on the 'unique' query object that was passed in
 				const query: FilterQuery<any> = job.attrs.unique;
 				query.name = props.name;
-				if (uniqueOpts?.insertOnly) {
+				if (job.attrs.uniqueOpts?.insertOnly) {
 					update = { $setOnInsert: props };
 				}
 

src/JobProcessor.ts

@@ -21,7 +21,7 @@ export class JobProcessor {
 			| undefined;
 	} = {};
 
-	getStatus() {
+	async getStatus() {
 		return {
 			jobStatus: this.jobStatus,
 			runningJobs: this.runningJobs.length,