Show in-app notification when new app version is available

Author: rablador

ios/Assets/Localizable.xcstrings

@@ -4,6 +4,14 @@
     "" : {
       "shouldTranslate" : false
     },
+    "“Force all apps” is enabled, please disable it before updating or you will lose network connectivity. This will briefly expose your traffic as you reconnect to the VPN." : {
+      "comment" : "Text in an in-app notification about a new app version, explaining that \"Force all apps\" is enabled and that the user should disable it before updating.",
+      "isCommentAutoGenerated" : true
+    },
+    "“Force all apps” is enabled, please disable it or disconnect before updating or you will lose network connectivity." : {
+      "comment" : "Body text of an in-app notification that appears when the user has a new app store version available, but the \"Force all apps\" setting is enabled.",
+      "isCommentAutoGenerated" : true
+    },
     "**Attention: This increases network traffic and will also negatively affect speed, latency, and battery usage. Use with caution on limited plans.**" : {
       "localizations" : {
         "da" : {
@@ -4152,6 +4160,10 @@
         }
       }
     },
+    "After updating, you will have to enable “Force all apps” manually again." : {
+      "comment" : "Message in an in-app notification about the need to manually enable \"Force all apps\" after an app update.",
+      "isCommentAutoGenerated" : true
+    },
     "Agree and continue" : {
       "localizations" : {
         "da" : {
@@ -17378,6 +17390,10 @@
         }
       }
     },
+    "Disable “Force all apps”" : {
+      "comment" : "Title of an action in an alert presented when a new app version is available that requires the user to disable \"Force all apps\".",
+      "isCommentAutoGenerated" : true
+    },
     "Disable all \"%@\" above to activate this setting." : {
       "localizations" : {
         "da" : {
@@ -26350,6 +26366,10 @@
         }
       }
     },
+    "If you do not wish to disable “Force all apps“, you can disconnect from the VPN instead." : {
+      "comment" : "Message in an in-app notification about the option to disconnect from the VPN if they do not want to disable \"Force all apps\".",
+      "isCommentAutoGenerated" : true
+    },
     "If you exit the form and try again later, the information you already entered will still be here." : {
       "localizations" : {
         "da" : {
@@ -28474,6 +28494,10 @@
         }
       }
     },
+    "Install the latest app version to stay up to date." : {
+      "comment" : "Body text of an in-app notification that reminds the user to update their app to the latest version.",
+      "isCommentAutoGenerated" : true
+    },
     "Internal error occurred. Settings will be reset to defaults and device logged out." : {
       "localizations" : {
         "da" : {
@@ -58260,6 +58284,10 @@
         }
       }
     },
+    "Update available" : {
+      "comment" : "Title of an in-app notification that alerts the user that a new app version is available.",
+      "isCommentAutoGenerated" : true
+    },
     "USA" : {
       "localizations" : {
         "da" : {

ios/MullvadREST/ApiHandlers/AppStoreMetaDataService.swift

@@ -16,19 +16,18 @@ public final class AppStoreMetaDataService: @unchecked Sendable {
     private let checkInterval: TimeInterval = Duration.days(1).timeInterval
     private let logger = Logger(label: "AppStoreMetaDataService")
 
-    private let tunnelSettings: LatestTunnelSettings
     private let urlSession: URLSessionProtocol
     private let appPreferences: AppPreferences
     private let mainAppBundleIdentifier: String
-    private let appStoreLink: URL
+    private let iTunesLink: URL
+
+    public var onNewAppVersion: (() -> Void)?
 
     public init(
-        tunnelSettings: LatestTunnelSettings,
         urlSession: URLSessionProtocol,
         appPreferences: AppPreferences,
-        mainAppBundleIdentifier: String
+        mainAppBundleIdentifier: String,
     ) {
-        self.tunnelSettings = tunnelSettings
         self.urlSession = urlSession
         self.appPreferences = appPreferences
         self.mainAppBundleIdentifier = mainAppBundleIdentifier
@@ -38,21 +37,19 @@ public final class AppStoreMetaDataService: @unchecked Sendable {
             resolvingAgainstBaseURL: true
         )!
         urlComponents.queryItems = [URLQueryItem(name: "bundleId", value: mainAppBundleIdentifier)]
-        appStoreLink = urlComponents.url!
+        iTunesLink = urlComponents.url!
     }
 
     public func scheduleTimer() {
         let newTimer = DispatchSource.makeTimerSource()
 
         newTimer.setEventHandler {
             Task { [weak self] in
-                guard let self, tunnelSettings.includeAllNetworks else {
-                    return
-                }
+                guard let self else { return }
 
                 let newVersionExists = (try? await performVersionCheck()) ?? false
                 if newVersionExists {
-                    sendNotification()
+                    onNewAppVersion?()
                 }
             }
         }
@@ -68,35 +65,7 @@ public final class AppStoreMetaDataService: @unchecked Sendable {
         timer = newTimer
     }
 
-    func performVersionCheck() async throws -> Bool {
-        appPreferences.lastVersionCheck.date = .now
-
-        let appStoreMetaData = try await fetchAppStoreMetaData()
-        let appStoreVersion = appStoreMetaData?.version ?? ""
-
-        if appStoreVersion.isNewerThan(Bundle.main.shortVersion) {
-            appPreferences.lastVersionCheck.version = appStoreVersion
-            return true
-        }
-
-        return false
-    }
-
-    private func fetchAppStoreMetaData() async throws -> AppStoreMetaData? {
-        do {
-            let data = try await urlSession.data(
-                for: URLRequest(url: appStoreLink, timeoutInterval: REST.defaultAPINetworkTimeout.timeInterval)
-            )
-            let response = try JSONDecoder().decode(AppStoreMetaDataResponse.self, from: data.0)
-            return response.results.first { $0.bundleId == mainAppBundleIdentifier }
-        } catch {
-            logger.log(level: .error, "Could not fetch App Store metadata: \(error.description)")
-        }
-
-        return nil
-    }
-
-    private func sendNotification() {
+    public func sendSystemNotification() {
         let content = UNMutableNotificationContent()
         content.title = NSLocalizedString("Update available", comment: "")
         content.body = String(
@@ -131,6 +100,34 @@ public final class AppStoreMetaDataService: @unchecked Sendable {
             }
         }
     }
+
+    func performVersionCheck() async throws -> Bool {
+        appPreferences.lastVersionCheck.date = .now
+
+        let appStoreMetaData = try await fetchAppStoreMetaData()
+        let appStoreVersion = appStoreMetaData?.version ?? ""
+
+        if appStoreVersion.isNewerThan(Bundle.main.shortVersion) {
+            appPreferences.lastVersionCheck.version = appStoreVersion
+            return true
+        }
+
+        return false
+    }
+
+    private func fetchAppStoreMetaData() async throws -> AppStoreMetaData? {
+        do {
+            let data = try await urlSession.data(
+                for: URLRequest(url: iTunesLink, timeoutInterval: REST.defaultAPINetworkTimeout.timeInterval)
+            )
+            let response = try JSONDecoder().decode(AppStoreMetaDataResponse.self, from: data.0)
+            return response.results.first { $0.bundleId == mainAppBundleIdentifier }
+        } catch {
+            logger.log(level: .error, "Could not fetch App Store metadata: \(error.description)")
+        }
+
+        return nil
+    }
 }
 
 extension String {

ios/MullvadRESTTests/AppStoreMetaDataServiceTests.swift

@@ -31,7 +31,6 @@ class AppStoreMetaDataServiceTests: XCTestCase {
         )
 
         let metaDataService = AppStoreMetaDataService(
-            tunnelSettings: LatestTunnelSettings(),
             urlSession: URLSessionStub(
                 response: (mockData, URLResponse())
             ),
@@ -59,7 +58,6 @@ class AppStoreMetaDataServiceTests: XCTestCase {
         )
 
         let metaDataService = AppStoreMetaDataService(
-            tunnelSettings: LatestTunnelSettings(),
             urlSession: URLSessionStub(
                 response: (mockData, URLResponse())
             ),

ios/MullvadTypes/InAppNotificationDescriptor.swift

@@ -0,0 +1,69 @@
+//
+//  InAppNotificationDescriptor.swift
+//  MullvadVPN
+//
+//  Created by pronebird on 09/12/2022.
+//  Copyright © 2025 Mullvad VPN AB. All rights reserved.
+//
+
+import Foundation
+import UIKit.UIImage
+
+/// Struct describing in-app notification.
+public struct InAppNotificationDescriptor: Equatable {
+    /// Notification identifier.
+    public var identifier: NotificationProviderIdentifier
+
+    /// Notification banner style.
+    public var style: NotificationBannerStyle
+
+    /// Notification title.
+    public var title: String
+
+    /// Notification body.
+    public var body: NSAttributedString
+
+    /// Notification action (optional).
+    public var button: InAppNotificationAction?
+
+    /// Notification button action (optional).
+    public var tapAction: InAppNotificationAction?
+
+    public init(
+        identifier: NotificationProviderIdentifier,
+        style: NotificationBannerStyle,
+        title: String,
+        body: NSAttributedString,
+        button: InAppNotificationAction? = nil,
+        tapAction: InAppNotificationAction? = nil
+    ) {
+        self.identifier = identifier
+        self.style = style
+        self.title = title
+        self.body = body
+        self.button = button
+        self.tapAction = tapAction
+    }
+}
+
+/// Type describing a specific in-app notification action.
+public struct InAppNotificationAction: Equatable {
+    /// Image assigned to action button.
+    public var image: UIImage?
+
+    /// Action handler for button.
+    public var handler: (() -> Void)?
+
+    public init(image: UIImage? = nil, handler: (() -> Void)?) {
+        self.image = image
+        self.handler = handler
+    }
+
+    public static func == (lhs: InAppNotificationAction, rhs: InAppNotificationAction) -> Bool {
+        lhs.image == rhs.image
+    }
+}
+
+public enum NotificationBannerStyle {
+    case success, warning, error
+}

ios/MullvadTypes/NotificationProviderIdentifier.swift

@@ -21,7 +21,8 @@ public enum NotificationPriority: Int, Comparable {
 
 public enum NotificationProviderIdentifier: String {
     case accountExpirySystemNotification = "AccountExpiryNotification"
-    case newAppVersionSystemNotification = "NewAppVersionNotification"
+    case newAppVersionSystemNotification = "NewAppVersionSystemNotification"
+    case newAppVersionInAppNotification = "NewAppVersionInAppNotification"
     case accountExpiryInAppNotification = "AccountExpiryInAppNotification"
     case registeredDeviceInAppNotification = "RegisteredDeviceInAppNotification"
     case tunnelStatusNotificationProvider = "TunnelStatusNotificationProvider"