Ready for Review - [MouseJump] move "common" classes into separate project

[mikeclayton]

Summary of the Pull Request

This is an attempt to break PR #33486 ([Mouse Jump] - Customisable appearance - borders, margins, colours) down into smaller chunks because it's gotten unmanageable due to its age and number of commits (currently 37 commits / 205 files changed and 25 merge conflicts).

This PR just moves the files in the "MouseJumpUI\Common" folder into a separate *.csproj project so that it can eventually be referenced by the SettingsUI project to draw a sample preview image when style settings are changed. There's no functionality changes in the code, just a move of the existing classes into a separate project (and updating the namespaces), so it'll hopefully be a lot easier to review than #33486, which can eventually be cancelled.

A separate follow-up PR will re-implement the Settings UI changes to close PR #33486 and Issue #27511.

PR Checklist

• Partial implementation of : [Mouse Jump] Customisable appearance - borders, margins, colours, etc #27511
• Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
  • This is a step toward [Mouse Jump] Customisable appearance - borders, margins, colours, etc #27511 - [Mouse Jump] Customisable appearance - borders, margins, colours
• Tests: Added/updated and all pass
  • no changes required, apart from MouseJumpUI.UnitTests moved to MouseJump.Common.UnitTests
• Localization: All end user facing strings can be localized
  • no changes required
• Dev docs: Added/updated
  • no changes required
• New binaries: Added on the required places
  • JSON for signing for new binaries
  • WXS for installer for new binaries and localization folder
  • YML for CI pipeline for new test projects
  • YML for signed pipeline
• Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx
  • no changes required

Detailed Description of the Pull Request / Additional comments

This PR moves all of the code currently held in the MouseJumpUI project under "src\modules\MouseUtils\MouseJumpUI\Common" into a new project "MouseJump.Common". This will allow the project to be referenced from the SettingsUI project in a follow-up PR as part of the work to implement customisable style settings.

Validation Steps Performed

• Workflow tests
  • Automated tests passing locally
  • Minimal actions workflow (spelling check) passing for PR
  • Full actions workflow (msbuild) passing for PR
• UI tests
  • Happy path
    • preview image appears when activated
    • clicking the preview image moves the mouse cursor to the correct location
    • right-click dismisses the preview image without moving the mouse
    • pressing escape dismisses the preview image without moving the mouse
  • Works on multiple monitors with different dpi scaling settings (e.g. 100% vs 150%)
    • [Mouse Jump] - new feature - #23216 #23566 (comment)
    • [Mouse Jump] - new feature - #23216 #23566 (comment)
  • Handling negative coordinates on non-primary monitors if higher or "lefter" than primary monitor
    • [Mouse Jump] - new feature - #23216 #23566 (comment)
  • Mouse crosshair moves when Mouse Jump moves the cursor (mouse clicks and keyboard shortcuts)
    • Mouse pointer Crosshair & Mouse Jump Issue #24523
    • [MouseJump]Also simulate mouse input event #24527
  • Activating when the preview window is already visible moves the form to the new mouse position
  • Number and key shortcuts (1-9, Home / End, Left / Right Arrow) jump to the appropriate monitor
  • Number-pad shortcuts (1-9 jump to the appropriate monitor
• Lifecycle tests
  • Starting PowerToys Runner launches MouseJumpUI.exe when enabled, and not when disabled
  • Enabling / disabling Mouse Jump in settings starts / stops MouseJumpUI.exe
  • Exiting PowerToys Runner stops MouseJumpUI.exe
  • Killing runner exe via Task Manager stops MouseJumpUI.exe
  • Stopping Visual Studio local debug run stops MouseJumpUI.exe
    • note - runner needs to be in non-admin mode otherwise Visual Studio debugger disconnects at launch
  • Hotkey and size settings are automatically reloaded when config file is modified from Settings UI
  • Hotkey and size settings are automatically reloaded when config file is modified manually (e.g. in notepad) while runner and MouseJumpUI.exe are running
• Internal Test Suite
  • Enable Mouse Jump. Then:
  • Press the activation shortcut and verify the screens preview appears.
  • Change activation shortcut and verify that new shortcut triggers Mouse Jump.
  • Click around the screen preview and ensure that mouse cursor jumped to clicked location.
  • Reorder screens in Display settings and confirm that Mouse Jump reflects the change and still works correctly.
  • Change scaling of screens and confirm that Mouse Jump still works correctly.
  • Unplug additional monitors and confirm that Mouse Jump still works correctly.
  • Disable Mouse Jump and verify that the module is not activated when you press the activation shortcut.

[mikeclayton]

So it looks like adding <UseWinforms>true</UseWinForms> to MouseJump.Common.csproj has fixed the problem with verifyDepsJsonLibraryVersions.ps1 detecting a different version of System.Drawing.Common.dll being referenced in MouseJump.Common versus all the other modules.

I'm not keen on it as a fix as MouseJump.Common only really needs a reference to System.Drawing.Common and not the whole WinForms, but I can't work out how to get the build to use the right version of System.Drawing.Common, so this might have to do for now :-S...

[mikeclayton]

I think this PR is ready for review now - the manual and automated tests all work and the build pipeline is green.

The only remaining piece of work is to incorporate the new "MouseJump.Common.dll" assembly into the installer. I'm not super-confident about what is required for that - would someone from the core team be able to help?