Tested suggestions and highlights

mmoreram · mmoreram · commit d4d2e391db4e · 2020-10-11T16:13:29.000+02:00
- Test suggestions + highlights
- Fixed highlights
diff --git a/dist/apisearch.js b/dist/apisearch.js
diff --git a/dist/apisearch.js.map b/dist/apisearch.js.map
diff --git a/dist/apisearch.min.js b/dist/apisearch.min.js
diff --git a/dist/apisearch.min.js.map b/dist/apisearch.min.js.map
diff --git a/docker-compose/docker-compose-infra.yml b/docker-compose/docker-compose-infra.yml
@@ -5,6 +5,8 @@ services:
     elasticsearch:
         image: "docker.elastic.co/elasticsearch/elasticsearch:7.6.0"
         networks: [apisearch]
+        ports:
+            - 9200:9200
         environment:
             - "ES_JAVA_OPTS=-Xms256m -Xmx256m"
             - "discovery.type=single-node"
@@ -18,9 +20,6 @@ services:
         environment:
             APISEARCH_GOD_TOKEN: 0e4d75ba-c640-44c1-a745-06ee51db4e93
             APISEARCH_ENABLED_PLUGINS: elasticsearch
-            APISEARCH_EVENTS_EXCHANGE: events
-            APISEARCH_TOKENS_UPDATE_EXCHANGE: tokens_update
-            APISEARCH_ASYNC_EVENTS_ADAPTER: in_memory
             ELASTICSEARCH_HOST: elasticsearch
             ELASTICSEARCH_REFRESH_ON_WRITE: 1
 
