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

gokcekantarci · 2024-07-12T14:15:31Z

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

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

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.

This reverts commit 3c6d882.

This reverts commit c87a344.

This reverts commit f97cc86.

This reverts commit e7cc3a0.

This reverts commit 9c0ef91.

This reverts commit f2ed58f.

This reverts commit 96c0953.

This reverts commit 65a313f.

…rt when Report a Bug Clicked.

…r creating bug report.

htcfreek · 2024-07-12T17:06:16Z

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

niels9001 · 2024-07-13T06:29:41Z

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 · 2024-07-14T02:29:04Z

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.

Jay-o-Way · 2024-07-14T02:34:29Z

.github/ISSUE_TEMPLATE/bug_report.yml

+    placeholder: |
+      OS version
+      .Net version
+      Preferred System Language


Personally, I don't like these words. "Preferred" implies the possibility that the choice is not implemented. And does it mean OS lang or App lang? (since PowerToys UI should be using the app setting, right?)
It's just vague.

Changed to "System Language"

Jay-o-Way · 2024-07-14T02:37:10Z

src/settings-ui/Settings.UI/SettingsXAML/Controls/SettingsPageControl/LoadingMessage.xaml

+    DefaultButton="Primary">
+    <StackPanel>
+        <TextBlock Text="Creating bug report, please wait..." 
+                   VerticalAlignment="Center" 


This shouldn't be needed?

Jay-o-Way · 2024-07-14T02:37:19Z

src/settings-ui/Settings.UI/SettingsXAML/Controls/SettingsPageControl/LoadingMessage.xaml

+                   HorizontalAlignment="Center"
+                   TextAlignment="Center"/>
+        <ProgressBar IsIndeterminate="True" 
+                     VerticalAlignment="Bottom"


This shouldn't be needed?

Jay-o-Way · 2024-07-14T02:37:34Z

src/settings-ui/Settings.UI/SettingsXAML/Controls/SettingsPageControl/LoadingMessage.xaml

+        <ProgressBar IsIndeterminate="True" 
+                     VerticalAlignment="Bottom"
+                     Height="20"
+                     Margin="10"/>


Suggested change

Margin="10"/>

Margin="8"/>

Jay-o-Way · 2024-07-14T02:41:04Z

src/settings-ui/Settings.UI/SettingsXAML/Views/GeneralPage.xaml

+            <controls:PageLink x:Uid="GeneralPage_Documentation" Text="Documentation" Link="https://aka.ms/PowerToysOverview" />
+            <controls:PageLink x:Uid="General_Repository" Text="Repository" Link="https://aka.ms/powertoys" />


Why the Text property?

Jay-o-Way · 2024-07-14T02:43:05Z

src/settings-ui/Settings.UI/ViewModels/GeneralViewModel.cs

+                {
+                    Title = "Error",
+                    Content = $"An error occurred: {ex.Message}",
+                    CloseButtonText = "OK",


Errors are not very okay 🤓

I manually throw an exception and error message looks like above. What do you think?

We should log errors as well, not just show.

niels9001 · 2024-07-14T04:17:44Z

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 · 2024-07-14T13:54:43Z

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...

htcfreek · 2024-07-22T15:40:49Z

src/runner/bug_report.cpp

+
+        additionalInfo += windowsSettings + "%0a" + installScope + "%0a" + isElevatedRun;
+
+        gitHubURL = "https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=Issue-Bug%2CNeeds-Triage&template=bug_report.yml" +


Why assigning labels this way. They are defined in the template. Worry that nobody imagine about this piece of code later.

https://aka.ms/powerToysReportBug
When you open this currently working link, the link that opens is as follows. Also, it does not assign these labels when they are not added.

https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=Issue-Bug%2CTriage-Needed&template=bug_report.yml&title=

gokcekantarci · 2024-07-23T10:27:09Z

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 · 2024-07-26T09:20:24Z

/azp run

azure-pipelines · 2024-07-26T09:20:32Z

Azure Pipelines successfully started running 1 pipeline(s).

jaimecbernardo

Thanks for opening the PR. Some feedback from testing:
Gave it a test, but from tray icon, it creates the zip on Desktop, but then the following Dialog appears:

Doesn't make much sense having Ok and Cancel, since both seem to do the same thing.
It also should be likely an Error or Warning icon instead of the info. The message is also not too helpful.
All following attempts to generate the Bug Report after the first don't create the zip and just show the error message right away.
These changes also make the tray icon block while the Bug Report is being generated, which is a regression from 0.82.1
This needs more logs when there are errors so that we can understand what's going on when this errors occur.

…R comments have been implemented.

crutkas · 2024-09-10T18:24:01Z

@gokcekantarci did you resolve the feedback from @jaimecbernardo ?

jaimecbernardo

Hi @gokcekantarci ,
Gave this another try, btu this was the page that's shown at the end:

This is not what's intended, can you please take a look?

gokcekantarci added 25 commits June 3, 2024 15:07

Test version

65a313f

Github URL

96c0953

repro

f2ed58f

os version

9c0ef91

isadmin

e7cc3a0

report

f97cc86

report

c87a344

report

3c6d882

Revert "report"

c716aa6

This reverts commit 3c6d882.

Revert "report"

27b234e

This reverts commit c87a344.

Revert "report"

ce010f5

This reverts commit f97cc86.

Revert "isadmin"

51a33af

This reverts commit e7cc3a0.

Revert "os version"

5596a32

This reverts commit 9c0ef91.

Revert "repro"

f9b1588

This reverts commit f2ed58f.

Revert "Github URL"

5c0e146

This reverts commit 96c0953.

Revert "Test version"

d45ae2c

This reverts commit 65a313f.

[BugReport] Autofill PT version and other software, create a bug repo…

24bc41a

…rt when Report a Bug Clicked.

"iselevated" id added and changed type dopdown to input.

aff0f36

[BugReport] Isadmin changed to input type. Loading dialog is added fo…

4cc7fff

…r creating bug report.

[BugReport] New enhancements to tray icon 'Report Bug'

a6192a1

[BugReport] Spellcheck.

0b0e833

[BugReport] Minor check.

2d452c8

[BugReport] Additional info field is added for systray bugreport

5b83154

[BugReport] Additional info field is added for general settings button.

18141c9

[BugReport] Github link replaced.

58c5a6f

gokcekantarci requested review from crutkas, niels9001, jaimecbernardo, stefansjfw and ethanfangg July 12, 2024 14:15

gokcekantarci requested a review from DHowett as a code owner July 12, 2024 14:15

This comment has been minimized.

Sign in to view

Jay-o-Way reviewed Jul 14, 2024

View reviewed changes

htcfreek reviewed Jul 22, 2024

View reviewed changes

[BugReport] Minor changes made to comments in PR have been implemented.

37b373f

jaimecbernardo added 2 commits July 26, 2024 10:33

Merge branch 'main' into pr33802

5b25571

Fix XAML style

9422b1a

jaimecbernardo requested changes Jul 26, 2024

View reviewed changes

[BugReport] New logs and error messages are added. Minor changes in P…

b1aa218

…R comments have been implemented.

crutkas mentioned this pull request Aug 2, 2024

Report a bug enhancement #34128

Closed

gokcekantarci added 2 commits September 26, 2024 14:32

[BugReport] Main merge.

c033d8d

[BugReport] Merge main.

8e94792

This comment has been minimized.

Sign in to view

gokcekantarci and others added 3 commits September 26, 2024 15:22

[BugReport] SpellCheck.

b9c5173

Merge branch 'main' into BugReport-Autofill-'Report-Bug'

8a62c52

Fix merge issues

ad5217d

jaimecbernardo requested changes Oct 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

gokcekantarci commented Jul 12, 2024 •

edited

Loading

This comment has been minimized.

htcfreek commented Jul 12, 2024

niels9001 commented Jul 13, 2024

Jay-o-Way commented Jul 14, 2024

Jay-o-Way Jul 14, 2024

gokcekantarci Jul 23, 2024

Jay-o-Way Jul 14, 2024

gokcekantarci Jul 23, 2024

Jay-o-Way Jul 14, 2024

gokcekantarci Jul 23, 2024

Jay-o-Way Jul 14, 2024

gokcekantarci Jul 23, 2024

Jay-o-Way Jul 14, 2024

gokcekantarci Jul 23, 2024

Jay-o-Way Jul 14, 2024

gokcekantarci Jul 23, 2024

jaimecbernardo Jul 26, 2024

niels9001 commented Jul 14, 2024 •

edited

Loading

Jay-o-Way commented Jul 14, 2024

htcfreek Jul 22, 2024

gokcekantarci Jul 23, 2024

gokcekantarci commented Jul 23, 2024

jaimecbernardo commented Jul 26, 2024

azure-pipelines bot commented Jul 26, 2024

jaimecbernardo left a comment

crutkas commented Sep 10, 2024

This comment has been minimized.

jaimecbernardo left a comment

		<controls:PageLink x:Uid="GeneralPage_Documentation" Text="Documentation" Link="https://aka.ms/PowerToysOverview" />
		<controls:PageLink x:Uid="General_Repository" Text="Repository" Link="https://aka.ms/powertoys" />


		additionalInfo += windowsSettings + "%0a" + installScope + "%0a" + isElevatedRun;

		gitHubURL = "https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=Issue-Bug%2CNeeds-Triage&template=bug_report.yml" +

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

Are you sure you want to change the base?

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

Conversation

gokcekantarci commented Jul 12, 2024 • edited Loading

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

This comment has been minimized.

htcfreek commented Jul 12, 2024

niels9001 commented Jul 13, 2024

Jay-o-Way commented Jul 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

niels9001 commented Jul 14, 2024 • edited Loading

Jay-o-Way commented Jul 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gokcekantarci commented Jul 23, 2024

jaimecbernardo commented Jul 26, 2024

azure-pipelines bot commented Jul 26, 2024

jaimecbernardo left a comment

Choose a reason for hiding this comment

crutkas commented Sep 10, 2024

This comment has been minimized.

jaimecbernardo left a comment

Choose a reason for hiding this comment

gokcekantarci commented Jul 12, 2024 •

edited

Loading

niels9001 commented Jul 14, 2024 •

edited

Loading