verdnatura-mirror
/
loopback
mirror of https://github.com/strongloop/loopback.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3074 from ariskemper/fix_user_id 

Fix User model to handle custom PK name
This commit is contained in:
Miroslav Bajtoš 2017-01-23 09:43:19 +01:00 committed by GitHub
parent 9a1f86baef efd8237dc6
commit 4c9c6236e3
2 changed files with 56 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
common/models/user.js
View File

@ -388,6 +388,7 @@ module.exports = function(User) {
var user = this; var user = this;
var userModel = this.constructor; var userModel = this.constructor;
var registry = userModel.registry; var registry = userModel.registry;
var pkName = userModel.definition.idName() || 'id';
assert(typeof options === 'object', 'options required when calling user.verify()'); assert(typeof options === 'object', 'options required when calling user.verify()');
assert(options.type, 'You must supply a verification type (options.type)'); assert(options.type, 'You must supply a verification type (options.type)');
assert(options.type === 'email', 'Unsupported verification type'); assert(options.type === 'email', 'Unsupported verification type');
@ -425,7 +426,7 @@ module.exports = function(User) {
displayPort + displayPort +
urlPath + urlPath +
'?uid=' + '?uid=' +
options.user.id + options.user[pkName] +
'&redirect=' + '&redirect=' +
options.redirect; options.redirect;
@ -485,7 +486,7 @@ module.exports = function(User) {
if (err) { if (err) {
fn(err); fn(err);
} else { } else {
fn(null, {email: email, token: user.verificationToken, uid: user.id}); fn(null, {email: email, token: user.verificationToken, uid: user[pkName]});
} }
}); });
} }
@ -855,7 +856,13 @@ module.exports = function(User) {
User.observe('before save', function beforeEmailUpdate(ctx, next) { User.observe('before save', function beforeEmailUpdate(ctx, next) {
if (ctx.isNewInstance) return next(); if (ctx.isNewInstance) return next();
if (!ctx.where && !ctx.instance) return next(); if (!ctx.where && !ctx.instance) return next();
var where = ctx.where || {id: ctx.instance.id}; var pkName = ctx.Model.definition.idName() || 'id';
if (ctx.where) {
var where = ctx.where;
} else {
var where = {};
where[pkName] = ctx.instance[pkName];
}
var isPartialUpdateChangingPassword = ctx.data && 'password' in ctx.data; var isPartialUpdateChangingPassword = ctx.data && 'password' in ctx.data;
@ -871,7 +878,10 @@ module.exports = function(User) {
ctx.Model.find({where: where}, function(err, userInstances) { ctx.Model.find({where: where}, function(err, userInstances) {
if (err) return next(err); if (err) return next(err);
ctx.hookState.originalUserData = userInstances.map(function(u) { ctx.hookState.originalUserData = userInstances.map(function(u) {
return {id: u.id, email: u.email}; var user = {};
user[pkName] = u[pkName];
user['email'] = u['email'];
return user;
}); });
if (ctx.instance) { if (ctx.instance) {
var emailChanged = ctx.instance.email !== ctx.hookState.originalUserData[0].email; var emailChanged = ctx.instance.email !== ctx.hookState.originalUserData[0].email;
@ -895,6 +905,7 @@ module.exports = function(User) {
if (!ctx.instance && !ctx.data) return next(); if (!ctx.instance && !ctx.data) return next();
if (!ctx.hookState.originalUserData) return next(); if (!ctx.hookState.originalUserData) return next();
var pkName = ctx.Model.definition.idName() || 'id';
var newEmail = (ctx.instance || ctx.data).email; var newEmail = (ctx.instance || ctx.data).email;
var isPasswordChange = ctx.hookState.isPasswordChange; var isPasswordChange = ctx.hookState.isPasswordChange;
@ -903,7 +914,7 @@ module.exports = function(User) {
var userIdsToExpire = ctx.hookState.originalUserData.filter(function(u) { var userIdsToExpire = ctx.hookState.originalUserData.filter(function(u) {
return (newEmail && u.email !== newEmail) || isPasswordChange; return (newEmail && u.email !== newEmail) || isPasswordChange;
}).map(function(u) { }).map(function(u) {
return u.id; return u[pkName];
}); });
ctx.Model._invalidateAccessTokensOfUsers(userIdsToExpire, ctx.options, next); ctx.Model._invalidateAccessTokensOfUsers(userIdsToExpire, ctx.options, next);
}); });

74
test/user.test.js
View File

@ -50,11 +50,17 @@ describe('User', function() {
app.model(Email, {dataSource: 'email'}); app.model(Email, {dataSource: 'email'});
// attach User and related models // attach User and related models
// forceId is set to false for the purpose of updating the same affected user within the User = app.registry.createModel({
// `Email Update` test cases. name: 'TestUser',
User = app.registry.createModel('TestUser', {}, {
base: 'User', base: 'User',
properties: {
// Use a custom id property to verify that User methods
// are correctly looking up the primary key
pk: {type: 'String', defaultFn: 'guid', id: true},
},
http: {path: 'test-users'}, http: {path: 'test-users'},
// forceId is set to false for the purpose of updating the same affected user within the
// `Email Update` test cases.
forceId: false, forceId: false,
// Speed up the password hashing algorithm for tests // Speed up the password hashing algorithm for tests
saltWorkFactor: 4, saltWorkFactor: 4,
@ -92,7 +98,7 @@ describe('User', function() {
it('Create a new user', function(done) { it('Create a new user', function(done) {
User.create({email: 'f@b.com', password: 'bar'}, function(err, user) { User.create({email: 'f@b.com', password: 'bar'}, function(err, user) {
assert(!err); assert(!err);
assert(user.id); assert(user.pk);
assert(user.email); assert(user.email);
done(); done();
@ -104,7 +110,7 @@ describe('User', function() {
User.create({email: 'F@b.com', password: 'bar'}, function(err, user) { User.create({email: 'F@b.com', password: 'bar'}, function(err, user) {
if (err) return done(err); if (err) return done(err);
assert(user.id); assert(user.pk);
assert.equal(user.email, user.email.toLowerCase()); assert.equal(user.email, user.email.toLowerCase());
done(); done();
@ -115,7 +121,7 @@ describe('User', function() {
User.create({email: 'F@b.com', password: 'bar'}, function(err, user) { User.create({email: 'F@b.com', password: 'bar'}, function(err, user) {
if (err) return done(err); if (err) return done(err);
assert(user.id); assert(user.pk);
assert(user.email); assert(user.email);
assert.notEqual(user.email, user.email.toLowerCase()); assert.notEqual(user.email, user.email.toLowerCase());
@ -238,7 +244,7 @@ describe('User', function() {
async.series([ async.series([
function(next) { function(next) {
User.create({email: 'b@c.com', password: 'bar'}, function(err, user) { User.create({email: 'b@c.com', password: 'bar'}, function(err, user) {
usersId = user.id; usersId = user.pk;
next(err); next(err);
}); });
}, },
@ -281,7 +287,7 @@ describe('User', function() {
{name: 'myname', email: 'd@c.com', password: 'bar'}, {name: 'myname', email: 'd@c.com', password: 'bar'},
], function(err, users) { ], function(err, users) {
userIds = users.map(function(u) { userIds = users.map(function(u) {
return u.id; return u.pk;
}); });
next(err); next(err);
}); });
@ -409,7 +415,7 @@ describe('User', function() {
it('accepts passwords that are exactly 72 characters long', function(done) { it('accepts passwords that are exactly 72 characters long', function(done) {
User.create({email: 'b@c.com', password: pass72Char}, function(err, user) { User.create({email: 'b@c.com', password: pass72Char}, function(err, user) {
if (err) return done(err); if (err) return done(err);
User.findById(user.id, function(err, userFound) { User.findById(user.pk, function(err, userFound) {
if (err) return done(err); if (err) return done(err);
assert(userFound); assert(userFound);
done(); done();
@ -1074,7 +1080,7 @@ describe('User', function() {
it('logs in a user by with realm', function(done) { it('logs in a user by with realm', function(done) {
User.login(credentialWithRealm, function(err, accessToken) { User.login(credentialWithRealm, function(err, accessToken) {
assertGoodToken(accessToken); assertGoodToken(accessToken);
assert.equal(accessToken.userId, user1.id); assert.equal(accessToken.userId, user1.pk);
done(); done();
}); });
@ -1083,7 +1089,7 @@ describe('User', function() {
it('logs in a user by with realm in username', function(done) { it('logs in a user by with realm in username', function(done) {
User.login(credentialRealmInUsername, function(err, accessToken) { User.login(credentialRealmInUsername, function(err, accessToken) {
assertGoodToken(accessToken); assertGoodToken(accessToken);
assert.equal(accessToken.userId, user1.id); assert.equal(accessToken.userId, user1.pk);
done(); done();
}); });
@ -1092,7 +1098,7 @@ describe('User', function() {
it('logs in a user by with realm in email', function(done) { it('logs in a user by with realm in email', function(done) {
User.login(credentialRealmInEmail, function(err, accessToken) { User.login(credentialRealmInEmail, function(err, accessToken) {
assertGoodToken(accessToken); assertGoodToken(accessToken);
assert.equal(accessToken.userId, user1.id); assert.equal(accessToken.userId, user1.pk);
done(); done();
}); });
@ -1110,7 +1116,7 @@ describe('User', function() {
it('logs in a user by with realm', function(done) { it('logs in a user by with realm', function(done) {
User.login(credentialWithRealm, function(err, accessToken) { User.login(credentialWithRealm, function(err, accessToken) {
assertGoodToken(accessToken); assertGoodToken(accessToken);
assert.equal(accessToken.userId, user1.id); assert.equal(accessToken.userId, user1.pk);
done(); done();
}); });
@ -1229,7 +1235,7 @@ describe('User', function() {
var u = new User({username: 'a', password: 'b', email: 'z@z.net'}); var u = new User({username: 'a', password: 'b', email: 'z@z.net'});
u.save(function(err, user) { u.save(function(err, user) {
User.findById(user.id, function(err, uu) { User.findById(user.pk, function(err, uu) {
uu.hasPassword('b', function(err, isMatch) { uu.hasPassword('b', function(err, isMatch) {
assert(isMatch); assert(isMatch);
@ -1241,7 +1247,7 @@ describe('User', function() {
it('should match a password after it is changed', function(done) { it('should match a password after it is changed', function(done) {
User.create({email: 'foo@baz.net', username: 'bat', password: 'baz'}, function(err, user) { User.create({email: 'foo@baz.net', username: 'bat', password: 'baz'}, function(err, user) {
User.findById(user.id, function(err, foundUser) { User.findById(user.pk, function(err, foundUser) {
assert(foundUser); assert(foundUser);
foundUser.hasPassword('baz', function(err, isMatch) { foundUser.hasPassword('baz', function(err, isMatch) {
assert(isMatch); assert(isMatch);
@ -1249,7 +1255,7 @@ describe('User', function() {
foundUser.save(function(err, updatedUser) { foundUser.save(function(err, updatedUser) {
updatedUser.hasPassword('baz2', function(err, isMatch) { updatedUser.hasPassword('baz2', function(err, isMatch) {
assert(isMatch); assert(isMatch);
User.findById(user.id, function(err, uu) { User.findById(user.pk, function(err, uu) {
uu.hasPassword('baz2', function(err, isMatch) { uu.hasPassword('baz2', function(err, isMatch) {
assert(isMatch); assert(isMatch);
@ -2048,7 +2054,7 @@ describe('User', function() {
it('invalidates sessions when email is changed using `updateOrCreate`', function(done) { it('invalidates sessions when email is changed using `updateOrCreate`', function(done) {
User.updateOrCreate({ User.updateOrCreate({
id: user.id, pk: user.pk,
email: updatedEmailCredentials.email, email: updatedEmailCredentials.email,
}, function(err, userInstance) { }, function(err, userInstance) {
if (err) return done(err); if (err) return done(err);
@ -2059,7 +2065,7 @@ describe('User', function() {
it('invalidates sessions after `replaceById`', function(done) { it('invalidates sessions after `replaceById`', function(done) {
// The way how the invalidation is implemented now, all sessions // The way how the invalidation is implemented now, all sessions
// are invalidated on a full replace // are invalidated on a full replace
User.replaceById(user.id, currentEmailCredentials, function(err, userInstance) { User.replaceById(user.pk, currentEmailCredentials, function(err, userInstance) {
if (err) return done(err); if (err) return done(err);
assertNoAccessTokens(done); assertNoAccessTokens(done);
}); });
@ -2069,7 +2075,7 @@ describe('User', function() {
// The way how the invalidation is implemented now, all sessions // The way how the invalidation is implemented now, all sessions
// are invalidated on a full replace // are invalidated on a full replace
User.replaceOrCreate({ User.replaceOrCreate({
id: user.id, pk: user.pk,
email: currentEmailCredentials.email, email: currentEmailCredentials.email,
password: currentEmailCredentials.password, password: currentEmailCredentials.password,
}, function(err, userInstance) { }, function(err, userInstance) {
@ -2087,7 +2093,7 @@ describe('User', function() {
it('keeps sessions AS IS if firstName is added using `updateOrCreate`', function(done) { it('keeps sessions AS IS if firstName is added using `updateOrCreate`', function(done) {
User.updateOrCreate({ User.updateOrCreate({
id: user.id, pk: user.pk,
firstName: 'Loay', firstName: 'Loay',
email: currentEmailCredentials.email, email: currentEmailCredentials.email,
}, function(err, userInstance) { }, function(err, userInstance) {
@ -2154,7 +2160,7 @@ describe('User', function() {
}, },
function updatePartialUser(next) { function updatePartialUser(next) {
User.updateAll( User.updateAll(
{id: userPartial.id}, {pk: userPartial.pk},
{age: userPartial.age + 1}, {age: userPartial.age + 1},
function(err, info) { function(err, info) {
if (err) return next(err); if (err) return next(err);
@ -2162,7 +2168,7 @@ describe('User', function() {
}); });
}, },
function verifyTokensOfPartialUser(next) { function verifyTokensOfPartialUser(next) {
AccessToken.find({where: {userId: userPartial.id}}, function(err, tokens1) { AccessToken.find({where: {userId: userPartial.pk}}, function(err, tokens1) {
if (err) return next(err); if (err) return next(err);
expect(tokens1.length).to.equal(1); expect(tokens1.length).to.equal(1);
next(); next();
@ -2214,11 +2220,11 @@ describe('User', function() {
}); });
}, },
function(next) { function(next) {
AccessToken.find({where: {userId: user1.id}}, function(err, tokens1) { AccessToken.find({where: {userId: user1.pk}}, function(err, tokens1) {
if (err) return next(err); if (err) return next(err);
AccessToken.find({where: {userId: user2.id}}, function(err, tokens2) { AccessToken.find({where: {userId: user2.pk}}, function(err, tokens2) {
if (err) return next(err); if (err) return next(err);
AccessToken.find({where: {userId: user3.id}}, function(err, tokens3) { AccessToken.find({where: {userId: user3.pk}}, function(err, tokens3) {
if (err) return next(err); if (err) return next(err);
expect(tokens1.length).to.equal(1); expect(tokens1.length).to.equal(1);
@ -2259,7 +2265,7 @@ describe('User', function() {
}); });
}, },
function verifyTokensOfSpecialUser(next) { function verifyTokensOfSpecialUser(next) {
AccessToken.find({where: {userId: userSpecial.id}}, function(err, tokens1) { AccessToken.find({where: {userId: userSpecial.pk}}, function(err, tokens1) {
if (err) return done(err); if (err) return done(err);
expect(tokens1.length, 'tokens - special user tokens').to.equal(0); expect(tokens1.length, 'tokens - special user tokens').to.equal(0);
next(); next();
@ -2280,7 +2286,7 @@ describe('User', function() {
var options = {accessToken: originalUserToken1}; var options = {accessToken: originalUserToken1};
user.updateAttribute('email', 'new@example.com', options, function(err) { user.updateAttribute('email', 'new@example.com', options, function(err) {
if (err) return done(err); if (err) return done(err);
AccessToken.find({where: {userId: user.id}}, function(err, tokens) { AccessToken.find({where: {userId: user.pk}}, function(err, tokens) {
if (err) return done(err); if (err) return done(err);
var tokenIds = tokens.map(function(t) { return t.id; }); var tokenIds = tokens.map(function(t) { return t.id; });
expect(tokenIds).to.eql([originalUserToken1.id]); expect(tokenIds).to.eql([originalUserToken1.id]);
@ -2321,9 +2327,9 @@ describe('User', function() {
}); });
}, },
function(next) { function(next) {
AccessToken.find({where: {userId: user1.id}}, function(err, tokens1) { AccessToken.find({where: {userId: user1.pk}}, function(err, tokens1) {
if (err) return next(err); if (err) return next(err);
AccessToken.find({where: {userId: user2.id}}, function(err, tokens2) { AccessToken.find({where: {userId: user2.pk}}, function(err, tokens2) {
if (err) return next(err); if (err) return next(err);
expect(tokens1.length).to.equal(1); expect(tokens1.length).to.equal(1);
expect(tokens2.length).to.equal(0); expect(tokens2.length).to.equal(0);
@ -2338,7 +2344,7 @@ describe('User', function() {
}); });
function assertPreservedTokens(done) { function assertPreservedTokens(done) {
AccessToken.find({where: {userId: user.id}}, function(err, tokens) { AccessToken.find({where: {userId: user.pk}}, function(err, tokens) {
if (err) return done(err); if (err) return done(err);
var actualIds = tokens.map(function(t) { return t.id; }); var actualIds = tokens.map(function(t) { return t.id; });
actualIds.sort(); actualIds.sort();
@ -2350,7 +2356,7 @@ describe('User', function() {
}; };
function assertNoAccessTokens(done) { function assertNoAccessTokens(done) {
AccessToken.find({where: {userId: user.id}}, function(err, tokens) { AccessToken.find({where: {userId: user.pk}}, function(err, tokens) {
if (err) return done(err); if (err) return done(err);
expect(tokens.length).to.equal(0); expect(tokens.length).to.equal(0);
done(); done();
@ -2376,7 +2382,7 @@ describe('User', function() {
}); });
}, },
function findUser(next) { function findUser(next) {
User.findById(userInstance.id, function(err, info) { User.findById(userInstance.pk, function(err, info) {
if (err) return next(err); if (err) return next(err);
assert.equal(info.email, NEW_EMAIL); assert.equal(info.email, NEW_EMAIL);
assert.equal(info.emailVerified, false); assert.equal(info.emailVerified, false);
@ -2398,7 +2404,7 @@ describe('User', function() {
}); });
}, },
function findUser(next) { function findUser(next) {
User.findById(userInstance.id, function(err, info) { User.findById(userInstance.pk, function(err, info) {
if (err) return next(err); if (err) return next(err);
assert.equal(info.email, NEW_EMAIL); assert.equal(info.email, NEW_EMAIL);
assert.equal(info.emailVerified, true); assert.equal(info.emailVerified, true);
@ -2420,7 +2426,7 @@ describe('User', function() {
}); });
}, },
function findUser(next) { function findUser(next) {
User.findById(userInstance.id, function(err, info) { User.findById(userInstance.pk, function(err, info) {
if (err) return next(err); if (err) return next(err);
assert.equal(info.realm, 'test'); assert.equal(info.realm, 'test');
assert.equal(info.emailVerified, true); assert.equal(info.emailVerified, true);