alchemymvc 1.4.3 → 1.4.4

package/lib/app/datasource/mongo_datasource.js

@@ -722,64 +722,87 @@ Mongo.setMethod(function _remove(context) {
  */
 Mongo.setMethod(function _ensureIndex(model, index, callback) {
 
-	this.collection(model.table, async function gotCollection(err, collection) {
+	// `collection()` returns a promise since 1.4 (its callback form was removed),
+	// so this must await it - the old callback form silently never fired, leaving
+	// indexes added via `addIndex` uncreated.
+	let pledge = Swift.waterfall(
+		this.collection(model.table),
+		async (collection) => {
 
-		if (err != null) {
-			return callback(err);
-		}
+			let options = {
+				name   : index.options.name,
+				unique : index.options.unique ? true : false,
+				sparse : index.options.sparse ? true : false,
+			};
 
-		let options = {
-			name   : index.options.name,
-			unique : index.options.unique ? true : false,
-			sparse : index.options.sparse ? true : false,
-		};
+			let index_specs;
 
-		let index_specs;
+			// Hack in the text indexes
+			if (options.name == 'text') {
+				index_specs = {};
 
-		// Hack in the text indexes
-		if (options.name == 'text') {
-			let key;
+				for (let key in index.fields) {
+					index_specs[key] = 'text';
+				}
+			} else {
+				index_specs = index.fields;
+			}
 
-			index_specs = {};
+			// Reconcile any conflicting index to the schema's definition. A single
+			// drop can expose a second conflict (the wanted key may already exist
+			// under a different name), and concurrent boot-time ensures can drop an
+			// index from under us - so loop, dropping the conflicting index each
+			// round, until the create succeeds. Bounded, so a genuine problem still
+			// surfaces instead of spinning.
+			let attempts = 0;
 
-			for (key in index.fields) {
-				index_specs[key] = 'text';
-			}
-		} else {
-			index_specs = index.fields;
-		}
+			while (true) {
 
-		try {
-			await collection.createIndex(index_specs, options);
-		} catch (err) {
+				try {
+					await collection.createIndex(index_specs, options);
+					return;
+				} catch (err) {
 
-			// Check for IndexOptionsConflict
-			if (err.code === 85) {
-				let index_to_drop;
+					// 85 = IndexOptionsConflict (our key held under a different name),
+					// 86 = IndexKeySpecsConflict (our name held by a different key).
+					if ((err.code !== 85 && err.code !== 86) || attempts >= 5) {
+						throw err;
+					}
 
-				if (err.message.includes('already exists with a different name:')) {
-					index_to_drop = err.message.after('different name:').trim();
-				}
+					attempts++;
 
-				if (!index_to_drop) {
-					index_to_drop = options.name;
-				}
+					// Find the conflicting index(es) by inspecting the collection -
+					// the one holding our name, or one holding our exact key - rather
+					// than parsing the version-specific error message.
+					let specs_json = JSON.stringify(index_specs),
+					    dropped = false;
 
-				try {
+					for (let existing of await collection.indexes()) {
 
-					// Index already exists, drop it
-					await collection.dropIndex(index_to_drop);
+						if (existing.name === '_id_') {
+							continue;
+						}
 
-					// Try again
-					await collection.createIndex(index_specs, options);
-				} catch (second_err) {
-					return callback(second_err);
+						if (existing.name === options.name || JSON.stringify(existing.key) === specs_json) {
+							try {
+								await collection.dropIndex(existing.name);
+								dropped = true;
+							} catch (drop_err) {
+								// Already gone (a concurrent ensure dropped it).
+							}
+						}
+					}
+
+					// Nothing identifiable to drop: surface the error, don't spin.
+					if (!dropped) {
+						throw err;
+					}
 				}
-			} else {
-				return callback(err);
 			}
 		}
+	);
 
-		callback();
-	});
+	pledge.done(callback);
+
+	return pledge;
 });

package/lib/app/helper_datasource/remote_datasource.js

@@ -81,7 +81,7 @@ Remote.setMethod(async function doServerCommand(action, model, data, callback) {
 	let fetch_options = {
 		post        : data,
 		headers     : {'content-type': 'application/json-dry'},
-		max_timeout : this.options.max_timeout ?? 3500 // Configurable timeout, default 3.5s
+		max_timeout : this.options.max_timeout ?? 15000 // Configurable timeout, default 15s
 	};
 
 	alchemy.fetch(route_name, fetch_options, function gotResult(err, result) {

package/lib/app/helper_model/document.js

@@ -1478,12 +1478,45 @@ Document.setMethod(function hasFieldValue(name) {
 	return Object.hasProperty(this.$main, name);
 });
 
+/**
+ * Compare two field values, treating them as equal when their datasource
+ * (stored) form matches.
+ *
+ * `hasChanged()` compares the live, normalized field value (a cast object such
+ * as a TagTree, an ObjectId instance, ...) against the original record, which
+ * holds the raw stored form. Without this, a normalized value always looked
+ * different from its own unchanged stored counterpart, so such fields reported
+ * a change on every load. If both sides serialize to the same datasource value,
+ * saving either would write identical data, so the field has not changed.
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.4
+ * @version  1.4.4
+ *
+ * @param    {Mixed}   a
+ * @param    {Mixed}   b
+ *
+ * @return   {boolean}
+ */
+Document.setMethod(function alikeWhenStored(a, b) {
+
+	if (Object.alike(a, b)) {
+		return true;
+	}
+
+	try {
+		return Object.alike(JSON.clone(a, 'toDatasource'), JSON.clone(b, 'toDatasource'));
+	} catch (err) {
+		return false;
+	}
+});
+
 /**
  * Has this document changed since it was created?
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
- * @version  1.3.0
+ * @version  1.4.4
  *
  * @param    {string}   name   The optional field name
  *
@@ -1505,27 +1538,47 @@ Document.setMethod(function hasChanged(name) {
 
 	let result;
 
+	// Fields excluded from change-detection (computed fields, or `track_changes:
+	// false`) never count as changed and are never compared. The `$model` getter
+	// throws for an unresolvable model (a detached document, or a client document
+	// whose model is not registered), so guard against that and compare every
+	// field when no schema is available.
+	let untracked;
+	try {
+		let schema = this.$model && this.$model.schema;
+		untracked = schema ? schema.getUntrackedFieldNames() : null;
+	} catch (err) {
+		untracked = null;
+	}
+
 	// If we only want to check a single field
 	if (name) {
 		let current_value,
 		    old_value;
-		
-		if (name.includes('.')) {
-			current_value = Object.path(this, name);
-			old_value = Object.path(this.$attributes.original_record, name);
+
+		if (untracked && untracked.has(name)) {
+			result = false;
 		} else {
-			current_value = this[name];
-			old_value = this.$attributes.original_record[name];
-		}
 
-		result = !Object.alike(old_value, current_value);
+			if (name.includes('.')) {
+				current_value = Object.path(this, name);
+				old_value = Object.path(this.$attributes.original_record, name);
+			} else {
+				current_value = this[name];
+				old_value = this.$attributes.original_record[name];
+			}
+
+			result = !this.alikeWhenStored(old_value, current_value);
+		}
 	} else {
 
 		let key;
 
 		for (key in this.$attributes.original_record) {
-			if (!Object.alike(this.$attributes.original_record[key], this[key])) {
-				// @TODO: some special fields always end up being different
+			if (untracked && untracked.has(key)) {
+				continue;
+			}
+			if (!this.alikeWhenStored(this.$attributes.original_record[key], this[key])) {
 				result = true;
 				break;
 			}
@@ -1533,7 +1586,10 @@ Document.setMethod(function hasChanged(name) {
 
 		if (!result) {
 			for (key in this.$main) {
-				if (!Object.alike(this.$main[key], this.$attributes.original_record[key])) {
+				if (untracked && untracked.has(key)) {
+					continue;
+				}
+				if (!this.alikeWhenStored(this.$main[key], this.$attributes.original_record[key])) {
 					result = true;
 					break;
 				}

package/lib/class/schema_client.js

@@ -862,6 +862,10 @@ Schema.setMethod(function addField(name, type, options) {
 
 	this.set(name, field);
 
+	// A new field can change which fields are excluded from change-detection, so
+	// drop the cached set (rebuilt lazily by getUntrackedFieldNames).
+	this.untracked_field_names = null;
+
 	if (options.rules) {
 		let rules = Array.cast(options.rules),
 		    i;
@@ -1074,6 +1078,50 @@ Schema.setMethod(function getFieldNames() {
 	return Object.keys(this.dict);
 });
 
+/**
+ * The set of field names excluded from change-detection, computed once and
+ * cached. A field is excluded when `options.track_changes === false`, or - when
+ * `track_changes` is unset - when it is a computed field (`is_computed`), since
+ * its stored value is regenerated from its inputs and so is never independent
+ * state worth (deep-)comparing in `Document#hasChanged()`. Lazily computed and
+ * cached; `addField` clears the cache, so a later field addition is reflected.
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.4
+ * @version  1.4.4
+ *
+ * @return   {Set<string>}
+ */
+Schema.setMethod(function getUntrackedFieldNames() {
+
+	if (this.untracked_field_names) {
+		return this.untracked_field_names;
+	}
+
+	let names = new Set();
+
+	for (let name of this.getFieldNames()) {
+
+		let field = this.getField(name);
+
+		if (!field || !field.options) {
+			continue;
+		}
+
+		let skip = (field.options.track_changes != null)
+			? (field.options.track_changes === false)
+			: !!field.options.is_computed;
+
+		if (skip) {
+			names.add(name);
+		}
+	}
+
+	this.untracked_field_names = names;
+
+	return names;
+});
+
 /**
  * Add an index
  *

package/lib/core/alchemy.js

@@ -2439,6 +2439,36 @@ Alchemy.setMethod(function start(options, callback) {
 	// Indicate the server is starting
 	starting = true;
 
+	// `--migrate`: apply pending migrations (app/migrations/) and exit, without
+	// starting the HTTP server - so it can run alongside a live instance.
+	if (this.argv.migrate) {
+
+		STAGES.afterStages('settings', async () => {
+
+			let code = 0;
+
+			try {
+				await Classes.Alchemy.Migration.start();
+			} catch (err) {
+				log.error('Migration run failed:', err);
+				code = 1;
+			}
+
+			process.exit(code);
+		});
+
+		STAGES.launch([
+			'load_app',
+			'datasource',
+			'tasks',
+			'settings',
+		]);
+
+		Blast.doLoaded();
+
+		return this.ready(callback);
+	}
+
 	// Start the stages
 	STAGES.launch([
 		'load_app',

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.4.3",
+	"version": "1.4.4",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",