Merge branch 'main' into sam/mac-deprecated-remote-messaging-attribute

* main:
  Resetting all state for the VPN will cancel the tunnel and stop the monitors (#900)
  Add support for skipping sending usage pixels for remote messages (#902)

.swiftpm/xcode/xcshareddata/xcschemes/BrowserServicesKit-Package.xcscheme

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "1540"
-   version = "1.7">
+   version = "1.8">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES"
@@ -413,6 +413,20 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "CxxCrashHandler"
+               BuildableName = "CxxCrashHandler"
+               BlueprintName = "CxxCrashHandler"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction

.swiftpm/xcode/xcshareddata/xcschemes/SubscriptionTests.xcscheme

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "1540"
-   version = "1.7">
+   version = "1.8">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES"

Package.swift

@@ -512,6 +512,7 @@ let package = Package(
             resources: [
                 .copy("Resources/remote-messaging-config-example.json"),
                 .copy("Resources/remote-messaging-config-malformed.json"),
+                .copy("Resources/remote-messaging-config-metrics.json"),
                 .copy("Resources/remote-messaging-config-unsupported-items.json"),
                 .copy("Resources/remote-messaging-config.json"),
             ]

Sources/NetworkProtection/PacketTunnelProvider.swift

@@ -83,6 +83,9 @@ open class PacketTunnelProvider: NEPacketTunnelProvider {
         // Subscription Errors - 100+
         case vpnAccessRevoked
 
+        // State Reset - 200+
+        case appRequestedCancellation
+
         public var errorDescription: String? {
             switch self {
             case .startingTunnelWithoutAuthToken:
@@ -93,6 +96,8 @@ open class PacketTunnelProvider: NEPacketTunnelProvider {
                 return "Failed to generate a tunnel configuration: \(internalError.localizedDescription)"
             case .simulateTunnelFailureError:
                 return "Simulated a tunnel error as requested"
+            case .appRequestedCancellation:
+                return nil
             }
         }
 
@@ -104,14 +109,17 @@ open class PacketTunnelProvider: NEPacketTunnelProvider {
             case .simulateTunnelFailureError: return 2
                 // Subscription Errors - 100+
             case .vpnAccessRevoked: return 100
+                // State Reset - 200+
+            case .appRequestedCancellation: return 200
             }
         }
 
         public var errorUserInfo: [String: Any] {
             switch self {
             case .startingTunnelWithoutAuthToken,
                     .simulateTunnelFailureError,
-                    .vpnAccessRevoked:
+                    .vpnAccessRevoked,
+                    .appRequestedCancellation:
                 return [:]
             case .couldNotGenerateTunnelConfiguration(let underlyingError):
                 return [NSUnderlyingErrorKey: underlyingError]
@@ -1147,9 +1155,10 @@ open class PacketTunnelProvider: NEPacketTunnelProvider {
         try? tokenStore.deleteToken()
 #endif
 
-        // This is not really an error, we received a command to reset the connection
-        cancelTunnelWithError(nil)
-        completionHandler?(nil)
+        Task {
+            completionHandler?(nil)
+            await cancelTunnel(with: TunnelError.appRequestedCancellation)
+        }
     }
 
     private func handleGetLastErrorMessage(completionHandler: ((Data?) -> Void)? = nil) {

Sources/RemoteMessaging/Mappers/JsonToRemoteMessageModelMapper.swift

@@ -97,10 +97,13 @@ struct JsonToRemoteMessageModelMapper {
                 return
             }
 
-            var remoteMessage = RemoteMessageModel(id: message.id,
-                                              content: content,
-                                              matchingRules: message.matchingRules ?? [],
-                                              exclusionRules: message.exclusionRules ?? [])
+            var remoteMessage = RemoteMessageModel(
+                id: message.id,
+                content: content,
+                matchingRules: message.matchingRules ?? [],
+                exclusionRules: message.exclusionRules ?? [],
+                isMetricsEnabled: message.isMetricsEnabled
+            )
 
             if let translation = getTranslation(from: message.translations, for: Locale.current) {
                 remoteMessage.localizeContent(translation: translation)

Sources/RemoteMessaging/Model/JsonRemoteMessagingConfig.swift

@@ -31,10 +31,24 @@ public enum RemoteMessageResponse {
         let content: JsonContent
         let translations: [String: JsonContentTranslation]?
         let matchingRules, exclusionRules: [Int]?
+        let metrics: JsonMetrics?
 
         static func == (lhs: JsonRemoteMessage, rhs: JsonRemoteMessage) -> Bool {
             return lhs.id == rhs.id
         }
+
+        var isMetricsEnabled: Bool {
+            metrics?.state.flatMap(JsonMetrics.MetricsState.init) != .disabled
+        }
+    }
+
+    struct JsonMetrics: Decodable {
+        let state: String?
+
+        enum MetricsState: String, Decodable {
+            case disabled
+            case enabled
+        }
     }
 
     struct JsonContent: Decodable {

Sources/RemoteMessaging/Model/RemoteMessageModel.swift

@@ -24,28 +24,31 @@ public struct RemoteMessageModel: Equatable, Codable {
     public var content: RemoteMessageModelType?
     public let matchingRules: [Int]
     public let exclusionRules: [Int]
+    public let isMetricsEnabled: Bool
 
-    public init(id: String, content: RemoteMessageModelType?, matchingRules: [Int], exclusionRules: [Int]) {
+    public init(id: String, content: RemoteMessageModelType?, matchingRules: [Int], exclusionRules: [Int], isMetricsEnabled: Bool) {
         self.id = id
         self.content = content
         self.matchingRules = matchingRules
         self.exclusionRules = exclusionRules
+        self.isMetricsEnabled = isMetricsEnabled
     }
 
-    public static func == (lhs: RemoteMessageModel, rhs: RemoteMessageModel) -> Bool {
-        if lhs.id != rhs.id {
-            return false
-        }
-        if lhs.content != rhs.content {
-            return false
-        }
-        if lhs.matchingRules != rhs.matchingRules {
-            return false
-        }
-        if lhs.exclusionRules != rhs.exclusionRules {
-            return false
-        }
-        return true
+    enum CodingKeys: CodingKey {
+        case id
+        case content
+        case matchingRules
+        case exclusionRules
+        case isMetricsEnabled
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.id = try container.decode(String.self, forKey: .id)
+        self.content = try container.decodeIfPresent(RemoteMessageModelType.self, forKey: .content)
+        self.matchingRules = try container.decode([Int].self, forKey: .matchingRules)
+        self.exclusionRules = try container.decode([Int].self, forKey: .exclusionRules)
+        self.isMetricsEnabled = try container.decodeIfPresent(Bool.self, forKey: .isMetricsEnabled) ?? true
     }
 
     mutating func localizeContent(translation: RemoteMessageResponse.JsonContentTranslation) {

Sources/RemoteMessaging/RemoteMessagingStore.swift

@@ -226,7 +226,13 @@ extension RemoteMessagingStore {
                     continue
                 }
 
-                scheduledRemoteMessage = RemoteMessageModel(id: id, content: remoteMessage.content, matchingRules: [], exclusionRules: [])
+                scheduledRemoteMessage = RemoteMessageModel(
+                    id: id,
+                    content: remoteMessage.content,
+                    matchingRules: [],
+                    exclusionRules: [],
+                    isMetricsEnabled: remoteMessage.isMetricsEnabled
+                )
                 break
             }
         }
@@ -255,7 +261,13 @@ extension RemoteMessagingStore {
                     continue
                 }
 
-                remoteMessage = RemoteMessageModel(id: id, content: remoteMessageMapped.content, matchingRules: [], exclusionRules: [])
+                remoteMessage = RemoteMessageModel(
+                    id: id,
+                    content: remoteMessageMapped.content,
+                    matchingRules: [],
+                    exclusionRules: [],
+                    isMetricsEnabled: remoteMessageMapped.isMetricsEnabled
+                )
                 break
             }
         }

Tests/RemoteMessagingTests/Mappers/JsonToRemoteConfigModelMapperTests.swift

@@ -31,29 +31,33 @@ class JsonToRemoteConfigModelMapperTests: XCTestCase {
                 content: .bigSingleAction(titleText: "title", descriptionText: "description", placeholder: .announce,
                                           primaryActionText: "Ok", primaryAction: .url(value: "https://duckduckgo.com")),
                 matchingRules: [],
-                exclusionRules: [])
+                exclusionRules: [],
+                isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[1], RemoteMessageModel(
                 id: "8274589c-8aeb-4322-a737-3852911569e3",
                 content: .bigSingleAction(titleText: "Kedvenc hozzáadása", descriptionText: "Kedvenc eltávolítása", placeholder: .ddgAnnounce,
                                           primaryActionText: "Ok", primaryAction: .url(value: "https://duckduckgo.com")),
                 matchingRules: [],
-                exclusionRules: [])
+                exclusionRules: [],
+                isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[2], RemoteMessageModel(
                 id: "26780792-49fe-4e25-ae27-aa6a2e6f013b",
                 content: .small(titleText: "Here goes a title", descriptionText: "description"),
                 matchingRules: [5, 6],
-                exclusionRules: [7, 8, 9])
+                exclusionRules: [7, 8, 9],
+                isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[3], RemoteMessageModel(
                 id: "c3549d64-b388-41d8-9649-33e6e2674e8e",
                 content: .medium(titleText: "Here goes a title", descriptionText: "description", placeholder: .criticalUpdate),
                 matchingRules: [],
-                exclusionRules: [])
+                exclusionRules: [],
+                isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[4], RemoteMessageModel(
@@ -62,7 +66,8 @@ class JsonToRemoteConfigModelMapperTests: XCTestCase {
                                        primaryActionText: "Ok", primaryAction: .appStore,
                                        secondaryActionText: "Cancel", secondaryAction: .dismiss),
                 matchingRules: [],
-                exclusionRules: [])
+                exclusionRules: [],
+                isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[5], RemoteMessageModel(
@@ -72,15 +77,17 @@ class JsonToRemoteConfigModelMapperTests: XCTestCase {
                                                                                   title: "Share Title"),
                                    secondaryActionText: "Cancel", secondaryAction: .dismiss),
             matchingRules: [],
-            exclusionRules: [])
+            exclusionRules: [],
+            isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[6], RemoteMessageModel(
             id: "6E58D3DA-AB9D-47A4-87B7-B8AF830BFB5E",
             content: .promoSingleAction(titleText: "Promo Title", descriptionText: "Promo Description", placeholder: .newForMacAndWindows,
                                         actionText: "Promo Action", action: .dismiss),
             matchingRules: [],
-            exclusionRules: [])
+            exclusionRules: [],
+            isMetricsEnabled: true)
         )
 
         XCTAssertEqual(config.messages[7], RemoteMessageModel(
@@ -93,7 +100,8 @@ class JsonToRemoteConfigModelMapperTests: XCTestCase {
                 action: .survey(value: "https://duckduckgo.com/survey")
             ),
             matchingRules: [8],
-            exclusionRules: [])
+            exclusionRules: [],
+            isMetricsEnabled: true)
         )
 
     }
@@ -225,6 +233,43 @@ class JsonToRemoteConfigModelMapperTests: XCTestCase {
         XCTAssertEqual(rule6?.attributes.filter { $0 is UnknownMatchingAttribute }.count, 1)
     }
 
+    func testThatMetricsAreEnabledWhenStatedInJSONOrMissing() throws {
+        let config = try decodeAndMapJson(fileName: "remote-messaging-config-metrics.json")
+        XCTAssertEqual(config.messages.count, 4)
+
+        XCTAssertEqual(config.messages[0], RemoteMessageModel(
+                id: "1",
+                content: .small(titleText: "title", descriptionText: "description"),
+                matchingRules: [],
+                exclusionRules: [],
+                isMetricsEnabled: true)
+        )
+
+        XCTAssertEqual(config.messages[1], RemoteMessageModel(
+                id: "2",
+                content: .small(titleText: "title", descriptionText: "description"),
+                matchingRules: [],
+                exclusionRules: [],
+                isMetricsEnabled: true)
+        )
+
+        XCTAssertEqual(config.messages[2], RemoteMessageModel(
+                id: "3",
+                content: .small(titleText: "title", descriptionText: "description"),
+                matchingRules: [],
+                exclusionRules: [],
+                isMetricsEnabled: false)
+        )
+
+        XCTAssertEqual(config.messages[3], RemoteMessageModel(
+                id: "4",
+                content: .small(titleText: "title", descriptionText: "description"),
+                matchingRules: [],
+                exclusionRules: [],
+                isMetricsEnabled: true)
+        )
+    }
+
     func decodeAndMapJson(fileName: String) throws -> RemoteConfigModel {
         let resourceURL = Bundle.module.resourceURL!.appendingPathComponent(fileName, conformingTo: .json)
         let validJson = try Data(contentsOf: resourceURL)

Tests/RemoteMessagingTests/RemoteMessagingConfigMatcherTests.swift

@@ -515,9 +515,10 @@ class RemoteMessagingConfigMatcherTests: XCTestCase {
 
     func mediumMessage(id: String = "1", matchingRules: [Int], exclusionRules: [Int]) -> RemoteMessageModel {
         return RemoteMessageModel(id: id,
-                             content: .medium(titleText: "title", descriptionText: "description", placeholder: .announce),
-                             matchingRules: matchingRules,
-                             exclusionRules: exclusionRules
+                                  content: .medium(titleText: "title", descriptionText: "description", placeholder: .announce),
+                                  matchingRules: matchingRules,
+                                  exclusionRules: exclusionRules,
+                                  isMetricsEnabled: true
         )
     }
 }

Tests/RemoteMessagingTests/RemoteMessagingStoreTests.swift

@@ -93,7 +93,7 @@ class RemoteMessagingStoreTests: XCTestCase {
         XCTAssertEqual(config?.version, processorResult.version)
         guard let remoteMessage = store.fetchScheduledRemoteMessage() else {
             XCTFail("No remote message found")
-            return RemoteMessageModel(id: "", content: nil, matchingRules: [], exclusionRules: [])
+            return RemoteMessageModel(id: "", content: nil, matchingRules: [], exclusionRules: [], isMetricsEnabled: true)
         }
 
         XCTAssertNotNil(remoteMessage)