alchemymvc 1.4.0 → 1.4.1

package/lib/class/sitemap.js

@@ -353,7 +353,7 @@ Sitemap.setMethod(function addRouteWithParameters(route, config, parameters, for
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.4
- * @version  1.3.6
+ * @version  1.4.1
  *
  * @param    {string}   prefix
  *
@@ -378,7 +378,7 @@ Sitemap.setMethod(function getXmlBuilder(prefix) {
 		}
 
 		for (let info of category.pages) {
-			let url = urlset.ele(url);
+			let url = urlset.ele('url');
 
 			url.ele('loc').txt(''+info.url);
 

package/lib/core/alchemy.js

@@ -1,9 +1,10 @@
-let shared_objects = {},
-    plugModules    = null,
-    usedModules    = {},
-    useErrors      = {},
-    usePaths       = {},
-    ac_entries     = {},
+let shared_objects   = {},
+    plugModules      = null,
+    extraModulePaths = [],
+    usedModules      = {},
+    useErrors        = {},
+    usePaths         = {},
+    ac_entries       = {},
     parseArgs      = require('minimist'),
     libpath        = require('path'),
     colors         = require('ansi-256-colors'),
@@ -649,7 +650,7 @@ Alchemy.setMethod(function executeSetting(path) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.4.0
- * @version  1.4.0
+ * @version  1.4.1
  */
 Alchemy.setMethod(function loadSettings() {
 
@@ -678,18 +679,26 @@ Alchemy.setMethod(function loadSettings() {
 	let local_path = libpath.resolve(PATH_ROOT, 'app', 'config', 'local'),
 	    local;
 
-	// Get the local settings
-	try {
-		local = require(local_path);
-	} catch(err) {
+	// Get the local settings (can be skipped for testing)
+	if (process.env.ALCHEMY_SKIP_LOCAL_CONFIG === '1') {
 		local = {};
-		this.setSetting('no_local_file', local_path);
+		this.setSetting('skipped_local_file', local_path);
+	} else {
+		try {
+			local = require(local_path);
+		} catch(err) {
+			local = {};
+			this.setSetting('no_local_file', local_path);
+		}
 	}
 
 	// Default to the environment Protoblast has found
 	if (!local.environment) {
 
-		if (process.env.ENV) {
+		// ALCHEMY_ENV takes precedence (useful for testing)
+		if (process.env.ALCHEMY_ENV) {
+			local.environment = process.env.ALCHEMY_ENV;
+		} else if (process.env.ENV) {
 			local.environment = Blast.environment;
 		} else {
 			local.environment = 'dev';
@@ -1044,6 +1053,32 @@ Alchemy.setMethod(function pathResolve(...path_to_dirs) {
 	}
 });
 
+/**
+ * Add an additional path for module resolution.
+ * This is useful for test scenarios where PATH_ROOT is a test_root
+ * but modules are installed in the parent plugin's node_modules.
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.1
+ * @version  1.4.1
+ *
+ * @param    {string}   path   The node_modules directory to search
+ */
+Alchemy.setMethod(function addModuleSearchPath(path) {
+
+	if (!path || typeof path !== 'string') {
+		return;
+	}
+
+	// Normalize the path
+	path = libpath.resolve(path);
+
+	// Don't add duplicates
+	if (!extraModulePaths.includes(path)) {
+		extraModulePaths.push(path);
+	}
+});
+
 /**
  * A wrapper function for requiring modules
  *
@@ -1142,7 +1177,7 @@ Alchemy.setMethod(function use(module_name, register_as, options) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.4.0
+ * @version  1.4.1
  *
  * @param    {string}   startPath    The path to originate the search from
  * @param    {string}   moduleName
@@ -1242,6 +1277,21 @@ Alchemy.setMethod(function searchModule(startPath, moduleName, recurse) {
 		}
 	}
 
+	// If still not found, check extra module paths registered via addModuleSearchPath()
+	// This is used by the TestHarness to add the plugin's node_modules directory
+	if (!module_path && extraModulePaths.length > 0) {
+		for (let extra_path of extraModulePaths) {
+			try {
+				module_path = require.resolve(libpath.resolve(extra_path, moduleName));
+				if (module_path) {
+					break;
+				}
+			} catch (err) {
+				// Not found in this path, continue
+			}
+		}
+	}
+
 	return module_path;
 });
 
@@ -1502,12 +1552,33 @@ Alchemy.setMethod(function castObjectId(obj) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.0.5
+ * @version  1.4.1
  *
  * @return   {boolean}
  */
 Alchemy.setMethod(function isStream(obj) {
-	return obj && (typeof obj._read == 'function' || typeof obj._write == 'function') && typeof obj.on === 'function';
+
+	if (!obj) {
+		return false;
+	}
+
+	// Check for Node.js Stream instance (includes HTTP responses)
+	// Classes.Stream.Stream is provided by Protoblast (see stream_ns.js)
+	if (obj instanceof Classes.Stream.Stream) {
+		return true;
+	}
+
+	// Fallback to duck-typing for internal stream methods
+	if ((typeof obj._read == 'function' || typeof obj._write == 'function') && typeof obj.on === 'function') {
+		return true;
+	}
+
+	// Additional duck-typing check for writable-like objects
+	if (typeof obj.write == 'function' && typeof obj.end == 'function' && typeof obj.on == 'function') {
+		return true;
+	}
+
+	return false;
 });
 
 /**
@@ -2099,7 +2170,7 @@ Alchemy.setMethod(function createExportStream(options) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
- * @version  1.0.5
+ * @version  1.4.1
  *
  * @param    {Stream}   output
  * @param    {Object}   options
@@ -2126,10 +2197,16 @@ Alchemy.setMethod(function exportToStream(output, options) {
 	}
 
 	let tasks = [],
+	    models = Model.getAllChildren(),
 	    i;
 
-	for (i = 0; i < Model.children.length; i++) {
-		let model = Model.children[i];
+	for (i = 0; i < models.length; i++) {
+		let model = models[i];
+
+		// Skip abstract models - they have no records
+		if (model.is_abstract) {
+			continue;
+		}
 
 		tasks.push(async function exportModel(next) {
 			await (new model).exportToStream(output);
@@ -2152,7 +2229,7 @@ Alchemy.setMethod(function exportToStream(output, options) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
- * @version  1.0.5
+ * @version  1.4.1
  *
  * @param    {Stream}   input
  * @param    {Object}   options
@@ -2178,155 +2255,26 @@ Alchemy.setMethod(function importFromStream(input, options) {
 		options = {};
 	}
 
-	let that = this,
-	    current_type = null,
-	    extra_stream,
-	    pledge = new Pledge(),
-	    stopped,
-	    paused,
-	    buffer,
-	    model,
-	    value,
-	    seen = 0,
-	    left,
-	    size,
-	    doc;
-
-	input.on('data', function onData(data) {
-
-		if (stopped) {
-			return;
-		}
-
-		if (buffer) {
-			buffer = Buffer.concat([buffer, data]);
-		} else {
-			buffer = data;
-		}
-
-		handleBuffer();
-	});
-
-	function handleBuffer() {
-
-		if (paused) {
-			return;
-		}
-
-		if (!current_type && buffer.length < 2) {
-			return;
-		}
-
-		if (!current_type) {
-			current_type = buffer.readUInt8(0);
-
-			if (current_type == 0x01) {
-				size = buffer.readUInt8(1);
-				buffer = buffer.slice(2);
-			} else if (current_type == 0x02 && buffer.length >= 5) {
-				size = buffer.readUInt32BE(1);
-				buffer = buffer.slice(5);
-			} else if (current_type == 0xFF) {
-				size = buffer.readUInt32BE(1);
-				buffer = buffer.slice(5);
-				seen = 0;
-
-				if (!doc) {
-					stopped = true;
-					pledge.reject(new Error('Found extra import data, but no active document'));
-				} else {
-					extra_stream = new require('stream').PassThrough();
-					doc.extraImportFromStream(extra_stream);
-				}
-			} else {
-				// Not enough data? Wait
-				current_type = null;
-				return;
-			}
-		}
-
-		handleRest();
-	}
-
-	function handleRest() {
-
-		if (current_type == 0xFF) {
-			left = size - seen;
-			value = buffer.slice(0, left);
-
-			seen += value.length;
-
-			if (value.length == buffer.length) {
-				buffer = null;
-			} else if (value.length < buffer.length) {
-				buffer = buffer.slice(left);
-			}
-
-			extra_stream.write(value);
-
-			if (value.length == left) {
-				extra_stream.end();
-				current_type = null;
-
-				if (buffer) {
-					handleBuffer();
-				}
-			}
-
-			return;
-		}
+	let parser = new Classes.Alchemy.ImportStreamParser(input, options);
 
-		if (buffer.length >= size) {
-			value = buffer.slice(0, size);
-			buffer = buffer.slice(size);
-		} else {
-			// Wait for next call
-			return;
+	// Model resolver for full database import:
+	// Switches between models as they appear in the stream
+	parser.setModelResolver(function resolveModel(model_name, current_model) {
+		// Reuse current model if name matches
+		if (current_model && current_model.model_name == model_name) {
+			return current_model;
 		}
 
-		if (current_type == 0x01) {
-			value = value.toString();
-
-			if (!model || model.model_name != value) {
-				model = Model.get(value);
-				doc = null;
-			}
-
-			if (!model) {
-				stopped = true;
-				return pledge.reject(new Error('Could not find Model "' + value + '"'));
-			}
+		let model = Model.get(model_name);
 
-			current_type = null;
-			size = 0;
-		} else if (current_type == 0x02) {
-			doc = model.createDocument();
-			input.pause();
-			paused = true;
-
-			doc.importFromBuffer(value).done(function done(err, result) {
-
-				if (err) {
-					stopped = true;
-					return pledge.reject(err);
-				}
-
-				current_type = null;
-				paused = false;
-				input.resume();
-
-				handleBuffer();
-			});
-
-			return;
+		if (!model) {
+			throw new Error('Could not find Model "' + model_name + '"');
 		}
 
-		if (buffer && buffer.length) {
-			handleBuffer();
-		}
-	}
+		return model;
+	});
 
-	return pledge;
+	return parser.parse();
 });
 
 /**

package/lib/core/alchemy_load_functions.js

@@ -538,9 +538,55 @@ Alchemy.setMethod(function addViewDirectory(dirPath, weight) {
  * This immediately executes the plugin's bootstrap.js file,
  * but the loading of the app tree happens later.
  *
+/**
+ * Handle a fatal plugin error
+ * Plugin errors are fatal - the server cannot start with a broken plugin
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.1
+ * @version  1.4.1
+ *
+ * @param    {string}   plugin_name   The name of the plugin
+ * @param    {string}   phase         Which phase failed (not_found, settings, bootstrap, start)
+ * @param    {Error}    err           The error that occurred
+ * @param    {Object}   extra_info    Additional info for error tracking
+ */
+Alchemy.setMethod(function handlePluginError(plugin_name, phase, err, extra_info) {
+
+	let message = 'Failed to load plugin "' + plugin_name + '"';
+
+	if (phase) {
+		message += ' during ' + phase + ' phase';
+	}
+
+	// Log the full error
+	log.error(message);
+	log.error('Error:', err.message);
+
+	if (err.stack) {
+		log.error('Stack:', err.stack);
+	}
+
+	// Register with error tracking services (Sentry, Glitchtip, etc.)
+	let error_info = Object.assign({
+		context : message,
+		plugin  : plugin_name,
+		phase   : phase,
+		fatal   : true,
+	}, extra_info);
+
+	this.registerError(err, error_info);
+
+	// Die with a clear message
+	die('Plugin "' + plugin_name + '" failed to load: ' + err.message, {level: 2});
+});
+
+/**
+ * Load a plugin
+ *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.4.0
+ * @version  1.4.1
  *
  * @param    {string}   name      The name of the plugin (which is its path)
  * @param    {Object}   options   Options to pass to the plugin
@@ -604,7 +650,10 @@ Alchemy.setMethod(function usePlugin(name, options) {
 	}
 
 	if (!is_dir) {
-		log.error('Could not find ' + JSON.stringify(name) + ' plugin directory');
+		let err = new Error('Plugin directory not found. Searched: ' + possible_paths.join(', '));
+		err.searched_paths = possible_paths;
+
+		alchemy.handlePluginError(name, 'not_found', err, {paths: possible_paths});
 		return false;
 	}
 
@@ -613,7 +662,15 @@ Alchemy.setMethod(function usePlugin(name, options) {
 	// Set the given options
 	alchemy.plugins[name] = instance;
 
-	instance.doPreload();
+	// doPreload can fail - if it does, the plugin will call die()
+	// but we still need to clean up if for some reason it doesn't
+	let result = instance.doPreload();
+
+	if (result === false) {
+		// Plugin failed to load - remove it from plugins
+		delete alchemy.plugins[name];
+		return false;
+	}
 
 	return instance;
 });
@@ -623,7 +680,7 @@ Alchemy.setMethod(function usePlugin(name, options) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.4.0
+ * @version  1.4.1
  *
  * @param    {string|Array}   names
  * @param    {boolean}        attempt_require
@@ -659,7 +716,9 @@ Alchemy.setMethod(function requirePlugin(names, attempt_require) {
 					if (!plugin_stage || plugin_stage.started) {
 						// If the plugin stage has already started,
 						// manually start this plugin now
-						alchemy.startPlugins(name);
+						if (temp.startPlugin) {
+							temp.startPlugin();
+						}
 					}
 					continue;
 				}

package/lib/core/base.js

@@ -391,7 +391,7 @@ Base.setStatic('starts_new_group', false);
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.8
- * @version  1.2.6
+ * @version  1.4.1
  *
  * @type     {Conduit}
  */
@@ -414,7 +414,7 @@ Base.setProperty(function conduit() {
 		result = renderer.root_renderer.conduit;
 	}
 
-	if (!conduit && renderer?.server_var) {
+	if (!result && renderer?.server_var) {
 		result = renderer.server_var('conduit');
 	}
 

package/lib/core/middleware.js

@@ -1207,18 +1207,44 @@ async function createAlchemyScss() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.4.0
- * @version  1.4.0
+ * @version  1.4.1
  *
  * @param    {string}   path_to_import      The requested path to import
  * @param    {string}   current_file_path   The path to the current file
  */
-async function customScssImporter(path_to_import, current_file_path) {
+/**
+ * Create a custom SCSS importer for a specific main file
+ *
+ * @param    {string}   main_file_path   The path to the main SCSS file being compiled
+ */
+function createScssImporter(main_file_path) {
+	return async function customScssImporter(path_to_import, current_file_path) {
+		return resolveScssImport(path_to_import, current_file_path, main_file_path);
+	};
+}
+
+/**
+ * Resolve an SCSS import path
+ *
+ * @param    {string}   path_to_import      The requested path to import
+ * @param    {string}   current_file_path   The path to the file doing the import (may be 'stdin')
+ * @param    {string}   main_file_path      The path to the main SCSS file being compiled
+ */
+async function resolveScssImport(path_to_import, current_file_path, main_file_path) {
 
 	// The alchemy.scss file is a special case
 	if (path_to_import === 'alchemy.scss' || path_to_import === 'alchemy') {
 		return createAlchemyScss();
 	}
 
+	// SASS may pass non-path values for current_file_path:
+	// - 'stdin' when processing the main file
+	// - A simple name like 'alchemy' when processing imports from {contents: ...} returns
+	// In these cases, fall back to main_file_path
+	if (main_file_path && (!current_file_path || !libpath.isAbsolute(current_file_path))) {
+		current_file_path = main_file_path;
+	}
+
 	// Get the current directory this SCSS file is in
 	let current_dir = libpath.dirname(current_file_path);
 
@@ -1271,7 +1297,7 @@ async function customScssImporter(path_to_import, current_file_path) {
 	// Look for files starting with an underscore
 	if (filename_to_import[0] != '_') {
 		let dashed_filename_to_import = '_' + filename_to_import;
-		return customScssImporter(libpath.join(dir_to_import, dashed_filename_to_import), current_file_path);
+		return resolveScssImport(libpath.join(dir_to_import, dashed_filename_to_import), current_file_path, main_file_path);
 	}
 
 	let extension = libpath.extname(filename_to_import);
@@ -1279,7 +1305,7 @@ async function customScssImporter(path_to_import, current_file_path) {
 	// If no extension was given, look for that too
 	if (!extension) {
 		filename_to_import += '.scss';
-		return customScssImporter(libpath.join(dir_to_import, filename_to_import), current_file_path);
+		return resolveScssImport(libpath.join(dir_to_import, filename_to_import), current_file_path, main_file_path);
 	}
 
 	if (path_to_import.startsWith('/overrides/')) {
@@ -1356,7 +1382,7 @@ Alchemy.setMethod(function getCompiledSassPath(sassPath, options, callback) {
 			silenceDeprecations: ['legacy-js-api'],
 			includePaths   : styleDirs.getSorted(),
 			functions      : custom_functions,
-			importer       : customScssImporter,
+			importer       : createScssImporter(sassPath),
 			logger         : {
 				warn  : logSassWarning,
 				debug : logSassDebug,

package/lib/core/setting.js

@@ -8,7 +8,7 @@ const VALUE = Symbol('value');
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.4.0
- * @version  1.4.0
+ * @version  1.4.1
  *
  * @param    {string}   name     The name of the setting in its group
  * @param    {Object}   config   The settings of this definition
@@ -32,7 +32,7 @@ const Base = Function.inherits('Alchemy.Base', 'Alchemy.Setting', function Base(
 	this.view_permission = config?.view_permission;
 
 	// Does this setting require any permission to edit?
-	this.edit_persmission = config?.edit_persmission;
+	this.edit_permission = config?.edit_permission;
 });
 
 /**
@@ -317,7 +317,7 @@ Definition.setMethod(function toJSON() {
 		show_description   : this.show_description,
 		target             : this.target,
 		view_permission    : this.view_permission,
-		edit_persmission   : this.edit_persmission,
+		edit_permission   : this.edit_permission,
 		requires_restart   : this.requires_restart,
 		locked             : this.locked,
 	};
@@ -366,7 +366,7 @@ Definition.setMethod(function getEditorConfiguration(root_value, editor_context)
 		result.description = this.description;
 	}
 
-	if (this.edit_persmission && editor_context && !editor_context.hasPermission(this.edit_persmission)) {
+	if (this.edit_permission && editor_context && !editor_context.hasPermission(this.edit_permission)) {
 		result.locked = true;
 	}
 
@@ -413,7 +413,7 @@ Definition.setMethod(function canBeEditedBy(permission_context) {
 	}
 
 	// If no edit permission is required, it can be edited
-	if (!this.edit_persmission) {
+	if (!this.edit_permission) {
 		return true;
 	}
 
@@ -422,7 +422,7 @@ Definition.setMethod(function canBeEditedBy(permission_context) {
 		return false;
 	}
 
-	return permission_context.hasPermission(this.edit_persmission);
+	return permission_context.hasPermission(this.edit_permission);
 });
 
 /**
@@ -539,7 +539,7 @@ Group.setMethod(function toDry() {
 		setting_id       : this.setting_id,
 		description      : this.description,
 		view_permission  : this.view_permission,
-		edit_persmission : this.edit_persmission,
+		edit_permission : this.edit_permission,
 	};
 
 	let children = [...this.children.values()];
@@ -565,7 +565,7 @@ Group.setMethod(function toEnumEntry() {
 		setting_id       : this.setting_id,
 		description      : this.description,
 		view_permission  : this.view_permission,
-		edit_persmission : this.edit_persmission,
+		edit_permission : this.edit_permission,
 		is_group         : true,
 	};
 });
@@ -868,7 +868,10 @@ Group.setMethod(function assign(target, values, default_only, do_actions = true)
 
 		// Make sure it's correct
 		if (group) {
-			if (!target[key] || typeof target[key] !== 'object') {
+			// We need a GroupValue. If target[key] doesn't exist, isn't an object,
+			// or is a non-group Value (e.g., SettingValue from config), generate a new one.
+			// This handles the case where config sets `key: null` before bootstrap creates the group.
+			if (!target[key] || typeof target[key] !== 'object' || (target[key] instanceof Value && !target[key].is_group)) {
 				target[key] = group.generateValue();
 			}
 

package/lib/scripts/create_constants.js

@@ -115,5 +115,9 @@ DEFINE('die', function die(...args) {
 	// (but blessed can't revert to original state without segfaulting)
 	alchemy.Janeway.print(alchemy.SEVERE, args, {level: 2});
 
-	process.exit();
+	// Give logs time to flush before exiting
+	Blast.sleepSync(1000);
+
+	// Exit with error code 1 to indicate failure
+	process.exit(1);
 });

package/lib/stages/00-load_core.js

@@ -341,11 +341,17 @@ const app_bootstrap = load_core.createStage('app_bootstrap', () => {
 	try {
 		alchemy.useOnce(libpath.resolve(PATH_ROOT, 'app', 'config', 'bootstrap'));
 	} catch (err) {
-		if (err.message.indexOf('Cannot find') === -1) {
+
+		// Check if this is a "file not found" error (optional file)
+		let is_not_found = err.code === 'ENOENT' || err.message.indexOf('Cannot find') > -1;
+
+		if (is_not_found) {
+			// Bootstrap file is optional - just log a warning
 			alchemy.printLog(alchemy.WARNING, 'Could not load app bootstrap file');
-			throw err;
 		} else {
+			// Actual error in the bootstrap file - log and throw
 			alchemy.printLog(alchemy.SEVERE, 'Could not load config bootstrap file', {err: err});
+			throw err;
 		}
 	}
 });