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: Improve Verbum build #35323

Merged
merged 2 commits into from
Jan 30, 2024
Merged

jetpack-mu-wpcom: Improve Verbum build #35323

merged 2 commits into from
Jan 30, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Jan 29, 2024

Proposed changes:

  • Avoid copying php files into src/build/, as it causes Composer to complain about multiple files providing the classes.
  • Run dynamic-loader.js through webpack for minification.
  • Use the jetpack-assets package to register the scripts using the data in the .assets.php files.

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

p1706559158287209/1706556445.671539-slack-C01U2KGS2PQ

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

No

Testing instructions:

  1. Apply this patch to your sandbox using both of the commands listed here.
  2. Sandbox punsintended418746564.wordpress.com.
  3. Comment on this post.
  4. Make sure embeds works (one embed is enough, to make sure embeds endpoint work (relies on PHP files)).

Regression testing

  1. Checkout this branch.
  2. Sync jetpack-mu-plugin with your atomic site.
  3. Visit any wp-admin page and verify no warnings or errors show up.

* Avoid copying php files into `src/build/`, as it causes Composer to
  complain about multiple files providing the classes.
* Run `dynamic-loader.js` through webpack for minification.
* Use the jetpack-assets package to register the scripts using the data
  in the `.assets.php` files.
@github-actions github-actions bot added [mu wpcom Feature] Verbum Comments Verbum, a better comment experience, app developed in the mu-wpcom plugin [Package] Jetpack mu wpcom WordPress.com Features [Plugin] mu wpcom jetpack-mu-wpcom plugin labels Jan 29, 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.


Mu Wpcom plugin:

  • Next scheduled release: February 6, 2024.
  • Scheduled code freeze: January 29, 2024.

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

@anomiex
Copy link
Contributor Author

anomiex commented Jan 29, 2024

Hi Verbum folks! Sorry for dumping a PR on you without doing much testing myself. 🙁 I don't really know how Verbum works. Please feel free to fix stuff if there are obvious errors in the PR, and if this works for you feel free to merge it. Thanks!

Copy link
Contributor

github-actions bot commented Jan 29, 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/verbum-build 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/verbum-build
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/verbum-build
    

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
Member

@alshakero alshakero left a comment

Choose a reason for hiding this comment

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

Thank you so much!

  1. I added testing steps for future ref.
  2. I verified dynamic-loader.js is versioned and minified.
  3. I verified Verbum works, including the block editor.
  4. I verified the embeds work.
  5. I tested on Atomic and I don't see any warnings or errors.

@@ -250,14 +246,14 @@ public function enqueue_assets() {

wp_enqueue_script( 'verbum-settings' );

wp_enqueue_script(
Assets::register_script(
Copy link
Member

Choose a reason for hiding this comment

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

cc @Automattic/vertex it seems that's why we had issues with our versioning! Let's fix this one in our SSO work.

Copy link
Contributor

Choose a reason for hiding this comment

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

On it 👍

Copy link
Contributor

@agrullon95 agrullon95 left a comment

Choose a reason for hiding this comment

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

Testing:

Synced changes to WoA site and did not see any warnings/errors.
Verified embed blocks are still working.
Tested posts work for WPCOM, FB, and anon users with and without GB editor (Simple and Atomic).
Verified dynamic-loader.js is versioned and minified.

@agrullon95 agrullon95 merged commit 7fad963 into trunk Jan 30, 2024
66 checks passed
@agrullon95 agrullon95 deleted the fix/verbum-build branch January 30, 2024 14:38
robfelty pushed a commit that referenced this pull request Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[mu wpcom Feature] Verbum Comments Verbum, a better comment experience, app developed in the mu-wpcom plugin [Package] Jetpack mu wpcom WordPress.com Features [Plugin] mu wpcom jetpack-mu-wpcom plugin [Pri] Normal [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants