Feature/prevent duplicate search fields in search api (#510)

* Prevent duplicate search fields in search API

Author: patrick-tolosa

lib-es5/v2/search.js

@@ -42,13 +42,27 @@ var Search = function () {
   }, {
     key: 'aggregate',
     value: function aggregate(value) {
-      this.query_hash.aggregate.push(value);
+      var found = this.query_hash.aggregate.find(function (v) {
+        return v === value;
+      });
+
+      if (!found) {
+        this.query_hash.aggregate.push(value);
+      }
+
       return this;
     }
   }, {
     key: 'with_field',
     value: function with_field(value) {
-      this.query_hash.with_field.push(value);
+      var found = this.query_hash.with_field.find(function (v) {
+        return v === value;
+      });
+
+      if (!found) {
+        this.query_hash.with_field.push(value);
+      }
+
       return this;
     }
   }, {
@@ -59,7 +73,20 @@ var Search = function () {
       var sort_bucket = void 0;
       sort_bucket = {};
       sort_bucket[field_name] = dir;
-      this.query_hash.sort_by.push(sort_bucket);
+
+      // Check if this field name is already stored in the hash
+      var previously_sorted_obj = this.query_hash.sort_by.find(function (sort_by) {
+        return sort_by[field_name];
+      });
+
+      // Since objects are references in Javascript, we can update the reference we found
+      // For example,
+      if (previously_sorted_obj) {
+        previously_sorted_obj[field_name] = dir;
+      } else {
+        this.query_hash.sort_by.push(sort_bucket);
+      }
+
       return this;
     }
   }, {

lib/v2/search.js

@@ -1,5 +1,5 @@
 const api = require('./api');
-const { isEmpty, isNumber } = require('../utils');
+const {isEmpty, isNumber} = require('../utils');
 
 const Search = class Search {
   constructor() {
@@ -54,20 +54,41 @@ const Search = class Search {
   }
 
   aggregate(value) {
-    this.query_hash.aggregate.push(value);
+    const found = this.query_hash.aggregate.find(v => v === value);
+
+    if (!found) {
+      this.query_hash.aggregate.push(value);
+    }
+
     return this;
   }
 
   with_field(value) {
-    this.query_hash.with_field.push(value);
+    const found = this.query_hash.with_field.find(v => v === value);
+
+    if (!found) {
+      this.query_hash.with_field.push(value);
+    }
+
     return this;
   }
 
   sort_by(field_name, dir = "desc") {
     let sort_bucket;
     sort_bucket = {};
     sort_bucket[field_name] = dir;
-    this.query_hash.sort_by.push(sort_bucket);
+
+    // Check if this field name is already stored in the hash
+    const previously_sorted_obj = this.query_hash.sort_by.find((sort_by) => sort_by[field_name]);
+
+    // Since objects are references in Javascript, we can update the reference we found
+    // For example,
+    if (previously_sorted_obj) {
+      previously_sorted_obj[field_name] = dir;
+    } else {
+      this.query_hash.sort_by.push(sort_bucket);
+    }
+
     return this;
   }
 

test/integration/api/search/search_spec.js

@@ -155,6 +155,36 @@ describe("search_api", function () {
           expect(results).not.to.have.key('next_cursor');
         });
     });
+
+    it('Should eliminate duplicate fields when using sort_by, aggregate or with_fields', function () {
+      // This test ensures we can't push duplicate values into sort_by, aggregate or with_fields
+      const search_query = cloudinary.v2.search.max_results(10).expression(`tags:${SEARCH_TAG}`)
+        .sort_by('public_id', 'asc')
+        .sort_by('public_id', 'asc')
+        .sort_by('public_id', 'asc')
+        .sort_by('public_id', 'asc')
+        .sort_by('public_id', 'desc')
+        .sort_by('public_id', 'desc')
+        .aggregate('foo')
+        .aggregate('foo')
+        .aggregate('foo2')
+        .with_field('foo')
+        .with_field('foo')
+        .with_field('foo2')
+        .to_query();
+
+      expect(search_query.aggregate.length).to.be(2);
+      expect(search_query.with_field.length).to.be(2);
+      expect(search_query.sort_by.length).to.be(1);
+
+      expect(search_query.aggregate[0]).to.be('foo');
+      expect(search_query.aggregate[1]).to.be('foo2');
+      expect(search_query.with_field[0]).to.be('foo');
+      expect(search_query.with_field[1]).to.be('foo2');
+
+      expect(search_query.sort_by[0].public_id).to.be('desc');
+    });
+
     it('should include context', function () {
       return cloudinary.v2.search.expression(`tags:${SEARCH_TAG}`).with_field('context')
         .execute()