Merge branch 'feature/warn-to-restart-xpc-service' into develop

intitni · intitni · commit 9288320d6224 · 2023-01-12T15:51:35.000+08:00
diff --git a/Config.debug.xcconfig b/Config.debug.xcconfig
@@ -1,2 +1,4 @@
+#include "Version.xcconfig"
+
 BUNDLE_IDENTIFIER_BASE = dev.com.intii.CopilotForXcode
 EXTENSION_BUNDLE_NAME = Copilot Dev
diff --git a/Config.xcconfig b/Config.xcconfig
@@ -1,2 +1,4 @@
+#include "Version.xcconfig"
+
 BUNDLE_IDENTIFIER_BASE = com.intii.CopilotForXcode
 EXTENSION_BUNDLE_NAME = Copilot
diff --git a/Copilot for Xcode.xcodeproj/project.pbxproj b/Copilot for Xcode.xcodeproj/project.pbxproj
@@ -150,6 +150,7 @@
 		C8189B202938973000C9DCDA /* Preview Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = "Preview Assets.xcassets"; sourceTree = "<group>"; };
 		C8189B222938973000C9DCDA /* Copilot_for_Xcode.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = Copilot_for_Xcode.entitlements; sourceTree = "<group>"; };
 		C8189B282938979000C9DCDA /* Core */ = {isa = PBXFileReference; lastKnownFileType = wrapper; path = Core; sourceTree = "<group>"; };
+		C81E867D296FE4420026E908 /* Version.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Version.xcconfig; sourceTree = "<group>"; };
 		C832A47B2940C71D000989F2 /* copilot */ = {isa = PBXFileReference; lastKnownFileType = folder; name = copilot; path = copilot.vim/copilot; sourceTree = "<group>"; };
 		C83B2B79293D9C8C00C5ACCD /* LaunchAgentManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LaunchAgentManager.swift; sourceTree = "<group>"; };
 		C83B2B7B293D9FB400C5ACCD /* CopilotView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CopilotView.swift; sourceTree = "<group>"; };
@@ -246,6 +247,7 @@
 				C832A47B2940C71D000989F2 /* copilot */,
 				C8520308293D805800460097 /* README.md */,
 				C887BC832965D96000931567 /* DEVELOPMENT.md */,
+				C81E867D296FE4420026E908 /* Version.xcconfig */,
 				C81458AD293A009600135263 /* Config.xcconfig */,
 				C81458AE293A009800135263 /* Config.debug.xcconfig */,
 				C8189B282938979000C9DCDA /* Core */,
diff --git a/Copilot for Xcode/CopilotView.swift b/Copilot for Xcode/CopilotView.swift
@@ -12,6 +12,10 @@ struct CopilotView: View {
     @State var version: String?
     @State var isRunningAction: Bool = false
     @State var isUserCodeCopiedAlertPresented = false
+    @State var xpcServiceVersion: String?
+    var shouldRestartXPCService: Bool {
+        xpcServiceVersion != (Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String)
+    }
 
     var body: some View {
         Section {
@@ -20,7 +24,8 @@ struct CopilotView: View {
                     Text("Copilot")
                         .font(.title)
                         .padding(.bottom, 12)
-                    Text("Version: \(version ?? "Loading..")")
+                    Text("XPCService Version: \(xpcServiceVersion ?? "Loading..")")
+                    Text("Copilot Version: \(version ?? "Loading..")")
                     Text("Status: \(copilotStatus?.description ?? "Loading..")")
                     HStack(alignment: .center) {
                         Button("Refresh") { checkStatus() }
@@ -74,9 +79,12 @@ struct CopilotView: View {
             defer { isRunningAction = false }
             do {
                 let service = try getService()
+                xpcServiceVersion = try await service.getXPCServiceVersion().version
                 copilotStatus = try await service.checkStatus()
                 version = try await service.getVersion()
-                message = nil
+                message = shouldRestartXPCService
+                    ? "Please restart XPC Service to update it to the latest version."
+                    : nil
                 isRunningAction = false
             } catch {
                 message = error.localizedDescription
@@ -159,9 +167,9 @@ struct ActivityIndicatorView: NSViewRepresentable {
 struct CopilotView_Previews: PreviewProvider {
     static var previews: some View {
         VStack(alignment: .leading, spacing: 8) {
-            CopilotView(copilotStatus: .notSignedIn, version: "1.0.0")
+            CopilotView(copilotStatus: .notSignedIn, version: "1.0.0", xpcServiceVersion: "0.0.0")
 
-            CopilotView(copilotStatus: .alreadySignedIn, message: "Error")
+            CopilotView(copilotStatus: .alreadySignedIn, message: "Error", xpcServiceVersion: Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "")
 
             CopilotView(copilotStatus: .alreadySignedIn, isRunningAction: true)
         }
diff --git a/Core/Sources/Client/AsyncXPCService.swift b/Core/Sources/Client/AsyncXPCService.swift
@@ -24,6 +24,15 @@ public struct AsyncXPCService {
             }
         }
     }
+    
+    public func getXPCServiceVersion() async throws -> (version: String, build: String) {
+        try await withXPCServiceConnected(connection: connection) {
+            service, continuation in
+            service.getXPCServiceVersion { version, build in
+                continuation.resume((version, build))
+            }
+        }
+    }
 
     public func getVersion() async throws -> String {
         try await withXPCServiceConnected(connection: connection) {
diff --git a/Core/Sources/Service/XPCService.swift b/Core/Sources/Service/XPCService.swift
@@ -14,6 +14,12 @@ import XPCShared
 var workspaces = [URL: Workspace]()
 
 public class XPCService: NSObject, XPCServiceProtocol {
+    public func getXPCServiceVersion(withReply reply: @escaping (String, String) -> Void) {
+        reply(
+            Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "N/A",
+            Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? "N/A")
+    }
+
     @ServiceActor
     lazy var authService: CopilotAuthServiceType = Environment.createAuthService()
 
diff --git a/Core/Sources/XPCShared/XPCServiceProtocol.swift b/Core/Sources/XPCShared/XPCServiceProtocol.swift
@@ -43,4 +43,6 @@ public protocol XPCServiceProtocol {
         editorContent: Data,
         withReply reply: @escaping () -> Void
     )
+
+    func getXPCServiceVersion(withReply reply: @escaping (String, String) -> Void)
 }
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -34,4 +34,6 @@ Testing Real-time Suggestions is a little bit different because the Apple Script
 
 Just run both the XPCService and the EditorExtension Target. 
 
+## App Versioning
 
+The app version and all targets' version in controlled by `Version.xcconfig`.
diff --git a/EditorExtension/Info.plist b/EditorExtension/Info.plist
@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>CFBundleShortVersionString</key>
-	<string>$(MARKETING_VERSION)</string>
+	<string>$(APP_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>
 	<string></string>
 	<key>CFBundleDevelopmentRegion</key>
@@ -15,7 +15,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleVersion</key>
-	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<string>$(APP_BUILD)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleIdentifier</key>
diff --git a/Version.xcconfig b/Version.xcconfig
@@ -0,0 +1,2 @@
+APP_VERSION = 0.4.0
+APP_BUILD = 13
diff --git a/XPCService/Info.plist b/XPCService/Info.plist
@@ -2,6 +2,10 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+	<key>CFBundleShortVersionString</key>
+	<string>$(APP_VERSION)</string>
+	<key>CFBundleVersion</key>
+	<string>$(APP_BUILD)</string>
 	<key>EXTENSION_BUNDLE_NAME</key>
 	<string>$(EXTENSION_BUNDLE_NAME)</string>
 	<key>BUNDLE_IDENTIFIER_BASE</key>

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,15 @@ public struct AsyncXPCService {`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+ public func getXPCServiceVersion() async throws -> (version: String, build: String) {`
	`29`	`+ try await withXPCServiceConnected(connection: connection) {`
	`30`	`+ service, continuation in`
	`31`	`+ service.getXPCServiceVersion { version, build in`
	`32`	`+ continuation.resume((version, build))`
	`33`	`+ }`
	`34`	`+ }`
	`35`	`+ }`
`27`	`36`
`28`	`37`	`public func getVersion() async throws -> String {`
`29`	`38`	`try await withXPCServiceConnected(connection: connection) {`
Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,6 @@ public protocol XPCServiceProtocol {`
`43`	`43`	`editorContent: Data,`
`44`	`44`	`withReply reply: @escaping () -> Void`
`45`	`45`	`)`
	`46`	`+`
	`47`	`+ func getXPCServiceVersion(withReply reply: @escaping (String, String) -> Void)`
`46`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,6 @@ Testing Real-time Suggestions is a little bit different because the Apple Script`
`34`	`34`
`35`	`35`	`Just run both the XPCService and the EditorExtension Target.`
`36`	`36`
	`37`	`+## App Versioning`
`37`	`38`
	`39`	+The app version and all targets' version in controlled by `Version.xcconfig`.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+APP_VERSION = 0.4.0`
	`2`	`+APP_BUILD = 13`