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

Newsletter Widget: add Tracks events #42660

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

holdercp
Copy link
Contributor

@holdercp holdercp commented Mar 21, 2025

Closes Automattic/loop#575

Proposed changes:

  • Adds Tracks events for link clicks and when the widget and chart loads so we can better understand how the widget is being used.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

We are adding simple Tracks events for each link in the widget, as well as when it loads.

Testing instructions:

  • Go to wp-admin
  • Interact with the Newsletter Widget by clicking each link
  • Verify you see each corresponding jetpack_newsletter_widget_{action} event in Tracks:
  • jetpack_newsletter_widget_view
  • jetpack_newsletter_widget_all_subscribers_click
  • jetpack_newsletter_widget_paid_subscribers_click
  • jetpack_newsletter_widget_learn_more_click
  • jetpack_newsletter_widget_publish_post_click
  • jetpack_newsletter_widget_view_stats_click
  • jetpack_newsletter_widget_import_subscribers_click
  • jetpack_newsletter_widget_manage_subscribers_click
  • jetpack_newsletter_widget_monetize_click
  • jetpack_newsletter_widget_newsletter_settings_click
  • jetpack_newsletter_widget_chart_view (from the SubscribersChart component)

Copy link
Contributor

github-actions bot commented Mar 21, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the add/tracks-newsletter-widget branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack add/tracks-newsletter-widget

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Mar 21, 2025
Copy link
Contributor

github-actions bot commented Mar 21, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: April 1, 2025
    • Code freeze: March 30, 2025

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Mar 21, 2025
@holdercp holdercp self-assigned this Mar 21, 2025
@holdercp holdercp added [Status] Needs Review This PR is ready for review. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it labels Mar 21, 2025
Copy link

Code Coverage Summary

Coverage changed in 4 files.

File Coverage Δ% Δ Uncovered
projects/plugins/jetpack/modules/subscriptions/newsletter-widget/src/helpers.ts 33/35 (94.29%) -2.59% 1 ❤️‍🩹
projects/plugins/jetpack/modules/subscriptions/newsletter-widget/src/components/newsletter-widget.tsx 8/8 (100.00%) 0.00% 0 💚
projects/plugins/jetpack/modules/subscriptions/newsletter-widget/src/components/subscribers-chart.tsx 19/25 (76.00%) 3.27% 0 💚
projects/plugins/jetpack/modules/subscriptions/newsletter-widget/src/constants.ts 3/3 (100.00%) 0.00% 0 💚

Full summary · PHP report · JS report

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] Needs Review This PR is ready for review. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant