Remove fuzzy logic from lib search command

arduino · silvanocerza · Mar 16, 2021 · Mar 15, 2021 · Mar 15, 2021 · Mar 15, 2021
commit 249fd5a91bb6b9c1407ba2171e84db7887a167ca
diff --git a/commands/lib/search.go b/commands/lib/search.go
@@ -22,9 +22,9 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
+	"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"
 	semver "go.bug.st/relaxed-semver"
 )
 
@@ -43,44 +43,33 @@ func searchLibrary(req *rpc.LibrarySearchReq, lm *librariesmanager.LibrariesMana
 	res := []*rpc.SearchedLibrary{}
 	status := rpc.LibrarySearchStatus_success
    
-	// If the query is empty all libraries are returned
-	if strings.Trim(query, " ") == "" {
-		for _, lib := range lm.Index.Libraries {
-			res = append(res, indexLibraryToRPCSearchLibrary(lib))
+	searchArgs := strings.Split(strings.Trim(query, " "), " ")
+
+	match := func(toTest []string) (bool, error) {
+		if len(searchArgs) == 0 {
+			return true, nil
 		}
-		return &rpc.LibrarySearchResp{Libraries: res, Status: status}, nil
-	}
 
-	// maximumSearchDistance is the maximum Levenshtein distance accepted when using fuzzy search.
-	// This value is completely arbitrary and picked randomly.
-	maximumSearchDistance := 150
-	// Use a lower distance for shorter query or the user might be flooded with unrelated results
-	if len(query) <= 4 {
-		maximumSearchDistance = 40
+		for _, t := range toTest {
+			matches, err := utils.Match(t, searchArgs)
+			if err != nil {
+				return false, err
+			}
+			if matches {
+				return matches, nil
+			}
+		}
+		return false, nil
 	}
 
-	// Removes some chars from query strings to enhance results
-	cleanQuery := strings.Map(func(r rune) rune {
-		switch r {
-		case '_':
-		case '-':
-		case ' ':
-			return -1
-		}
-		return r
-	}, query)
 	for _, lib := range lm.Index.Libraries {
-		// Use both uncleaned and cleaned query
-		for _, q := range []string{query, cleanQuery} {
-			toTest := []string{lib.Name, lib.Latest.Paragraph, lib.Latest.Sentence}
-			for _, rank := range fuzzy.RankFindNormalizedFold(q, toTest) {
-				if rank.Distance < maximumSearchDistance {
-					res = append(res, indexLibraryToRPCSearchLibrary(lib))
-					goto nextLib
-				}
-			}
+		toTest := []string{lib.Name, lib.Latest.Paragraph, lib.Latest.Sentence}
+		if ok, err := match(toTest); err != nil {
+			return nil, err
+		} else if !ok {
+			continue
 		}
-	nextLib:
+		res = append(res, indexLibraryToRPCSearchLibrary(lib))
 	}
 
 	return &rpc.LibrarySearchResp{Libraries: res, Status: status}, nil

diff --git a/commands/lib/search_test.go b/commands/lib/search_test.go
@@ -39,7 +39,7 @@ func TestSearchLibrarySimilar(t *testing.T) {
 
 	req := &rpc.LibrarySearchReq{
 		Instance: &rpc.Instance{Id: 1},
-		Query:    "ardino",
+		Query:    "arduino",
 	}
 
 	resp, err := searchLibrary(req, lm)

diff --git a/test/test_lib.py b/test/test_lib.py
@@ -414,7 +414,7 @@ def test_lib_ops_caseinsensitive(run_command):
 
 
 def test_search(run_command):
-    assert run_command("lib update-index")
+    assert run_command("update")
 
     result = run_command("lib search --names")
     assert result.ok
@@ -433,29 +433,6 @@ def test_search(run_command):
     result = run_command("lib search --names")
     assert result.ok
 
-    # Search for a specific target
-    result = run_command("lib search --names ArduinoJson --format json")
-    assert result.ok
-    libs_json = json.loads(result.stdout)
-    assert len(libs_json.get("libraries")) >= 1
-
-
-def test_search_paragraph(run_command):
-    """
-    Search for a string that's only present in the `paragraph` field
-    within the index file.
-    """
-    assert run_command("lib update-index")
-    result = run_command('lib search "A simple and efficient JSON library" --names --format json')
-    assert result.ok
-    data = json.loads(result.stdout)
-    libraries = [l["name"] for l in data["libraries"]]
-    assert "ArduinoJson" in libraries
-
-
-def test_lib_search_fuzzy(run_command):
-    run_command("update")
-
     def run_search(search_args, expected_libraries):
         res = run_command(f"lib searc
9EE0
h --names --format json {search_args}")
         assert res.ok
@@ -468,7 +445,6 @@ def run_search(search_args, expected_libraries):
     run_search("Arduino mkr iot carrier", ["Arduino_MKRIoTCarrier"])
     run_search("mkr iot carrier", ["Arduino_MKRIoTCarrier"])
     run_search("mkriotcarrier", ["Arduino_MKRIoTCarrier"])
-    run_search("Arduinomkriotcarrier", ["Arduino_MKRIoTCarrier"])
 
     run_search(
         "dht",
@@ -481,10 +457,23 @@ def run_search(search_args, expected_libraries):
     run_search("sensor dht", [])
 
     run_search("arduino json", ["ArduinoJson", "Arduino_JSON"])
-    run_search("arduinojson", ["ArduinoJson", "Arduino_JSON"])
+    run_search("arduinojson", ["ArduinoJson"])
     run_search("json", ["ArduinoJson", "Arduino_JSON"])
 
 
+def test_search_paragraph(run_command):
+    """
+    Search for a string that's only present in the `paragraph` field
+    within the index file.
+    """
+    assert run_command("lib update-index")
+    result = run_command('lib search "A simple and efficient JSON library" --names --format json')
+    assert result.ok
+    data = json.loads(result.stdout)
+    libraries = [l["name"] for l in data["libraries"]]
+    assert "ArduinoJson" in libraries
+
+
 def test_lib_list_with_updatable_flag(run_command):
     # Init the environment explicitly
     run_command("lib update-index")