feat(analytics): append tag name(s) as value to tag events in Save ex…

…tension
Pocket · Apr 26, 2023 · 12fb233 · 12fb233
1 parent 3c937c3
commit 12fb233
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 14 deletions.
diff --git a/PocketKit/Sources/Analytics/AppEvents/SaveTo.swift b/PocketKit/Sources/Analytics/AppEvents/SaveTo.swift
@@ -63,9 +63,13 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user adds tag to an input list in the `Add Tags` screen for an item
-    static func addTag(itemUrl: URL) -> Event {
+    /// - Parameters:
+    ///     - tag: The tag added to an item.
+    ///     - itemUrl: The url of the item to which a new tag was added.
+    static func addTag(_ tag: String, itemUrl: URL) -> Event {
         return Engagement(
             .general,
+            value: tag,
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.addTags.addTag"
@@ -79,9 +83,13 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when user taps on a tag name and removes it from the list of input tags in `Add Tags` screen for an item
-    static func remoteInputTag(itemUrl: URL) -> Event {
+    /// - Parameters:
+    ///     - tag: The tag that was removed from the list of input tags.
+    ///     - itemUrl: The url of the item to which a tag was removed.
+    static func removeInputTag(_ tag: String, itemUrl: URL) -> Event {
         return Engagement(
             .general,
+            value: tag,
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.addTags.removeInputTag"
@@ -154,9 +162,12 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user taps on a general tag from `Add Tags` screen
-    static func selectTagToAddToItem() -> Event {
+    /// - Parameters:
+    ///     - tag: The tag selected to add to an item.
+    static func selectTagToAddToItem(_ tag: String) -> Event {
         return Engagement(
             .general,
+            value: tag,
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.addTags.selectTag"
@@ -165,9 +176,12 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user taps on a recent tag from `Add Tags` screen
-    static func selectRecentTagToAddToItem() -> Event {
+    /// - Parameters:
+    ///     - tag: The recent tag selected to add to an item.
+    static func selectRecentTagToAddToItem(_ tag: String) -> Event {
         return Engagement(
             .general,
+            value: tag,
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.addTags.selectRecentTag"
@@ -176,9 +190,12 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user selects on a general tag using the `Tags` screen after tapping on `Tagged` filter
-    static func selectTagToFilter() -> Event {
+    /// - Parameters:
+    ///     - tag: The tag that was selected as the filter.
+    static func selectTagToFilter(_ tag: String) -> Event {
         return Engagement(
             .general,
+            value: tag,
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.filterTags.selectTag"
@@ -198,9 +215,12 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user selects on a recent tag using the `Tags` screen after tapping on `Tagged` filter
-    static func selectRecentTagToFilter() -> Event {
+    /// - Parameters:
+    ///     - tag: The recent tag that was selected as the filter.
+    static func selectRecentTagToFilter(_ tag: String) -> Event {
         return Engagement(
             .general,
+            value: tag,
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.filterTags.selectRecentTag"
@@ -209,9 +229,13 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user adds tag to an input list in the `Add Tags` screen for an item
-    static func renameTag() -> Event {
+    /// - Parameters:
+    ///     - from: The previous name of the tag before rename.
+    ///     - to: The new name of the tag after rename.
+    static func renameTag(from oldTag: String, to newTag: String) -> Event {
         return Engagement(
             .general,
+            value: [oldTag, newTag].joined(separator: ","),
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.filterTags.tagRename"
@@ -220,9 +244,12 @@ public extension Events.SaveTo.Tags {
     }
 
     /// Fired when a user confirms to delete tags from 'Tags' screen after tapping on `Tagged` filter
-    static func deleteTags() -> Event {
+    /// - Parameters:
+    ///     - tags: An array of tags that were deleted; used to generate a comma-separated string as a value.
+    static func deleteTags(_ tags: [String]) -> Event {
         return Engagement(
             .general,
+            value: tags.joined(separator: ","),
             uiEntity: UiEntity(
                 .button,
                 identifier: "save-extension.filterTags.tagsDelete"

diff --git a/PocketKit/Sources/SaveToPocketKit/SaveToAddTagsViewModel.swift b/PocketKit/Sources/SaveToPocketKit/SaveToAddTagsViewModel.swift
@@ -105,20 +105,20 @@ extension SaveToAddTagsViewModel {
         tracker.track(event: Events.SaveTo.Tags.saveTags(itemUrl: url))
     }
 
-    func trackAddTag() {
+    func trackAddTag(_ tag: String) {
         guard let url = item?.url else {
             Log.capture(message: "Adding tags to an item without an associated url, not logging analytics for Tags.addTag")
             return
         }
-        tracker.track(event: Events.SaveTo.Tags.addTag(itemUrl: url))
+        tracker.track(event: Events.SaveTo.Tags.addTag(tag, itemUrl: url))
     }
 
-    func trackRemoveTag() {
+    func trackRemoveTag(_ tag: String) {
         guard let url = item?.url else {
             Log.capture(message: "Adding tags to an item without an associated url, not logging analytics for Tags.remoteInputTag")
             return
         }
-        tracker.track(event: Events.SaveTo.Tags.remoteInputTag(itemUrl: url))
+        tracker.track(event: Events.SaveTo.Tags.removeInputTag(tag, itemUrl: url))
     }
 
     func trackUserEnterText(with text: String) {
@@ -150,9 +150,9 @@ extension SaveToAddTagsViewModel {
         case .notTagged:
             return
         case .recent:
-            tracker.track(event: Events.SaveTo.Tags.selectRecentTagToAddToItem())
+            tracker.track(event: Events.SaveTo.Tags.selectRecentTagToAddToItem(tagType.name))
         case .tag:
-            tracker.track(event: Events.SaveTo.Tags.selectTagToAddToItem())
+            tracker.track(event: Events.SaveTo.Tags.selectTagToAddToItem(tagType.name))
         }
     }
 }