feat: Retry failed media uploads when re-establishing network connection #19803

dcalhoun · 2023-12-15T21:58:15Z

Description

Improve the media upload experience in the post editor by automatically retrying
failed uploads when re-establishing network connectivity.

Fixes wordpress-mobile/gutenberg-mobile#6406.

Testing Instructions

When network connectivity is available

Launch the editor.
Add several media blocks, attaching media to the blocks.
Disconnect your device network connection.
Note the failed state of media uploads.
Connect your device network connection.
Verify the media uploads automatically restart and succeed.

When network connectivity is unavailable

Launch the editor.
Add several media blocks, attaching media to the blocks.
Note the failed state of media uploads.
Connect your device network connection.
Verify the media uploads automatically restart and succeed.

Regression Notes

Potential unintended areas of impact
Editor media uploads, editor launch, writing flow.
What I did to test those areas of impact (or what existing automated tests I relied on)
Insert and interact with various blocks using the editor.
What automated tests I added (or what prevented me from doing so)
None, lack of familiarity with the testing stack.

PR submission checklist:

I have completed the Regression Notes.
I have considered adding unit tests for my changes.
I have considered adding accessibility improvements for my changes.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

UI Changes testing checklist:

Portrait and landscape orientations.
Light and dark modes.
Fonts: Larger, smaller and bold text.
High contrast.
VoiceOver.
Languages with large words or with letters/accents not frequently used in English.
Right-to-left languages. (Even if translation isn’t complete, formatting should still respect the right-to-left layout)
iPhone and iPad.
Multi-tasking: Split view and Slide over. (iPad)

Improve the media upload UX by automatically retrying failed uploads.

dcalhoun · 2023-12-15T22:06:18Z

libs/editor/src/main/java/org/wordpress/android/editor/gutenberg/GutenbergEditorFragment.java

