Skip to content

Various fixes in operation hooks #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bajtos merged 4 commits into from
Jan 5, 2016
Merged

Various fixes in operation hooks #796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89e4555
describe-operation-hooks: add "loaded" hook
bajtos Dec 18, 2015
3028329
"loaded" hook in DAO.find: ctx.data, not instance
bajtos Dec 18, 2015
fd9bef4
Enhance "persisted" hook in DAO.updateAttributes
bajtos Dec 18, 2015
e9899a9
Enhance "persist" hook in DAO.updateOrCreate
bajtos Dec 18, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 55 additions & 45 deletions lib/dao.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ DataAccessObject.create = function (data, options, cb) {
if (options.validate === undefined && Model.settings.automaticValidation === false) {
return create();
}

// validation required
obj.isValid(function (valid) {
if (valid) {
Expand Down Expand Up @@ -521,6 +521,7 @@ DataAccessObject.updateOrCreate = DataAccessObject.upsert = function upsert(data
var context = {
Model: Model,
data: data,
isNewInstance: info && info.isNewInstance,
hookState: ctx.hookState,
options: options
};
Expand Down Expand Up @@ -1455,56 +1456,64 @@ DataAccessObject.find = function find(query, options, cb) {
async.each(data, function(item, callback) {
var d = item;//data[i];
var Model = self.lookupModel(d);
var obj = new Model(d, {fields: query.fields, applySetters: false, persisted: true});

if (query && query.include) {
if (query.collect) {
// The collect property indicates that the query is to return the
// standalone items for a related model, not as child of the parent object
// For example, article.tags
obj = obj.__cachedRelations[query.collect];
if (obj === null) {
obj = undefined;
}
} else {
// This handles the case to return parent items including the related
// models. For example, Article.find({include: 'tags'}, ...);
// Try to normalize the include
var includes = Inclusion.normalizeInclude(query.include || []);
includes.forEach(function(inc) {
var relationName = inc;
if (utils.isPlainObject(inc)) {
relationName = Object.keys(inc)[0];
}

// Promote the included model as a direct property
var included = obj.__cachedRelations[relationName];
if (Array.isArray(included)) {
included = new List(included, null, obj);
}
if (included) obj.__data[relationName] = included;
});
delete obj.__data.__cachedRelations;
}
}
if (obj !== undefined) {
context = {
Model: Model,
instance: obj,
isNewInstance: false,
hookState: hookState,
options: options
context = {
Model: Model,
data: d,
isNewInstance: false,
hookState: hookState,
options: options
};

Model.notifyObserversOf('loaded', context, function(err) {
if (err) return callback(err);
d = context.data;

var ctorOpts = {
fields: query.fields,
applySetters: false,
persisted: true
};
var obj = new Model(d, ctorOpts);

if (query && query.include) {
if (query.collect) {
// The collect property indicates that the query is to return the
// standalone items for a related model, not as child of the parent object
// For example, article.tags
obj = obj.__cachedRelations[query.collect];
if (obj === null) {
obj = undefined;
}
} else {
// This handles the case to return parent items including the related
// models. For example, Article.find({include: 'tags'}, ...);
// Try to normalize the include
var includes = Inclusion.normalizeInclude(query.include || []);
includes.forEach(function(inc) {
var relationName = inc;
if (utils.isPlainObject(inc)) {
relationName = Object.keys(inc)[0];
}

Model.notifyObserversOf('loaded', context, function(err) {
if (err) return callback(err);
// Promote the included model as a direct property
var included = obj.__cachedRelations[relationName];
if (Array.isArray(included)) {
included = new List(included, null, obj);
}
if (included) obj.__data[relationName] = included;
});
delete obj.__data.__cachedRelations;
}
}

if (obj !== undefined) {
results.push(obj);
callback();
});
} else {
callback();
}
} else {
callback();
}
});
},
function(err) {
if (err) return cb(err);
Expand Down Expand Up @@ -2548,6 +2557,7 @@ DataAccessObject.prototype.updateAttributes = function updateAttributes(data, op
where: byIdQuery(Model, getIdValue(Model, inst)).where,
data: context.data,
currentInstance: inst,
isNewInstance: false,
hookState: hookState,
options: options
};
Expand Down
2 changes: 1 addition & 1 deletion support/describe-operation-hooks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ var Memory = require('../lib/connectors/memory').Memory;

var HOOK_NAMES = [
'access',
'before save', 'persist', 'after save',
'before save', 'persist', 'loaded', 'after save',
'before delete', 'after delete'
];

Expand Down
30 changes: 21 additions & 9 deletions test/persistence-hooks.suite.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ module.exports = function(dataSource, should) {

it('applies updates from `loaded` hook', function(done) {
TestModel.observe('loaded', pushContextAndNext(function(ctx) {
ctx.instance.extra = 'hook data';
ctx.data.extra = 'hook data';
}));

TestModel.find(
Expand All @@ -138,7 +138,7 @@ module.exports = function(dataSource, should) {
if (err) return done(err);

observedContexts.should.eql(aTestModelCtx({
instance: {
data: {
id: "1",
name: "first",
extra: "hook data"
Expand All @@ -147,6 +147,8 @@ module.exports = function(dataSource, should) {
hookState: { test: true },
options: {}
}));

list[0].should.have.property('extra', 'hook data');
done();
});
})
Expand Down Expand Up @@ -1210,7 +1212,8 @@ module.exports = function(dataSource, should) {
id: existingInstance.id,
name: 'changed',
extra: null
}
},
isNewInstance: false
}));

done();
Expand Down Expand Up @@ -1685,7 +1688,7 @@ module.exports = function(dataSource, should) {
function(err, instance) {
if (err) return done(err);

observedContexts.should.eql(aTestModelCtx({
var expectedContext = aTestModelCtx({
where: { id: existingInstance.id },
data: {
id: existingInstance.id,
Expand All @@ -1696,7 +1699,15 @@ module.exports = function(dataSource, should) {
name: 'updated name',
extra: undefined
}
}));
});

if (!dataSource.connector.updateOrCreate) {
// When the connector does not provide updateOrCreate,
// DAO falls back to updateAttributes which sets this flag
expectedContext.isNewInstance = false;
}

observedContexts.should.eql(expectedContext);
done();
});
});
Expand All @@ -1711,7 +1722,8 @@ module.exports = function(dataSource, should) {

if (dataSource.connector.updateOrCreate) {
observedContexts.should.eql(aTestModelCtx({
data: { id: 'new-id', name: 'a name' }
data: { id: 'new-id', name: 'a name' },
isNewInstance: true,
}));
} else {
observedContexts.should.eql(aTestModelCtx({
Expand Down Expand Up @@ -1739,18 +1751,18 @@ module.exports = function(dataSource, should) {
data: {
id: existingInstance.id,
name: 'updated name'
}
},
isNewInstance: false
}));
} else {
// For Unoptimized connector, the callback function `pushContextAndNext`
// is called twice. As a result, observedContexts
// returns an array and NOT a single instance.
observedContexts.should.eql([
aTestModelCtx({
instance: {
data: {
id: existingInstance.id,
name: 'first',
extra: null
},
isNewInstance: false,
options: { notify: false }
Expand Down