diff --git a/lib/Model/Item.js b/lib/Model/Item.js
@@ -375,7 +375,7 @@ var Item = /** @class */ (function () {
             item.distance = array.distance;
         }
         if (typeof array.highlights == "object" &&
-            array.distance != null) {
+            array.highlights != null) {
             item.highlights = array.highlights;
         }
         if (typeof array.is_promoted != "undefined" &&
diff --git a/lib/Repository/HttpRepository.js b/lib/Repository/HttpRepository.js
@@ -422,7 +422,7 @@ var HttpRepository = /** @class */ (function (_super) {
             }.bind(this));
             return Result_1.Result.createMultiresults(subresults);
         }
-        return Result_1.Result.create(result.getQueryUUID(), result.getTotalItems(), result.getTotalHits(), result.getAggregations(), result.getSuggests(), this
+        return Result_1.Result.create(result.getQueryUUID(), result.getTotalItems(), result.getTotalHits(), result.getAggregations(), result.getSuggestions(), this
             .transformer
             .fromItems(result.getItems()));
     };
diff --git a/lib/Result/Result.d.ts b/lib/Result/Result.d.ts
@@ -7,7 +7,7 @@ import { ResultAggregations } from "./ResultAggregations";
 export declare class Result {
     private queryUUID;
     private items;
-    private suggests;
+    private suggestions;
     private aggregations;
     private totalItems;
     private totalHits;
@@ -28,12 +28,12 @@ export declare class Result {
      * @param totalItems
      * @param totalHits
      * @param aggregations
-     * @param suggests
+     * @param suggestions
      * @param items
      *
      * @returns {Result}
      */
-    static create(queryUUID: string, totalItems: number, totalHits: number, aggregations: ResultAggregations, suggests: string[], items: Item[]): Result;
+    static create(queryUUID: string, totalItems: number, totalHits: number, aggregations: ResultAggregations, suggestions: string[], items: Item[]): Result;
     /**
      * Create multi results
      *
@@ -109,17 +109,11 @@ export declare class Result {
      */
     hasNotEmptyAggregation(name: string): boolean;
     /**
-     * Add suggest
-     *
-     * @param suggest
-     */
-    addSuggest(suggest: string): void;
-    /**
-     * Get suggests
+     * Get suggestions
      *
      * @return {string[]}
      */
-    getSuggests(): string[];
+    getSuggestions(): string[];
     /**
      * Get query uuid
      *
@@ -147,7 +141,7 @@ export declare class Result {
     /**
      * to array
      *
-     * @return {{query: any, total_items: number, total_hits: number, items:any[], aggregations: any, suggests: string[]}}
+     * @return {{query: any, total_items: number, total_hits: number, items:any[], aggregations: any, suggestions: string[]}}
      */
     toArray(): any;
     /**
diff --git a/lib/Result/Result.js b/lib/Result/Result.js
@@ -15,7 +15,7 @@ var Result = /** @class */ (function () {
      */
     function Result(queryUUID, totalItems, totalHits) {
         this.items = [];
-        this.suggests = [];
+        this.suggestions = [];
         this.subresults = {};
         this.queryUUID = queryUUID;
         this.totalItems = totalItems;
@@ -28,15 +28,15 @@ var Result = /** @class */ (function () {
      * @param totalItems
      * @param totalHits
      * @param aggregations
-     * @param suggests
+     * @param suggestions
      * @param items
      *
      * @returns {Result}
      */
-    Result.create = function (queryUUID, totalItems, totalHits, aggregations, suggests, items) {
+    Result.create = function (queryUUID, totalItems, totalHits, aggregations, suggestions, items) {
         var result = new Result(queryUUID, totalItems, totalHits);
         result.aggregations = aggregations;
-        result.suggests = suggests;
+        result.suggestions = suggestions;
         result.items = items;
         return result;
     };
@@ -163,20 +163,12 @@ var Result = /** @class */ (function () {
             : this.aggregations.hasNotEmptyAggregation(name);
     };
     /**
-     * Add suggest
-     *
-     * @param suggest
-     */
-    Result.prototype.addSuggest = function (suggest) {
-        this.suggests.push(suggest);
-    };
-    /**
-     * Get suggests
+     * Get suggestions
      *
      * @return {string[]}
      */
-    Result.prototype.getSuggests = function () {
-        return this.suggests;
+    Result.prototype.getSuggestions = function () {
+        return this.suggestions;
     };
     /**
      * Get query uuid
@@ -213,7 +205,7 @@ var Result = /** @class */ (function () {
     /**
      * to array
      *
-     * @return {{query: any, total_items: number, total_hits: number, items:any[], aggregations: any, suggests: string[]}}
+     * @return {{query: any, total_items: number, total_hits: number, items:any[], aggregations: any, suggestions: string[]}}
      */
     Result.prototype.toArray = function () {
         var array = {
@@ -224,7 +216,7 @@ var Result = /** @class */ (function () {
             aggregations: this.aggregations == null
                 ? null
                 : this.aggregations.toArray(),
-            suggests: this.suggests
+            suggests: this.suggestions
         };
         if (this.subresults instanceof Object &&
             Object.keys(this.subresults).length) {
@@ -254,7 +246,7 @@ var Result = /** @class */ (function () {
             ? ResultAggregations_1.ResultAggregations.createFromArray(array.aggregations)
             : null, array.suggests
             ? array.suggests
-            : null, array.items instanceof Array
+            : [], array.items instanceof Array
             ? array.items.map(function (itemAsArray) { return Item_1.Item.createFromArray(itemAsArray); })
             : []);
         /**
diff --git a/src/Model/Item.ts b/src/Model/Item.ts
@@ -506,7 +506,7 @@ export class Item {
 
         if (
             typeof array.highlights == "object" &&
-            array.distance != null
+            array.highlights != null
         ) {
             item.highlights = array.highlights;
         }
diff --git a/src/Repository/HttpRepository.ts b/src/Repository/HttpRepository.ts
@@ -413,7 +413,7 @@ export class HttpRepository extends Repository {
             result.getTotalItems(),
             result.getTotalHits(),
             result.getAggregations(),
-            result.getSuggests(),
+            result.getSuggestions(),
             this
                 .transformer
                 .fromItems(result.getItems()),
diff --git a/src/Result/Result.ts b/src/Result/Result.ts
@@ -8,7 +8,7 @@ export class Result {
 
     private queryUUID: string;
     private items: Item[] = [];
-    private suggests: string[] = [];
+    private suggestions: string[] = [];
     private aggregations: ResultAggregations;
     private totalItems: number;
     private totalHits: number;
@@ -39,7 +39,7 @@ export class Result {
      * @param totalItems
      * @param totalHits
      * @param aggregations
-     * @param suggests
+     * @param suggestions
      * @param items
      *
      * @returns {Result}
@@ -49,7 +49,7 @@ export class Result {
         totalItems: number,
         totalHits: number,
         aggregations: ResultAggregations,
-        suggests: string[],
+        suggestions: string[],
         items: Item[],
     ): Result {
         const result = new Result(
@@ -59,7 +59,7 @@ export class Result {
         );
 
         result.aggregations = aggregations;
-        result.suggests = suggests;
+        result.suggestions = suggestions;
         result.items = items;
 
         return result;
@@ -208,21 +208,12 @@ export class Result {
     }
 
     /**
-     * Add suggest
-     *
-     * @param suggest
-     */
-    public addSuggest(suggest: string) {
-        this.suggests.push(suggest);
-    }
-
-    /**
-     * Get suggests
+     * Get suggestions
      *
      * @return {string[]}
      */
-    public getSuggests(): string[] {
-        return this.suggests;
+    public getSuggestions(): string[] {
+        return this.suggestions;
     }
 
     /**
@@ -264,7 +255,7 @@ export class Result {
     /**
      * to array
      *
-     * @return {{query: any, total_items: number, total_hits: number, items:any[], aggregations: any, suggests: string[]}}
+     * @return {{query: any, total_items: number, total_hits: number, items:any[], aggregations: any, suggestions: string[]}}
      */
     public toArray(): any {
         const array: any = {
@@ -275,7 +266,7 @@ export class Result {
             aggregations: this.aggregations == null
                 ? null
                 : this.aggregations.toArray(),
-            suggests: this.suggests,
+            suggests: this.suggestions,
         };
 
         if (
@@ -315,7 +306,7 @@ export class Result {
                 : null,
             array.suggests
                 ? array.suggests
-                : null,
+                : [],
             array.items instanceof Array
                 ? array.items.map((itemAsArray) => Item.createFromArray(itemAsArray))
                 : [],
diff --git a/test/Functional/Apisearch/Query.test.ts b/test/Functional/Apisearch/Query.test.ts
@@ -186,4 +186,45 @@ describe('Apisearch', () => {
                 expect(counters['-2000..1000'].getN()).to.be.equal(4);
             });
     });
+
+    it('should be able to work with suggestions', async() => {
+        const items = [
+            Item.create(ItemUUID.createByComposedUUID('1~item'), {}, {}, {}, [], ['sug1']),
+        ];
+
+        repository.addItems(items);
+        await repository.flush();
+
+        await repository
+            .query(Query
+                .create('su')
+                .enableSuggestions()
+            )
+            .then(result => {
+                expect(result.getSuggestions()).to.be.deep.equal(['sug1']);
+            });
+    });
+
+    it('should be able to work with highlights', async() => {
+        const items = [
+            Item.create(ItemUUID.createByComposedUUID('1~item'), {
+                'name': "item result"
+            }, {}, {
+                'name': 'item result'
+            }),
+        ];
+
+        repository.addItems(items);
+        await repository.flush();
+
+        await repository
+            .query(Query
+                .create('it')
+                .enableHighlights()
+            )
+            .then(result => {
+                expect(result.getFirstItem().getHighlights().name).to.be.equal('<em>item</em> result');
+            });
+    });
+
 });
diff --git a/test/Result/Result.test.ts b/test/Result/Result.test.ts
@@ -25,7 +25,7 @@ describe('Result/', () => {
                 expect(resultAsArray.total_items).to.be.equal(2);
                 expect(result.getItems().length).to.be.equal(0);
                 expect(result.getFirstItem()).to.be.null;
-                expect(result.getSuggests().length).to.be.equal(0);
+                expect(result.getSuggestions().length).to.be.equal(0);
                 expect(result.getAggregations()).to.be.null;
 
                 result = HttpHelper.emulateHttpTransport(result);
@@ -34,7 +34,7 @@ describe('Result/', () => {
                 expect(result.getTotalItems()).to.be.equal(2);
                 expect(result.getItems().length).to.be.equal(0);
                 expect(result.getFirstItem()).to.be.null;
-                expect(result.getSuggests().length).to.be.equal(0);
+                expect(result.getSuggestions().length).to.be.equal(0);
                 expect(result.getAggregations()).to.be.null;
             });
         });
@@ -91,15 +91,15 @@ describe('Result/', () => {
         });
 
         describe('Test suggests', () => {
-            let result = new Result(
+            let result = Result.create(
                 '123',
-                2, 1
+                0, 0, new ResultAggregations(0), ['hola'], []
             );
-            result.addSuggest('hola');
+
             let resultAsArray = result.toArray();
 
             it('Should work properly', () => {
-                expect(result.getSuggests()).to.be.deep.equal(['hola']);
+                expect(result.getSuggestions()).to.be.deep.equal(['hola']);
                 expect(resultAsArray.suggests).to.be.deep.equal(['hola']);
             });
         });
@@ -188,15 +188,15 @@ describe('Result/', () => {
             expect(result.getTotalItems()).to.be.equal(10);
             expect(result.getTotalHits()).to.be.equal(20);
             expect(result.getAggregation('gogo').getName()).to.be.equal('hola');
-            expect(result.getSuggests()).to.be.deep.equal(['sug1', 'sug2']);
+            expect(result.getSuggestions()).to.be.deep.equal(['sug1', 'sug2']);
             expect(result.getItems().length).to.be.equal(2);
             expect(result.getFirstItem().getType()).to.be.equal('product');
             result = HttpHelper.emulateHttpTransport(result);
             expect(result.getQueryUUID()).to.be.equal('123');
             expect(result.getTotalItems()).to.be.equal(10);
             expect(result.getTotalHits()).to.be.equal(20);
             expect(result.getAggregation('gogo').getName()).to.be.equal('hola');
-            expect(result.getSuggests()).to.be.deep.equal(['sug1', 'sug2']);
+            expect(result.getSuggestions()).to.be.deep.equal(['sug1', 'sug2']);
             expect(result.getItems().length).to.be.equal(2);
             expect(result.getFirstItem().getType()).to.be.equal('product');
         });

Original file line number	Diff line number	Diff line change
`@@ -375,7 +375,7 @@ var Item = /** @class */ (function () {`
`375`	`375`	`item.distance = array.distance;`
`376`	`376`	`}`
`377`	`377`	`if (typeof array.highlights == "object" &&`
`378`		`- array.distance != null) {`
	`378`	`+ array.highlights != null) {`
`379`	`379`	`item.highlights = array.highlights;`
`380`	`380`	`}`
`381`	`381`	`if (typeof array.is_promoted != "undefined" &&`
Original file line number	Diff line number	Diff line change
`@@ -422,7 +422,7 @@ var HttpRepository = /** @class */ (function (_super) {`
`422`	`422`	`}.bind(this));`
`423`	`423`	`return Result_1.Result.createMultiresults(subresults);`
`424`	`424`	`}`
`425`		`- return Result_1.Result.create(result.getQueryUUID(), result.getTotalItems(), result.getTotalHits(), result.getAggregations(), result.getSuggests(), this`
	`425`	`+ return Result_1.Result.create(result.getQueryUUID(), result.getTotalItems(), result.getTotalHits(), result.getAggregations(), result.getSuggestions(), this`
`426`	`426`	`.transformer`
`427`	`427`	`.fromItems(result.getItems()));`
`428`	`428`	`};`
Original file line number	Diff line number	Diff line change
`@@ -506,7 +506,7 @@ export class Item {`
`506`	`506`
`507`	`507`	`if (`
`508`	`508`	`typeof array.highlights == "object" &&`
`509`		`- array.distance != null`
	`509`	`+ array.highlights != null`
`510`	`510`	`) {`
`511`	`511`	`item.highlights = array.highlights;`
`512`	`512`	`}`