Add FilespaceSuggestionInvalidationTests

Author: intitni

Core/Package.swift

@@ -106,6 +106,7 @@ let package = Package(
                 "SuggestionInjector",
                 "XPCShared",
                 "Environment",
+                "SuggestionModel",
                 .product(name: "Preferences", package: "Tool"),
             ]
         ),

Core/Tests/ServiceTests/Environment.swift

@@ -23,6 +23,8 @@ import XPCShared
     }
 
     Environment.triggerAction = { _ in }
+    
+    Environment.guessProjectRootURLForFile = { $0 }
 }
 
 func completion(text: String, range: CursorRange, uuid: String = "") -> CodeSuggestion {

Core/Tests/ServiceTests/FilespaceSuggestionInvalidationTests.swift

@@ -0,0 +1,136 @@
+import Foundation
+import XCTest
+import SuggestionModel
+
+@testable import Service
+
+class FilespaceSuggestionInvalidationTests: XCTestCase {
+    @ServiceActor
+    func prepare(suggestionText: String, cursorPosition: CursorPosition) async throws -> Filespace {
+        let (_, filespace) = try await Workspace
+            .fetchOrCreateWorkspaceIfNeeded(fileURL: URL(fileURLWithPath: "file/path/to.swift"))
+        filespace.suggestions = [
+            .init(
+                text: suggestionText,
+                position: cursorPosition,
+                uuid: "",
+                range: .outOfScope,
+                displayText: ""
+            )
+        ]
+        return filespace
+    }
+    
+    func test_text_typing_suggestion_should_be_valid() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 1, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hell\n", "\n"],
+            cursorPosition: .init(line: 1, character: 4)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
+    
+    func test_text_typing_suggestion_in_the_middle_should_be_valid() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 1, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hell man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 4)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
+    
+    func test_text_cursor_moved_to_another_line_should_invalidate() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 1, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hell\n", "\n"],
+            cursorPosition: .init(line: 2, character: 0)
+        )
+        XCTAssertFalse(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNil(suggestion)
+    }
+    
+    func test_text_cursor_is_invalid_should_invalidate() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 100, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hell\n", "\n"],
+            cursorPosition: .init(line: 100, character: 4)
+        )
+        XCTAssertFalse(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNil(suggestion)
+    }
+    
+    func test_line_content_does_not_match_input_should_invalidate() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 1, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "helo\n", "\n"],
+            cursorPosition: .init(line: 1, character: 4)
+        )
+        XCTAssertFalse(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNil(suggestion)
+    }
+    
+    func test_finish_typing_the_whole_single_line_suggestion_should_invalidate() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 1, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 9)
+        )
+        XCTAssertFalse(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNil(suggestion)
+    }
+    
+    func test_finish_typing_the_whole_multiple_line_suggestion_should_be_valid() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man\nhow are you?",
+            cursorPosition: .init(line: 1, character: 0)
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hello man\n", "\n"],
+            cursorPosition: .init(line: 1, character: 9)
+        )
+        XCTAssertTrue(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNotNil(suggestion)
+    }
+    
+    func test_undo_text_to_a_state_before_the_suggestion_was_generated_should_invalidate() async throws {
+        let filespace = try await prepare(
+            suggestionText: "hello man",
+            cursorPosition: .init(line: 1, character: 5) // generating man from hello
+        )
+        let isValid = await filespace.validateSuggestions(
+            lines: ["\n", "hell\n", "\n"],
+            cursorPosition: .init(line: 1, character: 4)
+        )
+        XCTAssertFalse(isValid)
+        let suggestion = await filespace.presentingSuggestion
+        XCTAssertNil(suggestion)
+    }
+}
+