Background image upload: Show a notice when the user leaves product details while uploads are pending (#15134)

Author: itsmeichigo

RELEASE-NOTES.txt

@@ -9,6 +9,7 @@
 - [*] Product List: Display syncing animation on items with image upload in progress [https://github.com/woocommerce/woocommerce-ios/pull/15052]
 - [*] Background image upload: Fix issue showing uploaded images while saving is in progress [https://github.com/woocommerce/woocommerce-ios/pull/15107]
 - [*] Background image upload: Fix missing error notice in iPhones [https://github.com/woocommerce/woocommerce-ios/pull/15117]
+- [*] Background image upload: Show a notice when the user leaves product details while uploads are pending [https://github.com/woocommerce/woocommerce-ios/pull/15134]
 - [*] Filters applied in product selector no longer affect the main product list screen. [https://github.com/woocommerce/woocommerce-ios/pull/14764]
 
 21.7

WooCommerce/Classes/ServiceLocator/ProductImageUploader.swift

@@ -1,4 +1,5 @@
 import Combine
+import Foundation
 import struct Yosemite.ProductImage
 import enum Yosemite.ProductAction
 import protocol Yosemite.StoresManager
@@ -79,6 +80,11 @@ protocol ProductImageUploaderProtocol {
     ///   - key: identifiable information about the product.
     func startEmittingErrors(key: ProductImageUploaderKey)
 
+    /// Triggers a notice about background image upload for a product if needed.
+    /// - Parameter key: identifiable information about the product.
+    ///
+    func sendBackgroundUploadNoticeIfNeeded(key: ProductImageUploaderKey, using noticePresenter: NoticePresenter)
+
     /// Determines whether there are unsaved changes on a product's images.
     /// If the product had any save request before, it checks whether the image statuses to save match the latest image statuses.
     /// Otherwise, it checks whether there is any pending upload or the image statuses match the given original image statuses.
@@ -165,6 +171,13 @@ final class ProductImageUploader: ProductImageUploaderProtocol {
         statusUpdatesExcludedProductKeys.remove(key)
     }
 
+    func sendBackgroundUploadNoticeIfNeeded(key: ProductImageUploaderKey, using noticePresenter: NoticePresenter) {
+        if activeUploadsPublisher.contains(key) {
+            let notice = Notice(title: Localization.backgroundUploadNoticeTitle)
+            noticePresenter.enqueue(notice: notice)
+        }
+    }
+
     func hasUnsavedChangesOnImages(key: ProductImageUploaderKey, originalImages: [ProductImage]) -> Bool {
         guard let handler = actionHandlersByProduct[key] else {
             return false
@@ -298,3 +311,11 @@ enum ProductImageUploaderError: Error {
     case failedSavingProductAfterImageUpload(error: Error)
     case failedUploadingImage(error: Error)
 }
+
+private enum Localization {
+    static let backgroundUploadNoticeTitle = NSLocalizedString(
+        "productImageUploader.backgroundUploadNotice.title",
+        value: "Image uploading will continue in the background",
+        comment: ""
+    )
+}

WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController.swift

@@ -194,12 +194,7 @@ final class ProductFormViewController<ViewModel: ProductFormViewModelProtocol>:
         super.viewWillDisappear(animated)
 
         view.endEditing(true)
-
-        if isBeingDismissedInAnyWay {
-            productImageUploader.startEmittingErrors(key: .init(siteID: viewModel.productModel.siteID,
-                                                                productOrVariationID: productOrVariationID,
-                                                                isLocalID: !viewModel.productModel.existsRemotely))
-        }
+        prepareForBackgroundUploadsUponDismissal()
     }
 
     override var shouldShowOfflineBanner: Bool {
@@ -1337,6 +1332,16 @@ private extension ProductFormViewController {
 // MARK: - Navigation actions handling
 //
 private extension ProductFormViewController {
+    func prepareForBackgroundUploadsUponDismissal() {
+        guard isBeingDismissedInAnyWay else { return }
+
+        let key = ProductImageUploaderKey(siteID: viewModel.productModel.siteID,
+                                          productOrVariationID: productOrVariationID,
+                                          isLocalID: !viewModel.productModel.existsRemotely)
+        productImageUploader.startEmittingErrors(key: key)
+        productImageUploader.sendBackgroundUploadNoticeIfNeeded(key: key, using: ServiceLocator.noticePresenter)
+    }
+
     func presentBackNavigationActionSheet(onDiscard: @escaping () -> Void = {}, onCancel: @escaping () -> Void = {}) {
         let exitForm: () -> Void = {
             presentationStyle.createExitForm(viewController: navigationController ?? self, completion: onDiscard)

WooCommerce/Classes/ViewRelated/Products/ProductsSplitViewCoordinator.swift

@@ -231,10 +231,7 @@ extension ProductsSplitViewCoordinator: UINavigationControllerDelegate {
     func navigationController(_ navigationController: UINavigationController, didShow viewController: UIViewController, animated: Bool) {
         if didNavigateFromTheLastSecondaryViewControllerToProductListInCollapsedMode(navigationController, didShow: viewController) {
             if let contentType = contentTypes.last, case let .productForm(product) = contentType, let product {
-                ServiceLocator.productImageUploader.startEmittingErrors(
-                    key: .init(siteID: product.siteID,
-                               productOrVariationID: .product(id: product.productID),
-                               isLocalID: false))
+                didDismissProductForm(product: product)
             }
             contentTypes = []
             secondaryNavigationController.viewControllers = []
@@ -275,6 +272,15 @@ private extension ProductsSplitViewCoordinator {
         return splitViewController.isCollapsed && navigationController == primaryNavigationController
             && contentTypes.isNotEmpty && isNavigatingToProductList
     }
+
+    func didDismissProductForm(product: Product) {
+        let uploader = ServiceLocator.productImageUploader
+        let key = ProductImageUploaderKey(siteID: product.siteID,
+                                          productOrVariationID: .product(id: product.productID),
+                                          isLocalID: false)
+        uploader.startEmittingErrors(key: key)
+        uploader.sendBackgroundUploadNoticeIfNeeded(key: key, using: ServiceLocator.noticePresenter)
+    }
 }
 
 private extension ProductsSplitViewCoordinator {

WooCommerce/WooCommerceTests/Mocks/MockProductImageUploader.swift

@@ -63,6 +63,10 @@ extension MockProductImageUploader: ProductImageUploaderProtocol {
         hasUnsavedChangesOnImages
     }
 
+    func sendBackgroundUploadNoticeIfNeeded(key: ProductImageUploaderKey, using noticePresenter: NoticePresenter) {
+        // no-op
+    }
+
     func reset() {
         resetWasCalled = true
     }

WooCommerce/WooCommerceTests/ViewRelated/Products/Media/ProductImageUploaderTests.swift

@@ -607,6 +607,7 @@ final class ProductImageUploaderTests: XCTestCase {
     }
 
     func test_product_is_removed_from_activeUploads_when_upload_is_cancelled() {
+        // Given
         let stores = MockStoresManager(sessionManager: .testingInstance)
         let imageUploader = ProductImageUploader(stores: stores)
         let key = ProductImageUploaderKey(siteID: siteID,
@@ -638,6 +639,45 @@ final class ProductImageUploaderTests: XCTestCase {
             activeUploads == []
         }
     }
+
+    func test_background_upload_notice_is_sent_when_there_are_active_uploads() {
+        // Given
+        let stores = MockStoresManager(sessionManager: .testingInstance)
+        let imageUploader = ProductImageUploader(stores: stores)
+        let key = ProductImageUploaderKey(siteID: siteID,
+                                          productOrVariationID: .product(id: productID),
+                                          isLocalID: false)
+        let actionHandler = imageUploader.actionHandler(key: key, originalStatuses: [])
+
+        let noticePresenter = MockNoticePresenter()
+        var isNoticeTriggered = false
+        noticePresenter.onNoticeQueued = { _ in
+            isNoticeTriggered = true
+        }
+
+        var activeUploads: [ProductImageUploaderKey] = []
+        activeUploadsSubscription = imageUploader.activeUploads
+            .sink { keys in
+                activeUploads = keys
+            }
+
+        // When
+        imageUploader.sendBackgroundUploadNoticeIfNeeded(key: key, using: noticePresenter)
+
+        // Then
+        XCTAssertFalse(isNoticeTriggered)
+
+        // When
+        let asset = PHAsset()
+        actionHandler.uploadMediaAssetToSiteMediaLibrary(asset: .phAsset(asset: asset))
+        waitUntil {
+            activeUploads == [key]
+        }
+
+        // Then
+        imageUploader.sendBackgroundUploadNoticeIfNeeded(key: key, using: noticePresenter)
+        XCTAssertTrue(isNoticeTriggered)
+    }
 }
 
 extension ProductImageUploadErrorInfo: @retroactive Equatable {