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

Post-migration task list: Add new ssl task #39686

Closed
wants to merge 13 commits into from
Closed

Conversation

andres-blanco
Copy link
Contributor

@andres-blanco andres-blanco commented Oct 8, 2024

Fixes Automattic/wp-calypso#95096

Proposed changes:

This change adds a new task to guide the user to provision their SSL certificate.

  • The task will be disabled if the site has no primary domain associated
  • The task will be marked as complete if the site has a primary domain and it has an SSL certificate provisioned

The check to see if the cert is provisioned is running on every /home render. It doesn't seem to be an issue since the call to get_flags (file: wp-content/lib/domains/domain-flags/domain-flags-store.php) is cached. But I would like to get a green light from Nomado since it's my first time working with domains.

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:

This code runs on simple since it's called via public-api. Please see the instructions here on how to test a PR: PCYsg-Osp-p2

  • Add the following filter to your 0-sandbox.php file:
add_filter( 'is_launchpad_intent_post_migration_enabled', '__return_true' );
  • Then, navigate to the Customer Home page and you should see a task named Provision SSL certificate.

On a site with a WPCOM primary domain

  • Verify that the task is disabled

On a site with a non WPCOM primary domain, but without provisioned SSL

  • Verify the task is enabled and when clicking on it you get redirected to https://wordpress.com/domains/manage/[PRIMARY_DOMAIN]/edit/[PRIMARY_DOMAIN]

On a site with a non WPCOM primary domain, with provisioned SSL

  • The task should be marked complete.

Copy link
Contributor

github-actions bot commented Oct 8, 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!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 8, 2024
Copy link
Contributor

github-actions bot commented Oct 8, 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/new-ssl-task 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 add/new-ssl-task
    

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

@andres-blanco andres-blanco force-pushed the add/new-ssl-task branch 2 times, most recently from 9412333 to c5bdebe Compare October 10, 2024 12:12
@andres-blanco andres-blanco requested a review from a team October 10, 2024 12:12
@andres-blanco andres-blanco self-assigned this Oct 10, 2024
@andres-blanco andres-blanco added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Oct 10, 2024
ramynasr
ramynasr previously approved these changes Oct 10, 2024
Copy link

@ramynasr ramynasr left a comment

Choose a reason for hiding this comment

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

LGTM as-is. Just added to suggestions in case that helps.

@valterlorran
Copy link
Contributor

Hey @ramynasr! I applied your feedback. Can you review it again, please?

Copy link

@ramynasr ramynasr left a comment

Choose a reason for hiding this comment

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

Thanks for looking into the suggestions. I'm concerned about the multiple calls to find_primary_by_blog_id since my understanding this would run on every /home page load. I left a suggestion that can possibly mitigate that.

@andres-blanco
Copy link
Contributor Author

The task was added in a separate PR. The check is implemented in this job: D164293-code . That job will be triggered when we detect ssl provisioning.

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.

Post-migration Experience: Add the "Check SSL status" task
4 participants