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

Improve performance of changelogger-validate-all.sh #38074

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Jun 26, 2024

Proposed changes:

changelogger version is unnecessarily calling git to fetch the timestamp and PR number for all the changelog entries, when all it's really using is the significance. Skip that.

Then, while validating each individual project is reasonably fast, when there's 117 of them it adds up. We can improve things somewhat by processing projects in parallel, matching the number of processors in the system.

On my laptop, the first takes the time from ~16.8s to ~10.7s, and the second (8 cores) takes it to ~2.3s.

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

None

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

No

Testing instructions:

  • Try it?

`changelogger version` is unnecessarily calling `git` to fetch the
timestamp and PR number for all the changelog entries, when all it's
really using is the significance. Skip that.

Then, while validating each individual project is reasonably fast, when
there's 117 of them it adds up. We can improve things somewhat by
processing projects in parallel, matching the number of processors in
the system.

On my laptop, the first takes the time from ~16.8s to ~10.7s, and the
second (8 cores) takes it to ~2.3s.
@anomiex anomiex added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Pri] Normal labels Jun 26, 2024
@anomiex anomiex requested a review from a team June 26, 2024 19:35
@anomiex anomiex self-assigned this Jun 26, 2024
@anomiex anomiex enabled auto-merge (squash) June 26, 2024 19:35
Copy link
Contributor

github-actions bot commented Jun 26, 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 fix/improve-performance-in-changelogger-validate-all branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/improve-performance-in-changelogger-validate-all
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/improve-performance-in-changelogger-validate-all
    

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.


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.

Copy link
Member

@zinigor zinigor left a comment

Choose a reason for hiding this comment

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

Before:

$ time ./tools/changelogger-validate-all.sh

real	0m17,171s
user	0m9,760s
sys	0m6,802s

After:

$ time ./tools/changelogger-validate-all.sh

real	0m0,837s
user	0m8,717s
sys	0m6,285s

Very impressive!

@anomiex anomiex merged commit 00c1de8 into trunk Jun 27, 2024
74 checks passed
@anomiex anomiex deleted the fix/improve-performance-in-changelogger-validate-all branch June 27, 2024 11:45
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jun 27, 2024
EXIT=0
declare -A PIDS
PIDS=()
N=$( nproc || echo 1 )
Copy link
Contributor

Choose a reason for hiding this comment

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

Noting that nproc doesn't exist on macOS. It seems sysctl -n hw.physicalcpu is an equivalent:

memkind/memkind#33 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Changelogger [Pri] Normal [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.

3 participants