@tryghost/job-manager 0.8.23 → 0.9.0

package/lib/job-manager.js

@@ -7,6 +7,7 @@ const {UnhandledJobError, IncorrectUsageError} = require('@tryghost/errors');
 const logging = require('@tryghost/logging');
 const isCronExpression = require('./is-cron-expression');
 const assembleBreeJob = require('./assemble-bree-job');
+const JobsRepository = require('./jobs-repository');
 
 const worker = async (task, callback) => {
     try {
@@ -31,18 +32,73 @@ class JobManager {
      * @param {Object} options
      * @param {Function} [options.errorHandler] - custom job error handler
      * @param {Function} [options.workerMessageHandler] - custom message handler coming from workers
+     * @param {Object} [options.JobModel] - a model which can persist job data in the storage
      */
-    constructor({errorHandler, workerMessageHandler}) {
+    constructor({errorHandler, workerMessageHandler, JobModel}) {
         this.queue = fastq(this, worker, 1);
+        this._jobMessageHandler = this._jobMessageHandler.bind(this);
+        this._jobErrorHandler = this._jobErrorHandler.bind(this);
+
+        const combinedMessageHandler = workerMessageHandler
+            ? ({name, message}) => {
+                workerMessageHandler({name, message});
+                this._jobMessageHandler({name, message});
+            }
+            : this._jobMessageHandler;
+
+        const combinedErrorHandler = errorHandler
+            ? (error, workerMeta) => {
+                errorHandler(error, workerMeta);
+                this._jobErrorHandler(error, workerMeta);
+            }
+            : this._jobErrorHandler;
 
         this.bree = new Bree({
             root: false, // set this to `false` to prevent requiring a root directory of jobs
             hasSeconds: true, // precision is needed to avoid task overlaps after immediate execution
             outputWorkerMetadata: true,
             logger: logging,
-            errorHandler: errorHandler,
-            workerMessageHandler: workerMessageHandler
+            errorHandler: combinedErrorHandler,
+            workerMessageHandler: combinedMessageHandler
+        });
+
+        this.bree.on('worker created', (name) => {
+            this._jobMessageHandler({name, message: 'started'});
         });
+
+        this._jobsRepository = new JobsRepository({JobModel});
+    }
+
+    async _jobMessageHandler({name, message}) {
+        if (message === 'started') {
+            const job = await this._jobsRepository.read(name);
+
+            if (job) {
+                await this._jobsRepository.update(job.id, {
+                    status: 'started',
+                    started_at: new Date()
+                });
+            }
+        } else if (message === 'done') {
+            const job = await this._jobsRepository.read(name);
+
+            if (job) {
+                await this._jobsRepository.update(job.id, {
+                    status: 'finished',
+                    finished_at: new Date()
+                });
+            }
+        }
+    }
+
+    async _jobErrorHandler(error, workerMeta) {
+        const job = await this._jobsRepository.read(workerMeta.name);
+
+        if (job) {
+            await this._jobsRepository.update(job.id, {
+                status: 'failed'
+            });
+        }
     }
 
     /**
@@ -118,6 +174,33 @@ class JobManager {
         }
     }
 
+    /**
+    * Adds a job that could ever be executed once.
+    *
+    * @param {Object} GhostJob - job options
+    * @prop {Function | String} GhostJob.job - function or path to a module defining a job
+    * @prop {String} [GhostJob.name] - unique job name, if not provided takes function name or job script filename
+    * @prop {String | Date} [GhostJob.at] - Date, cron or human readable schedule format. Manage will do immediate execution if not specified. Not supported for "inline" jobs
+    * @prop {Object} [GhostJob.data] - data to be passed into the job
+    * @prop {Boolean} [GhostJob.offloaded] - creates an "offloaded" job running in a worker thread by default. If set to "false" runs an "inline" job on the same event loop
+    */
+    async addOneOffJob({name, job, data, offloaded = true}) {
+        const persistedJob = await this._jobsRepository.read(name);
+
+        if (persistedJob) {
+            throw new IncorrectUsageError({
+                message: `A "${name}" one off job has already been executed.`
+            });
+        }
+
+        await this._jobsRepository.add({
+            name,
+            status: 'queued'
+        });
+
+        this.addJob({name, job, data, offloaded});
+    }
+
     /**
      * Removes an "offloaded" job from scheduled jobs queue.
      * It's NOT yet possible to remove "inline" jobs (will be possible when scheduling is added https://github.com/breejs/bree/issues/68).

package/lib/jobs-repository.js

@@ -0,0 +1,23 @@
+class JobsRepository {
+    constructor({JobModel}) {
+        this._JobModel = JobModel;
+    }
+
+    async add(data) {
+        const job = await this._JobModel.add(data);
+
+        return job;
+    }
+
+    async read(name) {
+        const job = await this._JobModel.findOne({name});
+
+        return job;
+    }
+
+    async update(id, data) {
+        await this._JobModel.edit(data, {id});
+    }
+}
+
+module.exports = JobsRepository;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/job-manager",
-  "version": "0.8.23",
+  "version": "0.9.0",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/job-manager",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -20,12 +20,12 @@
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "9.1.2",
-    "c8": "7.11.2",
-    "date-fns": "2.28.0",
+    "c8": "7.12.0",
+    "date-fns": "2.29.1",
     "delay": "5.0.0",
     "mocha": "10.0.0",
     "should": "13.2.3",
-    "sinon": "13.0.2"
+    "sinon": "14.0.0"
   },
   "dependencies": {
     "@breejs/later": "^4.0.2",
@@ -35,5 +35,5 @@
     "fastq": "^1.11.0",
     "p-wait-for": "^3.2.0"
   },
-  "gitHead": "e14f269ad87fee8f5c7c9fa6c2bc69d587f26e38"
+  "gitHead": "2ce0a263975cf6e0f34233caf19404fd8ab5e7a5"
 }