Update tracking for when syncing fails due to inactive session

Author: itsmeichigo

WooCommerce/Classes/System/WatchDependenciesSynchronizer.swift

@@ -81,15 +81,12 @@ final class WatchDependenciesSynchronizer: NSObject, WCSessionDelegate {
         let configurationDependencies = Publishers.CombineLatest($enablesCrashReports, $account)
 
         let watchDependencies = Publishers.CombineLatest(requiredDependencies, configurationDependencies)
-            .map { [weak self] (required, configuration) -> WatchDependencies? in
+            .map { (required, configuration) -> WatchDependencies? in
 
                 let (storeID, storeName, credentials, currencySettings) = required
                 let (enablesCrashReports, account) = configuration
 
-                guard let storeID, let storeName, let credentials else {
-                    self?.analytics.track(.watchSyncingFailed, withError: SyncError.missingStoreDetailsOrCredentials)
-                    return nil
-                }
+                guard let storeID, let storeName, let credentials else { return nil }
 
                 return .init(storeID: storeID,
                              storeName: storeName,
@@ -107,7 +104,15 @@ final class WatchDependenciesSynchronizer: NSObject, WCSessionDelegate {
 
                 // Do not update the context if the session is not active, the watch is not paired or the watch app is not installed.
                 guard isSessionActive, watchSession.isPaired, watchSession.isWatchAppInstalled else {
-                    self?.analytics.track(.watchSyncingFailed, withError: SyncError.watchSessionInactiveOrNotPaired)
+                    self?.analytics.track(
+                        .watchSyncingFailed,
+                        properties: [
+                            "session_active": isSessionActive,
+                            "session_paired": watchSession.isPaired,
+                            "watch_app_installed": watchSession.isWatchAppInstalled
+                        ],
+                        error: SyncError.watchSessionInactiveOrNotPaired
+                    )
                     return
                 }
 
@@ -140,11 +145,6 @@ final class WatchDependenciesSynchronizer: NSObject, WCSessionDelegate {
             .store(in: &subscriptions)
     }
 
-    func session(_ session: WCSession, activationDidCompleteWith activationState: WCSessionActivationState, error: Error?) {
-        DDLogInfo("🔵 WatchSession activated \(activationState)")
-        self.isSessionActive = activationState == .activated
-    }
-
     func sessionDidBecomeInactive(_ session: WCSession) {
         // No op
     }
@@ -162,7 +162,6 @@ extension WatchDependenciesSynchronizer {
     /// This is in order to not duplicate tracks configuration which involve quite a lot of information to be transmitted to the watch.
     ///
     func session(_ session: WCSession, didReceiveUserInfo userInfo: [String: Any] = [:]) {
-
         // The user info could contain a track event. Send it if we found one.
         guard let rawEvent = userInfo[WooConstants.watchTracksKey] as? String,
               let analyticEvent = WooAnalyticsStat(rawValue: rawEvent) else {
@@ -183,11 +182,14 @@ extension WatchDependenciesSynchronizer {
     /// When one is identified we should try to re-sync credentials.
     ///
     func session(_ session: WCSession, didReceiveMessage message: [String: Any]) {
-        guard message[WooConstants.watchSyncKey] as? Bool == true else {
+        if message[WooConstants.watchSyncKey] as? Bool == true {
+            syncTrigger.toggle()
+        } else if message[WooConstants.watchSessionActivatedKey] as? Bool == true {
+            self.isSessionActive = true
+            DDLogInfo("🔵 WatchSession activated)")
+        } else {
             return DDLogError("⛔️ Unsupported sync request message: \(message)")
         }
-
-        syncTrigger.toggle()
     }
 }
 

WooCommerce/Classes/System/WooConstants.swift

@@ -85,6 +85,10 @@ public enum WooConstants {
     ///
     static let watchTracksKey = "watch-tracks-event"
 
+    /// Key used to identify when session is activated on the watch.
+    ///
+    static let watchSessionActivatedKey = "watch_session_activated"
+
     /// Key used to identify sync request attempt from the watch.
     ///
     static let watchSyncKey = "watch-sync-event"

WooCommerce/Woo Watch App/ConnectView.swift

@@ -18,6 +18,10 @@ struct ConnectView: View {
                     .multilineTextAlignment(.center)
                     .fixedSize(horizontal: false, vertical: true)
 
+                Text(Localization.workaroundTip)
+                    .multilineTextAlignment(.center)
+                    .fixedSize(horizontal: false, vertical: true)
+
                 Image(systemName: "bolt.fill")
                     .renderingMode(.original)
                     .resizable()
@@ -44,10 +48,14 @@ extension ConnectView {
 
     private enum Localization {
         static let connectMessage = AppLocalizedString(
-            "watch.connect.messageWithWorkaround",
-            value: "Open Woo on your iPhone, log into your store, and hold your Watch nearby. " +
-            "If the issue persists, relaunch the app.",
-            comment: "Info message when connecting your watch to the phone for the first time with a workaround option."
+            "watch.connect.messageUpdated",
+            value: "Open Woo on your iPhone, log into your store, and hold your Watch nearby.",
+            comment: "Info message when connecting your watch to the phone for the first time."
+        )
+        static let workaroundTip = AppLocalizedString(
+            "watch.connect.workaround",
+            value: "If the error persists, relaunch the app.",
+            comment: "Workaround when connecting the watch to the phone fails."
         )
         static let itsNotWorking = AppLocalizedString(
             "watch.connect.notworking.title",

WooCommerce/Woo Watch App/Dependencies/PhoneDependenciesSynchronizer.swift

@@ -42,6 +42,10 @@ final class PhoneDependenciesSynchronizer: NSObject, ObservableObject, WCSession
     /// Get the latest application context when the session activates
     ///
     func session(_ session: WCSession, activationDidCompleteWith activationState: WCSessionActivationState, error: Error?) {
+        if error == nil {
+            WCSession.default.sendMessage([WooConstants.watchSessionActivatedKey: true], replyHandler: nil)
+        }
+
         DispatchQueue.main.async {
             self.storeDependencies(appContext: session.receivedApplicationContext)
             self.reloadDependencies()