Update validateSuggestions to handle emojis

Author: intitni

Core/Tests/ServiceTests/FilespaceSuggestionInvalidationTests.swift

@@ -55,6 +55,53 @@ class FilespaceSuggestionInvalidationTests: XCTestCase {
         let suggestion = filespace.presentingSuggestion
         XCTAssertNotNil(suggestion)
     }
+    
+    func test_text_typing_suggestion_with_emoji_in_the_middle_should_be_valid() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello🎆🎆 man",
+            cursorPosition: .init(line: 1, character: 0),
+            range: .init(startPair: (1, 0), endPair: (1, 0))
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hell🎆🎆 man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 4)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
+    
+    func test_text_typing_suggestion_typed_emoji_in_the_middle_should_be_valid() async throws {
+        let filespace = try await prepare(
+            suggestionText: "h🎆🎆o man",
+            cursorPosition: .init(line: 1, character: 0),
+            range: .init(startPair: (1, 0), endPair: (1, 0))
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "h🎆🎆o man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 2)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
+    
+    func test_text_typing_suggestion_cutting_emoji_in_the_middle_should_be_valid() async throws {
+        // undefined behavior, must not crash
+        
+        let filespace = try await prepare(
+            suggestionText: "h🎆🎆o man",
+            cursorPosition: .init(line: 1, character: 0),
+            range: .init(startPair: (1, 0), endPair: (1, 0))
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "h🎆🎆o man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 3)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
 
     func test_text_cursor_moved_to_another_line_should_invalidate() async throws {
         let filespace = try await prepare(
@@ -122,10 +169,35 @@ class FilespaceSuggestionInvalidationTests: XCTestCase {
             cursorPosition: .init(line: 1, character: 0),
             range: .init(startPair: (1, 0), endPair: (1, 0))
         )
+        let wasValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 8)
+        )
         let isValid = await filespace.validateSuggestions(
             lines: ["\n", "hello man\n", "\n"],
             cursorPosition: .init(line: 1, character: 9)
         )
+        XCTAssertTrue(wasValid)
+        XCTAssertFalse(isValid)
+        let suggestion = filespace.presentingSuggestion
+        XCTAssertNil(suggestion)
+    }
+    
+    func test_finish_typing_the_whole_single_line_suggestion_with_emoji_should_invalidate() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello m🎆🎆an",
+            cursorPosition: .init(line: 1, character: 0),
+            range: .init(startPair: (1, 0), endPair: (1, 0))
+        )
+        let wasValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello m🎆🎆an\n", "\n"],
+            cursorPosition: .init(line: 1, character: 12)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello m🎆🎆an\n", "\n"],
+            cursorPosition: .init(line: 1, character: 13)
+        )
+        XCTAssertTrue(wasValid)
         XCTAssertFalse(isValid)
         let suggestion = filespace.presentingSuggestion
         XCTAssertNil(suggestion)
@@ -138,10 +210,15 @@ class FilespaceSuggestionInvalidationTests: XCTestCase {
             cursorPosition: .init(line: 1, character: 0),
             range: .init(startPair: (1, 0), endPair: (1, 0))
         )
+        let wasValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello man!!!!!\n", "\n"],
+            cursorPosition: .init(line: 1, character: 8)
+        )
         let isValid = await filespace.validateSuggestions(
             lines: ["\n", "hello man!!!!!\n", "\n"],
             cursorPosition: .init(line: 1, character: 9)
         )
+        XCTAssertTrue(wasValid)
         XCTAssertFalse(isValid)
         let suggestion = filespace.presentingSuggestion
         XCTAssertNil(suggestion)
@@ -161,6 +238,21 @@ class FilespaceSuggestionInvalidationTests: XCTestCase {
         let suggestion = filespace.presentingSuggestion
         XCTAssertNotNil(suggestion)
     }
+    
+    func test_finish_typing_the_whole_multiple_line_suggestion_with_emoji_should_be_valid() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello m🎆🎆an\nhow are you?",
+            cursorPosition: .init(line: 1, character: 0),
+            range: .init(startPair: (1, 0), endPair: (1, 0))
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello m🎆🎆an\n", "\n"],
+            cursorPosition: .init(line: 1, character: 13)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
 
     func test_undo_text_to_a_state_before_the_suggestion_was_generated_should_invalidate(
     ) async throws {

Tool/Sources/WorkspaceSuggestionService/Filespace+SuggestionService.swift

@@ -82,20 +82,22 @@ public extension Filespace {
                 "Generating suggestion with invalid range"
             )
 
-            let startIndex = editingLine.index(
-                editingLine.startIndex,
+            let uff16View = editingLine.utf16
+            
+            let startIndex = uff16View.index(
+                uff16View.startIndex,
                 offsetBy: max(0, presentingSuggestion.range.start.character),
-                limitedBy: editingLine.endIndex
-            ) ?? editingLine.startIndex
+                limitedBy: uff16View.endIndex
+            ) ?? uff16View.startIndex
 
-            let endIndex = editingLine.index(
-                editingLine.startIndex,
+            let endIndex = uff16View.index(
+                uff16View.startIndex,
                 offsetBy: cursorPosition.character,
-                limitedBy: editingLine.endIndex
-            ) ?? editingLine.endIndex
+                limitedBy: uff16View.endIndex
+            ) ?? uff16View.endIndex
 
             if endIndex > startIndex {
-                return String(editingLine[startIndex..<endIndex])
+                return String(uff16View[startIndex..<endIndex]) ?? ""
             }
 
             return ""