-
-
Notifications
You must be signed in to change notification settings - Fork 347
fix(editor): stop autocomplete popup from stealing keyboard focus (#1885) #1893
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
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
114 changes: 114 additions & 0 deletions
114
...urceEditor/Tests/CodeEditSourceEditorTests/CodeSuggestion/SuggestionPanelFocusTests.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,114 @@ | ||
| import AppKit | ||
| @testable import CodeEditSourceEditor | ||
| import SwiftUI | ||
| import XCTest | ||
|
|
||
| final class SuggestionPanelFocusTests: XCTestCase { | ||
| @MainActor | ||
| func test_panel_neverAcceptsKeyOrMainStatus() throws { | ||
| let controller = SuggestionController() | ||
| let window = try XCTUnwrap(controller.window) | ||
|
|
||
| XCTAssertFalse(window.canBecomeKey) | ||
| XCTAssertFalse(window.canBecomeMain) | ||
| XCTAssertTrue(window.styleMask.contains(.nonactivatingPanel)) | ||
| XCTAssertEqual((window as? NSPanel)?.becomesKeyOnlyIfNeeded, true) | ||
| XCTAssertEqual(window.tabbingMode, .disallowed) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_contentViewHierarchy_containsNoFocusableTableView() throws { | ||
| let controller = SuggestionController() | ||
| let window = try XCTUnwrap(controller.window) | ||
|
|
||
| controller.model.items = [PanelStubEntry(label: "SELECT"), PanelStubEntry(label: "SET")] | ||
| window.setContentSize(NSSize(width: 300, height: 200)) | ||
| window.orderFrontRegardless() | ||
| defer { window.close() } | ||
| RunLoop.main.run(until: Date(timeIntervalSinceNow: 0.2)) | ||
|
|
||
| let contentView = try XCTUnwrap(window.contentView) | ||
| XCTAssertNil(firstFocusableTableView(in: contentView)) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_showWindowAttachedTo_preservesParentFirstResponder() throws { | ||
| let (parentWindow, textViewController) = Mock.windowedTextViewController(theme: Mock.theme()) | ||
| let controller = SuggestionController() | ||
| defer { | ||
| controller.close() | ||
| parentWindow.close() | ||
| } | ||
|
|
||
| parentWindow.orderFrontRegardless() | ||
| let textView = try XCTUnwrap(textViewController.textView) | ||
| XCTAssertTrue(parentWindow.makeFirstResponder(textView)) | ||
|
|
||
| controller.model.items = [PanelStubEntry(label: "SELECT")] | ||
| controller.showWindow(attachedTo: parentWindow) | ||
| RunLoop.main.run(until: Date(timeIntervalSinceNow: 0.2)) | ||
|
|
||
| XCTAssertTrue(parentWindow.firstResponder === textView) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_showWindowAttachedTo_reattachesFromPreviousParent() throws { | ||
| let (firstParent, _) = Mock.windowedTextViewController(theme: Mock.theme()) | ||
| let (secondParent, _) = Mock.windowedTextViewController(theme: Mock.theme()) | ||
| let controller = SuggestionController() | ||
| let window = try XCTUnwrap(controller.window) | ||
| defer { | ||
| controller.close() | ||
| firstParent.close() | ||
| secondParent.close() | ||
| } | ||
|
|
||
| controller.showWindow(attachedTo: firstParent) | ||
| XCTAssertTrue(window.parent === firstParent) | ||
|
|
||
| controller.showWindow(attachedTo: secondParent) | ||
| XCTAssertTrue(window.parent === secondParent) | ||
| XCTAssertFalse(firstParent.childWindows?.contains(window) ?? false) | ||
| } | ||
|
|
||
| @MainActor | ||
| func test_close_detachesPanelFromParent() throws { | ||
| let (parentWindow, _) = Mock.windowedTextViewController(theme: Mock.theme()) | ||
| let controller = SuggestionController() | ||
| let window = try XCTUnwrap(controller.window) | ||
| defer { parentWindow.close() } | ||
|
|
||
| controller.showWindow(attachedTo: parentWindow) | ||
| XCTAssertTrue(window.parent === parentWindow) | ||
|
|
||
| controller.close() | ||
|
|
||
| XCTAssertNil(window.parent) | ||
| XCTAssertFalse(parentWindow.childWindows?.contains(window) ?? false) | ||
| } | ||
|
|
||
| @MainActor | ||
| private func firstFocusableTableView(in view: NSView) -> NSTableView? { | ||
| if let tableView = view as? NSTableView { | ||
| return tableView | ||
| } | ||
| for subview in view.subviews { | ||
| if let found = firstFocusableTableView(in: subview) { | ||
| return found | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| private struct PanelStubEntry: 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 } | ||
| } |
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 the async request finishes after focus has moved away, this new guard returns without clearing
activeTextView/delegateor resetting the delegate's completion session. In the SQL editor,SQLCompletionAdapter.completionSuggestionsRequestedhas already cached its finalsessionbefore returning; if the user clicks back into the same editor and keeps typing,cursorsUpdatedsees the same active text view, gets filtered items fromcompletionOnCursorMove, and returns without invoking thepresentIfNotpath, so the popup stays hidden until something else resets the session. Please route this drop path through the same cleanup as closing/dismissing the request.Useful? React with 👍 / 👎.