alchemymvc 1.2.8 → 1.3.0

package/lib/core/middleware.js

@@ -7,7 +7,7 @@ var publicDirs = alchemy.shared('public.directories', new Deck()),
     imageDirs  = alchemy.shared('images.directories', new Deck()),
     rootDirs   = alchemy.shared('root.directories', new Deck()),
     fontDirs   = alchemy.shared('font.directories', new Deck()),
-    assetMap   = alchemy.shared('files.assetMap'),
+    asset_cache= alchemy.getCache('files.assets'),
     fileCache  = alchemy.shared('files.fileCache'),
     minifyMap  = alchemy.shared('files.minifyMap'),
     Nodent     = alchemy.use('nodent-compiler'),
@@ -128,7 +128,7 @@ function getMiddlePaths(paths, ext, new_ext) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.2.7
+ * @version  1.3.0
  */
 Alchemy.setMethod(function styleMiddleware(req, res, nextMiddleware) {
 
@@ -145,10 +145,10 @@ Alchemy.setMethod(function styleMiddleware(req, res, nextMiddleware) {
 	path = url.path;
 
 	// If this file has already been found & compiled, serve it to the user
-	if (assetMap[path]) {
-		return req.conduit.serveFile(assetMap[path].path, {onError: function onError() {
+	if (asset_cache.has(path)) {
+		return req.conduit.serveFile(asset_cache.get(path).path, {onError: function onError() {
 			// Unset asset
-			assetMap[path] = null;
+			asset_cache.remove(path);
 			alchemy.styleMiddleware(req, res, nextMiddleware);
 		}});
 	}
@@ -246,17 +246,20 @@ Alchemy.setMethod(function styleMiddleware(req, res, nextMiddleware) {
 			return nextMiddleware();
 		}
 
-		return req.conduit.serveFile(compiled.path, {onError: function onError(err) {
-			if (fileCache[compiled.path]) {
-				fileCache[compiled.path] = null;
+		return req.conduit.serveFile(compiled.path, {
+			mimetype: 'text/css',
+			onError: function onError(err) {
+				if (fileCache[compiled.path]) {
+					fileCache[compiled.path] = null;
 
-				if (o_stats && fileCache[o_stats.path]) {
-					fileCache[o_stats.path] = null;
-				}
+					if (o_stats && fileCache[o_stats.path]) {
+						fileCache[o_stats.path] = null;
+					}
 
-				alchemy.styleMiddleware(req, res, nextMiddleware);
+					alchemy.styleMiddleware(req, res, nextMiddleware);
+				}
 			}
-		}});
+		});
 	});
 });
 
@@ -266,7 +269,7 @@ Alchemy.setMethod(function styleMiddleware(req, res, nextMiddleware) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.3.0
  */
 Alchemy.setMethod(function sourcemapMiddleware(req, res, nextMiddleware) {
 
@@ -297,7 +300,9 @@ Alchemy.setMethod(function sourcemapMiddleware(req, res, nextMiddleware) {
 			return nextMiddleware();
 		}
 
-		req.conduit.serveFile(stats.path);
+		req.conduit.serveFile(stats.path, {
+			mimetype: 'application/json',
+		});
 	});
 });
 
@@ -503,7 +508,7 @@ Alchemy.setMethod(function minifyScript(path, options, callback) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.0.4
+ * @version  1.3.0
  */
 Alchemy.setMethod(function scriptMiddleware(req, res, nextMiddleware) {
 
@@ -517,15 +522,15 @@ Alchemy.setMethod(function scriptMiddleware(req, res, nextMiddleware) {
 			return next();
 		}
 
-		if (assetMap[req.url]) {
-			source = assetMap[req.url];
+		if (asset_cache.has(req.url)) {
+			source = asset_cache.get(req.url);
 			return next();
 		}
 
 		alchemy.findAssetPath(req.middlePath, scriptDirs.getSorted(), function gotAssetPath(err, stats) {
 
 			// @todo: error stuff, 404
-			assetMap[req.url] = stats;
+			asset_cache.set(req.url, stats);
 			source = stats;
 
 			next();
@@ -566,22 +571,25 @@ Alchemy.setMethod(function scriptMiddleware(req, res, nextMiddleware) {
 			return nextMiddleware();
 		}
 
-		req.conduit.serveFile(source.path, {onError: function onError() {
-			// Unset asset
-			if (fileCache[req.url]) {
-				fileCache[req.url] = null;
-			}
+		req.conduit.serveFile(source.path, {
+			mimetype: 'text/javascript',
+			onError: function onError() {
+				// Unset asset
+				if (fileCache[req.url]) {
+					fileCache[req.url] = null;
+				}
 
-			if (assetMap[req.url]) {
-				assetMap[req.url] = null;
-			}
+				if (asset_cache.has(req.url)) {
+					asset_cache.remove(req.url);
+				}
 
-			if (source && minifyMap[source.path]) {
-				minifyMap[source.path] = null;
-			}
+				if (source && minifyMap[source.path]) {
+					minifyMap[source.path] = null;
+				}
 
-			alchemy.scriptMiddleware(req, res, nextMiddleware);
-		}});
+				alchemy.scriptMiddleware(req, res, nextMiddleware);
+			}
+		});
 	});
 });
 
@@ -622,15 +630,15 @@ Alchemy.setMethod(function assetInDirsMiddleware(req, res, directories, nextMidd
 
 	Function.series(function getPath(next) {
 
-		if (assetMap[req.url]) {
-			source = assetMap[req.url];
+		if (asset_cache.has(req.url)) {
+			source = asset_cache.get(req.url);
 			return next();
 		}
 
 		alchemy.findAssetPath(req.middlePath, directories, function gotAssetPath(err, stats) {
 
 			// @todo: error stuff, 404
-			assetMap[req.url] = stats;
+			asset_cache.set(req.url, stats);
 			source = stats;
 
 			next();
@@ -654,7 +662,7 @@ Alchemy.setMethod(function assetInDirsMiddleware(req, res, directories, nextMidd
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.3.0
  */
 Alchemy.setMethod(function rootMiddleware(req, res, nextMiddleware) {
 
@@ -663,8 +671,8 @@ Alchemy.setMethod(function rootMiddleware(req, res, nextMiddleware) {
 
 	Function.series(function getPath(next) {
 
-		if (assetMap[req.url]) {
-			source = assetMap[req.url];
+		if (asset_cache.has(req.url)) {
+			source = asset_cache.get(req.url);
 			cached = true;
 			return next();
 		}
@@ -672,7 +680,10 @@ Alchemy.setMethod(function rootMiddleware(req, res, nextMiddleware) {
 		alchemy.findAssetPath(req.middlePath, rootDirs.getSorted(), function gotAssetPath(err, stats) {
 
 			// @todo: error stuff, 404
-			assetMap[req.url] = stats;
+			if (stats?.path) {
+				asset_cache.set(req.url, stats);
+			}
+
 			source = stats;
 
 			next();
@@ -689,7 +700,7 @@ Alchemy.setMethod(function rootMiddleware(req, res, nextMiddleware) {
 			onError: function onError() {
 
 			if (cached) {
-				assetMap[req.url] = null;
+				asset_cache.remove(req.url);
 				alchemy.rootMiddleware(req, res, nextMiddleware);
 				return;
 			}
@@ -704,7 +715,7 @@ Alchemy.setMethod(function rootMiddleware(req, res, nextMiddleware) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.4
+ * @version  1.3.0
  *
  * @param    {String}     image_path
  * @param    {Function}   callback
@@ -723,8 +734,8 @@ Alchemy.setMethod(function findImagePath(image_path, callback) {
 
 		let id = 'image-' + image_path;
 
-		if (alchemy.settings.cache && assetMap[id]) {
-			pledge.resolve(assetMap[id].path);
+		if (alchemy.settings.cache && asset_cache.has(id)) {
+			pledge.resolve(asset_cache.get(id).path);
 		} else {
 
 			alchemy.findAssetPath(image_path, imageDirs.getSorted(), function gotImagePath(err, stats) {
@@ -732,7 +743,7 @@ Alchemy.setMethod(function findImagePath(image_path, callback) {
 				if (err) {
 					pledge.reject(err);
 				} else {
-					assetMap[id] = stats;
+					asset_cache.set(id, stats);
 					pledge.resolve(stats.path);
 				}
 			});
@@ -869,7 +880,7 @@ Alchemy.setMethod(function findAssetPath(assetFile, directories, callback) {
 	}, function lastly() {
 
 		// Return an empty object when nothing was found,
-		// so we'll cache that in the assetMap
+		// so we'll cache that in the asset_cache
 		// Otherwise it'll keep checking for every request
 		if (found == null) {
 			found = {};

package/lib/init/alchemy.js

@@ -92,6 +92,9 @@ global.Alchemy = Function.inherits('Informer', 'Alchemy', function Alchemy() {
 	// Also store the version of the app
 	process.versions.alchemy_app = this.package.version;
 
+	// Distinct problems
+	this.distinct_problems = new Map();
+
 	// Load the settings
 	this.loadSettings();
 
@@ -1113,7 +1116,7 @@ Alchemy.setMethod(function isStream(obj) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.0.4
+ * @version  1.3.0
  *
  * @param    {String}          name
  * @param    {Number|Object}   options
@@ -1144,12 +1147,11 @@ Alchemy.setMethod(function getCache(name, options) {
 	}
 
 	config = Object.assign({
+		name,
 		max_length : 5000,
 	}, options);
 
-	// @TODO: Fixed in 0.6.1
-	instance = new Blast.Classes.Develry.Cache();
-	Object.assign(instance, config);
+	instance = new Blast.Classes.Develry.Cache(config);
 
 	this.caches[name] = instance;
 
@@ -1161,16 +1163,17 @@ Alchemy.setMethod(function getCache(name, options) {
  *
  * @author    Jelle De Loecker   <jelle@elevenways.be>
  * @since     1.1.3
- * @version   1.1.3
+ * @version   1.3.0
  *
  * @param     {String}   href         The href or route name
  * @param     {Object}   parameters   Route parameters
+ * @param     {Object}   options
  *
  * @return    {String}
  */
-Alchemy.setMethod(function routeUrl(href, parameters) {
+Alchemy.setMethod(function routeUrl(href, parameters, options) {
 
-	let temp = Router.getUrl(href, parameters);
+	let temp = Router.getUrl(href, parameters, options);
 
 	if (temp && temp.href) {
 		temp = String(temp);
@@ -1382,7 +1385,7 @@ Alchemy.setMethod(function addAppcacheEntry(entry) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.2.7
+ * @version  1.3.0
  *
  * @param    {IncomingMessage}   req
  * @param    {OutgoingMessage}   res       Optional
@@ -1410,7 +1413,7 @@ Alchemy.setMethod(function parseRequestBody(req, res, callback) {
 
 		let form = new formidable.IncomingForm({
 			multiples     : true,
-			hashAlgorithm : 'md5',
+			hashAlgorithm : alchemy.settings.file_hash_algorithm || 'sha1',
 		});
 
 		form.parse(req, function parsedMultipart(err, form_fields, form_files) {

package/lib/init/constants.js

@@ -48,6 +48,17 @@ DEFINE('Blast', __Protoblast);
  */
 DEFINE('Classes', Blast.Classes);
 
+/**
+ * Available types
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ *
+ * @type     {Object}
+ */
+DEFINE('Types', Blast.Types);
+
 /**
  * Path to the directory of the server.js file
  *

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) {
+Alchemy.setMethod(function download(url, options) {
 
-	var filepath,
-	    options,
-	    name,
-	    file,
-	    res;
-
-	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;
 });
 
 /**
@@ -1345,14 +1362,7 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 	// 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());
-
-	// Expose socket routes
-	hawkejs.exposeStatic('socket_routes', Router.getSocketRoutes());
+	this.exposeRouteData();
 
 	// Expose breadcrumb info
 	hawkejs.exposeStatic('breadcrumb_info', Router.getBreadcrumbInfo());
@@ -1379,6 +1389,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/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.2.8",
+	"version": "1.3.0",
 	"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.2.23",
 		"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.7.27",
 		"semver"           : "~7.3.5",
 		"socket.io"        : "~2.4.0",
 		"@11ways/socket.io-stream" : "~0.9.2",
@@ -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": {