Social: Hide license link on Social admin page of WoA sites #41076

p-jackson · 2025-01-15T03:11:11Z

Proposed changes:

Adds a is_woa_site flag to the window.JetpackScriptData.social global
Hide the Already have an existing plan or license key? link on the Social plugin's admin page when the site is hosted on WoA

Hiding the license link in the admin page is the approach that Jetpack Boost took here when it had the equivalent issue here #36434

AFAICT there isn't an existing way to check whether the site is hosted on WoA in the client, so, like Boost, we have to add something to a global. (Boost uses it's own window.Jetpack_Boost global which contains this data

jetpack/projects/plugins/boost/app/assets/src/js/lib/utils/hosting.ts

Line 16 in ee9ed01

return Jetpack_Boost.site.host === 'woa';

)

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

The issue described in Automattic/wp-calypso#98217 is that the user can end up on an access denied page after clicking the Add an existing license link.

This is because the My Jetpack page is hidden on WoA sometimes; specifically when the admin interface style is set to "Default" (aka use Calypso instead of wp-admin)

There's been discussion here Automattic/wp-calypso#98217 (comment) and here https://github.com/Automattic/dotcom-forge/issues/5663#issuecomment-1953388803 about whether we should just open up the My Jetpack page in all cases. This PR doesn't answer that discussion.

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

Nope

Testing instructions:

Follow these instructions for setting up this diff on your WoA test site
The standalone Jetpack Social plugin needs to be installed
Nav to /wp-admin/admin.php?page=jetpack-social
Confirm the Already have an existing plan or license key? link is hidden
Test using jurassic.ninja; the link should appear

github-actions · 2025-01-15T03:12:01Z

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 update/social/hide-license-on-woa 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 update/social/hide-license-on-woa

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/social/hide-license-on-woa

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 · 2025-01-15T03:12:12Z

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 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 🤖

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:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Social plugin:

Next scheduled release: none scheduled.

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

manzoorwanijk

This looks good and a reasonable change. Thank you for fixing it.

As you mentioned

AFAICT there isn't an existing way to check whether the site is hosted on WoA in the client, so, like Boost, we have to add something to a global. (Boost uses it's own window.Jetpack_Boost global which contains this data

There are always multiple versions of the same data passed to the client and for this reason, we decided to consolidate the initial state for Jetpack - pdWQjU-11v-p2.

So, since that flag you added is not specific to social, let us add it to some place where it can be used by other areas of the codebase.

After the suggested changes, we can have this

manzoorwanijk · 2025-01-15T04:29:47Z

projects/packages/publicize/src/class-publicize-script-data.php

