Log messages when starting / ending freeze

[feerrenrut]

Link to issue number:

As per #14289 (comment)

Summary of the issue:

When NVDA freezes its behavior changes, this can break assumptions, and make inferring its behavior difficult.
The logs do not clearly indicate the start / end / level of a freeze.

Description of user facing changes

None

Description of development approach

• Refactor code to extract responsibilities to make loop conditions easier to reason about.
• Add logging for different levels of freeze, start and end.

Testing strategy:

• System tests.
• Alpha testing.

Known issues with pull request:

• It would be helpful to have clear names and a description of the implications of the different levels of freeze.

Change log entries:

For Developers

- More detailed logging for NVDA freezes to aid debugging.

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.

[seanbudd]

generally LGTM

[feerrenrut]

Last system test failure:

Robot.startupShutdownNVDA.RestartsRobot
Error message:
Timed out waiting Welcome to NVDA to focus

Unlikely to be related to this change.

[michaelDCurran]

I'd like to see this change split into separate commits in the following order:

• Switch to using performance counters
• Add missing logging
• Refactor code
  As much as I don't want to create extra work here, I'm finding it hard to follow all the changes and therefore can not be confident to give my assurance that the change looks correct. Especially also because the primary point of the pr was to add missing logging, not to necessarily refactor.

[feerrenrut]

@michaelDCurran The changes have been split. The refactor is composed of several aspects, I also made these separate commits.