@@ -1583,5 +1583,9 @@ public void onGutenbergDialogNegativeClicked(@NonNull String instanceTag) {
    @Override
    public void onConnectionStatusChange(boolean isConnected) {
        getGutenbergContainerFragment().onConnectionStatusChange(isConnected);
+        if (hasFailedMediaUploads()) {
+            mEditorFragmentListener.onMediaRetryAll(mFailedMediaIds);
+            mFailedMediaIds.clear();


Not sure clearing this is necessary, it does not appear to be done elsewhere, e.g., showRetryMediaUploadDialog. This clear was added in an attempt to fix erroneously displayed errors after saving or publishing a post, but it does not appear to work.

Error screenshot

Steps to reproduce

Use the prototype build on this PR.

Disable network connectivity.

Add an Image block and attach media.

Enable network connectivity.

Allow the automatic retry of media upload to finish successfully.

Save and close the post.

Note the failed media upload notification.

It appears as though a lingering error state/message is in place, but I am unable to find where that is or how to clear it. I expected onMediaRetryAll to clear it, but it doesn't appear to be doing so.

👋🏻 @antonis. Randomly pinging you for Android expertise and help. 😄 Would you be willing to help me debug why I might see this error when the media attached to the post actually successfully uploads with the new retry logic?

After testing the existing functionality of retrying failing media uploads via the dialog presented when tapping a failed image, it appears the lingering error message is a preexisting issue. Semi-related issues are reported in #11039, #15897, and #13427.

Steps to reproduce

Use the latest Play Store app version.

Disable network connectivity.

Add an Image block and attach media.

Enable network connectivity.

Tap the Image block with a failed upload.

Tap "Retry."

After the media finishes uploading successfully, save and close the post.

Note the failed media upload notification.

Therefore, I do not consider this issue blocking. It'd be nice to resolve, but could be done so in a separate PR later.

@antonis please do not feel like it is a priority to help debug this. Thanks!

Not sure clearing this is necessary

Removing the clearing with c114528 and the reasoning for it sounds good 👍

Therefore, I do not consider this issue blocking. It'd be nice to resolve, but could be done so in a separate PR later.

I was able to reproduce this issue and tried to figure out why this happens. My understanding is that there is a limitation on how the SnackbarSequencer works were this kind of internal notifications are not really canceled once issued. I agree that this can be investigated further and handled in a follow up PR 👍

Thank you for investigating and sharing your insights and perspective. Very helpful! 🙇🏻‍♂️

wpmobilebot · 2023-12-15T22:17:30Z

📲 You can test the changes from this Pull Request in Jetpack by scanning the QR code below to install the corresponding build.

	App Name	Jetpack
	Flavor	Jalapeno
	Build Type	Debug
	Version	pr19803-d459991
	Commit	`d459991`
	Direct Download	`jetpack-prototype-build-pr19803-d459991.apk`

Note: Google Login is not supported on these builds.

wpmobilebot · 2023-12-15T22:17:43Z

📲 You can test the changes from this Pull Request in WordPress by scanning the QR code below to install the corresponding build.

	App Name	WordPress
	Flavor	Jalapeno
	Build Type	Debug
	Version	pr19803-d459991
	Commit	`d459991`
	Direct Download	`wordpress-prototype-build-pr19803-d459991.apk`

Note: Google Login is not supported on these builds.

We will enable the feature in production once all project work is completed.

This was originally added in an attempt to clear an unexpected "failed media upload" notification displayed after closing the editor. However, it did not resolve that issue, it must originate from some other location. Additionally, it would appears successful media uploads already manage removing media IDs from the `mFailedMediaIds` collection.

libs/editor/src/main/java/org/wordpress/android/editor/gutenberg/GutenbergEditorFragment.java

antonis

Thank you for fixing this @dcalhoun 🙇
I tested the implementation in debug mode (47df150) and the app performed as expected. The code also looks good and I only added a minor suggestion 🎉
Overall I think this is an improvement to the current user experience when uploads fail 🏅

Retrying media uploads without a network connection will undoubtedly fail again. Co-authored-by: Antonis Lilis <[email protected]>

derekblank

I tested this feature successfully on an internal build, and automated retries are working. Also confirmed that the feature is not active on non-debug/internal builds. 🚀

I removed the RELEASE-NOTES entry, keeping with the precedent that we will add public-facing release notes when the DEBUG flag is removed for this feature.

feat: Retry failed media uploads when re-establishing network connection

0550cc5

Improve the media upload UX by automatically retrying failed uploads.

dcalhoun added [Type] Enhancement Media Gutenberg Editing and display of Gutenberg blocks. labels Dec 15, 2023

docs: Add release note

be1c1f8

dcalhoun commented Dec 15, 2023

View reviewed changes

dcalhoun added 2 commits December 16, 2023 07:35

feat: Limit automatic upload retries to debug builds

47df150

We will enable the feature in production once all project work is completed.

dcalhoun added this to the 24.0 milestone Dec 16, 2023

dcalhoun marked this pull request as ready for review December 16, 2023 13:09

dcalhoun requested a review from derekblank December 16, 2023 13:09

antonis self-requested a review December 18, 2023 06:55

antonis reviewed Dec 19, 2023

View reviewed changes

libs/editor/src/main/java/org/wordpress/android/editor/gutenberg/GutenbergEditorFragment.java Outdated Show resolved Hide resolved

antonis approved these changes Dec 19, 2023

View reviewed changes

dcalhoun and others added 2 commits December 19, 2023 10:49

feat: Only retry media uploads if a network connection is available

3fb85a3

Retrying media uploads without a network connection will undoubtedly fail again. Co-authored-by: Antonis Lilis <[email protected]>

Merge branch 'trunk' into feat/automatically-retry-pending-media-uploads

d459991

derekblank approved these changes Dec 27, 2023

View reviewed changes

derekblank merged commit c719762 into trunk Dec 28, 2023
20 checks passed

derekblank deleted the feat/automatically-retry-pending-media-uploads branch December 28, 2023 08:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Retry failed media uploads when re-establishing network connection #19803

feat: Retry failed media uploads when re-establishing network connection #19803

dcalhoun commented Dec 15, 2023 •

edited

Loading

dcalhoun Dec 15, 2023 •

edited

Loading

dcalhoun Dec 16, 2023 •

edited

Loading

antonis Dec 19, 2023

dcalhoun Dec 19, 2023

wpmobilebot commented Dec 15, 2023 •

edited

Loading

wpmobilebot commented Dec 15, 2023 •

edited

Loading

antonis left a comment

derekblank left a comment

feat: Retry failed media uploads when re-establishing network connection #19803

feat: Retry failed media uploads when re-establishing network connection #19803

Conversation

dcalhoun commented Dec 15, 2023 • edited Loading

Description

Testing Instructions

When network connectivity is available

When network connectivity is unavailable

Regression Notes

dcalhoun Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

dcalhoun Dec 16, 2023 • edited Loading

Choose a reason for hiding this comment

antonis Dec 19, 2023

Choose a reason for hiding this comment

dcalhoun Dec 19, 2023

Choose a reason for hiding this comment

wpmobilebot commented Dec 15, 2023 • edited Loading

wpmobilebot commented Dec 15, 2023 • edited Loading

antonis left a comment

Choose a reason for hiding this comment

derekblank left a comment

Choose a reason for hiding this comment

dcalhoun commented Dec 15, 2023 •

edited

Loading

dcalhoun Dec 15, 2023 •

edited

Loading

dcalhoun Dec 16, 2023 •

edited

Loading

wpmobilebot commented Dec 15, 2023 •

edited

Loading

wpmobilebot commented Dec 15, 2023 •

edited

Loading