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

Add DIFM-specific functionality for WoA sites #39915

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

aneeshd16
Copy link
Contributor

@aneeshd16 aneeshd16 commented Oct 26, 2024

Fixes https://github.com/Automattic/martech/issues/3505

Proposed changes:

Fixes https://github.com/Automattic/martech/issues/3505

This PR contains the following changes:
When the difm-lite-in-progress sticker is active for a WoA site, and the user is NOT proxied:

  • Always show the Coming Soon page.

  • Hide the admin bar.

  • Hide all menu items in wp-admin except for Hosting->{Email, Domain, Purchases}.

  • Replace wp-admin page content with this notice:

    • If content has not been submitted:
    image
    • If content has been submitted:
    image

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?

Testing instructions:

Setup

  • Ensure you have a WoA site on a Business plan.
  • Go to https://wordpress.com/start/do-it-for-me and choose "Existing site". Choose the WoA site from the first step.
  • Ensure that you are not store sandboxed and complete the purchase.
  • SSH into the WoA site.
  • Add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file. (Usually in /htdocs/wp-config.php)
  • Go to the Blog RC and toggle off the difm-lite-in-progress sticker.
  • Install the Jetpack Beta Tester Plugin.
  • Go to /wp-admin/admin.php?page=jetpack-beta&plugin=jetpack-mu-wpcom-plugin.
  • In the "Search for a feature branch box", enter add/wpcom-difm-functions. (This branch)
  • Go to the Blog RC and toggle on the difm-lite-in-progress sticker.

Testing

Proxy Off

  • Visit the website URL. Confirm that the Coming Soon page is shown.

  • Confirm that the admin bar is not shown. The following is a screenshot of the admin bar.
    image

  • Go to /wp-admin

  • Confirm that only the Hosting menu is present in the side bar and contains the following items:
    image

  • Confirm that the sub menu items point to the correct URLs.

  • Confirm that the content area is replaced by this:
    image

  • Click on the button in the above notice.

  • Confirm it takes you to the content submission form and submit content.

  • Go to /wp-admin.

  • Confirm that the content area is replaced by by this:
    image

Proxy On

  • Visit the website URL. Confirm that the Coming Soon page is not shown and the full website is visible.
  • Confirm that the admin bar is shown.
  • Go to /wp-admin
  • Confirm that the all menu items are present in the sidebar.
  • Confirm that the regular wp-admin content is shown.

Copy link
Contributor

github-actions bot commented Oct 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 add/wpcom-difm-functions 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-difm-functions
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/wpcom-difm-functions
    

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 Oct 26, 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.


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!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

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

@oskosk
Copy link
Contributor

oskosk commented Oct 29, 2024

Hi, can you add any context for this PR? Thanks

@aneeshd16
Copy link
Contributor Author

Hi @oskosk, this is a very early draft, and depending on feedback, we may or may not proceed with it. As the PR progresses, I'll keep adding details and testing instructions. For now, I have added the GH issue link to the PR. Hope that it's okay!

@aneeshd16 aneeshd16 force-pushed the add/wpcom-difm-functions branch 2 times, most recently from e9acd0b to a44a1d8 Compare November 22, 2024 04:32
@aneeshd16 aneeshd16 force-pushed the add/wpcom-difm-functions branch from a44a1d8 to 2046862 Compare November 22, 2024 04:51
@aneeshd16 aneeshd16 marked this pull request as ready for review November 22, 2024 04:51
@aneeshd16 aneeshd16 self-assigned this Nov 22, 2024
@github-actions github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants