772 lines
21 KiB
JavaScript
772 lines
21 KiB
JavaScript
/**
|
|
* Module exports class Model
|
|
*/
|
|
module.exports = AbstractClass;
|
|
|
|
/**
|
|
* Module dependencies
|
|
*/
|
|
var util = require('util');
|
|
var validations = require('./validations.js');
|
|
var ValidationError = validations.ValidationError;
|
|
var List = require('./list.js');
|
|
require('./hooks.js');
|
|
require('./relations.js');
|
|
require('./include.js');
|
|
|
|
var BASE_TYPES = ['String', 'Boolean', 'Number', 'Date', 'Text'];
|
|
|
|
/**
|
|
* Model class - base class for all persist objects
|
|
* provides **common API** to access any database adapter.
|
|
* This class describes only abstract behavior layer, refer to `lib/adapters/*.js`
|
|
* to learn more about specific adapter implementations
|
|
*
|
|
* `AbstractClass` mixes `Validatable` and `Hookable` classes methods
|
|
*
|
|
* @constructor
|
|
* @param {Object} data - initial object data
|
|
*/
|
|
function AbstractClass(data) {
|
|
this._initProperties(data, true);
|
|
}
|
|
|
|
AbstractClass.prototype._initProperties = function (data, applySetters) {
|
|
var self = this;
|
|
var ctor = this.constructor;
|
|
var ds = ctor.schema.definitions[ctor.modelName];
|
|
var properties = ds.properties;
|
|
data = data || {};
|
|
|
|
Object.defineProperty(this, '__cachedRelations', {
|
|
writable: true,
|
|
enumerable: false,
|
|
configurable: true,
|
|
value: {}
|
|
});
|
|
|
|
Object.defineProperty(this, '__data', {
|
|
writable: true,
|
|
enumerable: false,
|
|
configurable: true,
|
|
value: {}
|
|
});
|
|
|
|
Object.defineProperty(this, '__dataWas', {
|
|
writable: true,
|
|
enumerable: false,
|
|
configurable: true,
|
|
value: {}
|
|
});
|
|
|
|
if (data['__cachedRelations']) {
|
|
this.__cachedRelations = data['__cachedRelations'];
|
|
}
|
|
|
|
for (var i in data) this.__data[i] = this.__dataWas[i] = data[i];
|
|
|
|
if (applySetters === true) {
|
|
Object.keys(data).forEach(function (attr) {
|
|
self[attr] = data[attr];
|
|
});
|
|
}
|
|
|
|
ctor.forEachProperty(function (attr) {
|
|
|
|
if ('undefined' === typeof self.__data[attr]) {
|
|
self.__data[attr] = self.__dataWas[attr] = getDefault(attr);
|
|
} else {
|
|
self.__dataWas[attr] = self.__data[attr];
|
|
}
|
|
|
|
});
|
|
|
|
ctor.forEachProperty(function (attr) {
|
|
|
|
var type = properties[attr].type;
|
|
|
|
if (BASE_TYPES.indexOf(type.name) === -1) {
|
|
if (typeof self.__data[attr] !== 'object' && self.__data[attr]) {
|
|
try {
|
|
self.__data[attr] = JSON.parse(self.__data[attr] + '');
|
|
} catch (e) {
|
|
self.__data[attr] = String(self.__data[attr]);
|
|
}
|
|
}
|
|
if (type.name === 'Array' || typeof type === 'object' && type.constructor.name === 'Array') {
|
|
self.__data[attr] = new List(self.__data[attr], type, self);
|
|
}
|
|
}
|
|
|
|
});
|
|
|
|
function getDefault(attr) {
|
|
var def = properties[attr]['default'];
|
|
if (isdef(def)) {
|
|
if (typeof def === 'function') {
|
|
return def();
|
|
} else {
|
|
return def;
|
|
}
|
|
} else {
|
|
return undefined;
|
|
}
|
|
}
|
|
|
|
this.trigger('initialize');
|
|
}
|
|
|
|
/**
|
|
* @param {String} prop - property name
|
|
* @param {Object} params - various property configuration
|
|
*/
|
|
AbstractClass.defineProperty = function (prop, params) {
|
|
this.schema.defineProperty(this.modelName, prop, params);
|
|
};
|
|
|
|
AbstractClass.whatTypeName = function (propName) {
|
|
var ds = this.schema.definitions[this.modelName];
|
|
return ds.properties[propName] && ds.properties[propName].type.name;
|
|
};
|
|
|
|
AbstractClass._forDB = function (data) {
|
|
var res = {};
|
|
Object.keys(data).forEach(function (propName) {
|
|
if (this.whatTypeName(propName) === 'JSON' || data[propName] instanceof Array) {
|
|
res[propName] = JSON.stringify(data[propName]);
|
|
} else {
|
|
res[propName] = data[propName];
|
|
}
|
|
}.bind(this));
|
|
return res;
|
|
};
|
|
|
|
AbstractClass.prototype.whatTypeName = function (propName) {
|
|
return this.constructor.whatTypeName(propName);
|
|
};
|
|
|
|
/**
|
|
* Create new instance of Model class, saved in database
|
|
*
|
|
* @param data [optional]
|
|
* @param callback(err, obj)
|
|
* callback called with arguments:
|
|
*
|
|
* - err (null or Error)
|
|
* - instance (null or Model)
|
|
*/
|
|
AbstractClass.create = function (data, callback) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
var Model = this;
|
|
var modelName = Model.modelName;
|
|
|
|
if (typeof data === 'function') {
|
|
callback = data;
|
|
data = {};
|
|
}
|
|
|
|
if (typeof callback !== 'function') {
|
|
callback = function () {};
|
|
}
|
|
|
|
if (!data) {
|
|
data = {};
|
|
}
|
|
|
|
if (data instanceof Array) {
|
|
var instances = [];
|
|
var errors = Array(data.length);
|
|
var gotError = false;
|
|
var wait = data.length;
|
|
if (wait === 0) callback(null, []);
|
|
|
|
var instances = [];
|
|
for (var i = 0; i < data.length; i += 1) {
|
|
(function(d, i) {
|
|
instances.push(Model.create(d, function(err, inst) {
|
|
if (err) {
|
|
errors[i] = err;
|
|
gotError = true;
|
|
}
|
|
modelCreated();
|
|
}));
|
|
})(data[i], i);
|
|
}
|
|
|
|
return instances;
|
|
|
|
function modelCreated() {
|
|
if (--wait === 0) {
|
|
callback(gotError ? errors : null, instances);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
var obj;
|
|
// if we come from save
|
|
if (data instanceof Model && !data.id) {
|
|
obj = data;
|
|
} else {
|
|
obj = new Model(data);
|
|
}
|
|
data = obj.toObject(true);
|
|
|
|
// validation required
|
|
obj.isValid(function(valid) {
|
|
if (valid) {
|
|
create();
|
|
} else {
|
|
callback(new ValidationError(obj), obj);
|
|
}
|
|
}, data);
|
|
|
|
function create() {
|
|
obj.trigger('create', function(createDone) {
|
|
obj.trigger('save', function(saveDone) {
|
|
|
|
this._adapter().create(modelName, this.constructor._forDB(data), function (err, id, rev) {
|
|
obj._initProperties(data, false);
|
|
if (id) {
|
|
obj.__data.id = id;
|
|
obj.__dataWas.id = id;
|
|
defineReadonlyProp(obj, 'id', id);
|
|
}
|
|
if (rev) {
|
|
obj._rev = rev
|
|
}
|
|
if (err) {
|
|
return callback(err, obj);
|
|
}
|
|
saveDone.call(obj, function () {
|
|
createDone.call(obj, function () {
|
|
callback(err, obj);
|
|
});
|
|
});
|
|
});
|
|
}, data);
|
|
}, data);
|
|
}
|
|
|
|
return obj;
|
|
};
|
|
|
|
function stillConnecting(schema, obj, args) {
|
|
if (schema.connected) return false;
|
|
if (schema.connecting) return true;
|
|
var method = args.callee;
|
|
schema.once('connected', function () {
|
|
method.apply(obj, [].slice.call(args));
|
|
});
|
|
schema.connect();
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* Update or insert
|
|
*/
|
|
AbstractClass.upsert = AbstractClass.updateOrCreate = function upsert(data, callback) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
var Model = this;
|
|
if (!data.id) return this.create(data, callback);
|
|
if (this.schema.adapter.updateOrCreate) {
|
|
var inst = new Model(data);
|
|
this.schema.adapter.updateOrCreate(Model.modelName, inst.toObject(), function (err, data) {
|
|
var obj;
|
|
if (data) {
|
|
inst._initProperties(data);
|
|
obj = inst;
|
|
} else {
|
|
obj = null;
|
|
}
|
|
callback(err, obj);
|
|
});
|
|
} else {
|
|
this.find(data.id, function (err, inst) {
|
|
if (err) return callback(err);
|
|
if (inst) {
|
|
inst.updateAttributes(data, callback);
|
|
} else {
|
|
var obj = new Model(data);
|
|
obj.save(data, callback);
|
|
}
|
|
});
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Find one record, same as `all`, limited by 1 and return object, not collection,
|
|
* if not found, create using data provided as second argument
|
|
*
|
|
* @param {Object} query - search conditions: {where: {test: 'me'}}.
|
|
* @param {Object} data - object to create.
|
|
* @param {Function} cb - callback called with (err, instance)
|
|
*/
|
|
AbstractClass.findOrCreate = function findOrCreate(query, data, callback) {
|
|
if (typeof query === 'undefined') {
|
|
query = {where: {}};
|
|
}
|
|
if (typeof data === 'function' || typeof data === 'undefined') {
|
|
callback = data;
|
|
data = query && query.where;
|
|
}
|
|
if (typeof callback === 'undefined') {
|
|
callback = function () {};
|
|
}
|
|
|
|
var t = this;
|
|
this.findOne(query, function (err, record) {
|
|
if (err) return callback(err);
|
|
if (record) return callback(null, record);
|
|
t.create(data, callback);
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Check whether object exitst in database
|
|
*
|
|
* @param {id} id - identifier of object (primary key value)
|
|
* @param {Function} cb - callbacl called with (err, exists: Bool)
|
|
*/
|
|
AbstractClass.exists = function exists(id, cb) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
if (id) {
|
|
this.schema.adapter.exists(this.modelName, id, cb);
|
|
} else {
|
|
cb(new Error('Model::exists requires positive id argument'));
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Find object by id
|
|
*
|
|
* @param {id} id - primary key value
|
|
* @param {Function} cb - callback called with (err, instance)
|
|
*/
|
|
AbstractClass.find = function find(id, cb) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
this.schema.adapter.find(this.modelName, id, function (err, data) {
|
|
var obj = null;
|
|
if (data) {
|
|
if (!data.id) {
|
|
data.id = id;
|
|
}
|
|
obj = new this();
|
|
obj._initProperties(data, false);
|
|
}
|
|
cb(err, obj);
|
|
}.bind(this));
|
|
};
|
|
|
|
/**
|
|
* Find all instances of Model, matched by query
|
|
* make sure you have marked as `index: true` fields for filter or sort
|
|
*
|
|
* @param {Object} params (optional)
|
|
*
|
|
* - where: Object `{ key: val, key2: {gt: 'val2'}}`
|
|
* - include: String, Object or Array. See AbstractClass.include documentation.
|
|
* - order: String
|
|
* - limit: Number
|
|
* - skip: Number
|
|
*
|
|
* @param {Function} callback (required) called with arguments:
|
|
*
|
|
* - err (null or Error)
|
|
* - Array of instances
|
|
*/
|
|
AbstractClass.all = function all(params, cb) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
if (arguments.length === 1) {
|
|
cb = params;
|
|
params = null;
|
|
}
|
|
var constr = this;
|
|
this.schema.adapter.all(this.modelName, params, function (err, data) {
|
|
if (data && data.map) {
|
|
data.forEach(function (d, i) {
|
|
var obj = new constr;
|
|
obj._initProperties(d, false);
|
|
data[i] = obj;
|
|
});
|
|
if (data && data.countBeforeLimit) {
|
|
data.countBeforeLimit = data.countBeforeLimit;
|
|
}
|
|
cb(err, data);
|
|
}
|
|
else
|
|
cb(err, []);
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Find one record, same as `all`, limited by 1 and return object, not collection
|
|
*
|
|
* @param {Object} params - search conditions: {where: {test: 'me'}}
|
|
* @param {Function} cb - callback called with (err, instance)
|
|
*/
|
|
AbstractClass.findOne = function findOne(params, cb) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
if (typeof params === 'function') {
|
|
cb = params;
|
|
params = {};
|
|
}
|
|
params.limit = 1;
|
|
this.all(params, function (err, collection) {
|
|
if (err || !collection || !collection.length > 0) return cb(err, null);
|
|
cb(err, collection[0]);
|
|
});
|
|
};
|
|
|
|
function substractDirtyAttributes(object, data) {
|
|
Object.keys(object.toObject()).forEach(function (attr) {
|
|
if (data.hasOwnProperty(attr) && object.propertyChanged(attr)) {
|
|
delete data[attr];
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Destroy all records
|
|
* @param {Function} cb - callback called with (err)
|
|
*/
|
|
AbstractClass.destroyAll = function destroyAll(cb) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
this.schema.adapter.destroyAll(this.modelName, function (err) {
|
|
cb(err);
|
|
}.bind(this));
|
|
};
|
|
|
|
/**
|
|
* Return count of matched records
|
|
*
|
|
* @param {Object} where - search conditions (optional)
|
|
* @param {Function} cb - callback, called with (err, count)
|
|
*/
|
|
AbstractClass.count = function (where, cb) {
|
|
if (stillConnecting(this.schema, this, arguments)) return;
|
|
|
|
if (typeof where === 'function') {
|
|
cb = where;
|
|
where = null;
|
|
}
|
|
this.schema.adapter.count(this.modelName, cb, where);
|
|
};
|
|
|
|
/**
|
|
* Return string representation of class
|
|
*
|
|
* @override default toString method
|
|
*/
|
|
AbstractClass.toString = function () {
|
|
return '[Model ' + this.modelName + ']';
|
|
};
|
|
|
|
/**
|
|
* Save instance. When instance haven't id, create method called instead.
|
|
* Triggers: validate, save, update | create
|
|
* @param options {validate: true, throws: false} [optional]
|
|
* @param callback(err, obj)
|
|
*/
|
|
AbstractClass.prototype.save = function (options, callback) {
|
|
if (stillConnecting(this.constructor.schema, this, arguments)) return;
|
|
|
|
if (typeof options == 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
|
|
callback = callback || function () {};
|
|
options = options || {};
|
|
|
|
if (!('validate' in options)) {
|
|
options.validate = true;
|
|
}
|
|
if (!('throws' in options)) {
|
|
options.throws = false;
|
|
}
|
|
|
|
var inst = this;
|
|
var data = inst.toObject(true);
|
|
var Model = this.constructor;
|
|
var modelName = Model.modelName;
|
|
|
|
if (!this.id) {
|
|
return Model.create(this, callback);
|
|
}
|
|
|
|
// validate first
|
|
if (!options.validate) {
|
|
return save();
|
|
}
|
|
|
|
inst.isValid(function (valid) {
|
|
if (valid) {
|
|
save();
|
|
} else {
|
|
var err = new ValidationError(inst);
|
|
// throws option is dangerous for async usage
|
|
if (options.throws) {
|
|
throw err;
|
|
}
|
|
callback(err, inst);
|
|
}
|
|
});
|
|
|
|
// then save
|
|
function save() {
|
|
inst.trigger('save', function (saveDone) {
|
|
inst.trigger('update', function (updateDone) {
|
|
inst._adapter().save(modelName, inst.constructor._forDB(data), function (err) {
|
|
if (err) {
|
|
return callback(err, inst);
|
|
}
|
|
inst._initProperties(data, false);
|
|
updateDone.call(inst, function () {
|
|
saveDone.call(inst, function () {
|
|
callback(err, inst);
|
|
});
|
|
});
|
|
});
|
|
}, data);
|
|
}, data);
|
|
}
|
|
};
|
|
|
|
AbstractClass.prototype.isNewRecord = function () {
|
|
return !this.id;
|
|
};
|
|
|
|
/**
|
|
* Return adapter of current record
|
|
* @private
|
|
*/
|
|
AbstractClass.prototype._adapter = function () {
|
|
return this.schema.adapter;
|
|
};
|
|
|
|
/**
|
|
* Convert instance to Object
|
|
*
|
|
* @param {Boolean} onlySchema - restrict properties to schema only, default false
|
|
* when onlySchema == true, only properties defined in schema returned,
|
|
* otherwise all enumerable properties returned
|
|
* @returns {Object} - canonical object representation (no getters and setters)
|
|
*/
|
|
AbstractClass.prototype.toObject = function (onlySchema) {
|
|
var data = {};
|
|
var ds = this.constructor.schema.definitions[this.constructor.modelName];
|
|
var properties = ds.properties;
|
|
var self = this;
|
|
|
|
this.constructor.forEachProperty(function (attr) {
|
|
if (self[attr] instanceof List) {
|
|
data[attr] = self[attr].toObject();
|
|
} else if (self.__data.hasOwnProperty(attr)) {
|
|
data[attr] = self[attr];
|
|
} else {
|
|
data[attr] = null;
|
|
}
|
|
});
|
|
|
|
if (!onlySchema) {
|
|
Object.keys(self).forEach(function (attr) {
|
|
if (!data.hasOwnProperty(attr)) {
|
|
data[attr] = this[attr];
|
|
}
|
|
});
|
|
}
|
|
|
|
return data;
|
|
};
|
|
|
|
// AbstractClass.prototype.hasOwnProperty = function (prop) {
|
|
// return this.__data && this.__data.hasOwnProperty(prop) ||
|
|
// Object.getOwnPropertyNames(this).indexOf(prop) !== -1;
|
|
// };
|
|
|
|
AbstractClass.prototype.toJSON = function () {
|
|
return this.toObject();
|
|
};
|
|
|
|
/**
|
|
* Delete object from persistence
|
|
*
|
|
* @triggers `destroy` hook (async) before and after destroying object
|
|
*/
|
|
AbstractClass.prototype.destroy = function (cb) {
|
|
if (stillConnecting(this.constructor.schema, this, arguments)) return;
|
|
|
|
this.trigger('destroy', function (destroyed) {
|
|
this._adapter().destroy(this.constructor.modelName, this.id, function (err) {
|
|
if (err) {
|
|
return cb(err);
|
|
}
|
|
|
|
destroyed(function () {
|
|
if(cb) cb();
|
|
});
|
|
}.bind(this));
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Update single attribute
|
|
*
|
|
* equals to `updateAttributes({name: value}, cb)
|
|
*
|
|
* @param {String} name - name of property
|
|
* @param {Mixed} value - value of property
|
|
* @param {Function} callback - callback called with (err, instance)
|
|
*/
|
|
AbstractClass.prototype.updateAttribute = function updateAttribute(name, value, callback) {
|
|
var data = {};
|
|
data[name] = value;
|
|
this.updateAttributes(data, callback);
|
|
};
|
|
|
|
/**
|
|
* Update set of attributes
|
|
*
|
|
* this method performs validation before updating
|
|
*
|
|
* @trigger `validation`, `save` and `update` hooks
|
|
* @param {Object} data - data to update
|
|
* @param {Function} callback - callback called with (err, instance)
|
|
*/
|
|
AbstractClass.prototype.updateAttributes = function updateAttributes(data, cb) {
|
|
if (stillConnecting(this.constructor.schema, this, arguments)) return;
|
|
|
|
var inst = this;
|
|
var model = this.constructor.modelName;
|
|
|
|
if (typeof data === 'function') {
|
|
cb = data;
|
|
data = null;
|
|
}
|
|
|
|
if (!data) {
|
|
data = {};
|
|
}
|
|
|
|
// update instance's properties
|
|
Object.keys(data).forEach(function (key) {
|
|
inst[key] = data[key];
|
|
});
|
|
|
|
inst.isValid(function (valid) {
|
|
if (!valid) {
|
|
if (cb) {
|
|
cb(new ValidationError(inst), inst);
|
|
}
|
|
} else {
|
|
inst.trigger('save', function (saveDone) {
|
|
inst.trigger('update', function (done) {
|
|
|
|
Object.keys(data).forEach(function (key) {
|
|
inst[key] = data[key];
|
|
});
|
|
|
|
inst._adapter().updateAttributes(model, inst.id, inst.constructor._forDB(data), function (err) {
|
|
if (!err) {
|
|
// update _was attrs
|
|
Object.keys(data).forEach(function (key) {
|
|
inst.__dataWas[key] = inst.__data[key];
|
|
});
|
|
}
|
|
done.call(inst, function () {
|
|
saveDone.call(inst, function () {
|
|
cb(err, inst);
|
|
});
|
|
});
|
|
});
|
|
}, data);
|
|
}, data);
|
|
}
|
|
}, data);
|
|
};
|
|
|
|
AbstractClass.prototype.fromObject = function (obj) {
|
|
Object.keys(obj).forEach(function (key) {
|
|
this[key] = obj[key];
|
|
}.bind(this));
|
|
};
|
|
|
|
/**
|
|
* Checks is property changed based on current property and initial value
|
|
*
|
|
* @param {String} attr - property name
|
|
* @return Boolean
|
|
*/
|
|
AbstractClass.prototype.propertyChanged = function propertyChanged(attr) {
|
|
return this.__data[attr] !== this.__dataWas[attr];
|
|
};
|
|
|
|
/**
|
|
* Reload object from persistence
|
|
*
|
|
* @requires `id` member of `object` to be able to call `find`
|
|
* @param {Function} callback - called with (err, instance) arguments
|
|
*/
|
|
AbstractClass.prototype.reload = function reload(callback) {
|
|
if (stillConnecting(this.constructor.schema, this, arguments)) return;
|
|
|
|
this.constructor.find(this.id, callback);
|
|
};
|
|
|
|
/**
|
|
* Reset dirty attributes
|
|
*
|
|
* this method does not perform any database operation it just reset object to it's
|
|
* initial state
|
|
*/
|
|
AbstractClass.prototype.reset = function () {
|
|
var obj = this;
|
|
Object.keys(obj).forEach(function (k) {
|
|
if (k !== 'id' && !obj.constructor.schema.definitions[obj.constructor.modelName].properties[k]) {
|
|
delete obj[k];
|
|
}
|
|
if (obj.propertyChanged(k)) {
|
|
obj[k] = obj[k + '_was'];
|
|
}
|
|
});
|
|
};
|
|
|
|
AbstractClass.prototype.inspect = function () {
|
|
return util.inspect(this.__data, false, 4, true);
|
|
};
|
|
|
|
|
|
/**
|
|
* Check whether `s` is not undefined
|
|
* @param {Mixed} s
|
|
* @return {Boolean} s is undefined
|
|
*/
|
|
function isdef(s) {
|
|
var undef;
|
|
return s !== undef;
|
|
}
|
|
|
|
/**
|
|
* Define readonly property on object
|
|
*
|
|
* @param {Object} obj
|
|
* @param {String} key
|
|
* @param {Mixed} value
|
|
*/
|
|
function defineReadonlyProp(obj, key, value) {
|
|
Object.defineProperty(obj, key, {
|
|
writable: false,
|
|
enumerable: true,
|
|
configurable: true,
|
|
value: value
|
|
});
|
|
}
|