plugin-tasks

The tasks plugin is used to register functionality to be executed at specific points in time, recurring or not. This plugin is useful for a worker-like microservice that can process items in the background.

By default, the plugin will create the folder app/tasks where you should save all your task definitions. They will be automatically loaded and registered by the application.

Installation and usage

npm i --save thorin-plugin-tasks@1.x
'use strict';
// app.js entry file
const thorin = require('thorin');

thorin.addPlugin(require('thorin-plugin-tasks'));   // <- add this line
thorin.run((err) => {});

#update config/app.js with your configuration
# run to setup the plugin
node app.js --setup=plugin.tasks

Default configuration

• enabledboolean, true setting this to false will disable any scheduled tasks to execute.
• debugboolean, true enable task debugging and logging
• persiststring, thorin.root + config/.task_dumpthe file used to persist task entry timers.

Plugin functionality

The TaskEntry class

You use the task entry to define what and when gets executed.

The TaskContext class

You use the task context to attach context-specific information about your currently running task.

Example

'use strict';
const taskPlugin = thorin.plugin('tasks');
const myTask = taskPlugin.addTask('my.task.right.here');

myTask
   .prepare((context) => {
      // Set any context information.
      context.items = [];
      context.processed = 0;
   })
   .action('dequeue', (context) => {   // Return a promise to signal the action completion.
      return new Promise((resolve, reject) => {
         log.info('Should dequeue');
         context.items.push("myItem");
         resolve();
      });
   })
   .action('process', (context) => {   // If returns undefined, go to next action automatically.
      if(context.items.length === 0) return;
      context.items.forEach((item) => {
         log.info('Processing item ', item);
         context.processed++;
      });
   })
   .action('release', (context) => {
      if(context.processed === 0) return;
      log.info('Releasing items');
      context.items = [];
   });
// Schedule the way our actions will be executed and when
myTask.schedule([
   'dequeue',
   'process',
   'release'
], {
   delay: '2s',
   timer: '40s',
   timeout: '30s'
});
// Listen for any events.
myTask
   .handle('completed', (context) => {
      log.info('Processed: ', context.processed);
   })
   .handle('failed', (context, err) => {
      log.warn(`Failed to finalize task`, err);
   });