Merge pull request #437 from HugoPoi/feature/settings-disable-default-sort

Add settings disableDefaultSort for find method

Author: dhmlau

README.md

@@ -64,7 +64,9 @@ of type `GeoPoint`. This allows for indexed ```near``` queries.  Default is `fal
   - Default is `false`.
   - If set to `true`, the database instance will not be attached to the datasource and the connection is deferred.
   - It will try to establish the connection automatically once users hit the endpoint. If the mongodb server is offline, the app will start, however, the endpoints will not work.
-
+- **disableDefaultSort**: Set to `true` to disable the default sorting
+  behavior on `id` column, this will help performance using indexed
+columns available in mongodb.
 ### Setting the url property in datasource.json
 
 You can set the `url` property to a connection URL in `datasources.json` to override individual connection parameters such as `host`, `user`, and `password`.  

lib/mongodb.js

@@ -936,10 +936,24 @@ MongoDB.prototype.buildWhere = function(model, where) {
   return query;
 };
 
-MongoDB.prototype.buildSort = function(model, order) {
+MongoDB.prototype.buildSort = function(model, order, options) {
   var sort = {};
   var idName = this.idName(model);
-  if (!order) {
+
+  var modelClass = this._models[model];
+
+  var disableDefaultSort = false;
+  if (this.settings.hasOwnProperty('disableDefaultSort')) {
+    disableDefaultSort = this.settings.disableDefaultSort;
+  }
+  if (modelClass.settings.hasOwnProperty('disableDefaultSort')) {
+    disableDefaultSort = modelClass.settings.disableDefaultSort;
+  }
+  if (options && options.hasOwnProperty('disableDefaultSort')) {
+    disableDefaultSort = options.disableDefaultSort;
+  }
+
+  if (!order && !disableDefaultSort) {
     var idNames = this.idNames(model);
     if (idNames && idNames.length) {
       order = idNames;
@@ -966,7 +980,7 @@ MongoDB.prototype.buildSort = function(model, order) {
         sort[key] = 1;
       }
     }
-  } else {
+  } else if (!disableDefaultSort) {
     // order by _id by default
     sort = {_id: 1};
   }
@@ -1224,7 +1238,7 @@ MongoDB.prototype.all = function all(model, filter, options, callback) {
 
     // don't apply sorting if dealing with a geo query
     if (!hasNearFilter(filter.where)) {
-      var order = self.buildSort(model, filter.order);
+      var order = self.buildSort(model, filter.order, options);
       cursor.sort(order);
     }
 

test/mongodb.test.js

@@ -26,7 +26,8 @@ var Superhero,
   Category,
   UserWithRenamedColumns,
   PostWithStringIdAndRenamedColumns,
-  Employee;
+  Employee,
+  PostWithDisableDefaultSort;
 
 describe('lazyConnect', function() {
   it('should skip connect phase (lazyConnect = true)', function(done) {
@@ -273,6 +274,18 @@ describe('mongodb connector', function() {
       }
     );
 
+    PostWithDisableDefaultSort = db.define(
+      'PostWithDisableDefaultSort',
+      {
+        id: {type: String, id: true},
+        title: {type: String, length: 255, index: true},
+        content: {type: String},
+      },
+      {
+        disableDefaultSort: true,
+      }
+    );
+
     User.hasMany(Post);
     Post.belongsTo(User);
   });
@@ -285,7 +298,9 @@ describe('mongodb connector', function() {
           PostWithNumberId.destroyAll(function() {
             PostWithNumberUnderscoreId.destroyAll(function() {
               PostWithStringId.destroyAll(function() {
-                done();
+                PostWithDisableDefaultSort.destroyAll(function() {
+                  done();
+                });
               });
             });
           });
@@ -2490,6 +2505,32 @@ describe('mongodb connector', function() {
     });
   });
 
+  it('find should not order by id if the order is not set for the query filter and settings.disableDefaultSort is true',
+    function(done) {
+      PostWithDisableDefaultSort.create({id: '2', title: 'c', content: 'CCC'}, function(err, post) {
+        PostWithDisableDefaultSort.create({id: '1', title: 'd', content: 'DDD'}, function(err, post) {
+          PostWithDisableDefaultSort.find({}, function(err, posts) {
+            should.not.exist(err);
+            posts.length.should.be.equal(2);
+            posts[0].id.should.be.equal('2');
+
+            PostWithDisableDefaultSort.find({limit: 1, offset: 0}, function(err, posts) {
+              should.not.exist(err);
+              posts.length.should.be.equal(1);
+              posts[0].id.should.be.equal('2');
+
+              PostWithDisableDefaultSort.find({limit: 1, offset: 1}, function(err, posts) {
+                should.not.exist(err);
+                posts.length.should.be.equal(1);
+                posts[0].id.should.be.equal('1');
+                done();
+              });
+            });
+          });
+        });
+      });
+    });
+
   it('should report error on duplicate keys', function(done) {
     Post.create({title: 'd', content: 'DDD'}, function(err, post) {
       Post.create({id: post.id, title: 'd', content: 'DDD'}, function(