Social: Use core endpoint for dismissing notices #34544

gmjuhasz · 2023-12-08T14:19:20Z

This change updates our notice dismissal logic, so it uses register_setting and the core endpoint coming with it.
We have to support the deprecated Jetpack endpoint, so I flagged that with the current versions so we can get rid of it 3 versions later.

Proposed changes:

Added the handler class + tests
Changed the initial states so they use the new getter

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

https://github.com/orgs/Automattic/projects/733/views/2?pane=issue&itemId=46761193

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

No.

Testing instructions:

Delete the dismissed_notices with jetpack docker wp option delete jetpack_social_dismissed_notices
With auto-conversion being on, create a new post and upload a 10Mb jpg image which should be invalid but convertible. You should see the notice that it will be converted.
Click Got it, then refresh the page and select the image again. You should not see the notice anymore

Remove the advanced plan.

Go to the editor and dismiss the advancedPlan upgrade nudge
Make sure both are stored correctly in the option

jetpack docker wp option get jetpack_social_dismissed_notices
You can also check it from the console: https://developer.wordpress.com/docs/api/console/
Run a query like this with your site ID:

github-actions · 2023-12-08T14:20:13Z

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 refactor/social-dismissed-notices-endpoint branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack refactor/social-dismissed-notices-endpoint

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 · 2023-12-08T14:20: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.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for February 6, 2024 (scheduled code freeze on February 5, 2024).

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

Social plugin:

Next scheduled release: February 6, 2024.
Scheduled code freeze: January 29, 2024.

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

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

projects/plugins/jetpack/_inc/lib/admin-pages/class-jetpack-redux-state-helper.php

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

manzoorwanijk

This works well. I just have some optional code suggestions/questions.

manzoorwanijk

Thank you for making the suggested changes. This looks good now.

manzoorwanijk · 2023-12-15T13:25:19Z

