Remove fuzzy logic from core search command

Author: silvanocerza

commands/core/search.go

@@ -21,9 +21,9 @@ import (
 	"strings"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
+	"github.com/arduino/arduino-cli/arduino/utils"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
-	"github.com/lithammer/fuzzysearch/fuzzy"
 )
 
 // maximumSearchDistance is the maximum Levenshtein distance accepted when using fuzzy search.
@@ -44,6 +44,26 @@ func PlatformSearch(req *rpc.PlatformSearchReq) (*rpc.PlatformSearchResp, error)
 		vid, pid := searchArgs[:4], searchArgs[5:]
 		res = pm.FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid)
 	} else {
+
+		searchArgs := strings.Split(searchArgs, " ")
+
+		match := func(toTest []string) (bool, error) {
+			if len(searchArgs) == 0 {
+				return true, nil
+			}
+
+			for _, t := range toTest {
+				matches, err := utils.Match(t, searchArgs)
+				if err != nil {
+					return false, err
+				}
+				if matches {
+					return matches, nil
+				}
+			}
+			return false, nil
+		}
+
 		for _, targetPackage := range pm.Packages {
 			for _, platform := range targetPackage.Platforms {
 				// discard invalid platforms
@@ -60,15 +80,6 @@ func PlatformSearch(req *rpc.PlatformSearchReq) (*rpc.PlatformSearchResp, error)
 					continue
 				}
 
-				if searchArgs == "" {
-					if allVersions {
-						res = append(res, platform.GetAllReleases()...)
-					} else {
-						res = append(res, platformRelease)
-					}
-					continue
-				}
-
 				// Gather all strings that can be used for searching
 				toTest := []string{
 					platform.String(),
@@ -82,32 +93,18 @@ func PlatformSearch(req *rpc.PlatformSearchReq) (*rpc.PlatformSearchResp, error)
 					toTest = append(toTest, board.Name)
 				}
 
-				// Removes some chars from query strings to enhance results
-				cleanSearchArgs := strings.Map(func(r rune) rune {
-					switch r {
-					case '_':
-					case '-':
-					case ' ':
-						return -1
-					}
-					return r
-				}, searchArgs)
+				// Search
+				if ok, err := match(toTest); err != nil {
+					return nil, err
+				} else if !ok {
+					continue
+				}
 
-				// Fuzzy search
-				for _, arg := range []string{searchArgs, cleanSearchArgs} {
-					for _, rank := range fuzzy.RankFindNormalizedFold(arg, toTest) {
-						// Accepts only results that close to the searched terms
-						if rank.Distance < maximumSearchDistance {
-							if allVersions {
-								res = append(res, platform.GetAllReleases()...)
-							} else {
-								res = append(res, platformRelease)
-							}
-							goto nextPlatform
-						}
-					}
+				if allVersions {
+					res = append(res, platform.GetAllReleases()...)
+				} else {
+					res = append(res, platformRelease)
 				}
-			nextPlatform:
 			}
 		}
 	}

test/test_core.py

@@ -76,12 +76,33 @@ def get_platforms(stdout):
     assert "1.0.5" in platforms["Retrokits-RK002:arm"]
     assert "1.0.6" in platforms["Retrokits-RK002:arm"]
 
-    # Search using a board name
+    # Search using board names
     result = run_command(f"core search myboard --all --additional-urls={url} --format json")
     assert result.ok
     platforms = get_platforms(result.stdout)
     assert "1.2.3" in platforms["Package:x86"]
 
+    def run_search(search_args, expected_ids):
+        res = run_command(f"core search --format json {search_args}")
+        assert res.ok
+        data = json.loads(res.stdout)
+        platform_ids = [p["ID"] for p in data]
+        for platform_id in expected_ids:
+            assert platform_id in platform_ids
+
+    run_search("mkr1000", ["arduino:samd"])
+    run_search("mkr 1000", ["arduino:samd"])
+
+    run_search("yún", ["arduino:avr"])
+    run_search("yùn", ["arduino:avr"])
+    run_search("yun", ["arduino:avr"])
+
+    run_search("nano", ["arduino:avr", "arduino:megaavr", "arduino:samd", "arduino:mbed"])
+    run_search("nano 33", ["arduino:samd", "arduino:mbed"])
+    run_search("nano ble", ["arduino:mbed"])
+    run_search("ble", ["arduino:mbed"])
+    run_search("ble nano", ["arduino:mbed"])
+
 
 def test_core_search_no_args(run_command, httpserver):
     """
@@ -146,32 +167,6 @@ def test_core_search_no_args(run_command, httpserver):
     assert len(platforms) == num_platforms
 
 
-def test_core_search_fuzzy(run_command):
-    assert run_command("update")
-
-    def run_fuzzy_search(search_args, expected_ids):
-        res = run_command(f"core search --format json {search_args}")
-        assert res.ok
-        data = json.loads(res.stdout)
-        platform_ids = [p["ID"] for p in data]
-        for platform_id in expected_ids:
-            assert platform_id in platform_ids
-
-    run_fuzzy_search("mkr1000", ["arduino:samd"])
-    run_fuzzy_search("mkr 1000", ["arduino:samd"])
-
-    run_fuzzy_search("yún", ["arduino:avr"])
-    run_fuzzy_search("yùn", ["arduino:avr"])
-    run_fuzzy_search("yun", ["arduino:avr"])
-
-    run_fuzzy_search("nano", ["arduino:avr", "arduino:megaavr", "arduino:samd", "arduino:mbed"])
-    run_fuzzy_search("nano33", ["arduino:samd", "arduino:mbed"])
-    run_fuzzy_search("nano 33", ["arduino:samd", "arduino:mbed"])
-    run_fuzzy_search("nano ble", ["arduino:mbed"])
-    run_fuzzy_search("ble", ["arduino:mbed"])
-    run_fuzzy_search("ble nano", [])
-
-
 def test_core_updateindex_url_not_found(run_command, httpserver):
     assert run_command("core update-index")