Merge pull request #18405 from wordpress-mobile/feature/dashboard-arch-refactor/base

My Site Dashboard: Refactor dashboard architecture and data source

Author: hassaanelgarem

RELEASE-NOTES.txt

@@ -1,6 +1,6 @@
 19.8
 -----
-
+* [*] [internal] My Site Dashboard: Made some changes to the code architecture of the dashboard. The majority of the changes are related to the posts cards. It should have no visible changes but could cause regressions. Please test it by creating/trashing drafts and scheduled posts and testing that they appear correctly on the dashboard. [#18405]
 
 19.7
 -----

WordPress/Classes/PropertyWrappers/Atomic.swift

@@ -0,0 +1,29 @@
+import Foundation
+
+@propertyWrapper
+struct Atomic<Value> {
+
+    private var value: Value
+    private let lock = NSLock()
+
+    init(wrappedValue value: Value) {
+        self.value = value
+    }
+
+    var wrappedValue: Value {
+      get { return load() }
+      set { store(newValue: newValue) }
+    }
+
+    func load() -> Value {
+        lock.lock()
+        defer { lock.unlock() }
+        return value
+    }
+
+    mutating func store(newValue: Value) {
+        lock.lock()
+        defer { lock.unlock() }
+        value = newValue
+    }
+}

WordPress/Classes/Services/PostCoordinator+Dashboard.swift

@@ -13,6 +13,10 @@ extension PostCoordinator {
     func notifyNewPostCreated() {
         NotificationCenter.default.post(name: .newPostCreated, object: nil)
     }
+
+    func notifyNewPostPublished() {
+        NotificationCenter.default.post(name: .newPostPublished, object: nil)
+    }
 }
 
 extension NSNotification.Name {
@@ -21,4 +25,7 @@ extension NSNotification.Name {
 
     /// Fired when a draft is saved
     static let newPostCreated = NSNotification.Name("NewPostCreated")
+
+    /// Fired when a post is published
+    static let newPostPublished = NSNotification.Name("NewPostPublished")
 }

WordPress/Classes/Services/PostCoordinator.swift

@@ -242,6 +242,8 @@ class PostCoordinator: NSObject {
 
             if uploadedPost.isScheduled() {
                 self?.notifyNewPostScheduled()
+            } else if uploadedPost.isPublished() {
+                self?.notifyNewPostPublished()
             }
 
             SearchManager.shared.indexItem(uploadedPost)

WordPress/Classes/ViewRelated/Blog/Blog Dashboard/BlogDashboardViewController.swift

@@ -10,6 +10,8 @@ protocol BlogDashboardCardConfigurable {
 final class BlogDashboardViewController: UIViewController {
 
     var blog: Blog
+    var presentedPostStatus: String?
+
     private let embeddedInScrollView: Bool
 
     private lazy var viewModel: BlogDashboardViewModel = {
@@ -57,7 +59,6 @@ final class BlogDashboardViewController: UIViewController {
         addHeightObservers()
         addWillEnterForegroundObserver()
         addQuickStartObserver()
-        addNewPostAvailableObserver()
         viewModel.viewDidLoad()
 
         // Force the view to update its layout immediately, so the content size is calculated correctly
@@ -78,6 +79,10 @@ final class BlogDashboardViewController: UIViewController {
         stopAlertTimer()
     }
 
+    func reloadCardsLocally() {
+        viewModel.loadCardsFromCache()
+    }
+
     /// If you want to give any feedback when the dashboard
     /// started loading just change this method.
     /// For not, it will be transparent
@@ -124,6 +129,7 @@ final class BlogDashboardViewController: UIViewController {
     private func setupCollectionView() {
         collectionView.isScrollEnabled = !embeddedInScrollView
         collectionView.backgroundColor = .listBackground
+        collectionView.register(DashboardQuickActionsCardCell.self, forCellWithReuseIdentifier: DashboardQuickActionsCardCell.self.defaultReuseID)
         DashboardCard.allCases.forEach {
             collectionView.register($0.cell, forCellWithReuseIdentifier: $0.cell.defaultReuseID)
         }
@@ -144,10 +150,6 @@ final class BlogDashboardViewController: UIViewController {
         NotificationCenter.default.addObserver(self, selector: #selector(loadCardsFromCache), name: .QuickStartTourElementChangedNotification, object: nil)
     }
 
-    private func addNewPostAvailableObserver() {
-        NotificationCenter.default.addObserver(self, selector: #selector(loadCardsFromCache), name: .newPostAvailableForDashboard, object: nil)
-    }
-
     @objc private func updateCollectionViewHeight(notification: Notification) {
         collectionView.collectionViewLayout.invalidateLayout()
     }
@@ -195,10 +197,9 @@ extension BlogDashboardViewController {
         let group = NSCollectionLayoutGroup.vertical(layoutSize: itemSize, subitems: [item])
 
         let section = NSCollectionLayoutSection(group: group)
-        let isQuickActionSection = viewModel.card(for: sectionIndex) == .quickActions
-        let isLastSection = collectionView.numberOfSections == (sectionIndex + 1)
+        let isQuickActionSection = viewModel.isQuickActionsSection(sectionIndex)
         let horizontalInset = isQuickActionSection ? 0 : Constants.horizontalSectionInset
-        let bottomInset = isLastSection ? Constants.verticalSectionInset : 0
+        let bottomInset = isQuickActionSection ? 0 : Constants.verticalSectionInset
         section.contentInsets = NSDirectionalEdgeInsets(top: Constants.verticalSectionInset,
                                                         leading: horizontalInset,
                                                         bottom: bottomInset,
@@ -264,7 +265,7 @@ extension BlogDashboardViewController {
         static let estimatedHeight: CGFloat = 44
         static let horizontalSectionInset: CGFloat = 20
         static let verticalSectionInset: CGFloat = 20
-        static let cellSpacing: CGFloat = 24
+        static let cellSpacing: CGFloat = 20
     }
 }
 

…ds/Posts/BlogDashboardNextPostView.swift …/Posts/DashboardEmptyPostsCardCell.swiftWordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/BlogDashboardNextPostView.swift renamed to WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/DashboardEmptyPostsCardCell.swift WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/BlogDashboardNextPostView.swift renamed to WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/DashboardEmptyPostsCardCell.swift

@@ -1,7 +1,31 @@
 import UIKit
 
-/// View prompting the user to create their next post
-class BlogDashboardNextPostView: UIView {
+/// Card cell prompting the user to create their first post
+final class DashboardFirstPostCardCell: DashboardEmptyPostsCardCell, BlogDashboardCardConfigurable {
+    func configure(blog: Blog, viewController: BlogDashboardViewController?, apiResponse: BlogDashboardRemoteEntity?) {
+        super.configure(blog: blog, viewController: viewController, apiResponse: apiResponse, cardType: .createPost)
+    }
+}
+
+/// Card cell prompting the user to create their next post
+final class DashboardNextPostCardCell: DashboardEmptyPostsCardCell, BlogDashboardCardConfigurable {
+    func configure(blog: Blog, viewController: BlogDashboardViewController?, apiResponse: BlogDashboardRemoteEntity?) {
+        super.configure(blog: blog, viewController: viewController, apiResponse: apiResponse, cardType: .nextPost)
+    }
+}
+
+/// Card cell used when no posts are available to display
+class DashboardEmptyPostsCardCell: UICollectionViewCell, Reusable {
+
+    // MARK: Views
+
+    private lazy var frameView: BlogDashboardCardFrameView = {
+        let frameView = BlogDashboardCardFrameView()
+        frameView.translatesAutoresizingMaskIntoConstraints = false
+        frameView.hideHeader()
+        return frameView
+    }()
+
     private lazy var mainStackView: UIStackView = {
         let mainStackView = UIStackView()
         mainStackView.translatesAutoresizingMaskIntoConstraints = false
@@ -54,20 +78,21 @@ class BlogDashboardNextPostView: UIView {
         return imageView
     }()
 
-    var onTap: (() -> Void)?
+    // MARK: Private Variables
 
-    var hasPublishedPosts: Bool = true {
-        didSet {
-            titleLabel.text = hasPublishedPosts ? Strings.nextPostTitle : Strings.firstPostTitle
-            descriptionLabel.text = hasPublishedPosts ? Strings.nextPostDescription : Strings.firstPostDescription
-        }
-    }
+    /// The VC presenting this cell
+    private weak var viewController: BlogDashboardViewController?
+    private var blog: Blog?
+
+    // MARK: Initializers
 
     override init(frame: CGRect) {
         super.init(frame: frame)
 
-        addSubview(mainStackView)
-        pinSubviewToAllEdges(mainStackView)
+        contentView.addSubview(frameView)
+        contentView.pinSubviewToAllEdges(frameView, priority: Constants.constraintPriority)
+
+        frameView.add(subview: mainStackView)
 
         mainStackView.addArrangedSubviews([
             contentStackView,
@@ -83,19 +108,58 @@ class BlogDashboardNextPostView: UIView {
         addGestureRecognizer(tap)
     }
 
+    required init?(coder: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+
+    // MARK: Actions
+
     @objc private func promptTapped() {
-        onTap?()
+        presentEditor()
     }
+}
 
-    required init?(coder: NSCoder) {
-        fatalError("init(coder:) has not been implemented")
+// MARK: BlogDashboardCardConfigurable
+
+extension DashboardEmptyPostsCardCell {
+    func configure(blog: Blog, viewController: BlogDashboardViewController?, apiResponse: BlogDashboardRemoteEntity?, cardType: DashboardCard) {
+        self.blog = blog
+        self.viewController = viewController
+
+        switch cardType {
+        case .createPost:
+            titleLabel.text = Strings.firstPostTitle
+            descriptionLabel.text = Strings.firstPostDescription
+        case .nextPost:
+            titleLabel.text = Strings.nextPostTitle
+            descriptionLabel.text = Strings.nextPostDescription
+        default:
+            assertionFailure("Cell used with wrong card type")
+            return
+        }
+
+        BlogDashboardAnalytics.shared.track(.dashboardCardShown, properties: ["type": "post", "sub_type": cardType.rawValue])
+    }
+}
+
+// MARK: Private Helpers
+
+private extension DashboardEmptyPostsCardCell {
+    func presentEditor() {
+        let controller = viewController?.tabBarController as? WPTabBarController
+        controller?.showPostTab()
     }
+}
+
+// MARK: Constants
 
+extension DashboardEmptyPostsCardCell {
     private enum Constants {
         static let horizontalSpacing: CGFloat = 16
         static let verticalSpacing: CGFloat = 10
         static let padding = UIEdgeInsets(top: 8, left: 16, bottom: 8, right: 16)
         static let imageSize = CGSize(width: 70, height: 70)
+        static let constraintPriority = UILayoutPriority(999)
     }
 
     private enum Strings {