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] Add woocomerceanalytics_session #41085

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

Conversation

puntope
Copy link
Contributor

@puntope puntope commented Jan 15, 2025

Fixes and issue with the way we set the cookie for storing woocomerceanalytics_session that created cache issues.

In this PR we do set the cookie using JS to avoid those cache misses.

Proposed changes:

  • Set the woocomerceanalytics_session using JS

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?

Testing instructions:

  • Set up a Jurassic Ninja site using the code in this PR for WooCommerce Analytics
  • Verify the cache by hitting different pages with curl -I
  • When running it the second time you should see something like:
Screenshot 2025-01-15 at 13 50 25

See how it was before when the set cookie was set in PHP headers

Screenshot 2025-01-14 at 17 03 59
  • Close all the incognito windows and open a new one, navigate to a Product (or perform any other event like going to checkout or cart)
  • See session_started event is triggered and also the event contains session_id
  • Create more events, see they have session_id and landfing_page in the props.
  • Tests edge cases, like Empty carts or going to checkout when cart is empty.

Note:

Mybe you want to quickly push the plugin to a live JN site without waiting for the builds. This rsync wrapper knows which files to send and not send.

Rsync the Jetpack plugin to server destination:

jetpack rsync jetpack [email protected]:/home/path/to/wp-content/plugins

Find the command in your JN site

Screenshot 2025-01-15 at 15 07 09

Notice also that for track to happen USage TRcking should be enabled in WoCommerce -> Settings -> Advanced -> WooCommerce.com -> "Allow usage tracking"

Also JP (or WPCOM) should be connected

@puntope puntope requested review from ianlin and mikkamp January 15, 2025 12:58
@puntope puntope self-assigned this Jan 15, 2025
Copy link
Contributor

github-actions bot commented Jan 15, 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 Jan 15, 2025
Copy link
Contributor

github-actions bot commented Jan 15, 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 tweak/analytics_session_id branch.

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

    bin/jetpack-downloader test jetpack tweak/analytics_session_id
    

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

@puntope puntope added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Team Review labels Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] WooCommerce Analytics [Package] WooCommerce Analytics Enhanced analytics for WooCommerce users [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 [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.

1 participant