Disable UIA text change events outside of Word, Windows Console, and Windows Terminal

[codeofdusk]

Link to issue number:

Mitigation for #11002.
Blocking #14047.

Summary of the issue:

UIA textChange NVDA events are seldom (if ever) used outside of a few specific situations, but have an extreme performance impact (see #11002).

Description of user facing changes

Improved performance/less chance of NVDA hanging in UIA applications.

Description of development approach

Explicitly do not process UIA textChange events outside of Windows Console, Terminal, and Word. The eventual end goal is to remove TermControl/TermControl2 from UIAHandler.textChangeUIAClassNames in #14047, which will very greatly improve performance in Windows Terminal. (conhost will remain, as there don't seem to be any plans to add notifications, especially as wt is becoming the default).

I'm very reluctant to add a mechanism by which add-ons/app modules can request textChange events unless someone requests it, especially given #11002.

Testing strategy:

• Tested in a self-signed build of NVDA over a few days.
• Tested that conhost and wt remain functional.
• Removed TermControl from textChangeUIAClassNames and verified that textChange events are not received.

Known issues with pull request:

None known.

Change log entries:

== Changes for Developers ==

• NVDA no longer processes textChange events for most UI Automation applications due to their extreme negative performance impact. (UIA freezes after a large number of events is received #11002, Disable UIA text change events outside of Word, Windows Console, and Windows Terminal #14067)

Code Review Checklist:

• Pull Request description:
  • description is up to date
  • change log entries
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• API is compatible with existing add-ons.
• Documentation:
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• Security precautions taken.

[LeonarddeR]

Note that you need to add "_WwG" as well since word also relies on text change events

[codeofdusk]

@LeonarddeR Done. For some reason, start menu suggestions aren't reading with this PR.

[LeonarddeR]

May be @josephsl knows a reason for this, though I don't see how textChange events are used there.

[codeofdusk]

Never mind, even when running master from source they don't read. I think it's a build environment issue.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests. See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/1u9l8e90lfbdtl74/artifacts/output/nvda_snapshot_pr14067-26327,820eb605.exe

See test results for failed build of commit 820eb60520

[codeofdusk]

@seanbudd Why was the build cancelled for this PR?

[seanbudd]

@codeofdusk - please don't force push to the branch after approval

stale after force push

[codeofdusk]

@seanbudd OK. I just tried doing that to see if it'd re-trigger the build. There are no code changes.

[seanbudd]

@codeofdusk - the build was cancelled intentionally. Releases take priority for builds.
You can build and run tests locally.
The build checks are for final checks before merging.

[codeofdusk]

Oh OK. Will you restart the build for this PR after the release?

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests. See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/92c7sxpxfth75rne/artifacts/output/nvda_snapshot_pr14067-26365,5c330d89.exe

See test results for failed build of commit 5c330d899c

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests. See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/q797an05cv4o54kf/artifacts/output/nvda_snapshot_pr14067-26368,5c330d89.exe

See test results for failed build of commit 5c330d899c

stale, changes pushed

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• FAIL: Lint check. See test results for more information.
• PASS: System tests.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/cpc19d6i1hu6q9x2/artifacts/output/nvda_snapshot_pr14067-26379,04337168.exe

See test results for failed build of commit 04337168d0