alchemymvc 1.3.21 → 1.3.23

package/lib/app/helper/syncable.js

@@ -262,6 +262,31 @@ Syncable.setStatic(function setSyncMethod(types, method) {
 	});
 });
 
+/**
+ * Add a method that will only be called on the client.
+ * No response will be returned, since it is sent to multiple clients.
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ *
+ * @param     {Object}   data
+ *
+ * @return    {Syncable}
+ */
+Syncable.setStatic(function setClientMethod(types, method) {
+	return this.setHandledMethod(types, method, function handler(method, args) {
+
+		if (this.is_server) {
+			this.addLog('call', [method.name, args]);
+			return;
+		}
+		
+		let result = method.apply(this, args);
+		return result;
+	});
+});
+
 /**
  * Add a method that fetches info from the server.
  * The response is always a promise.

package/lib/app/helper_field/object_field.js

@@ -34,7 +34,7 @@ ObjectField.setSelfContained(true);
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.5.0
- * @version  0.5.0
+ * @version  1.3.22
  *
  * @param    {Mixed}   value
  *
@@ -42,7 +42,7 @@ ObjectField.setSelfContained(true);
  */
 ObjectField.setMethod(function cast(value) {
 
-	if (typeof value == 'string') {
+	if (this.options.store_as_string && typeof value == 'string') {
 		return JSON.undry(value);
 	}
 

package/lib/app/helper_model/model.js

@@ -49,7 +49,7 @@ Model.constitute(function setModelName() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.2.5
- * @version  1.2.5
+ * @version  1.3.22
  */
 Model.mapEventToMethod({
 	saved          : 'afterSave',
@@ -58,6 +58,7 @@ Model.mapEventToMethod({
 	associated     : 'afterAssociated',
 	found          : 'afterData',
 	foundDocuments : 'afterFind',
+	removed        : 'afterRemove',
 });
 
 /**

package/lib/class/conduit.js

@@ -1,5 +1,6 @@
 const FILECACHE = alchemy.getCache('served_files'),
-      RX_TEXT = /svg|xml|javascript|text/i;
+      RX_TEXT = /svg|xml|javascript|text/i,
+      ENDING = Symbol('ending');
 
 var libstream  = alchemy.use('stream'),
     libpath = alchemy.use('path'),
@@ -16,7 +17,7 @@ var libstream  = alchemy.use('stream'),
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.2.0
+ * @version  1.3.23
  *
  * @param    {IncomingMessage}   req
  * @param    {ServerResponse}    res
@@ -54,6 +55,9 @@ var Conduit = Function.inherits('Alchemy.Base', 'Alchemy.Conduit', function Cond
 	// Where the files will go
 	this.files = {};
 
+	// Are we in the process of ending?
+	this[ENDING] = false;
+
 	this.initValues();
 	this.setReqRes(req, res);
 });
@@ -1456,13 +1460,18 @@ Conduit.setMethod(function setResponseUrl(new_url) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.17
+ * @version  1.3.23
  *
  * @param    {Number}          status    3xx redirection codes. 302 (temporary redirect) by default
  * @param    {String|Object}   options   Options or url
  */
 Conduit.setMethod(function redirect(status, options) {
 
+	if (this.ended) {
+		console.warn('Conduit#redirect() called after response has already ended', this);
+		return;
+	}
+
 	let hard_refresh = false,
 	    url;
 
@@ -1578,7 +1587,7 @@ Conduit.setMethod(function redirect(status, options) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.21
+ * @version  1.3.23
  *
  * @param    {Nulber}  status       Response statuscode
  * @param    {Error}   message      Optional error to send
@@ -1586,6 +1595,11 @@ Conduit.setMethod(function redirect(status, options) {
  */
 Conduit.setMethod(function error(status, message, print_error) {
 
+	if (this.ended) {
+		console.warn('Conduit#error() called after response has already ended', this);
+		return;
+	}
+
 	let print_dev = false;
 
 	if (status instanceof Classes.Alchemy.Error.HTTP) {
@@ -1783,7 +1797,7 @@ Conduit.setMethod(function notModified() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.0
+ * @version  1.3.23
  *
  * @param    {String|Object}   message
  */
@@ -1796,6 +1810,13 @@ Conduit.setMethod(function end(message) {
 	    etag,
 	    temp;
 
+	if (this[ENDING]) {
+		console.warn('Conduit#end() called after conduit has already ended', this);
+		return false;
+	}
+
+	this[ENDING] = true;
+
 	if (this.websocket) {
 		throw new Error('You can not end a websocket, use the callback instead');
 	}
@@ -1806,6 +1827,10 @@ Conduit.setMethod(function end(message) {
 
 	if (typeof message !== 'string') {
 
+		if (message && message instanceof Classes.Stream.Stream) {
+			return this._endWithStream(message);
+		}
+
 		// Use regular JSON if DRY has been disabled in settings
 		if (alchemy.settings.json_dry_response === false || this.json_dry === false) {
 			json_type = 'json';
@@ -1878,15 +1903,44 @@ Conduit.setMethod(function end(message) {
 	this._end(message, 'utf-8');
 });
 
+/**
+ * End with a stream
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.23
+ */
+Conduit.setMethod(function _endWithStream(stream) {
+
+	if (this.ended) {
+		console.warn('Conduit#_endWithStream() called after conduit has already ended', this);
+		return false;
+	}
+
+	this[ENDING] = true;
+	this.ended = new Date();
+	this.emit('ending');
+
+	this.flushHeaders();
+
+	stream.pipe(this.response);
+});
+
 /**
  * Call the actual end method
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.14
+ * @version  1.3.23
  */
 Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 
+	if (this.ended) {
+		console.warn('Conduit#_end() called after conduit has already ended', this);
+		return false;
+	}
+
+	this[ENDING] = true;
 	this.ended = new Date();
 
 	this.emit('ending');
@@ -1906,18 +1960,42 @@ Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 		return;
 	}
 
-	let headers = [],
-	    value,
-	    key;
+	// Set the content-length if it hasn't been set yet
+	if (arguments.length > 0 && !this.response_headers['content-length']) {
+		this.response_headers['content-length'] = Buffer.byteLength(message);
+	}
+
+	this.flushHeaders();
+
+	if (arguments.length === 0) {
+		return this.response.end();
+	}
+
+	// End the response
+	return this.response.end(message, encoding);
+});
+
+/**
+ * Flush the headers
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+Conduit.setMethod(function flushHeaders() {
+
+	if (this._flushed) {
+		return;
+	}
+
+	this._flushed = true;
 
 	if (this.status) {
 		this.response.statusCode = this.status;
 	}
 
-	// Set the content-length if it hasn't been set yet
-	if (arguments.length > 0 && !this.response_headers['content-length']) {
-		this.response_headers['content-length'] = Buffer.byteLength(message);
-	}
+	let value,
+	    key;
 
 	for (key in this.response_headers) {
 		value = this.response_headers[key];
@@ -1935,13 +2013,6 @@ Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 
 	// Write the actual headers
 	this.response.writeHead(this.status);
-
-	if (arguments.length === 0) {
-		return this.response.end();
-	}
-
-	// End the response
-	return this.response.end(message, encoding);
 });
 
 /**

package/lib/class/inode_file.js

@@ -338,4 +338,29 @@ File.setMethod(function readString(encoding) {
 	}
 
 	return this.read({encoding: encoding});
+});
+
+/**
+ * Write the given data to the file
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+File.setMethod(function overwrite(contents, options = {}) {
+
+	let pledge = new Pledge();
+
+	options.flag = 'w';
+
+	fs.writeFile(this.path, contents, options, function done(err) {
+
+		if (err) {
+			return pledge.reject(err);
+		}
+
+		pledge.resolve();
+	});
+
+	return pledge;
 });

package/lib/class/model.js

@@ -1287,7 +1287,7 @@ Model.setMethod(async function executeMongoPipeline(pipeline) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  1.3.21
+ * @version  1.3.22
  *
  * @param   {String}     id        The object id
  * @param   {Function}   callback
@@ -1313,12 +1313,33 @@ Model.setMethod(function remove(id, callback) {
 		id = String(id);
 	}
 
-	let query = {};
-	query[this.primary_key] = id;
+	let query = {
+		[this.primary_key] : id,
+	};
 
-	Function.series(function recompute(next) {
-		that.callOrNext('beforeRemove', [id], next);
-	}, function done(err) {
+	let has_remove_events = typeof this.beforeRemove == 'function' || typeof this.afterRemove == 'function' || this.listeners('removed').length;
+	let doc;
+	let tasks = [];
+
+	if (has_remove_events) {
+
+		// Get the actual document
+		tasks.push(async next => {
+			doc = await this.findByPk(id);
+
+			if (!doc) {
+				return next(new Error('Unable to find document with id ' + id));
+			}
+
+			next();
+		});
+
+		tasks.push(next => {
+			this.callOrNext('beforeRemove', [doc], next);
+		});
+	}
+
+	Function.series(tasks, function done(err) {
 
 		if (err) {
 			pledge.reject(err);
@@ -1330,10 +1351,13 @@ Model.setMethod(function remove(id, callback) {
 			if (err != null) {
 				return pledge.reject(err);
 			}
-	
-			that.emit('removed', result, {}, false, function afterRemovedEvent() {
+
+			if (has_remove_events) {
+				that.issueEvent('removed', [doc, result], () => pledge.resolve(result));
+			} else {
 				pledge.resolve(result);
-			});
+			}
+	
 		});
 	});
 

package/lib/class/postponement.js

@@ -293,9 +293,9 @@ Postponement.setMethod(function handleRequest(conduit) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.3.1
- * @version  1.3.2
+ * @version  1.3.23
  *
- * @return   {Boolean}   True if the request is being resumed
+ * @return   {Boolean}   True if the request can be resumed
  */
 Postponement.setMethod(function attemptUnlock() {
 
@@ -307,11 +307,21 @@ Postponement.setMethod(function attemptUnlock() {
 
 	Postponement.scheduleQueueCheck();
 
-	if (this.position_in_queue > 5) {
+	let max_position = alchemy.settings.postpone_max_unlock_position ?? 5;
+
+	if (this.position_in_queue > max_position) {
+		return false;
+	}
+
+	let max_event_loop_lag = alchemy.settings.postpone_max_unlock_event_loop_lag ?? 100;
+
+	if (alchemy.lagInMs() > max_event_loop_lag) {
 		return false;
 	}
 
-	if (alchemy.lagInMs() > 100) {
+	let max_system_load = alchemy.settings.postpone_max_unlock_system_load ?? 110;
+
+	if (alchemy.systemLoad() > max_system_load) {
 		return false;
 	}
 

package/lib/core/client_base.js

@@ -294,7 +294,7 @@ ClientBase.setMethod(function getModel(name, init, options) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.1
- * @version  1.3.2
+ * @version  1.3.22
  *
  * @param    {String}   name   The name of the event to emit
  * @param    {Array}    args   The parameters to pass to the event
@@ -323,7 +323,17 @@ ClientBase.setMethod(function issueEvent(name, args, next) {
 	}
 
 	if (method_name && typeof this[method_name] == 'function') {
-		promise = this[method_name].apply(this, args);
+		try {
+			promise = this[method_name].apply(this, args);
+		} catch (err) {
+			pledge.reject(err);
+
+			if (next) {
+				next(err);
+			}
+
+			return pledge;
+		}
 	}
 
 	Pledge.done(promise, function doneEventPromise(err, result) {

package/lib/init/alchemy.js

@@ -924,7 +924,7 @@ Alchemy.setMethod(function ready(callback) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.2
- * @version  1.3.3
+ * @version  1.3.22
  */
 Alchemy.setMethod(async function doPreload() {
 
@@ -952,7 +952,8 @@ Alchemy.setMethod(async function doPreload() {
 		Blast.getClientPath({
 			modify_prototypes : true,
 			create_source_map : alchemy.settings.source_map,
-			enable_coverage   : !!global.__coverage__
+			enable_coverage   : !!global.__coverage__,
+			debug             : alchemy.settings.debug,
 		});
 	}
 });

package/lib/init/functions.js

@@ -441,26 +441,49 @@ Alchemy.setMethod(function createDir(target, callback) {
 /**
  * Return the key:items of the first object that are no longer in the second
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.0.1
- * @version  0.4.0
+ * @version  1.3.22
  *
- * @param    {Object}
- * @param    {Object}
+ * @param    {Object|Map}   first
+ * @param    {Object|Map}   second
  *
- * @return   {Object}   The items in the first item that are not in the second
+ * @return   {Object}       The items in the first item that are not in the second
  */
 Alchemy.setMethod(function getDifference(first, second) {
 
-	var key,
-	    result = {};
+	let first_is_map = first instanceof Map,
+	    second_is_map = second instanceof Map,
+	    first_keys,
+	    result = {},
+	    first_val,
+	    key,
+	    val;
+
+	if (first_is_map) {
+		first_keys = [...first.keys()];
+	} else {
+		first_keys = Object.keys(first);
+	}
+
+	for (key of first_keys) {
 
-	for (key in first) {
+		if (second_is_map) {
+			val = second.get(key);
+		} else {
+			val = second[key];
+		}
 
 		// If the key in the first item doesn't show up in the second item,
 		// add it to the result
-		if (typeof second[key] === 'undefined') {
-			result[key] = first[key];
+		if (typeof val === 'undefined') {
+			if (first_is_map) {
+				first_val = first.get(key);
+			} else {
+				first_val = first[key];
+			}
+
+			result[key] = first_val;
 		}
 	}
 
@@ -470,24 +493,42 @@ Alchemy.setMethod(function getDifference(first, second) {
 /**
  * Return the shared items
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.0.1
- * @version  0.4.0
+ * @version  1.3.22
  *
- * @param    {Object}
- * @param    {Object}
+ * @param    {Object|Map}   first
+ * @param    {Object|Map}   second
  *
  * @return   {Object}   The items in the second item that are also in the first
  */
 Alchemy.setMethod(function getShared(first, second) {
 
-	var key,
-	    result = {};
+	let first_is_map = first instanceof Map,
+	    second_is_map = second instanceof Map,
+	    first_keys,
+	    result = {},
+	    key,
+	    val;
+
+	if (first_is_map) {
+		first_keys = [...first.keys()];
+	} else {
+		first_keys = Object.keys(first);
+	}
 
-	for (key in first) {
+	for (key of first_keys) {
 
-		if (typeof second[key] !== 'undefined') {
-			result[key] = second[key];
+		if (second_is_map) {
+			val = second.get(key);
+		} else {
+			val = second[key];
+		}
+
+		// If the key in the first item doesn't show up in the second item,
+		// add it to the result
+		if (typeof val !== 'undefined') {
+			result[key] = val;
 		}
 	}
 

package/lib/init/load_functions.js

@@ -19,7 +19,7 @@ var fs               = alchemy.use('fs'),
  * 
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  1.1.5
+ * @version  1.3.22
  *
  * @param   {String}  dirPath    The path to load
  * @param   {Object}  options
@@ -44,6 +44,7 @@ Alchemy.setMethod(function usePath(dirPath, options) {
 
 	options._level++;
 	useOptions._level = options._level;
+	useOptions.skip = options.skip;
 
 	// Always ignore .git directories
 	modularRegex.push(/^.git$/);
@@ -166,7 +167,7 @@ Alchemy.setProperty('default_use_path_options', {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  1.2.0
+ * @version  1.3.22
  *
  * @param   {String}   dir_path
  * @param   {Object}   options
@@ -214,6 +215,10 @@ Alchemy.setMethod(function _usePath(dir_path, options) {
 	for (i = 0; i < files.length; i++) {
 		file_name = files[i];
 
+		if (file_name == 'routes.js' && options.skip?.length && options.skip.includes('routes')) {
+			continue;
+		}
+
 		// Skip hidden files or the "empty" file
 		if (file_name[0] == '.' || file_name == 'empty') {
 			continue;
@@ -289,7 +294,8 @@ Alchemy.setMethod(function _usePath(dir_path, options) {
 			ignore        : options.ignore,
 			recursive     : options.recursive - 1,
 			_level        : options._level,
-			modularParent : options.modularParent
+			modularParent : options.modularParent,
+			skip          : options.skip,
 		});
 	}
 

package/lib/stages.js

@@ -156,11 +156,11 @@ alchemy.sputnik.add(function plugins() {
  *
  * @author        Jelle De Loecker   <jelle@develry.be>
  * @since         0.0.1
- * @version       0.0.1
+ * @version       1.3.22
  */
 alchemy.sputnik.add(function base_app() {
 	// Load in the app
-	alchemy.usePath(PATH_APP, {weight: 20});
+	alchemy.usePath(PATH_APP, {weight: 20, skip: ['routes']});
 });
 
 /**
@@ -185,7 +185,7 @@ alchemy.sputnik.add(function define_debug() {
  *
  * @author        Jelle De Loecker   <jelle@elevenways.be>
  * @since         0.0.1
- * @version       1.3.3
+ * @version       1.3.22
  */
 alchemy.sputnik.add(function hawkejs_setup() {
 
@@ -202,7 +202,8 @@ alchemy.sputnik.add(function hawkejs_setup() {
 			modify_prototypes : true,
 			ua                : req.conduit.headers.useragent,
 			create_source_map : alchemy.settings.source_map,
-			enable_coverage   : !!global.__coverage__
+			enable_coverage   : !!global.__coverage__,
+			debug             : alchemy.settings.debug,
 		}).done(gotClientFile);
 
 		function gotClientFile(err, path) {
@@ -244,6 +245,7 @@ alchemy.sputnik.add(function hawkejs_setup() {
 				modify_prototypes : true,
 				ua                : req.conduit.headers.useragent,
 				create_source_map : alchemy.settings.source_map,
+				debug             : alchemy.settings.debug,
 			}).done(gotClientFile);
 		}
 	});
@@ -362,15 +364,15 @@ alchemy.sputnik.add(function middleware() {
  *
  * @author        Jelle De Loecker   <jelle@develry.be>
  * @since         0.0.1
- * @version       0.4.0
+ * @version       1.3.22
  */
 alchemy.sputnik.add(function routes() {
 	try {
-		alchemy.useOnce(path.resolve(PATH_APP, 'config', 'routes'));
+		alchemy.useOnce(path.resolve(PATH_APP, 'config', 'routes.js'));
 	} catch (err) {
 		// Only output warning when not in client mode
 		if (!alchemy.settings.client_mode) {
-			log.warn('No route config was found');
+			log.warn('No app routes were found:', err);
 		}
 	}
 });

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.3.21",
+	"version": "1.3.23",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -22,7 +22,7 @@
 		"chokidar"         : "~3.5.3",
 		"formidable"       : "~3.5.1",
 		"graceful-fs"      : "~4.2.11",
-		"hawkejs"          : "~2.3.15",
+		"hawkejs"          : "~2.3.19",
 		"jsondiffpatch"    : "~0.5.0",
 		"mime"             : "~3.0.0",
 		"minimist"         : "~1.2.5",
@@ -31,7 +31,7 @@
 		"mongodb"          : "~6.1.0",
 		"ncp"              : "~2.0.0",
 		"postcss"          : "~8.4.31",
-		"protoblast"       : "~0.8.15",
+		"protoblast"       : "~0.8.19",
 		"semver"           : "~7.5.4",
 		"socket.io"        : "~4.7.2",
 		"@11ways/socket.io-stream" : "~0.9.2",