Merge pull request #17839 from wordpress-mobile/task/17697-msd-show-error-retry

leandroalonso · web-flow · commit fedbd94f23cd · 2022-02-01T09:20:29.000-03:00
My Site Dashboard: add error messages when posts fails to load
diff --git a/WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/Helpers/DashboardCardInnerErrorView.swift b/WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/Helpers/DashboardCardInnerErrorView.swift
@@ -0,0 +1,56 @@
+import UIKit
+
+protocol DashboardCardInnerErrorViewDelegate: AnyObject {
+    func retry()
+}
+
+class DashboardCardInnerErrorView: UIStackView {
+    weak var delegate: DashboardCardInnerErrorViewDelegate?
+
+    private lazy var errorTitle: UILabel = {
+        let errorTitle = UILabel()
+        errorTitle.textAlignment = .center
+        errorTitle.textColor = .textSubtle
+        WPStyleGuide.configureLabel(errorTitle, textStyle: .callout, fontWeight: .semibold)
+        return errorTitle
+    }()
+
+    private lazy var retryLabel: UILabel = {
+        let retryLabel = UILabel()
+        retryLabel.textAlignment = .center
+        retryLabel.text = Strings.tapToRetry
+        retryLabel.textColor = .textSubtle
+        WPStyleGuide.configureLabel(retryLabel, textStyle: .callout, fontWeight: .regular)
+        return retryLabel
+    }()
+
+    convenience init(message: String, canRetry: Bool) {
+        self.init(arrangedSubviews: [])
+
+        errorTitle.text = message
+        addArrangedSubview(errorTitle)
+
+        axis = .vertical
+        spacing = Constants.spacing
+
+        if canRetry {
+            addArrangedSubview(retryLabel)
+
+            isUserInteractionEnabled = true
+            let tap = UITapGestureRecognizer(target: self, action: #selector(didTap))
+            addGestureRecognizer(tap)
+        }
+    }
+
+    @objc func didTap() {
+        delegate?.retry()
+    }
+
+    private enum Constants {
+        static let spacing: CGFloat = 8
+    }
+
+    private enum Strings {
+        static let tapToRetry = NSLocalizedString("Tap to retry", comment: "Label for a button to retry loading posts")
+    }
+}
diff --git a/WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/PostsCardViewController.swift b/WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/PostsCardViewController.swift
@@ -11,6 +11,7 @@ import UIKit
 
     private var viewModel: PostsCardViewModel!
     private var ghostableTableView: UITableView?
+    private var errorView: DashboardCardInnerErrorView?
 
     private let status: BasePost.Status = .draft
 
@@ -31,6 +32,11 @@ import UIKit
         viewModel.viewDidLoad()
     }
 
+    override func viewWillAppear(_ animated: Bool) {
+        super.viewWillAppear(animated)
+        hideSeparatorForGhostCells()
+    }
+
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
         tableView.dataSource = viewModel
@@ -49,14 +55,15 @@ private extension PostsCardViewController {
     func configureTableView() {
         view.addSubview(tableView)
         tableView.translatesAutoresizingMaskIntoConstraints = false
+        tableView.isScrollEnabled = false
         view.pinSubviewToAllEdges(tableView)
         let postCompactCellNib = PostCompactCell.defaultNib
         tableView.register(postCompactCellNib, forCellReuseIdentifier: PostCompactCell.defaultReuseID)
         tableView.separatorStyle = .none
     }
 
     func configureGhostableTableView() {
-        let ghostableTableView = IntrinsicTableView()
+        let ghostableTableView = PostCardTableView()
 
         view.addSubview(ghostableTableView)
 
@@ -83,6 +90,11 @@ private extension PostsCardViewController {
         ghostableTableView?.removeFromSuperview()
     }
 
+    func hideSeparatorForGhostCells() {
+        ghostableTableView?.visibleCells
+            .forEach { ($0 as? PostCompactCell)?.hideSeparator() }
+    }
+
     enum Constants {
         static let numberOfPosts = 3
     }
@@ -105,8 +117,21 @@ extension PostsCardViewController: PostsCardView {
     }
 
     func hideLoading() {
+        errorView?.removeFromSuperview()
         removeGhostableTableView()
     }
+
+    func showError(message: String, retry: Bool) {
+        let errorView = DashboardCardInnerErrorView(message: message, canRetry: retry)
+        errorView.delegate = self
+        errorView.translatesAutoresizingMaskIntoConstraints = false
+        tableView.addSubview(withFadeAnimation: errorView)
+        tableView.pinSubviewToSafeArea(errorView)
+        self.errorView = errorView
+
+        // Force the table view to recalculate its height
+        _ = tableView.intrinsicContentSize
+    }
 }
 
 // MARK: - EditorAnalyticsProperties
@@ -126,6 +151,14 @@ extension PostsCardViewController: EditorAnalyticsProperties {
     }
 }
 
+// MARK: - DashboardCardInnerErrorViewDelegate
+
+extension PostsCardViewController: DashboardCardInnerErrorViewDelegate {
+    func retry() {
+        viewModel.retry()
+    }
+}
+
 // MARK: - PostCardTableView
 
 extension NSNotification.Name {
diff --git a/WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/PostsCardViewModel.swift b/WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/PostsCardViewModel.swift
@@ -7,6 +7,7 @@ protocol PostsCardView: AnyObject {
 
     func showLoading()
     func hideLoading()
+    func showError(message: String, retry: Bool)
 }
 
 /// Responsible for populating a table view with posts
@@ -52,6 +53,11 @@ class PostsCardViewModel: NSObject {
         }
     }
 
+    func retry() {
+        viewController?.showLoading()
+        sync()
+    }
+
     /// Set up the view model to be ready for use
     func viewDidLoad() {
         viewController?.showLoading()
@@ -73,6 +79,10 @@ class PostsCardViewModel: NSObject {
 // MARK: - Private methods
 
 private extension PostsCardViewModel {
+    private var numberOfPosts: Int {
+        fetchedResultsController.fetchedObjects?.count ?? 0
+    }
+
     func createFetchedResultsController() {
         fetchedResultsController?.delegate = nil
         fetchedResultsController = nil
@@ -121,17 +131,36 @@ private extension PostsCardViewModel {
             ofType: .post,
             with: options,
             for: blog,
-            success: { _ in
+            success: { [weak self] _ in
+                if self?.numberOfPosts == 0 {
+                    self?.showEmptyPostsError()
+                }
+            }, failure: { [weak self] _ in
+                if self?.numberOfPosts == 0 {
+                    self?.showLoadingFailureError()
+                }
+        })
+    }
 
-            }, failure: { (error: Error?) -> () in
+    func showEmptyPostsError() {
+        viewController?.hideLoading()
+        viewController?.showError(message: Strings.noPostsMessage, retry: false)
+    }
 
-        })
+    func showLoadingFailureError() {
+        viewController?.hideLoading()
+        viewController?.showError(message: Strings.loadingFailure, retry: true)
     }
 
     enum Constants {
         static let numberOfPosts = 3
         static let numberOfPostsToSync: NSNumber = 4
     }
+
+    enum Strings {
+        static let noPostsMessage = NSLocalizedString("You don't have any posts", comment: "Displayed when the user views the dashboard posts card but they have no posts")
+        static let loadingFailure = NSLocalizedString("Unable to load posts right now.", comment: "Message for when posts fail to load on the dashboard")
+    }
 }
 
 // MARK: - UITableViewDataSource
diff --git a/WordPress/Classes/ViewRelated/Post/PostCompactCell.swift b/WordPress/Classes/ViewRelated/Post/PostCompactCell.swift
@@ -232,4 +232,8 @@ extension PostCompactCell {
         trailingContentConstraint.constant = Constants.margin
         headerStackView.spacing = Constants.margin
     }
+
+    func hideSeparator() {
+        separator.isHidden = true
+    }
 }
diff --git a/WordPress/WordPress.xcodeproj/project.pbxproj b/WordPress/WordPress.xcodeproj/project.pbxproj
@@ -1437,6 +1437,8 @@
 		8B821F3C240020E2006B697E /* PostServiceUploadingListTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B821F3B240020E2006B697E /* PostServiceUploadingListTests.swift */; };
 		8B85AEDA259230FC00ADBEC9 /* ABTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B85AED9259230FC00ADBEC9 /* ABTest.swift */; };
 		8B8C814D2318073300A0E620 /* BasePostTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B8C814C2318073300A0E620 /* BasePostTests.swift */; };
+		8B8E50B627A4692000C89979 /* DashboardCardInnerErrorView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B8E50B527A4692000C89979 /* DashboardCardInnerErrorView.swift */; };
+		8B8E50B727A4692000C89979 /* DashboardCardInnerErrorView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B8E50B527A4692000C89979 /* DashboardCardInnerErrorView.swift */; };
 		8B8FE8582343955500F9AD2E /* PostAutoUploadMessages.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B8FE8562343952B00F9AD2E /* PostAutoUploadMessages.swift */; };
 		8B93412F257029F60097D0AC /* FilterChipButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B93412E257029F50097D0AC /* FilterChipButton.swift */; };
 		8B93856E22DC08060010BF02 /* PageListSectionHeaderView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B93856D22DC08060010BF02 /* PageListSectionHeaderView.swift */; };
@@ -6077,6 +6079,7 @@
 		8B821F3B240020E2006B697E /* PostServiceUploadingListTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PostServiceUploadingListTests.swift; sourceTree = "<group>"; };
 		8B85AED9259230FC00ADBEC9 /* ABTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ABTest.swift; sourceTree = "<group>"; };
 		8B8C814C2318073300A0E620 /* BasePostTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BasePostTests.swift; sourceTree = "<group>"; };
+		8B8E50B527A4692000C89979 /* DashboardCardInnerErrorView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DashboardCardInnerErrorView.swift; sourceTree = "<group>"; };
 		8B8FE8562343952B00F9AD2E /* PostAutoUploadMessages.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PostAutoUploadMessages.swift; sourceTree = "<group>"; };
 		8B93412E257029F50097D0AC /* FilterChipButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FilterChipButton.swift; sourceTree = "<group>"; };
 		8B93856D22DC08060010BF02 /* PageListSectionHeaderView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PageListSectionHeaderView.swift; sourceTree = "<group>"; };
@@ -11317,6 +11320,7 @@
 			isa = PBXGroup;
 			children = (
 				8B4DDF24278F3AF60022494D /* Posts */,
+				8B8E50B427A468E800C89979 /* Helpers */,
 			);
 			path = Cards;
 			sourceTree = "<group>";
@@ -11371,6 +11375,15 @@
 			path = "AB Testing";
 			sourceTree = "<group>";
 		};
+		8B8E50B427A468E800C89979 /* Helpers */ = {
+			isa = PBXGroup;
+			children = (
+				8B8E50B527A4692000C89979 /* DashboardCardInnerErrorView.swift */,
+			);
+			name = Helpers;
+			path = Posts/Helpers;
+			sourceTree = "<group>";
+		};
 		8B93412D257029E30097D0AC /* Filter */ = {
 			isa = PBXGroup;
 			children = (
@@ -18167,6 +18180,7 @@
 				C76F48EE25BA20EF00BFEC87 /* JetpackScanHistoryCoordinator.swift in Sources */,
 				17FCA6811FD84B4600DBA9C8 /* NoticeStore.swift in Sources */,
 				9A162F2921C271D300FDC035 /* RevisionBrowserState.swift in Sources */,
+				8B8E50B627A4692000C89979 /* DashboardCardInnerErrorView.swift in Sources */,
 				FAADE43A26159B2800BF29FE /* AppConstants.swift in Sources */,
 				1751E5911CE0E552000CA08D /* KeyValueDatabase.swift in Sources */,
 				8BF0B607247D88EB009A7457 /* UITableViewCell+enableDisable.swift in Sources */,
@@ -19790,6 +19804,7 @@
 				93CDC72226CD342900C8A3A8 /* DestructiveAlertHelper.swift in Sources */,
 				FABB22612602FC2C00C8785C /* WPStyleGuide+AlertView.swift in Sources */,
 				DC76668426FD9AC9009254DD /* TimeZoneRow.swift in Sources */,
+				8B8E50B727A4692000C89979 /* DashboardCardInnerErrorView.swift in Sources */,
 				FABB22622602FC2C00C8785C /* ErrorStateViewConfiguration.swift in Sources */,
 				46B1A16C26A774E500F058AE /* CollapsableHeaderView.swift in Sources */,
 				FABB22632602FC2C00C8785C /* UIFont+Styles.swift in Sources */,

Original file line number	Diff line number	Diff line change
`@@ -232,4 +232,8 @@ extension PostCompactCell {`
`232`	`232`	`trailingContentConstraint.constant = Constants.margin`
`233`	`233`	`headerStackView.spacing = Constants.margin`
`234`	`234`	`}`
	`235`	`+`
	`236`	`+ func hideSeparator() {`
	`237`	`+ separator.isHidden = true`
	`238`	`+ }`
`235`	`239`	`}`