Improve the 'report bug' functionality to auto-fill data

[gokcekantarci]

Summary of the Pull Request

!!! Important For testing, please change https://github.com/microsoft/PowerToys to https://github.com/gokcekantarci/PowerToys

https://github.com/microsoft/PowerToys/pull/33802/files#diff-3b008940357607ddfe1a2427962928042eb1cd920d16e17c5e76449d73b52946R123

https://github.com/microsoft/PowerToys/pull/33802/files#diff-3b008940357607ddfe1a2427962928042eb1cd920d16e17c5e76449d73b52946R123

In this PR, some fields on the link opened with the 'Report Bug' button were automatically filled. When pressed the button from both the general page and the system tray, a bug report is created on the desktop. The fields that can be filled in on the page that opens later are filled automatically.

PR Checklist

• [ ] Closes: #31797
• [ ] Dev docs: Added/updated
• [ ] Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
• [ ] Tests: Added/updated and all pass
• [ ] Localization: All end user facing strings can be localized
• [ ] 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

Detailed Description of the Pull Request / Additional comments

General Settings

System Tray

Validation Steps Performed

General Settings

• Click the report a bug button on the general settings page and see the generating message box.
• Wait for the process to finish and see the message generated. Then, check the report created with the report name in the message on the desktop.
• Press the 'OK' button and wait for the bug report link to open automatically. Check that the version field and additional information field with the OS version, .NET version, Pref language, User locale, Installation, Run as admin fields are filled in correctly.
• Press the report a bug button again. Cancel with the Cancel button before the report is created.
• Check that the "https://aka.ms/powerToysReportBug" link opens automatically without filling in the relevant fields. Also check that no reports are being generated on the desktop.

System Tray

• Press the report bug button from the system tray and see the generating notification message.
• Wait for the process to finish and see the message generated. Then, check the report created with the report name in the message on the desktop.
• Wait for the bug report link to open automatically. Check that the version field and additional information field with the OS version, .NET version, Pref language, User locale, Installation, Run as admin fields are filled in correctly.

[htcfreek]

Does it make sense to fill the PT version field or add it to the additional information?

[htcfreek]

Does this PR implements #28791? It looks like it does.

[niels9001]

Should the "the file is created on the desktop" dialog open the desktop folder for you so you can attach it quicker? Now it requires the user to open File Explorer first, navigatw to desktop etc

[Jay-o-Way]

it requires the user to open File Explorer first, navigatw to desktop etc

Ehm, normally the desktop can be only one click or hotkey away.

[niels9001]

it requires the user to open File Explorer first, navigatw to desktop etc

Ehm, normally the desktop can be only one click or hotkey away.

It might, but why inform the user to go to navigate to a certain folder (which in my case has a lot of files and I'd need to manually search for it) if we could open it and highlight the file? E.g. using: https://stackoverflow.com/questions/13680415/how-to-open-explorer-with-a-specific-file-selected

Or at the very least provide a clickable link to the folder.

This is pretty common in confirmation dialogs in Windows apps when e.g. exporting a file like a video.

[Jay-o-Way]

navigate to a certain folder

Well, the user can also minimize all windows to see the actual desktop (not as a folder). I think we're talking about a few second or clicks, but oh wel... The idea to use Explorer with the file selected is actually fine. But then, why bother to ask? If a user creates the file, we can assume* they want to use it right away.

assume?

Said with a hint of sarcasm... I know assuming something is dangerous and often unwanted. But that doesn't seem to be a concern for Microsoft. Remember all the complaints about Windows 10 being installed without consent? Or importing data from Chrome into Edge. Or simply giving the user the choice between "Yes" and "Later" - where's the "No"? It's typical for Microsoft...

[gokcekantarci]

navigate to a certain folder

Well, the user can also minimize all windows to see the actual desktop (not as a folder). I think we're talking about a few second or clicks, but oh wel... The idea to use Explorer with the file selected is actually fine. But then, why bother to ask? If a user creates the file, we can assume* they want to use it right away.

assume?

I tried it as in the link suggested by @niels9001 https://stackoverflow.com/questions/13680415/how-to-open-explorer-with-a-specific-file-selected

I think opening both the link and the folder would create a bigger mess on the screen. The name of the file is specified in the last message. It will not be difficult to find this file on the desktop. So I think we need to move forward this way. If there are requests or complaints from users, we can easily add it.

[jaimecbernardo]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[crutkas]

@gokcekantarci did you resolve the feedback from @jaimecbernardo ?

[github-actions[bot]]

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

settingsd

Previously acknowledged words that are now absent

applayout appsfolder buildtask cswinrt directshow GBarm IDCANCEL netcore nugets systemsettings SYSTEMWOW telem USEPOSITION USESIZE winappdriver 🫥

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:gokcekantarci/PowerToys.git repository on the BugReport-Autofill-'Report-Bug' branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/11052041246/attempts/1'

Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (1927) from .github/actions/spell-check/expect.txt and unrecognized words (1)

Dictionary	Entries	Covers	Uniquely
cspell:r/src/r.txt	543	1	1
cspell:cpp/src/people.txt	23	1
cspell:cpp/src/ecosystem.txt	51	1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:r/src/r.txt
          cspell:cpp/src/people.txt
          cspell:cpp/src/ecosystem.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''

Errors (2)

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

:x: Errors	Count
:x: ignored-expect-variant	1
:information_source: non-alpha-in-dictionary	1

See :x: Event descriptions for more information.

If the flagged items are :exploding_head: false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it, try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

[jaimecbernardo]

This still needs quite some work. Definitely not for .89.

[shuaiyuanxx]

Same issue still exists, need some extra work to get this PR in.

[shuaiyuanxx]

Hi @jaimecbernardo , I have rebased the code and fixed some issues, could you try it again? It works for me now.

[yeelam-gordon]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[vanzue]

Let's target next release to make it happen

[jaimecbernardo]

Closing in favor of https://github.com/microsoft/PowerToys/pull/37991