Offline Mode: Improve Post Settings #22863

kean · 2024-03-19T17:38:22Z

This PR improves Post Settings in multiple ways by introducing a child context as a scratchpad for changes. The only complication is due to the relationships. For example, when you add a category, its added in the viewContext, so we have to get the same object in the scratchpad.

Known Issues

In this PR, I want to make sure we get the bigger ideas right. There are a couple of known issues:

publicizeMessage and social integration not encoded in the patch parameters
Assertion when using "password protected" status from the standalone settings screen
Removing feature image doesn't work (needs to be set to "" instead of null)

I have a list of those and I suggest not focusing on the individual fields for now. We'll do a full test before merging the feature branch.

Changes

Update the navigation bar style in the Post Settings in the Editor
Add “Cancel” button to allow undoing the changes – extra peace of mind. Thanks to a child context, the app no longer needs to do anything to undo the changes.
"Save" button will now work based on the diff – same as in the standalone editor
Fix an issue with “Cancel” button being enable during save (production issue)
Remove "Done" button from the Tags screen (same behavior as back)

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-19.at.16.51.01.mp4

To test:

Verify that adding new categories works (important because blog still operates on viewContext, so it was a bit tricky to support): you can select new categories, add new categories, and the categories are pre-selected after re-opening the picker
Verify that passport-protected visibility does not crash in the standalone editor
Verify that you can cancel any change
Verify that "Save" is enabled only if there are any changes (undoing a change will disable the button)
Verify that if you dismiss the editor using a swipe gesture, the changes are not saved
Verify that if you open Post Settings from the Editor, make changes, and tap "Save", the changes are saved to the database (check by re-opening the settings)
Disable .syncPublishing feature flag and perform regression test of the settings

Known Issues

I'm planning to change how status updates from the Post Settings are handled in the upcoming PR

Regression Notes

Potential unintended areas of impact: n/a
What I did to test those areas of impact (or what existing automated tests I relied on): n/a
What automated tests I added (or what prevented me from doing so): n/a

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.

Testing checklist:

wpmobilebot · 2024-03-19T17:46:47Z

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

	App Name	WordPress Alpha
	Configuration	Release-Alpha
	Build Number	pr22863-cf313c6
	Version	24.5
	Bundle ID	org.wordpress.alpha
	Commit	`cf313c6`
	App Center Build	WPiOS - One-Offs #9274

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

wpmobilebot · 2024-03-19T17:47:21Z

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

	App Name	Jetpack Alpha
	Configuration	Release-Alpha
	Build Number	pr22863-cf313c6
	Version	24.5
	Bundle ID	com.jetpack.alpha
	Commit	`cf313c6`
	App Center Build	jetpack-installable-builds #8318

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

tiagomar · 2024-03-19T22:40:38Z

Hey @kean 👋
You're probably aware, but I was taking a look at the UI Tests failures and noticed they caught a crash while setting the Featured Image. The app consistently crashes right after selecting the image, I've tried:

Choose from Device
Take Photo
Choose from Media

kean · 2024-03-19T22:49:31Z

Hey, @tiagomar. Yeah, I've noticed it too. I moved the PR to draft and will try a slightly different approach tomorrow.

Btw, there are 4-6 UI tests we are planning to add in the scope of the project.

kean · 2024-03-20T01:14:13Z

We'll keep this change out of the scope for now. It's too risky, it deviates from the existing behavior too much, and is not necessarily required to fix the sync issues.

kean · 2024-03-22T00:33:31Z

WordPress/Classes/Services/PostCoordinator.swift

+    ///
+    /// - warning: Work-in-progress (kahu-offline-mode)
+    @MainActor
+    func _update(_ post: AbstractPost, changes: RemotePostUpdateParameters) async throws {


This is the simplest possible form of updating the post: send diff, update the original post with RemotePost from the server. Keeps the local revision intact. It'll be required in a few places when working with published posts.

kean · 2024-03-22T00:34:54Z

WordPress/Classes/ViewRelated/Post/PostSettingsViewController+FeaturedImageUpload.swift

@@ -73,12 +73,12 @@ extension PostSettingsViewController {
        guard let media = MediaCoordinator.shared.addMedia(from: asset, to: apost) else {
            return
        }
-        self.apost.featuredImage = media
+        self.apost.featuredImage = try? self.apost.managedObjectContext?.existingObject(with: TaggedManagedObjectID(media))


This is what I referred to in the description. When you add a featuredImage, it gets added to viewContext, so we have to get the instance in the temporary child context. The child context also automatically merges the changes from viewContext to allow the screen to show the updated status of the Media asset. This is probably the only complication with child contexts.

kean · 2024-03-22T00:35:27Z

WordPress/Classes/ViewRelated/Post/PostSettingsViewController+Swift.swift

+
+    /// - note: Deprecated (kahu-offline-mode)
+    private func _buttonSaveTapped() {
+        saveChangesToParentContext()


It's slightly different from the previous production behavior – it's now fully offline-first and it should be OK. It means that the "Save" is now also offline-first. I hope we don't even end up shipping this and be ready for 24.6 release.

kean · 2024-03-22T00:37:18Z

WordPress/Classes/ViewRelated/Post/PostSettingsViewController.m

-    if (self.isStandalone) {
-        if ((self.isBeingDismissed || self.parentViewController.isBeingDismissed) && !self.isStandaloneEditorDismissingAfterSave) {
-            // TODO: Implement it using a ViewModel or a child context to eliminate the risk of accidently saving the changes without uploading them
-            [self.apost.managedObjectContext refreshObject:self.apost mergeChanges:NO];


To discard the changes, you no longer need to do anything thanks to the child context. This is probably why it's really worth it – we no longer have to worry about accidentally saving the changes to the database without committing them to the server. This will be used in the upcoming changes.

momo-ozawa

@kean 👋 I tested the flows and found a few issues.

When I make changes to a post setting and go back to the editor, the "Update" button is disabled. Tapping the more button enables the "Update" button.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-28.at.14.19.50.mp4

Verify that password-protected visibility does not crash in the standalone editor

If I access post settings from the post list context menu, this flow crashes.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-28.at.14.25.50.mp4

If I access post settings from the editor, change to password protected visibility, I am not able to update my post with the new post settings.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-28.at.14.23.28.mp4

Verify that "Save" is enabled only if there are any changes (undoing a change will disable the button)

If I undo a change for tags, the "Save" button is not disabled.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-28.at.14.20.16.mp4

kean · 2024-03-28T16:02:46Z

When I make changes to a post setting and go back to the editor, the "Update" button is disabled. Tapping the more button enables the "Update" button.

It's a production issue. It's on my stretch-task list.

This has the same root cause:

If I access post settings from the editor, change to password protected visibility, I am not able to update my post with the new post settings.

If I access post settings from the post list context menu, this flow crashes.

I initially put it on the list of tests, but forgot to remove it once I decided not to fix it just yet. It's anther production issue. It's an assertion, so it doest' crash in production, but does in the debug mode.

If I undo a change for tags, the "Save" button is not disabled.

Looking into it – I'll push a fix.

kean · 2024-03-28T16:07:33Z

If I undo a change for tags, the "Save" button is not disabled.

Hmm, I can't reproduce it. I'll put in on the list to check and fix later.

kean · 2024-04-01T23:38:37Z

Closed in favor of #22934

kean requested a review from a team as a code owner March 19, 2024 17:38

kean added [Type] Task Offline Mode (Sync Issues) labels Mar 19, 2024

kean added this to the Pending milestone Mar 19, 2024

kean requested a review from momo-ozawa March 19, 2024 17:38

kean mentioned this pull request Mar 19, 2024

Offline Mode: Milestone 2 #22849

Merged

4 tasks

kean marked this pull request as draft March 19, 2024 20:33

kean removed the request for review from momo-ozawa March 19, 2024 20:33

kean closed this Mar 20, 2024

kean reopened this Mar 21, 2024

kean removed the request for review from a team March 21, 2024 23:45

kean force-pushed the task/simplify-post-settings branch from 3678f3a to b9e7b95 Compare March 21, 2024 23:45

kean marked this pull request as ready for review March 22, 2024 00:31

kean requested a review from momo-ozawa March 22, 2024 00:31

Update PostSettings screen to use child context

cf313c6

kean force-pushed the task/simplify-post-settings branch from b9e7b95 to cf313c6 Compare March 22, 2024 00:32

kean commented Mar 22, 2024

View reviewed changes

kean removed the request for review from momo-ozawa March 22, 2024 21:25

kean marked this pull request as draft March 22, 2024 21:25

kean marked this pull request as ready for review March 26, 2024 23:43

kean requested a review from momo-ozawa March 26, 2024 23:43

momo-ozawa reviewed Mar 28, 2024

View reviewed changes

kean requested a review from momo-ozawa April 1, 2024 14:28

kean marked this pull request as draft April 1, 2024 16:52

kean closed this Apr 1, 2024

momo-ozawa modified the milestones: Pending, 24.7 Apr 15, 2024

jkmassel deleted the task/simplify-post-settings branch July 26, 2024 18:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Offline Mode: Improve Post Settings #22863

Offline Mode: Improve Post Settings #22863

kean commented Mar 19, 2024 •

edited

Loading

wpmobilebot commented Mar 19, 2024 •

edited

Loading

wpmobilebot commented Mar 19, 2024 •

edited

Loading

tiagomar commented Mar 19, 2024

kean commented Mar 19, 2024

kean commented Mar 20, 2024

kean Mar 22, 2024

kean Mar 22, 2024

kean Mar 22, 2024

kean Mar 22, 2024 •

edited

Loading

momo-ozawa left a comment

kean commented Mar 28, 2024

kean commented Mar 28, 2024 •

edited

Loading

kean commented Apr 1, 2024

Offline Mode: Improve Post Settings #22863

Offline Mode: Improve Post Settings #22863

Conversation

kean commented Mar 19, 2024 • edited Loading

Known Issues

Changes

To test:

Known Issues

Regression Notes

wpmobilebot commented Mar 19, 2024 • edited Loading

wpmobilebot commented Mar 19, 2024 • edited Loading

tiagomar commented Mar 19, 2024

kean commented Mar 19, 2024

kean commented Mar 20, 2024

kean Mar 22, 2024

Choose a reason for hiding this comment

kean Mar 22, 2024

Choose a reason for hiding this comment

kean Mar 22, 2024

Choose a reason for hiding this comment

kean Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

momo-ozawa left a comment

Choose a reason for hiding this comment

kean commented Mar 28, 2024

kean commented Mar 28, 2024 • edited Loading

kean commented Apr 1, 2024

kean commented Mar 19, 2024 •

edited

Loading

wpmobilebot commented Mar 19, 2024 •

edited

Loading

wpmobilebot commented Mar 19, 2024 •

edited

Loading

kean Mar 22, 2024 •

edited

Loading

kean commented Mar 28, 2024 •

edited

Loading