BuildSettingsKit v2

Modules/Sources/BuildSettingsKit/BuildSettings+Live.swift

@@ -0,0 +1,45 @@
+import Foundation
+
+extension BuildSettings {
+    static let live = BuildSettings(bundle: .app)
+
+    init(bundle: Bundle) {
+        pushNotificationAppID = bundle.infoValue(forKey: "WPPushNotificationAppID")
+        appGroupName = bundle.infoValue(forKey: "WPAppGroupName")
+        appKeychainAccessGroup = bundle.infoValue(forKey: "WPAppKeychainAccessGroup")
+    }
+}
+
+private extension Bundle {
+    func infoValue<T>(forKey key: String) -> T where T: LosslessStringConvertible {
+        guard let object = object(forInfoDictionaryKey: key) else {
+            fatalError("missing value for key: \(key)")
+        }
+        switch object {
+        case let value as T:
+            return value
+        case let string as String:
+            guard let value = T(string) else { fallthrough }
+            return value
+        default:
+            fatalError("unexpected value: \(object) for key: \(key)")
+        }
+    }
+}
+
+private extension Bundle {
+    /// Returns the `Bundle` for the host `.app`.
+    ///
+    /// - If this is called from code already located in the main app's bundle or from a Pod/Framework,
+    ///   this will return the same as `Bundle.main`, aka the bundle of the app itself.
+    /// - If this is called from an App Extension (Widget, ShareExtension, etc), this will return the bundle of the
+    ///   main app hosting said App Extension (while `Bundle.main` would return the App Extension itself)
+    static let app: Bundle = {
+        var url = Bundle.main.bundleURL
+        while url.pathExtension != "app" && url.lastPathComponent != "/" {
+            url.deleteLastPathComponent()
+        }
+        guard let appBundle = Bundle(url: url) else { fatalError("Unable to find the parent app bundle") }
+        return appBundle
+    }()
+}

Modules/Sources/BuildSettingsKit/BuildSettings+Preview.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+/// The container for Xcode previews.
+extension BuildSettings {
+    nonisolated(unsafe) static var preview = BuildSettings(
+        pushNotificationAppID: "xcpreview_push_notification_id",
+        appGroupName: "xcpreview_app_group_name",
+        appKeychainAccessGroup: "xcpreview_app_keychain_access_group"
+    )
+}
+
+extension BuildSettings {
+    /// Updates the preview settings for the lifetime of the given closure.
+    /// Reverts to the original settings when done.
+    @MainActor
+    public static func withSettings<T>(_ configure: (inout BuildSettings) -> Void, perform closure: () -> T) -> T {
+        var container = BuildSettings.preview
+        let original = container
+        configure(&container)
+        BuildSettings.preview = container
+        let value = closure()
+        BuildSettings.preview = original
+        return value
+    }
+}

Modules/Sources/BuildSettingsKit/BuildSettings.swift

@@ -1,35 +1,25 @@
 import Foundation
 
-/// Provides convenient access for values defined in Info.plist files for
-/// apps and app extensions.
+/// Manages global build settings.
 ///
-/// - warning: Most of these values exist only in Info.plist files for apps as
-/// app extensions only need a tiny subset of these settings.
-public enum BuildSettings {
-    public static var pushNotificationAppID: String {
-        infoPlistValue(forKey: "WPPushNotificationAppID")
-    }
-
-    public static var appGroupName: String {
-        infoPlistValue(forKey: "WPAppGroupName")
-    }
-
-    public static var appKeychainAccessGroup: String {
-        infoPlistValue(forKey: "WPAppKeychainAccessGroup")
-    }
-}
+/// The build settings work differently depending on the environment:
+///
+/// - **Live** – the code runs as part of an app or app extensions with build
+/// settings configured using the `Info.plist` file.
+/// - **Preview** – the code runs as part of the SwiftPM or Xcode target. In this
+/// environment, the build settings have predefined values that can also be
+/// changed at runtime.
+/// - **Test** – `BuildSettings` are not available when running unit tests as
+/// they are incompatible with parallelized tests and are generally not recommended.
+public struct BuildSettings: Sendable {
+    public var pushNotificationAppID: String
+    public var appGroupName: String
+    public var appKeychainAccessGroup: String
 
-private func infoPlistValue<T>(forKey key: String) -> T where T: LosslessStringConvertible {
-    guard let object = Bundle.main.object(forInfoDictionaryKey: key) else {
-        fatalError("missing value for key: \(key)")
-    }
-    switch object {
-    case let value as T:
-        return value
-    case let string as String:
-        guard let value = T(string) else { fallthrough }
-        return value
-    default:
-        fatalError("unexpected value: \(object) for key: \(key)")
+    public static var current: BuildSettings {
+        switch BuildSettingsEnvironment.current {
+        case .live: .live
+        case .preview: .preview
+        }
     }
 }

Modules/Sources/BuildSettingsKit/BuildSettingsEnvironment.swift

@@ -0,0 +1,39 @@
+import Foundation
+
+enum BuildSettingsEnvironment {
+    case live
+    case preview
+
+    static let current: BuildSettingsEnvironment = {
+#if DEBUG
+        let processInfo = ProcessInfo.processInfo
+        if processInfo.isXcodePreview {
+            return .preview
+        }
+        if processInfo.isTesting {
+            fatalError("BuildSettings are unavailable when running unit tests. Make sure to inject the values manually in system under test.")
+        }
+#endif
+        return .live
+    }()
+}
+
+private extension ProcessInfo {
+    var isXcodePreview: Bool {
+        environment["XCODE_RUNNING_FOR_PREVIEWS"] == "1"
+    }
+
+    var isTesting: Bool {
+        if environment.keys.contains("XCTestBundlePath") { return true }
+        if environment.keys.contains("XCTestConfigurationFilePath") { return true }
+        if environment.keys.contains("XCTestSessionIdentifier") { return true }
+
+        return arguments.contains { argument in
+            let path = URL(fileURLWithPath: argument)
+            return path.lastPathComponent == "swiftpm-testing-helper"
+            || argument == "--testing-library"
+            || path.lastPathComponent == "xctest"
+            || path.pathExtension == "xctest"
+        }
+    }
+}

WordPress/Classes/Services/NotificationSettingsService.swift

@@ -146,7 +146,7 @@ class NotificationSettingsService {
 
         notificationsServiceRemote?.registerDeviceForPushNotifications(
             token,
-            pushNotificationAppId: BuildSettings.pushNotificationAppID,
+            pushNotificationAppId: BuildSettings.current.pushNotificationAppID,
             success: success,
             failure: failure
         )

WordPress/Classes/Services/NotificationSupportService.swift

@@ -7,7 +7,7 @@ open class NotificationSupportService: NSObject {
     private let appKeychainAccessGroup: String
 
     @objc convenience override init() {
-        self.init(appKeychainAccessGroup: BuildSettings.appKeychainAccessGroup)
+        self.init(appKeychainAccessGroup: BuildSettings.current.appKeychainAccessGroup)
     }
 
     init(appKeychainAccessGroup: String) {

WordPress/Classes/Services/ShareExtensionService.swift

@@ -9,8 +9,8 @@ open class ShareExtensionService: NSObject {
 
     @objc public convenience override init() {
         self.init(
-            appGroupName: BuildSettings.appGroupName,
-            appKeychainAccessGroup: BuildSettings.appKeychainAccessGroup
+            appGroupName: BuildSettings.current.appGroupName,
+            appKeychainAccessGroup: BuildSettings.current.appKeychainAccessGroup
         )
     }
 

WordPress/Classes/Stores/StatsWidgetsStore.swift

@@ -10,8 +10,8 @@ class StatsWidgetsStore {
     private let appKeychainAccessGroup: String
 
     init(coreDataStack: CoreDataStack = ContextManager.shared,
-         appGroupName: String = BuildSettings.appGroupName,
-         appKeychainAccessGroup: String = BuildSettings.appKeychainAccessGroup) {
+         appGroupName: String = BuildSettings.current.appGroupName,
+         appKeychainAccessGroup: String = BuildSettings.current.appKeychainAccessGroup) {
         self.coreDataStack = coreDataStack
         self.appGroupName = appGroupName
         self.appKeychainAccessGroup = appKeychainAccessGroup
@@ -27,17 +27,17 @@ class StatsWidgetsStore {
         initializeStatsWidgetsIfNeeded()
 
         if let newTodayData = refreshStats(type: HomeWidgetTodayData.self) {
-            HomeWidgetTodayData.write(items: newTodayData)
+            setCachedItems(newTodayData)
             WidgetCenter.shared.reloadTodayTimelines()
         }
 
         if let newAllTimeData = refreshStats(type: HomeWidgetAllTimeData.self) {
-            HomeWidgetAllTimeData.write(items: newAllTimeData)
+            setCachedItems(newAllTimeData)
             WidgetCenter.shared.reloadAllTimeTimelines()
         }
 
         if let newThisWeekData = refreshStats(type: HomeWidgetThisWeekData.self) {
-            HomeWidgetThisWeekData.write(items: newThisWeekData)
+            setCachedItems(newThisWeekData)
             WidgetCenter.shared.reloadThisWeekTimelines()
         }
     }
@@ -51,21 +51,21 @@ class StatsWidgetsStore {
 
         var isReloadRequired = false
 
-        if !HomeWidgetTodayData.cacheDataExists() {
+        if !hasCachedItems(for: HomeWidgetTodayData.self) {
             DDLogInfo("StatsWidgets: Writing initialization data into HomeWidgetTodayData.plist")
-            HomeWidgetTodayData.write(items: initializeHomeWidgetData(type: HomeWidgetTodayData.self))
+            setCachedItems(initializeHomeWidgetData(type: HomeWidgetTodayData.self))
             isReloadRequired = true
         }
 
-        if !HomeWidgetThisWeekData.cacheDataExists() {
+        if !hasCachedItems(for: HomeWidgetThisWeekData.self) {
             DDLogInfo("StatsWidgets: Writing initialization data into HomeWidgetThisWeekData.plist")
-            HomeWidgetThisWeekData.write(items: initializeHomeWidgetData(type: HomeWidgetThisWeekData.self))
+            setCachedItems(initializeHomeWidgetData(type: HomeWidgetThisWeekData.self))
             isReloadRequired = true
         }
 
-        if !HomeWidgetAllTimeData.cacheDataExists() {
+        if !hasCachedItems(for: HomeWidgetAllTimeData.self) {
             DDLogInfo("StatsWidgets: Writing initialization data into HomeWidgetAllTimeData.plist")
-            HomeWidgetAllTimeData.write(items: initializeHomeWidgetData(type: HomeWidgetAllTimeData.self))
+            setCachedItems(initializeHomeWidgetData(type: HomeWidgetAllTimeData.self))
             isReloadRequired = true
         }
 
@@ -83,7 +83,7 @@ class StatsWidgetsStore {
             return
         }
 
-        var homeWidgetCache = T.read() ?? initializeHomeWidgetData(type: widgetType)
+        var homeWidgetCache = getCachedItems(for: T.self) ?? initializeHomeWidgetData(type: widgetType)
         guard let oldData = homeWidgetCache[siteID.intValue] else {
             DDLogError("StatsWidgets: Failed to find a matching site")
             return
@@ -93,7 +93,7 @@ class StatsWidgetsStore {
             DDLogError("StatsWidgets: the site does not exist anymore")
             // if for any reason that site does not exist anymore, remove it from the cache.
             homeWidgetCache.removeValue(forKey: siteID.intValue)
-            T.write(items: homeWidgetCache)
+            setCachedItems(homeWidgetCache)
             return
         }
 
@@ -102,37 +102,81 @@ class StatsWidgetsStore {
         if widgetType == HomeWidgetTodayData.self, let stats = stats as? TodayWidgetStats {
             widgetReload = WidgetCenter.shared.reloadTodayTimelines
 
-            homeWidgetCache[siteID.intValue] = HomeWidgetTodayData(siteID: siteID.intValue,
-                                                                   siteName: blog.title ?? oldData.siteName,
-                                                                   url: blog.url ?? oldData.url,
-                                                                   timeZone: blog.timeZone ?? TimeZone.current,
-                                                                   date: Date(),
-                                                                   stats: stats) as? T
+            homeWidgetCache[siteID.intValue] = HomeWidgetTodayData(
+                siteID: siteID.intValue,
+                siteName: blog.title ?? oldData.siteName,
+                url: blog.url ?? oldData.url,
+                timeZone: blog.timeZone ?? TimeZone.current,
+                date: Date(),
+                stats: stats
+            ) as? T
 
         } else if widgetType == HomeWidgetAllTimeData.self, let stats = stats as? AllTimeWidgetStats {
             widgetReload = WidgetCenter.shared.reloadAllTimeTimelines
 
-            homeWidgetCache[siteID.intValue] = HomeWidgetAllTimeData(siteID: siteID.intValue,
-                                                                     siteName: blog.title ?? oldData.siteName,
-                                                                     url: blog.url ?? oldData.url,
-                                                                     timeZone: blog.timeZone ?? TimeZone.current,
-                                                                     date: Date(),
-                                                                     stats: stats) as? T
+            homeWidgetCache[siteID.intValue] = HomeWidgetAllTimeData(
+                siteID: siteID.intValue,
+                siteName: blog.title ?? oldData.siteName,
+                url: blog.url ?? oldData.url,
+                timeZone: blog.timeZone ?? TimeZone.current,
+                date: Date(),
+                stats: stats
+            ) as? T
 
         } else if widgetType == HomeWidgetThisWeekData.self, let stats = stats as? ThisWeekWidgetStats {
             widgetReload = WidgetCenter.shared.reloadThisWeekTimelines
 
-            homeWidgetCache[siteID.intValue] = HomeWidgetThisWeekData(siteID: siteID.intValue,
-                                                                      siteName: blog.title ?? oldData.siteName,
-                                                                      url: blog.url ?? oldData.url,
-                                                                      timeZone: blog.timeZone ?? TimeZone.current,
-                                                                      date: Date(),
-                                                                      stats: stats) as? T
+            homeWidgetCache[siteID.intValue] = HomeWidgetThisWeekData(
+                siteID: siteID.intValue,
+                siteName: blog.title ?? oldData.siteName,
+                url: blog.url ?? oldData.url,
+                timeZone: blog.timeZone ?? TimeZone.current,
+                date: Date(),
+                stats: stats
+            ) as? T
         }
 
-        T.write(items: homeWidgetCache)
+        setCachedItems(homeWidgetCache)
         widgetReload?()
     }
+
+    // MARK: HomeWidgetCache (Helpers)
+
+    private func getCachedItems<T: HomeWidgetData>(for type: T.Type) -> [Int: T]? {
+        do {
+            return try makeCache(for: type).read()
+        } catch {
+            DDLogError("HomeWidgetCache: failed to read items: \(error)")
+            return nil
+        }
+    }
+
+    private func hasCachedItems<T: HomeWidgetData>(for type: T.Type) -> Bool {
+        guard let items = getCachedItems(for: type) else {
+            return false
+        }
+        return !items.isEmpty
+    }
+
+    private func deleteCachedItems<T: HomeWidgetData>(for type: T.Type) {
+        do {
+            try makeCache(for: T.self).delete()
+        } catch {
+            DDLogError("HomeWidgetCache: failed to delete items: \(error)")
+        }
+    }
+
+    private func setCachedItems<T: HomeWidgetData>(_ items: [Int: T]) {
+        do {
+            try makeCache(for: T.self).write(items: items)
+        } catch {
+            DDLogError("HomeWidgetCache: failed to write items: \(error)")
+        }
+    }
+
+    private func makeCache<T: HomeWidgetData>(for type: T.Type) -> HomeWidgetCache<T> {
+        HomeWidgetCache<T>(appGroup: appGroupName)
+    }
 }
 
 // MARK: - Helper methods
@@ -283,9 +327,9 @@ private extension StatsWidgetsStore {
 
         guard !isLoggedIn else { return }
 
-        HomeWidgetTodayData.delete()
-        HomeWidgetThisWeekData.delete()
-        HomeWidgetAllTimeData.delete()
+        deleteCachedItems(for: HomeWidgetTodayData.self)
+        deleteCachedItems(for: HomeWidgetThisWeekData.self)
+        deleteCachedItems(for: HomeWidgetAllTimeData.self)
 
         userDefaults?.setValue(nil, forKey: WidgetStatsConfiguration.userDefaultsSiteIdKey)
 

WordPress/Classes/System/WordPressAppDelegate.swift

@@ -203,7 +203,7 @@ class WordPressAppDelegate: UIResponder, UIApplicationDelegate {
     func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
         // 21-Oct-2017: We are only handling background URLSessions initiated by the share extension so there
         // is no need to inspect the identifier beyond the simple check here.
-        let appGroupName = BuildSettings.appGroupName
+        let appGroupName = BuildSettings.current.appGroupName
         if identifier.contains(appGroupName) {
             let manager = ShareExtensionSessionManager(appGroup: appGroupName, backgroundSessionIdentifier: identifier)
             manager.backgroundSessionCompletionBlock = completionHandler