loopback-datasource-juggler/lib/model.js

873 lines
26 KiB
JavaScript
Raw Normal View History

2019-05-08 15:45:37 +00:00
// Copyright IBM Corp. 2013,2019. All Rights Reserved.
2016-04-01 22:25:16 +00:00
// Node module: loopback-datasource-juggler
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT
// Turning on strict for this file breaks lots of test cases;
// disabling strict for this file
/* eslint-disable strict */
2014-03-12 23:28:46 +00:00
/*!
2013-04-11 23:23:34 +00:00
* Module exports class Model
*/
module.exports = ModelBaseClass;
2013-04-11 23:23:34 +00:00
2014-03-12 23:28:46 +00:00
/*!
2012-03-27 14:22:24 +00:00
* Module dependencies
2011-10-10 13:22:51 +00:00
*/
2014-01-24 17:09:53 +00:00
2018-12-07 14:54:29 +00:00
const g = require('strong-globalize')();
const util = require('util');
const jutil = require('./jutil');
const List = require('./list');
const DataAccessUtils = require('./model-utils');
const Observer = require('./observer');
const Hookable = require('./hooks');
const validations = require('./validations');
const _extend = util._extend;
const utils = require('./utils');
const fieldsToArray = utils.fieldsToArray;
const uuid = require('uuid');
const shortid = require('shortid');
2011-10-10 13:22:51 +00:00
// Set up an object for quick lookup
2018-12-07 14:54:29 +00:00
const BASE_TYPES = {
'String': true,
'Boolean': true,
'Number': true,
'Date': true,
'Text': true,
2016-04-01 11:48:17 +00:00
'ObjectID': true,
};
2011-10-10 13:22:51 +00:00
2011-10-08 17:11:26 +00:00
/**
2014-03-12 23:28:46 +00:00
* Model class: base class for all persistent objects.
2012-03-27 14:22:24 +00:00
*
* `ModelBaseClass` mixes `Validatable` and `Hookable` classes methods
2012-03-27 14:22:24 +00:00
*
2014-03-12 23:28:46 +00:00
* @class
* @param {Object} data Initial object data
2017-05-03 15:10:31 +00:00
* @param {Object} options An object to control the instantiation
* @returns {ModelBaseClass} an instance of the ModelBaseClass
2011-10-08 17:11:26 +00:00
*/
function ModelBaseClass(data, options) {
options = options || {};
2016-04-01 11:48:17 +00:00
if (!('applySetters' in options)) {
// Default to true
options.applySetters = true;
}
if (!('applyDefaultValues' in options)) {
options.applyDefaultValues = true;
}
this._initProperties(data, options);
2012-04-19 15:01:40 +00:00
}
/**
* Initialize the model instance with a list of properties
* @param {Object} data The data object
* @param {Object} options An object to control the instantiation
* @property {Boolean} applySetters Controls if the setters will be applied
* @property {Boolean} applyDefaultValues Default attributes and values will be applied
* @property {Boolean} strict Set the instance level strict mode
* @property {Boolean} persisted Whether the instance has been persisted
* @private
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype._initProperties = function(data, options) {
2018-12-07 14:54:29 +00:00
const self = this;
const ctor = this.constructor;
2017-05-03 15:10:31 +00:00
2017-09-28 00:12:30 +00:00
if (typeof data !== 'undefined' && data !== null && data.constructor &&
typeof (data.constructor) !== 'function') {
2016-07-22 19:26:07 +00:00
throw new Error(g.f('Property name "{{constructor}}" is not allowed in %s data', ctor.modelName));
}
2016-04-01 11:48:17 +00:00
if (data instanceof ctor) {
// Convert the data to be plain object to avoid pollutions
data = data.toObject(false);
}
2018-12-07 14:54:29 +00:00
const properties = _extend({}, ctor.definition.properties);
2014-01-24 17:09:53 +00:00
data = data || {};
if (typeof ctor.applyProperties === 'function') {
ctor.applyProperties(data);
}
2014-01-24 17:09:53 +00:00
options = options || {};
2018-12-07 14:54:29 +00:00
const applySetters = options.applySetters;
const applyDefaultValues = options.applyDefaultValues;
let strict = options.strict;
2016-04-01 11:48:17 +00:00
if (strict === undefined) {
strict = ctor.definition.settings.strict;
} else if (strict === 'throw') {
g.warn('Warning: Model %s, {{strict mode: `throw`}} has been removed, ' +
'please use {{`strict: true`}} instead, which returns' +
'{{`Validation Error`}} for unknown properties,', ctor.modelName);
}
2018-12-07 14:54:29 +00:00
const persistUndefinedAsNull = ctor.definition.settings.persistUndefinedAsNull;
if (ctor.hideInternalProperties) {
// Object.defineProperty() is expensive. We only try to make the internal
// properties hidden (non-enumerable) if the model class has the
// `hideInternalProperties` set to true
Object.defineProperties(this, {
__cachedRelations: {
writable: true,
enumerable: false,
configurable: true,
2016-04-01 11:48:17 +00:00
value: {},
},
__data: {
writable: true,
enumerable: false,
configurable: true,
2016-04-01 11:48:17 +00:00
value: {},
},
// Instance level data source
__dataSource: {
writable: true,
enumerable: false,
configurable: true,
2016-04-01 11:48:17 +00:00
value: options.dataSource,
},
// Instance level strict mode
__strict: {
writable: true,
enumerable: false,
configurable: true,
2016-04-01 11:48:17 +00:00
value: strict,
},
__persisted: {
writable: true,
enumerable: false,
configurable: true,
2016-04-01 11:48:17 +00:00
value: false,
},
});
if (strict) {
Object.defineProperty(this, '__unknownProperties', {
writable: true,
enumerable: false,
configrable: true,
2016-04-01 11:48:17 +00:00
value: [],
});
}
} else {
this.__cachedRelations = {};
this.__data = {};
this.__dataSource = options.dataSource;
this.__strict = strict;
2014-10-19 16:52:18 +00:00
this.__persisted = false;
if (strict) {
this.__unknownProperties = [];
}
}
if (options.persisted !== undefined) {
this.__persisted = options.persisted === true;
}
if (data.__cachedRelations) {
this.__cachedRelations = data.__cachedRelations;
2014-01-24 17:09:53 +00:00
}
2018-12-07 14:54:29 +00:00
let keys = Object.keys(data);
if (Array.isArray(options.fields)) {
keys = keys.filter(function(k) {
return (options.fields.indexOf(k) != -1);
});
}
2018-12-07 14:54:29 +00:00
let size = keys.length;
let p, propVal;
2018-12-07 15:22:36 +00:00
for (let k = 0; k < size; k++) {
p = keys[k];
propVal = data[p];
if (typeof propVal === 'function') {
continue;
}
if (propVal === undefined && persistUndefinedAsNull) {
propVal = null;
}
if (properties[p]) {
// Managed property
if (applySetters || properties[p].id) {
self[p] = propVal;
} else {
self.__data[p] = propVal;
}
} else if (ctor.relations[p]) {
2018-12-07 14:54:29 +00:00
const relationType = ctor.relations[p].type;
2018-12-07 15:22:36 +00:00
let modelTo;
if (!properties[p]) {
modelTo = ctor.relations[p].modelTo || ModelBaseClass;
2018-12-07 14:54:29 +00:00
const multiple = ctor.relations[p].multiple;
const typeName = multiple ? 'Array' : modelTo.modelName;
const propType = multiple ? [modelTo] : modelTo;
2016-08-19 17:46:59 +00:00
properties[p] = {name: typeName, type: propType};
/* Issue #1252
this.setStrict(false);
*/
}
// Relation
2014-08-21 08:44:55 +00:00
if (relationType === 'belongsTo' && propVal != null) {
2014-03-13 23:43:38 +00:00
// If the related model is populated
self.__data[ctor.relations[p].keyFrom] = propVal[ctor.relations[p].keyTo];
if (ctor.relations[p].options.embedsProperties) {
2018-12-07 14:54:29 +00:00
const fields = fieldsToArray(ctor.relations[p].properties,
modelTo.definition.properties, modelTo.settings.strict);
if (!~fields.indexOf(ctor.relations[p].keyTo)) {
fields.push(ctor.relations[p].keyTo);
}
2016-04-01 13:23:42 +00:00
self.__data[p] = new modelTo(propVal, {
fields: fields,
applySetters: false,
persisted: options.persisted,
});
}
2014-03-13 23:43:38 +00:00
}
self.__cachedRelations[p] = propVal;
2014-01-24 17:09:53 +00:00
} else {
// Un-managed property
if (strict === false || self.__cachedRelations[p]) {
self[p] = self.__data[p] =
(propVal !== undefined) ? propVal : self.__cachedRelations[p];
// Throw error for properties with unsupported names
if (/\./.test(p)) {
2016-07-22 19:26:07 +00:00
throw new Error(g.f(
'Property names containing dot(s) are not supported. ' +
2016-07-22 19:26:07 +00:00
'Model: %s, dynamic property: %s',
this.constructor.modelName, p,
2016-07-22 19:26:07 +00:00
));
}
} else {
if (strict !== 'filter') {
this.__unknownProperties.push(p);
}
2014-01-24 17:09:53 +00:00
}
}
2014-01-24 17:09:53 +00:00
}
keys = Object.keys(properties);
if (Array.isArray(options.fields)) {
keys = keys.filter(function(k) {
return (options.fields.indexOf(k) != -1);
});
}
size = keys.length;
2018-12-07 15:22:36 +00:00
for (let k = 0; k < size; k++) {
p = keys[k];
propVal = self.__data[p];
2018-12-07 14:54:29 +00:00
const type = properties[p].type;
// Set default values
if (applyDefaultValues && propVal === undefined && appliesDefaultsOnWrites(properties[p])) {
2018-12-07 14:54:29 +00:00
let def = properties[p]['default'];
if (def !== undefined) {
if (typeof def === 'function') {
if (def === Date) {
// FIXME: We should coerce the value in general
// This is a work around to {default: Date}
// Date() will return a string instead of Date
def = new Date();
} else {
def = def();
}
} else if (type.name === 'Date' && def === '$now') {
def = new Date();
}
// FIXME: We should coerce the value
// will implement it after we refactor the PropertyDefinition
self.__data[p] = propVal = def;
}
2014-01-24 17:09:53 +00:00
}
if (ignoresMatchedDefault(properties[p]) && properties[p].default === propVal) {
delete self.__data[p];
}
// Set default value using a named function
if (applyDefaultValues && propVal === undefined) {
2018-12-07 14:54:29 +00:00
const defn = properties[p].defaultFn;
switch (defn) {
case undefined:
break;
case 'guid':
case 'uuid':
// Generate a v1 (time-based) id
propVal = uuid.v1();
break;
case 'uuidv4':
// Generate a RFC4122 v4 UUID
propVal = uuid.v4();
break;
case 'now':
propVal = new Date();
break;
2016-09-20 09:16:00 +00:00
case 'shortid':
propVal = shortid.generate();
break;
default:
// TODO Support user-provided functions via a registry of functions
2016-07-22 19:26:07 +00:00
g.warn('Unknown default value provider %s', defn);
}
// FIXME: We should coerce the value
// will implement it after we refactor the PropertyDefinition
if (propVal !== undefined)
self.__data[p] = propVal;
}
if (propVal === undefined && persistUndefinedAsNull) {
self.__data[p] = propVal = null;
}
// Handle complex types (JSON/Object)
if (!BASE_TYPES[type.name]) {
if (typeof self.__data[p] !== 'object' && self.__data[p]) {
2014-01-24 17:09:53 +00:00
try {
self.__data[p] = JSON.parse(self.__data[p] + '');
2014-01-24 17:09:53 +00:00
} catch (e) {
self.__data[p] = String(self.__data[p]);
2011-10-11 19:51:32 +00:00
}
2014-01-24 17:09:53 +00:00
}
2014-08-19 20:06:55 +00:00
if (type.prototype instanceof ModelBaseClass) {
2016-04-01 13:23:42 +00:00
if (!(self.__data[p] instanceof type) &&
typeof self.__data[p] === 'object' &&
self.__data[p] !== null) {
2014-08-19 20:06:55 +00:00
self.__data[p] = new type(self.__data[p]);
}
} else if (type.name === 'Array' || Array.isArray(type)) {
2016-04-01 13:23:42 +00:00
if (!(self.__data[p] instanceof List) &&
self.__data[p] !== undefined &&
self.__data[p] !== null) {
self.__data[p] = List(self.__data[p], type, self);
2014-01-24 17:09:53 +00:00
}
}
2011-10-11 19:51:32 +00:00
}
2014-01-24 17:09:53 +00:00
}
this.trigger('initialize');
};
2011-10-08 17:11:26 +00:00
// Implementation of persistDefaultValues property
function ignoresMatchedDefault(property) {
if (property && property.persistDefaultValues === false) {
return true;
}
}
// Helper function for determing the applyDefaultOnWrites value of a property
function appliesDefaultsOnWrites(property) {
if (property && ('applyDefaultOnWrites' in property)) {
return property.applyDefaultOnWrites;
}
return true;
}
2012-03-27 14:22:24 +00:00
/**
2014-03-12 23:28:46 +00:00
* Define a property on the model.
* @param {String} prop Property name
* @param {Object} params Various property configuration
2012-03-27 14:22:24 +00:00
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.defineProperty = function(prop, params) {
if (this.dataSource) {
2014-08-08 08:20:57 +00:00
this.dataSource.defineProperty(this.modelName, prop, params);
} else {
this.modelBuilder.defineProperty(this.modelName, prop, params);
}
2011-12-09 15:23:29 +00:00
};
2017-05-03 15:10:31 +00:00
/**
* Get model property type.
* @param {String} propName Property name
* @returns {String} Name of property type
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.getPropertyType = function(propName) {
2018-12-07 14:54:29 +00:00
const prop = this.definition.properties[propName];
2014-01-24 17:09:53 +00:00
if (!prop) {
// The property is not part of the definition
return null;
}
if (!prop.type) {
2016-07-22 19:26:07 +00:00
throw new Error(g.f('Type not defined for property %s.%s', this.modelName, propName));
2014-01-24 17:09:53 +00:00
// return null;
}
return prop.type.name;
2012-05-29 11:16:24 +00:00
};
2017-05-03 15:10:31 +00:00
/**
* Get model property type.
* @param {String} propName Property name
* @returns {String} Name of property type
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.getPropertyType = function(propName) {
2014-01-24 17:09:53 +00:00
return this.constructor.getPropertyType(propName);
2012-01-18 15:20:05 +00:00
};
2012-03-27 14:22:24 +00:00
/**
* Return string representation of class
2014-03-12 23:28:46 +00:00
* This overrides the default `toString()` method
2012-03-27 14:22:24 +00:00
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.toString = function() {
2014-01-24 17:09:53 +00:00
return '[Model ' + this.modelName + ']';
2012-07-13 13:53:22 +00:00
};
2011-10-08 17:11:26 +00:00
2012-03-27 14:22:24 +00:00
/**
2014-03-12 23:28:46 +00:00
* Convert model instance to a plain JSON object.
* Returns a canonical object representation (no getters and setters).
2012-03-27 14:22:24 +00:00
*
2014-03-12 23:28:46 +00:00
* @param {Boolean} onlySchema Restrict properties to dataSource only. Default is false. If true, the function returns only properties defined in the schema; Otherwise it returns all enumerable properties.
2017-05-03 15:10:31 +00:00
* @param {Boolean} removeHidden Boolean flag as part of the transformation. If true, then hidden properties should not be brought out.
* @param {Boolean} removeProtected Boolean flag as part of the transformation. If true, then protected properties should not be brought out.
* @returns {Object} returns Plain JSON object
2012-03-27 14:22:24 +00:00
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.toObject = function(onlySchema, removeHidden, removeProtected) {
if (typeof onlySchema === 'object' && onlySchema != null) {
2018-12-07 14:54:29 +00:00
const options = onlySchema;
onlySchema = options.onlySchema;
removeHidden = options.removeHidden;
removeProtected = options.removeProtected;
}
if (onlySchema === undefined) {
onlySchema = true;
}
2018-12-07 14:54:29 +00:00
const data = {};
const self = this;
const Model = this.constructor;
2014-01-24 17:09:53 +00:00
2014-05-05 14:23:12 +00:00
// if it is already an Object
if (Model === Object) {
return self;
}
2014-05-05 14:23:12 +00:00
2018-12-07 14:54:29 +00:00
const strict = this.__strict;
const schemaLess = (strict === false) || !onlySchema;
const persistUndefinedAsNull = Model.definition.settings.persistUndefinedAsNull;
2018-12-07 14:54:29 +00:00
const props = Model.definition.properties;
let keys = Object.keys(props);
let propertyName, val;
2018-12-07 15:22:36 +00:00
for (let i = 0; i < keys.length; i++) {
propertyName = keys[i];
val = self[propertyName];
// Exclude functions
if (typeof val === 'function') {
continue;
}
// Exclude hidden properties
if (removeHidden && Model.isHiddenProperty(propertyName)) {
continue;
}
2015-01-20 19:58:52 +00:00
if (removeProtected && Model.isProtectedProperty(propertyName)) {
continue;
}
if (val instanceof List) {
2015-01-20 19:58:52 +00:00
data[propertyName] = val.toObject(!schemaLess, removeHidden, true);
} else {
if (val !== undefined && val !== null && val.toObject) {
2015-01-20 19:58:52 +00:00
data[propertyName] = val.toObject(!schemaLess, removeHidden, true);
2014-01-24 17:09:53 +00:00
} else {
if (val === undefined && persistUndefinedAsNull) {
val = null;
}
data[propertyName] = val;
2014-01-24 17:09:53 +00:00
}
}
}
2014-01-24 17:09:53 +00:00
if (schemaLess) {
// Find its own properties which can be set via myModel.myProperty = 'myValue'.
// If the property is not declared in the model definition, no setter will be
// triggered to add it to __data
keys = Object.keys(self);
2018-12-07 14:54:29 +00:00
let size = keys.length;
2018-12-07 15:22:36 +00:00
for (let i = 0; i < size; i++) {
propertyName = keys[i];
if (props[propertyName]) {
continue;
}
if (propertyName.indexOf('__') === 0) {
continue;
}
if (removeHidden && Model.isHiddenProperty(propertyName)) {
continue;
}
2015-01-20 19:58:52 +00:00
if (removeProtected && Model.isProtectedProperty(propertyName)) {
continue;
}
if (data[propertyName] !== undefined) {
continue;
}
val = self[propertyName];
if (val !== undefined) {
if (typeof val === 'function') {
continue;
}
if (val !== null && val.toObject) {
2015-01-20 19:58:52 +00:00
data[propertyName] = val.toObject(!schemaLess, removeHidden, true);
} else {
data[propertyName] = val;
}
} else if (persistUndefinedAsNull) {
data[propertyName] = null;
}
}
// Now continue to check __data
keys = Object.keys(self.__data);
size = keys.length;
2018-12-07 15:22:36 +00:00
for (let i = 0; i < size; i++) {
propertyName = keys[i];
if (propertyName.indexOf('__') === 0) {
continue;
}
if (data[propertyName] === undefined) {
if (removeHidden && Model.isHiddenProperty(propertyName)) {
continue;
}
if (removeProtected && Model.isProtectedProperty(propertyName)) {
2015-01-20 19:58:52 +00:00
continue;
}
2018-12-07 14:54:29 +00:00
const ownVal = self[propertyName];
// The ownVal can be a relation function
2015-01-20 19:58:52 +00:00
val = (ownVal !== undefined && (typeof ownVal !== 'function')) ? ownVal : self.__data[propertyName];
if (typeof val === 'function') {
continue;
}
2014-01-24 17:09:53 +00:00
if (val !== undefined && val !== null && val.toObject) {
2015-01-20 19:58:52 +00:00
data[propertyName] = val.toObject(!schemaLess, removeHidden, true);
} else if (val === undefined && persistUndefinedAsNull) {
data[propertyName] = null;
2012-09-10 15:57:21 +00:00
} else {
2014-01-24 17:09:53 +00:00
data[propertyName] = val;
}
2014-01-24 17:09:53 +00:00
}
}
2014-01-24 17:09:53 +00:00
}
2014-04-11 18:39:57 +00:00
2014-01-24 17:09:53 +00:00
return data;
2011-10-08 17:11:26 +00:00
};
2018-11-12 21:54:22 +00:00
/**
* Convert an array of strings into an object as the map
* @param {string[]} arr An array of strings
*/
function asObjectMap(arr) {
2018-12-07 14:54:29 +00:00
const obj = {};
2018-11-12 21:54:22 +00:00
if (Array.isArray(arr)) {
2018-12-07 14:54:29 +00:00
for (let i = 0; i < arr.length; i++) {
2018-11-12 21:54:22 +00:00
obj[arr[i]] = true;
}
return obj;
}
return arr || obj;
}
2017-05-03 15:10:31 +00:00
/**
* Checks if property is protected.
* @param {String} propertyName Property name
* @returns {Boolean} true or false if protected or not.
2017-05-03 15:10:31 +00:00
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.isProtectedProperty = function(propertyName) {
2018-12-07 14:54:29 +00:00
const settings = (this.definition && this.definition.settings) || {};
const protectedProperties = settings.protectedProperties || settings.protected;
2018-11-12 21:54:22 +00:00
settings.protectedProperties = asObjectMap(protectedProperties);
return settings.protectedProperties[propertyName];
2015-01-20 19:58:52 +00:00
};
2017-05-03 15:10:31 +00:00
/**
* Checks if property is hidden.
* @param {String} propertyName Property name
* @returns {Boolean} true or false if hidden or not.
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.isHiddenProperty = function(propertyName) {
2018-12-07 14:54:29 +00:00
const settings = (this.definition && this.definition.settings) || {};
const hiddenProperties = settings.hiddenProperties || settings.hidden;
2018-11-12 21:54:22 +00:00
settings.hiddenProperties = asObjectMap(hiddenProperties);
return settings.hiddenProperties[propertyName];
2015-01-20 19:58:52 +00:00
};
2014-04-11 18:39:57 +00:00
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.toJSON = function() {
2015-01-20 19:58:52 +00:00
return this.toObject(false, true, false);
2012-09-10 15:57:21 +00:00
};
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.fromObject = function(obj) {
2018-12-07 14:54:29 +00:00
for (const key in obj) {
2014-01-24 17:09:53 +00:00
this[key] = obj[key];
}
};
2012-03-27 14:22:24 +00:00
/**
2014-03-12 23:28:46 +00:00
* Reset dirty attributes.
* This method does not perform any database operations; it just resets the object to its
* initial state.
2012-03-27 14:22:24 +00:00
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.reset = function() {
2018-12-07 14:54:29 +00:00
const obj = this;
for (const k in obj) {
2014-01-24 17:09:53 +00:00
if (k !== 'id' && !obj.constructor.dataSource.definitions[obj.constructor.modelName].properties[k]) {
delete obj[k];
}
}
2011-11-28 16:31:01 +00:00
};
// Node v0.11+ allows custom inspect functions to return an object
// instead of string. That way options like `showHidden` and `colors`
// can be preserved.
2018-12-07 14:54:29 +00:00
const versionParts = process.versions && process.versions.node ?
process.versions.node.split(/\./g).map(function(v) { return +v; }) :
[1, 0, 0]; // browserify ships 1.0-compatible version of util.inspect
2018-12-07 14:54:29 +00:00
const INSPECT_SUPPORTS_OBJECT_RETVAL =
versionParts[0] > 0 ||
versionParts[1] > 11 ||
(versionParts[0] === 11 && versionParts[1] >= 14);
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.inspect = function(depth) {
if (INSPECT_SUPPORTS_OBJECT_RETVAL)
2016-04-01 11:48:17 +00:00
return this.__data;
// Workaround for older versions
// See also https://github.com/joyent/node/commit/66280de133
return util.inspect(this.__data, {
showHidden: false,
depth: depth,
2016-04-01 11:48:17 +00:00
colors: false,
});
2012-10-15 23:15:29 +00:00
};
if (util.inspect.custom) {
// Node.js 12+ no longer recognizes "inspect" method,
// it uses "inspect.custom" symbol as the key instead
// TODO(semver-major) always use the symbol key only (requires Node.js 8+).
ModelBaseClass.prototype[util.inspect.custom] = ModelBaseClass.prototype.inspect;
}
2017-05-03 15:10:31 +00:00
/**
*
* @param {String} anotherClass could be string or class. Name of the class or the class itself
* @param {Object} options An object to control the instantiation
* @returns {ModelClass}
*/
2016-04-01 11:48:17 +00:00
ModelBaseClass.mixin = function(anotherClass, options) {
if (typeof anotherClass === 'string') {
2014-08-08 08:20:57 +00:00
this.modelBuilder.mixins.applyMixin(this, anotherClass, options);
} else {
2014-08-08 08:20:57 +00:00
if (anotherClass.prototype instanceof ModelBaseClass) {
2018-12-07 14:54:29 +00:00
const props = anotherClass.definition.properties;
for (const i in props) {
2014-08-08 08:20:57 +00:00
if (this.definition.properties[i]) {
continue;
}
this.defineProperty(i, props[i]);
}
}
return jutil.mixin(this, anotherClass, options);
}
};
2013-05-28 20:50:59 +00:00
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.getDataSource = function() {
2013-10-31 17:51:33 +00:00
return this.__dataSource || this.constructor.dataSource;
};
2016-04-01 11:48:17 +00:00
ModelBaseClass.getDataSource = function() {
2013-10-31 17:51:33 +00:00
return this.dataSource;
};
2016-04-01 11:48:17 +00:00
ModelBaseClass.prototype.setStrict = function(strict) {
this.__strict = strict;
};
2013-10-31 17:51:33 +00:00
configurable model merge The PR superseeds the existing deepMerge algorithm used to merge settings of parent and child models with a new algorithm that allows to specify the way each setting is merged or mixed-in. This configuration of this algorithm uses a merge policy specification. The `getMergePolicy()` helper of BaseModelClass can be used to ease model merge configuration. Next is presented the expected merge behaviour for each option. NOTE: This applies to top-level settings properties - Any - `{replace: true}` (default): child replaces the value from parent - assignin `null` on child setting deletes the inherited setting - Arrays - `{replace: false}`: unique elements of parent and child cumulate - `{rank: true}` adds the model inheritance rank to array elements of type Object {} as internal property `__rank` - Object {}: - `{replace: false}`: deep merges parent and child objects - `{patch: true}`: child replaces inner properties from parent The recommended merge policy is returned by getMergePolicy() when calling the method with option `{configureModelMerge: true}`. The legacy built-in merge policy is returned by `getMergePolicy()` when avoiding option `configureModelMerge`. NOTE: it also delivers ACLs ranking in addition to the legacy behaviour as well as fixes for settings `description` and `relations` `getMergePolicy()` can be customized using model's setting `configureModelMerge` as follows: ``` { // .. options: { configureModelMerge: { // merge options } } // .. } ``` `getMergePolicy()` method can also be extended programmatically as follows: ``` myModel.getMergePolicy = function(options) { const origin = myModel.base.getMergePolicy(options); return Object.assign({}, origin, { // new/overriding options }); }; ```
2017-03-27 22:30:29 +00:00
/**
*
* `getMergePolicy()` provides model merge policies to apply when extending
* a child model from a base model. Such a policy drives the way parent/child model
* properties/settings are merged/mixed-in together.
*
* Below is presented the expected merge behaviour for each option.
* NOTE: This applies to top-level settings properties
*
*
* - Any
* - `{replace: true}` (default): child replaces the value from parent
* - assignin `null` on child setting deletes the inherited setting
*
* - Arrays:
* - `{replace: false}`: unique elements of parent and child cumulate
* - `{rank: true}` adds the model inheritance rank to array
* elements of type Object {} as internal property `__rank`
*
* - Object {}:
* - `{replace: false}`: deep merges parent and child objects
* - `{patch: true}`: child replaces inner properties from parent
*
*
* The recommended built-in merge policy is as follows. It is returned by getMergePolicy()
* when calling the method with option `{configureModelMerge: true}`.
*
* ```
* {
* description: {replace: true}, // string or array
* options: {patch: true}, // object
* hidden: {replace: false}, // array
* protected: {replace: false}, // array
* indexes: {patch: true}, // object
* methods: {patch: true}, // object
* mixins: {patch: true}, // object
* relations: {patch: true}, // object
* scope: {replace: true}, // object
* scopes: {patch: true}, // object
* acls: {rank: true}, // array
* // this setting controls which child model property's value allows deleting
* // a base model's property
* __delete: null,
* // this setting controls the default merge behaviour for settings not defined
* // in the mergePolicy specification
* __default: {replace: true},
* }
* ```
*
* The legacy built-in merge policy is as follows, it is retuned by `getMergePolicy()`
* when avoiding option `configureModelMerge`.
* NOTE: it also provides the ACLs ranking in addition to the legacy behaviour, as well
* as fixes for settings 'description' and 'relations': matching relations from child
* replace relations from parents.
*
* ```
* {
* description: {replace: true}, // string or array
* properties: {patch: true}, // object
* hidden: {replace: false}, // array
* protected: {replace: false}, // array
* relations: {acls: true}, // object
* acls: {rank: true}, // array
* }
* ```
*
*
* `getMergePolicy()` can be customized using model's setting `configureModelMerge` as follows:
*
* ``` json
* {
* // ..
* options: {
* configureModelMerge: {
* // merge options
* }
* }
* // ..
* }
* ```
*
* NOTE: mergePolicy parameter can also defined at JSON model definition root
*
* `getMergePolicy()` method can also be extended programmatically as follows:
*
* ``` js
* myModel.getMergePolicy = function(options) {
* const origin = myModel.base.getMergePolicy(options);
* return Object.assign({}, origin, {
* // new/overriding options
* });
* };
* ```
*
* @param {Object} options option `configureModelMerge` can be used to alter the
* returned merge policy:
* - `configureModelMerge: true` will have the method return the recommended merge policy.
* - `configureModelMerge: {..}` will actually have the method return the provided object.
* - not providing this options will have the method return a merge policy emulating the
* the model merge behaviour up to datasource-juggler v3.6.1, as well as the ACLs ranking.
* @returns {Object} mergePolicy The model merge policy to apply when using the
* current model as base class for a child model
*/
ModelBaseClass.getMergePolicy = function(options) {
// NOTE: merge policy equivalent to datasource-juggler behaviour up to v3.6.1
// + fix for description arrays that should not be merged
// + fix for relations that should patch matching relations
// + ranking of ACLs
2018-12-07 14:54:29 +00:00
let mergePolicy = {
configurable model merge The PR superseeds the existing deepMerge algorithm used to merge settings of parent and child models with a new algorithm that allows to specify the way each setting is merged or mixed-in. This configuration of this algorithm uses a merge policy specification. The `getMergePolicy()` helper of BaseModelClass can be used to ease model merge configuration. Next is presented the expected merge behaviour for each option. NOTE: This applies to top-level settings properties - Any - `{replace: true}` (default): child replaces the value from parent - assignin `null` on child setting deletes the inherited setting - Arrays - `{replace: false}`: unique elements of parent and child cumulate - `{rank: true}` adds the model inheritance rank to array elements of type Object {} as internal property `__rank` - Object {}: - `{replace: false}`: deep merges parent and child objects - `{patch: true}`: child replaces inner properties from parent The recommended merge policy is returned by getMergePolicy() when calling the method with option `{configureModelMerge: true}`. The legacy built-in merge policy is returned by `getMergePolicy()` when avoiding option `configureModelMerge`. NOTE: it also delivers ACLs ranking in addition to the legacy behaviour as well as fixes for settings `description` and `relations` `getMergePolicy()` can be customized using model's setting `configureModelMerge` as follows: ``` { // .. options: { configureModelMerge: { // merge options } } // .. } ``` `getMergePolicy()` method can also be extended programmatically as follows: ``` myModel.getMergePolicy = function(options) { const origin = myModel.base.getMergePolicy(options); return Object.assign({}, origin, { // new/overriding options }); }; ```
2017-03-27 22:30:29 +00:00
description: {replace: true}, // string or array
properties: {patch: true}, // object
hidden: {replace: false}, // array
protected: {replace: false}, // array
relations: {patch: true}, // object
acls: {rank: true}, // array
};
2018-12-07 14:54:29 +00:00
const config = (options || {}).configureModelMerge;
configurable model merge The PR superseeds the existing deepMerge algorithm used to merge settings of parent and child models with a new algorithm that allows to specify the way each setting is merged or mixed-in. This configuration of this algorithm uses a merge policy specification. The `getMergePolicy()` helper of BaseModelClass can be used to ease model merge configuration. Next is presented the expected merge behaviour for each option. NOTE: This applies to top-level settings properties - Any - `{replace: true}` (default): child replaces the value from parent - assignin `null` on child setting deletes the inherited setting - Arrays - `{replace: false}`: unique elements of parent and child cumulate - `{rank: true}` adds the model inheritance rank to array elements of type Object {} as internal property `__rank` - Object {}: - `{replace: false}`: deep merges parent and child objects - `{patch: true}`: child replaces inner properties from parent The recommended merge policy is returned by getMergePolicy() when calling the method with option `{configureModelMerge: true}`. The legacy built-in merge policy is returned by `getMergePolicy()` when avoiding option `configureModelMerge`. NOTE: it also delivers ACLs ranking in addition to the legacy behaviour as well as fixes for settings `description` and `relations` `getMergePolicy()` can be customized using model's setting `configureModelMerge` as follows: ``` { // .. options: { configureModelMerge: { // merge options } } // .. } ``` `getMergePolicy()` method can also be extended programmatically as follows: ``` myModel.getMergePolicy = function(options) { const origin = myModel.base.getMergePolicy(options); return Object.assign({}, origin, { // new/overriding options }); }; ```
2017-03-27 22:30:29 +00:00
if (config === true) {
// NOTE: recommended merge policy from datasource-juggler v3.6.2
mergePolicy = {
description: {replace: true}, // string or array
options: {patch: true}, // object
// properties: {patch: true}, // object // NOTE: not part of configurable merge
hidden: {replace: false}, // array
protected: {replace: false}, // array
indexes: {patch: true}, // object
methods: {patch: true}, // object
mixins: {patch: true}, // object
// validations: {patch: true}, // object // NOTE: not implemented
relations: {patch: true}, // object
scope: {replace: true}, // object
scopes: {patch: true}, // object
acls: {rank: true}, // array
// this option controls which value assigned on child model allows deleting
// a base model's setting
__delete: null,
// this option controls the default merge behaviour for settings not defined
// in the mergePolicy specification
__default: {replace: true},
};
}
// override mergePolicy with provided model setting if required
if (config && typeof config === 'object' && !Array.isArray(config)) {
// config is an object
mergePolicy = config;
}
return mergePolicy;
};
/**
* Gets properties defined with 'updateOnly' flag set to true from the model. This flag is also set to true
* internally for the id property, if this property is generated and IdInjection is true.
* @returns {updateOnlyProps} List of properties with updateOnly set to true.
*/
ModelBaseClass.getUpdateOnlyProperties = function() {
const props = this.definition.properties;
return Object.keys(props).filter(key => props[key].updateOnly);
};
2018-11-12 21:54:22 +00:00
// Mix in utils
jutil.mixin(ModelBaseClass, DataAccessUtils);
// Mixin observer
2018-11-12 21:54:22 +00:00
jutil.mixin(ModelBaseClass, Observer);
2013-05-28 05:20:30 +00:00
jutil.mixin(ModelBaseClass, Hookable);
jutil.mixin(ModelBaseClass, validations.Validatable);