[L] Native editor Voice Over support
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Seddon
	Oct 2 2023, 1:42 PM

Description

PR: https://github.com/wikimedia/wikipedia-ios/pull/4521
PR: https://github.com/wikimedia/wikipedia-ios-components/pull/9 (since we've already migrated to a monorepo, this work will need porting over)

Requirements:

Add feature flag
Add container view controller around source editor component
Adds localized and Voice Over accessibility strings injection
Adds unit tests and UI tests
Ensure init sites updated with injected localized strings

Engineering notes #1 [PR: https://github.com/wikimedia/wikipedia-ios/pull/4521] :

This PR adds the native editor feature flag and implements the initial pieces of it within PageEditorViewController. I also added a full source edit button in ArticleViewController, so that we can test performance against a large set of wikitext as we build this. The entry point of this full source edit button is likely to change before release, though.

Note I found a bug in the default automatic theme switching in this branch. Marking as draft while I look into that.

Test Steps
In the Staging scheme, load the article editor, either by tapping the full source "Edit" button at the top of an article or any edit pencil.
Text formatting toolbars and input views should display like our Code Mirror editor, though state logic in the Find and Replace toolbar view will act wrong. I will fix this in a separate find & replace PR later on.

Engineering notes #2 [PR: https://github.com/wikimedia/wikipedia-ios-components/pull/9] :

This PR does a few things:

Updates the source editor components to reference a WKSourceEditorLocalizedStrings struct of strings instead of internally hardcoding them. This will allow us to inject localized strings from our client app.

Note that though the struct is injected at the public view model init point, I am referencing the strings internally like a singleton (label.text = WKSourceEditorLocalizedStrings.current.inputViewParagraph). I felt like it was nice to have the localized strings for a whole feature in one easy to read (though large) struct, instead of split up across several different view models. Referencing the singleton internally also allowed me to avoid passing the strings around everywhere in method parameters throughout the feature, which felt distracting. But it still feels a bit weird and could cause potential reuse issues down the line, so I'm definitely open to changes here.
This also adds Voice Over accessibility labels everywhere, using the same pattern.

This adds unit tests and UI tests that can be run locally (WKSourceEditorTests and WKSourceEditorUITests). Note that there isn't any CI set up for this, but maybe we can discuss adding Xcode Cloud integration if we like these. For UI tests, I had to add accessibility identifiers on certain elements, which were added in a similar pattern as WKSourceEditorLocalizedStrings.

This PR is ready to review, but is a breaking change against the client app and how wikimedia/wikipedia-ios#4521 is instantiating the source editor. Since that PR is already in progress, I am marking this PR as draft until that is merged.

Testing Notes

The only thing testable with this chunk of work is Voice Over support - everything else here foundational has already been tested in the other tickets.

Related Objects
Search...

Status	Assigned	Task
Open	None	T344258 [Main Epic] 2023-2024 Enhancements to Editing on the iOS app
Open	None	T344282 [Sub Epic] Make the iOS editor native
Resolved	JTannerWMF	T347870 [L] Native editor Voice Over support

Event Timeline

This task is splitting out already initiated under T331936 that is currently already going through code review.

Seddon assigned this task to Tsevener.Oct 2 2023, 1:43 PM

Seddon moved this task from Tasks from Product Backlog to Needs Code Review on the iOS Release FY2023-24 (Archive) board.

Seddon renamed this task from [Task] Native editor feature flag and container view controller to [Task] Native editor feature flag, container view controller and components.Oct 3 2023, 1:22 AM

Seddon updated the task description. (Show Details)

Seddon updated the task description. (Show Details)Oct 3 2023, 1:29 AM

Seddon mentioned this in T347925: [Task] Reading controls popover support and bold / italics formatting.Oct 3 2023, 2:40 AM

Seddon mentioned this in T347928: [Task] Add formatting options to NativeEditor tool bar.Oct 3 2023, 3:37 AM

Seddon removed a project: Epic.Oct 3 2023, 9:11 PM

Seddon mentioned this in T348072: [Sub Task] Add more text style formatting functions to NativeEditor toolbar.Oct 3 2023, 9:45 PM

Seddon mentioned this in T348073: [Sub Task] Add paragraph/header formatting functions to NativeEditor toolbar.

Seddon mentioned this in T348074: [Sub Task] Add template formatting functions.Oct 3 2023, 9:50 PM

Seddon mentioned this in T348088: [Sub Task] Add undo/redo buttons to NativeEditor.Oct 4 2023, 12:59 AM

Seddon mentioned this in T348089: [Sub Task] Add clear formatting functionality to NativeEditor.Oct 4 2023, 2:02 AM

Seddon removed a project: iOS Release FY2023-24 (Archive).Oct 4 2023, 5:30 PM

Seddon moved this task from Needs Triage to Engineering Backlog on the Wikipedia-iOS-App-Backlog board.Oct 13 2023, 12:15 PM

Seddon triaged this task as Low priority.Oct 13 2023, 2:12 PM

Tsevener reassigned this task from Tsevener to Mazevedo.Oct 31 2023, 6:47 PM

Tsevener added a project: iOS Release FY2023-24 (Archive).

Tsevener moved this task from Needs Code Review to Doing on the iOS Release FY2023-24 (Archive) board.

Tsevener subscribed.

PR https://github.com/wikimedia/wikipedia-ios/pull/4682

Mazevedo moved this task from Needs Code Review to Waiting for Build on the iOS Release FY2023-24 (Archive) board.Dec 5 2023, 10:26 PM

Tsevener removed Mazevedo as the assignee of this task.Dec 5 2023, 11:05 PM

