alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/class/task.js

@@ -11,7 +11,7 @@ const running = alchemy.shared('Task.running', 'Array'),
 /**
  * The base "Task" class
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  0.5.0
  */
@@ -56,11 +56,11 @@ const Task = Function.inherits('Alchemy.Base', 'Alchemy.Task', function Task() {
  * Add a forced cron schedule:
  * this task will always run at the given time
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param    {String}   cron_schedule
+ * @param    {string}   cron_schedule
  * @param    {Object}   settings
  */
 Task.setStatic(function addForcedCronSchedule(cron_schedule, settings) {
@@ -78,11 +78,11 @@ Task.setStatic(function addForcedCronSchedule(cron_schedule, settings) {
  * Add a fallback cron schedule:
  * this task will run at the given time if no other schedule is found
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param    {String}   cron_schedule
+ * @param    {string}   cron_schedule
  * @param    {Object}   settings
  */
 Task.setStatic(function addFallbackCronSchedule(cron_schedule, settings) {
@@ -99,7 +99,7 @@ Task.setStatic(function addFallbackCronSchedule(cron_schedule, settings) {
 /**
  * Each command has a configuration schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  0.5.0
  */
@@ -112,7 +112,7 @@ Task.constitute(function setSchema() {
 /**
  * Return the class-wide schema
  *
- * @type   {Schema}
+ * @type     {Schema}
  */
 Task.setProperty(function schema() {
 	return this.constructor.schema;
@@ -131,14 +131,14 @@ Task.startNewGroup();
 /**
  * Indicate this command can be paused
  *
- * @type   {Boolean}
+ * @type     {boolean}
  */
 Task.setProperty('can_be_paused', true);
 
 /**
  * Indicate this command can be stopped
  *
- * @type   {Schema}
+ * @type     {Schema}
  */
 Task.setProperty('can_be_stopped', true);
 
@@ -147,7 +147,7 @@ Task.setProperty('can_be_stopped', true);
  * only set when command block should never use
  * `_getDescription`
  *
- * @type {Boolean}
+ * @type     {boolean}
  */
 Task.setProperty('static_description', '');
 
@@ -155,7 +155,7 @@ Task.setProperty('static_description', '');
  * Always execute `_getDescription`, even when
  * there are no settings
  *
- * @type {Boolean}
+ * @type     {boolean}
  */
 Task.setProperty('force_description_callback', false);
 
@@ -166,7 +166,7 @@ Task.setProperty('force_description_callback', false);
  * @since    1.3.17
  * @version  1.3.17
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 Task.setProperty(function has_started() {
 	return this[STATUS] > STARTING;
@@ -179,7 +179,7 @@ Task.setProperty(function has_started() {
  * @since    1.3.17
  * @version  1.3.17
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 Task.setProperty(function is_paused() {
 	return this[STATUS] == PAUSED;
@@ -192,7 +192,7 @@ Task.setProperty(function is_paused() {
  * @since    1.3.17
  * @version  1.3.17
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 Task.setProperty(function has_stopped() {
 	return this[STATUS] == STOPPED;
@@ -226,11 +226,11 @@ Task.setMethod(function toJSON() {
 /**
  * Callback with a nice description
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.17
  *
- * @return   {Promise<String>}
+ * @return   {Promise<string>}
  */
 Task.setMethod(async function getDescription() {
 
@@ -249,11 +249,11 @@ Task.setMethod(async function getDescription() {
  * Callback with a nice description,
  * should be modified upon extension
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  0.3.0
  *
- * @return   {Promise<String>}
+ * @return   {Promise<string>}
  */
 Task.setMethod(async function _getDescription() {
 	return this.constructor.title || this.name;
@@ -263,7 +263,7 @@ Task.setMethod(async function _getDescription() {
  * The main function to execute. Should not be called directly.
  * Needs to be overridden by child classes.
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  1.3.17
  */
@@ -274,7 +274,7 @@ Task.setMethod(async function executor() {
 /**
  * Set the payload/settings
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
@@ -287,7 +287,7 @@ Task.setMethod(function setPayload(payload) {
 /**
  * Set the original AlchemyTask document
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
@@ -300,7 +300,7 @@ Task.setMethod(function setAlchemyTaskDocument(doc) {
 /**
  * Set the AlchemyTaskHistory document
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
@@ -313,7 +313,7 @@ Task.setMethod(function setAlchemyTaskHistoryDocument(doc) {
 /**
  * Start executing the command
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.17
  *
@@ -329,7 +329,7 @@ Task.setMethod(async function start(payload) {
 		this.setPayload(payload);
 	}
 
-	const History = Model.get('AlchemyTaskHistory');
+	const History = Model.get('System.TaskHistory');
 
 	this[STATUS] = STARTED;
 	this[RUNNING_PLEDGE] = new Pledge();
@@ -398,7 +398,7 @@ Task.setMethod(async function start(payload) {
 /**
  * Stop the running command
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.17
  */
@@ -418,7 +418,7 @@ Task.setMethod(async function stop() {
 /**
  * Pause the running command
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.17
  */
@@ -445,7 +445,7 @@ Task.setMethod(function pause() {
 /**
  * Resume this task if it has been paused
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.17
  */
@@ -476,7 +476,7 @@ Task.setMethod(function resume() {
 /**
  * Get a parameter from the payload by the given name
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
@@ -487,7 +487,7 @@ Task.setMethod(function getParam(name) {
 /**
  * Wait for the pause to resolve
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.21
  */
@@ -509,7 +509,7 @@ Task.setMethod(function waitUntilResumed() {
 /**
  * Wait if the system is too busy
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  */
@@ -525,7 +525,7 @@ Task.setMethod(function waitIfTooBusy() {
 /**
  * Do a loop until the system is no longer busy
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  */
@@ -549,12 +549,12 @@ async function doAsyncLoopUntilNotBusy(max_tries) {
 /**
  * Report command progress
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.17
  *
- * @param    {Number}   percentage    Percentage that is done as a decimal (between 0 & 1)
- * @param    {String}   type          The type of status
+ * @param    {number}   percentage    Percentage that is done as a decimal (between 0 & 1)
+ * @param    {string}   type          The type of status
  *
  * @return   {Object}
  */
@@ -636,12 +636,12 @@ Task.setMethod(function report(percentage, type) {
  * Report progress, Janeway monkey-patches this method
  * and uses it to display the progress bar.
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  0.5.0
  *
- * @param    {Number}   value   A value between 0-100
- * @param    {String}   label   An optional label
+ * @param    {number}   value   A value between 0-100
+ * @param    {string}   label   An optional label
  */
 Task.setMethod(function reportProgress(value, label) {
 	this.progress = value;
@@ -650,7 +650,7 @@ Task.setMethod(function reportProgress(value, label) {
 /**
  * Log command messages
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  0.3.0
  */
@@ -673,7 +673,7 @@ Task.setMethod(function log() {
 /**
  * Start executing a task
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  0.5.0
  *

package/lib/class/task_service.js

@@ -8,9 +8,9 @@ let running_task_menu,
 /**
  * The TaskService class
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
- * @version  1.3.17
+ * @version  1.4.0
  */
 const Service = Function.inherits('Alchemy.Base', 'Alchemy.Task', function TaskService() {
 
@@ -19,7 +19,7 @@ const Service = Function.inherits('Alchemy.Base', 'Alchemy.Task', function TaskS
 	}
 
 	// Get the AlchemyTask model
-	this.AlchemyTask = Model.get('AlchemyTask');
+	this.AlchemyTask = Model.get('System.Task');
 
 	// Keep track of all running tasks
 	this.running_tasks = [];
@@ -33,20 +33,16 @@ const Service = Function.inherits('Alchemy.Base', 'Alchemy.Task', function TaskS
 	this.initSchedules();
 
 	singleton = this;
-
-	if (alchemy.settings.janeway_task_menu) {
-		this.createJanewayTaskMenu();
-	}
 });
 
 /**
  * Get a TaskSchedule instance for the given taks
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @return   {TaskSchedules|String}
+ * @return   {TaskSchedules|string}
  */
 Service.setMethod(function getTaskSchedules(constructor) {
 
@@ -75,15 +71,15 @@ Service.setMethod(function getTaskSchedules(constructor) {
 /**
  * Checksum the given cron schedule & settings
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param    {String} type_path
+ * @param    {string} type_path
  * @param    {Cron}   cron
  * @param    {Object} settings
  *
- * @return   {String}
+ * @return   {string}
  */
 Service.setMethod(function checksumSystemSchedule(type_path, cron, settings) {
 
@@ -103,9 +99,9 @@ Service.setMethod(function checksumSystemSchedule(type_path, cron, settings) {
 /**
  * Initialize the schedules on boot
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
- * @version  1.3.20
+ * @version  1.4.0
  */
 Service.setMethod(async function initSchedules() {
 
@@ -172,7 +168,7 @@ Service.setMethod(async function initSchedules() {
 			let entry = required_system_schedules.get(checksum);
 
 			// If the checksum is not in the required system schedules, remove it
-			if (!entry) {
+			if (!entry || !entry.cron) {
 				await record.remove();
 			}
 
@@ -231,7 +227,7 @@ Service.setMethod(async function initSchedules() {
 /**
  * Create the Janeway task menu
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.21
  */
@@ -303,7 +299,7 @@ Service.setMethod(function createJanewayTaskMenu() {
 /**
  * Update all the schedule `setTimeout` calls that need it
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
@@ -316,7 +312,7 @@ Service.setMethod(function updateTimeoutCalls() {
 /**
  * Schedule forced tasks
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
@@ -336,13 +332,13 @@ Service.setMethod(async function rescheduleAllTasks() {
 /**
  * Get the constructor of the given task type
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param    {String|Function}   task_type_path
+ * @param    {string|Function}   task_type_path
  *
- * @return   {Function|Boolean}
+ * @return   {Function|boolean}
  */
 Service.setMethod(function getTaskConstructor(task_type_path) {
 
@@ -367,11 +363,11 @@ Service.setMethod(function getTaskConstructor(task_type_path) {
 /**
  * Reschedule all tasks of the given type
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param    {String|Function}   task_class
+ * @param    {string|Function}   task_class
  */
 Service.setMethod(async function rescheduleTasksOfType(task_class) {
 
@@ -389,7 +385,7 @@ Service.setMethod(async function rescheduleTasksOfType(task_class) {
 
 	schedules.clearAll();
 
-	const Task = Model.get('AlchemyTask');
+	const Task = Model.get('System.Task');
 	const crit = Task.find();
 	crit.where('type').equals(task_class.type_path);
 	const records = await Task.find('all', crit);
@@ -445,7 +441,7 @@ Service.setMethod(async function rescheduleTasksOfType(task_class) {
 /**
  * Simple class to keep track of a task's schedule
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
@@ -457,7 +453,7 @@ class TaskSchedules {
 	/**
 	 * Initialize the instance
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -468,7 +464,7 @@ class TaskSchedules {
 	/**
 	 * Getter for the amount of schedules
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -479,7 +475,7 @@ class TaskSchedules {
 	/**
 	 * Add a schedule (with the given settings)
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 *
@@ -496,7 +492,7 @@ class TaskSchedules {
 	/**
 	 * Update all the timeout calls that need it.
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -509,7 +505,7 @@ class TaskSchedules {
 	/**
 	 * Create a start menu entry for the given record
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -531,7 +527,7 @@ class TaskSchedules {
 	/**
 	 * Start a task from the menu
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.20
 	 */
@@ -547,7 +543,7 @@ class TaskSchedules {
 	/**
 	 * Clear all the schedules
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -570,7 +566,7 @@ class TaskSchedules {
 /**
  * Simple class to keep track of a task's schedule
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
@@ -594,7 +590,7 @@ class TaskSchedule {
 	/**
 	 * Initialize the instance
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 *
@@ -613,7 +609,7 @@ class TaskSchedule {
 	/**
 	 * Create a new instance with the current settings
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -629,7 +625,7 @@ class TaskSchedule {
 	/**
 	 * Calculate the next scheduled date
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -642,7 +638,7 @@ class TaskSchedule {
 	 * With the current scheduled date,
 	 * check if the timeout call needs to be updated.
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -668,7 +664,7 @@ class TaskSchedule {
 	 * Propose a new scheduled date.
 	 * If another date is already set, the closest one will be used.
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -691,13 +687,13 @@ class TaskSchedule {
 	 * Get the AlchemyTaskHistory document for the given date.
 	 * If it does not exist yet, it will be created.
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
 	async getHistoryDocumentForDate(date) {
 
-		const TaskHistory = Model.get('AlchemyTaskHistory');
+		const TaskHistory = Model.get('System.TaskHistory');
 		const crit = TaskHistory.find();
 
 		crit.where('scheduled_at').equals(date);
@@ -738,7 +734,7 @@ class TaskSchedule {
 	 * Set the next scheduled date.
 	 * Current date will be overridden no matter what.
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -777,7 +773,7 @@ class TaskSchedule {
 	/**
 	 * Do something when the Janeway menu item is clicked.
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -788,7 +784,7 @@ class TaskSchedule {
 	/**
 	 * Actually set the date & timeout (and history document)
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -813,7 +809,7 @@ class TaskSchedule {
 	/**
 	 * Does the current process own this task?
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */
@@ -854,7 +850,7 @@ class TaskSchedule {
 	/**
 	 * Do a manual start
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.20
 	 *
@@ -877,7 +873,7 @@ class TaskSchedule {
 	/**
 	 * Actually run the task
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.20
 	 */
@@ -944,7 +940,7 @@ class TaskSchedule {
 	/**
 	 * Clear the timer
 	 *
-	 * @author   Jelle De Loecker   <jelle@elevenways.be>
+	 * @author   Jelle De Loecker <jelle@elevenways.be>
 	 * @since    1.3.17
 	 * @version  1.3.17
 	 */