[PM-21125] Stream send updates when viewing a send (#1620)

Author: matt-livefront

BitwardenShared/Core/Tools/Repositories/SendRepository.swift

@@ -87,6 +87,13 @@ public protocol SendRepository: AnyObject {
     ///
     func sendListPublisher() async throws -> AsyncThrowingPublisher<AnyPublisher<[SendListSection], Error>>
 
+    /// A publisher for a send.
+    ///
+    /// - Parameter id: The ID of the send that is being subscribed to.
+    /// - Returns: A publisher for a send with a specified identifier.
+    ///
+    func sendPublisher(id: String) async throws -> AsyncThrowingPublisher<AnyPublisher<SendView?, Error>>
+
     /// A publisher for all the sends in the user's account.
     ///
     /// - Parameter: The `SendType` to use to filter the sends.
@@ -289,6 +296,16 @@ class DefaultSendRepository: SendRepository {
             .values
     }
 
+    func sendPublisher(id: String) async throws -> AsyncThrowingPublisher<AnyPublisher<SendView?, Error>> {
+        try await sendService.sendPublisher(id: id)
+            .asyncTryMap { send in
+                guard let send else { return nil }
+                return try await self.clientService.sends().decrypt(send: send)
+            }
+            .eraseToAnyPublisher()
+            .values
+    }
+
     // MARK: Private Methods
 
     /// Returns a list of the sections in the vault list from a sync response.

BitwardenShared/Core/Tools/Repositories/SendRepositoryTests.swift

@@ -345,6 +345,49 @@ class SendRepositoryTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         }
     }
 
+    /// `sendListPublisher()` returns a publisher for a single send.
+    func test_sendPublisher() async throws {
+        let send1 = Send.fixture(name: "Initial")
+        sendService.sendSubject.send(send1)
+
+        var iterator = try await subject.sendPublisher(id: "1").makeAsyncIterator()
+
+        var sendView = try await iterator.next()
+        XCTAssertEqual(sendView, SendView(send: send1))
+        XCTAssertEqual(clientService.mockSends.decryptedSends, [send1])
+
+        let send2 = Send.fixture(name: "Updated")
+        sendService.sendSubject.send(send2)
+        sendView = try await iterator.next()
+        XCTAssertEqual(sendView, SendView(send: send2))
+        XCTAssertEqual(clientService.mockSends.decryptedSends, [send1, send2])
+    }
+
+    /// `sendListPublisher()` throws an error if underlying publisher returns an error.
+    func test_sendPublisher_error() async throws {
+        sendService.sendSubject.send(completion: .failure(BitwardenTestError.example))
+
+        var iterator = try await subject.sendPublisher(id: "1").makeAsyncIterator()
+        await assertAsyncThrows(error: BitwardenTestError.example) {
+            _ = try await iterator.next()
+        }
+    }
+
+    /// `sendListPublisher()` passes along a `nil` send.
+    func test_sendPublisher_nilSend() async throws {
+        sendService.sendSubject.send(nil)
+
+        var iterator = try await subject.sendPublisher(id: "1").makeAsyncIterator()
+
+        var sendView = try await iterator.next()
+        XCTAssertEqual(sendView, Optional(Optional(nil)))
+
+        let send = Send.fixture()
+        sendService.sendSubject.send(send)
+        sendView = try await iterator.next()
+        XCTAssertEqual(sendView, SendView(send: send))
+    }
+
     /// `shareURL()` successfully generates a share url for the send view.
     func test_shareURL() async throws {
         let sendView = SendView.fixture(accessId: "ACCESS_ID", key: "KEY")

BitwardenShared/Core/Tools/Repositories/TestHelpers/MockSendRepository.swift

@@ -24,6 +24,8 @@ class MockSendRepository: SendRepository {
 
     var sendListSubject = CurrentValueSubject<[SendListSection], Error>([])
 
+    var sendSubject = CurrentValueSubject<SendView?, Error>(nil)
+
     var sendTypeListPublisherType: BitwardenShared.SendType?
     var sendTypeListSubject = CurrentValueSubject<[SendListItem], Error>([])
 
@@ -104,6 +106,12 @@ class MockSendRepository: SendRepository {
             .values
     }
 
+    func sendPublisher(id: String) async throws -> AsyncThrowingPublisher<AnyPublisher<SendView?, Error>> {
+        sendSubject
+            .eraseToAnyPublisher()
+            .values
+    }
+
     func sendTypeListPublisher(
         type: BitwardenShared.SendType
     ) async throws -> AsyncThrowingPublisher<AnyPublisher<[SendListItem], Error>> {

BitwardenShared/Core/Tools/Services/SendService.swift

@@ -70,6 +70,13 @@ protocol SendService {
 
     // MARK: Publishers
 
+    /// A publisher for a `Send`.
+    ///
+    /// - Parameter id: The ID of the `Send` to publish updates for.
+    /// - Returns: A publisher containing the encrypted send.
+    ///
+    func sendPublisher(id: String) async throws -> AnyPublisher<Send?, Error>
+
     /// A publisher for the list of sends.
     ///
     /// - Returns: The list of encrypted sends.
@@ -206,8 +213,13 @@ extension DefaultSendService {
         try await sendDataStore.replaceSends(sends.map(Send.init), userId: userId)
     }
 
+    func sendPublisher(id: String) async throws -> AnyPublisher<Send?, Error> {
+        let userId = try await stateService.getActiveAccountId()
+        return sendDataStore.sendPublisher(id: id, userId: userId)
+    }
+
     func sendsPublisher() async throws -> AnyPublisher<[Send], Error> {
         let userId = try await stateService.getActiveAccountId()
-        return sendDataStore.sendPublisher(userId: userId)
+        return sendDataStore.sendsPublisher(userId: userId)
     }
 }

BitwardenShared/Core/Tools/Services/SendServiceTests.swift

@@ -347,11 +347,29 @@ class SendServiceTests: BitwardenTestCase {
         XCTAssertEqual(sendDataStore.replaceSendsUserId, "1")
     }
 
+    /// `sendPublisher()` throws an error if one occurs.
+    func test_sendPublisher_error() async {
+        await assertAsyncThrows(error: StateServiceError.noActiveAccount) {
+            _ = try await subject.sendPublisher(id: "1")
+        }
+    }
+
+    /// `sendPublisher()` returns a publisher for a send.
+    func test_sendPublisher_withValues() async throws {
+        stateService.activeAccount = .fixtureAccountLogin()
+        sendDataStore.sendSubject.send(.fixture())
+
+        var iterator = try await subject.sendPublisher(id: "1").values.makeAsyncIterator()
+        let publisherValue = try await iterator.next()
+
+        try XCTAssertEqual(XCTUnwrap(publisherValue), .fixture())
+    }
+
     /// `sendsPublisher()` returns a publisher for the list of sections and items that are
     /// displayed in the sends tab.
     func test_sendsPublisher_withValues() async throws {
         stateService.activeAccount = .fixtureAccountLogin()
-        sendDataStore.sendSubject.send([.fixture()])
+        sendDataStore.sendsSubject.send([.fixture()])
 
         var iterator = try await subject.sendsPublisher().values.makeAsyncIterator()
         let publisherValue = try await iterator.next()

BitwardenShared/Core/Tools/Services/Stores/SendDataStore.swift

@@ -30,12 +30,21 @@ protocol SendDataStore: AnyObject {
     ///
     func fetchSend(id: String, userId: String) async throws -> Send?
 
+    /// A publisher for a single `Send` for a user.
+    ///
+    /// - Parameters:
+    ///   - id: The ID of the `Send` to publish updates for.
+    ///   - userId: The user ID of the user to associated with the object to fetch.
+    /// - Returns: A publisher for the user's send.
+    ///
+    func sendPublisher(id: String, userId: String) -> AnyPublisher<Send?, Error>
+
     /// A publisher for a user's send objects.
     ///
     /// - Parameter userId: The user ID of the user to associated with the objects to fetch.
     /// - Returns: A publisher for the user's sends.
     ///
-    func sendPublisher(userId: String) -> AnyPublisher<[Send], Error>
+    func sendsPublisher(userId: String) -> AnyPublisher<[Send], Error>
 
     /// Replaces a list of `Send` objects for a user.
     ///
@@ -74,7 +83,20 @@ extension DataStore: SendDataStore {
             .first
     }
 
-    func sendPublisher(userId: String) -> AnyPublisher<[Send], Error> {
+    func sendPublisher(id: String, userId: String) -> AnyPublisher<Send?, Error> {
+        let fetchRequest = SendData.fetchByIdRequest(id: id, userId: userId)
+        fetchRequest.fetchLimit = 1
+        // A sort descriptor is needed by `NSFetchedResultsController`.
+        fetchRequest.sortDescriptors = [NSSortDescriptor(keyPath: \SendData.id, ascending: true)]
+        return FetchedResultsPublisher(
+            context: persistentContainer.viewContext,
+            request: fetchRequest
+        )
+        .tryMap { try $0.first.map(Send.init) }
+        .eraseToAnyPublisher()
+    }
+
+    func sendsPublisher(userId: String) -> AnyPublisher<[Send], Error> {
         let fetchRequest = SendData.fetchByUserIdRequest(userId: userId)
         // A sort descriptor is needed by `NSFetchedResultsController`.
         fetchRequest.sortDescriptors = [NSSortDescriptor(keyPath: \SendData.id, ascending: true)]

BitwardenShared/Core/Tools/Services/Stores/SendDataStoreTests.swift

@@ -55,10 +55,29 @@ class SendDataStoreTests: BitwardenTestCase {
         )
     }
 
-    /// `sendPublisher(userId:)` returns a publisher for a user's send objects.
+    /// `sendPublisher(userId:)` returns a publisher for a single send.
     func test_sendPublisher() async throws {
+        var publishedValues = [Send?]()
+        let publisher = subject.sendPublisher(id: "1", userId: "1")
+            .sink(
+                receiveCompletion: { _ in },
+                receiveValue: { value in
+                    publishedValues.append(value)
+                }
+            )
+        defer { publisher.cancel() }
+
+        try await subject.replaceSends(sends, userId: "1")
+
+        waitFor { publishedValues.count == 2 }
+        XCTAssertNil(publishedValues[0])
+        XCTAssertEqual(publishedValues[1], Send.fixture(id: "1", name: "SEND1"))
+    }
+
+    /// `sendsPublisher(userId:)` returns a publisher for a user's send objects.
+    func test_sendsPublisher() async throws {
         var publishedValues = [[Send]]()
-        let publisher = subject.sendPublisher(userId: "1")
+        let publisher = subject.sendsPublisher(userId: "1")
             .sink(
                 receiveCompletion: { _ in },
                 receiveValue: { values in

BitwardenShared/Core/Tools/Services/Stores/TestHelpers/MockSendDataStore.swift

@@ -13,7 +13,9 @@ class MockSendDataStore: SendDataStore {
     var fetchSendUserId: String?
     var fetchSendResult: Result<Send?, Error> = .success(nil)
 
-    var sendSubject = CurrentValueSubject<[Send], Error>([])
+    var sendSubject = CurrentValueSubject<Send?, Error>(nil)
+
+    var sendsSubject = CurrentValueSubject<[Send], Error>([])
 
     var replaceSendsValue: [Send]?
     var replaceSendsUserId: String?
@@ -36,10 +38,14 @@ class MockSendDataStore: SendDataStore {
         return try fetchSendResult.get()
     }
 
-    func sendPublisher(userId: String) -> AnyPublisher<[Send], Error> {
+    func sendPublisher(id: String, userId: String) -> AnyPublisher<Send?, Error> {
         sendSubject.eraseToAnyPublisher()
     }
 
+    func sendsPublisher(userId: String) -> AnyPublisher<[Send], Error> {
+        sendsSubject.eraseToAnyPublisher()
+    }
+
     func replaceSends(_ sends: [Send], userId: String) async throws {
         replaceSendsValue = sends
         replaceSendsUserId = userId

BitwardenShared/Core/Tools/Services/TestHelpers/MockSendService.swift

@@ -37,6 +37,8 @@ class MockSendService: SendService {
     var syncSendWithServerId: String?
     var syncSendWithServerResult: Result<Void, Error> = .success(())
 
+    var sendSubject = CurrentValueSubject<Send?, Error>(nil)
+
     var sendsSubject = CurrentValueSubject<[Send], Error>([])
 
     // MARK: Methods
@@ -87,6 +89,10 @@ class MockSendService: SendService {
         return try syncSendWithServerResult.get()
     }
 
+    func sendPublisher(id: String) async throws -> AnyPublisher<Send?, Error> {
+        sendSubject.eraseToAnyPublisher()
+    }
+
     func sendsPublisher() async throws -> AnyPublisher<[Send], Error> {
         sendsSubject.eraseToAnyPublisher()
     }

BitwardenShared/UI/Tools/PreviewContent/SendView+Fixtures.swift

@@ -5,7 +5,7 @@ import Foundation
 #if DEBUG
 extension SendView {
     static func fixture(
-        id: String = "id",
+        id: String? = "id",
         accessId: String = "accessId",
         name: String = "name",
         notes: String? = nil,

BitwardenShared/UI/Tools/Send/Send/SendList/SendListView.swift

@@ -1,6 +1,8 @@
 import BitwardenSdk
 import SwiftUI
 
+// swiftlint:disable file_length
+
 // MARK: - MainSendListView
 
 /// The main content of the `SendListView`. Broken out into it's own view so that the

BitwardenShared/UI/Tools/Send/SendItem/AddEditSendItem/AddEditSendItemProcessor.swift

@@ -2,8 +2,6 @@ import BitwardenKit
 @preconcurrency import BitwardenSdk
 import Foundation
 
-// swiftlint:disable file_length
-
 // MARK: - AddEditSendItemProcessor
 
 /// The processor used to manage state and handle actions for the add/edit send item screen.

BitwardenShared/UI/Tools/Send/SendItem/ViewSendItem/ViewSendItemEffect.swift

@@ -8,4 +8,7 @@ enum ViewSendItemEffect: Equatable {
 
     /// Any initial data for the view should be loaded.
     case loadData
+
+    /// Stream the details of the send.
+    case streamSend
 }

BitwardenShared/UI/Tools/Send/SendItem/ViewSendItem/ViewSendItemProcessor.swift

@@ -46,6 +46,8 @@ class ViewSendItemProcessor: StateProcessor<ViewSendItemState, ViewSendItemActio
             })
         case .loadData:
             await loadData()
+        case .streamSend:
+            await streamSend()
         }
     }
 
@@ -101,4 +103,21 @@ class ViewSendItemProcessor: StateProcessor<ViewSendItemState, ViewSendItemActio
             await coordinator.showErrorAlert(error: error)
         }
     }
+
+    /// Streams the details of the send, so the view updates if the send changes.
+    ///
+    private func streamSend() async {
+        do {
+            guard let sendId = state.sendView.id else {
+                throw BitwardenError.dataError("View Send: send ID is nil, can't stream updates to send")
+            }
+            for try await sendView in try await services.sendRepository.sendPublisher(id: sendId) {
+                guard let sendView else { return }
+                state.sendView = sendView
+            }
+        } catch {
+            services.errorReporter.log(error: error)
+            await coordinator.showErrorAlert(error: error)
+        }
+    }
 }