Tsevener added a subscriber: Mazevedo.

Can be tested in TestFlight Experimental build 7.4.6 (60).

Not much user-facing here besides Voice Over support for all the keyboard buttons. I'm going to move this into Needs Design Review.

Tsevener moved this task from Waiting for Build to Needs Design Review on the iOS Release FY2023-24 (Archive) board.Dec 5 2023, 11:18 PM

@OTichonova Something we need to know is what Voice Over accessibility labels you would like for all of the keyboard buttons.

For example:

In our current editor, the bold button says "Add Bold Formatting, button" for an unselected state, and "selected, Remove Bold Formatting, button" for a selected state.

The Notes app says "Bold, button" when in an unselected state, and "selected, Bold, button" when in a selected state.

Hi @Tsevener,
Looking through Slack and Notes apps I think we can get rid of 'add' and/or 'remove' and have it as you mentioned above so it is not redundant when selecting options from the text formatting menu.

I am wondering whether it might be helpful to have it slightly different when selecting text formatting options from the toolbar rather than the menu. We can have 'Bold text formatting, Button' and 'selected, bold text formatting, button' when people tap the options from the toolbar. Eg. When you double tap and select a word you will have 'bold' and 'italics' as options in the toolbar.

The thought process being:

When people select the text formatting menu it reads it out to you, but you don't have that added context when you are selecting these options directly from the toolbar above the keyboard.

Links: 'Writing great accessibility labels'

OTichonova moved this task from Needs Design Review to Ready for Development on the iOS Release FY2023-24 (Archive) board.Dec 18 2023, 8:32 PM

Tsevener raised the priority of this task from Low to Medium.Jan 19 2024, 9:41 PM

Seddon moved this task from Ready for Development to Needs Engineering Sync on the iOS Release FY2023-24 (Archive) board.Jan 24 2024, 3:17 PM

OTichonova moved this task from Needs Engineering Sync to Ready for Development on the iOS Release FY2023-24 (Archive) board.Jan 24 2024, 3:38 PM

OTichonova moved this task from Ready for Development to Needs Engineering Sync on the iOS Release FY2023-24 (Archive) board.

Seddon renamed this task from [Task] Native editor feature flag, container view controller and components to [L] Native editor feature flag, container view controller and components.Jan 25 2024, 6:27 PM

Seddon moved this task from Needs Engineering Sync to Ready for Development on the iOS Release FY2023-24 (Archive) board.

Tsevener claimed this task.Jan 29 2024, 10:06 PM

Tsevener moved this task from Ready for Development to Doing on the iOS Release FY2023-24 (Archive) board.

https://github.com/wikimedia/wikipedia-ios/pull/4730

Tsevener moved this task from Doing to Needs Code Review on the iOS Release FY2023-24 (Archive) board.Jan 30 2024, 3:57 AM

Tsevener removed Tsevener as the assignee of this task.Jan 30 2024, 8:06 AM

Tsevener moved this task from Needs Code Review to Needs Design Review on the iOS Release FY2023-24 (Archive) board.

Changes addressing https://phabricator.wikimedia.org/T347870#9400922 are ready for design review. Thanks @OTichonova!

Hi @Tsevener!
This might be an issue on my side but I noticed that when voiceover is on and I either switch to the app, go back to the editor after opening and closing 'Find and replace' and/or 'insert media' the editor freezes for multiple seconds and I can't tap anything. You can see in the videos times that there are times when the cursor is just blinking but nothing is happening those are the times when I was tapping but the app wasn't responding.

Switching over to the app-> Video

Going back to the editor after opening and closing 'Insert media' -> Video

OTichonova moved this task from Needs Design Review to Ready for Development on the iOS Release FY2023-24 (Archive) board.Jan 30 2024, 11:47 PM

@OTichonova It does seem to hang for me on my lowest powered device when I edit a full article source. It's better when I'm editing only a section, so I'm guessing it just takes a while for Voice Over to evaluate the text view data. I might be able to do some sort of "loading editor" announcement before it switches back to the editor.

I also notice the image wizard seems to still think the editor text view is displaying after it appears. I can look at that too. Let me know if you see any other oddities.

Hi @Tsevener, okay sounds good with the 'loading editor'. I will take at look at it today again.

Tsevener claimed this task.Feb 5 2024, 4:44 PM

Tsevener moved this task from Ready for Development to Doing on the iOS Release FY2023-24 (Archive) board.

https://github.com/wikimedia/wikipedia-ios/pull/4737

Improvements will be in the next Experimental build (81).

Tsevener removed Tsevener as the assignee of this task.Feb 5 2024, 9:08 PM

OTichonova moved this task from Needs Design Review to Needs Code Review on the iOS Release FY2023-24 (Archive) board.Feb 6 2024, 6:40 PM

Tsevener moved this task from Needs Code Review to Waiting for Build on the iOS Release FY2023-24 (Archive) board.Feb 6 2024, 8:53 PM

Tsevener moved this task from Waiting for Build to Needs Code Review on the iOS Release FY2023-24 (Archive) board.Feb 6 2024, 8:56 PM

Code is merged, but we may tweak Voice Over label wording some more from feedback. Waiting on confirmation there.

Tsevener renamed this task from [L] Native editor feature flag, container view controller and components to [L] Native editor Voice Over support.Feb 8 2024, 9:20 PM

Tsevener updated the task description. (Show Details)

Tsevener moved this task from Blocked or Waiting to Needs QA on the iOS Release FY2023-24 (Archive) board.

Update: Voice Over label tweaks will happen as a part of a separate task.