alchemymvc 1.2.8 → 1.3.1

package/lib/init/functions.js

@@ -11,8 +11,9 @@ var mkdirp       = alchemy.use('mkdirp'),
     timers       = {},
     lpQueue      = 0,
     moduledirs,
-    spawnQueue,
-    Magic;
+    spawnQueue;
+
+const HAS_EXPOSED = Symbol('has_exposed');
 
 // Create a queue for functions opening files
 spawnQueue = Function.createQueue();
@@ -519,25 +520,22 @@ alchemy.ObjectId = mongo.ObjectID;
 
 /**
  * Get mimetype info of a file
+ * 
+ * @deprecated Use Classes.Alchemy.Inode.File.getMimetype(path)
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  0.4.0
+ * @version  1.3.0
  *
- * @param    {String}   filePath   A path to the file
+ * @param    {String}   filepath   A path to the file
  * @param    {Function} callback
+ *
+ * @return   {Pledge<String>}
  */
-Alchemy.setMethod(function getMimetype(filePath, callback) {
-
-	var magic,
-	    mmm = alchemy.use('mmmagic');
-
-	if (!mmm) {
-		return callback(new Error('The mmmagic module is not available'));
-	}
-
-	magic = new mmm.Magic(mmm.MAGIC_MIME_TYPE);
-	magic.detectFile(filePath, callback);
+Alchemy.setMethod(function getMimetype(filepath, callback) {
+	const pledge = Classes.Alchemy.Inode.File.getMimetype(filepath);
+	pledge.done(callback);
+	return pledge;
 });
 
 /**
@@ -687,9 +685,9 @@ Alchemy.setMethod(function getMedhash(file_path, options) {
 /**
  * Hash the given file_path using the given hash
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.0.7
- * @version  1.0.7
+ * @version  1.3.0
  *
  * @param    {String}   file_path
  * @param    {Object}   options
@@ -698,7 +696,7 @@ Alchemy.setMethod(function hashFile(file_path, options) {
 
 	var stream_options = {},
 	    digest_type,
-	    type;
+	    hash_algorithm;
 
 	if (!options) {
 		options = {};
@@ -710,10 +708,10 @@ Alchemy.setMethod(function hashFile(file_path, options) {
 		};
 	}
 
-	type = options.type || 'sha1';
+	hash_algorithm = options.algorithm || options.type || alchemy.settings.file_hash_algorithm || 'sha1';
 	digest_type = options.digest_type || 'hex';
 
-	let checksum = crypto.createHash(type),
+	let checksum = crypto.createHash(hash_algorithm),
 	    pledge = new Pledge(),
 	    stream;
 
@@ -781,7 +779,7 @@ Alchemy.setMethod(function statPath(path, options) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  1.0.7
+ * @version  1.3.0
  *
  * @param    {String}   filePath   A path to the file
  * @param    {Object}   options
@@ -802,7 +800,7 @@ Alchemy.setMethod(function getFileInfo(filePath, options, callback) {
 
 	// Use sha1 as hashing default
 	if (typeof options.hash == 'undefined' || options.hash === true) {
-		options.hash = 'sha1';
+		options.hash = alchemy.settings.file_hash_algorithm || 'sha1';
 	}
 
 	// Get basic file information
@@ -1011,42 +1009,45 @@ Alchemy.setMethod(function request(url, options, callback) {
 });
 
 /**
- * Download a url to a temporary location
+ * Download a file
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
- * @since    0.1.0
- * @version  1.2.6
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
  *
- * @param    {String}   url       The url
- * @param    {Object}   options
- * @param    {Function} callback  Callback
+ * @param    {String}   url
+ *
+ * @return   {Pledge<File>}
  */
-Alchemy.setMethod(function downloadFile(url, options, callback) {
-
-	var filepath,
-	    options,
-	    name,
-	    file,
-	    res;
+Alchemy.setMethod(function download(url, options) {
 
-	if (typeof options === 'function') {
-		callback = options;
-		options = {};
-	} else if (!options && typeof options !== 'object') {
-		options = {};
-	}
-
-	if (typeof callback !== 'function') {
-		callback = Function.thrower;
-	}
+	const pledge = new Pledge();
 
 	// Get the file
-	Blast.fetch({url, get_stream: true}, function gotStream(err, res, output) {
+	Blast.fetch({url, get_stream: true}, async function gotStream(err, res, output) {
 
 		if (err) {
-			return callback(err);
+			return pledge.reject(err);
 		}
 
+		if (res.statusCode == 404) {
+			err = new Error('Path "' + url + '" does not exist');
+			err.number = 404;
+			return pledge.reject(err);
+		}
+
+		if (options?.type && res.headers['content-type']) {
+			if (res.headers['content-type'].indexOf(options.type) < 0) {
+
+				err = new Error('Received unexpected filetype');
+				err.number = 500;
+
+				return pledge.reject(err);
+			}
+		}
+
+		let name;
+
 		if (res.headers['content-disposition']) {
 			let disposition = res.headers['content-disposition'],
 			    pieces = disposition.split(';'),
@@ -1075,44 +1076,60 @@ Alchemy.setMethod(function downloadFile(url, options, callback) {
 			}
 		}
 
-		// Construct a temporary file path
-		filepath = '/tmp/alchemy_' + Crypto.pseudoHex(8) + '_' + name;
-
-		// Open the temp file
-		file = fs.createWriteStream(filepath);
-
-		if (res.statusCode == 404) {
-			err = new Error('Path "' + url + '" does not exist');
-			err.number = 404;
-
-			return callback(err);
+		if (name.indexOf('/') > -1) {
+			name = name.replaceAll('/', '-');
 		}
 
-		if (options.type && res.headers['content-type']) {
-			if (res.headers['content-type'].indexOf(options.type) < 0) {
-
-				err = new Error('Received unexpected filetype');
-				err.number = 500;
-
-				return callback(err);
-			}
-		}
+		let temp_dir = await Blast.createTempDir({prefix: 'aldl'}),
+		    full_path = libpath.resolve(temp_dir, name);
+		
+		let write_stream = fs.createWriteStream(full_path);
 
 		if (output) {
 			// Pipe the response stream into the file
-			output.pipe(file);
+			output.pipe(write_stream);
 		} else {
-			file.end('');
+			write_stream.end('');
 		}
 
-		// @todo: maybe implement content-type for downloaded file, too?
-		// Because webservers can lie about filetypes
+		// Wait for it to finish writing to the temp file
+		write_stream.on('finish', async function writeFinished() {
 
-		// Close the file when finished and callback
-		file.on('finish', function writeFinished() {
-			callback(null, filepath, name);
+			try {
+				let file = await Classes.Alchemy.Inode.Inode.from(full_path);
+				pledge.resolve(file);
+			} catch (err) {
+				pledge.reject(err);
+			}
 		});
 	});
+
+	return pledge;
+});
+
+/**
+ * Download a url to a temporary location
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.0
+ * @version  1.3.0
+ * 
+ * @deprecated   Use `download` instead
+ *
+ * @param    {String}   url       The url
+ * @param    {Object}   options
+ * @param    {Function} callback  Callback
+ */
+Alchemy.setMethod(function downloadFile(url, options, callback) {
+
+	if (typeof options == 'function') {
+		callback = options;
+		options = null;
+	}
+
+	let pledge = this.download(url, options);
+	pledge.done(callback);
+	return pledge;
 });
 
 /**
@@ -1327,32 +1344,48 @@ 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);
 
-	// Expose router options
-	hawkejs.exposeStatic('router_options', Router.getOptions());
-
-	// Expose basic HTTP routes
-	hawkejs.exposeStatic('routes', Router.getRoutes());
+	Blast.require('client_models', {
+		after    : 'helper_model/model',
+		resolver : async function getExportedFunction() {
+			return model_code;
+		},
+		client : true,
+		server : false,
+	});
 
-	// Expose socket routes
-	hawkejs.exposeStatic('socket_routes', Router.getSocketRoutes());
+	this.exposeRouteData();
 
 	// Expose breadcrumb info
 	hawkejs.exposeStatic('breadcrumb_info', Router.getBreadcrumbInfo());
@@ -1367,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
@@ -1379,6 +1415,47 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 
 	// Emit as a global event so plugins can also expose their data
 	this.emit('generate_static_variables', hawkejs);
+
+	this[HAS_EXPOSED] = true;
+});
+
+/**
+ * Regenerate exposed route data
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+Alchemy.setMethod(function exposeRouteData() {
+
+	const hawkejs = alchemy.hawkejs;
+
+	// Expose router options
+	hawkejs.exposeStatic('router_options', Router.getOptions());
+
+	// Expose basic HTTP routes
+	hawkejs.exposeStatic('routes', Router.getRoutes());
+
+	// Expose socket routes
+	hawkejs.exposeStatic('socket_routes', Router.getSocketRoutes());
+});
+
+
+/**
+ * Flush the exposed route data
+ * (Will only regenerate if default static variables haven't been generated yet)
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+Alchemy.setMethod(function checkExposedRouteData() {
+
+	if (!this[HAS_EXPOSED]) {
+		return;
+	}
+
+	this.exposeRouteData();
 });
 
 /**

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.2.8",
+	"version": "1.3.1",
 	"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.18",
+		"hawkejs"          : "~2.3.1",
 		"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.24",
+		"protoblast"       : "~0.8.0",
 		"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",
@@ -56,9 +56,9 @@
 		"codecov"                 : "~3.8.1",
 		"istanbul-lib-instrument" : "~4.0.3",
 		"mocha"                   : "~8.3.2",
-		"mongo-unit"              : "~2.0.1",
+		"mongo-unit"              : "~3.2.0",
 		"nyc"                     : "^15.1.0",
-		"puppeteer"               : "~9.0.0",
+		"puppeteer"               : "~19.0.0",
 		"source-map"              : "~0.7.3"
 	},
 	"scripts": {