fix(retrocompatibility): handle sequelize includables on smart field search (#850)

Co-authored-by: Thenkei <[email protected]>

Author: Thenkei

src/services/query-options.js

@@ -189,7 +189,11 @@ class QueryOptions {
     }
 
     if (include) {
-      this._customerIncludes.push(...include);
+      if (Array.isArray(include)) {
+        this._customerIncludes.push(...include);
+      } else {
+        this._customerIncludes.push(include);
+      }
     }
 
     return helper.getFieldsSearched();

src/utils/sequelize-compatibility.js

@@ -1,6 +1,5 @@
 import ObjectTools from './object-tools';
 import Operators from './operators';
-import { isVersionLessThan } from './orm';
 import QueryUtils from './query';
 
 /**
@@ -86,9 +85,13 @@ function normalizeInclude(model, include) {
 
   // Recurse
   if (include.include) {
-    include.include = include.include.map(
-      (childInclude) => normalizeInclude(include.model, childInclude),
-    );
+    if (Array.isArray(include.include)) {
+      include.include = include.include.map(
+        (childInclude) => normalizeInclude(include.model, childInclude),
+      );
+    } else {
+      include.include = [normalizeInclude(include.model, include.include)];
+    }
   }
 
   return include;
@@ -143,13 +146,9 @@ exports.postProcess = (model, rawOptions) => {
   const options = rawOptions;
   const operators = Operators.getInstance({ Sequelize: model.sequelize.constructor });
 
-  if (isVersionLessThan(model.sequelize.constructor, '5.0.0')) {
-    options.include = options.include.map((include) => normalizeInclude(model, include));
-    bubbleWheresInPlace(operators, options);
-    removeDuplicateAssociations(model, options.include);
-  } else {
-    bubbleWheresInPlace(operators, options);
-  }
+  options.include = options.include.map((include) => normalizeInclude(model, include));
+  bubbleWheresInPlace(operators, options);
+  removeDuplicateAssociations(model, options.include);
 
   return options;
 };

test/services/query-options.test.js

@@ -3,23 +3,27 @@ import Interface from 'forest-express';
 import QueryOptions from '../../src/services/query-options';
 
 describe('services > query-options', () => {
+  const resetSchema = () => {
+    Interface.Schemas = {
+      schemas: {
+        actor: {
+          idField: 'id',
+          fields: [{ field: 'smartField' }, { field: 'secondSmartField' }],
+        },
+      },
+    };
+  };
+
   const buildModelMock = (dialect) => {
     // Sequelize is created here without connection to a database
     const sequelize = new Sequelize({ dialect });
 
     const modelActor = sequelize.define('actor', {});
     const modelMovie = sequelize.define('movie', {});
 
-    modelActor.belongsTo(modelMovie);
+    resetSchema();
 
-    Interface.Schemas = {
-      schemas: {
-        actor: {
-          idField: 'id',
-          fields: [{ field: 'smartField', search: (query) => { query.include = 'movie'; } }],
-        },
-      },
-    };
+    modelActor.belongsTo(modelMovie);
 
     return modelActor;
   };
@@ -83,20 +87,27 @@ describe('services > query-options', () => {
           expect(loggerErrorSpy).toHaveBeenCalledWith('Cannot search properly on Smart Field smartField', errorThrown);
 
           loggerErrorSpy.mockClear();
+          resetSchema();
         });
       });
 
-      it('should add the search query', async () => {
+      it('should add the search includes', async () => {
         expect.assertions(1);
 
         Interface.Schemas.schemas.actor.fields[0].search = async (query) => {
           await Promise.resolve();
-          query.include = ['movie'];
+          query.include.push('movie');
+        };
+        Interface.Schemas.schemas.actor.fields[1].search = async (query) => {
+          await Promise.resolve();
+          query.include.push('toto');
         };
 
         const options = new QueryOptions(model);
         await options.search('search string', null);
-        expect(options._customerIncludes).toStrictEqual(['movie']);
+        expect(options._customerIncludes).toStrictEqual(['movie', 'toto']);
+
+        resetSchema();
       });
     });
 
@@ -114,6 +125,21 @@ describe('services > query-options', () => {
         expect(loggerErrorSpy).toHaveBeenCalledWith('Cannot search properly on Smart Field smartField', errorThrown);
 
         loggerErrorSpy.mockClear();
+        resetSchema();
+      });
+    });
+
+    describe('when smartField return none array include', () => {
+      it('should transform include to array', async () => {
+        expect.assertions(1);
+
+        Interface.Schemas.schemas.actor.fields[0].search = (query) => { query.include = 'movie'; };
+
+        const options = new QueryOptions(model);
+        await options.search('search string', null);
+        expect(options._customerIncludes).toStrictEqual(['movie']);
+
+        resetSchema();
       });
     });
   });

test/utils/sequelize-compatibility.test.js

@@ -107,7 +107,7 @@ describe('utils > sequelize-compatibility', () => {
       });
     });
 
-    it('shoud add attributes when both sides are defined', () => {
+    it('should add attributes when both sides are defined', () => {
       expect.assertions(1);
 
       const options = postProcess(Model, {
@@ -122,7 +122,7 @@ describe('utils > sequelize-compatibility', () => {
       });
     });
 
-    it('shoud drop attributes when either side is undefined', () => {
+    it('should drop attributes when either side is undefined', () => {
       expect.assertions(1);
 
       const options = postProcess(Model, {
@@ -233,5 +233,23 @@ describe('utils > sequelize-compatibility', () => {
         },
       });
     });
+
+
+    it('should add attributes when sub include is not an array', () => {
+      expect.assertions(1);
+
+      const options = postProcess(Model, {
+        include: [{ as: 'submodelAlias', attributes: ['id'], include: 'subsubmodel1Alias' }],
+      });
+
+      expect(options).toStrictEqual({
+        include: [{
+          as: 'submodelAlias',
+          model: SubModel,
+          attributes: ['id'],
+          include: [{ as: 'subsubmodel1Alias', model: SubSubModel1 }],
+        }],
+      });
+    });
   });
 });

types/index.d.ts

@@ -222,7 +222,7 @@ export interface SmartFieldValueSetter<M extends Sequelize.Model = any> {
 }
 
 export interface SmartFieldSearchQuery {
-  include: string[],
+  include: Sequelize.Includeable | Sequelize.Includeable[],
   where: Sequelize.WhereOptions,
 }