Merge pull request #707 from strongloop/fix-primary-key-checks

Fix primary key checks
This commit is contained in:
Simon Ho 2015-08-27 14:51:17 -07:00
commit e2df36c006
4 changed files with 105 additions and 76 deletions

View File

@ -856,8 +856,8 @@ DataAccessObject.findById = function findById(id, filter, options, cb) {
assert(typeof options === 'object', 'The options argument must be an object');
assert(typeof cb === 'function', 'The cb argument must be a function');
if (!this.definition.hasIdDefined()) {
process.nextTick(cb(getIdDefinitionError()));
if (isPKMissing(this, cb)) {
return cb.promise;
} else if (id == null || id === '') {
process.nextTick(function() {
cb(new Error('Model::findById requires the id argument'));
@ -906,8 +906,7 @@ DataAccessObject.findByIds = function(ids, query, options, cb) {
assert(typeof options === 'object', 'The options argument must be an object');
assert(typeof cb === 'function', 'The cb argument must be a function');
if (!this.definition.hasIdDefined()) {
process.nextTick(cb(getIdDefinitionError()));
if (isPKMissing(this, cb)) {
return cb.promise;
} else if (ids.length === 0) {
process.nextTick(cb(null, []));
@ -1697,8 +1696,7 @@ DataAccessObject.removeById = DataAccessObject.destroyById = DataAccessObject.de
assert(typeof options === 'object', 'The options argument must be an object');
assert(typeof cb === 'function', 'The cb argument must be a function');
if (!this.definition.hasIdDefined()) {
process.nextTick(cb(getIdDefinitionError()));
if (isPKMissing(this, cb)) {
return cb.promise;
} else if (id == null || id === '') {
process.nextTick(function() {
@ -1839,7 +1837,9 @@ DataAccessObject.prototype.save = function (options, cb) {
assert(typeof options === 'object', 'The options argument should be an object');
assert(typeof cb === 'function', 'The cb argument should be a function');
if (this.isNewRecord()) {
if (isPKMissing(Model, cb)) {
return cb.promise;
} else if (this.isNewRecord()) {
return Model.create(this, options, cb);
}
@ -2141,6 +2141,9 @@ DataAccessObject.prototype.remove =
var id = getIdValue(this.constructor, this);
var hookState = {};
if (isPKMissing(Model, cb))
return cb.promise;
var context = {
Model: Model,
query: byIdQuery(Model, id),
@ -2327,6 +2330,9 @@ DataAccessObject.prototype.updateAttributes = function updateAttributes(data, op
assert(typeof connector.updateAttributes === 'function',
'updateAttributes() must be implemented by the connector');
if (isPKMissing(Model, cb))
return cb.promise;
var allowExtendedOperators = connector.settings
&& connector.settings.allowExtendedOperators;
@ -2542,13 +2548,17 @@ jutil.mixin(DataAccessObject, Relation);
*/
jutil.mixin(DataAccessObject, require('./transaction'));
/**
* Return an error object stating the `id` property must be part of the model
* definition.
*
* @return {Object} The error stating the requirements
*/
function getIdDefinitionError() {
return new Error('`id` property must be defined as part of the model ' +
'definition');
function PKMissingError(modelName) {
this.name = 'PKMissingError';
this.message = 'Primary key is missing for the ' + modelName + ' model';
}
PKMissingError.prototype = new Error();
function isPKMissing(modelClass, cb) {
var hasPK = modelClass.definition.hasPK();
if (hasPK) return false;
process.nextTick(function() {
cb(new PKMissingError(modelClass.modelName));
});
return true;
}

View File

@ -303,24 +303,6 @@ ModelDefinition.prototype.toJSON = function (forceRebuild) {
return json;
};
/**
* Checks if the id property has been defined in the model definition. Returns
* true if the id is found in the model definition properties OR in at least one
* id object from the _id property.
*
* @returns {Boolean} True if id is defined, false otherwise
*/
ModelDefinition.prototype.hasIdDefined = function() {
var isDefined = false;
if (this.properties.id)
isDefined = true;
// check if id is defined by a relation
this.ids().forEach(function(item) {
if (item.hasOwnProperty('id'))
isDefined = true;
});
return isDefined;
ModelDefinition.prototype.hasPK = function() {
return this.ids().length > 0;
};

View File

@ -620,10 +620,10 @@ describe('basic-querying', function () {
});
});
describe('queries', function() {
describe.skip('queries', function() {
var Todo;
before(function setupDb(done) {
before(function prepDb(done) {
var db = getSchema();
Todo = db.define('Todo', {
id: false,
@ -714,47 +714,10 @@ describe('queries', function() {
done();
});
});
it('should work for save', function(done) {
var todo = new Todo();
todo.content = 'Buy ham';
todo.save(function(err) {
should.not.exist(err);
done();
});
});
it('should work for delete', function(done) {
Todo.findOne(function(err, todo) {
todo.delete(function(err) {
should.not.exist(err);
done();
});
});
});
it('should work for updateAttribute', function(done) {
Todo.findOne(function(err, todo) {
todo.updateAttribute('content', 'Buy ham', function(err) {
should.not.exist(err);
done();
});
});
});
it('should work for updateAttributes', function(done) {
Todo.findOne(function(err, todo) {
todo.updateAttributes({content: 'Buy ham'}, function(err) {
should.not.exist(err);
done();
});
});
});
});
context('that require an id', function() {
var expectedErrMsg = '`id` property must be defined as part of the model ' +
'definition';
var expectedErrMsg = 'Primary key is missing for the Todo model';
it('should return an error for findById', function(done) {
Todo.findById(1, function(err) {
@ -783,6 +746,46 @@ describe('queries', function() {
});
}, done);
});
it('should return an error for instance.save', function(done) {
var todo = new Todo();
todo.content = 'Buy ham';
todo.save(function(err) {
should.exist(err);
err.message.should.equal(expectedErrMsg);
done();
});
});
it('should return an error for instance.delete', function(done) {
Todo.findOne(function(err, todo) {
todo.delete(function(err) {
should.exist(err);
err.message.should.equal(expectedErrMsg);
done();
});
});
});
it('should return an error for instance.updateAttribute', function(done) {
Todo.findOne(function(err, todo) {
todo.updateAttribute('content', 'Buy ham', function(err) {
should.exist(err);
err.message.should.equal(expectedErrMsg);
done();
});
});
});
it('should return an error for instance.updateAttributes', function(done) {
Todo.findOne(function(err, todo) {
todo.updateAttributes({content: 'Buy ham'}, function(err) {
should.exist(err);
err.message.should.equal(expectedErrMsg);
done();
});
});
});
});
});

View File

@ -400,4 +400,38 @@ describe('ModelDefinition class', function () {
var props = Model.definition.properties;
props.regular.type.should.equal(props.sugar.type);
});
context('hasPK', function() {
context('with primary key defined', function() {
var Todo;
before(function prepModel() {
Todo = new ModelDefinition(new ModelBuilder(), 'Todo', {
content: 'string'
});
Todo.defineProperty('id', {
type: 'number',
id: true
});
Todo.build();
});
it('should return true', function() {
Todo.hasPK().should.be.ok;
});
});
context('without primary key defined', function() {
var Todo;
before(function prepModel() {
Todo = new ModelDefinition(new ModelBuilder(), 'Todo', {
content: 'string'
});
Todo.build();
});
it('should return false', function() {
Todo.hasPK().should.not.be.ok;
});
});
});
});