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

Stats: Fix stats setting role toggles not sticking #40853

Merged
merged 5 commits into from
Jan 6, 2025

Conversation

kangzj
Copy link
Contributor

@kangzj kangzj commented Jan 6, 2025

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

Proposed changes:

  • Calling setState in the constructor of a React class component does not work because the component is not yet mounted, and React explicitly prevents the use of setState during this phase. Instead, we should directly assign values to this.state in the constructor.

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:

  • Create custom roles with code running in a mu plugin
function add_custom_user_role() {
    add_role(
        'content_manager',
        'Content Manager',
        array(
            'read' => true,
            'edit_posts' => true,
            'delete_posts' => true,
            'publish_posts' => true,
            'upload_files' => true,
        )
    );
}
add_action('init', 'add_custom_user_role');
  • Open /wp-admin/admin.php?page=jetpack#/traffic
  • Expand Jetpack Stats section
  • Toggle Content Manager for Count logged in page views from and Allow Jetpack Stats to be viewed by
  • Refresh page
  • Ensure the option sticks
  • Toggle off
  • Refresh page
  • Ensure the option sticks
image

@kangzj kangzj added the [Feature] Stats Data Feature that enables users to track their site's traffic and gain insights on popular content. label Jan 6, 2025
@kangzj kangzj requested review from dognose24 and a team January 6, 2025 01:51
@kangzj kangzj self-assigned this Jan 6, 2025
@kangzj kangzj added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Team Review labels Jan 6, 2025
Copy link
Contributor

github-actions bot commented Jan 6, 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 fix/stats-setting-role-toggles branch.

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

    bin/jetpack-downloader test jetpack fix/stats-setting-role-toggles
    

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/ Admin Page React-powered dashboard under the Jetpack menu labels Jan 6, 2025
Copy link
Contributor

github-actions bot commented Jan 6, 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!


Jetpack plugin:

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

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for January 7, 2025 (scheduled code freeze on undefined).

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

@kangzj kangzj added this to the jetpack/14.2 milestone Jan 6, 2025
dognose24
dognose24 previously approved these changes Jan 6, 2025
Copy link
Contributor

@dognose24 dognose24 left a comment

Choose a reason for hiding this comment

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

It works as described, and the changes look good to me! 👍🏼

截圖 2025-01-06 下午3 37 14

a8ck3n
a8ck3n previously approved these changes Jan 6, 2025
Copy link
Contributor

@a8ck3n a8ck3n left a comment

Choose a reason for hiding this comment

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

Looks good to me!

countRoles.forEach( role => {
if (
! [ 'administrator', 'editor', 'author', 'subscriber', 'contributor' ].includes(
countRoles
Copy link
Contributor

Choose a reason for hiding this comment

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

In addition to the setState() issue, testing for countRoles here would appear to be a bug.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ya it was a bug and I fixed it by the way 😄

if ( countRoles?.length > 0 ) {
countRoles.forEach( role => {
if (
! [ 'administrator', 'editor', 'author', 'subscriber', 'contributor' ].includes( role )
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor suggestion but maybe this array is a good candidate for a const value.

@kangzj kangzj dismissed stale reviews from a8ck3n and dognose24 via 22f546e January 6, 2025 20:38
@kangzj kangzj merged commit be744e8 into trunk Jan 6, 2025
59 checks passed
@kangzj kangzj deleted the fix/stats-setting-role-toggles branch January 6, 2025 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Feature] Stats Data Feature that enables users to track their site's traffic and gain insights on popular content. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [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.

3 participants