Social: Consolidate social initial state #38606

manzoorwanijk · 2024-07-30T06:48:40Z

Based off of #38430, this PR serves as an example of how to use the consolidated initial state.

This is a minimal version of what changes we need to make to get the job done (https://github.com/Automattic/jetpack-reach/issues/135). For now it uses the new initial state only for the useAdminUiV1 feature flag. Moving forward, we will need to update the initial state from the backend and also update the corresponding js logic.

Proposed changes:

Use the consolidated initial of Jetpack to render the Social Initial state
Use the rendered Social initial state for useAdminUiV1 feature flag on Social admin page

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:

Go to Social admin page
Confirm that you see the "Connect accounts" button when there are no connections
Confirm that clicking on the button opens the connections management modal
Confirm that you see the connections list
Confirm that nothing changes in the editor and Jetpack settings page for both Jetpack and WPCOM sites
For WoA sites, you may need to jetpack build plugins/wpcomsh and jetpack rsync wpcomsh to mu-plugins
If you use Query Monitor plugin (which you always should), you can check the script dependencies for Social admin page.
Do a sanity check for simple and atomic sites to ensure all is OK.

…tate

github-actions · 2024-07-30T06:50:07Z

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/consolidate-social-state 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/consolidate-social-state

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/consolidate-social-state

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

spsiddarthan

I have asked some questions and added some thoughts. Might be a good idea to get together and chat about it tomorrow.

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

projects/plugins/social/src/class-jetpack-social.php

projects/plugins/jetpack/class.jetpack.php

projects/plugins/social/tests/e2e/package.json

projects/packages/publicize/src/class-publicize-utils.php

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

spsiddarthan · 2024-08-08T10:17:50Z

Left some thoughts, copying @gmjuhasz to add his as well.

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

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

projects/plugins/social/src/class-jetpack-social.php

spsiddarthan

Left a thought on the way we configure the assets.

Instead of commenting out, let's get rid of functions and variables we don't use. We can come back to this PR's history to add them back.

projects/packages/publicize/actions.php

manzoorwanijk · 2024-08-09T10:10:35Z

Instead of commenting out, let's get rid of functions and variables we don't use. We can come back to this PR's history to add them back.

Done. Thanks

spsiddarthan

This looks good and I think is really close. It tests well per the instructions.

I am pinging @gmjuhasz for a second look and testing. I don't know how to test using the Query Monitor plugin, so I didn't do that, but I will do that after pairing with either of you next week.

gmjuhasz

Tests well just had some small questions. If this is done and we migrate all other initial state, what else do we need to deprecate?

gmjuhasz · 2024-08-09T12:48:49Z

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

@@ -1,3 +1,12 @@
+export interface FeatureFlags {
+	useAdminUiV1: boolean;


Do we have to add the new feature flag for the modal as well?

Yes, we need to migrate all our initial state to this new consolidated one.

gmjuhasz · 2024-08-09T12:53:03Z

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

+/**
+ * Publicize_Script_Data class.
+ */
+class Publicize_Script_Data {


I am a bit confused here what the class name "Script data" means. Could we have a more descriptive doc if this describes the class the best?

Actually the package we created in #38430 was initially named as initial-state and the class was also named as Jetpack_Initial_State but after some discussion with Garage team, we reached the conclusion to use the word script data which is what the initial state actually is. Also, WordPress uses the similar nomenclature for such data - wp_add_inline_script has calls the second argument as $data and likewise the other such functions.

gmjuhasz · 2024-08-09T12:54:21Z

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

+	public static function has_feature_flag( $feature ): bool {
+		$flag_name = str_replace( '-', '_', $feature );
+
+		// If the option is set, use it.
+		if ( get_option( 'jetpack_social_has_' . $flag_name, false ) ) {
+			return true;
+		}
+
+		$constant_name = 'JETPACK_SOCIAL_HAS_' . strtoupper( $flag_name );
+		// If the constant is set, use it.
+		if ( defined( $constant_name ) && constant( $constant_name ) ) {
+			return true;
+		}
+
+		return Current_Plan::supports( 'social-' . $feature );
+	}
+}


We have this in publicize-base with my previous changes, would that be deprecated?

Yes, we will eventually move to this new consolidated logic.

manzoorwanijk · 2024-08-09T15:37:26Z

If this is done and we migrate all other initial state, what else do we need to deprecate?

Yes, we will need to gradually migrate to the new initial state. We can do that in small PRs to make testing easier. After we are done doing that, we can come back to Unbundling publicize from Jetpack and Social - the idea that actually gave birth to this one.

gmjuhasz

This tests well per the instuctions and looks okay to merge

manzoorwanijk added 23 commits July 22, 2024 12:38

WIP

18026f2

Make the whole class static

a4e0b93

Use in-footer

2c677a3

Reset my-jetpack from trunk

bb90514

Remove unnecessary checks for asset registration

59dc46c

Merge branch 'trunk' into add/consolidate-initial-state

590d56f

Add changelog

5b0ac8a

Merge branch 'trunk' into add/consolidate-initial-state

a8f41a8

Delete .eslintrc.js

713c909

Set type to module

ac4b37b

Fix case

d32dc2d

Merge branch 'trunk' into add/consolidate-initial-state

16a9564

Update pnpm-lock.yaml

1ba5b7d

Merge branch 'trunk' into add/consolidate-initial-state

f927d65

Silence filemtime warning

436c436

Use print_scripts hook instead of enqueue_scripts to render initial s…

7acde2b

…tate

Merge branch 'trunk' into add/consolidate-initial-state

d4fd7a9

Reset changes in connection package

14a1cd6

Have separate filters for admin and public scripts

745918a

Add more common fields and update types

066270e

Merge branch 'trunk' into add/consolidate-initial-state

7e2adfa

Fix up versions

aadfeb3

Create .gitkeep

948e8ff

manzoorwanijk self-assigned this Jul 30, 2024

github-actions bot added [JS Package] Publicize Components [Package] Publicize [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Social Issues about the Jetpack Social plugin [Status] In Progress labels Jul 30, 2024

github-actions bot added [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh Docs labels Aug 7, 2024

manzoorwanijk added 3 commits August 7, 2024 21:22

Merge branch 'trunk' into update/consolidate-social-state

12e563d

Fix up versions

0ac1e95

Remove unnecessary changelog

de290e9

manzoorwanijk marked this pull request as ready for review August 7, 2024 15:55

spsiddarthan reviewed Aug 8, 2024

View reviewed changes

projects/packages/publicize/src/class-publicize-script-data.php Show resolved Hide resolved

spsiddarthan reviewed Aug 9, 2024

View reviewed changes

manzoorwanijk added 4 commits August 9, 2024 14:00

Comment out unused code for now

f09fecc

Use in-package initialization of assets

0739b4e

Merge branch 'trunk' into update/consolidate-social-state

fe7faa7

Fix up versions

3c4201c

spsiddarthan reviewed Aug 9, 2024

View reviewed changes

projects/packages/publicize/actions.php Show resolved Hide resolved

Remove unused code for now

2190351

Correct the variable names

98d6408

spsiddarthan reviewed Aug 9, 2024

View reviewed changes

gmjuhasz reviewed Aug 9, 2024

View reviewed changes

manzoorwanijk added 2 commits August 9, 2024 23:04

Fix namespace

9bec185

Merge branch 'trunk' into update/consolidate-social-state

b9f3186

manzoorwanijk requested a review from gmjuhasz August 12, 2024 09:54

gmjuhasz approved these changes Aug 12, 2024

View reviewed changes

manzoorwanijk merged commit 065c5cb into trunk Aug 12, 2024
73 checks passed

manzoorwanijk deleted the update/consolidate-social-state branch August 12, 2024 11:00

github-actions bot removed the [Status] In Progress label Aug 12, 2024

manzoorwanijk mentioned this pull request Aug 13, 2024

Social | Initial State: Migrate URLs #38855

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Social: Consolidate social initial state #38606

Social: Consolidate social initial state #38606

manzoorwanijk commented Jul 30, 2024 •

edited

Loading

github-actions bot commented Jul 30, 2024 •

edited

Loading

spsiddarthan left a comment

spsiddarthan commented Aug 8, 2024

spsiddarthan left a comment

manzoorwanijk commented Aug 9, 2024

spsiddarthan left a comment •

edited

Loading

gmjuhasz left a comment

gmjuhasz Aug 9, 2024

manzoorwanijk Aug 9, 2024

gmjuhasz Aug 9, 2024

manzoorwanijk Aug 9, 2024

gmjuhasz Aug 9, 2024

manzoorwanijk Aug 9, 2024

manzoorwanijk commented Aug 9, 2024

gmjuhasz left a comment

		@@ -1,3 +1,12 @@
		export interface FeatureFlags {
		useAdminUiV1: boolean;

Social: Consolidate social initial state #38606

Social: Consolidate social initial state #38606

Conversation

manzoorwanijk commented Jul 30, 2024 • 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 Jul 30, 2024 • edited Loading

spsiddarthan left a comment

Choose a reason for hiding this comment

spsiddarthan commented Aug 8, 2024

spsiddarthan left a comment

Choose a reason for hiding this comment

manzoorwanijk commented Aug 9, 2024

spsiddarthan left a comment • edited Loading

Choose a reason for hiding this comment

gmjuhasz left a comment

Choose a reason for hiding this comment

gmjuhasz Aug 9, 2024

Choose a reason for hiding this comment

manzoorwanijk Aug 9, 2024

Choose a reason for hiding this comment

gmjuhasz Aug 9, 2024

Choose a reason for hiding this comment

manzoorwanijk Aug 9, 2024

Choose a reason for hiding this comment

gmjuhasz Aug 9, 2024

Choose a reason for hiding this comment

manzoorwanijk Aug 9, 2024

Choose a reason for hiding this comment

manzoorwanijk commented Aug 9, 2024

gmjuhasz left a comment

Choose a reason for hiding this comment

manzoorwanijk commented Jul 30, 2024 •

edited

Loading

github-actions bot commented Jul 30, 2024 •

edited

Loading

spsiddarthan left a comment •

edited

Loading