Skip to content

Jetpack Focus: Add analytics tracking for the Jetpack menu card #19786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 20, 2022
Merged

Jetpack Focus: Add analytics tracking for the Jetpack menu card #19786

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c6ef080
Add: define jetpack menu card events
hassaanelgarem Dec 16, 2022
62dbf50
Add: trigger analytics events
hassaanelgarem Dec 16, 2022
8f6f579
Update: rename analytics events
hassaanelgarem Dec 16, 2022
12535f4
Add: tracking for accessing the contextual menu
hassaanelgarem Dec 16, 2022
c25f938
Update: rename events
hassaanelgarem Dec 16, 2022
d7874d4
Merge branch 'task/19450-phase-3-card-actions' into task/19450-phase-…
hassaanelgarem Dec 19, 2022
9dc4c28
Update: Retrieve phase when needed instead of initializing it in the …
hassaanelgarem Dec 19, 2022
5baf666
Merge branch 'task/19450-phase-3-card-actions' into task/19450-phase-…
hassaanelgarem Dec 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions WordPress/Classes/Utility/Analytics/WPAnalyticsEvent.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,12 @@ import Foundation
case jetpackSiteCreationOverlayDisplayed
case jetpackSiteCreationOverlayButtonTapped
case jetpackSiteCreationOverlayDismissed
case jetpackBrandingMenuCardDisplayed
case jetpackBrandingMenuCardTapped
case jetpackBrandingMenuCardLinkTapped
case jetpackBrandingMenuCardHidden
case jetpackBrandingMenuCardRemindLater
case jetpackBrandingMenuCardContextualMenuAccessed

/// A String that represents the event
var value: String {
Expand Down Expand Up @@ -1123,6 +1129,18 @@ import Foundation
return "remove_site_creation_overlay_button_tapped"
case .jetpackSiteCreationOverlayDismissed:
return "remove_site_creation_overlay_dismissed"
case .jetpackBrandingMenuCardDisplayed:
return "remove_feature_card_displayed"
case .jetpackBrandingMenuCardTapped:
return "remove_feature_card_tapped"
case .jetpackBrandingMenuCardLinkTapped:
return "remove_feature_card_link_tapped"
case .jetpackBrandingMenuCardHidden:
return "remove_feature_card_hide_tapped"
case .jetpackBrandingMenuCardRemindLater:
return "remove_feature_card_remind_later_tapped"
case .jetpackBrandingMenuCardContextualMenuAccessed:
return "remove_feature_card_menu_accessed"

} // END OF SWITCH
}
Expand Down
2 changes: 2 additions & 0 deletions ...elated/Jetpack/Branding/Menu Card/BlogDetailsViewController+JetpackBrandingMenuCard.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ extension BlogDetailsViewController {
@objc func jetpackCardSectionViewModel() -> BlogDetailsSection {
let row = BlogDetailsRow()
row.callback = {
let presenter = JetpackBrandingMenuCardPresenter()
JetpackFeaturesRemovalCoordinator.presentOverlayIfNeeded(from: .card, in: self)
presenter.trackCardTapped()
}

let section = BlogDetailsSection(title: nil,
Expand Down
11 changes: 5 additions & 6 deletions WordPress/Classes/ViewRelated/Jetpack/Branding/Menu Card/JetpackBrandingMenuCardCell.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ class JetpackBrandingMenuCardCell: UITableViewCell {
frameView.configureButtonContainerStackView()
frameView.hideHeader()

frameView.onEllipsisButtonTap = {
// TODO: Track menu shown
frameView.onEllipsisButtonTap = { [weak self] in
self?.presenter.trackContexualMenuAccessed()
}
frameView.ellipsisButton.showsMenuAsPrimaryAction = true
frameView.ellipsisButton.menu = contextMenu
Expand Down Expand Up @@ -134,7 +134,8 @@ class JetpackBrandingMenuCardCell: UITableViewCell {
private func commonInit() {
setupViews()
setupContent()
// TODO: Track card shown

presenter.trackCardShown()
}

// MARK: Helpers
Expand Down Expand Up @@ -164,7 +165,7 @@ class JetpackBrandingMenuCardCell: UITableViewCell {
let webViewController = WebViewControllerFactory.controller(url: url, source: Constants.analyticsSource)
let navController = UINavigationController(rootViewController: webViewController)
viewController?.present(navController, animated: true)
// TODO: Track button tapped
presenter.trackLinkTapped()
}
}

Expand All @@ -191,13 +192,11 @@ private extension JetpackBrandingMenuCardCell {
private func remindMeLaterTapped() {
presenter.remindLaterTapped()
viewController?.reloadTableView()
// TODO: Track button tapped
}

private func hideThisTapped() {
presenter.hideThisTapped()
viewController?.reloadTableView()
// TODO: Track button tapped
}
}

Expand Down
41 changes: 38 additions & 3 deletions ...ess/Classes/ViewRelated/Jetpack/Branding/Menu Card/JetpackBrandingMenuCardPresenter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ class JetpackBrandingMenuCardPresenter {

private let remoteConfigStore: RemoteConfigStore
private let persistenceStore: UserPersistentRepository
private let featureFlagStore: RemoteFeatureFlagStore
private let currentDateProvider: CurrentDateProvider
private let phase: JetpackFeaturesRemovalCoordinator.GeneralPhase
Copy link
Contributor

@momo-ozawa momo-ozawa Dec 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The unit tests for this class are failing because the phase doesn't get updated when you do remoteFeatureFlagsStore.removalPhaseX = true

Copy link
Contributor Author

@hassaanelgarem hassaanelgarem Dec 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that I think about this, other than the tests, if the phase changes, we'll have to refresh the presenter to carry the correct value. So given that, I think it's best to revert this change altogether.

Copy link
Contributor Author

@hassaanelgarem hassaanelgarem Dec 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 9dc4c28
Let me know what you think!

Copy link
Contributor

@momo-ozawa momo-ozawa Dec 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So given that, I think it's best to revert this change altogether.

Agreed!


// MARK: Initializers

Expand All @@ -21,15 +21,14 @@ class JetpackBrandingMenuCardPresenter {
persistenceStore: UserPersistentRepository = UserDefaults.standard,
currentDateProvider: CurrentDateProvider = DefaultCurrentDateProvider()) {
self.remoteConfigStore = remoteConfigStore
self.featureFlagStore = featureFlagStore
self.persistenceStore = persistenceStore
self.currentDateProvider = currentDateProvider
self.phase = JetpackFeaturesRemovalCoordinator.generalPhase(featureFlagStore: featureFlagStore)
}

// MARK: Public Functions

func cardConfig() -> Config? {
let phase = JetpackFeaturesRemovalCoordinator.generalPhase(featureFlagStore: featureFlagStore)
switch phase {
case .three:
let description = Strings.phaseThreeDescription
Expand All @@ -55,10 +54,45 @@ class JetpackBrandingMenuCardPresenter {
let duration = Constants.remindLaterDurationInDays * Constants.secondsInDay
let newDate = now.addingTimeInterval(TimeInterval(duration))
showCardOnDate = newDate
trackRemindMeLaterTapped()
}

func hideThisTapped() {
shouldHideCard = true
trackHideThisTapped()
}
}

// MARK: Analytics

extension JetpackBrandingMenuCardPresenter {

func trackCardShown() {
WPAnalytics.track(.jetpackBrandingMenuCardDisplayed, properties: analyticsProperties)
}

func trackLinkTapped() {
WPAnalytics.track(.jetpackBrandingMenuCardLinkTapped, properties: analyticsProperties)
}

func trackCardTapped() {
WPAnalytics.track(.jetpackBrandingMenuCardTapped, properties: analyticsProperties)
}

func trackContexualMenuAccessed() {
WPAnalytics.track(.jetpackBrandingMenuCardContextualMenuAccessed, properties: analyticsProperties)
}

func trackHideThisTapped() {
WPAnalytics.track(.jetpackBrandingMenuCardHidden, properties: analyticsProperties)
}

func trackRemindMeLaterTapped() {
WPAnalytics.track(.jetpackBrandingMenuCardRemindLater, properties: analyticsProperties)
}

private var analyticsProperties: [String: String] {
[Constants.phaseAnalyticsKey: phase.rawValue]
}
}

Expand Down Expand Up @@ -90,6 +124,7 @@ private extension JetpackBrandingMenuCardPresenter {
static let remindLaterDurationInDays = 7
static let shouldHideCardKey = "JetpackBrandingShouldHideCardKey"
static let showCardOnDateKey = "JetpackBrandingShowCardOnDateKey"
static let phaseAnalyticsKey = "phase"
}

enum Strings {
Expand Down