Social: Fix media validation deadlock #38933

gmjuhasz · 2024-08-16T14:29:11Z

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

Proposed changes:

Show the post form if
- There are enabled connections
- There is any attached media
- There is any media validation error - to combat the issue of not showing the form with the no media error

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/Automattic/jetpack-reach/issues/478

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

Testing instructions:

Go to the post editor and check the following scenarios:

Go to an already published post and have only an Instagram connection

If SIG is off you cannot turn the connection on because it's disabled because of the no media error - deadlock. With this change the media picker should be shown so you can upload media

Go to an already published post and add a media that is invalid for all connections

All connections should get disabled, a warning is shown and you are in a deadlock on trunk. With this change the media picker should be visible, so you can remove the image from it

Go to an already published post that has no errors and no media.

The form should not be shown

github-actions · 2024-08-16T14:30:11Z

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 fix/social-media-validation-deadlock branch.

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

bin/jetpack-downloader test jetpack fix/social-media-validation-deadlock

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-08-16T14:30:29Z

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!

manzoorwanijk · 2024-08-21T11:21:55Z

projects/js-packages/publicize-components/src/components/form/index.tsx

+		isPublicizeEnabled &&
+		( hasEnabledConnections ||
+			attachedMedia.length > 0 ||
+			( Object.keys( validationErrors ).length !== 0 && ! isConvertible ) );


In what case will there be no validation errors when the media is not convertible?

I mean if the media is not convertible, won't there already be validation errors?

Good point.

So you say we should only look for ! isConvertible in that part of the logic?

I am not sure but my concern is that if the media is not convertible, we should already show/have validation errors. If that is not the case then we may need to fix that first, otherwise, yes, we may only look for ! isConvertible in that part of the logic.

I am not sure but my concern is that if the media is not convertible, we should already show/have validation errors.

Yeah we do, I think it's true that if something is not convertible, that means we have at least 1 error

Cool. Thank you for the confirmation.

We only use that here too: MediaValidationNotices I'll update that

manzoorwanijk · 2024-08-21T11:24:31Z

projects/js-packages/publicize-components/src/components/form/index.tsx

+	const { attachedMedia } = useAttachedMedia();
+	const featuredImageId = useFeaturedImage();
+
+	const mediaId = attachedMedia[ 0 ]?.id || featuredImageId;


Why should featured image be a part of this logic?

I thought that if the featured image is invalid, you still get the deadlock in the editor on the jetpack tab, until you remove the featured image. If we use it here, they can also use the attached media to upload a working image without having to change the featured image. What do you think?

Fair enough. Thank you for the explanation.

manzoorwanijk · 2024-08-21T17:09:53Z

projects/js-packages/publicize-components/src/components/form/index.tsx

+	const { isConvertible } = useMediaRestrictions( connections, useMediaDetails( mediaId )[ 0 ] );
+
+	const showSharePostForm =
+		isPublicizeEnabled && ( hasEnabledConnections || attachedMedia.length > 0 || ! isConvertible );


isConvertible is false if there is no media attached. Thus ! isConvertible becomes true.

That means, the SharePostForm is visible by default, which is not the case on trunk.

So we need the full logic as before

May be we don't need to use isConvertible here?

I think we do because otherwise we would show the modal even if the media is invalid but convertible. For example the featured image is too big, but can be converted, in that case I think we do not need it 🤔 This logic starts to get fiddly

Yeah, this logic is going to be difficult to untangle in future.

May be we can add explanatory comments to that code.

manzoorwanijk

Works good

* Show SharePostForm if there is attached media * changelog * Show form if there is any validation error * Use only !isConvertible * Use validationErrors * Add a small comment to explain why we do that

gmjuhasz added 2 commits August 16, 2024 16:28

Show SharePostForm if there is attached media

0628513

changelog

a9724e1

github-actions bot added [JS Package] Publicize Components [Status] In Progress RNA labels Aug 16, 2024

gmjuhasz added 2 commits August 21, 2024 13:04

Merge branch 'trunk' into fix/social-media-validation-deadlock

ae7c3d0

Show form if there is any validation error

0e3167c

gmjuhasz changed the title ~~Fix/social media validation deadlock~~ Social: Fix media validation deadlock Aug 21, 2024

gmjuhasz requested a review from a team August 21, 2024 11:17

gmjuhasz self-assigned this Aug 21, 2024

gmjuhasz added the [Status] Needs Team Review label Aug 21, 2024

gmjuhasz marked this pull request as ready for review August 21, 2024 11:20

manzoorwanijk reviewed Aug 21, 2024

View reviewed changes

Use only !isConvertible

a806222

manzoorwanijk reviewed Aug 21, 2024

View reviewed changes

gmjuhasz added 3 commits August 22, 2024 14:12

Use validationErrors

9f3c520

Merge branch 'trunk' into fix/social-media-validation-deadlock

3f27ace

Add a small comment to explain why we do that

0eb7571

manzoorwanijk approved these changes Aug 27, 2024

View reviewed changes

gmjuhasz enabled auto-merge (squash) August 28, 2024 12:55

gmjuhasz disabled auto-merge August 28, 2024 12:55

Merge branch 'trunk' into fix/social-media-validation-deadlock

3e475dd

gmjuhasz enabled auto-merge (squash) August 28, 2024 12:56

gmjuhasz merged commit a1da228 into trunk Aug 28, 2024
59 checks passed

gmjuhasz deleted the fix/social-media-validation-deadlock branch August 28, 2024 13:07

github-actions bot removed [Status] In Progress [Status] Needs Team Review labels Aug 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Social: Fix media validation deadlock #38933

Social: Fix media validation deadlock #38933

gmjuhasz commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024

manzoorwanijk Aug 21, 2024 •

edited

Loading

gmjuhasz Aug 21, 2024

gmjuhasz Aug 21, 2024

manzoorwanijk Aug 21, 2024

gmjuhasz Aug 21, 2024

manzoorwanijk Aug 21, 2024

gmjuhasz Aug 21, 2024

manzoorwanijk Aug 21, 2024

gmjuhasz Aug 21, 2024

manzoorwanijk Aug 21, 2024

manzoorwanijk Aug 21, 2024

gmjuhasz Aug 22, 2024

manzoorwanijk Aug 23, 2024

gmjuhasz Aug 23, 2024

manzoorwanijk Aug 23, 2024

manzoorwanijk left a comment

Social: Fix media validation deadlock #38933

Social: Fix media validation deadlock #38933

Conversation

gmjuhasz commented Aug 16, 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 Aug 16, 2024 • edited Loading

github-actions bot commented Aug 16, 2024

manzoorwanijk Aug 21, 2024 • edited Loading

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

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

Choose a reason for hiding this comment

manzoorwanijk left a comment

Choose a reason for hiding this comment

gmjuhasz commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

manzoorwanijk Aug 21, 2024 •

edited

Loading