Merge pull request #580 from stueynz/master

Key field with mapsTo breaks the cache

Author: dxg

lib/Model.js

@@ -396,13 +396,17 @@ function Model(opts) {
 			properties   : allProperties,
 			keyProperties: keyProperties,
 			newInstance  : function (data, cb) {
+                                // We need to do the rename before we construct the UID & do the cache lookup
+                                // because the cache is loaded using propertyName rather than fieldName
+                                Utilities.renameDatastoreFieldsToPropertyNames(data, fieldToPropertyMap);
+
+                                // Construct UID
 				var uid = opts.driver.uid + "/" + opts.table + (merge ? "+" + merge.from.table : "");
 				for (var i = 0; i < opts.keys.length; i++) {
 					uid += "/" + data[opts.keys[i]];
 				}
 
-				Utilities.renameDatastoreFieldsToPropertyNames(data, fieldToPropertyMap);
-
+                                // Now we can do the cache lookup
 				Singleton.get(uid, {
 					cache      : options.cache,
 					save_check : opts.settings.get("instance.cacheSaveCheck")

test/integration/model-find-mapsto.js

@@ -0,0 +1,98 @@
+var should   = require('should');
+var helper   = require('../support/spec_helper');
+var ORM      = require('../../');
+
+describe("Model.pkMapTo.find()", function() {
+	var db = null;
+	var Person = null;
+
+	var setup = function () {
+		return function (done) {
+
+                  // The fact that we've applied mapsTo to the key
+                  // property of the model - will break the cache.
+
+                  // Without Stuart's little bugfix, 2nd (and subsequent) calls to find()
+                  // will return the repeats of the first obect retrieved and placed in the cache.
+			Person = db.define("person", {
+	                        personId : {type : "integer", key: true,   mapsTo: "id"},
+				name     : String,
+				surname  : String,
+				age      : Number,
+				male     : Boolean
+			});
+
+			return helper.dropSync(Person, function () {
+				Person.create([{
+                                        personId: 1001,
+					name    : "John",
+					surname : "Doe",
+					age     : 18,
+					male    : true
+				}, {
+                                        personId: 1002,
+					name    : "Jane",
+					surname : "Doe",
+					age     : 16,
+					male    : false
+				}, {
+                                        personId: 1003,
+					name    : "Jeremy",
+					surname : "Dean",
+					age     : 18,
+					male    : true
+				}, {
+                                        personId: 1004,
+					name    : "Jack",
+					surname : "Dean",
+					age     : 20,
+					male    : true
+				}, {
+                                        personId: 1005,
+					name    : "Jasmine",
+					surname : "Doe",
+					age     : 20,
+					male    : false
+				}], done);
+			});
+		};
+	};
+
+	before(function (done) {
+		helper.connect(function (connection) {
+			db = connection;
+
+			return done();
+		});
+	});
+
+	after(function () {
+		return db.close();
+	});
+
+
+	describe("Cache should work with mapped key field", function () {
+		before(setup());
+
+		it("1st find should work", function (done) {
+			Person.find({ surname: "Dean" }, function (err, people) {
+				should.not.exist(err);
+				people.should.be.a("object");
+				people.should.have.property("length", 2);
+				people[0].surname.should.equal("Dean");
+
+				return done();
+			});
+		});
+		it("2nd find should should also work", function (done) {
+			Person.find({ surname: "Doe" }, function (err, people) {
+				should.not.exist(err);
+				people.should.be.a("object");
+				people.should.have.property("length", 3);
+				people[0].surname.should.equal("Doe");
+
+				return done();
+			});
+		});
+	});
+});