alchemymvc 1.3.16 → 1.3.18

package/lib/app/helper_model/document.js

@@ -1277,6 +1277,7 @@ Document.setMethod(function hasChanged(name) {
 
 		for (key in this.$attributes.original_record) {
 			if (!Object.alike(this.$attributes.original_record[key], this[key])) {
+				// @TODO: some special fields always end up being different
 				result = true;
 				break;
 			}

package/lib/app/model/alchemy_task_history_model.js

@@ -0,0 +1,109 @@
+/**
+ * The Alchemy Task History model:
+ * keep track of all the tasks that have been run
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.5.0
+ * @version  0.5.0
+ */
+const AlchemyTaskHistory = Function.inherits('Alchemy.Model.App', 'AlchemyTaskHistory');
+
+/**
+ * Constitute the class wide schema
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.5.0
+ * @version  1.3.17
+ */
+AlchemyTaskHistory.constitute(function addTaskFields() {
+
+	this.belongsTo('AlchemyTask', {
+		description : 'The original AlchemyTask document it belonged to',
+	});
+
+	// The timestamp this was scheduled for
+	this.addField('scheduled_at', 'Date', {
+		description : 'The original date this was scheduled for',
+	});
+
+	this.addField('process_id', 'Integer', {
+		description : 'The process ID of the task',
+	});
+
+	// The type of Task that is running
+	this.addField('type', 'Enum', {
+		values: Classes.Alchemy.Task.Task.getLiveDescendantsMap(),
+	});
+
+	// The payload/settings of the task
+	this.addField('settings', 'Schema', {
+		description : 'The settings of the task at the time it ran',
+		schema: 'type'
+	});
+
+	this.addField('had_error', 'Boolean', {
+		description : 'Did this task run into an error?'
+	});
+
+	this.addField('error_message', 'String', {
+		description : 'The main error message'
+	});
+
+	this.addField('error_stack', 'Text', {
+		description : 'The error stack trace'
+	});
+
+	this.addField('is_running', 'Boolean', {
+		description : 'Is this task still running?',
+		default     : false,
+	});
+
+	this.addField('started_at', 'Datetime', {
+		description : 'The datetime this task actually started running',
+	});
+
+	this.addField('ended_at', 'Datetime', {
+		description : 'The datetime this task actually ended',
+	});
+
+	this.addIndex('type');
+	this.addIndex('is_running');
+});
+
+/**
+ * Configure the default chimera fieldsets
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
+ */
+AlchemyTaskHistory.constitute(function chimeraConfig() {
+
+	if (!this.chimera) {
+		return;
+	}
+
+	// Get the list group
+	let list = this.chimera.getActionFields('list');
+
+	list.addField('created');
+	list.addField('type');
+	list.addField('process_id');
+	list.addField('scheduled_at');
+	list.addField('started_at');
+	list.addField('ended_at');
+	list.addField('had_error');
+
+	// Get the edit group
+	let edit = this.chimera.getActionFields('edit');
+
+	edit.addField('type');
+	edit.addField('settings');
+	edit.addField('had_error');
+	edit.addField('error_message');
+	edit.addField('error_stack');
+	edit.addField('started_at');
+	edit.addField('ended_at');
+});

package/lib/app/model/alchemy_task_model.js

@@ -1,34 +1,157 @@
-var all_task_types = alchemy.getClassGroup('task');
-
 /**
- * The Alchemy Task Model class
+ * The Alchemy Task model:
+ * 
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
- * @since    0.5.0
- * @version  0.5.0
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
+ */
+const AlchemyTask = Function.inherits('Alchemy.Model.App', 'AlchemyTask');
+
+/**
+ * Constitute the class wide schema
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
  */
-var AlchemyTask = Function.inherits('Alchemy.Model.App', function AlchemyTask(conduit, options) {
+AlchemyTask.constitute(function addTaskFields() {
+
+	this.addField('title', 'String', {
+		description : 'The title of the task',
+	});
+
+	this.addField('type', 'Enum', {
+		values      : Classes.Alchemy.Task.Task.getLiveDescendantsMap(),
+		description : 'The type of task to run',
+	});
+
+	this.addField('settings', 'Schema', {
+		description : 'The settings to use for running the task',
+		schema: 'type'
+	});
 
-	var that = this;
+	this.addField('enabled', 'Boolean', {
+		description : 'Is this task enabled?',
+		default     : true,
+	});
 
-	AlchemyTask.super.call(this, conduit, options);
+	this.addField('frequency', 'String', {
+		description : 'The frequency this task should run at (CRON syntax)',
+	});
+
+	this.addField('comment', 'Text', {
+		description : 'A comment about this task',
+	});
+
+	this.addField('schedule_type', 'Enum', {
+		values: {
+			user            : 'User',
+			system_forced   : 'System (forced)',
+			system_fallback : 'System (fallback)',
+		},
+		default: 'user',
+	});
+
+	this.addField('forced_schedule_checksum', 'String', {
+		description : 'Checksum of the cron syntax and settings, set only for tasks originating from forced schedules',
+	});
+
+	this.addIndex('forced_schedule_checksum', {
+		unique : true,
+		sparse : true,
+	});
 });
 
 /**
- * Constitute the class wide schema
+ * Configure the default chimera fieldsets
  *
- * @author   Jelle De Loecker <jelle@develry.be>
- * @since    0.5.0
- * @version  0.5.0
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
  */
-AlchemyTask.constitute(function addTaskFields() {
+AlchemyTask.constitute(function chimeraConfig() {
+
+	if (!this.chimera) {
+		return;
+	}
+
+	// Get the list group
+	let list = this.chimera.getActionFields('list');
+
+	list.addField('title');
+	list.addField('type');
+	list.addField('enabled');
+	list.addField('frequency');
+	list.addField('schedule_type');
+
+	// Get the edit group
+	let edit = this.chimera.getActionFields('edit');
+
+	edit.addField('title');
+	edit.addField('frequency')
+	edit.addField('enabled');
+	edit.addField('type');
+	edit.addField('settings');
+	edit.addField('comment');
+});
+
+/**
+ * Do something before saving the record
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
+ *
+ * @param    {Document.AlchemyTask}   doc
+ */
+AlchemyTask.setMethod(function beforeSave(doc) {
+
+	if (!doc.schedule_type) {
+		doc.schedule_type = 'user';
+	}
+
+	if (doc.enabled == null) {
+		doc.enabled = false;
+	}
+
+	if (!doc.title) {
+		let title = '';
+
+		if (doc.schedule_type == 'system_forced') {
+			title += 'System forced: ';
+		}
+
+		if (doc.schedule_type == 'system_fallback') {
+			title += 'System fallback: ';
+		}
+
+		title += doc.type;
+		doc.title = title;
+	}
+});
+
+/**
+ * Update the schedules after saving
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
+ *
+ * @param    {Object}   main
+ * @param    {Object}   info
+ */
+AlchemyTask.setMethod(function afterSave(main, info) {
 
-	// The type of Task that is running
-	this.addField('type', 'Enum', {values: all_task_types});
+	if (!main.type) {
+		return;
+	}
 
-	// When the task ended
-	this.addField('ended', 'Datetime');
+	if (!alchemy.task_service.has_loaded) {
+		return;
+	}
 
+	alchemy.task_service.rescheduleTasksOfType(main.type);
 });

package/lib/bootstrap.js

@@ -312,6 +312,9 @@ Alchemy.setMethod(function start(options, callback) {
 	// Make sure Blast has executed everything that's still waiting
 	Blast.doLoaded();
 
+	// Call the `afterStart` method
+	this.ready(() => this.afterStart());
+
 	// Schedule the callback
 	return this.ready(callback);
 });

package/lib/class/conduit.js

@@ -125,12 +125,23 @@ Conduit.setProperty(function scene() {
 	return this.getSession().getScene(this.scene_id);
 });
 
+/**
+ * The session cookie name to use
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.18
+ * @version  1.3.18
+ */
+Conduit.setProperty(function session_cookie_name() {
+	return alchemy.settings.session_key || 'alchemy_sid';
+});
+
 /**
  * Enforce the scene_id
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.0
- * @version  1.3.10
+ * @version  1.3.18
  */
 Conduit.enforceProperty(function scene_id(new_value, old_value) {
 
@@ -160,7 +171,10 @@ Conduit.enforceProperty(function scene_id(new_value, old_value) {
 				path: path,
 
 				// Cookie should not live for more than 15 seconds
-				maxAge: 1000 * 15
+				maxAge: 1000 * 15,
+
+				// It should be restricted to the same domain
+				domain: false,
 			});
 		}
 	}
@@ -259,12 +273,17 @@ Conduit.setProperty(function is_secure() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.3.18
  *
- * @param    {Object}
+ * @param    {Object|String}
  */
 Conduit.setMethod(function setRequestBody(body) {
 
+	if (typeof body == 'string') {
+		this.body = body;
+		return;
+	}
+
 	if (!body) {
 		return;
 	}
@@ -490,22 +509,20 @@ Conduit.setMethod(function time() {
 /**
  * Parse the request, get information from the url
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.2.5
+ * @version  1.3.18
  *
  * @param    {IncomingMessage}   req
  * @param    {ServerResponse}    res
  */
 Conduit.setMethod(async function parseRequest() {
 
-	var protocol,
-	    section;
-
 	if (this.method == null && this.request && this.request.method) {
 		this.method = this.request.method.toLowerCase();
 	}
 
+	this.parseUrl();
 	this.parseShortcuts();
 	this.parseLanguages();
 	this.parsePrefix();
@@ -529,11 +546,25 @@ Conduit.setMethod(async function parseRequest() {
 		this.overrideResponseUrl(new_url);
 	}
 
+	this.parseUrl();
+});
+
+/**
+ * Parse the url if it hasn't been done already
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.18
+ * @version  1.3.18
+ */
+Conduit.setMethod(function parseUrl() {
+
 	// If the url has already been parsed, return early
 	if (this.url) {
-		return;
+		return false;
 	}
 
+	let protocol;
+
 	if (alchemy.settings.assume_https) {
 		protocol = 'https://';
 	} else if (this.headers['x-forwarded-proto']) {
@@ -555,7 +586,12 @@ Conduit.setMethod(async function parseRequest() {
 	// Set the host
 	this.url.hostname = this.headers.host;
 
-	let path = this.path;
+	// If no URL was set, use the first requests URL (without the path)
+	if (!alchemy.settings.url && this.headers.host) {
+		alchemy.setUrl(this.url);
+	}
+
+	let path = this.original_path;
 
 	if (this.prefix) {
 		path = '/' + this.prefix + '/' + path;
@@ -569,9 +605,9 @@ Conduit.setMethod(async function parseRequest() {
 /**
  * Parse the headers for shortcuts
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  0.2.0
+ * @version  1.3.17
  */
 Conduit.setMethod(function parseShortcuts() {
 
@@ -597,6 +633,10 @@ Conduit.setMethod(function parseShortcuts() {
 		this.ajax = headers['x-requested-with'] === 'XMLHttpRequest';
 	}
 
+	// Is this request coming from a webview?
+	if (this.in_webview == null) {
+		this.in_webview = headers['x-protoblast-webview'] === 'true';
+	}
 });
 
 /**
@@ -1161,6 +1201,8 @@ Conduit.setMethod(async function callMiddleware() {
 			middleDebug.mark('Preparing viewrender');
 		}
 
+		// An action will be called,
+		// so we can already prepare the viewrender now.
 		that.prepareViewRender();
 
 		if (middleDebug) {
@@ -1184,10 +1226,14 @@ Conduit.setMethod(async function callMiddleware() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.1
+ * @version  1.3.17
  */
 Conduit.setMethod(function prepareViewRender() {
 
+	if (this.renderer.conduit) {
+		return;
+	}
+
 	// Add a link to this conduit
 	this.renderer.conduit = this;
 	this.renderer.server_var('conduit', this);
@@ -1410,7 +1456,7 @@ Conduit.setMethod(function setResponseUrl(new_url) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.6
+ * @version  1.3.17
  *
  * @param    {Number}          status    3xx redirection codes. 302 (temporary redirect) by default
  * @param    {String|Object}   options   Options or url
@@ -1508,13 +1554,18 @@ Conduit.setMethod(function redirect(status, options) {
 		}
 	}
 
-	if (hard_refresh && this.headers['x-hawkejs-request']) {
-		this.setHeader('x-hawkejs-navigate', url);
+	if (options?.popup) {
+		this.setHeader('x-hawkejs-popup', options.popup);
 
-		if (options && options.popup) {
-			this.setHeader('x-hawkejs-popup', options.popup);
+		if (options.popup_url) {
+			this.setHeader('x-hawkejs-popup-url', options.popup_url);
 		}
 
+		hard_refresh = true;
+	}
+
+	if (hard_refresh && this.headers['x-hawkejs-request']) {
+		this.setHeader('x-hawkejs-navigate', url);
 	} else {
 		this.setHeader('Location', url);
 	}
@@ -1921,11 +1972,11 @@ Conduit.setMethod(function createScene() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.3.17
  */
 Conduit.setMethod(function render(template_name, options, callback) {
 
-	var that = this,
+	let that = this,
 	    templates;
 
 	if (typeof options == 'function') {
@@ -1935,6 +1986,10 @@ Conduit.setMethod(function render(template_name, options, callback) {
 		options = {};
 	}
 
+	// Make sure the viewrender is prepared
+	// (Fallback)
+	this.prepareViewRender();
+
 	if (template_name) {
 		templates = [template_name];
 	}
@@ -2266,7 +2321,7 @@ Conduit.setMethod(function _sendStream(stream, options) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.6
+ * @version  1.3.18
  *
  * @param    {Boolean}   create   Create a session if none exist
  *
@@ -2279,13 +2334,10 @@ Conduit.setMethod(function getSession(allow_create = true) {
 		return this.sessionData;
 	}
 
-	let cookie_name,
+	let cookie_name = this.session_cookie_name,
 	    session_id,
 	    session;
 
-	// Set the name of the cookie (could change in the future)
-	cookie_name = alchemy.settings.session_key || 'alchemy_sid';
-
 	// Get the ID of the session
 	session_id = this.cookie(cookie_name);
 
@@ -2449,9 +2501,9 @@ Conduit.setMethod(function setRouteParameters(data) {
 /**
  * Get/set a cookie
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  0.4.2
+ * @version  1.3.18
  *
  * @param    {String}   name
  * @param    {Mixed}    value
@@ -2459,10 +2511,6 @@ Conduit.setMethod(function setRouteParameters(data) {
  */
 Conduit.setMethod(function cookie(name, value, options) {
 
-	var header,
-	    arr,
-	    key;
-
 	// Return if cookies are disabled
 	if (!alchemy.settings.cookies) {
 		return;
@@ -2493,12 +2541,34 @@ Conduit.setMethod(function cookie(name, value, options) {
 	// Store it in the new_cookies object, for quick access
 	this.new_cookies[name] = value;
 
+	// If there is no domain set, see if it is required
+	if ((options.domain === true || options.domain == null) && alchemy.settings.cookie_domain && this.url) {
+		let wanted_domain = alchemy.settings.cookie_domain,
+		    actual_domain = this.url.hostname;
+
+		if (wanted_domain != actual_domain) {
+			// You can only set a cookie on the current domain,
+			// or a parent domain. But not on a child domain.
+			if (wanted_domain.length < actual_domain.length && actual_domain.endsWith(wanted_domain)) {
+				// It's allowed!
+			} else {
+				// When on a domain like "11ways.be" you
+				// can not set a cookie for "www.11ways.be"
+				wanted_domain = false;
+			}
+		}
+
+		if (wanted_domain) {
+			options.domain = wanted_domain;
+		}
+	}
+
 	if (this.websocket) {
 		return this.socket.emit('alchemy-set-cookie', {name: name, value: value, options: options});
 	}
 
 	// Create the basic header string
-	header = String.encodeCookie(name, value, options);
+	let header = String.encodeCookie(name, value, options);
 
 	// Add this to the cookieheader array
 	this.new_cookie_header.push(header);

package/lib/class/model.js

@@ -1246,6 +1246,30 @@ Model.setMethod(function nukeCache(associated, parent) {
 	}
 });
 
+/**
+ * Perform a MongoDB pipeline
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.17
+ * @version  1.3.17
+ *
+ * @param   {Array}     pipeline
+ *
+ * @return  {Promise}
+ */
+Model.setMethod(async function executeMongoPipeline(pipeline) {
+
+	if (typeof this.datasource.collection != 'function') {
+		throw new Error('The `' + this.model_name + '` model does not seem to use MongoDB, unable to perform pipeline');
+	}
+
+	let collection = await this.datasource.collection(this.table);
+	let cursor = await collection.aggregate(pipeline);
+	let result = await cursor.toArray();
+
+	return result;
+});
+
 /**
  * Delete the given record id
  *

package/lib/class/schema_client.js

@@ -892,7 +892,7 @@ Schema.setMethod(function getFieldNames() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.3.0
+ * @version  1.3.17
  *
  * @param    {String|FieldType}   _field
  * @param    {Object}             options
@@ -901,24 +901,19 @@ Schema.setMethod(function getFieldNames() {
  */
 Schema.setMethod(function addIndex(_field, _options) {
 
-	var that = this,
-	    datasource,
-	    options,
-	    order,
-	    field,
-	    path;
-
 	// `Schema` is the `Client.Schema` class in this scope
 	if (Blast.isNode && this.constructor == Schema) {
 		return;
 	}
 
-	field = this.getField(_field);
+	let field = this.getField(_field);
 
 	if (!field) {
 		throw new Error('Could not find field "' + _field + '"');
 	}
 
+	let options;
+
 	if (typeof _options === 'string') {
 		options = {};
 		options[_options] = true;
@@ -961,6 +956,8 @@ Schema.setMethod(function addIndex(_field, _options) {
 		this.has_alternates++;
 	}
 
+	const that = this;
+
 	that.getDatasource().done(function gotDs(err, datasource) {
 
 		if (err) {
@@ -977,7 +974,7 @@ Schema.setMethod(function addIndex(_field, _options) {
 			return alchemy.printLog('error', ['Unable to ensure index on this datasource', options.name], {err: new Error()});
 		}
 
-		path = field.path;
+		let path = field.path;
 
 		if (options.db_property) {
 			path += '.' + options.db_property;
@@ -990,7 +987,7 @@ Schema.setMethod(function addIndex(_field, _options) {
 		datasource.ensureIndex(that.model_class, that.indexes[options.name], function ensuredIndex(err, result) {
 
 			if (err) {
-				alchemy.printLog('error', ['Error ensuring index', options.name], {err: err});
+				alchemy.printLog('error', ['Error ensuring index', options.name, 'in model', that.model_name], {err: err});
 			}
 		});
 	});