Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add several improvements to "Report a broken site" form (aka webcompat reporter) #20095

Closed
6 tasks
pes10k opened this issue Dec 14, 2021 · 26 comments · Fixed by brave/brave-core#12039 or brave/brave-core#12060
Assignees
Labels
OS/Desktop privacy/feature User-facing privacy- & security-focused feature work. privacy-pod Feature work for the Privacy & Web Compatibility pod QA Pass-Linux QA Pass-macOS QA Pass-Win64 QA/Test-All-Device-Types QA/Test-All-Platforms QA/Yes release-notes/include webcompat/shields Shields is breaking a website.

Comments

@pes10k
Copy link
Contributor

pes10k commented Dec 14, 2021

Brave includes a "webcompat reporter" that users can use to report when a site isn't broken. The current version does not have enough information to be actionable in most cases, frustrating users (they took the time to report a problem, but we can't fix it) and leaving sites broken.

Screen Shot 2021-12-14 at 5 05 42 PM

This issue is to improve the WebCompat reporter, through the following steps:

  • Have the WebCompat reporter send the full URL of the page being reported (currently only the protocol and origin is reported)
  • Have the WebCompat reporter show the user the full URL to the user when confirming the user wants to send the report
  • Include an optional "additional details" box on the form, so that the user can provide any extra context that would assist community / support with reproducing and resolving the issue on the webpage.
  • Include an optional "contact me / follow up with me" box on the form, so that community / support can follow up with the reporter (if desired).
  • Update the server side / data collector so that reports are automatically deleted every 3 weeks
  • Add UI / UX in the stats page (where these reports are currently visible) so that the stats user can delete a report if needed (for example, if the report includes sensitive / identifying information)
@pes10k pes10k added privacy/feature User-facing privacy- & security-focused feature work. webcompat/shields Shields is breaking a website. OS/Android Fixes related to Android browser functionality privacy-pod Feature work for the Privacy & Web Compatibility pod OS/Desktop labels Dec 14, 2021
@pes10k
Copy link
Contributor Author

pes10k commented Dec 14, 2021

