Feature: Support for Search API Spellcheck

Added search_api_spellcheck to "supported features" in Open Search backend.

All new features must go into the 2.x branch.

Needs reroll for 2.x branch.

@kim.pepper Aah, okay. I will re-roll for 2.x. I will put the last and final patch for 1.x here, so that any one using 1.x can patch their modules and use this functionality.

In this patch, I added a data type spell check which is needed for having an aggregated field of type Open Search spell check.

@kim.pepper Here's a patch re-rolled to 2.x

The last submitted patch, 9: add_spellcheck_compatiblity--3339329-7-2x.patch, failed testing. View results →
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

Looks great. Just a couple of nitpicks:

1. +++ b/src/SearchAPI/Query/SpellCheckBuilder.php
   @@ -0,0 +1,50 @@
   +      // @see https://opensearch.org/docs/1.3/opensearch/search/did-you-mean/
   

   Should link to latest docs?

2. +++ b/src/SearchAPI/Query/SpellCheckResultParser.php
   @@ -0,0 +1,63 @@
   +      // Suggestions are build exposing there suggest per fulltext configured
   

   Grammar fix: Suggestions are *built* exposing *their*

Also, we need tests.

@kim.pepper thank you for the feedback :-D

I have added the updated doc link and Grammar fixes.

I will try to work on tests soon.

Rerolled patch #9 with Drupal 2.x.

The last submitted patch, 13: add_spellcheck_compatiblity--3339329-13-2x.patch, failed testing. View results →
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

The last submitted patch, 15: add_spellcheck_compatiblity--3339329-14-2x.patch, failed testing. View results →
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

@Medha Kumari Patch https://www.drupal.org/project/search_api_opensearch/issues/3339329#comm... ✨ Feature: Support for Search API Spellcheck Needs work is rolled for Search API Open Search 2.x branch

Adding needs tests tag :-)

Re-rolling patch add_spellcheck_compatiblity--3339329-13-2x.patch for 2.0.0-beta3.

Ahh... added the two new files in that last re-roll.

Can you convert this to a MR now please? 🙏🏻

Re-rolling patch 21. It was missing the SpellcheckTextDataType file.

Re: #22 Can you convert it to a MR now please?

Not sure why but composer didn't seem to like that patch #23, saying it had a malformed line. Tried locally and this applied ok.

Created merge request (finally got around to this - sorry for the delay):
https://git.drupalcode.org/project/search_api_opensearch/-/merge_request...

There are code style and test fails in the MR.

The tests are green now (except for some code style failures in other classes unrelated to this change).

I've tried out the code in this PR locally, and it's working well for me.

Left some feedback.

Thanks for the review kim.pepper.

I've added unit tests for the new classes SpellCheckBuilder and SpellCheckResultParser. While doing that I realised that the builder was getting passed data it never used, so I've cut down the params to SpellCheckBuilder::setSpellCheckQuery(). I also found a bug in SpellCheckResultParser::parseSpellCheckResult(), where suggestions that appeared early in the response from OpenSearch would be ignored in favour of later ones with the same score. I've replaced the logic there with code that won't ignore any suggestions, and ranks by both score and frequency to find the best ones.

I'm going to work on a functional test now.

I've added a kernel test to cover the spell check feature. How's that looking now?

Hiding some files

That call to sleep() actually came over in some code I copied from OpenSearchBackendTest. I've swopped it out in both that test and the new SpellCheckTest for a call to refresh the index. The tests both pass, and now they run faster, which is nice.

Committed to 2.x and 3.x thanks!

Excellent - thankyou!

Automatically closed - issue fixed for 2 weeks with no activity.