Merge pull request #28 from netgrif/NAE-1614

[NAE-1614] Advanced search substring query

Author: tuplle

projects/netgrif-components-core/src/lib/search/models/category/case/case-dataset.ts

@@ -260,13 +260,13 @@ export class CaseDataset extends Category<Datafield> implements AutocompleteOpti
             case 'file':
             case 'fileList':
                 return resolver.getIndex(datafield.fieldId, SearchIndex.FILE_NAME,
-                    this.isSelectedOperator(Equals) || this.isSelectedOperator(NotEquals));
+                    this.isSelectedOperator(Equals) || this.isSelectedOperator(NotEquals) || this.isSelectedOperator(Substring));
             case 'user':
             case 'userList':
                 return resolver.getIndex(datafield.fieldId, SearchIndex.USER_ID);
             default:
                 return resolver.getIndex(datafield.fieldId, SearchIndex.FULLTEXT,
-                    this.isSelectedOperator(Equals) || this.isSelectedOperator(NotEquals));
+                    this.isSelectedOperator(Equals) || this.isSelectedOperator(NotEquals) || this.isSelectedOperator(Substring));
         }
     }
 
@@ -417,10 +417,6 @@ export class CaseDataset extends Category<Datafield> implements AutocompleteOpti
         return value;
     }
 
-    protected isSelectedOperator(operatorClass: Type<any>): boolean {
-        return this.selectedOperator === this._operatorService.getOperator(operatorClass);
-    }
-
     serializeClass(): Categories | string {
         return Categories.CASE_DATASET;
     }

projects/netgrif-components-core/src/lib/search/models/category/case/case-simple-dataset.ts

@@ -86,14 +86,14 @@ export class CaseSimpleDataset extends NoConfigurationCategory<string> {
                 break;
             case 'file':
             case 'fileList':
-                this._elasticKeyword = resolver.getIndex(this._fieldId, SearchIndex.FILE_NAME);
+                this._elasticKeyword = resolver.getIndex(this._fieldId, SearchIndex.FILE_NAME, this.isSelectedOperator(Substring));
                 break;
             case 'user':
             case 'userList':
                 this._elasticKeyword = resolver.getIndex(this._fieldId, SearchIndex.USER_ID);
                 break;
             default:
-                this._elasticKeyword = resolver.getIndex(this._fieldId, SearchIndex.FULLTEXT);
+                this._elasticKeyword = resolver.getIndex(this._fieldId, SearchIndex.FULLTEXT, this.isSelectedOperator(Substring));
         }
     }
 

projects/netgrif-components-core/src/lib/search/models/category/case/case-title.spec.ts

@@ -5,14 +5,21 @@ import {configureCategory} from '../../../../utility/tests/utility/configure-cat
 import {Equals} from '../../operator/equals';
 import {Categories} from '../categories';
 import {Operators} from '../../operator/operators';
+import {Substring} from '../../operator/substring';
+import {CaseSearch} from './case-search.enum';
+import {SearchIndexResolverService} from '../../../search-keyword-resolver-service/search-index-resolver.service';
+import {OptionalDependencies} from '../../../category-factory/optional-dependencies';
 
 describe('CaseTitle', () => {
     let category: CaseTitle;
     let operatorService: OperatorService;
+    let deps: OptionalDependencies;
+
 
     beforeEach(() => {
         operatorService = new OperatorService(new OperatorResolverService());
-        category = new CaseTitle(operatorService, null);
+        deps = {searchIndexResolver: new SearchIndexResolverService()} as OptionalDependencies;
+        category = new CaseTitle(operatorService, null, deps);
     });
 
     afterEach(() => {
@@ -64,4 +71,10 @@ describe('CaseTitle', () => {
             done();
         });
     });
+
+    it('should use keyword index', () => {
+        configureCategory(category, operatorService, Substring, ['foo']);
+        const predicate = category.generatePredicate(['input']);
+        expect(predicate.query.value.includes(`${CaseSearch.TITLE}${deps.searchIndexResolver.KEYWORD}`)).toBeTrue();
+    });
 });

projects/netgrif-components-core/src/lib/search/models/category/case/case-title.ts

@@ -8,12 +8,13 @@ import {NotEquals} from '../../operator/not-equals';
 import {Like} from '../../operator/like';
 import {Categories} from '../categories';
 import {CaseSearch} from './case-search.enum';