(@ryanbr , do you think 3 weeks would be sufficient?

@ryanbr
Copy link

ryanbr commented Dec 14, 2021

Yeah 3 weeks fine, maybe to add an optional submission of Extensions in use also?

@porteron
Copy link
Member

Looks good, once you implement the new field to be sent we can go ahead and update the go-vault webcompat API to make sure we're in sync to capture.

Sending the entire URL should be fine, although maybe we want to establish the max character length we'll accept.

@porteron
Copy link
Member

Tracking the needed implementation here on my end: https://github.com/brave-intl/go-vault/issues/81

@antonok-edm antonok-edm added the design/needs-mock-up needs-mockup A feature which needs design mockup to be implemented. label Dec 28, 2021
@bradleyrichter
Copy link

@antonok-edm This represents the changes in the UX mentioned above:

image

@DJAndries
Copy link
Collaborator

Screenshots of implementation (ignore the "Contact details (optional)" placeholder, it is now "Email address (optional)")

report dark
report light

@bradleyrichter
Copy link

@DJAndries @pes10k @antonok-edm I thought we decided to include mentions of twitter and other rather than just email?

image

@pes10k
Copy link
Contributor Author

pes10k commented Jan 28, 2022

me too (from our slack chat @ryanbr and @antonok-edm ). Was there a reason to flip it back?

@DJAndries
Copy link
Collaborator

Apologies, I had not seen this new mock up. Will update accordingly.

@pes10k
Copy link
Contributor Author

pes10k commented Jan 28, 2022

thanks thanks @DJAndries !

@DJAndries
Copy link
Collaborator

DJAndries commented Jan 29, 2022

New screenshot:
Screenshot from 2022-01-28 16-34-44

@pes10k
Copy link
Contributor Author

pes10k commented Jan 29, 2022 via email

@bbondy bbondy added this to the 1.37.x - Nightly milestone Feb 7, 2022
@DJAndries
Copy link
Collaborator

Client and server-side complete, closing

@GeetaSarvadnya GeetaSarvadnya added the QA/In-Progress Indicates that QA is currently in progress for that particular issue label Mar 3, 2022
@LaurenWags
Copy link
Member

@brave/legacy_qa when checking this, please confirm with server-side team that data is being received as expected.

@GeetaSarvadnya
Copy link

GeetaSarvadnya commented Mar 4, 2022

Verification PASSED on

Brave | 1.37.82 Chromium: 99.0.4844.51 (Official Build) beta (64-bit)
-- | --
Revision | d537ec02474b5afe23684e7963d538896c63ac77-refs/branch-heads/4844@{#875}
OS | Windows 10 Version 21H2 (Build 19044.1526)

Client-side validation:

Light mode Dark mode
image image

@GeetaSarvadnya
Copy link

GeetaSarvadnya commented Mar 4, 2022

@porteron We would need your help to test the server-side data receive part. Please let me know once you have some time today.

@DJAndries Is this implemented Add UI / UX in the stats page (where these reports are currently visible) so that the stats user can delete a report if needed (for example, if the report includes sensitive / identifying information)? I have verified http://stats.brave.com/ but am unable to open this site, not sure if it's moved to the new site

@stephendonner
Copy link

@GeetaSarvadnya you have to use the VPN to reach https://stats.brave.com.

@porteron
Copy link
Member

porteron commented Mar 4, 2022

@GeetaSarvadnya I can confirm data is coming in on the server-side for the new fields. Seeing records with the additionalDetails and contactInfo.

@GeetaSarvadnya
Copy link

@porteron Thanks for confirming!

@GeetaSarvadnya GeetaSarvadnya added QA Pass-Win64 and removed QA/In-Progress Indicates that QA is currently in progress for that particular issue labels Mar 8, 2022
@stephendonner
Copy link

@porteron are you also able to confirm my data submission for brave.com from earlier today? 🙏 Thanks!

@porteron
Copy link
Member

@stephendonner Confirmed.

77,611
winx64-bc
99.0.4844.51
https://github.com/
https://github.com/brave/brave-browser/issues/20095
[sdonner@brave.com](mailto:sdonner@brave.com)
Just a test for https://github.com/brave/brave-browser/issues/20095
March 17, 2022, 4:44 AM

@stephendonner
Copy link

Verified PASSED using

Brave 1.37.96 Chromium: 99.0.4844.74 (Official Build) dev (x86_64)
Revision fee9a47e86e981802390cb0d41c5ed7ea93c4f6f-refs/branch-heads/4844@{#1060}
OS macOS Version 11.6.3 (Build 20G415)

Client-side validation:

Light mode Dark mode
Screen Shot 2022-03-17 at 1 04 48 PM Screen Shot 2022-03-17 at 1 05 15 PM
osx-bc
99.0.4844.74
https://github.com/
https://github.com/brave/brave-browser/issues/20095
sdonner@brave.com
Just a test for https://github.com/brave/brave-browser/issues/20095
March 17, 2022, 6:43 PM

@btlechowski
Copy link

btlechowski commented Mar 22, 2022

Verification passed on

Brave 1.37.100 Chromium: 99.0.4844.83 (Oficjalna wersja) beta (64-bitowa)
Revision b11086e62d7c1a44b0942ac5568d22a425c7ae35-refs/branch-heads/4844_74@{#5}
OS Ubuntu 18.04 LTS

Verified test plan from the description

Light mode:
image

Dark mode:
image

Logged: #21801

March 21, 2022, 11:56 PM
linux-bc
https://github.com/
test
[blechowski@brave.com](mailto:blechowski@brave.com)

@btlechowski
Copy link

@porteron are you also able to confirm my data submission for brave.com from blechowki@brave.com? Thanks in advance :)

@porteron
Copy link
Member

@btlechowski Confirmed I see the entry.

March 21, 2022, 11:56 PM
linux-bc
https://github.com/
test
[blechowski@brave.com](mailto:blechowski@brave.com)

@bsclifton bsclifton removed the OS/Android Fixes related to Android browser functionality label Mar 24, 2022
@bsclifton
Copy link
Member

Removed OS/Android label as this is only on Desktop 👍

@rebron rebron changed the title Improve webcompat reporter Add several improvements to "Report a broken site form" Mar 30, 2022
@rebron rebron changed the title Add several improvements to "Report a broken site form" Add several improvements to "Report a broken site" form (aka webcompat reporter) Mar 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment