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

jetpack-mu-wpcom: Stabilize build #38284

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Jul 10, 2024

Proposed changes:

PR #38093 added downloading of translation data into the build for the package, and decided to store the current date in each file meaning that every file changes for every single build. This clutters up the history of the mirror repo, making it hard to see what the actual changes are since every trunk commit has these useless date changes.

We can improve the situation somewhat by saving the HTTP Last-Modified date into the files instead of the current date, so they should only be updated when the translations actually change. We'll still get updates attributed to whichever unrelated trunk commit happened to be the next after a change on the translation server, but at least we won't get it for every single commit.

Even better, IMO, would be if the translations could be downloaded to sites as needed like WordPress does with translations for plugins installed from wporg. But that would probably require a lot more refactoring.

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. But have a look at https://github.com/Automattic/jetpack-mu-wpcom-plugin/commits/trunk/vendor/automattic/jetpack-mu-wpcom/src/features/help-center/languages

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

No

Testing instructions:

  • Is the build happy?
  • Check the dates in the files.
PR #38093 added downloading of translation data into the build for the
package, and decided to store the current date in each file meaning that
every file changes for every single build. This clutters up the history
of the mirror repo, making it hard to see what the actual changes are
since every trunk commit has these useless date changes.

We can improve the situation somewhat by saving the HTTP Last-Modified
date into the files instead of the current date, so they should only be
updated when the translations actually change. We'll still get updates
attributed to whichever unrelated trunk commit happened to be the next
after a change on the translation server, but at least we won't get it
for every single commit.

Even better, IMO, would be if the translations could be downloaded to
sites as needed like WordPress does with translations for plugins
installed from wporg. But that would probably require a lot more
refactoring.
Copy link
Contributor

github-actions bot commented Jul 10, 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/constant-changes-for-help-center-languages 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-mu-wpcom-plugin fix/constant-changes-for-help-center-languages
    

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 the [Package] Jetpack mu wpcom WordPress.com Features label Jul 10, 2024
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.

@anomiex anomiex merged commit b10c682 into trunk Jul 10, 2024
55 checks passed
@anomiex anomiex deleted the fix/constant-changes-for-help-center-languages branch July 10, 2024 18:11
@github-actions github-actions bot removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Status] Needs Team Review labels Jul 10, 2024
@alshakero
Copy link
Member

Thank you for this. Lesson learned.

It's crazy that I got a shower idea 10 minutes ago, and I realized I can remove a lot of this complexity if I made translation files JS files and enqueued them using their URL instead. I'll send a PR soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment