fix(search): handle large numbers in search queries (#621)

Author: closingin

src/services/search-builder.js

@@ -148,8 +148,15 @@ function SearchBuilder(model, opts, params, fieldNamesRequested) {
           pushCondition(condition, columnName);
         }
       } else if (field.type === 'Number') {
-        const value = Number(params.search);
+        let value = Number(params.search);
+
         if (!Number.isNaN(value)) {
+          if (Number.isInteger(value) && !Number.isSafeInteger(value)) {
+            // NOTE: Numbers higher than MAX_SAFE_INTEGER need to be handled as
+            //       strings to circumvent precision problems
+            value = params.search;
+          }
+
           condition[field.field] = value;
           pushCondition(condition, field.field);
         }

test/databases.test.js

@@ -124,6 +124,10 @@ const HasManyDissociator = require('../src/services/has-many-dissociator');
       ownerId: { type: Sequelize.INTEGER },
     });
 
+    models.counter = sequelize.define('counter', {
+      clicks: { type: Sequelize.BIGINT },
+    });
+
     models.address.belongsTo(models.user);
     models.addressWithUserAlias.belongsTo(models.user, { as: 'userAlias' });
     models.user.hasMany(models.address);
@@ -316,6 +320,16 @@ const HasManyDissociator = require('../src/services/has-many-dissociator');
             { field: 'ownerId', type: 'Number', reference: 'owner.ownerId' },
           ],
         },
+        counter: {
+          name: 'counter',
+          idField: 'id',
+          primaryKeys: ['id'],
+          isCompositePrimary: false,
+          fields: [
+            { field: 'id', type: 'Number' },
+            { field: 'clicks', type: 'Number' },
+          ],
+        },
       },
     };
 
@@ -1010,6 +1024,34 @@ const HasManyDissociator = require('../src/services/has-many-dissociator');
               connectionManager.closeConnection();
             }
           });
+
+          it('should handle numbers over MAX_SAFE_INTEGER', async () => {
+            expect.assertions(2);
+            const { models, sequelizeOptions } = initializeSequelize();
+
+            // HACK: sequelize-fixtures does not support BigInt in json files,
+            //       so we need to update the clicks value manually
+            const counter = await models.counter.findByPk(10);
+            counter.clicks = BigInt('9013084467599484828'); // eslint-disable-line no-undef
+            await counter.save();
+
+            const params = {
+              fields: {
+                counter: 'id,clicks',
+              },
+              page: { number: '1', size: '30' },
+              search: '9013084467599484828',
+              timezone: 'Europe/Paris',
+            };
+            try {
+              const result = await new ResourcesGetter(models.counter, sequelizeOptions, params)
+                .perform();
+              expect(result[0]).toHaveLength(1);
+              expect(result[0][0].id).toBe(10);
+            } finally {
+              connectionManager.closeConnection();
+            }
+          });
         });
       });
 

test/fixtures/db.json

@@ -1,4 +1,11 @@
 [
+  {
+    "model": "counter",
+    "data": {
+      "id": 10,
+      "clicks": 9013084467599484828
+    }
+  },
   {
     "model": "user",
     "data": {