-
-
Notifications
You must be signed in to change notification settings - Fork 288
fix(editor): stop keystrokes being erased and filter the completion popup in place (#1608) #1611
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
137 changes: 137 additions & 0 deletions
137
...Editor/Tests/CodeEditSourceEditorTests/CodeSuggestion/SuggestionCursorsUpdatedTests.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| import AppKit | ||
| @testable import CodeEditSourceEditor | ||
| import SwiftUI | ||
| import XCTest | ||
|
|
||
| final class SuggestionCursorsUpdatedTests: XCTestCase { | ||
| @MainActor | ||
| func test_cursorsUpdated_keepsWindowOpenWhileRequestIsInFlight() throws { | ||
| let model = SuggestionViewModel() | ||
| let textViewController = Mock.textViewController(theme: Mock.theme()) | ||
| let delegate = FilteringStubDelegate(itemsOnCursorMove: nil) | ||
|
|
||
| model.activeTextView = textViewController | ||
| model.delegate = delegate | ||
| model.items = [FilterStubEntry(label: "SELECT")] | ||
| model.itemsRequestTask = Task { try? await Task.sleep(for: .seconds(10)) } | ||
| defer { model.itemsRequestTask?.cancel() } | ||
|
|
||
| var closeCount = 0 | ||
| model.cursorsUpdated( | ||
| textView: textViewController, | ||
| delegate: delegate, | ||
| position: CursorPosition(range: NSRange(location: 1, length: 0)) | ||
| ) { closeCount += 1 } | ||
|
|
||
| XCTAssertEqual(closeCount, 0) | ||
| XCTAssertNotNil(model.itemsRequestTask) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_cursorsUpdated_filtersItemsInPlaceWhenDelegateProvidesThem() throws { | ||
| let model = SuggestionViewModel() | ||
| let textViewController = Mock.textViewController(theme: Mock.theme()) | ||
| let filtered: [CodeSuggestionEntry] = [FilterStubEntry(label: "SELECT"), FilterStubEntry(label: "SET")] | ||
| let delegate = FilteringStubDelegate(itemsOnCursorMove: filtered) | ||
|
|
||
| model.activeTextView = textViewController | ||
| model.delegate = delegate | ||
| model.items = [FilterStubEntry(label: "stale")] | ||
| model.selectedIndex = 0 | ||
|
|
||
| var closeCount = 0 | ||
| model.cursorsUpdated( | ||
| textView: textViewController, | ||
| delegate: delegate, | ||
| position: CursorPosition(range: NSRange(location: 2, length: 0)) | ||
| ) { closeCount += 1 } | ||
|
|
||
| XCTAssertEqual(closeCount, 0) | ||
| XCTAssertEqual(model.items.map(\.label), ["SELECT", "SET"]) | ||
| XCTAssertEqual(model.selectedIndex, 0) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_cursorsUpdated_closesWhenNoItemsAndNoRequestInFlight() throws { | ||
| let model = SuggestionViewModel() | ||
| let textViewController = Mock.textViewController(theme: Mock.theme()) | ||
| let delegate = FilteringStubDelegate(itemsOnCursorMove: nil) | ||
|
|
||
| model.activeTextView = textViewController | ||
| model.delegate = delegate | ||
| model.items = [FilterStubEntry(label: "SELECT")] | ||
| model.itemsRequestTask = nil | ||
|
|
||
| var closeCount = 0 | ||
| model.cursorsUpdated( | ||
| textView: textViewController, | ||
| delegate: delegate, | ||
| position: CursorPosition(range: NSRange(location: 0, length: 0)) | ||
| ) { closeCount += 1 } | ||
|
|
||
| XCTAssertEqual(closeCount, 1) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_cursorsUpdated_cancelsRequestAndClosesForDifferentTextView() throws { | ||
| let model = SuggestionViewModel() | ||
| let activeController = Mock.textViewController(theme: Mock.theme()) | ||
| let otherController = Mock.textViewController(theme: Mock.theme()) | ||
| let delegate = FilteringStubDelegate(itemsOnCursorMove: [FilterStubEntry(label: "SELECT")]) | ||
|
|
||
| model.activeTextView = activeController | ||
| model.delegate = delegate | ||
| model.itemsRequestTask = Task { try? await Task.sleep(for: .seconds(10)) } | ||
|
|
||
| var closeCount = 0 | ||
| model.cursorsUpdated( | ||
| textView: otherController, | ||
| delegate: delegate, | ||
| position: CursorPosition(range: NSRange(location: 0, length: 0)) | ||
| ) { closeCount += 1 } | ||
|
|
||
| XCTAssertEqual(closeCount, 1) | ||
| XCTAssertNil(model.itemsRequestTask) | ||
| } | ||
| } | ||
|
|
||
| private final class FilteringStubDelegate: CodeSuggestionDelegate { | ||
| private let itemsOnCursorMove: [CodeSuggestionEntry]? | ||
|
|
||
| init(itemsOnCursorMove: [CodeSuggestionEntry]?) { | ||
| self.itemsOnCursorMove = itemsOnCursorMove | ||
| } | ||
|
|
||
| func completionSuggestionsRequested( | ||
| textView: TextViewController, | ||
| cursorPosition: CursorPosition, | ||
| isManualTrigger: Bool | ||
| ) async -> (windowPosition: CursorPosition, items: [CodeSuggestionEntry])? { | ||
| nil | ||
| } | ||
|
|
||
| func completionOnCursorMove( | ||
| textView: TextViewController, | ||
| cursorPosition: CursorPosition | ||
| ) -> [CodeSuggestionEntry]? { | ||
| itemsOnCursorMove | ||
| } | ||
|
|
||
| func completionWindowApplyCompletion( | ||
| item: CodeSuggestionEntry, | ||
| textView: TextViewController, | ||
| cursorPosition: CursorPosition? | ||
| ) {} | ||
| } | ||
|
|
||
| private struct FilterStubEntry: CodeSuggestionEntry { | ||
| var label: String | ||
| var detail: String? { nil } | ||
| var documentation: String? { nil } | ||
| var pathComponents: [String]? { nil } | ||
| var targetPosition: CursorPosition? { nil } | ||
| var sourcePreview: String? { nil } | ||
| var image: Image { Image(systemName: "circle") } | ||
| var imageColor: Color { .gray } | ||
| var deprecated: Bool { false } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a large document edit is still in the 150 ms debounced writeback window,
isUpdateFromTextViewremains true and this guard skips any external binding update such as Clear/Format. Because the pendingtextBindingTaskis not cancelled on this path, that task can later write the pre-clear text back into the binding, so the programmatic change is dropped or reverted; the old duplicateSQLEditorViewpush-down was removed in this commit, sosyncBindingTextis now the only path that can apply the external change.Useful? React with 👍 / 👎.