Avoid freeze in Windows API Level 0 and 1 console when UIA support is enabled

[ABuffEr]

Link to issue number:

Fixes #14689

Summary of the issue:

Due to a bug in API Level 0 and 1 consoles (see microsoft/terminal/#5243), sometimes NVDA freezes during dictionary processing of console text, containing a huge amount of blank lines.

Description of user facing changes

None.

Description of development approach

If current focus object has apiLevel 0 or 1, and difference between regular text and text with rightside blank lines stripped is greater than 100, we use cleaned text for dictionary processing.

Testing strategy:

Manual, with #14689 str.

Known issues with pull request:

None.

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.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• FAIL: Lint check. See test results for more information.
• PASS: System tests (tags: installer NVDA).
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/dc46a2l1fkmd5bwf/artifacts/output/nvda_snapshot_pr14703-27813,ff21508d.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.0,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 27.0,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 23.2,
  FINISH_END 0.2

See test results for failed build of commit ff21508d8b

[codeofdusk]

Honestly, I'm not the biggest fan of this approach (or, for that matter, putting any more work into the API <2 console). There are changes coming down the pipeline that I'm not at liberty to discuss in detail (I would if I could), so I'd suggest holding off on any changes for now.

CC @DHowett.

[seanbudd]

Honestly, I'm not the biggest fan of this approach (or, for that matter, putting any more work into the API <2 console).

Shouldn't NVDA still support the API <2 console? Can you explain why not?
It seems like this small change will improve a freeze quite easily.

[ABuffEr]

@cary-rowen, can you test the last try-build when available?

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/oxwjfvvv4nf45cn8/artifacts/output/nvda_snapshot_pr14703-27944,5900fdb1.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.9,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 24.1,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 22.1,
  FINISH_END 0.1

See test results for failed build of commit 5900fdb1ba

[ABuffEr]

Ok, I found a way that can accomplish @codeofdusk requests.
I can import (into function) ConsoleUIATextInfo class, that shared by apiLevel 1 and 0 implementations, and then check istance of textInfo returned by review.getObjectPosition(globalVars.focusObject).
I could additionally check even apiLevel on focusObject, if you want, but it has not particularly sense at the moment

[seanbudd]

Thanks @ABuffEr

[seanbudd]

@ABuffEr - you omitted the change log section from the PR template. Do you think this warrants a change log entry?
What do you think of this in bug fixes:
"When forcing UIA support with certain terminal and consoles, a bug is fixed which caused a freeze and the log file to be spammed. (#14689)"

[codeofdusk]

Approved pending my suggested comment clarifications (for consistency in style of references)

[ABuffEr]

"When forcing UIA support with certain terminal and consoles, a bug is fixed which caused a freeze and the log file to be spammed. (#14689)"

Ok for me.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• FAIL: Lint check. See test results for more information.
• PASS: System tests (tags: installer NVDA).
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/a3ox8hijnlm0ee6n/artifacts/output/nvda_snapshot_pr14703-28031,7bad1d47.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.8,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 23.9,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 22.1,
  FINISH_END 0.1

See test results for failed build of commit 7bad1d47d5

[ABuffEr]

Hi @seanbudd,
unfortunately this PR seems to cause troubles in some situations. I'm testing a new solution acting from _get_text directly in ConsoleUIATextInfo (new PR soon). Can you revert this? Thanks, and sorry for inconvenience.

[codeofdusk]

If you're able to fix the bug by patching ConsoleUIATextInfo directly, I too would feel much more comfortable with this.

[codeofdusk]

I've opened #14815.