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

Limited Global Styles: Port feature from ETK to jetpack-mu-wpcom #38333

Merged
merged 25 commits into from
Jul 18, 2024

Conversation

mmtr
Copy link
Member

@mmtr mmtr commented Jul 15, 2024

Fixes https://github.com/Automattic/dotcom-forge/issues/8170

Proposed changes:

Ports the Limited Global Styles feature from ETK to jetpack-mu-wpcom.

Code has been just copied from ETK with some additional changes:

  • Defined a MU_WPCOM_GLOBAL_STYLES constant to turn off the feature in the ETK plugin
  • Changed tracks logic to use the tools available in Jetpack
  • Changed fetching of the Explorer plan name to use the tools available in Jetpack
  • Adapted webpack config and enqueueing logic
  • Changed text domain of translations to jetpack-mu-wpcom
  • Adapted WPCOM_Global_Styles_Test to use \WorDBless\BaseTestCase
  • Fixed a few linting issues:
    • Added missing JSDocs
    • Removed a ?int syntax because it's not compatible with PHP 7.0
    • Changed a capability check to use the manage_options cap instead of the administrator role

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:

  • Apply these changes.
  • Sandbox your API.
  • Test a Free site with GS.
  • The Site Editor should show notices when GS are used.
  • The Site Editor should show the Try before you buy modal.
  • The onboarding flow should work without regressions.
  • The Launch Banner should work without regressions.
  • Event names should be the same as on production.

@mmtr mmtr self-assigned this Jul 15, 2024
Copy link
Contributor

github-actions bot commented Jul 15, 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 add/wpcom-global-styles 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 add/wpcom-global-styles
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/wpcom-global-styles
    

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

github-actions bot commented Jul 15, 2024

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: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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


Wpcomsh plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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

@rcrdortiz
Copy link
Contributor

Works as expected on the Site Editor (I'll continue testing other places)

Screenshot 2024-07-17 at 09 51 22
Screenshot 2024-07-17 at 09 52 40
Screenshot 2024-07-17 at 09 52 16

@rcrdortiz
Copy link
Contributor

Launch Banner works as expected:

Screenshot 2024-07-17 at 09 55 03
Screenshot 2024-07-17 at 09 54 50

@rcrdortiz
Copy link
Contributor

Found a bug, it's not a regression since it also happens in production. When we have a GS paid variation selected on the Site Editor on the Free plan, the GS notice isn't shown until something re-triggers it. Here is a video with the actual issue.

gs-bug.mp4

@mmtr
Copy link
Member Author

mmtr commented Jul 17, 2024

When we have a GS paid variation selected on the Site Editor on the Free plan, the GS notice isn't shown until something re-triggers it.

Nice catch! Since the bug is in prod as well, let's create a separate issue and fix it afterwards.

@rcrdortiz
Copy link
Contributor

Events working as expected, everything I've tried is working as expected.

rcrdortiz
rcrdortiz previously approved these changes Jul 17, 2024
Copy link
Contributor

@rcrdortiz rcrdortiz left a comment

Choose a reason for hiding this comment

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

Changes work as expected, could not find any regressions. Tested the onboarding flow, Site Editor, and the Launch Banner.
Upgraded to an Explorer plan and checked that the notices and upsells are hidden.

rcrdortiz
rcrdortiz previously approved these changes Jul 17, 2024
@rcrdortiz
Copy link
Contributor

Could you have a look at the Phan changes we've made in this PR @anomiex?

@github-actions github-actions bot added [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Wpcomsh labels Jul 18, 2024
Copy link
Contributor

@rcrdortiz rcrdortiz left a comment

Choose a reason for hiding this comment

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

Changes look good, all checks are passing.

@mmtr
Copy link
Member Author

mmtr commented Jul 18, 2024

Thanks for addressing the Phan errors, @rcrdortiz! Everything looks good to me as well.

@mmtr mmtr merged commit 20b1a96 into trunk Jul 18, 2024
73 checks passed
@mmtr mmtr deleted the add/wpcom-global-styles branch July 18, 2024 09:40
@anomiex
Copy link
Contributor

anomiex commented Jul 18, 2024

Phan changes look reasonable. Suggested #38410 to clean up a little.

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.

3 participants