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

Odyssey Stats widget: Only load stats script when widget is visible #34284

Merged
merged 5 commits into from
Nov 23, 2023

Conversation

kangzj
Copy link
Contributor

@kangzj kangzj commented Nov 23, 2023

Fixes https://github.com/Automattic/jpop-issues/issues/8700

Proposed changes:

  • Only load script when the Stats widget is visible
  • As the widget is always rendered by the dashboard, it's not possible to load data easily when it's toggled visible. So we added a notice saying 'Please reload the page to see your Stats.'.

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

n/a

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

no

Testing instructions:

  • Go to you local test instance with Stats module enabled
  • Open /wp-admin/
  • Click 'Screen Options' on the top right of the page
  • Uncheck Jetpack Stats
  • Refresh
  • Inspect network requests
  • Ensure there are no stats requests described in https://github.com/Automattic/jpop-issues/issues/8700
  • Click 'Screen Options' on the top right of the page
  • Check Jetpack Stats
  • Ensure you see 'Please reload the page to see your Stats.'
  • Refresh
  • Ensure you see the widget working properly
image image

@kangzj kangzj added [Feature] Stats Data Feature that enables users to track their site's traffic and gain insights on popular content. [Package] Stats Admin labels Nov 23, 2023
@kangzj kangzj requested review from anomiex and a team November 23, 2023 21:57
@kangzj kangzj self-assigned this Nov 23, 2023
@kangzj kangzj marked this pull request as ready for review November 23, 2023 21:57
Copy link
Contributor

github-actions bot commented Nov 23, 2023

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/only-load-stats-data-when-widget-is-visible branch.

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

    bin/jetpack-downloader test jetpack fix/only-load-stats-data-when-widget-is-visible
    

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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Nov 23, 2023
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.


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 December 5, 2023 (scheduled code freeze on November 28, 2023).

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

Copy link
Contributor

@oskosk oskosk left a comment

Choose a reason for hiding this comment

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

Tests great!

@oskosk oskosk merged commit e9e7460 into trunk Nov 23, 2023
53 checks passed
@oskosk oskosk deleted the fix/only-load-stats-data-when-widget-is-visible branch November 23, 2023 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Stats Data Feature that enables users to track their site's traffic and gain insights on popular content. [Package] Stats Admin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants