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

Launchpad: verifying email sends appropriate launchpad track event #41624

Conversation

p-jackson
Copy link
Member

@p-jackson p-jackson commented Feb 7, 2025

Fixes Automattic/wp-calypso#99456

Proposed changes:

Other tasks record a wpcom_launchpad_mark_task_complete event when
a task is detected as completed. Nothing is recording this for email
verification though. We should record an event for this just like
every other task.

WPCOM fires a wpcom_email_verification_complete action when the
user verifies. We hook into that action here in Jetpack.

Email verification links send users to signup.wordpress.com not
public-api.wordpress.com. So it must use a different authentication
mechanism which is why I'm not trusting the wp_get_current_user()
function call like the other tracks events do. Using the user ID
from the action parameter is how other action handlers in WPCOM do
it too. See this example 36e9b-pb

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?

Tracking email verification task is the same sort of data we already track for other tasks. No changes
to our existing data usage.

Testing instructions:

  • Apply this PR to your sandbox
  • Sandbox signup.wordpress.com
  • Create a new user
  • Copy the verification link sent to your inbox
  • Use this JavaScript snippet to extract the redirect_to URL out of the link
    • new URLSearchParams(new URL(' ... ').search).get('redirect_to') (substituting the link for the ...)
  • Use your Tracks Live View and wait 10m for your event to appear. Filter by your new user's id and the wpcom_launchpad_mark_task_complete event
    • Alternatively you can add some logging to the line which records the track event

Other tasks record a `wpcom_launchpad_mark_task_complete` event when
a task is detected as completed. Nothing is recording this for email
verification though. We should record an event for this just like
every other task.

WPCOM fires a `wpcom_email_verification_complete` action when the
user verifies.

Email verification links send users to `signup.wordpress.com` not
`public-api.wordpress.com`. So it must use a different authentication
mechanism which is why I'm not trusting the `wp_get_current_user()`
function call like the other tracks events do. Using the user ID
from the action parameter is how other action handlers in WPCOM do
it too.
@p-jackson p-jackson self-assigned this Feb 7, 2025
Copy link
Contributor

github-actions bot commented Feb 7, 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 WordPress.com Simple 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, and enable the update/send-wpcom_launchpad_mark_task_complete-when-email-verified branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/send-wpcom_launchpad_mark_task_complete-when-email-verified
    

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

@p-jackson p-jackson added the [Type] Bug When a feature is broken and / or not performing as intended label Feb 7, 2025
@p-jackson p-jackson requested a review from a team February 7, 2025 06:42
Copy link
Contributor

github-actions bot commented Feb 7, 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 Team 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 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Feb 7, 2025
Copy link
Contributor

github-actions bot commented Feb 7, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/features/launchpad/launchpad-task-definitions.php 654/1506 (43.43%) -0.14% 5 💔

Full summary · PHP report · JS report

@p-jackson p-jackson added the Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. label Feb 7, 2025
Copy link
Contributor

@vykes-mac vykes-mac left a comment

Choose a reason for hiding this comment

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

Event recorded great!!

image

@p-jackson p-jackson merged commit a551f52 into trunk Feb 9, 2025
70 of 71 checks passed
@p-jackson p-jackson deleted the update/send-wpcom_launchpad_mark_task_complete-when-email-verified branch February 9, 2025 21:40
@github-actions github-actions bot removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review labels Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[mu wpcom Feature] Launchpad [Package] Jetpack mu wpcom WordPress.com Features Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Task: Verifying email is not sending the appropriate launchpad tracks event
2 participants