chore: append bundle version to mach service name (#191)

ethanndickson · web-flow · commit c19b39a343c6 · 2025-06-26T12:24:10.000+10:00
We append the CFBundleVersion to the service name to ensure a new service is used for each version. This works around the issue described in #121, presumably caused by the XPC service cache not being invalidated on update. ![image](https://github.com/user-attachments/assets/5b1f2d1d-7aa1-4f58-92b0-ecee712f9131)
diff --git a/Coder-Desktop/Coder-Desktop/Info.plist b/Coder-Desktop/Coder-Desktop/Info.plist
@@ -29,7 +29,12 @@
 	<key>NetworkExtension</key>
 	<dict>
 		<key>NEMachServiceName</key>
-		<string>$(TeamIdentifierPrefix)com.coder.Coder-Desktop.VPN</string>
+		<!-- We append the CFBundleVersion to the service name to ensure a new
+		 service is used for each version. This works around the issue described
+		 in https://github.com/coder/coder-desktop-macos/issues/121, presumably
+		 caused by the XPC service cache not being invalidated on update.
+		-->
+		<string>$(TeamIdentifierPrefix)com.coder.Coder-Desktop.VPN.$(CURRENT_PROJECT_VERSION)</string>
 	</dict>
 	<key>SUPublicEDKey</key>
 	<string>Ae2oQLTcx89/a73XrpOt+IVvqdo+fMTjo3UKEm77VdA=</string>
diff --git a/Coder-Desktop/Coder-Desktop/VPN/VPNSystemExtension.swift b/Coder-Desktop/Coder-Desktop/VPN/VPNSystemExtension.swift
@@ -183,15 +183,16 @@ class SystemExtensionDelegate<AsyncDelegate: SystemExtensionAsyncRecorder>:
         if existing.bundleVersion == `extension`.bundleVersion {
             return .replace
         }
+        // TODO: Workaround disabled, as we're trying another workaround
         // To work around the bug described in
         // https://github.com/coder/coder-desktop-macos/issues/121,
         // we're going to manually reinstall after the replacement is done.
         // If we returned `.cancel` here the deactivation request will fail as
         // it looks for an extension with the *current* version string.
         // There's no way to modify the deactivate request to use a different
         // version string (i.e. `existing.bundleVersion`).
-        logger.info("App upgrade detected, replacing and then reinstalling")
-        action = .replacing
+        // logger.info("App upgrade detected, replacing and then reinstalling")
+        // action = .replacing
         return .replace
     }
 }
diff --git a/Coder-Desktop/VPN/Info.plist b/Coder-Desktop/VPN/Info.plist
@@ -9,7 +9,12 @@
 	<key>NetworkExtension</key>
 	<dict>
 		<key>NEMachServiceName</key>
-		<string>$(TeamIdentifierPrefix)com.coder.Coder-Desktop.VPN</string>
+		<!-- We append the CFBundleVersion to the service name to ensure a new
+		 service is used for each version. This works around the issue described
+		 in https://github.com/coder/coder-desktop-macos/issues/121, presumably
+		 caused by the XPC service cache not being invalidated on update.
+		-->
+		<string>$(TeamIdentifierPrefix)com.coder.Coder-Desktop.VPN.$(CURRENT_PROJECT_VERSION)</string>
 		<key>NEProviderClasses</key>
 		<dict>
 			<key>com.apple.networkextension.packet-tunnel</key>

Original file line number	Diff line number	Diff line change
`@@ -183,15 +183,16 @@ class SystemExtensionDelegate<AsyncDelegate: SystemExtensionAsyncRecorder>:`
`183`	`183`	if existing.bundleVersion == `extension`.bundleVersion {
`184`	`184`	`return .replace`
`185`	`185`	`}`
	`186`	`+ // TODO: Workaround disabled, as we're trying another workaround`
`186`	`187`	`// To work around the bug described in`
`187`	`188`	`// https://github.com/coder/coder-desktop-macos/issues/121,`
`188`	`189`	`// we're going to manually reinstall after the replacement is done.`
`189`	`190`	// If we returned `.cancel` here the deactivation request will fail as
`190`	`191`	`// it looks for an extension with the current version string.`
`191`	`192`	`// There's no way to modify the deactivate request to use a different`
`192`	`193`	// version string (i.e. `existing.bundleVersion`).
`193`		`- logger.info("App upgrade detected, replacing and then reinstalling")`
`194`		`- action = .replacing`
	`194`	`+ // logger.info("App upgrade detected, replacing and then reinstalling")`
	`195`	`+ // action = .replacing`
`195`	`196`	`return .replace`
`196`	`197`	`}`
`197`	`198`	`}`