Skip to content

WoA: Clarify function names and comments related to checking for WoA sites #43481

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

Merged
merged 7 commits into from
May 22, 2025

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented May 15, 2025

Fixes VULCAN-93

Proposed changes:

  • This PR updates function docblocks and comments where confusion may arise in terms of usage of functions designed to check if a site is WoA or Atomic (as well as isJetpackSelfHostedSite). The intention is to make it clearer that isWoASite should be the go-to option for WoA sites, and functions mentioning Atomic refer to the Atomic platform (including Jurassic Ninja, Pressable, and others).
  • It also introduces a new isWoASite function within the shared-extension-utils package, which is a duplicate of isAtomicSite (to be removed later, as well as replacing isAtomicSite usage in the shared-extension-utils package).
  • It also updates isAtomicSite usage to isWoASite where the functionality was imported from state/initial-state, as both functions do the same (the former was intended to be deprecated when the latter was introduced four years ago in Admin Page: Do not display version numbers on Atomic platform #21533).
  • In the process, docblocks were added throughout the initial state reducer.js file due to linter requests.

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:

  • Proof read docblock / comment changes
  • Confirm the new isWoASite function is a duplication of isAtomicSite in the shared-extension-utils package

To test the function replacements:

  • From the Jetpack 'At a Glance' page - /wp-admin/admin.php?page=jetpack#/dashboard - find the 'Akismet Anti-Spam' card. Open up the info popup, and on a Jurassic Ninja site you should see a 'Learn more' link leading to https://akismet.com/features. On a WoA site, there should be no 'Learn more' link.
  • Add a paid plan to a Jurassic Ninja site. Visit the same 'At a Glance' page and scroll down to the 'Support' card (titled 'We're here to help). Notice the text mentions Jetpack support and there is a link to Jetpack support (and 'Getting started with Jetpack).
  • View the same page on a WoA site, it should mention WordPress.com support and link to a WordPress.com support page.
  • This behaviour should be the same both with and without the changes applied (using the Jetpack beta tester plugin).

Copy link
Contributor

github-actions bot commented May 15, 2025

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 WoA dev 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 (Jetpack or WordPress.com Site Helper), and enable the update/woa-atomic-jetpack-site-usage-functions branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack update/woa-atomic-jetpack-site-usage-functions
bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/woa-atomic-jetpack-site-usage-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

@github-actions github-actions bot added [JS Package] Script Data [JS Package] Shared Extension Utils [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Admin Page React-powered dashboard under the Jetpack menu RNA labels May 15, 2025
Copy link
Contributor

github-actions bot commented May 15, 2025

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 Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, 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 as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: June 3, 2025
    • Code freeze: June 2, 2025

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

Copy link

jp-launch-control bot commented May 15, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/js-packages/shared-extension-utils/src/site-type-utils.js 2/8 (25.00%) -3.57% 1 ❤️‍🩹

Full summary · PHP report · JS report

@coder-karen coder-karen marked this pull request as ready for review May 16, 2025 11:12
@coder-karen coder-karen added [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels May 16, 2025
@coder-karen coder-karen requested a review from a team May 16, 2025 11:13
@darssen darssen self-requested a review May 22, 2025 11:23
Copy link
Contributor

@darssen darssen 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 sensible and tests as expected.

Thanks for the work here @coder-karen!

@coder-karen coder-karen merged commit d881a81 into trunk May 22, 2025
84 checks passed
@coder-karen coder-karen deleted the update/woa-atomic-jetpack-site-usage-functions branch May 22, 2025 15:49
@github-actions github-actions bot removed [Status] In Progress [Status] Needs Review This PR is ready for review. labels May 22, 2025
@github-actions github-actions bot added this to the jetpack/14.7 milestone May 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [JS Package] Script Data [JS Package] Shared Extension Utils [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ RNA [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants