Preference center SMS and Email opt-in wrap up and testing (#3094)

* wip

# Conflicts:
#	Airship/AirshipCore/Tests/TestContactAPIClient.swift

* Update preference center config and add test

* Add contact API client tests

* Add contact manager tests

* Cleanup and docs

---------

Co-authored-by: crow <[email protected]>

Author: crow

Airship.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -559,6 +559,13 @@ public final class AirshipContact: NSObject, AirshipContactProtocol, @unchecked
         )
     }
 
+    /**
+     * Resends an opt-in message
+     * - Parameters:
+     *   - channelID: The channel ID.
+     *   - type: The channel type.
+     *   - options: The SMS/email channel options
+     */
     public func resend(_ channel: ContactChannel) {
         guard self.privacyManager.isEnabled(.contacts) else {
             AirshipLogger.warn(

Airship/AirshipCore/Source/AirshipContact.swift

@@ -2,32 +2,40 @@
 
 import Foundation
 
+/**
+ * Contact channels provider protocol for receiving contact updates.
+ * @note For internal use only. :nodoc:
+ */
 protocol ContactChannelsProviderProtocol: AnyActor {
     func contactUpdates(contactID: String) async throws -> AsyncStream<[ContactChannel]>
 }
 
+/// Provides a stream of contact updates at a regular interval
 final actor ContactChannelsProvider: ContactChannelsProviderProtocol {
     private let audienceOverrides: AudienceOverridesProvider
     private let apiClient: ContactChannelsAPIClientProtocol
     private let cachedChannelsList: CachedValue<(String, [ContactChannel])>
     private let fetchQueue: AirshipSerialQueue = AirshipSerialQueue()
-    private static let maxChannelListCacheAge: TimeInterval = 600
+    private let maxChannelListCacheAge: TimeInterval
 
     private let taskSleeper: AirshipTaskSleeper
 
     init(
         audienceOverrides: AudienceOverridesProvider,
         apiClient: ContactChannelsAPIClientProtocol,
         date: AirshipDateProtocol = AirshipDate.shared,
-        taskSleeper: AirshipTaskSleeper = .shared
+        taskSleeper: AirshipTaskSleeper = .shared,
+        maxChannelListCacheAgeSeconds: TimeInterval = 600
     ) {
         self.audienceOverrides = audienceOverrides
         self.apiClient = apiClient
         self.cachedChannelsList = CachedValue(date: date)
         self.taskSleeper = taskSleeper
+        self.maxChannelListCacheAge = maxChannelListCacheAgeSeconds
     }
 
     func contactUpdates(contactID: String) async throws -> AsyncStream<[ContactChannel]> {
+        /// Fetch the initial channels list and apply overrides
         let overrideUpdates = await self.audienceOverrides.contactOverrideUpdates(contactID: contactID)
         let fetched = try await self.resolveChannelsList(contactID)
         let initialHistory = await self.audienceOverrides.contactOverrides(contactID: contactID)
@@ -56,7 +64,7 @@ final actor ContactChannelsProvider: ContactChannelsProviderProtocol {
                         }
                     }
 
-                    try await self.taskSleeper.sleep(timeInterval: Self.maxChannelListCacheAge)
+                    try await self.taskSleeper.sleep(timeInterval: self.maxChannelListCacheAge)
 
                     overrideUpdates = await self.audienceOverrides.contactOverrideUpdates(contactID: contactID)
 
@@ -94,7 +102,7 @@ final actor ContactChannelsProvider: ContactChannelsProviderProtocol {
 
             self.cachedChannelsList.set(
                 value: (contactID, list),
-                expiresIn: Self.maxChannelListCacheAge
+                expiresIn: self.maxChannelListCacheAge
             )
 
             return list
@@ -127,6 +135,26 @@ extension Array where Element == ContactChannel {
                 }
 
             case .associated(let contact, let registeredChannelID):
+                let alreadyAssociated = mutated.contains {
+                    let channelID = $0.channelID
+                    let canonicalAddress = $0.canonicalAddress
+
+                    if let canonicalAddress, contact.canonicalAddress == canonicalAddress {
+                        return true
+                    }
+
+                    if let channelID, registeredChannelID == channelID {
+                        return true
+                    }
+
+                    return false
+                }
+
+                /// If we've already associated this address/channel, bail early with no-op
+                if alreadyAssociated {
+                    break
+                }
+
                 mutated.removeAll {
                     let channelID = $0.channelID
                     let canonicalAddress = $0.canonicalAddress

Airship/AirshipCore/Source/ContactChannelsProvider.swift

@@ -130,7 +130,7 @@ public protocol AirshipContactProtocol: AirshipBaseContactProtocol {
     /// The named user ID current value publisher.
     var namedUserIDPublisher: AnyPublisher<String?, Never> { get }
 
-    /// Conflict event publisher
+    /// Conflict event publisher.
     var conflictEventPublisher: AnyPublisher<ContactConflictEvent, Never> { get }
 
     /// Notifies any edits to the subscription lists.
@@ -153,9 +153,9 @@ public protocol AirshipContactProtocol: AirshipBaseContactProtocol {
     func validateSMS(_ msisdn: String, sender: String) async throws -> Bool
 
     /**
-     * Re-sends the double opt in prompt via the channel
+     * Re-sends the double opt in prompt via the pending or registered channel.
      * - Parameters:
-     *   - channel: The channel to resend the double opt-in prompt to
+     *   - channel: The pending or registered channel to resend the double opt-in prompt to.
      */
     func resend(_ channel: ContactChannel)
 
@@ -166,7 +166,10 @@ public protocol AirshipContactProtocol: AirshipBaseContactProtocol {
      */
     func disassociateChannel(_ channel: ContactChannel)
 
+    /// Contact channel updates stream.
     var contactChannelUpdates: AsyncStream<[ContactChannel]> { get async throws }
+
+    /// Contact channel updates publisher.
     var contactChannelPublisher: AnyPublisher<[ContactChannel], Never> { get async throws }
 }
 

Airship/AirshipCore/Source/ContactProtocol.swift

@@ -377,7 +377,6 @@ class AirshipContactTest: XCTestCase {
     }
 
     func testAssociateChannel() async throws {
-        let options = EmailRegistrationOptions.commercialOptions(transactionalOptedIn: Date(), commercialOptedIn: Date(), properties: nil)
         self.contact.associateChannel(
             "some-channel-id",
             type: .email

Airship/AirshipCore/Tests/AirshipContactTest.swift

@@ -487,6 +487,119 @@ class ContactAPIClientTest: XCTestCase {
         }
     }
 
+    func testDisassociate() async throws {
+        let expectedChannelType: ChannelType = .email
+        let expectedChannelID: String = "some channel"
+        let expectedContactID: String = "contact"
+
+        let response = try await contactAPIClient.disassociateChannel(contactID: expectedContactID, channelID: expectedChannelID, type: expectedChannelType)
+        XCTAssertTrue(response.isSuccess)
+
+        let request = self.session.lastRequest!
+        XCTAssertEqual(
+            "https://example.com/api/contacts/disassociate/\(expectedContactID)",
+            request.url!.absoluteString
+        )
+
+        let body = try JSONSerialization.jsonObject(
+            with: request.body!,
+            options: []
+        ) as! [String: Any]
+
+        let expectedBody = [
+            "channel_type": expectedChannelType.stringValue,
+            "channel_id": expectedChannelID,
+            "opt_out": true
+        ] as [String : Any]
+
+        XCTAssertEqual(body as NSDictionary, expectedBody as NSDictionary)
+    }
+
+    func testResendEmail() async throws {
+        let expectedChannelType: ChannelType = .email
+        let expectedEmail: String = "[email protected]"
+
+        let expectedResendOptions = ResendOptions(address: expectedEmail)
+
+        let response = try await contactAPIClient.resend(resendOptions: expectedResendOptions)
+        XCTAssertTrue(response.isSuccess)
+
+        let request = self.session.lastRequest!
+        XCTAssertEqual(
+            "https://example.com/api/channels/resend",
+            request.url!.absoluteString
+        )
+
+        let body = try JSONSerialization.jsonObject(
+            with: request.body!,
+            options: []
+        ) as! [String: Any]
+
+        let expectedBody = [
+            "channel_type": expectedChannelType.stringValue,
+            "email_address": expectedEmail
+        ] as [String : Any]
+
+        XCTAssertEqual(body as NSDictionary, expectedBody as NSDictionary)
+    }
+
+    func testResendSMS() async throws {
+        let expectedChannelType: ChannelType = .sms
+        let expectedMSISDN: String = "1234"
+        let expectedSenderID: String = "1234"
+
+        let expectedResendOptions = ResendOptions(msisdn: expectedMSISDN, senderID: expectedSenderID)
+
+        let response = try await contactAPIClient.resend(resendOptions: expectedResendOptions)
+        XCTAssertTrue(response.isSuccess)
+
+        let request = self.session.lastRequest!
+        XCTAssertEqual(
+            "https://example.com/api/channels/resend",
+            request.url!.absoluteString
+        )
+
+        let body = try JSONSerialization.jsonObject(
+            with: request.body!,
+            options: []
+        ) as! [String: Any]
+
+        let expectedBody = [
+            "channel_type": expectedChannelType.stringValue,
+            "sender": expectedSenderID,
+            "msisdn": expectedMSISDN
+        ] as [String : Any]
+
+        XCTAssertEqual(body as NSDictionary, expectedBody as NSDictionary)
+    }
+
+    func testResendChannel() async throws {
+        let expectedChannelType: ChannelType = .email
+        let expectedChannelID: String = "some channel"
+        let expectedResendOptions = ResendOptions(channelID: expectedChannelID, channelType: expectedChannelType)
+
+        let response = try await contactAPIClient.resend(resendOptions: expectedResendOptions)
+        XCTAssertTrue(response.isSuccess)
+
+        let request = self.session.lastRequest!
+        XCTAssertEqual(
+            "https://example.com/api/channels/resend",
+            request.url!.absoluteString
+        )
+
+        let body = try JSONSerialization.jsonObject(
+            with: request.body!,
+            options: []
+        ) as! [String: Any]
+
+        let expectedBody = [
+            "channel_type": expectedChannelType.stringValue,
+            "channel_id": expectedChannelID
+        ] as [String : Any]
+
+        XCTAssertEqual(body as NSDictionary, expectedBody as NSDictionary)
+    }
+
     func testUpdate() async throws {
         let tagUpdates = [
             TagGroupUpdate(group: "tag-set", tags: [], type: .set),

Airship/AirshipCore/Tests/ContactAPIClientTest.swift

@@ -0,0 +1,54 @@
+/* Copyright Airship and Contributors */
+
+import XCTest
+
+@testable import AirshipCore
+
+final class ContactChannelsProviderTest: XCTestCase {
+
+    override func setUpWithError() throws {
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+    }
+
+    override func tearDownWithError() throws {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+    }
+
+    func testExample() throws {
+        // This is an example of a functional test case.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+        // Any test you write for XCTest can be annotated as throws and async.
+        // Mark your test throws to produce an unexpected failure when your test encounters an uncaught error.
+        // Mark your test async to allow awaiting for asynchronous code to complete. Check the results with assertions afterwards.
+    }
+
+    func testContactUpdates() async throws {
+        // Setup mocks and initial conditions
+        let contactID = "some id"
+        let expectedChannels = [ContactChannel(id: "some channel"), ContactChannel(id: "some channel")]
+        let mockOverrides = MockAudienceOverrides()
+        let sleeper = MockSleeper()
+        let tester = YourClass(audienceOverrides: mockOverrides, taskSleeper: sleeper)
+
+        // Prepare the AsyncStream
+        let stream = tester.contactUpdates(contactID: contactID)
+        var results = [AsyncStream<[ContactChannel]>]()
+
+        // Collect results
+        for try await channels in stream {
+            results.append(channels)
+            // Optionally, break after receiving enough results or certain conditions
+        }
+
+        // Assert conditions
+        XCTAssertEqual(results.count, expectedCount)
+        XCTAssertEqual(results.last, expectedChannels)
+    }
+
+    func testPerformanceExample() throws {
+        // This is an example of a performance test case.
+        self.measure {
+            // Put the code you want to measure the time of here.
+        }
+    }
+}