Support SMAppService for macOS 13

Fixes #76

Author: sindresorhus

.github/funding.yml

@@ -1,8 +1,14 @@
 import Foundation
 import ServiceManagement
 import Combine
+import os.log
+
+private let hasMigratedKey = "LaunchAtLogin__hasMigrated"
 
 public enum LaunchAtLogin {
+	@available(macOS 11, *)
+	private static let logger = Logger(subsystem: "com.sindresorhus.LaunchAtLogin", category: "main")
+
 	public static let kvo = KVO()
 
 	@available(macOS 10.15, *)
@@ -15,30 +21,99 @@ public enum LaunchAtLogin {
 
 	private static let id = "\(Bundle.main.bundleIdentifier!)-LaunchAtLoginHelper"
 
+	private static var hasMigrated: Bool {
+		get { UserDefaults.standard.bool(forKey: hasMigratedKey) }
+		set {
+			UserDefaults.standard.set(true, forKey: hasMigratedKey)
+		}
+	}
+
+	public static func migrateIfNeeded() {
+		guard
+			#available(macOS 13, *),
+			!hasMigrated
+		else {
+			return
+		}
+
+		hasMigrated = true
+
+		if isEnabledLegacy {
+			isEnabledModern = true
+		}
+
+		unregisterLegacy()
+	}
+
 	public static var isEnabled: Bool {
 		get {
-			guard let jobs = (LaunchAtLogin.self as DeprecationWarningWorkaround.Type).jobsDict else {
-				return false
+			if #available(macOS 13, *) {
+				return isEnabledModern
+			} else {
+				return isEnabledLegacy
 			}
-
-			let job = jobs.first { ($0["Label"] as? String) == id }
-
-			return job?["OnDemand"] as? Bool ?? false
 		}
 		set {
 			if #available(macOS 10.15, *) {
 				observable.objectWillChange.send()
 			}
 
 			kvo.willChangeValue(for: \.isEnabled)
-			SMLoginItemSetEnabled(id as CFString, newValue)
+
+			if #available(macOS 13, *) {
+				isEnabledModern = newValue
+			} else {
+				isEnabledLegacy = newValue
+			}
+
 			kvo.didChangeValue(for: \.isEnabled)
 
 			if #available(macOS 10.15, *) {
 				_publisher.send(newValue)
 			}
 		}
 	}
+
+	@available(macOS 13, *)
+	private static var isEnabledModern: Bool {
+		get { SMAppService.mainApp.status == .enabled }
+		set {
+			do {
+				if newValue {
+					if SMAppService.mainApp.status == .enabled {
+						try? SMAppService.mainApp.unregister()
+					}
+
+					try SMAppService.mainApp.register()
+				} else {
+					try SMAppService.mainApp.unregister()
+				}
+			} catch {
+				logger.error("Failed to \(newValue ? "enable" : "disable") launch at login: \(error.localizedDescription)")
+			}
+		}
+	}
+
+	private static var isEnabledLegacy: Bool {
+		get {
+			guard let jobs = (LaunchAtLogin.self as DeprecationWarningWorkaround.Type).jobsDict else {
+				return false
+			}
+
+			let job = jobs.first { ($0["Label"] as? String) == id }
+
+			return job?["OnDemand"] as? Bool ?? false
+		}
+		set {
+			SMLoginItemSetEnabled(id as CFString, newValue)
+		}
+	}
+
+	@available(macOS 13, *)
+	private static func unregisterLegacy() {
+		isEnabledLegacy = false
+		try? SMAppService.loginItem(identifier: id).unregister()
+	}
 }
 
 // MARK: - LaunchAtLoginObservable

.github/workflows/ci.yml

@@ -2,31 +2,31 @@
 
 > Add “Launch at Login” functionality to your macOS app in seconds
 
-It's usually quite a [convoluted and error-prone process](before-after.md) to add this. **No more!**
+**If your app targets macOS 13 or later, check out [this modern version](https://github.com/sindresorhus/LaunchAtLogin-Modern) instead.**
+
+It's usually quite a [convoluted and error-prone process](before-after.md) to add this (on macOS 12 and older). **No more!**
 
 This package works with both sandboxed and non-sandboxed apps and it's App Store compatible and used in apps like [Plash](https://github.com/sindresorhus/Plash), [Dato](https://sindresorhus.com/dato), [Lungo](https://sindresorhus.com/lungo), and [Battery Indicator](https://sindresorhus.com/battery-indicator).
 
+**This package uses the new [`SMAppService`](https://developer.apple.com/documentation/servicemanagement/smappservice/3945412-mainapp) on macOS 13+ and [`SMLoginItemSetEnabled`](https://developer.apple.com/documentation/servicemanagement/1501557-smloginitemsetenabled) on older macOS versions.**
+
+### Why should I use this package now that [`SMAppService`](https://developer.apple.com/documentation/servicemanagement/smappservice/3945412-mainapp?changes=latest_minor) exists?
+
+- Backwards compatibility with older macOS versions
+- Nicer API
+- Included SwiftUI component
+
 ## Requirements
 
 macOS 10.13+
 
 ## Install
 
-#### Swift Package Manager
-
 Add `https://github.com/sindresorhus/LaunchAtLogin` in the [“Swift Package Manager” tab in Xcode](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app).
 
-#### Carthage
-
-*Warning: Carthage is not recommended. Support for it will be removed at some point in the future.*
-
-```
-github "sindresorhus/LaunchAtLogin"
-```
-
 ## Usage
 
-#### Swift Package Manager
+**Skip this step if your app targets macOS 13 or later.**
 
 Add a new [“Run Script Phase”](http://stackoverflow.com/a/39633955/64949) **below** (not into) “Copy Bundle Resources” in “Build Phases” with the following:
 
@@ -38,16 +38,6 @@ And uncheck “Based on dependency analysis”.
 
 *(I would name the run script `Copy “Launch at Login Helper”`)*
 
-#### Carthage
-
-Add a new [“Run Script Phase”](http://stackoverflow.com/a/39633955/64949) **below** (not into) “Embed Frameworks” in “Build Phases” with the following:
-
-```sh
-"${PROJECT_DIR}/Carthage/Build/Mac/LaunchAtLogin.framework/Resources/copy-helper.sh"
-```
-
-*(I would name the run script `Copy “Launch at Login Helper”`)*
-
 ### Use it in your app
 
 No need to store any state to UserDefaults.
@@ -128,6 +118,10 @@ final class ViewModel {
 }
 ```
 
+#### Swift Concurrency
+
+Use [`LaunchAtLogin.publisher.values`](https://developer.apple.com/documentation/combine/publisher/values-1dm9r).
+
 #### Storyboards
 
 Bind the control to the `LaunchAtLogin.kvo` exposed property:
@@ -145,7 +139,7 @@ final class ViewController: NSViewController {
 
 ## How does it work?
 
-The package bundles the helper app needed to launch your app and copies it into your app at build time.
+On macOS 12 and earlier, the package bundles the helper app needed to launch your app and copies it into your app at build time. On macOS 13 and later, it calls the built-in API.
 
 ## FAQ
 
@@ -161,16 +155,12 @@ rm: […]/Resources/copy-helper.sh: No such file or directory
 Command PhaseScriptExecution failed with a nonzero exit code
 ```
 
-#### The size of my app increased after adding `LaunchAtLogin` when using Carthage
-
-The bundled launcher app is written in Swift and hence needs to embed the Swift runtime libraries. If your project targets macOS 10.14.4 or later, you can avoid embedding the Swift runtime libraries. First, open `./Carthage/Checkouts/LaunchAtLogin/LaunchAtLogin.xcodeproj` and set the deployment target to the same as your app, and then run `$ carthage build`. You'll have to do this each time you update `LaunchAtLogin`.
-
-This is not a problem when using Swift Package Manager.
-
 #### My app doesn't show up in “System Preferences › Users & Groups › Login Items”
 
 [This is the expected behavior](https://stackoverflow.com/a/15104481/64949), unfortunately.
 
+However, it will show there on macOS 13 and later.
+
 #### My app doesn't launch at login when testing
 
 This is usually caused by having one or more older builds of your app laying around somewhere on the system, and macOS picking one of those instead, which doesn't have the launch helper, and thus fails to start.
@@ -186,10 +176,6 @@ Some helpful Stack Overflow answers:
 - https://stackoverflow.com/a/53110832/64949
 - https://stackoverflow.com/a/53110852/64949
 
-#### Can you support CocoaPods?
-
-CocoaPods used to be supported, but [it did not work well](https://github.com/sindresorhus/LaunchAtLogin/issues/22) and there was no easy way to fix it, so support was dropped. Even though you mainly use CocoaPods, you can still use Swift Package Manager just for this package without any problems.
-
 #### I can't see the `LaunchAtLogin.bundle` in my debug build or I get a notarization error for developer ID distribution
 
 As discussed [here](https://github.com/sindresorhus/LaunchAtLogin/issues/50), this package tries to determine if you're making a release or debug build and clean up its install accordingly. If your debug build is missing the bundle or, conversely, your release build has the bundle and it causes a code signing error, that means this has failed.
@@ -200,8 +186,6 @@ The script's determination is based on the “Build Active Architecture Only”
 
 - [Defaults](https://github.com/sindresorhus/Defaults) - Swifty and modern UserDefaults
 - [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts) - Add user-customizable global keyboard shortcuts to your macOS app
-- [Regex](https://github.com/sindresorhus/Regex) - Swifty regular expressions
-- [Preferences](https://github.com/sindresorhus/Preferences) - Add a preferences window to your macOS app in minutes
 - [DockProgress](https://github.com/sindresorhus/DockProgress) - Show progress in your app's Dock icon
 - [create-dmg](https://github.com/sindresorhus/create-dmg) - Create a good-looking DMG for your macOS app in seconds
 - [More…](https://github.com/search?q=user%3Asindresorhus+language%3Aswift)