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

wpcomsh: bilmur: Add site timezone to tag #41964

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

Conversation

mreishus
Copy link
Contributor

@mreishus mreishus commented Feb 21, 2025

Fixes #

Proposed changes:

  • Updates the Bilmur Real User Monitoring (RUM) library to include the site’s timezone.
  • Adds a new function wpcomsh_stats_timezone_string() to standardize timezone output (e.g., converts +05:30 to Asia/Kolkata or Etc/GMT+5).
  • Injects the timezone as a data-site-tz attribute in the Bilmur <script> tag.

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?

Yes, this PR adds the site’s timezone to the data sent to Bilmur for performance tracking. This could indirectly reveal location info (e.g., America/New_York), but it’s site-level, not user-level data.

Testing instructions:

  • Make a WoA dev site, download Jetpack Beta, install it and switch wpcom site helper to this branch as explained in the comment below
  • Open the site in a browser and inspect the page source (Ctrl+U or right-click > View Source).
  • Look for the <script id="bilmur" ...> tag in the footer.
  • Check that it includes a data-site-tz attribute (e.g., data-site-tz="Etc/GMT+0" or a city like Asia/Kolkata).
  • Change the site’s timezone in WordPress (Settings > General > Timezone) to something else (e.g., UTC+5:30 or New York), reload, and verify the data-site-tz updates accordingly.

Copy link
Contributor

github-actions bot commented Feb 21, 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 WoA dev 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 (WordPress.com Site Helper), and enable the update/wpcomsh-bilmur-tz branch.

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

Copy link
Contributor

github-actions bot commented Feb 21, 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!


Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

@github-actions github-actions bot added [Plugin] Wpcomsh [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 21, 2025
@mreishus mreishus self-assigned this Feb 21, 2025
Copy link

jp-launch-control bot commented Feb 21, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/plugins/wpcomsh/wpcomsh.php 83/313 (26.52%) 2.77% 2 ❤️‍🩹

Full summary · PHP report

@mreishus mreishus force-pushed the update/wpcomsh-bilmur-tz branch from c93b3c7 to 16b66b8 Compare February 21, 2025 20:51
@mreishus mreishus added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Feb 21, 2025
@mreishus mreishus added the [Status] Needs Privacy Updates Our support docs will need to be updated to take this change into account label Feb 21, 2025
@mreishus mreishus added the I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. label Feb 21, 2025
@mreishus mreishus removed the I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. label Feb 21, 2025
@mreishus mreishus added [Status] Needs Review A Jetpack Crew expert's review is needed. Typically for significant changes to core functionality. and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 21, 2025
@mreishus
Copy link
Contributor Author

mreishus commented Feb 21, 2025

Tested on a WoA dev site:

<script defer id="bilmur" data-customproperties="{&quot;woo_active&quot;:&quot;0&quot;}" data-provider="wordpress.com" data-service="atomic"  src="https://s0.wp.com/wp-content/js/bilmur.min.js?m=202508" data-site-tz="America/Chicago"></script>

@mreishus mreishus added [Status] Needs Team Review Your teammate needs to review this PR. and removed [Status] Needs Review A Jetpack Crew expert's review is needed. Typically for significant changes to core functionality. labels Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Wpcomsh [Status] Needs Privacy Updates Our support docs will need to be updated to take this change into account [Status] Needs Team Review Your teammate needs to review this PR. [Tests] Includes Tests [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant