🐛 fix special character in search query to fix fuzzing check (#1241)

* fix fuzzing path separator Signed-off-by: Asra Ali <[email protected]> * add comment Signed-off-by: Asra Ali <[email protected]>
ossf · Nov 15, 2021 · 5950fde · 5950fde
1 parent 72e20a0
commit 5950fde
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/clients/githubrepo/search.go b/clients/githubrepo/search.go
@@ -59,7 +59,11 @@ func (handler *searchHandler) buildQuery(request clients.SearchRequest) (string,
 	}
 	var queryBuilder strings.Builder
 	if _, err := queryBuilder.WriteString(
-		fmt.Sprintf("%s repo:%s/%s", request.Query, handler.owner, handler.repo)); err != nil {
+		// The fuzzing check searches for GitHub URI, e.g. `github.com/org/repo`. The forward slash is one special character
+		// that should be replaced with a space.
+		// See https://docs.github.com/en/search-github/searching-on-github/searching-code#considerations-for-code-search
+		// for reference.
+		fmt.Sprintf("%s repo:%s/%s", strings.ReplaceAll(request.Query, "/", " "), handler.owner, handler.repo)); err != nil {
 		return "", fmt.Errorf("WriteString: %w", err)
 	}
 	if request.Filename != "" {

diff --git a/clients/githubrepo/search_test.go b/clients/githubrepo/search_test.go
@@ -80,6 +80,17 @@ func TestBuildQuery(t *testing.T) {
 			},
 			expectedQuery: "testquery repo:testowner/testrepo in:file filename:filename1.txt path:dir1/dir2",
 		},
+		{
+			name:  "WithFilenameAndPathWithSeparator",
+			owner: "testowner",
+			repo:  "testrepo",
+			searchReq: clients.SearchRequest{
+				Query:    "testquery/query",
+				Filename: "filename1.txt",
+				Path:     "dir1/dir2",
+			},
+			expectedQuery: "testquery query repo:testowner/testrepo in:file filename:filename1.txt path:dir1/dir2",
+		},
 	}
 
 	for _, testcase := range testcases {