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

WooCommerce Analytics: Initialize the package only if is not loaded in WooCommerce Core #38236

Merged
merged 3 commits into from
Jul 9, 2024

Conversation

puntope
Copy link
Contributor

@puntope puntope commented Jul 8, 2024

Fixes woocommerce/woocommerce#45210
PT: pcShBQ-1Vt-p2

Proposed changes:

  • This PR initializes WooCommerce_Analytics package only if it was not loaded in WooCommerce core

To do that, we created a WC_ANALYTICS constant in the WooCommerce core version when we load the package.
When this constant is present Jetpack will not initialize WooCommerce_Analytics.

This is for maintaining compatibility as it might happen that JEtpack gets updated but WooCommerce does not and vice versa.

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

PT: pcShBQ-1Vt-p2

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

Added ✅

Testing instructions:

  • Connect Jetpack and install WooCommerce
  • Go to the shop as guest (or not an admin), add a product and then go to the cart
  • In the web source you will see <script>window._wca = window._wca || [];</script> script loaded
  • add the constant: define( 'WC_ANALYTICS', true )
  • Go to the shop as guest (or not an admin), add a product and then go to the cart
  • In the web source you won't see <script>window._wca = window._wca || [];</script> script loaded
@puntope puntope requested a review from jeherve July 8, 2024 14:31
@puntope puntope self-assigned this Jul 8, 2024
@puntope puntope added the [Status] Needs Privacy Updates Our support docs will need to be updated to take this change into account label Jul 8, 2024
Copy link
Contributor

github-actions bot commented Jul 8, 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 tweak/load-wc-analytics-core branch.

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

    bin/jetpack-downloader test jetpack tweak/load-wc-analytics-core
    

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 the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jul 8, 2024
Copy link
Contributor

github-actions bot commented Jul 8, 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 August 6, 2024 (scheduled code freeze on August 5, 2024).

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

@puntope puntope requested a review from a team July 8, 2024 14:33
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

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

LGTM!
Not sure if we need the Needs Privacy Updates label here, since we are not tracking any new data, just conditionally tracking the same Woo related data we used to, when WC_ANALYTICS is not present.

@fgiannar fgiannar added the [Status] Ready to Merge Go ahead, you can push that green button! label Jul 9, 2024
@puntope puntope removed the [Status] Needs Privacy Updates Our support docs will need to be updated to take this change into account label Jul 9, 2024
@puntope puntope merged commit dc7e0bf into trunk Jul 9, 2024
56 checks passed
@puntope puntope deleted the tweak/load-wc-analytics-core branch July 9, 2024 13:37
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 9, 2024
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jul 9, 2024
@jenhooks
Copy link

jenhooks commented Jul 9, 2024

@fgiannar - hi! And thanks for the privacy flag on this, @puntope. Can y'all do a quick check of the privacy section in this doc https://jetpack.com/support/privacy/woocommerce-analytics/#privacy and let me know if any verbiage needs to be added or changed? Sometimes, when a change is needed, it might just mean making the existing language a little more inclusive or wider-scoped.

@puntope
Copy link
Contributor Author

puntope commented Jul 11, 2024

Howdy @jenhooks thanks for being proactive on this.

Not sure if that needs to be changed but I can summarize what it changed so it can clarify if it should:

Now WooCommerce Analytics is activated in these scenarios:

User still uses an old version of WooCommerce or Jetpack that doesn't load the WooCommerce Analytics package via WooCommerce.

--> In this case, the package is still loaded as always using Jetpack

User uses a new version of Jetpack and WooCommerce and the package is loaded in WooCommerce

1.. woocommerce_analytics_allow_tracking filter is true (by default false) This requirement is coming from Beau. And is still discussed how we do allow this to be true. Maybe with an extra opt-in check or some integration with WP Consent API (notice this package tracks customer info not just store admin info as WC Tracks does)

  1. Jetpack should be activated and also connected to Wordpress.com (this might change soon, is still being discussed but likely we just require Wordpress.com connection without Jetpack plugin activation needed)

For now, I wouldn't change anything yet. In the PT pcShBQ-1Vt-p2 we have a task for discussing with privacy team once everything is discussed.

BTW. This claim is not correct on the page you mention

The WooCommerce Analytics module is activated by default when both the Jetpack and WooCommerce plugins are activated

Jetpack should be activated and also connected to Wordpress.com if it is just activated it doesn't track.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
3 participants