-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Expand file tree
/
Copy pathPseudoCommandHandler.swift
More file actions
628 lines (575 loc) · 23.5 KB
/
PseudoCommandHandler.swift
File metadata and controls
628 lines (575 loc) · 23.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
import ActiveApplicationMonitor
import AppKit
import Dependencies
import Preferences
import SuggestionInjector
import SuggestionBasic
import Toast
import Workspace
import WorkspaceSuggestionService
import XcodeInspector
import XPCShared
import AXHelper
import GitHubCopilotService
/// It's used to run some commands without really triggering the menu bar item.
///
/// For example, we can use it to generate real-time suggestions without Apple Scripts.
struct PseudoCommandHandler {
static var lastTimeCommandFailedToTriggerWithAccessibilityAPI = Date(timeIntervalSince1970: 0)
static var lastBundleNotFoundTime = Date(timeIntervalSince1970: 0)
static var lastBundleDisabledTime = Date(timeIntervalSince1970: 0)
private var toast: ToastController { ToastControllerDependencyKey.liveValue }
func presentPreviousSuggestion() async {
let handler = WindowBaseCommandHandler()
_ = try? await handler.presentPreviousSuggestion(editor: .init(
content: "",
lines: [],
uti: "",
cursorPosition: .outOfScope,
cursorOffset: -1,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
))
}
func presentNextSuggestion() async {
let handler = WindowBaseCommandHandler()
_ = try? await handler.presentNextSuggestion(editor: .init(
content: "",
lines: [],
uti: "",
cursorPosition: .outOfScope,
cursorOffset: -1,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
))
}
@WorkspaceActor
func generateRealtimeSuggestions(sourceEditor: SourceEditor?) async {
guard let filespace = await getFilespace(),
let (workspace, _) = try? await Service.shared.workspacePool
.fetchOrCreateWorkspaceAndFilespace(fileURL: filespace.fileURL) else { return }
if Task.isCancelled { return }
let codeCompletionEnabled = UserDefaults.shared.value(for: \.realtimeSuggestionToggle)
// Enabled both by Feature Flag and User.
let nesEnabled = FeatureFlagNotifierImpl.shared.featureFlags.editorPreviewFeatures && UserDefaults.shared.value(for: \.realtimeNESToggle)
guard codeCompletionEnabled || nesEnabled else {
cleanupAllSuggestions(filespace: filespace, presenter: nil)
return
}
// Can't use handler if content is not available.
guard let editor = await getEditorContent(sourceEditor: sourceEditor)
else { return }
let presenter = PresentInWindowSuggestionPresenter()
presenter.markAsProcessing(true)
defer { presenter.markAsProcessing(false) }
do {
if codeCompletionEnabled {
try await _generateRealtimeCodeCompletionSuggestions(
editor: editor,
sourceEditor: sourceEditor,
filespace: filespace,
workspace: workspace,
presenter: presenter
)
} else {
cleanupCodeCompletionSuggestion(filespace: filespace, presenter: presenter)
}
if nesEnabled,
(codeCompletionEnabled == false || filespace.presentingSuggestion == nil) {
try await _generateRealtimeNESSuggestions(
editor: editor,
sourceEditor: sourceEditor,
filespace: filespace,
workspace: workspace,
presenter: presenter
)
} else {
cleanupNESSuggestion(filespace: filespace, presenter: presenter)
}
} catch {
cleanupAllSuggestions(filespace: filespace, presenter: presenter)
}
}
@WorkspaceActor
private func cleanupCodeCompletionSuggestion(
filespace: Filespace,
presenter: PresentInWindowSuggestionPresenter?
) {
filespace.reset()
presenter?.discardSuggestion(fileURL: filespace.fileURL)
}
@WorkspaceActor
private func cleanupNESSuggestion(
filespace: Filespace,
presenter: PresentInWindowSuggestionPresenter?
) {
filespace.resetNESSuggestion()
presenter?.discardNESSuggestion(fileURL: filespace.fileURL)
}
@WorkspaceActor
private func cleanupAllSuggestions(
filespace: Filespace,
presenter: PresentInWindowSuggestionPresenter?
) {
cleanupCodeCompletionSuggestion(filespace: filespace, presenter: presenter)
cleanupNESSuggestion(filespace: filespace, presenter: presenter)
filespace.resetSnapshot()
filespace.resetNESSnapshot()
}
@WorkspaceActor
func _generateRealtimeCodeCompletionSuggestions(
editor: EditorContent,
sourceEditor: SourceEditor?,
filespace: Filespace,
workspace: Workspace,
presenter: PresentInWindowSuggestionPresenter
) async throws {
if filespace.presentingSuggestion != nil {
// Check if the current suggestion is still valid.
if filespace.validateSuggestions(
lines: editor.lines,
cursorPosition: editor.cursorPosition
) {
return
} else {
filespace.reset()
presenter.discardSuggestion(fileURL: filespace.fileURL)
}
}
let fileURL = filespace.fileURL
try await workspace.generateSuggestions(
forFileAt: fileURL,
editor: editor
)
let editorContent = sourceEditor?.getContent()
if let editorContent {
_ = filespace.validateSuggestions(
lines: editorContent.lines,
cursorPosition: editorContent.cursorPosition
)
}
if !filespace.errorMessage.isEmpty {
presenter
.presentWarningMessage(
filespace.errorMessage,
url: "https://github.com/github-copilot/signup/copilot_individual"
)
}
if filespace.presentingSuggestion != nil {
presenter.presentSuggestion(fileURL: fileURL)
workspace.notifySuggestionShown(fileFileAt: fileURL)
} else {
presenter.discardSuggestion(fileURL: fileURL)
}
}
@WorkspaceActor
func _generateRealtimeNESSuggestions(
editor: EditorContent,
sourceEditor: SourceEditor?,
filespace: Filespace,
workspace: Workspace,
presenter: PresentInWindowSuggestionPresenter
) async throws {
if filespace.presentingNESSuggestion != nil {
// Check if the current NES suggestion is still valid.
if filespace.validateNESSuggestions(
lines: editor.lines,
cursorPosition: editor.cursorPosition
) {
return
} else {
filespace.resetNESSuggestion()
presenter.discardNESSuggestion(fileURL: filespace.fileURL)
}
}
let fileURL = filespace.fileURL
try await workspace.generateNESSuggestions(forFileAt: fileURL, editor: editor)
let editorContent = sourceEditor?.getContent()
if let editorContent {
_ = filespace.validateNESSuggestions(
lines: editorContent.lines,
cursorPosition: editorContent.cursorPosition
)
}
// TODO: handle errorMessage if any
if filespace.presentingNESSuggestion != nil {
presenter.presentNESSuggestion(fileURL: fileURL)
workspace.notifyNESSuggestionShown(forFileAt: fileURL)
} else {
presenter.discardNESSuggestion(fileURL: fileURL)
}
}
@WorkspaceActor
func invalidateRealtimeSuggestionsIfNeeded(fileURL: URL, sourceEditor: SourceEditor) async {
guard let (_, filespace) = try? await Service.shared.workspacePool
.fetchOrCreateWorkspaceAndFilespace(fileURL: fileURL) else { return }
if filespace.presentingSuggestion == nil {
return // skip if there's no suggestion presented.
}
let content = sourceEditor.getContent()
if !filespace.validateSuggestions(
lines: content.lines,
cursorPosition: content.cursorPosition
) {
PresentInWindowSuggestionPresenter().discardSuggestion(fileURL: fileURL)
}
}
@WorkspaceActor
func invalidateRealtimeNESSuggestionsIfNeeded(fileURL: URL, sourceEditor: SourceEditor) async {
guard let (_, filespace) = try? await Service.shared.workspacePool
.fetchOrCreateWorkspaceAndFilespace(fileURL: fileURL) else { return }
if filespace.presentingNESSuggestion == nil {
return // skip if there's no NES suggestion presented.
}
let content = sourceEditor.getContent()
if !filespace.validateNESSuggestions(
lines: content.lines,
cursorPosition: content.cursorPosition
) {
PresentInWindowSuggestionPresenter().discardNESSuggestion(fileURL: fileURL)
}
}
func rejectSuggestions() async {
let handler = WindowBaseCommandHandler()
_ = try? await handler.rejectSuggestion(editor: .init(
content: "",
lines: [],
uti: "",
cursorPosition: .outOfScope,
cursorOffset: -1,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
))
}
func rejectNESSuggestions() async {
let handler = WindowBaseCommandHandler()
_ = try? await handler.rejectNESSuggestion(editor: .init(
content: "",
lines: [],
uti: "",
cursorPosition: .outOfScope,
cursorOffset: -1,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
))
}
func handleCustomCommand(_ command: CustomCommand) async {
guard let editor = await {
if let it = await getEditorContent(sourceEditor: nil) {
return it
}
switch command.feature {
// editor content is not required.
case .customChat, .chatWithSelection, .singleRoundDialog:
return .init(
content: "",
lines: [],
uti: "",
cursorPosition: .outOfScope,
cursorOffset: -1,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
)
// editor content is required.
case .promptToCode:
return nil
}
}() else {
do {
try await XcodeInspector.shared.safe.latestActiveXcode?
.triggerCopilotCommand(name: command.name)
} catch {
let presenter = PresentInWindowSuggestionPresenter()
presenter.presentError(error)
}
return
}
let handler = WindowBaseCommandHandler()
do {
try await handler.handleCustomCommand(id: command.id, editor: editor)
} catch {
let presenter = PresentInWindowSuggestionPresenter()
presenter.presentError(error)
}
}
func acceptPromptToCode() async {
do {
if UserDefaults.shared.value(for: \.alwaysAcceptSuggestionWithAccessibilityAPI) {
throw CancellationError()
}
do {
try await XcodeInspector.shared.safe.latestActiveXcode?
.triggerCopilotCommand(name: "Accept Prompt to Code")
} catch {
let last = Self.lastTimeCommandFailedToTriggerWithAccessibilityAPI
let now = Date()
if now.timeIntervalSince(last) > 60 * 60 {
Self.lastTimeCommandFailedToTriggerWithAccessibilityAPI = now
toast.toast(content: """
The app is using a fallback solution to accept suggestions. \
For better experience, please restart Xcode to re-activate the Copilot \
menu item.
""", level: .warning)
}
throw error
}
} catch {
guard let xcode = ActiveApplicationMonitor.shared.activeXcode
?? ActiveApplicationMonitor.shared.latestXcode else { return }
let application = AXUIElementCreateApplication(xcode.processIdentifier)
guard let focusElement = application.focusedElement,
focusElement.description == "Source Editor"
else { return }
guard let (
content,
lines,
_,
cursorPosition,
cursorOffset
) = await getFileContent(sourceEditor: nil)
else {
PresentInWindowSuggestionPresenter()
.presentErrorMessage("Unable to get file content.")
return
}
let handler = WindowBaseCommandHandler()
do {
guard let result = try await handler.acceptPromptToCode(editor: .init(
content: content,
lines: lines,
uti: "",
cursorPosition: cursorPosition,
cursorOffset: cursorOffset,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
)) else { return }
try injectUpdatedCodeWithAccessibilityAPI(result, focusElement: focusElement)
} catch {
PresentInWindowSuggestionPresenter().presentError(error)
}
}
}
func acceptSuggestion(_ suggestionType: CodeSuggestionType) async {
do {
if UserDefaults.shared.value(for: \.alwaysAcceptSuggestionWithAccessibilityAPI) {
throw CancellationError()
}
do {
switch suggestionType {
case .codeCompletion:
try await XcodeInspector.shared.safe.latestActiveXcode?
.triggerCopilotCommand(name: "Accept Suggestion")
case .nes:
try await XcodeInspector.shared.safe.latestActiveXcode?
.triggerCopilotCommand(name: "Accept Next Edit Suggestion")
}
} catch {
let lastBundleNotFoundTime = Self.lastBundleNotFoundTime
let lastBundleDisabledTime = Self.lastBundleDisabledTime
let now = Date()
if let cantRunError = error as? AppInstanceInspector.CantRunCommand {
if cantRunError.errorDescription.contains("No bundle found") {
// Extension permission not granted
if now.timeIntervalSince(lastBundleNotFoundTime) > 60 * 60 {
Self.lastBundleNotFoundTime = now
toast.toast(
title: "GitHub Copilot Extension Permission Not Granted",
content: """
Enable Extensions → Xcode Source Editor → GitHub Copilot \
for Xcode for faster and full-featured code completion. \
[View How-to Guide](https://github.com/github/CopilotForXcode/blob/main/TROUBLESHOOTING.md#extension-permission)
""",
level: .warning,
button: .init(
title: "Enable",
action: { NSWorkspace.openXcodeExtensionsPreferences() }
)
)
}
} else if cantRunError.errorDescription.contains("found but disabled") {
if now.timeIntervalSince(lastBundleDisabledTime) > 60 * 60 {
Self.lastBundleDisabledTime = now
toast.toast(
title: "GitHub Copilot Extension Disabled",
content: "Quit and restart Xcode to enable extension.",
level: .warning,
button: .init(
title: "Restart Xcode",
action: { NSWorkspace.restartXcode() }
)
)
}
}
}
throw error
}
} catch {
guard let xcode = ActiveApplicationMonitor.shared.activeXcode
?? ActiveApplicationMonitor.shared.latestXcode else { return }
let application = AXUIElementCreateApplication(xcode.processIdentifier)
guard let focusElement = application.focusedElement,
focusElement.description == "Source Editor"
else { return }
guard let (
content,
lines,
_,
cursorPosition,
cursorOffset
) = await getFileContent(sourceEditor: nil)
else {
PresentInWindowSuggestionPresenter()
.presentErrorMessage("Unable to get file content.")
return
}
let handler = WindowBaseCommandHandler()
do {
let editor: EditorContent = .init(
content: content,
lines: lines,
uti: "",
cursorPosition: cursorPosition,
cursorOffset: cursorOffset,
selections: [],
tabSize: 0,
indentSize: 0,
usesTabsForIndentation: false
)
let result = try await {
switch suggestionType {
case .codeCompletion:
return try await handler.acceptSuggestion(editor: editor)
case .nes:
return try await handler.acceptNESSuggestion(editor: editor)
}
}()
guard let result else { return }
try injectUpdatedCodeWithAccessibilityAPI(result, focusElement: focusElement)
} catch {
PresentInWindowSuggestionPresenter().presentError(error)
}
}
}
func goToNextEditSuggestion() async {
do {
guard let sourceEditor = await XcodeInspector.shared.safe.focusedEditor,
let fileURL = sourceEditor.realtimeDocumentURL
else { return }
let (workspace, _) = try await Service.shared.workspacePool
.fetchOrCreateWorkspaceAndFilespace(fileURL: fileURL)
guard let suggestion = await workspace.getNESSuggestion(forFileAt: fileURL)
else { return }
AXHelper.scrollSourceEditorToLine(
suggestion.range.start.line,
content: sourceEditor.getContent().content,
focusedElement: sourceEditor.element
)
} catch {
// Handle if needed
}
}
func dismissSuggestion() async {
guard let documentURL = await XcodeInspector.shared.safe.activeDocumentURL else { return }
guard let (_, filespace) = try? await Service.shared.workspacePool
.fetchOrCreateWorkspaceAndFilespace(fileURL: documentURL) else { return }
await filespace.reset()
PresentInWindowSuggestionPresenter().discardSuggestion(fileURL: documentURL)
}
func openChat(forceDetach: Bool) {
let store = Service.shared.guiController.store
Task { @MainActor in
await store.send(.createAndSwitchToChatTabIfNeeded).finish()
store.send(.openChatPanel(forceDetach: forceDetach))
}
}
}
extension PseudoCommandHandler {
/// When Xcode commands are not available, we can fallback to directly
/// set the value of the editor with Accessibility API.
func injectUpdatedCodeWithAccessibilityAPI(
_ result: UpdatedContent,
focusElement: AXUIElement
) throws {
try AXHelper().injectUpdatedCodeWithAccessibilityAPI(
result,
focusElement: focusElement,
onError: {
PresentInWindowSuggestionPresenter()
.presentErrorMessage("Fail to set editor content.")
}
)
}
func getFileContent(sourceEditor: AXUIElement?) async
-> (
content: String,
lines: [String],
selections: [CursorRange],
cursorPosition: CursorPosition,
cursorOffset: Int
)?
{
guard let xcode = ActiveApplicationMonitor.shared.activeXcode
?? ActiveApplicationMonitor.shared.latestXcode else { return nil }
let application = AXUIElementCreateApplication(xcode.processIdentifier)
guard let focusElement = sourceEditor ?? application.focusedElement,
focusElement.description == "Source Editor"
else { return nil }
guard let selectionRange = focusElement.selectedTextRange else { return nil }
let content = focusElement.value
let split = content.breakLines(appendLineBreakToLastLine: false)
let range = SourceEditor.convertRangeToCursorRange(selectionRange, in: content)
return (content, split, [range], range.start, selectionRange.lowerBound)
}
func getFileURL() async -> URL? {
await XcodeInspector.shared.safe.realtimeActiveDocumentURL
}
@WorkspaceActor
func getFilespace() async -> Filespace? {
guard
let fileURL = await getFileURL(),
let (_, filespace) = try? await Service.shared.workspacePool
.fetchOrCreateWorkspaceAndFilespace(fileURL: fileURL)
else { return nil }
return filespace
}
@WorkspaceActor
func getEditorContent(sourceEditor: SourceEditor?) async -> EditorContent? {
guard let filespace = await getFilespace(),
let sourceEditor = await {
if let sourceEditor { sourceEditor }
else { await XcodeInspector.shared.safe.focusedEditor }
}()
else { return nil }
if Task.isCancelled { return nil }
let content = sourceEditor.getContent()
let uti = filespace.codeMetadata.uti ?? ""
let tabSize = filespace.codeMetadata.tabSize ?? 4
let indentSize = filespace.codeMetadata.indentSize ?? 4
let usesTabsForIndentation = filespace.codeMetadata.usesTabsForIndentation ?? false
return .init(
content: content.content,
lines: content.lines,
uti: uti,
cursorPosition: content.cursorPosition,
cursorOffset: content.cursorOffset,
selections: content.selections.map {
.init(start: $0.start, end: $0.end)
},
tabSize: tabSize,
indentSize: indentSize,
usesTabsForIndentation: usesTabsForIndentation
)
}
}