+import {OptionalDependencies} from '../../../category-factory/optional-dependencies';
 
 export class CaseTitle extends NoConfigurationCategory<string> {
 
     private static readonly _i18n = 'search.category.case.title';
 
-    constructor(operators: OperatorService, logger: LoggerService) {
+    constructor(operators: OperatorService, logger: LoggerService, protected _optionalDependencies?: OptionalDependencies) {
         super([CaseSearch.TITLE],
             [
                 operators.getOperator(Substring),
@@ -32,10 +33,19 @@ export class CaseTitle extends NoConfigurationCategory<string> {
     }
 
     duplicate(): CaseTitle {
-        return new CaseTitle(this._operatorService, this._log);
+        return new CaseTitle(this._operatorService, this._log, this._optionalDependencies);
     }
 
     serializeClass(): Categories | string {
         return Categories.CASE_TITLE;
     }
+
+    protected get elasticKeywords(): Array<string> {
+        if (!!this._optionalDependencies) {
+            const resolver = this._optionalDependencies.searchIndexResolver;
+            return [resolver.getCoreIndex(CaseSearch.TITLE, this.isSelectedOperator(Substring))];
+        } else {
+            return this._elasticKeywords;
+        }
+    }
 }

projects/netgrif-components-core/src/lib/search/models/category/case/case-visual-id.spec.ts

@@ -5,14 +5,20 @@ import {configureCategory} from '../../../../utility/tests/utility/configure-cat
 import {Equals} from '../../operator/equals';
 import {Categories} from '../categories';
 import {Operators} from '../../operator/operators';
+import {Substring} from '../../operator/substring';
+import {SearchIndexResolverService} from '../../../search-keyword-resolver-service/search-index-resolver.service';
+import {CaseSearch} from './case-search.enum';
+import {OptionalDependencies} from '../../../category-factory/optional-dependencies';
 
 describe('CaseVisualId', () => {
     let category: CaseVisualId;
     let operatorService: OperatorService;
+    let deps: OptionalDependencies;
 
     beforeEach(() => {
         operatorService = new OperatorService(new OperatorResolverService());
-        category = new CaseVisualId(operatorService, null);
+        deps = {searchIndexResolver: new SearchIndexResolverService()} as OptionalDependencies;
+        category = new CaseVisualId(operatorService, null, deps);
     });
 
     afterEach(() => {
@@ -64,4 +70,10 @@ describe('CaseVisualId', () => {
             done();
         });
     });
+
+    it('should use keyword index', () => {
+        configureCategory(category, operatorService, Substring, ['foo']);
+        const predicate = category.generatePredicate(['input']);
+        expect(predicate.query.value.includes(`${CaseSearch.VISUAL_ID}${deps.searchIndexResolver.KEYWORD}`)).toBeTrue();
+    });
 });

projects/netgrif-components-core/src/lib/search/models/category/case/case-visual-id.ts

@@ -7,12 +7,13 @@ import {Equals} from '../../operator/equals';
 import {NotEquals} from '../../operator/not-equals';
 import {Categories} from '../categories';
 import {CaseSearch} from './case-search.enum';
+import {OptionalDependencies} from '../../../category-factory/optional-dependencies';
 
 export class CaseVisualId extends NoConfigurationCategory<string> {
 
     private static readonly _i18n = 'search.category.case.visualId';
 
-    constructor(operators: OperatorService, logger: LoggerService) {
+    constructor(operators: OperatorService, logger: LoggerService, protected _optionalDependencies?: OptionalDependencies) {
         super([CaseSearch.VISUAL_ID],
             [operators.getOperator(Substring), operators.getOperator(Equals), operators.getOperator(NotEquals)],
             `${CaseVisualId._i18n}.name`,
@@ -26,10 +27,19 @@ export class CaseVisualId extends NoConfigurationCategory<string> {
     }
 
     duplicate(): CaseVisualId {
-        return new CaseVisualId(this._operatorService, this._log);
+        return new CaseVisualId(this._operatorService, this._log, this._optionalDependencies);
     }
 
     serializeClass(): Categories | string {
         return Categories.CASE_VISUAL_ID;
     }
+
+    protected get elasticKeywords(): Array<string> {
+        if (!!this._optionalDependencies) {
+            const resolver = this._optionalDependencies.searchIndexResolver;
+            return [resolver.getCoreIndex(CaseSearch.VISUAL_ID, this.isSelectedOperator(Substring))];
+        } else {
+            return this._elasticKeywords;
+        }
+    }
 }

projects/netgrif-components-core/src/lib/search/models/category/category.ts

@@ -16,6 +16,7 @@ import {Operators} from '../operator/operators';
 import {ofVoid} from '../../../utility/of-void';
 import {FilterTextSegment} from '../persistance/filter-text-segment';
 import {DATE_FORMAT_STRING, DATE_TIME_FORMAT_STRING} from '../../../moment/time-formats';
+import {Type} from '@angular/core';
 
 /**
  * The top level of abstraction in search query generation. Represents a set of indexed fields that can be searched.
@@ -323,7 +324,7 @@ export abstract class Category<T> {
         if (!this.isOperatorSelected()) {
             throw new Error('Category cannot generate a Query if no Operator is selected');
         }
-        return this._operatorFormControl.value.createQuery(this._elasticKeywords, userInput as unknown as Array<string>);
+        return this._operatorFormControl.value.createQuery(this.elasticKeywords, userInput as unknown as Array<string>);
     }
 
     /**
@@ -667,4 +668,13 @@ export abstract class Category<T> {
         }
         return {segment, bold: true};
     }
+
+    /**
+     * Checks for selected operator
+     * @param operatorClass the operator to be checked
+     * @return boolean of the statement
+     */
+    protected isSelectedOperator(operatorClass: Type<any>): boolean {
+        return this.selectedOperator === this._operatorService.getOperator(operatorClass);
+    }
 }

projects/netgrif-components-core/src/lib/search/models/operator/substring.ts

@@ -16,8 +16,8 @@ export class Substring extends Operator<string> {
         // TODO IMPROVEMENT 27.4.2020 - we could use regular expressions to search for substrings which would solve the unintuitive
         //  behavior that occurs when we search for strings that contain spaces. We need to escape the input string in a special way
         //  if we choose to do this
-        const escapedValue = Operator.escapeInput(args[0]).value;
-        return Operator.forEachKeyword(elasticKeywords, keyword => new Query(`(${keyword}:\\*${escapedValue}\\*)`));
+        const escapedValue = Operator.escapeInput(args[0]).value.replace(' ', '\\ ');
+        return Operator.forEachKeyword(elasticKeywords, keyword => new Query(`(${keyword}:*${escapedValue}*)`));
     }
 
     getOperatorNameTemplate(): Array<string> {

projects/netgrif-components-core/src/lib/search/search-keyword-resolver-service/search-index-resolver.service.ts

@@ -14,7 +14,10 @@ import {SearchIndex} from '../models/search-index';
   providedIn: 'root'
 })
 export class SearchIndexResolverService {
-  constructor() { }
+
+    public readonly KEYWORD = '.keyword';
+
+    constructor() { }
 
     /**
      * Constructs the index name for the specified field.
@@ -28,6 +31,20 @@ export class SearchIndexResolverService {
      * @returns the full name of the specified index
      */
   public getIndex(dataFieldIdentifier: string, index: SearchIndex, keyword = false): string {
-      return `dataSet.${dataFieldIdentifier}.${index}${keyword ? '.keyword' : ''}`;
+      return `dataSet.${dataFieldIdentifier}.${index}${keyword ? this.KEYWORD : ''}`;
+  }
+
+    /**
+     * Constructs the index name for the specified core field.
+     *
+     * Note that almost all combinations are valid and will not throw an error when used to query the database, but not all combinations are
+     * used by the application engine. The {@link SearchIndex} class has some information about which field types map to which indices, but
+     * you should consult the backend documentation for more reliable information.
+     * @param index the queried index
+     * @param keyword whether the keyword of a TEXT index should be queried
+     * @returns the full name of the specified index
+     */
+  public getCoreIndex(index: string, keyword = false): string {
+      return `${index}${keyword ? this.KEYWORD : ''}`;
   }
 }

projects/netgrif-components-core/src/lib/search/search-service/search.service.ts

@@ -257,7 +257,8 @@ export class SearchService implements OnDestroy {
      * @param searchedSubstring value that should be searched on all full text fields
      */
     public setFullTextFilter(searchedSubstring: string): void {
-        this._fullTextFilter = new SimpleFilter('', this._baseFilter.type, {fullText: searchedSubstring});
+        const whiteSpacedSubstring = searchedSubstring.replace(' ', '\\ ');
+        this._fullTextFilter = new SimpleFilter('', this._baseFilter.type, {fullText: whiteSpacedSubstring});
         this.updateActiveFilter();
     }