Merge pull request #17848 from wordpress-mobile/task/17697-msd-track-posts-interaction

My Site Dashboard: track interaction with posts content

Author: leandroalonso

WordPress/Classes/Utility/Analytics/WPAnalyticsEvent.swift

@@ -303,6 +303,9 @@ import Foundation
     case changeUsernameDisplayed
     case changeUsernameDismissed
 
+    // My Site Dashboard
+    case dashboardCardItemTapped
+
     /// A String that represents the event
     var value: String {
         switch self {
@@ -811,6 +814,10 @@ import Foundation
         case .changeUsernameDismissed:
             return "change_username_dismissed"
 
+        // My Site Dashboard
+        case .dashboardCardItemTapped:
+            return "my_site_dashboard_card_item_tapped"
+
         } // END OF SWITCH
     }
 

WordPress/Classes/ViewRelated/Aztec/ViewControllers/AztecPostViewController.swift

@@ -69,6 +69,12 @@ class AztecPostViewController: UIViewController, PostEditor {
         mediaCoordinator.cancelUploadOfAllMedia(for: post)
     }
 
+    var entryPoint: PostEditorEntryPoint = .unknown {
+        didSet {
+            editorSession.entryPoint = entryPoint
+        }
+    }
+
     /// For autosaving - The debouncer will execute local saving every defined number of seconds.
     /// In this case every 0.5 second
     ///

WordPress/Classes/ViewRelated/Blog/Blog Dashboard/Cards/Posts/PostsCardViewController.swift

@@ -105,7 +105,10 @@ extension PostsCardViewController: UITableViewDelegate {
     func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
         let post = viewModel.postAt(indexPath)
 
-        PostListEditorPresenter.handle(post: post, in: self)
+        WPAnalytics.track(.dashboardCardItemTapped,
+                          properties: ["type": "post", "sub_type": status.rawValue])
+
+        PostListEditorPresenter.handle(post: post, in: self, entryPoint: .dashboard)
     }
 }
 

WordPress/Classes/ViewRelated/Gutenberg/GutenbergViewController.swift

@@ -70,6 +70,12 @@ class GutenbergViewController: UIViewController, PostEditor, FeaturedImageDelega
         }
     }
 
+    var entryPoint: PostEditorEntryPoint = .unknown {
+        didSet {
+            editorSession.entryPoint = entryPoint
+        }
+    }
+
     /// Maintainer of state for editor - like for post button
     ///
     private(set) lazy var postEditorStateContext: PostEditorStateContext = {

WordPress/Classes/ViewRelated/Post/EditPostViewController.swift

@@ -17,6 +17,8 @@ class EditPostViewController: UIViewController {
     var insertedMedia: [Media]? = nil
     /// is editing a reblogged post
     var postIsReblogged = false
+    /// the entry point for the editor
+    var entryPoint: PostEditorEntryPoint = .unknown
 
     private let loadAutosaveRevision: Bool
 
@@ -139,6 +141,7 @@ class EditPostViewController: UIViewController {
                 self?.replaceEditor(editor: editor, replacement: replacement)
         })
         editor.postIsReblogged = postIsReblogged
+        editor.entryPoint = entryPoint
         showEditor(editor)
     }
 

WordPress/Classes/ViewRelated/Post/PostEditor.swift

@@ -101,8 +101,12 @@ protocol PostEditor: PublishingEditor, UIViewControllerTransitioningDelegate {
     var replaceEditor: ReplaceEditorCallback { get }
 
     var autosaver: Autosaver { get set }
+
     /// true if the post is the result of a reblog
     var postIsReblogged: Bool { get set }
+
+    /// From where the editor was shown (for analytics reporting)
+    var entryPoint: PostEditorEntryPoint { get set }
 }
 
 extension PostEditor {
@@ -145,3 +149,9 @@ extension PostEditor {
         return [.visibility, .schedule, .tags, .categories]
     }
 }
+
+enum PostEditorEntryPoint: String {
+    case unknown
+    case postsList
+    case dashboard
+}

WordPress/Classes/ViewRelated/Post/PostEditorAnalyticsSession.swift

