Add “suggest” to the whitelisted ES search body keys

[pierreminik]

What does this PR do ?

Adds the suggest keyword to whitelisted ES search body.

[codecov]

Codecov Report

Merging #2019 (ca733a3) into 2-dev (827ae8d) will not change coverage.
The diff coverage is 100.00%.

❗ Current head ca733a3 differs from pull request most recent head 255a4b5. Consider uploading reports for the commit 255a4b5 to get more accurate results

@@           Coverage Diff           @@
##            2-dev    #2019   +/-   ##
=======================================
  Coverage   93.83%   93.83%           
=======================================
  Files         123      123           
  Lines        7727     7727           
=======================================
  Hits         7251     7251           
  Misses        476      476           

Impacted Files	Coverage Δ
lib/api/controllers/documentController.js	97.54% <ø> (ø)
lib/service/storage/elasticsearch.js	92.37% <ø> (ø)
lib/api/funnel.js	96.24% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 827ae8d...255a4b5. Read the comment docs.

[Aschen]

Thanks for your contribution, it's very much appreciated ;-)

Can you also update the documentation to reflect this change ? https://github.com/kuzzleio/kuzzle/blob/master/doc/2/guides/main-concepts/querying/index.md

Also since the result of the suggest keyword are not including in the hits array, you will need to add it in the return of the controller action here: https://github.com/kuzzleio/kuzzle/blob/master/lib/api/controllers/documentController.js#L93

[pierreminik]

I hope I've done it correctly. 😊

[Aschen]

If you could just add/modify an unit test in the document controller, verifying that the suggest property from the Elasticsearch result is correctly returned in the document controller action it would be perfect 👍

[pierreminik]

I haven't quite catched how the mocking works so I'm not sure if it's the implementation failing or test not properly test up. I'll figure it out.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[pierreminik]

It seems to go through now. I'm not sure if the suggest keyword should be available when doing a scroll besides the search?

[Aschen]

It seems to go through now. I'm not sure if the suggest keyword should be available when doing a scroll besides the search?

Since the _formatSearchResult is used by both search and scroll it's already available in scroll as well 👍