projects/js-packages/publicize-components/src/components/form/validation-notice.tsx

 } ) => {
-	return (
+	return shouldAutoConvert ? null : (


Thank you for making this change.

This change was cherry picked in #34730 as a quick fix for the issue

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

spsiddarthan

This tests well, Geri! Requesting @pablinos to glance over it as well to make sure there is nothing glaring.

spsiddarthan · 2024-01-09T14:38:43Z

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

@@ -62,8 +55,8 @@ public function update_dismissed_notices( $updated, $name, $value ) {
 			return $updated;
 		}

-		$notice            = $value['notice'];
-		$reappearance_time = $value['reappearance_time'];
+		$notice            = key( $value );


Am I correct in saying that $updated is true or false, $name is the option name and $value is ['instagram' => 0]?

If that's the case, $notice would be instagram .

reappearance_time would be $value['notice'] which is 0.

I am bit confused by this change, could you please elaborate why we would need this?

Sure!

The first part of the change (f7eb8bc#diff-b9af7ea1c5d7705e15c3aa19241ee6e3f3b8090af8977a9951def8e88907d2d9R31) is to fix the schema, as the previous one would describe our format poorly. We want the option to store an array with key->value pairs, where the key is the name of the notice, and the value is a numeric value, which is the reappearance time.

The second part (f7eb8bc#diff-5f1e74f983a6c97e6afd793e071e2b976f2f14616174253e77739c59e07de12eR63) was to modify the UI to send the data in this format. That means that for Instagram, it would send jerpack_social_dismissed_notices: { Instagram: 0}, which means that we want to update the registered setting jerpack_social_dismissed_notices, with the value of { Instagram: 0}.

The third part of the change is where your comment lies, where value would be as you said, and the notice variable stores the name, and the reappearance_time is the number. Then we add it to the array $dismissed_notices[ $notice ] = $reappearance_time; and update the option

Testing it with the API console as in the testing instructions should show if it's working well

gmjuhasz added 5 commits December 8, 2023 14:49

Add handler class + tests

869704f

Update initial states

ea87733

Update frontend + register the setting

7226560

Flag jetpack endpoint as deprecated

4927895

changelog

3088684

gmjuhasz added the [Status] Needs Team Review label Dec 8, 2023

gmjuhasz requested a review from a team December 8, 2023 14:19

gmjuhasz self-assigned this Dec 8, 2023

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 [Tests] Includes Tests RNA labels Dec 8, 2023

manzoorwanijk reviewed Dec 13, 2023

View reviewed changes

projects/packages/publicize/src/jetpack-social-settings/class-dismissed-notices.php Outdated Show resolved Hide resolved

manzoorwanijk reviewed Dec 13, 2023

View reviewed changes

projects/plugins/jetpack/_inc/lib/admin-pages/class-jetpack-redux-state-helper.php Outdated Show resolved Hide resolved

manzoorwanijk reviewed Dec 13, 2023

View reviewed changes

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

manzoorwanijk previously approved these changes Dec 13, 2023

View reviewed changes

gmjuhasz added 3 commits December 13, 2023 14:57

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

92b6494

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

d7a5dbd

Use tags

8242bd4

gmjuhasz dismissed manzoorwanijk’s stale review via 8242bd4 December 14, 2023 09:23

gmjuhasz requested a review from manzoorwanijk December 14, 2023 09:23

gmjuhasz added 4 commits December 15, 2023 09:59

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

4c2c9da

Use self method

8c38dd4

Fixed validation message issue

16fa93a

Fixup versions

916c804

manzoorwanijk previously approved these changes Dec 15, 2023

View reviewed changes

gmjuhasz added 2 commits December 18, 2023 09:58

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

129f067

Remove change for Jetpack notices

9b32abc

gmjuhasz dismissed manzoorwanijk’s stale review via 9b32abc December 18, 2023 09:00

manzoorwanijk previously approved these changes Dec 19, 2023

View reviewed changes

spsiddarthan reviewed Dec 19, 2023

View reviewed changes

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

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

gmjuhasz added 2 commits January 3, 2024 10:24

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

8c2dc93

Fixup versions

1b10ed1

gmjuhasz dismissed manzoorwanijk’s stale review via 1b10ed1 January 3, 2024 09:26

gmjuhasz added 2 commits January 4, 2024 09:22

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

479c019

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

98c2355

spsiddarthan reviewed Jan 4, 2024

View reviewed changes

gmjuhasz added 2 commits January 8, 2024 09:23

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

abd7a2c

Fixup versions

aaa3032

spsiddarthan previously approved these changes Jan 8, 2024

View reviewed changes

gmjuhasz added 2 commits January 9, 2024 10:36

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

fe66b85

Update schema validator

f7eb8bc

gmjuhasz dismissed spsiddarthan’s stale review via f7eb8bc January 9, 2024 10:34

Update tests

532c56f

spsiddarthan reviewed Jan 9, 2024

View reviewed changes

spsiddarthan approved these changes Jan 10, 2024

View reviewed changes

Merge branch 'trunk' into refactor/social-dismissed-notices-endpoint

b09839e

gmjuhasz merged commit 24f1872 into trunk Jan 17, 2024
56 checks passed

gmjuhasz deleted the refactor/social-dismissed-notices-endpoint branch January 17, 2024 09:15

github-actions bot removed the [Status] Needs Team Review label Jan 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Social: Use core endpoint for dismissing notices #34544

Social: Use core endpoint for dismissing notices #34544

gmjuhasz commented Dec 8, 2023 •

edited

Loading

github-actions bot commented Dec 8, 2023 •

edited

Loading

github-actions bot commented Dec 8, 2023 •

edited

Loading

manzoorwanijk left a comment

manzoorwanijk left a comment

manzoorwanijk Dec 15, 2023

manzoorwanijk Dec 20, 2023

spsiddarthan left a comment

spsiddarthan Jan 9, 2024

gmjuhasz Jan 9, 2024

gmjuhasz Jan 9, 2024

Social: Use core endpoint for dismissing notices #34544

Social: Use core endpoint for dismissing notices #34544

Conversation

gmjuhasz commented Dec 8, 2023 • 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 Dec 8, 2023 • edited Loading

github-actions bot commented Dec 8, 2023 • edited Loading

manzoorwanijk left a comment

Choose a reason for hiding this comment

manzoorwanijk left a comment

Choose a reason for hiding this comment

manzoorwanijk Dec 15, 2023

Choose a reason for hiding this comment

manzoorwanijk Dec 20, 2023

Choose a reason for hiding this comment

spsiddarthan left a comment

Choose a reason for hiding this comment

spsiddarthan Jan 9, 2024

Choose a reason for hiding this comment

gmjuhasz Jan 9, 2024

Choose a reason for hiding this comment

gmjuhasz Jan 9, 2024

Choose a reason for hiding this comment

gmjuhasz commented Dec 8, 2023 •

edited

Loading

github-actions bot commented Dec 8, 2023 •

edited

Loading

github-actions bot commented Dec 8, 2023 •

edited

Loading