fix: always include MinimumFieldsToInclude

https://coveord.atlassian.net/browse/JSUI-3525
coveo · Jun 27, 2024 · 718b879 · 718b879
1 parent 0b046a3
commit 718b879
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/src/ui/Base/QueryBuilder.ts b/src/ui/Base/QueryBuilder.ts
@@ -484,7 +484,7 @@ export class QueryBuilder {
 
   public computeFieldsToInclude() {
     if (this.includeRequiredFields || this.fieldsToInclude != null) {
-      return this.requiredFields.concat(this.fieldsToInclude || []);
+      return _.uniq(this.requiredFields.concat(this.fieldsToInclude || []));
     } else {
       return null;
     }

diff --git a/src/ui/ResultList/ResultList.ts b/src/ui/ResultList/ResultList.ts
@@ -1,7 +1,7 @@
 import 'styling/_Result';
 import 'styling/_ResultFrame';
 import 'styling/_ResultList';
-import { chain, compact, contains, each, flatten, map, unique, without, uniqueId, find } from 'underscore';
+import { compact, contains, each, flatten, map, without, uniqueId, find, unique, chain } from 'underscore';
 import {
   IBuildingQueryEventArgs,
   IDuringQueryEventArgs,
@@ -668,6 +668,7 @@ export class ResultList extends Component {
   }
 
   protected handleBuildingQuery(args: IBuildingQueryEventArgs) {
+    args.queryBuilder.addFieldsToInclude(this.getMinimalFieldsToInclude());
     if (this.options.fieldsToInclude != null) {
       // remove the @
       args.queryBuilder.addFieldsToInclude(map(this.options.fieldsToInclude, field => field.substr(1)));

diff --git a/unitTests/ui/ResultListTest.ts b/unitTests/ui/ResultListTest.ts
@@ -569,6 +569,17 @@ export function ResultListTest() {
         );
       });
 
+      it('should also get the minimal amount of fields to include when the option is false', () => {
+        test = Mock.optionsComponentSetup<ResultList, IResultListOptions>(ResultList, {
+          autoSelectFieldsToInclude: false
+        });
+
+        const simulation = Simulate.query(test.env);
+        expect(simulation.queryBuilder.build().fieldsToInclude).toEqual(
+          jasmine.arrayContaining(['author', 'language', 'urihash', 'objecttype', 'collection', 'source', 'language', 'permanentid'])
+        );
+      });
+
       it('should allow to get the auto select fields to include', () => {
         expect(test.cmp.getAutoSelectedFieldsToInclude()).toEqual(
           jasmine.arrayContaining(['author', 'language', 'urihash', 'objecttype', 'collection', 'source', 'language', 'permanentid'])
@@ -692,6 +703,16 @@ export function ResultListTest() {
         expect(simulation.queryBuilder.fieldsToInclude).toContain('field3');
       });
 
+      it('fieldsToInclude should always include minimal amount of required fields', () => {
+        test = Mock.optionsComponentSetup<ResultList, IResultListOptions>(ResultList, {
+          fieldsToInclude: ['@field1', '@field2', '@field3']
+        });
+        const simulation = Simulate.query(test.env);
+        expect(simulation.queryBuilder.fieldsToInclude).toEqual(
+          jasmine.arrayContaining(['author', 'language', 'urihash', 'objecttype', 'collection', 'source', 'language', 'permanentid'])
+        );
+      });
+
       describe('layout', () => {
         it('should correctly listen to populateResultLayout', () => {
           test = Mock.optionsComponentSetup<ResultList, IResultListOptions>(ResultList, {