@@ -100,6 +100,7 @@ public static function get_admin_script_data() {
 			'shares_data'          => array(),
 			'urls'                 => array(),
 			'settings'             => self::get_social_settings(),
+			'is_woa_site'          => ( new Host() )->is_woa_site(),


Instead of adding this boolean flag here, we can add it inside that set_admin_script_data method here.

if ( ! isset( $data['site']['host'] ) ) { $data['site']['host'] = ( new Host() )->get_known_host_guess(); }

By extending the JetpackScriptData interface to include the host value too, is your intention that Boost should move over to using it too? I'd be happy to make that change too, but would that be considered too much of a breaking change? (since the over-the-wire format would be changing).

In which case, would it be better to add the host value here?

jetpack/projects/packages/assets/src/class-script-data.php

Line 110 in ee9ed01

'site' => array(

Or (in keeping with the filter documentation that we should only enqueue data we know will be used) should both the Social and Boost plugins both independently add the host data in the jetpack_admin_js_script_data filter. So that when neither plugin is installed the data won't be present.

Some data is always added, whether it's used or not (like wp_version, is_multisite), but maybe those are more fundamental than the host.

By extending the JetpackScriptData interface to include the host value too, is your intention that Boost should move over to using it too? I'd be happy to make that change too, but would that be considered too much of a breaking change? (since the over-the-wire format would be changing).

I don't mean to change anything in Boost right now. I think that has been in Boost for a while. I mean to say that we just don't make that data specific to Social. Boost can later refactor to use that shared value from JetpackScriptData

In which case, would it be better to add the host value here?

That will require the status package to be a dependency for the assets package, which we don't want for this small change. At least not as a part of this PR.

Or (in keeping with the filter documentation that we should only enqueue data we know will be used) should both the Social and Boost plugins both independently add the host data in the jetpack_admin_js_script_data filter. So that when neither plugin is installed the data won't be present.

Yes, let the package that needs it, add it to the data.

Thanks for the clarification. I'll rein in the scope of where I was starting to go with this PR 😄

manzoorwanijk · 2025-01-15T04:33:20Z

projects/js-packages/publicize-components/src/types.ts

@@ -54,4 +54,5 @@ export interface SocialScriptData {
 	store_initial_state: SocialStoreState;
 	supported_services: Array< ConnectionService >;
 	urls: SocialUrls;
+	is_woa_site: boolean;


manzoorwanijk · 2025-01-15T04:35:56Z

projects/plugins/social/src/js/components/admin-page/header/index.jsx


 	return (
 		<div className={ styles.header }>
 			<span className={ styles.logo }>
 				<Logo />
 			</span>

-			{ ! hasSocialPaidFeatures() && (
+			{ ! hasSocialPaidFeatures() && ! isWoaSite && (


Then here we can use ! getScriptData().site.host !== 'woa' after

import { getScriptData } from '@automattic/jetpack-script-data';

agrullon95

I tested on my atomic site and can confirm the link is no longer visible.
The link is a visible and navigating to the correct location when I tested with Jurassic NInja

manzoorwanijk · 2025-01-15T04:53:53Z

@p-jackson Please let me know if I should make those changes for you.

manzoorwanijk · 2025-01-15T08:33:39Z

projects/js-packages/script-data/src/types.ts

@@ -18,6 +18,7 @@ export interface PublicSiteData {
 export interface AdminSiteData {
 	admin_url: string;
 	date_format: string;
+	host: 'woa' | 'atomic' | 'newspack' | 'vip' | 'wpcom' | 'unknown';


In practice everything in AdminSiteData is optional since it's included in the JetpackScriptData interface using Partial< ... >.

But perhaps this makes it clearer that this property is even more optional than the other optional properties.

Yeah, thanks. I am fine with both.

manzoorwanijk

This looks good. Thank you for the fix.

I just have another optional suggestion.

Thank you for making the suggested changes.

p-jackson · 2025-01-15T08:38:38Z

Thank you for making the suggested changes.

No problem, I like this better

manzoorwanijk

This will require an Atomic release, right?

p-jackson · 2025-01-15T09:02:51Z

This will require an Atomic release, right?

I don't believe so. It's not part of wpcomsh. It will just roll out whenever the stand alone Social plugin usually rolls out right? Jetpack Social is not a plugin "managed" by the Atomic platform, so it doesn't have a way of updating this plugin sooner than it coming out in the dotorg repo.

manzoorwanijk · 2025-01-15T09:26:42Z

Yeah, makes sense. Thanks.

manzoorwanijk

Please hold off merging this. We are discussing it in our team call.

That nudge might be valid. I will get back to you on this.

manzoorwanijk

OK, this can be shipped now. We had recently enabling purchasing of Social plans for Atomic sites and were wondering if that nudge is valid, but since they can't access the page, it's better to hide it. Sorry for keeping you waiting.

p-jackson · 2025-01-15T20:49:45Z

Sounds good, thanks for the reviews!

Hide license link on Social admin page of WoA sites

ee9ed01

github-actions bot added [Feature] Publicize Now Jetpack Social, auto-sharing [JS Package] Publicize Components [Package] Publicize [Plugin] Social Issues about the Jetpack Social plugin [Status] In Progress RNA labels Jan 15, 2025

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 Jan 15, 2025

p-jackson added the [Type] Bug When a feature is broken and / or not performing as intended label Jan 15, 2025

p-jackson self-assigned this Jan 15, 2025

p-jackson requested review from gmjuhasz and manzoorwanijk and removed request for gmjuhasz January 15, 2025 03:55

p-jackson added the Groundskeeping Worked on by Dotcom Groundskeeping label Jan 15, 2025

p-jackson requested review from ouikhuan and agrullon95 January 15, 2025 03:56

p-jackson marked this pull request as ready for review January 15, 2025 03:56

p-jackson mentioned this pull request Jan 15, 2025

Unable to access "Activate a Plan" link when WordPress.com interface style is enabled General Settings Automattic/wp-calypso#98217

Closed

manzoorwanijk reviewed Jan 15, 2025

View reviewed changes

agrullon95 previously approved these changes Jan 15, 2025

View reviewed changes

p-jackson added 2 commits January 15, 2025 21:24

Switch is_woa_site flag to a JetpackScriptData.site.host flag

4bbdedb

changelog

4227ba7

p-jackson dismissed agrullon95’s stale review via 4227ba7 January 15, 2025 08:26

github-actions bot added the [JS Package] Script Data label Jan 15, 2025

changelog

6b9190d

manzoorwanijk reviewed Jan 15, 2025

View reviewed changes

manzoorwanijk previously approved these changes Jan 15, 2025

View reviewed changes

Annotate the host property as optional

04fecbc

p-jackson dismissed manzoorwanijk’s stale review via 04fecbc January 15, 2025 08:37

manzoorwanijk approved these changes Jan 15, 2025

View reviewed changes

manzoorwanijk requested changes Jan 15, 2025

View reviewed changes

manzoorwanijk approved these changes Jan 15, 2025

View reviewed changes

p-jackson merged commit be0d34b into trunk Jan 15, 2025
76 checks passed

p-jackson deleted the update/social/hide-license-on-woa branch January 15, 2025 20:50

github-actions bot removed [Status] In Progress [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Social: Hide license link on Social admin page of WoA sites #41076

Social: Hide license link on Social admin page of WoA sites #41076

p-jackson commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

manzoorwanijk left a comment

manzoorwanijk Jan 15, 2025

p-jackson Jan 15, 2025

manzoorwanijk Jan 15, 2025

p-jackson Jan 15, 2025

manzoorwanijk Jan 15, 2025

manzoorwanijk Jan 15, 2025

agrullon95 left a comment

manzoorwanijk commented Jan 15, 2025

manzoorwanijk Jan 15, 2025

p-jackson Jan 15, 2025

manzoorwanijk Jan 15, 2025

manzoorwanijk left a comment

p-jackson commented Jan 15, 2025

manzoorwanijk left a comment

p-jackson commented Jan 15, 2025

manzoorwanijk commented Jan 15, 2025

manzoorwanijk left a comment

manzoorwanijk left a comment

p-jackson commented Jan 15, 2025

	host: 'woa' \| 'atomic' \| 'newspack' \| 'vip' \| 'wpcom' \| 'unknown';
	host?: 'woa' \| 'atomic' \| 'newspack' \| 'vip' \| 'wpcom' \| 'unknown';

Social: Hide license link on Social admin page of WoA sites #41076

Social: Hide license link on Social admin page of WoA sites #41076

Conversation

p-jackson commented Jan 15, 2025 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Jan 15, 2025 • edited Loading

github-actions bot commented Jan 15, 2025 • edited Loading

manzoorwanijk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agrullon95 left a comment

Choose a reason for hiding this comment

manzoorwanijk commented Jan 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

manzoorwanijk left a comment

Choose a reason for hiding this comment

p-jackson commented Jan 15, 2025

manzoorwanijk left a comment

Choose a reason for hiding this comment

p-jackson commented Jan 15, 2025

manzoorwanijk commented Jan 15, 2025

manzoorwanijk left a comment

Choose a reason for hiding this comment

manzoorwanijk left a comment

Choose a reason for hiding this comment

p-jackson commented Jan 15, 2025

p-jackson commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading