perf(search): Resolved issue with SearchKit

CodeEdit/Features/Documents/WorkspaceDocument+Find.swift

@@ -14,10 +14,11 @@ extension WorkspaceDocument.SearchState {
     ///
     /// - Returns: A modified search term according to the specified search mode.
     func getSearchTerm(_ query: String) -> String {
-        let newQuery = caseSensitive ? query : query.lowercased()
+        let newQuery = stripSpecialCharacters(from: (caseSensitive ? query : query.lowercased()))
         guard let mode = selectedMode.third else {
             return newQuery
         }
+
         switch mode {
         case .Containing:
             return "*\(newQuery)*"
@@ -30,6 +31,16 @@ extension WorkspaceDocument.SearchState {
         }
     }
 
+    func stripSpecialCharacters(from string: String) -> String {
+        let regex = try? NSRegularExpression(pattern: "[^a-zA-Z0-9]+", options: .caseInsensitive)
+        return regex!.stringByReplacingMatches(
+            in: string,
+            options: [],
+            range: NSRange(location: 0, length: string.utf16.count),
+            withTemplate: "*"
+        )
+    }
+
     /// Generates a regular expression pattern based on the specified query and search mode.
     ///
     /// - Parameter query: The original user query string.
@@ -41,21 +52,23 @@ extension WorkspaceDocument.SearchState {
     /// Except its using the word boundary anchor(\b) instead of the asterisk(\*).
     /// This is needed to highlight the search results correctly.
     func getRegexPattern(_ query: String) -> String {
+        let newQuery = NSRegularExpression.escapedPattern(for: query.trimmingCharacters(in: .whitespacesAndNewlines))
+
         guard let mode = selectedMode.third else {
-            return query
+            return newQuery
         }
 
         switch mode {
         case .Containing:
-            return "\(query)"
+            return "\(newQuery)"
         case .StartingWith:
-            return "\\b\(query)"
+            return "\\b\(newQuery)"
         case .EndingWith:
-            return "\(query)\\b"
+            return "\(newQuery)\\b"
         case .MatchingWord:
-            return "\\b\(query)\\b"
+            return "\\b\(newQuery)\\b"
         default:
-            return query
+            return newQuery
         }
     }
 
@@ -175,7 +188,7 @@ extension WorkspaceDocument.SearchState {
         // Attempt to create a regular expression from the provided query
         guard let regex = try? NSRegularExpression(
             pattern: query,
-            options: caseSensitive ? [] : [.caseInsensitive]
+            options: caseSensitive ? [] : .caseInsensitive
         ) else {
             await setStatus(.failed(errorMessage: "Invalid regular expression."))
             return

CodeEditTests/Features/Documents/WorkspaceDocument+SearchState+FindTests.swift

@@ -47,9 +47,9 @@ final class FindTests: XCTestCase {
 
         for index in 0..<fileURLs.count {
             if index % 2 == 0 {
-                try String("Loren Ipsum").write(to: fileURLs[index], atomically: true, encoding: .utf8)
+                try String("Loren Ipsum.").write(to: fileURLs[index], atomically: true, encoding: .utf8)
             } else {
-                try String("Aperiam asperiores").write(to: fileURLs[index], atomically: true, encoding: .utf8)
+                try String("Aperiam*asperiores").write(to: fileURLs[index], atomically: true, encoding: .utf8)
             }
         }
 
@@ -89,6 +89,52 @@ final class FindTests: XCTestCase {
         try? FileManager.default.removeItem(at: directory)
     }
 
+    func testGetSearchTerm() {
+        let query = "test*/Quer@#y"
+
+        searchState.selectedMode[2] = .Containing
+        XCTAssertEqual(searchState.getSearchTerm(query), "*test*quer*y*")
+
+        searchState.selectedMode[2] = .StartingWith
+        XCTAssertEqual(searchState.getSearchTerm(query), "test*quer*y*")
+
+        searchState.selectedMode[2] = .EndingWith
+        XCTAssertEqual(searchState.getSearchTerm(query), "*test*quer*y")
+
+        searchState.selectedMode[2] = .MatchingWord
+        XCTAssertEqual(searchState.getSearchTerm(query), "test*quer*y")
+
+        searchState.caseSensitive = true
+        XCTAssertEqual(searchState.getSearchTerm(query), "test*Quer*y")
+    }
+
+    func testStripSpecialCharacters() {
+        let string = "test!@#Query"
+        let strippedString = searchState.stripSpecialCharacters(from: string)
+        XCTAssertEqual(strippedString, "test*Query")
+    }
+
+    func testGetRegexPattern() {
+        let query = "@(test. !*#Query"
+
+        searchState.selectedMode[2] = .Containing
+        XCTAssertEqual(searchState.getRegexPattern(query), "@\\(test\\. !\\*#Query")
+
+        searchState.selectedMode[2] = .StartingWith
+        XCTAssertEqual(searchState.getRegexPattern(query), "\\b@\\(test\\. !\\*#Query")
+
+        searchState.selectedMode[2] = .EndingWith
+        XCTAssertEqual(searchState.getRegexPattern(query), "@\\(test\\. !\\*#Query\\b")
+
+        searchState.selectedMode[2] = .MatchingWord
+        XCTAssertEqual(searchState.getRegexPattern(query), "\\b@\\(test\\. !\\*#Query\\b")
+
+        // Enabling case sensitivity shouldn't affect the regex pattern because if case sensitivity is enabled,
+        // `NSRegularExpression.Options.caseInsensitive` is passed to `NSRegularExpression`.
+        searchState.caseSensitive = true
+        XCTAssertEqual(searchState.getRegexPattern(query), "\\b@\\(test\\. !\\*#Query\\b")
+    }
+
     /// Tests the search functionality of the `WorkspaceDocument.SearchState` and `SearchIndexer`.
     func testSearch() async {
         let searchExpectation = XCTestExpectation(description: "Search for 'Ipsum'")