fix(search): highlighting not working when the column name contains underscores

Author: romain-gilliotte

src/services/search-builder.js

@@ -110,7 +110,7 @@ function SearchBuilder(model, opts, params, fieldNamesRequested) {
             ' LIKE ',
             lowerIfNecessary(`%${params.search}%`),
           );
-          pushCondition(condition, columnName);
+          pushCondition(condition, field.field);
         } else if (isUUID(DataTypes, primaryKeyType)
           && params.search.match(REGEX_UUID)) {
           condition[field.field] = params.search;
@@ -145,7 +145,7 @@ function SearchBuilder(model, opts, params, fieldNamesRequested) {
             ' LIKE ',
             lowerIfNecessary(`%${params.search}%`),
           );
-          pushCondition(condition, columnName);
+          pushCondition(condition, field.field);
         }
       } else if (field.type === 'Number') {
         let value = Number(params.search);

test/databases.test.js

@@ -71,6 +71,15 @@ const HasManyDissociator = require('../src/services/has-many-dissociator');
       name: { type: Sequelize.STRING, allowNull: false },
     });
 
+    models.georegion = sequelize.define('georegion', {
+      isocode: {
+        type: Sequelize.STRING,
+        primaryKey: true,
+      },
+      nameEnglish: { type: Sequelize.STRING, allowNull: false },
+      nameFrench: { type: Sequelize.STRING, allowNull: false },
+    });
+
     models.address = sequelize.define('address', {
       line: { type: Sequelize.STRING },
       zipCode: { type: Sequelize.STRING },
@@ -218,6 +227,17 @@ const HasManyDissociator = require('../src/services/has-many-dissociator');
             { field: 'updatedAt', type: 'Date' },
           ],
         },
+        georegion: {
+          name: 'georegion',
+          idField: 'isocode',
+          primaryKeys: ['isocode'],
+          isCompositePrimary: false,
+          fields: [
+            { field: 'isocode', type: 'String' },
+            { field: 'nameEnglish', type: 'String' },
+            { field: 'nameFrench', type: 'String' },
+          ],
+        },
         address: {
           name: 'address',
           idField: 'id',
@@ -1211,6 +1231,84 @@ const HasManyDissociator = require('../src/services/has-many-dissociator');
         });
       });
 
+      describe('request on the resources getter with a search on a string primary key', () => {
+        describe('with a string that does not matches', () => {
+          it('should return 0 records for the specified page', async () => {
+            expect.assertions(1);
+            const { models, sequelizeOptions } = initializeSequelize();
+            const params = {
+              fields: {
+                country: 'isocode,nameEnglish',
+              },
+              page: { number: '1', size: '30' },
+              search: 'en',
+              timezone: 'Europe/Paris',
+            };
+            try {
+              const result = await new ResourcesGetter(models.georegion, sequelizeOptions, params)
+                .perform();
+              expect(result[0]).toHaveLength(0);
+            } finally {
+              connectionManager.closeConnection();
+            }
+          });
+
+          it('should count 0 records', async () => {
+            expect.assertions(1);
+            const { models, sequelizeOptions } = initializeSequelize();
+            const params = {
+              search: 'en',
+              timezone: 'Europe/Paris',
+            };
+            try {
+              const count = await new ResourcesGetter(models.georegion, sequelizeOptions, params)
+                .count();
+              expect(count).toStrictEqual(0);
+            } finally {
+              connectionManager.closeConnection();
+            }
+          });
+        });
+
+        describe('with a string that matches', () => {
+          it('should return 1 record for the specified page', async () => {
+            expect.assertions(1);
+            const { models, sequelizeOptions } = initializeSequelize();
+            const params = {
+              fields: {
+                georegion: 'isocode,nameEnglish',
+              },
+              page: { number: '1', size: '30' },
+              search: 'es',
+              timezone: 'Europe/Paris',
+            };
+            try {
+              const result = await new ResourcesGetter(models.georegion, sequelizeOptions, params)
+                .perform();
+              expect(result[0]).toHaveLength(1);
+            } finally {
+              connectionManager.closeConnection();
+            }
+          });
+
+          it('should count 1 record', async () => {
+            expect.assertions(1);
+            const { models, sequelizeOptions } = initializeSequelize();
+            const params = {
+              search: 'es',
+              timezone: 'Europe/Paris',
+            };
+            try {
+              const count = await new ResourcesGetter(models.georegion, sequelizeOptions, params)
+                .count();
+              expect(count).toStrictEqual(1);
+            } finally {
+              connectionManager.closeConnection();
+            }
+          });
+        });
+      });
+
       describe('request on the resources getter with a search on a collection with searchFields', () => {
         it('should return the records for the specified page', async () => {
           expect.assertions(1);

test/fixtures/db.json

@@ -129,5 +129,13 @@
       "userId": 100,
       "teamId": 100
     }
+  },
+  {
+    "model": "georegion",
+    "data": {
+      "isocode": "es",
+      "nameEnglish": "Spain",
+      "nameFrench": "Espagne"
+    }
   }
-]
+]