@@ -10,6 +10,7 @@ struct PostEditorAnalyticsSession {
     var currentEditor: Editor
     var hasUnsupportedBlocks = false
     var outcome: Outcome? = nil
+    var entryPoint: PostEditorEntryPoint?
     private let startTime = DispatchTime.now().uptimeNanoseconds
 
     init(editor: Editor, post: AbstractPost) {
@@ -49,6 +50,8 @@ struct PostEditorAnalyticsSession {
             properties[Property.unstableGalleryWithImageBlocks] = "unknown"
         }
 
+        properties[Property.entryPoint] = (entryPoint ?? .unknown).rawValue
+
         return properties.merging(commonProperties, uniquingKeysWith: { $1 })
     }
 
@@ -72,7 +75,10 @@ struct PostEditorAnalyticsSession {
 
     func end(outcome endOutcome: Outcome) {
         let outcome = self.outcome ?? endOutcome
-        let properties: [String: Any] = [ Property.outcome: outcome.rawValue ].merging(commonProperties, uniquingKeysWith: { $1 })
+        let properties: [String: Any] = [
+            Property.outcome: outcome.rawValue,
+            Property.entryPoint: (entryPoint ?? .unknown).rawValue
+        ].merging(commonProperties, uniquingKeysWith: { $1 })
 
         WPAppAnalytics.track(.editorSessionEnd, withProperties: properties)
     }
@@ -92,6 +98,7 @@ private extension PostEditorAnalyticsSession {
         static let template = "template"
         static let startupTime = "startup_time_ms"
         static let unstableGalleryWithImageBlocks = "unstable_gallery_with_image_blocks"
+        static let entryPoint = "entry_point"
     }
 
     var commonProperties: [String: String] {

WordPress/Classes/ViewRelated/Post/PostListEditorPresenter.swift

@@ -14,16 +14,16 @@ protocol EditorAnalyticsProperties: AnyObject {
 /// Analytics are also tracked.
 struct PostListEditorPresenter {
 
-    static func handle(post: Post, in postListViewController: EditorPresenterViewController) {
+    static func handle(post: Post, in postListViewController: EditorPresenterViewController, entryPoint: PostEditorEntryPoint = .unknown) {
 
         // Autosaves are ignored for posts with local changes.
         if !post.hasLocalChanges(), post.hasAutosaveRevision, let saveDate = post.dateModified, let autosaveDate = post.autosaveModifiedDate {
             let autosaveViewController = autosaveOptionsViewController(forSaveDate: saveDate, autosaveDate: autosaveDate, didTapOption: { loadAutosaveRevision in
-                openEditor(with: post, loadAutosaveRevision: loadAutosaveRevision, in: postListViewController)
+                openEditor(with: post, loadAutosaveRevision: loadAutosaveRevision, in: postListViewController, entryPoint: entryPoint)
             })
             postListViewController.present(autosaveViewController, animated: true)
         } else {
-            openEditor(with: post, loadAutosaveRevision: false, in: postListViewController)
+            openEditor(with: post, loadAutosaveRevision: false, in: postListViewController, entryPoint: entryPoint)
         }
     }
 
@@ -46,11 +46,11 @@ struct PostListEditorPresenter {
         }
     }
 
-    private static func openEditor(with post: Post, loadAutosaveRevision: Bool, in postListViewController: EditorPresenterViewController) {
+    private static func openEditor(with post: Post, loadAutosaveRevision: Bool, in postListViewController: EditorPresenterViewController, entryPoint: PostEditorEntryPoint = .unknown) {
         let editor = EditPostViewController(post: post, loadAutosaveRevision: loadAutosaveRevision)
         editor.modalPresentationStyle = .fullScreen
+        editor.entryPoint = entryPoint
         postListViewController.present(editor, animated: false)
-        WPAppAnalytics.track(.postListEditAction, withProperties: postListViewController.propertiesForAnalytics(), with: post)
     }
 
     private static func openEditorWithCopy(with post: Post, in postListViewController: EditorPresenterViewController) {
@@ -65,6 +65,7 @@ struct PostListEditorPresenter {
         // Open Editor
         let editor = EditPostViewController(post: newPost, loadAutosaveRevision: false)
         editor.modalPresentationStyle = .fullScreen
+        editor.entryPoint = .postsList
         postListViewController.present(editor, animated: false)
         // Track Analytics event
         WPAppAnalytics.track(.postListDuplicateAction, withProperties: postListViewController.propertiesForAnalytics(), with: post)

WordPress/Classes/ViewRelated/Post/PostListViewController.swift

@@ -563,6 +563,7 @@ class PostListViewController: AbstractPostListViewController, UIViewControllerRe
     override func createPost() {
         let editor = EditPostViewController(blog: blog)
         editor.modalPresentationStyle = .fullScreen
+        editor.entryPoint = .postsList
         present(editor, animated: false, completion: nil)
         WPAppAnalytics.track(.editorCreatedPost, withProperties: [WPAppAnalyticsKeyTapSource: "posts_view", WPAppAnalyticsKeyPostType: "post"], with: blog)
     }
@@ -576,7 +577,8 @@ class PostListViewController: AbstractPostListViewController, UIViewControllerRe
             return
         }
 
-        PostListEditorPresenter.handle(post: post, in: self)
+        WPAppAnalytics.track(.postListEditAction, withProperties: propertiesForAnalytics(), with: post)
+        PostListEditorPresenter.handle(post: post, in: self, entryPoint: .postsList)
     }
 
     private func editDuplicatePost(apost: AbstractPost) {