fix: nested include duplication in smart field search (#863)

Author: arnaud-moncel

src/services/search-builder.js

@@ -85,7 +85,7 @@ function SearchBuilder(model, opts, params, fieldNamesRequested) {
         try {
           await field.search(query, params.search);
         } catch (error) {
-          const errorMessage = `Cannot search properly on Smart Field ${field.field}`;
+          const errorMessage = `Cannot search properly on Smart Field ${field.field}: `;
           Interface.logger.error(errorMessage, error);
         }
         return Promise.resolve();

src/utils/sequelize-compatibility.js

@@ -133,8 +133,8 @@ function removeDuplicateAssociations(model, includeList) {
 
   // Recurse
   includeList.forEach((include) => {
-    if (include.include) {
-      const association = model.associations[include.as];
+    const association = model.associations[include.as];
+    if (include.include && association) {
       removeDuplicateAssociations(association.target, include.include);
     }
   });

test/services/query-options.test.js

@@ -84,7 +84,7 @@ describe('services > query-options', () => {
 
           const options = new QueryOptions(model);
           await options.search('search string', null);
-          expect(loggerErrorSpy).toHaveBeenCalledWith('Cannot search properly on Smart Field smartField', errorThrown);
+          expect(loggerErrorSpy).toHaveBeenCalledWith('Cannot search properly on Smart Field smartField: ', errorThrown);
 
           loggerErrorSpy.mockClear();
           resetSchema();
@@ -122,7 +122,7 @@ describe('services > query-options', () => {
 
         const options = new QueryOptions(model);
         await options.search('search string', null);
-        expect(loggerErrorSpy).toHaveBeenCalledWith('Cannot search properly on Smart Field smartField', errorThrown);
+        expect(loggerErrorSpy).toHaveBeenCalledWith('Cannot search properly on Smart Field smartField: ', errorThrown);
 
         loggerErrorSpy.mockClear();
         resetSchema();

test/utils/sequelize-compatibility.test.js

@@ -252,4 +252,26 @@ describe('utils > sequelize-compatibility', () => {
       });
     });
   });
+
+  describe('postProcess -> removeDuplicateAssociations', () => {
+    describe('when include alias is not valid', () => {
+      it('should not throw an error', () => {
+        expect.assertions(1);
+
+        const include = [{ model: SubModel, as: 'notAValidAlias', include: SubModel }];
+
+        expect(() => postProcess(Model, { include })).not.toThrow();
+      });
+    });
+
+    describe('when the main model is reincluded', () => {
+      it('should not throw an error', () => {
+        expect.assertions(1);
+
+        const include = [{ model: Model, include: SubSubModel1 }];
+
+        expect(() => postProcess(Model, { include })).not.toThrow();
+      });
+    });
+  });
 });