Merge branch 'feature/command-chat-with-selection' into develop

intitni · intitni · commit 12c65488ca8b · 2023-03-25T11:32:25.000+08:00
diff --git a/Copilot for Xcode.xcodeproj/project.pbxproj b/Copilot for Xcode.xcodeproj/project.pbxproj
@@ -46,6 +46,7 @@
 		C882175A294187E100A22FD3 /* Client in Frameworks */ = {isa = PBXBuildFile; productRef = C8821759294187E100A22FD3 /* Client */; };
 		C882175C294187EF00A22FD3 /* Client in Frameworks */ = {isa = PBXBuildFile; productRef = C882175B294187EF00A22FD3 /* Client */; };
 		C8C8B60929AFA35F00034BEE /* CopilotForXcodeExtensionService.app in Embed XPCService */ = {isa = PBXBuildFile; fileRef = C861E60E2994F6070056CB02 /* CopilotForXcodeExtensionService.app */; settings = {ATTRIBUTES = (RemoveHeadersOnCopy, ); }; };
+		C8DCF00029CE11D500FDDDD7 /* ChatWithSelection.swift in Sources */ = {isa = PBXBuildFile; fileRef = C8DCEFFF29CE11D500FDDDD7 /* ChatWithSelection.swift */; };
 		C8EE079D29CC21300043B6D9 /* AccountView.swift in Sources */ = {isa = PBXBuildFile; fileRef = C8EE079C29CC21300043B6D9 /* AccountView.swift */; };
 		C8EE079F29CC25C20043B6D9 /* OpenAIView.swift in Sources */ = {isa = PBXBuildFile; fileRef = C8EE079E29CC25C20043B6D9 /* OpenAIView.swift */; };
 		C8EE07A129CC9ED30043B6D9 /* ExplainSelectionCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = C8EE07A029CC9ED30043B6D9 /* ExplainSelectionCommand.swift */; };
@@ -191,6 +192,7 @@
 		C87F3E61293DD004008523E8 /* Styles.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Styles.swift; sourceTree = "<group>"; };
 		C887BC832965D96000931567 /* DEVELOPMENT.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = DEVELOPMENT.md; sourceTree = "<group>"; };
 		C8CD828229B88006008D044D /* TestPlan.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = TestPlan.xctestplan; sourceTree = "<group>"; };
+		C8DCEFFF29CE11D500FDDDD7 /* ChatWithSelection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatWithSelection.swift; sourceTree = "<group>"; };
 		C8EE079C29CC21300043B6D9 /* AccountView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AccountView.swift; sourceTree = "<group>"; };
 		C8EE079E29CC25C20043B6D9 /* OpenAIView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OpenAIView.swift; sourceTree = "<group>"; };
 		C8EE07A029CC9ED30043B6D9 /* ExplainSelectionCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExplainSelectionCommand.swift; sourceTree = "<group>"; };
@@ -257,6 +259,7 @@
 				C8009C022941C576007AA7E8 /* RealtimeSuggestionCommand.swift */,
 				C800DBB0294C624D00B04CAC /* PrefetchSuggestionsCommand.swift */,
 				C8EE07A029CC9ED30043B6D9 /* ExplainSelectionCommand.swift */,
+				C8DCEFFF29CE11D500FDDDD7 /* ChatWithSelection.swift */,
 				C81458972939EFDC00135263 /* Info.plist */,
 				C81458982939EFDC00135263 /* EditorExtension.entitlements */,
 			);
@@ -519,6 +522,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				C8DCF00029CE11D500FDDDD7 /* ChatWithSelection.swift in Sources */,
 				C81458942939EFDC00135263 /* SourceEditorExtension.swift in Sources */,
 				C8520301293C4D9000460097 /* Helpers.swift in Sources */,
 				C8009BFF2941C551007AA7E8 /* ToggleRealtimeSuggestionsCommand.swift in Sources */,
