Move ConnectivityObserver to WooFoundation for reusability and set to environment in POS

Author: staskus

Modules/Sources/PointOfSale/DependencyProviders/POSDependencyProviding.swift

@@ -12,6 +12,7 @@ public protocol POSDependencyProviding {
     var currency: CurrencySettings { get }
     var featureFlags: POSFeatureFlagProviding { get }
     var session: POSSessionManagerProviding { get }
+    var connectivity: ConnectivityObserver { get }
 }
 
 /// Analytics service abstraction

Modules/Sources/PointOfSale/Environment/POSEnvironmentKeys.swift

@@ -1,4 +1,5 @@
 import SwiftUI
+import Combine
 import WooFoundation
 import Experiments
 import protocol Yosemite.Action
@@ -48,6 +49,11 @@ public struct POSSessionManagerKey: EnvironmentKey {
     public static let defaultValue: POSSessionManagerProviding = DefaultPOSSessionManager()
 }
 
+/// Environment key for POS connectivity
+public struct POSConnectivityKey: EnvironmentKey {
+    public static let defaultValue: ConnectivityObserver = DefaultPOSConnectivity()
+}
+
 // Default implementations for testing/previews
 private struct DefaultPOSStores: POSStoresProviding {
     func dispatch(_ action: Yosemite.Action) {}
@@ -61,6 +67,13 @@ private struct DefaultPOSFeatureFlags: POSFeatureFlagProviding {
     func isFeatureFlagEnabled(_ flag: FeatureFlag) -> Bool { false }
 }
 
+private class DefaultPOSConnectivity: ConnectivityObserver {
+    @Published private(set) var currentStatus: ConnectivityStatus = .reachable(type: .ethernetOrWiFi)
+    var statusPublisher: AnyPublisher<ConnectivityStatus, Never> { $currentStatus.eraseToAnyPublisher() }
+    func startObserving() {}
+    func stopObserving() {}
+}
+
 public extension EnvironmentValues {
     var posAnalytics: POSAnalyticsProviding {
         get { self[POSAnalyticsKey.self] }
@@ -86,4 +99,9 @@ public extension EnvironmentValues {
         get { self[POSSessionManagerKey.self] }
         set { self[POSSessionManagerKey.self] = newValue }
     }
+
+    var posConnectivity: ConnectivityObserver {
+        get { self[POSConnectivityKey.self] }
+        set { self[POSConnectivityKey.self] = newValue }
+    }
 }

WooCommerce/Classes/Tools/Connectivity/ConnectivityObserver.swift renamed to Modules/Sources/WooFoundation/Utilities/Connectivity/ConnectivityObserver.swift

@@ -2,7 +2,7 @@ import Combine
 
 /// Interface for the observing connectivity
 ///
-protocol ConnectivityObserver {
+public protocol ConnectivityObserver {
     /// Getter for current state of the connectivity.
     var currentStatus: ConnectivityStatus { get }
 
@@ -21,7 +21,7 @@ protocol ConnectivityObserver {
 /// - unknown:      It is unknown whether the network is reachable.
 /// - notReachable: The network is not reachable.
 /// - reachable:    The network is reachable.
-enum ConnectivityStatus: Equatable {
+public enum ConnectivityStatus: Equatable {
     case unknown
     case notReachable
     case reachable(type: ConnectionType)
@@ -32,7 +32,7 @@ enum ConnectivityStatus: Equatable {
 /// - ethernetOrWiFi: The connection type is either over Ethernet or WiFi.
 /// - cellular:       The connection type is a cellular connection.
 /// - other:          The connection type is via a local loopback network, virtual network or other unknown types.
-enum ConnectionType: Equatable {
+public enum ConnectionType: Equatable {
     case ethernetOrWiFi
     case cellular
     case other

WooCommerce/Classes/Tools/Connectivity/DefaultConnectivityObserver.swift renamed to Modules/Sources/WooFoundation/Utilities/Connectivity/DefaultConnectivityObserver.swift

@@ -1,19 +1,23 @@
 import Combine
 import Network
 
-final class DefaultConnectivityObserver: ConnectivityObserver {
+public final class DefaultConnectivityObserver: ConnectivityObserver {
 
     /// Network monitor to evaluate connection.
     ///
     private let networkMonitor: NetworkMonitoring
     private let observingQueue: DispatchQueue = .global(qos: .background)
 
-    @Published private(set) var currentStatus: ConnectivityStatus = .unknown
+    @Published private(set) public var currentStatus: ConnectivityStatus = .unknown
 
-    var statusPublisher: AnyPublisher<ConnectivityStatus, Never> {
+    public var statusPublisher: AnyPublisher<ConnectivityStatus, Never> {
         $currentStatus.eraseToAnyPublisher()
     }
 
+    public convenience init() {
+        self.init(networkMonitor: NWPathMonitor())
+    }
+
     init(networkMonitor: NetworkMonitoring = NWPathMonitor()) {
         self.networkMonitor = networkMonitor
         startObserving()
@@ -25,11 +29,11 @@ final class DefaultConnectivityObserver: ConnectivityObserver {
         }
     }
 
-    func startObserving() {
+    public func startObserving() {
         networkMonitor.start(queue: observingQueue)
     }
 
-    func stopObserving() {
+    public func stopObserving() {
         networkMonitor.cancel()
     }
 

WooCommerce/Classes/POS/Adaptors/POSServiceLocatorAdaptor.swift

@@ -12,23 +12,27 @@ import struct Yosemite.Site
 /// Adaptor that bridges main app ServiceLocator to POS dependency abstraction to support POS modularization
 final class POSServiceLocatorAdaptor: POSDependencyProviding {
     var analytics: POSAnalyticsProviding {
-        return POSAnalyticsAdaptor()
+        POSAnalyticsAdaptor()
     }
 
     var stores: POSStoresProviding {
-        return POSStoresAdaptor(stores: ServiceLocator.stores)
+        POSStoresAdaptor(stores: ServiceLocator.stores)
     }
 
     var currency: CurrencySettings {
-        return ServiceLocator.currencySettings
+        ServiceLocator.currencySettings
     }
 
     var featureFlags: POSFeatureFlagProviding {
-        return POSFeatureFlagAdaptor(featureFlagService: ServiceLocator.featureFlagService)
+        POSFeatureFlagAdaptor(featureFlagService: ServiceLocator.featureFlagService)
     }
 
     var session: POSSessionManagerProviding {
-        return POSSessionManagerAdaptor(sessionManager: ServiceLocator.stores.sessionManager)
+        POSSessionManagerAdaptor(sessionManager: ServiceLocator.stores.sessionManager)
+    }
+
+    var connectivity: ConnectivityObserver {
+        ServiceLocator.connectivityObserver
     }
 }
 

WooCommerce/Classes/POS/Presentation/PointOfSaleEntryPointView.swift

@@ -85,6 +85,7 @@ struct PointOfSaleEntryPointView: View {
         .environment(\.posStores, services.stores)
         .environment(\.posFeatureFlags, services.featureFlags)
         .environment(\.posSession, services.session)
+        .environment(\.posConnectivity, services.connectivity)
         .injectKeyboardObserver()
         .onAppear {
             onPointOfSaleModeActiveStateChange(true)

WooCommerce/Classes/POS/Presentation/Reusable Views/POSConnectivityView.swift

@@ -1,10 +1,11 @@
 import SwiftUI
 import Combine
+import enum WooFoundation.ConnectivityStatus
 
 struct POSConnectivityView: View {
-    let connectivityObserver: ConnectivityObserver = ServiceLocator.connectivityObserver
     @State private var isVisible = false
     @State private var cancellable: AnyCancellable?
+    @Environment(\.posConnectivity) private var connectivityObserver
 
     var body: some View {
         ZStack(alignment: .top) {

WooCommerce/Classes/POS/Utils/PreviewHelpers.swift

@@ -298,6 +298,7 @@ final class POSPreviewServices: POSDependencyProviding {
     var currency: CurrencySettings = CurrencySettings()
     var featureFlags: POSFeatureFlagProviding = POSPreviewFeatureFlags()
     var session: POSSessionManagerProviding = POSPreviewSessionManager()
+    var connectivity: ConnectivityObserver = POSPreviewConnectivity()
 }
 
 // Preview implementations for all service types
@@ -313,4 +314,11 @@ private struct POSPreviewFeatureFlags: POSFeatureFlagProviding {
     func isFeatureFlagEnabled(_ flag: FeatureFlag) -> Bool { false }
 }
 
+private class POSPreviewConnectivity: ConnectivityObserver {
+    @Published private(set) var currentStatus: ConnectivityStatus = .reachable(type: .ethernetOrWiFi)
+    var statusPublisher: AnyPublisher<ConnectivityStatus, Never> { $currentStatus.eraseToAnyPublisher() }
+    func startObserving() {}
+    func stopObserving() {}
+}
+
 #endif

WooCommerce/Classes/System/WooNavigationController.swift

@@ -1,5 +1,7 @@
 import Combine
 import UIKit
+import protocol WooFoundation.ConnectivityObserver
+import enum WooFoundation.ConnectivityStatus
 
 /// Subclass to set Woo styling. Removes back button text on managed view controllers.
 ///

WooCommerce/Classes/ViewRelated/Dashboard/DashboardView.swift

@@ -5,6 +5,7 @@ import struct Yosemite.StoreOnboardingTask
 import struct Yosemite.Coupon
 import struct Yosemite.Order
 import struct Yosemite.DashboardCard
+import enum WooFoundation.ConnectivityStatus
 
 /// View for the dashboard screen
 ///