Constrain a11y word nav to the virtual bottom #5405

carlos-zamora · 2020-04-18T00:10:02Z

Use the virtual bottom in ConHost to speed up a11y word navigation performance. GetTextBufferEndPosition() is also used by by search; it'll also get a minor performance boost.

PR Checklist

Closes UIA: delay when reaching prompt with word navigation #5243

Detailed Description of the Pull Request / Additional comments

#7789 uses GetLastNonspaceCharacter() to determine where the last word is and exit early on a UIA::Move by word call. The change in this PR passes the virtual bottom over to GetLastNonspaceCharacter() to make that search a bit faster.

Tested word navigation on Host.exe using NVDA.

WPR Traces

The percentages below represent the weight that a function call had. The
test scenario included moving by word on the CMD welcome message until
the last word was reached. Inspect.exe was used to limit any additional
calls that are generally performed by a screen reader.

function	current	branch
`UIA:Move`	29.52%	28.43%

There is an improvement of about 1% in a release build of ConHost.

zadjii-msft

I don't think this will break anything. Virtual bottom should always be below the last written text so this should always work

src/host/renderData.cpp

codeofdusk · 2020-04-19T00:49:33Z

Thanks @carlos-zamora!

src/host/renderData.cpp

DHowett-MSFT · 2020-04-20T18:02:19Z

src/host/renderData.cpp

-    Viewport bufferSize = gci.GetActiveOutputBuffer().GetBufferSize();
-    COORD endPosition{ bufferSize.Width() - 1, bufferSize.BottomInclusive() };
+    const auto mutableViewport = gci.GetActiveOutputBuffer().GetVirtualViewport();
+    COORD endPosition{ mutableViewport.Width() - 1, mutableViewport.BottomInclusive() };


just so i understand: this is not impacted by the user having scrolled up? the viewport usually is.

So the good news is that the returned value is not impacted by the user having scrolled up. The bad news is, your comment led me down a rabbit hole of realizing that #6453 exists. This was already in master though.

codeofdusk · 2020-04-24T22:35:20Z

Any updates on this PR? Thanks.

miniksa · 2020-04-27T15:47:13Z

I came by to look at this but three things stick out:

Outstanding comments by @DHowett-MSFT that don't look answered yet.
The x64 build is failing.
@carlos-zamora hasn't attached the WPR traces before/after he said he was going to.

So I'm going to skip reviewing it for now and come back later hoping some of those progress.

codeofdusk · 2020-04-29T00:14:14Z

Do you intend to merge this in time for 21H1? It would mean a lot for NVDA. Thanks!

carlos-zamora · 2020-04-29T16:35:57Z

@codeofdusk Yeah! I've had bad luck the last few days where suddenly my internet goes down or my machine refuses to run the tracing app haha. I'm hoping to get this in this week or early next, but I'm trying to prioritize closing some of the other Windows Terminal bugs first.

DHowett-MSFT · 2020-04-29T16:38:09Z

@codeofdusk sorry about the confusion here: the 21H1 milestone end date was set incorrectly. Things are a lot less dire than “we need to fix all the UIA bugs in the next two days.”

codeofdusk · 2020-04-29T20:45:43Z

Excellent news!

codeofdusk · 2020-05-21T06:03:47Z

@carlos-zamora Any updates on this PR? Were you able to address the issues with your machine and outstanding review comments? Thanks!

carlos-zamora · 2020-05-21T16:30:50Z

@carlos-zamora Any updates on this PR? Were you able to address the issues with your machine and outstanding review comments? Thanks!

Now that Build is over, time to get back to this one 😊. Getting the traces and fixing the build today.

carlos-zamora · 2020-05-21T17:57:09Z

@carlos-zamora Any updates on this PR? Were you able to address the issues with your machine and outstanding review comments? Thanks!

Now that Build is over, time to get back to this one 😊. Getting the traces and fixing the build today.

And another problem came up with recording the traces. Baby steps. This'll get done soon, sorry Bill haha.

codeofdusk · 2020-05-21T18:01:10Z

Thanks for looking into it!

Also, could you please look into #5481?

DHowett · 2020-05-21T18:08:06Z

@codeofdusk We'll look into it -- Carlos is assigned, but that does not indicate that it's in his immediate list of things to look at. We're finally coming off the v1 release cycle for Terminal and will have time in the future to evaluate conhost issues.

codeofdusk · 2020-09-30T19:00:51Z

What is the current status of this PR?

DHowett

This seems to have shaped up into something like we wanted it to. Can you change the name to something like "constrain a11y to the touched viewport"

consider that SEARCH uses this function (!) which could be problematic.

codeofdusk · 2020-09-30T19:25:17Z

Also, how does this PR relate to #6986?

carlos-zamora · 2020-09-30T21:57:10Z

Also, how does this PR relate to #6986?

Here, we're making it easier to find the last non-space character (and the last word, by extension).

#6986 is an architectural change to treat the last non-space character as the end of the buffer. This change should make it a bit easier to accomplish that in a performant way.

