Social: Add UTM settings and toggles #39998

gmjuhasz · 2024-10-31T18:34:08Z

Fixes https://github.com/Automattic/jetpack-reach/issues/674

Proposed changes:

Adds a new setting and toggle for it to the Jetpack Social admin page and to Jetpack settings
This setting will be used to toggle the UTM params on the sites

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 JP settings and to the Social Admin page
Test that the toggle works as expected
Also check the option on the local backend

github-actions · 2024-10-31T18:35:05Z

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/social-utm-toggle branch.
To test on Simple, run the following command on your sandbox:
```
bin/jetpack-downloader test jetpack add/social-utm-toggle
```

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 · 2024-10-31T18:35:19Z

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:

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!

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.

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 · 2024-11-04T13:52:32Z

Instead of just a Boolean flag, should we make it an object like SIG settings with enabled being the only property for now? That will make it easier to add more related options in future.

Something like this

"jetpack_social_utm_config": {
    "enabled": true
}

projects/plugins/jetpack/class.jetpack-gutenberg.php

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

gmjuhasz · 2024-11-05T09:53:07Z

Instead of just a Boolean flag, should we make it an object like SIG settings with enabled being the only property for now? That will make it easier to add more related options in future.

Something like this
"jetpack_social_utm_config": {
    "enabled": true
}

Done in 4f590a2, thanks @manzoorwanijk

projects/plugins/jetpack/_inc/client/sharing/features/utm-toggle-section.jsx

manzoorwanijk

This works well. I just have an optional suggestion.

manzoorwanijk · 2024-11-06T06:03:26Z

projects/packages/publicize/src/jetpack-social-settings/class-settings.php

@@ -153,6 +187,7 @@ public function get_settings( $with_available = false ) {

 		$settings = array(
 			'socialImageGeneratorSettings' => $this->get_image_generator_settings(),
+			'utmSettings'                  => $this->get_utm_settings(),


I think this is no longer needed because this get_settings method is used only for the initial state. Removing this will also fix the failing PHP unit tests.

I'll remove it then I thought we still need it

I removed it, I'll give it another test if it works well but I'll finish the backend stuff first. If you get to test it before feel free to approve if looks good, thanks

Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

projects/plugins/social/src/js/components/utm-toggle/index.tsx

Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

projects/plugins/social/src/js/components/utm-toggle/index.tsx

Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

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

…es.ts Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

gmjuhasz added 2 commits October 31, 2024 19:33

Add the toggle and the backend setting

fceccba

changelog

365b1e7

github-actions bot added [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 Oct 31, 2024

gmjuhasz added 3 commits November 4, 2024 13:32

Merge branch 'trunk' into add/social-utm-toggle

3905750

Add toggle to Social Admin and Jetpack settings

5f3f0ce

changelog

8db6bee

github-actions bot added [JS Package] Publicize Components Admin Page React-powered dashboard under the Jetpack menu RNA labels Nov 4, 2024

gmjuhasz self-assigned this Nov 4, 2024

gmjuhasz requested a review from a team November 4, 2024 13:38

gmjuhasz changed the title ~~Add/social utm toggle~~ Social: Add UTM settings and toggles Nov 4, 2024

manzoorwanijk reviewed Nov 5, 2024

View reviewed changes

projects/plugins/jetpack/class.jetpack-gutenberg.php Outdated Show resolved Hide resolved

manzoorwanijk reviewed Nov 5, 2024

View reviewed changes

projects/plugins/social/src/class-jetpack-social.php Outdated Show resolved Hide resolved

gmjuhasz added 2 commits November 5, 2024 10:35

Remove from old initial state

fdd391f

Restructure data

4f590a2

gmjuhasz marked this pull request as ready for review November 5, 2024 09:53

gmjuhasz requested a review from manzoorwanijk November 5, 2024 09:53

manzoorwanijk reviewed Nov 5, 2024

View reviewed changes

projects/plugins/jetpack/_inc/client/sharing/features/utm-toggle-section.jsx Outdated Show resolved Hide resolved

manzoorwanijk previously approved these changes Nov 5, 2024

View reviewed changes

Fix types

c0c3a08

manzoorwanijk dismissed their stale review via c0c3a08 November 6, 2024 05:38

manzoorwanijk reviewed Nov 6, 2024

View reviewed changes

Use comma

e26bd3b

Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

manzoorwanijk reviewed Nov 6, 2024

View reviewed changes

projects/plugins/social/src/js/components/utm-toggle/index.tsx Outdated Show resolved Hide resolved

Update projects/plugins/social/src/js/components/utm-toggle/index.tsx

63e1541

Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

manzoorwanijk reviewed Nov 6, 2024

View reviewed changes

projects/plugins/social/src/js/components/utm-toggle/index.tsx Outdated Show resolved Hide resolved

gmjuhasz and others added 2 commits November 6, 2024 13:19

Update projects/plugins/social/src/js/components/utm-toggle/index.tsx

be2d4e3

Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

Remove unneeded file

31cffac

manzoorwanijk previously approved these changes Nov 7, 2024

View reviewed changes

Merge branch 'trunk' into add/social-utm-toggle

c4ae7e0

gmjuhasz dismissed manzoorwanijk’s stale review via c4ae7e0 November 7, 2024 10:35

manzoorwanijk reviewed Nov 7, 2024

View reviewed changes

projects/js-packages/publicize-components/src/social-store/types.ts Outdated Show resolved Hide resolved

Update projects/js-packages/publicize-components/src/social-store/typ…

6ec000f

…es.ts Co-authored-by: Manzoor Wani <manzoorwani.jk@gmail.com>

manzoorwanijk previously approved these changes Nov 7, 2024

View reviewed changes

Merge branch 'trunk' into add/social-utm-toggle

4dba240

manzoorwanijk dismissed their stale review via 4dba240 November 12, 2024 05:51

manzoorwanijk approved these changes Nov 12, 2024

View reviewed changes

gmjuhasz merged commit 7f938c8 into trunk Nov 12, 2024
60 checks passed

gmjuhasz deleted the add/social-utm-toggle branch November 12, 2024 09:01

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Social: Add UTM settings and toggles #39998

Social: Add UTM settings and toggles #39998

gmjuhasz commented Oct 31, 2024 •

edited

Loading

github-actions bot commented Oct 31, 2024 •

edited

Loading

github-actions bot commented Oct 31, 2024 •

edited

Loading

manzoorwanijk commented Nov 4, 2024 •

edited

Loading

gmjuhasz commented Nov 5, 2024

manzoorwanijk left a comment

manzoorwanijk Nov 6, 2024

gmjuhasz Nov 6, 2024

gmjuhasz Nov 6, 2024

Social: Add UTM settings and toggles #39998

Social: Add UTM settings and toggles #39998

Conversation

gmjuhasz commented Oct 31, 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 Oct 31, 2024 • edited Loading

github-actions bot commented Oct 31, 2024 • edited Loading

manzoorwanijk commented Nov 4, 2024 • edited Loading

gmjuhasz commented Nov 5, 2024

manzoorwanijk left a comment

Choose a reason for hiding this comment

manzoorwanijk Nov 6, 2024

Choose a reason for hiding this comment

gmjuhasz Nov 6, 2024

Choose a reason for hiding this comment

gmjuhasz Nov 6, 2024

Choose a reason for hiding this comment

gmjuhasz commented Oct 31, 2024 •

edited

Loading

github-actions bot commented Oct 31, 2024 •

edited

Loading

github-actions bot commented Oct 31, 2024 •

edited

Loading

manzoorwanijk commented Nov 4, 2024 •

edited

Loading