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

Google Analytics: extract API into the package #37358

Merged
merged 18 commits into from
Jun 19, 2024

Conversation

sergeymitr
Copy link
Contributor

@sergeymitr sergeymitr commented May 13, 2024

Proposed changes:

  • Move Google Analytics API code from Jetpack into the package.
  • Add the is_active flag to indicate whether GA is active (currently module activation status is used).
  • Modify the Status package to check activation status of an unavailable module to ease transition to settings when GA module gets removed from Jetpack.

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

pfwV0U-4g-p2

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

No.

Testing instructions:

  1. Checkout the branch, connect Jetpack.
  2. If reusing a site, deactivate the Google Analytics feature if enabled. Also please delete the jetpack_wga option from Jetpack site (wp option delete jetpack_wga) if it exists.
  3. Go to "Jetpack -> Settings -> Traffic", purchase the plan.
  4. Go there again and click on "Configure your Google Analytics settings".
  5. In Calypso, scroll down to "Google" card and activate it.
  6. Check jetpack_wga, confirm the setting is_active: true is now stored.
  7. Go to the Jetpack site, find "Modules" section (/wp-admin/admin.php?page=jetpack_modules), and confirm that Google Analytics module is active.
  8. Add a Measurement ID (e.g. G-12345), click "Save". Check jetpack_wga, confirm the Measurement ID and is_active are correct, and other settings show up and valid.
  9. Reload the page, confirm Google Analytics is still active, and Measurement ID is preserved.
  10. Load the site's frontend, check the page source code to confirm the Measurement ID is added to the page.
  11. Deactivate "Add Google". Check jetpack_wga option, confirm is_active: false, and the rest of the settings didn't change.
  12. Visit Jetpack's Modules page, confirm the module got disabled.
  13. Check the frontend and confirm that the measurement ID has now disappeared.
  14. Reload the Calypso page, confirm "Add Google" is still deactivated. Turn it on, confirm Measurement ID is still there.

@sergeymitr sergeymitr added this to the jetpack/13.5 milestone May 13, 2024
@sergeymitr sergeymitr self-assigned this May 13, 2024
Copy link
Contributor

github-actions bot commented May 13, 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 update/move-google-analytics-apis 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 update/move-google-analytics-apis
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/move-google-analytics-apis
    

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] Google Analytics [Feature] WPCOM API [Package] Google Analytics [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels May 13, 2024
Copy link
Contributor

github-actions bot commented May 13, 2024

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.


Jetpack plugin:

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

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for July 2, 2024 (scheduled code freeze on July 1, 2024).

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

@tbradsha tbradsha modified the milestones: jetpack/13.5, jetpack/13.6 Jun 4, 2024
@sergeymitr sergeymitr added [Status] In Progress [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Blocked / Hold [Status] In Progress labels Jun 18, 2024
@sergeymitr sergeymitr requested a review from a team June 19, 2024 15:20
Copy link
Contributor

@monsieur-z monsieur-z left a comment

Choose a reason for hiding this comment

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

I can't offer relevant feedback regarding the code, but every step in the instructions worked as expected.

@sergeymitr sergeymitr merged commit 25eb8fa into trunk Jun 19, 2024
72 checks passed
@sergeymitr sergeymitr deleted the update/move-google-analytics-apis branch June 19, 2024 20:47
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jun 19, 2024
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