π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
[mobile][photos] Trace native background task startup
laurenspriem2bda4b98dc42
diff --git a/mobile/apps/photos/ios/Runner/AppDelegate.swift b/mobile/apps/photos/ios/Runner/AppDelegate.swiftindex 77d5e4fc60..9a9b2287f0 100644--- a/mobile/apps/photos/ios/Runner/AppDelegate.swift+++ b/mobile/apps/photos/ios/Runner/AppDelegate.swift@@ -10,21 +10,45 @@ import workmanager_apple@objc class AppDelegate: FlutterAppDelegate {private static let workmanagerDebugThreadIdentifier ="io.ente.frame.workmanager.debug"+ private let startupTrace: BackgroundStartupTrace = {+ let trace = BackgroundStartupTrace(scope: "app")+ trace.event("app.delegate.initializing")+ return trace+ }()private let foregroundHeartbeat = ForegroundHeartbeat()+ override func application(+ _ application: UIApplication,+ willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?+ ) -> Bool {+ startupTrace.event(+ "app.willFinishLaunching.begin",+ detail: "applicationState=\(application.applicationState.rawValue)")+ defer { startupTrace.event("app.willFinishLaunching.end") }+ return super.application(application, willFinishLaunchingWithOptions: launchOptions)+ }+override func application(_ application: UIApplication,didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {- configureWorkmanagerDebugHandler()+ startupTrace.event(+ "app.didFinishLaunching.begin",+ detail: "applicationState=\(application.applicationState.rawValue)")+ defer { startupTrace.event("app.didFinishLaunching.end") }+ startupTrace.measure("app.debugHandler") {+ configureWorkmanagerDebugHandler()+ }// Prevent interrupting background audio from other apps on launchdo {- try AVAudioSession.sharedInstance().setCategory(- .ambient,- mode: .default,- options: [.mixWithOthers]- )+ try startupTrace.measure("app.audioSession") {+ try AVAudioSession.sharedInstance().setCategory(+ .ambient,+ mode: .default,+ options: [.mixWithOthers]+ )+ }} catch {print("Failed to configure initial audio session: \(error)")}@@ -33,33 +57,45 @@ import workmanager_appleUNUserNotificationCenter.current().delegate = self as UNUserNotificationCenterDelegate}- GeneratedPluginRegistrant.register(with: self)- BackgroundManagerPlugin.install(- isEnabled: { Self.shouldUseNativeBackgroundManager() },- registrant: { registry in GeneratedPluginRegistrant.register(with: registry) }- )+ startupTrace.measure("app.plugins") {+ GeneratedPluginRegistrant.register(with: self)+ }+ startupTrace.measure("app.backgroundManager.install") {+ BackgroundManagerPlugin.install(+ isEnabled: { Self.shouldUseNativeBackgroundManager() },+ registrant: { registry in GeneratedPluginRegistrant.register(with: registry) }+ )+ }BackgroundManagerPlugin.registerTask(identifier: "io.ente.photos.nativeBackgroundRefresh", processing: false)BackgroundManagerPlugin.registerTask(identifier: "io.ente.photos.nativeBackgroundProcessing", processing: true)WorkmanagerPlugin.setPluginRegistrantCallback { registry in- GeneratedPluginRegistrant.register(with: registry)- }- var freqInMinutes = 30 * 60- WorkmanagerPlugin.registerPeriodicTask(- withIdentifier: "io.ente.frame.iOSBackgroundAppRefresh",- frequency: NSNumber(value: freqInMinutes))- WorkmanagerPlugin.registerBGProcessingTask(- withIdentifier: "io.ente.frame.iOSBackgroundProcessing")-- if let url = AppLinks.shared.getLink(launchOptions: launchOptions) {- // only accept non-homewidget urls for AppLinks- if !url.absoluteString.contains("homeWidget") {- AppLinks.shared.handleLink(url: url)+ BackgroundStartupTrace(scope: "workmanager").measure("task.plugins") {+ GeneratedPluginRegistrant.register(with: registry)}}+ startupTrace.measure("app.workmanager.register") {+ let freqInMinutes = 30 * 60+ WorkmanagerPlugin.registerPeriodicTask(+ withIdentifier: "io.ente.frame.iOSBackgroundAppRefresh",+ frequency: NSNumber(value: freqInMinutes))+ WorkmanagerPlugin.registerBGProcessingTask(+ withIdentifier: "io.ente.frame.iOSBackgroundProcessing")+ }- return super.application(application, didFinishLaunchingWithOptions: launchOptions)+ startupTrace.measure("app.links") {+ if let url = AppLinks.shared.getLink(launchOptions: launchOptions) {+ // only accept non-homewidget urls for AppLinks+ if !url.absoluteString.contains("homeWidget") {+ AppLinks.shared.handleLink(url: url)+ }+ }+ }++ return startupTrace.measure("app.super.didFinishLaunching") {+ super.application(application, didFinishLaunchingWithOptions: launchOptions)+ }}private func configureWorkmanagerDebugHandler() {@@ -91,14 +127,15 @@ import workmanager_appleif defaults.bool(forKey: "flutter.ls.internal_user_disabled") {return false}- if !defaults.bool(forKey: "flutter.ls.bg_debug_notifications_enabled") &&- defaults.object(forKey: "flutter.ls.bg_debug_notifications_enabled") != nil {+ if !defaults.bool(forKey: "flutter.ls.bg_debug_notifications_enabled")+ && defaults.object(forKey: "flutter.ls.bg_debug_notifications_enabled") != nil+ {return false}guard let remoteFlags = defaults.string(forKey: "flutter.remote_flags"),- let data = remoteFlags.data(using: .utf8),- let json = try? JSONSerialization.jsonObject(with: data) as? [String: Any]+ let data = remoteFlags.data(using: .utf8),+ let json = try? JSONSerialization.jsonObject(with: data) as? [String: Any]else {return false}@@ -107,16 +144,19 @@ import workmanager_apple}override func applicationDidBecomeActive(_ application: UIApplication) {+ startupTrace.event("app.didBecomeActive")foregroundHeartbeat.start()signal(SIGPIPE, SIG_IGN)}override func applicationWillEnterForeground(_ application: UIApplication) {+ startupTrace.event("app.willEnterForeground")foregroundHeartbeat.start()signal(SIGPIPE, SIG_IGN)}override func applicationDidEnterBackground(_ application: UIApplication) {+ startupTrace.event("app.didEnterBackground")foregroundHeartbeat.stop()super.applicationDidEnterBackground(application)}diff --git a/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundRuntime.swift b/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundRuntime.swiftindex f22b918525..5f2e747330 100644--- a/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundRuntime.swift+++ b/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundRuntime.swift@@ -25,7 +25,8 @@ final class BackgroundRuntime: NSObject {let task: BGTasklet configuration: TaskConfigurationlet startedAt: TimeInterval- let invocation = UUID().uuidString+ let invocation: String+ let trace: BackgroundStartupTracevar engine: FlutterEngine?var channel: FlutterMethodChannel?var ready = false@@ -35,10 +36,12 @@ final class BackgroundRuntime: NSObject {var foregroundTimer: DispatchWorkItem?var stopResults: [FlutterResult] = []- init(task: BGTask, configuration: TaskConfiguration, startedAt: TimeInterval) {+ init(task: BGTask, configuration: TaskConfiguration, trace: BackgroundStartupTrace) {self.task = taskself.configuration = configuration- self.startedAt = startedAt+ self.startedAt = trace.startedAt+ self.invocation = trace.invocation+ self.trace = trace}}@@ -65,14 +68,21 @@ final class BackgroundRuntime: NSObject {func register(identifier: String, processing: Bool) -> Bool {if let existing = registrations[identifier] { return existing == processing }- let registered = BGTaskScheduler.shared.register(- forTaskWithIdentifier: identifier, using: .main- ) { task in- let startedAt = ProcessInfo.processInfo.systemUptime- MainActor.assumeIsolated {- self.deliver(task, startedAt: startedAt)+ let trace = BackgroundStartupTrace(scope: identifier)+ let registered = trace.measure("task.register") {+ BGTaskScheduler.shared.register(+ forTaskWithIdentifier: identifier, using: .main+ ) { task in+ let startedAt = ProcessInfo.processInfo.systemUptime+ let deliveryTrace = BackgroundStartupTrace(+ scope: task.identifier, invocation: UUID().uuidString, startedAt: startedAt)+ deliveryTrace.event("task.delivered")+ MainActor.assumeIsolated {+ self.deliver(task, trace: deliveryTrace)+ }}}+ trace.event("task.register.result", detail: "registered=\(registered)")if registered {registrations[identifier] = processing} else {@@ -248,20 +258,25 @@ final class BackgroundRuntime: NSObject {}}- private func deliver(_ task: BGTask, startedAt: TimeInterval) {+ private func deliver(_ task: BGTask, trace: BackgroundStartupTrace) {scheduleRevision += 1guard configuration.enabled,let policy = configuration.tasks.first(where: { $0.identifier == task.identifier })else {BGTaskScheduler.shared.cancel(taskRequestWithIdentifier: task.identifier)+ trace.event("task.skipped", detail: "reason=disabled")report(identifier: task.identifier, outcome: "skipped", reason: "disabled")task.setTaskCompleted(success: true)+ trace.event("task.completed", detail: "success=true")return}do {- try submit(policy, delayMs: policy.frequencyMs)- try recordSubmitted(policy)+ try trace.measure("task.reschedule") {+ try submit(policy, delayMs: policy.frequencyMs)+ try recordSubmitted(policy)+ }} catch {+ trace.event("task.reschedule.failed")report(identifier: task.identifier, outcome: "failed", reason: "schedule",error: String(describing: error))@@ -271,9 +286,10 @@ final class BackgroundRuntime: NSObject {occupant.configuration.kind == "refresh", !occupant.retiring, waiting == nil,!["foreground", "requested", "system"].contains(occupant.stopReason ?? ""){- let run = Run(task: task, configuration: policy, startedAt: startedAt)+ let run = Run(task: task, configuration: policy, trace: trace)waiting = runobserveExpiration(run)+ trace.event("task.waitingForRefresh")Self.logger.info("\(policy.identifier, privacy: .public): waiting for refresh")if let budget = policy.runBudgetMs {let remaining = budget - elapsed(run)@@ -301,18 +317,23 @@ final class BackgroundRuntime: NSObject {skip = nil}if let skip {+ trace.event("task.skipped", detail: "reason=\(skip)")report(identifier: task.identifier, outcome: "skipped", reason: skip)task.setTaskCompleted(success: true)+ trace.event("task.completed", detail: "success=true")return}- let run = Run(task: task, configuration: policy, startedAt: startedAt)+ let run = Run(task: task, configuration: policy, trace: trace)start(run)}private func observeExpiration(_ run: Run) {+ let trace = run.tracerun.task.expirationHandler = { [weak run] in+ trace.event("task.expiration.received")DispatchQueue.main.async {guard let run else { return }+ trace.event("task.expiration.handled")if self.waiting === run {self.finishWaiting(run, outcome: "stopped", reason: "expired", success: false)} else if self.active === run {@@ -324,6 +345,8 @@ final class BackgroundRuntime: NSObject {}private func start(_ run: Run) {+ run.trace.event(+ "task.start", detail: "applicationState=\(UIApplication.shared.applicationState.rawValue)")let policy = run.configurationactive = runobserveExpiration(run)@@ -336,19 +359,25 @@ final class BackgroundRuntime: NSObject {DispatchQueue.main.asyncAfter(deadline: .now() + Double(max(0, budget - elapsed(run))) / 1000, execute: timer)}- guard let callback = FlutterCallbackCache.lookupCallbackInformation(policy.callbackHandle),+ let callback = run.trace.measure("task.callbackLookup") {+ FlutterCallbackCache.lookupCallbackInformation(policy.callbackHandle)+ }+ guard let callback,let registrantelse {retire(run, outcome: "failed", reason: "bootstrap", error: "Background dispatcher is unavailable")return}- let engine = FlutterEngine(- name: "ente-background-\(run.invocation)", project: nil, allowHeadlessExecution: true)+ let engine = run.trace.measure("task.engine.create") {+ FlutterEngine(+ name: "ente-background-\(run.invocation)", project: nil, allowHeadlessExecution: true)+ }run.engine = engine- guard+ let engineStarted = run.trace.measure("task.engine.run") {engine.run(withEntrypoint: callback.callbackName, libraryURI: callback.callbackLibraryPath)- else {+ }+ guard engineStarted else {retire(run, outcome: "failed", reason: "bootstrap", error: "Flutter engine failed to start")return}@@ -367,6 +396,7 @@ final class BackgroundRuntime: NSObject {FlutterError(code: "bootstrap", message: "Dispatcher already started", details: nil))return}+ run.trace.event("task.dart.ready")run.ready = truevar data: [String: Any] = ["identifier": policy.identifier,@@ -387,13 +417,16 @@ final class BackgroundRuntime: NSObject {)return}+ run.trace.event("task.dart.complete", detail: "outcome=\(outcome)")result(nil)self.retire(run, outcome: outcome, reason: run.stopReason, error: data["error"] as? String)default:result(FlutterMethodNotImplemented)}}- registrant(engine)+ run.trace.measure("task.plugins") {+ registrant(engine)+ }}private func finishWaiting(@@ -405,6 +438,8 @@ final class BackgroundRuntime: NSObject {run.budgetTimer?.cancel()run.task.expirationHandler = nilrun.task.setTaskCompleted(success: success)+ run.trace.event(+ "task.completed", detail: "outcome=\(outcome) reason=\(reason) success=\(success)")report(identifier: run.configuration.identifier, outcome: outcome, reason: reason)}@@ -443,6 +478,7 @@ final class BackgroundRuntime: NSObject {guard active === run, !run.retiring else { return }if run.stopReason == nil {run.stopReason = reason+ run.trace.event("task.stop", detail: "reason=\(reason) dartReady=\(run.ready)")if run.ready {run.channel?.invokeMethod("stop", arguments: ["invocation": run.invocation, "reason": reason])@@ -469,12 +505,16 @@ final class BackgroundRuntime: NSObject {run.foregroundTimer?.cancel()run.task.expirationHandler = nillet terminal = outcome == "completed" && run.stopReason != nil ? "stopped" : outcome+ run.trace.event("task.retire", detail: "outcome=\(terminal) reason=\(reason ?? "none")")run.channel?.setMethodCallHandler(nil)- run.engine?.destroyContext()+ run.trace.measure("task.engine.destroy") {+ run.engine?.destroyContext()+ }run.channel = nilrun.engine = nil- run.task.setTaskCompleted(- success: success ?? (terminal != "failed" && terminal != "forcedTeardown"))+ let completedSuccessfully = success ?? (terminal != "failed" && terminal != "forcedTeardown")+ run.task.setTaskCompleted(success: completedSuccessfully)+ run.trace.event("task.completed", detail: "success=\(completedSuccessfully)")active = nilstartWaiting()if terminal != "completed" {diff --git a/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundStartupTrace.swift b/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundStartupTrace.swiftnew file mode 100644index 0000000000..8a195695ce--- /dev/null+++ b/mobile/apps/photos/plugins/ente_background_manager/ios/Classes/BackgroundStartupTrace.swift@@ -0,0 +1,38 @@+import Foundation+import os++public struct BackgroundStartupTrace: Sendable {+ private static let logger = Logger(subsystem: "io.ente.background", category: "Startup")+ private let scope: String+ let invocation: String+ let startedAt: TimeInterval++ public init(+ scope: String, invocation: String = "-",+ startedAt: TimeInterval = ProcessInfo.processInfo.systemUptime+ ) {+ self.scope = scope+ self.invocation = invocation+ self.startedAt = startedAt+ }++ public func event(_ stage: String, detail: String = "-") {+ let uptime = ProcessInfo.processInfo.systemUptime+ let elapsedMs = Int64(max(0, uptime - startedAt) * 1000)+ let uptimeMs = Int64(uptime * 1000)+ let pid = ProcessInfo.processInfo.processIdentifier+ Self.logger.notice(+ "pid=\(pid) scope=\(scope, privacy: .public) invocation=\(invocation, privacy: .public) stage=\(stage, privacy: .public) uptimeMs=\(uptimeMs) elapsedMs=\(elapsedMs) mainThread=\(Thread.isMainThread) detail=\(detail, privacy: .public)"+ )+ }++ public func measure<T>(_ stage: String, _ body: () throws -> T) rethrows -> T {+ let start = ProcessInfo.processInfo.systemUptime+ event("\(stage).begin")+ defer {+ let durationMs = Int64(max(0, ProcessInfo.processInfo.systemUptime - start) * 1000)+ event("\(stage).end", detail: "durationMs=\(durationMs)")+ }+ return try body()+ }+}