diff --git a/Copilot for Xcode/OpenAIView.swift b/Copilot for Xcode/OpenAIView.swift
@@ -70,7 +70,7 @@ struct OpenAIView: View {
                         Text("Reply in Language")
                         TextField(
                             text: $settings.chatGPTLanguage,
-                            prompt: Text("English")
+                            prompt: Text("e.g. English. Leave it blank to let the bot decide.")
                         ) {
                             EmptyView()
                         }.textFieldStyle(.copilot)
diff --git a/Core/Sources/Client/AsyncXPCService.swift b/Core/Sources/Client/AsyncXPCService.swift
@@ -178,6 +178,14 @@ public struct AsyncXPCService {
             { $0.explainSelection }
         )
     }
+    
+    public func chatWithSelection(editorContent: EditorContent) async throws -> UpdatedContent? {
+        try await suggestionRequest(
+            connection,
+            editorContent,
+            { $0.chatWithSelection }
+        )
+    }
 }
 
 struct AutoFinishContinuation<T> {
diff --git a/Core/Sources/OpenAIService/ChatGPTService.swift b/Core/Sources/OpenAIService/ChatGPTService.swift
@@ -188,9 +188,9 @@ extension ChatGPTService {
     }
 
     func combineHistoryWithSystemPrompt() -> [CompletionRequestBody.Message] {
-        if history.count > 4 {
+        if history.count > 5 {
             return [.init(role: .system, content: systemPrompt)] +
-                history[history.endIndex - 4..<history.endIndex].map {
+                history[history.endIndex - 5..<history.endIndex].map {
                     .init(role: $0.role, content: $0.content)
                 }
         }
diff --git a/Core/Sources/Service/SuggestionCommandHandler/CommentBaseCommandHandler.swift b/Core/Sources/Service/SuggestionCommandHandler/CommentBaseCommandHandler.swift
@@ -175,6 +175,10 @@ struct CommentBaseCommandHandler: SuggestionCommandHandler {
     func explainSelection(editor: EditorContent) async throws -> UpdatedContent? {
         throw NotSupportedInCommentMode()
     }
+    
+    func chatWithSelection(editor: EditorContent) async throws -> UpdatedContent? {
+        throw NotSupportedInCommentMode()
+    }
 }
 
 // MARK: - Unsupported
diff --git a/Core/Sources/Service/SuggestionCommandHandler/SuggestionCommandHandler.swift b/Core/Sources/Service/SuggestionCommandHandler/SuggestionCommandHandler.swift
@@ -18,4 +18,6 @@ protocol SuggestionCommandHandler {
     func generateRealtimeSuggestions(editor: EditorContent) async throws -> UpdatedContent?
     @ServiceActor
     func explainSelection(editor: EditorContent) async throws -> UpdatedContent?
+    @ServiceActor
+    func chatWithSelection(editor: EditorContent) async throws -> UpdatedContent?
 }
diff --git a/Core/Sources/Service/SuggestionCommandHandler/WindowBaseCommandHandler.swift b/Core/Sources/Service/SuggestionCommandHandler/WindowBaseCommandHandler.swift
@@ -199,10 +199,8 @@ struct WindowBaseCommandHandler: SuggestionCommandHandler {
 
         let service = ChatGPTService(
             systemPrompt: """
-            You are a code explanation engine, you can only explain the code concisely, do not interpret or translate it. Reply in \(
-                language
-                    .isEmpty ? language : "English"
-            )
+            You are a code explanation engine, you can only explain the code concisely, do not interpret or translate it
+            Reply in \(language.isEmpty ? "" : "in \(language)")
             """,
             apiKey: UserDefaults.shared.value(for: \.openAIAPIKey),
             endpoint: endpoint.isEmpty ? nil : endpoint,
@@ -214,15 +212,83 @@ struct WindowBaseCommandHandler: SuggestionCommandHandler {
         let code = editor.selectedCode(in: selection)
         Task {
             try? await service.send(
-                content: removeContinousSpaces(from: code),
+                content: removeContinuousSpaces(from: code),
                 summary: "Explain selected code from `\(selection.start.line + 1):\(selection.start.character + 1)` to `\(selection.end.line + 1):\(selection.end.character + 1)`."
             )
         }
 
         presenter.presentChatGPTConversation(service, fileURL: fileURL)
     }
+
+    func chatWithSelection(editor: EditorContent) async throws -> UpdatedContent? {
+        Task {
+            do {
+                try await _chatWithSelection(editor: editor)
+            } catch {
+                presenter.presentError(error)
+            }
+        }
+        return nil
+    }
+
+    private func _chatWithSelection(editor: EditorContent) async throws {
+        presenter.markAsProcessing(true)
+        defer { presenter.markAsProcessing(false) }
+
+        let fileURL = try await Environment.fetchCurrentFileURL()
+        let endpoint = UserDefaults.shared.value(for: \.chatGPTEndpoint)
+        let model = UserDefaults.shared.value(for: \.chatGPTModel)
+        let language = UserDefaults.shared.value(for: \.chatGPTLanguage)
+
+        let code = {
+            guard let selection = editor.selections.last,
+                  selection.start != selection.end else { return "" }
+            return editor.selectedCode(in: selection)
+        }()
+
+        let prompt = {
+            if code.isEmpty {
+                return """
+                You are a senior programmer, you will answer my questions concisely \(
+                    language.isEmpty ? "" : "in \(language)"
+                )
+                """
+            }
+            return """
+            You are a senior programmer, you will answer my questions concisely in \(
+                language.isEmpty ? "" : "in \(language)"
+            ) about the code
+            ```
+            \(removeContinuousSpaces(from: code))
+            ```
+            """
+        }()
+
+        let service = ChatGPTService(
+            systemPrompt: prompt,
+            apiKey: UserDefaults.shared.value(for: \.openAIAPIKey),
+            endpoint: endpoint.isEmpty ? nil : endpoint,
+            model: model.isEmpty ? nil : model,
+            temperature: 1,
+            maxToken: UserDefaults.shared.value(for: \.chatGPTMaxToken)
+        )
+
+        Task {
+            if !code.isEmpty, let selection = editor.selections.last {
+                await service.mutateHistory { history in
+                    history.append(.init(
+                        role: .user,
+                        content: "",
+                        summary: "Chat about selected code from `\(selection.start.line + 1):\(selection.start.character + 1)` to `\(selection.end.line + 1):\(selection.end.character)`.\nThe code will persisted in the conversation."
+                    ))
+                }
+            }
+        }
+
+        presenter.presentChatGPTConversation(service, fileURL: fileURL)
+    }
 }
 
-func removeContinousSpaces(from string: String) -> String {
+func removeContinuousSpaces(from string: String) -> String {
     return string.replacingOccurrences(of: " +", with: " ", options: .regularExpression)
 }
diff --git a/Core/Sources/Service/XPCService.swift b/Core/Sources/Service/XPCService.swift
@@ -223,6 +223,15 @@ public class XPCService: NSObject, XPCServiceProtocol {
             try await handler.explainSelection(editor: editor)
         }
     }
+    
+    public func chatWithSelection(
+        editorContent: Data,
+        withReply reply: @escaping (Data?, Error?) -> Void
+    ) {
+        replyWithUpdatedContent(editorContent: editorContent, withReply: reply) { handler, editor in
+            try await handler.chatWithSelection(editor: editor)
+        }
+    }
 
     // MARK: - Settings
 
diff --git a/Core/Sources/XPCShared/Models.swift b/Core/Sources/XPCShared/Models.swift
@@ -42,39 +42,7 @@ public struct EditorContent: Codable {
     public var usesTabsForIndentation: Bool
 
     public func selectedCode(in selection: Selection) -> String {
-        let startPosition = selection.start
-        let endPosition = selection.end
-
-        guard startPosition.line >= 0, startPosition.line < lines.count else { return "" }
-        guard endPosition.line >= 0, endPosition.line < lines.count else { return "" }
-        guard endPosition.line >= startPosition.line else { return "" }
-
-        var code = ""
-        if startPosition.line == endPosition.line {
-            let line = lines[startPosition.line]
-            let startIndex = line.index(line.startIndex, offsetBy: startPosition.character)
-            let endIndex = line.index(line.startIndex, offsetBy: endPosition.character)
-            code = String(line[startIndex...endIndex])
-        } else {
-            let startLine = lines[startPosition.line]
-            let startIndex = startLine.index(
-                startLine.startIndex,
-                offsetBy: startPosition.character
-            )
-            code += String(startLine[startIndex...])
-
-            if startPosition.line + 1 < endPosition.line {
-                for line in lines[startPosition.line + 1...endPosition.line - 1] {
-                    code += line
-                }
-            }
-
-            let endLine = lines[endPosition.line]
-            let endIndex = endLine.index(endLine.startIndex, offsetBy: endPosition.character)
-            code += String(endLine[...endIndex])
-        }
-        
-        return code
+        return XPCShared.selectedCode(in: selection, for: lines)
     }
 }
 
@@ -89,3 +57,47 @@ public struct UpdatedContent: Codable {
     public var newCursor: CursorPosition?
     public var modifications: [Modification]
 }
+
+func selectedCode(in selection: EditorContent.Selection, for lines: [String]) -> String {
+    let startPosition = selection.start
+    var endPosition = CursorPosition(
+        line: selection.end.line,
+        character: selection.end.character - 1
+    )
+
+    guard startPosition.line >= 0, startPosition.line < lines.count else { return "" }
+    guard startPosition.character >= 0,
+          startPosition.character < lines[startPosition.line].count else { return "" }
+    guard endPosition.line >= 0, endPosition.line < lines.count else { return "" }
+    guard endPosition.line >= startPosition.line else { return "" }
+    guard endPosition.character >= 0,
+          endPosition.character < lines[endPosition.line].count else { return "" }
+
+    var code = ""
+    if startPosition.line == endPosition.line {
+        guard endPosition.character >= startPosition.character else { return "" }
+        let line = lines[startPosition.line]
+        let startIndex = line.index(line.startIndex, offsetBy: startPosition.character)
+        let endIndex = line.index(line.startIndex, offsetBy: endPosition.character)
+        code = String(line[startIndex...endIndex])
+    } else {
+        let startLine = lines[startPosition.line]
+        let startIndex = startLine.index(
+            startLine.startIndex,
+            offsetBy: startPosition.character
+        )
+        code += String(startLine[startIndex...])
+
+        if startPosition.line + 1 < endPosition.line {
+            for line in lines[startPosition.line + 1...endPosition.line - 1] {
+                code += line
+            }
+        }
+
+        let endLine = lines[endPosition.line]
+        let endIndex = endLine.index(endLine.startIndex, offsetBy: endPosition.character)
+        code += String(endLine[...endIndex])
+    }
+
+    return code
+}
diff --git a/Core/Sources/XPCShared/XPCServiceProtocol.swift b/Core/Sources/XPCShared/XPCServiceProtocol.swift
@@ -40,6 +40,10 @@ public protocol XPCServiceProtocol {
         editorContent: Data,
         withReply reply: @escaping (Data?, Error?) -> Void
     )
+    func chatWithSelection(
+        editorContent: Data,
+        withReply reply: @escaping (Data?, Error?) -> Void
+    )
 
     func toggleRealtimeSuggestion(withReply reply: @escaping (Error?) -> Void)
 
diff --git a/Core/Tests/ServiceTests/ExtractSelectedCodeTests.swift b/Core/Tests/ServiceTests/ExtractSelectedCodeTests.swift
@@ -0,0 +1,56 @@
+import CopilotModel
+import XCTest
+@testable import Service
+@testable import XPCShared
+
+class ExtractSelectedCodeTests: XCTestCase {
+    func test_empty_selection() {
+        let selection = EditorContent.Selection(
+            start: CursorPosition(line: 0, character: 0),
+            end: CursorPosition(line: 0, character: 0)
+        )
+        let lines = ["let foo = 1\n", "let bar = 2\n"]
+        let result = selectedCode(in: selection, for: lines)
+        XCTAssertEqual(result, "")
+    }
+
+    func test_single_line_selection() {
+        let selection = EditorContent.Selection(
+            start: CursorPosition(line: 0, character: 4),
+            end: CursorPosition(line: 0, character: 10)
+        )
+        let lines = ["let foo = 1\n", "let bar = 2\n"]
+        let result = selectedCode(in: selection, for: lines)
+        XCTAssertEqual(result, "foo = ")
+    }
+
+    func test_single_line_selection_at_line_end() {
+        let selection = EditorContent.Selection(
+            start: CursorPosition(line: 0, character: 8),
+            end: CursorPosition(line: 0, character: 11)
+        )
+        let lines = ["let foo = 1\n", "let bar = 2\n"]
+        let result = selectedCode(in: selection, for: lines)
+        XCTAssertEqual(result, "= 1")
+    }
+
+    func test_multi_line_selection() {
+        let selection = EditorContent.Selection(
+            start: CursorPosition(line: 0, character: 4),
+            end: CursorPosition(line: 1, character: 11)
+        )
+        let lines = ["let foo = 1\n", "let bar = 2\n", "let baz = 3\n"]
+        let result = selectedCode(in: selection, for: lines)
+        XCTAssertEqual(result, "foo = 1\nlet bar = 2")
+    }
+
+    func test_invalid_selection() {
+        let selection = EditorContent.Selection(
+            start: CursorPosition(line: 1, character: 4),
+            end: CursorPosition(line: 0, character: 10)
+        )
+        let lines = ["let foo = 1", "let bar = 2"]
+        let result = selectedCode(in: selection, for: lines)
+        XCTAssertEqual(result, "")
+    }
+}
diff --git a/Core/Tests/ServiceTests/RemoveContinuousSpacesInCodeTests.swift b/Core/Tests/ServiceTests/RemoveContinuousSpacesInCodeTests.swift
@@ -0,0 +1,33 @@
+import XCTest
+@testable import Service
+
+class RemoveContinuousSpacesInCodeTests: XCTestCase {
+    func test_remove_continuous_spaces_in_code_empty_string() {
+        let input = ""
+        let expectedOutput = ""
+        let output = removeContinuousSpaces(from: input)
+        XCTAssertEqual(output, expectedOutput)
+    }
+    
+    func test_remove_continuous_spaces_in_code_blank_string() {
+        let input = "   "
+        let expectedOutput = ""
+        let output = removeContinuousSpaces(from: input)
+        XCTAssertEqual(output, expectedOutput)
+    }
+    
+    func test_remove_continuous_spaces() {
+        let input = "hello    world"
+        let expectedOutput = "hello world"
+        let output = removeContinuousSpaces(from: input)
+        XCTAssertEqual(output, expectedOutput)
+    }
+    
+    func test_remove_continuous_spaces_without_continuous_spaces() {
+        let input = "hello world"
+        let expectedOutput = "hello world"
+        let output = removeContinuousSpaces(from: input)
+        XCTAssertEqual(output, expectedOutput)
+    }
+}
+
diff --git a/EditorExtension/ChatWithSelection.swift b/EditorExtension/ChatWithSelection.swift
diff --git a/EditorExtension/SourceEditorExtension.swift b/EditorExtension/SourceEditorExtension.swift

Original file line number	Diff line number	Diff line change
`@@ -178,6 +178,14 @@ public struct AsyncXPCService {`
`178`	`178`	`{ $0.explainSelection }`
`179`	`179`	`)`
`180`	`180`	`}`
	`181`	`+`
	`182`	`+ public func chatWithSelection(editorContent: EditorContent) async throws -> UpdatedContent? {`
	`183`	`+ try await suggestionRequest(`
	`184`	`+ connection,`
	`185`	`+ editorContent,`
	`186`	`+ { $0.chatWithSelection }`
	`187`	`+ )`
	`188`	`+ }`
`181`	`189`	`}`
`182`	`190`
`183`	`191`	`struct AutoFinishContinuation<T> {`
Original file line number	Diff line number	Diff line change
`@@ -188,9 +188,9 @@ extension ChatGPTService {`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`func combineHistoryWithSystemPrompt() -> [CompletionRequestBody.Message] {`
`191`		`- if history.count > 4 {`
	`191`	`+ if history.count > 5 {`
`192`	`192`	`return [.init(role: .system, content: systemPrompt)] +`
`193`		`- history[history.endIndex - 4..<history.endIndex].map {`
	`193`	`+ history[history.endIndex - 5..<history.endIndex].map {`
`194`	`194`	`.init(role: $0.role, content: $0.content)`
`195`	`195`	`}`
`196`	`196`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,10 @@ struct CommentBaseCommandHandler: SuggestionCommandHandler {`
`175`	`175`	`func explainSelection(editor: EditorContent) async throws -> UpdatedContent? {`
`176`	`176`	`throw NotSupportedInCommentMode()`
`177`	`177`	`}`
	`178`	`+`
	`179`	`+ func chatWithSelection(editor: EditorContent) async throws -> UpdatedContent? {`
	`180`	`+ throw NotSupportedInCommentMode()`
	`181`	`+ }`
`178`	`182`	`}`
`179`	`183`
`180`	`184`	`// MARK: - Unsupported`
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,6 @@ protocol SuggestionCommandHandler {`
`18`	`18`	`func generateRealtimeSuggestions(editor: EditorContent) async throws -> UpdatedContent?`
`19`	`19`	`@ServiceActor`
`20`	`20`	`func explainSelection(editor: EditorContent) async throws -> UpdatedContent?`
	`21`	`+ @ServiceActor`
	`22`	`+ func chatWithSelection(editor: EditorContent) async throws -> UpdatedContent?`
`21`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -223,6 +223,15 @@ public class XPCService: NSObject, XPCServiceProtocol {`
`223`	`223`	`try await handler.explainSelection(editor: editor)`
`224`	`224`	`}`
`225`	`225`	`}`
	`226`	`+`
	`227`	`+ public func chatWithSelection(`
	`228`	`+ editorContent: Data,`
	`229`	`+ withReply reply: @escaping (Data?, Error?) -> Void`
	`230`	`+ ) {`
	`231`	`+ replyWithUpdatedContent(editorContent: editorContent, withReply: reply) { handler, editor in`
	`232`	`+ try await handler.chatWithSelection(editor: editor)`
	`233`	`+ }`
	`234`	`+ }`
`226`	`235`
`227`	`236`	`// MARK: - Settings`
`228`	`237`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,10 @@ public protocol XPCServiceProtocol {`
`40`	`40`	`editorContent: Data,`
`41`	`41`	`withReply reply: @escaping (Data?, Error?) -> Void`
`42`	`42`	`)`
	`43`	`+ func chatWithSelection(`
	`44`	`+ editorContent: Data,`
	`45`	`+ withReply reply: @escaping (Data?, Error?) -> Void`
	`46`	`+ )`
`43`	`47`
`44`	`48`	`func toggleRealtimeSuggestion(withReply reply: @escaping (Error?) -> Void)`
`45`	`49`