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

Update all occurrences of MJ utils/formatNumber() function to use default options. #39055

Merged

Conversation

elliottprogrammer
Copy link
Contributor

@elliottprogrammer elliottprogrammer commented Aug 23, 2024

In PR #38953, we updated the My Jetpack formatNumber() utility function to pass some custom properties to the 2nd "options" parameter of the function by default. The custom default options are:

{
	maximumFractionDigits: 1,
	notation: 'compact',
}

These make the formatNumber() function display compact numbers (with 1 decimal) by default. For example: 23,682 displays as 23.7K, or 1,212,000 as 1.2M. This was our main intention/use case for the function.

Therefore, this is a follow-up PR: that updates all the other places that we call the My Jetpack formatNumber() function, removing the option parameters we were passing in because they are no longer needed (because as stated above, we now pass them in by default in the function definition).

Fixes #

Proposed changes:

  • Update occurrences of formatNumber() in the My Jetpack Backup product card.
  • Update occurrences of formatNumber in the My Jetpack VideoPress product card.
  • Update occurrences of FormatNumber in the My Jetpack Stats section.

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?

No

Testing instructions:

  • It's probably enough just to review the code and verify that I have removed the 2nd argument (shortenedNumberConfig) on each instance where we are calling the My Jetpack numberFormat utility function.

If you want to do a more thorough manual test, follow the following steps below:

  • Checkout this branch on your local Jetpack dev site, or a JN site using Beta plugin with sandbox access enabled.
  • Connect your site and make your Jetpack site is using your sandbox (JETPACK_SANDBOX__DOMAIN).
  • In your sandbox, edit file: public.api/rest/wpcom-json-endpoints/class.wpcom-json-api-stats-highlights-v1-1-endpoint.php
    • Disable the cache by commenting out line 22 (// return $cached_response;)
    • Line 34, set views to 8100. ('views' => 8100,)
  • Open the "Stats detail page" by going to My Jetpack --> Stats card --> View detailed stats, or directly to: /wp-admin/admin.php?page=stats
  • Now go back to My Jetpack page.
  • View the Stats Highlights, the "Views" card should be showing 8.1k (shortened number format), but the difference should Not have the shortened format (because the value is less than 9999). See screenshot:
    Screen Shot 2024-08-27 at 16 52 40
  • Again in your sandbox, edit file: public.api/rest/wpcom-json-endpoints/class.wpcom-json-api-stats-highlights-v1-1-endpoint.php
    • Line 34, set views to 10100. ('views' => 10100,)
  • Open the Stats detail page by going to My Jetpack --> Stats card --> View detailed stats, or directly to /wp-admin/admin.php?page=stats
  • Now go back to My Jetpack page.
  • View the Stats Highlights, the "Views" card should be showing 10.1k (shortened number format), and also the difference should have the shortened format also (because the value is greater than 9999). See screenshot:
    Screen Shot on 2024-08-27 at 16-45-51

Copy link
Contributor

github-actions bot commented Aug 23, 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 update/my-jetpack-format-number-default-config branch.

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

    bin/jetpack-downloader test jetpack update/my-jetpack-format-number-default-config
    

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

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.


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!

Copy link
Contributor

@IanRamosC IanRamosC left a comment

Choose a reason for hiding this comment

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

LGTM!

@elliottprogrammer elliottprogrammer added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] In Progress labels Aug 30, 2024
@elliottprogrammer elliottprogrammer merged commit cd0ac7a into trunk Aug 30, 2024
72 of 73 checks passed
@elliottprogrammer elliottprogrammer deleted the update/my-jetpack-format-number-default-config branch August 30, 2024 13:45
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants