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

Search: fix Tracks value that is causing event to be rejected #38394

Merged
merged 3 commits into from
Jul 18, 2024

Conversation

IanRamosC
Copy link
Contributor

Context: pbmo2S-2Eb-p2#comment-3225

Proposed changes:

  • This PR fixes a Tracks event that was trying to store a JSON-encoded string as value, but it was causing the event to be rejected (since it doesn't match the allowed pattern)

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

pbmo2S-2Eb-p2#comment-3225

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

No

Testing instructions:

N/a

@IanRamosC IanRamosC self-assigned this Jul 17, 2024
Copy link
Contributor

github-actions bot commented Jul 17, 2024

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 fix/jetpack_search_customberg-events branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/jetpack_search_customberg-events
    

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 [Package] Search Contains core Search functionality for Jetpack and Search plugins [Status] In Progress labels Jul 17, 2024
Copy link
Contributor

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 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

@IanRamosC IanRamosC marked this pull request as ready for review July 17, 2024 21:09
@IanRamosC IanRamosC requested review from jsnmoon, aaronyan and a team July 17, 2024 21:09
Copy link
Member

@aaronyan aaronyan left a comment

Choose a reason for hiding this comment

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

LGTM! Consider adding a new Tracks event in the future that maps what settings have been changed. It could be something like:

jetpack_search_customberg_setting_changed with eventprops:

  • setting_name: <string>
  • setting_value: <string>

which fires for every setting that has been changed.

@IanRamosC IanRamosC merged commit 3a1eb8b into trunk Jul 18, 2024
59 checks passed
@IanRamosC IanRamosC deleted the fix/jetpack_search_customberg-events branch July 18, 2024 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Search Contains core Search functionality for Jetpack and Search plugins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants