alchemymvc 1.3.0 → 1.3.2

package/lib/class/schema_client.js

@@ -152,12 +152,16 @@ Schema.setProperty(function has_translatable_fields() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.3
+ * @version  1.3.1
  *
  * @return   {Object}
  */
-Schema.setMethod(function dryClone() {
-	return this.clone();
+Schema.setMethod(function dryClone(wm, custom_method) {
+
+	let obj = JSON.toDryObject(this),
+	    cloned = JSON.undry(obj);
+
+	return cloned;
 });
 
 /**
@@ -166,16 +170,12 @@ Schema.setMethod(function dryClone() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.3
+ * @version  1.3.1
  *
  * @return   {Object}
  */
 Schema.setMethod(function clone() {
-
-	let obj = JSON.toDryObject(this),
-	    cloned = JSON.undry(obj);
-
-	return cloned;
+	return this.dryClone();
 });
 
 /**
@@ -183,7 +183,7 @@ Schema.setMethod(function clone() {
  *
  * @author   Jelle De Loecker <jelle@develry.be>
  * @since    1.1.0
- * @version  1.3.0
+ * @version  1.3.1
  *
  * @return   {Object}
  */
@@ -210,10 +210,6 @@ Schema.setMethod(function toDry() {
 		value.rules.set(key, entry);
 	}
 
-	if (this.parent) {
-		value.parent = this.parent;
-	}
-
 	if (this.model_name) {
 		value.model_name = this.model_name;
 
@@ -224,24 +220,25 @@ Schema.setMethod(function toDry() {
 
 	value.options = this.options;
 
+	let result = {value};
+
 	// Get the sorted fields
-	let options,
-	    fields = this.getSorted(false),
+	let fields = this.getSorted(false),
 	    field,
 	    i;
-
+	
 	for (i = 0; i < fields.length; i++) {
 		field = fields[i];
 
 		value.fields.push({
 			name       : field.name,
-			options    : field.options,
+			options    : field.getOptionsForDrying(),
 			class_name : field.constructor.name,
 			namespace  : field.constructor.namespace,
 		});
 	}
 
-	return {value: value};
+	return result;
 });
 
 /**

package/lib/class/session.js

@@ -5,7 +5,7 @@ var data_listeners = alchemy.shared('data_binding_listeners');
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.3.1
  *
  * @param    {Conduit}   conduit   The initializing conduit
  */
@@ -36,10 +36,19 @@ var Session = Function.inherits('Alchemy.Base', function ClientSession(conduit)
 	this.data_listener_ids = {};
 
 	// Postponed requests
-	this.postponed = new Classes.Develry.Cache();
+	this.postponements = new Classes.Develry.Cache();
+
+	// Postponed requests are invalidated after 3 hours
+	this.postponements.max_age = 3 * 60 * 60 * 1000;
+
+	// Time spent in the queue
+	this.queued_time = 0;
 
-	// Postponed requests are invalidated after 1 hour
-	this.postponed.max_age = 60 * 60 * 1000;
+	// Any postponements that have happened already
+	this.postponement_counter = 0;
+
+	// The amount of renders that have happened during this session
+	this.render_counter = 0;
 
 	// Increment the alchemy session count
 	alchemy.session_count++;
@@ -103,6 +112,56 @@ Session.setProperty(function idle_time() {
 	return result;
 });
 
+/**
+ * Is this an active session?
+ * When no activity happens for 5 minutes, the session becomes inactive.
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @type     {Boolean}
+ */
+Session.setProperty(function is_active() {
+
+	if (this.idle_time < 5 * 60 * 1000) {
+		return true;
+	}
+
+	return false;
+});
+
+/**
+ * Add the amount of time this client has been in the queue
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @return   {Boolean}
+ */
+Session.setMethod(function addFinishedQueueDuration(ms) {
+	this.queued_time += ms;
+});
+
+/**
+ * Has this client already been in the queue?
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @return   {Boolean}
+ */
+Session.setMethod(function hasAlreadyQueued() {
+
+	if (this.queued_time > 0) {
+		return true;
+	}
+
+	return false;
+});
+
 /**
  * Register a conduit
  *
@@ -134,21 +193,84 @@ Session.setMethod(function createMenuItem(conduit) {
 /**
  * Postpone the result
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  0.4.0
+ * @version  1.3.1
  *
  * @param    {Conduit}   conduit   The conduit to postpone
+ * @param    {Object}    options
  *
- * @return   {String}    The postponed id
+ * @return   {Alchemy.Conduit.Postponement}    The postponement
+ */
+Session.setMethod(function postpone(conduit, options) {
+
+	let id = Crypto.uid();
+
+	let postponement = new Classes.Alchemy.Conduit.Postponement(conduit, id, options);
+
+	this.postponements.set(id, postponement);
+
+	this.postponement_counter++;
+
+	return postponement;
+});
+
+/**
+ * Increment the render count
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @return   {Number}    The amount of renders
  */
-Session.setMethod(function postpone(conduit) {
+Session.setMethod(function incrementRenderCount() {
+	return ++this.render_counter;
+});
 
-	var key = Crypto.uid();
+/**
+ * Get a postponement by its id
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @param    {String}   id   The postponement id
+ *
+ * @return   {Alchemy.Conduit.Postponement}    The postponement
+ */
+Session.setMethod(function getPostponement(id) {
+	return this.postponements.get(id);
+});
 
-	this.postponed.set(key, conduit);
+/**
+ * See if a postponement already exists for the given conduit
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @param    {Conduit}   conduit
+ *
+ * @return   {Alchemy.Conduit.Postponement}    The postponement
+ */
+Session.setMethod(function getExistingPostponement(conduit) {
+
+	if (!this.postponement_counter) {
+		return;
+	}
+
+	if (!this.postponements.length) {
+		return;
+	}
 
-	return key;
+	let postponement;
+
+	for (postponement of this.postponements) {
+		if (postponement.original_path === conduit.path) {
+			return postponement;
+		}
+	}
 });
 
 /**
@@ -156,7 +278,7 @@ Session.setMethod(function postpone(conduit) {
  *
  * @author   Jelle De Loecker <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.3.1
  *
  * @param    {Boolean}   expired   True if removed because time ran out
  */
@@ -180,6 +302,10 @@ Session.setMethod(function removed(expired) {
 		this.menu_item.remove();
 	}
 
+	for (let postponement of this.postponements) {
+		postponement.expire();
+	}
+
 	this.emit('removed', expired);
 });
 

package/lib/core/base.js

@@ -717,4 +717,10 @@ Base.setMethod(function debugMark(message) {
  */
 alchemy.getClassGroup = __Protoblast.getGroup;
 
-// PROTOBLAST END CUT
+// PROTOBLAST END CUT
+
+// @TODO: put this somewhere else
+if (Blast.isBrowser) {
+	window.Types = Blast.Types;
+	window.Classes = Blast.Classes;
+}

package/lib/core/client_alchemy.js

@@ -133,7 +133,7 @@ Alchemy.setMethod(function initScene(scene, options) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.3.0
- * @version  1.3.0
+ * @version  1.3.1
  *
  * @param    {String}   id
  * @param    {String}   message
@@ -167,6 +167,8 @@ Alchemy.setMethod(function distinctProblem(id, message, options = {}) {
 
 			if (now >= wait_until) {
 				do_log = true;
+			} else {
+				do_log = false;
 			}
 		} else {
 			do_log = 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.0
+ * @version  1.3.2
  *
  * @param    {String}   name   The name of the event to emit
  * @param    {Array}    args   The parameters to pass to the event
@@ -330,7 +330,12 @@ ClientBase.setMethod(function issueEvent(name, args, next) {
 
 		if (err) {
 			pledge.reject(err);
-			return next(err);
+
+			if (next) {
+				next(err);
+			}
+
+			return;
 		}
 
 		if (result !== false) {

package/lib/init/alchemy.js

@@ -9,7 +9,8 @@ var shared_objects = {},
     parseArgs      = require('minimist'),
     libpath        = require('path'),
     colors         = require('ansi-256-colors'),
-    fs             = require('fs');
+    fs             = require('fs'),
+    os             = require('os');
 
 /**
  * The Alchemy class
@@ -60,6 +61,9 @@ global.Alchemy = Function.inherits('Informer', 'Alchemy', function Alchemy() {
 	// Link to failed modules
 	this.modules_error = useErrors;
 
+	// How many CPUs are available?
+	this.cpu_core_count = os.cpus().length;
+
 	// Try getting the app package.json file
 	try {
 		package_json = require(libpath.resolve(PATH_ROOT, 'package.json'));
@@ -86,6 +90,9 @@ global.Alchemy = Function.inherits('Informer', 'Alchemy', function Alchemy() {
 	// All caches
 	this.caches = {};
 
+	// Extra toobusy checks
+	this.extra_toobusy_checks = [];
+
 	// Also store the version in the process versions object
 	process.versions.alchemy = this.version;
 
@@ -214,12 +221,142 @@ Alchemy.setProperty(function environment() {
 	return alchemy.settings.environment;
 });
 
+/**
+ * Get the current lag in ms
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @return   {Number}
+ */
+Alchemy.setMethod(function lagInMs() {
+	return this.toobusy.lag();
+});
+
+/**
+ * Get the system load as percentage points
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @return   {Number}
+ */
+Alchemy.setMethod(function systemLoad() {
+
+	let load_average = os.loadavg();
+
+	const percentage = ~~((load_average[0] / this.cpu_core_count) * 100);
+
+	return percentage;
+});
+
+/**
+ * Register an extra toobusy check method.
+ * These will be checked after event loop lag & system load are deemed OK.
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.2
+ * @version  1.3.2
+ */
+Alchemy.setMethod(function addToobusyCheck(fnc) {
+	this.extra_toobusy_checks.push(fnc);
+});
+
+/**
+ * Is the server currently too busy, overloaded in some way?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.2
+ *
+ * @return   {Boolean}
+ */
+Alchemy.setMethod(function isTooBusy() {
+
+	// First check if it's too busy because of event loop lag
+	if (this.toobusy()) {
+		return true;
+	}
+
+	if (this.settings.max_system_load > 0) {
+		// Then check the load average
+		if (this.systemLoad() > this.settings.max_system_load) {
+			return true;
+		}
+	}
+
+	if (this.extra_toobusy_checks.length > 0) {
+
+		for (let fnc of this.extra_toobusy_checks) {
+			try {
+				if (fnc()) {
+					return true;
+				}
+			} catch (err) {
+				alchemy.distinctProblem('error-extra-toobusy-check', 'Extra toobusy check failed', {error: err});
+			}
+		}
+	}
+
+	return false;
+});
+
+/**
+ * Is the server too busy for requests?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.1
+ *
+ * @return   {Boolean}
+ */
+Alchemy.setMethod(function isTooBusyForRequests() {
+
+	// If a queue already exists, the server's lag might be quite good
+	// BECAUSE requests are being queued.
+	if (Classes.Alchemy.Conduit.Postponement.queue_length > 5) {
+		return true;
+	}
+
+	return this.isTooBusy();
+});
+
+/**
+ * Is the server too busy for AJAX too?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.1
+ * @version  1.3.2
+ *
+ * @return   {Boolean}
+ */
+Alchemy.setMethod(function isTooBusyForAjax() {
+
+	if (!this.isTooBusyForRequests()) {
+		return false;
+	}
+
+	let lag = this.lagInMs();
+
+	let max_event_loop_lag = alchemy.settings.max_event_loop_lag || alchemy.settings.toobusy;
+
+	if (max_event_loop_lag) {
+		if (lag > (max_event_loop_lag * 3)) {
+			return true;
+		}
+	}
+
+	return false;
+});
+
 /**
  * Start janeway
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.5.0
- * @version  1.2.7
+ * @version  1.3.1
  *
  * @param    {Object}   options
  */
@@ -301,6 +438,17 @@ Alchemy.setMethod(function startJaneway(options) {
 		this.Janeway.session_menu = session_menu;
 	}
 
+	if (this.settings.lag_menu) {
+		let lag_menu = this.Janeway.addIndicator('0 ms');
+
+		setInterval(() => {
+			lag_menu.setIcon(this.lagInMs() + ' ms');
+			this.Janeway.redraw();
+		}, 900).unref();
+
+		this.Janeway.lag_menu = lag_menu;
+	}
+
 });
 
 /**

package/lib/init/functions.js

@@ -1344,24 +1344,47 @@ Alchemy.setMethod(function exposeStatic(name, value) {
 /**
  * Expose the default static variables
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.0
- * @version  1.2.1
+ * @version  1.3.1
  */
 Alchemy.setMethod(function exposeDefaultStaticVariables() {
 
-	let model_info = {},
+	let model_info = [],
+	    model_code = '',
 	    hawkejs = alchemy.hawkejs,
 	    models = Model.getAllChildren(),
+		info,
 	    i;
 
 	for (i = 0; i < models.length; i++) {
-		model_info[models[i].model_name] = models[i].getClientConfig();
+		info = models[i].getClientConfig();
+		model_info.push(info);
+	}
+
+	// Sort the models by their ancestor count
+	model_info.sortByPath(1, 'ancestors');
+
+	model_code = `function inheritModel(parent, child) {
+		return Classes.Hawkejs.Model.getClass(child, true, parent);
+	}\n`;
+
+	for (let info of model_info) {
+		model_code += 'inheritModel(' + JSON.stringify(info.parent) + ', ' + JSON.stringify(info.name) + ')\n';
 	}
 
 	// Expose the model configuration
 	hawkejs.exposeStatic('model_info', model_info);
 
+	Blast.require('client_models', {
+		after    : 'helper_model/model',
+		resolver : async function getExportedFunction() {
+			return model_code;
+		},
+		client : true,
+		server : false,
+	});
+
 	this.exposeRouteData();
 
 	// Expose breadcrumb info
@@ -1377,6 +1400,9 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 		hawkejs.exposeStatic('enable_websockets', true);
 	}
 
+	// Expose the layout settings
+	hawkejs.exposeStatic('alchemy_layout', alchemy.settings.layout);
+
 	let app_version = alchemy.package.version;
 
 	// The current app version

package/lib/init/requirements.js

@@ -57,9 +57,11 @@ alchemy.hawkejs = Classes.Hawkejs.Hawkejs.getInstance();
  */
 alchemy.toobusy = alchemy.use('toobusy-js', 'toobusy');
 
+let max_event_loop_lag = alchemy.settings.max_event_loop_lag || alchemy.settings.toobusy;
+
 // If the config is a number, use that as the lag threshold
-if (typeof alchemy.settings.toobusy === 'number') {
-	alchemy.toobusy.maxLag(alchemy.settings.toobusy);
+if (typeof max_event_loop_lag === 'number') {
+	alchemy.toobusy.maxLag(max_event_loop_lag);
 }
 
 /**

package/lib/stages.js

@@ -13,11 +13,12 @@
  * @since       0.0.1
  * @version     1.1.0
  */
-var path       = alchemy.modules.path,
+let path       = alchemy.modules.path,
     settings   = alchemy.settings,
     http       = alchemy.modules.http,
     hawkejs    = alchemy.hawkejs,
-    fs         = alchemy.use('fs');
+    fs         = alchemy.use('fs'),
+    total_http_requests = 0;
 
 if (alchemy.settings.debug) {
 	alchemy.sputnik.on('launching', function onLaunch(stage) {
@@ -38,13 +39,26 @@ if (alchemy.settings.debug) {
 	});
 }
 
+/**
+ * Add a getter for the total amount of http requests
+ *
+ * @author    Jelle De Loecker   <jelle@elevenways.be>
+ * @since     1.3.1
+ * @version   1.3.1
+ *
+ * @type      {Number}
+ */
+Alchemy.setProperty(function http_request_counter() {
+	return total_http_requests;
+});
+
 /**
  * The "http" stage:
  * Create the server and listen to requests
  *
  * @author        Jelle De Loecker   <jelle@develry.be>
  * @since         0.0.1
- * @version       1.1.0
+ * @version       1.3.1
  */
 alchemy.sputnik.add(function http() {
 
@@ -54,6 +68,7 @@ alchemy.sputnik.add(function http() {
 	// Listen for requests
 	alchemy.server.on('request', function onRequest(request, response) {
 		Router.resolve(request, response);
+		total_http_requests++;
 	});
 });
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.3.0",
+	"version": "1.3.2",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -22,7 +22,7 @@
 		"chokidar"         : "~3.5.3",
 		"formidable"       : "~2.0.1",
 		"graceful-fs"      : "~4.2.9",
-		"hawkejs"          : "~2.2.23",
+		"hawkejs"          : "~2.3.2",
 		"jsondiffpatch"    : "~0.4.1",
 		"mime"             : "~3.0.0",
 		"minimist"         : "~1.2.5",
@@ -31,7 +31,7 @@
 		"mongodb"          : "~3.6.6",
 		"ncp"              : "~2.0.0",
 		"postcss"          : "~8.4.6",
-		"protoblast"       : "~0.7.27",
+		"protoblast"       : "~0.8.2",
 		"semver"           : "~7.3.5",
 		"socket.io"        : "~2.4.0",
 		"@11ways/socket.io-stream" : "~0.9.2",
@@ -45,7 +45,7 @@
 		"index.js"
 	],
 	"optionalDependencies": {
-		"janeway"          : "~0.3.6",
+		"janeway"          : "~0.4.0",
 		"less"             : "~4.1.1",
 		"sass"             : "~1.53.0",
 		"sass-embedded"    : "~1.53.0",