carlos-zamora · 2021-03-29T17:08:04Z

Closing. See #7000 (comment) for more details.

I'll revive this PR once I actively start working on UIA again.

carlos-zamora added Area-Accessibility Issues related to accessibility Product-Conhost For issues in the Console codebase labels Apr 18, 2020

zadjii-msft approved these changes Apr 18, 2020

View reviewed changes

src/host/renderData.cpp Outdated Show resolved Hide resolved

carlos-zamora marked this pull request as ready for review April 20, 2020 17:11

carlos-zamora force-pushed the dev/cazamor/acc/ch/word-nav-perf branch from 634034a to 78ebaca Compare April 20, 2020 17:42

DHowett-MSFT reviewed Apr 20, 2020

View reviewed changes

src/host/renderData.cpp Outdated Show resolved Hide resolved

DHowett-MSFT reviewed Apr 20, 2020

View reviewed changes

codeofdusk mentioned this pull request May 1, 2020

UI Automation in Windows Console: make default in FORMATTED consoles (Windows 11 Sun Valley 2) nvaccess/nvda#10964

Merged

carlos-zamora added 2 commits June 10, 2020 09:14

Improve word navigation perf in ConHost

6ecc28a

remove unnecessary narrow

66e9d73

ghost added Issue-Bug It either shouldn't be doing this or needs an investigation. Priority-1 A description (P1) labels Jun 10, 2020

change name of variable

76fcc51

carlos-zamora force-pushed the dev/cazamor/acc/ch/word-nav-perf branch from 78ebaca to 76fcc51 Compare June 10, 2020 18:50

zadjii-msft added the Needs-Second It's a PR that needs another sign-off label Sep 30, 2020

ghost requested review from miniksa and DHowett September 30, 2020 19:09

ghost requested review from leonMSFT and PankajBhojwani September 30, 2020 19:09

zadjii-msft assigned carlos-zamora Sep 30, 2020

DHowett approved these changes Sep 30, 2020

View reviewed changes

Merge branch 'master' into dev/cazamor/acc/ch/word-nav-perf

8169d16

carlos-zamora changed the title ~~Improve word navigation perf in ConHost~~ Constrain a11y word nav to the virtual bottom Sep 30, 2020

microsoft-github-updates bot changed the base branch from master to main October 22, 2020 00:27

zadjii-msft removed the Needs-Second It's a PR that needs another sign-off label Mar 29, 2021

carlos-zamora mentioned this pull request Mar 29, 2021

[Epic] Shared UI Automation Improvements #7000

Open

carlos-zamora closed this Mar 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Constrain a11y word nav to the virtual bottom #5405

Constrain a11y word nav to the virtual bottom #5405

carlos-zamora commented Apr 18, 2020 •

edited

Loading

zadjii-msft left a comment

codeofdusk commented Apr 19, 2020

DHowett-MSFT Apr 20, 2020

carlos-zamora Jun 10, 2020

codeofdusk commented Apr 24, 2020

miniksa commented Apr 27, 2020

codeofdusk commented Apr 29, 2020

carlos-zamora commented Apr 29, 2020

DHowett-MSFT commented Apr 29, 2020

codeofdusk commented Apr 29, 2020

codeofdusk commented May 21, 2020

carlos-zamora commented May 21, 2020

carlos-zamora commented May 21, 2020

codeofdusk commented May 21, 2020

DHowett commented May 21, 2020

codeofdusk commented Sep 30, 2020

DHowett left a comment

codeofdusk commented Sep 30, 2020

carlos-zamora commented Sep 30, 2020

carlos-zamora commented Mar 29, 2021

Constrain a11y word nav to the virtual bottom #5405

Constrain a11y word nav to the virtual bottom #5405

Conversation

carlos-zamora commented Apr 18, 2020 • edited Loading

PR Checklist

Detailed Description of the Pull Request / Additional comments

WPR Traces

zadjii-msft left a comment

Choose a reason for hiding this comment

codeofdusk commented Apr 19, 2020

DHowett-MSFT Apr 20, 2020

Choose a reason for hiding this comment

carlos-zamora Jun 10, 2020

Choose a reason for hiding this comment

codeofdusk commented Apr 24, 2020

miniksa commented Apr 27, 2020

codeofdusk commented Apr 29, 2020

carlos-zamora commented Apr 29, 2020

DHowett-MSFT commented Apr 29, 2020

codeofdusk commented Apr 29, 2020

codeofdusk commented May 21, 2020

carlos-zamora commented May 21, 2020

carlos-zamora commented May 21, 2020

codeofdusk commented May 21, 2020

DHowett commented May 21, 2020

codeofdusk commented Sep 30, 2020

DHowett left a comment

Choose a reason for hiding this comment

codeofdusk commented Sep 30, 2020

carlos-zamora commented Sep 30, 2020

carlos-zamora commented Mar 29, 2021

carlos-zamora commented Apr 18, 2020 •

edited

Loading