Skip to content
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.

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

Adds more tracking to the reader, comments, and notifications #17558

Merged
merged 14 commits into from
Nov 30, 2021

Conversation

emilylaguna
Copy link
Contributor

Project: #17503

Description

Adds new tracking to the Reader, Comments, and Notifications:

Reader

  • When the user clears their search history
  • Tracks the source and type when performing a search
  • Removed a duplicated event when toggling the follow notifications
  • When tapping on a link and image on the reader detail

Comments

  • When entering or exiting fullscreen in the comment reply field

Notifications

  • When tapping the up and down arrows on the notifications view

To test:

Reader Search

  1. Launch the app
  2. Tap the Reader tab
  3. Tap the Search icon in the top corner of the view
  4. Perform a search, and verify you see: 🔵 Tracked: reader_search_performed <source: user_input, type: posts>
  5. Tap on the Sites tab
  6. Perform a search, and verify you see: 🔵 Tracked: reader_search_performed <source: user_input, type: sites>
  7. Clear the search text
  8. Tap on an item from your search history, and verify you see: 🔵 Tracked: reader_search_performed <source: search_history, type: posts>
  9. Tap on the search field again
  10. Tap the 'Clear search history' button, and verify you see: 🔵 Tracked: reader_search_history_cleared <subscription_count: COUNT>

Reader Toggle Follow

  1. Launch the app
  2. Tap the Reader tab
  3. Locate an item in the feed
  4. Tap the more ⠇ button
  5. Tap the 'Turn on site notifications' button
  6. Verify you see only 1 🔵 Tracked: followed_blog_notifications_reader_menu_on <blogId: BLOG_ID, subscription_count: COUNT>
  7. Toggle the option off and verify you see only 1 🔵 Tracked: followed_blog_notifications_reader_menu_off <blogId: BLOG_ID, subscription_count: COUNT>

Comments

  1. Launch the app
  2. Tap the Reader tab
  3. Tap the comment button to compose a comment
  4. Tap the up arrow, and verify you see: 🔵 Tracked: comment_fullscreen_entered <>
  5. Tap the down arrow and verify you see 🔵 Tracked: comment_fullscreen_exited <>

Notifications

  1. Launch the app
  2. Tap the Notifications tab
  3. Tap on an item to view the details
  4. Tap the down arrow and verify you see 🔵 Tracked: notifications_previous_tapped <>
  5. Tap the up arrow and verify you see 🔵 Tracked: notifications_next_tapped <>

To me it feels a little weird that the down arrow is previous and up is next, this matches the naming in code.

Regression Notes

  1. Potential unintended areas of impact
    None, adding tracking.

  2. What I did to test those areas of impact (or what existing automated tests I relied on)
    Manual testing

  3. What automated tests I added (or what prevented me from doing so)
    None.

PR submission checklist:

  • I have completed the Regression Notes.
  • I have considered adding unit tests for my changes.
  • I have considered adding accessibility improvements for my changes.
  • I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

@peril-wordpress-mobile
Copy link

peril-wordpress-mobile bot commented Nov 24, 2021

You can trigger an installable build for these changes by visiting CircleCI here.

@peril-wordpress-mobile
Copy link

peril-wordpress-mobile bot commented Nov 24, 2021

You can trigger optional UI/connected tests for these changes by visiting CircleCI here.

Copy link
Contributor

@frosty frosty left a comment

Choose a reason for hiding this comment

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

Tap the 'Turn on site notifications' button

It took me a while to find a post that had this option, and I'm not sure why!

PR looks good! Just one small code comment!

Comment on lines 32 to 42
private enum SearchSource {
case userInput
case searchHistory

var value: String {
switch self {
case .userInput: return "user_input"
case .searchHistory: return "search_history"
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Could this be simplified a little to:

private enum SearchSource: String {
    case userInput = "user_input"
    case searchHistory = "search_history"
}

and then use rawValue where we were using value?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a way better idea than what I had. Updated the code: 035d8dc

@mokagio
Copy link
Contributor

mokagio commented Nov 28, 2021

@emilylaguna I'm going to bump this to the next release because we'll be code freezing 18.8 today and this hasn't been approved yet. @frosty basically said this is good to go, but there are also conflicts against develop.

If this cannot wait two weeks and it's important that it makes it into this release, let me know and we'll organize a new beta once ready.

@mokagio mokagio modified the milestones: 18.8, 18.9 Nov 28, 2021
@emilylaguna emilylaguna requested a review from frosty November 29, 2021 15:10
Copy link
Contributor

@frosty frosty left a comment

Choose a reason for hiding this comment

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

:shipit:

@emilylaguna emilylaguna merged commit b78e08b into develop Nov 30, 2021
@emilylaguna emilylaguna deleted the issue/17503-add-reader-tracking branch November 30, 2021 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants