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

feat(panel): Add the "Report a broken page" view #2164

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

smalluban
Copy link
Collaborator

@smalluban smalluban commented Dec 23, 2024

The PR adds the CTA for paused domains, which opens the "Report a broken page" in the panel.

  • It looks like activeTab permission does not trigger a browser popup when the extension is updated. However, we can also try out the optional permission if it is better.
  • We need to match operating systems between the extension and support form - I think we should update fields to follow extension logic - mac, win, ios, ipados,linux, etc... and version only as a separate field (currently we have windows_10 and other as os name)
  • Copy is a draft version - needs review and improvements
  • I tested the screenshot feature on Chrome, Firefox, and Safari on Mac and iOS, and it works as expected
  • Open question about the link "Report a broken page" in the menu - should it also open the form in the panel or should it open the website as it does now?

WARNING: the PR logic is finished and it's connected to the real end-point. Please use npm start -- --staging when testing to avoid spaming the support channel.

@smalluban smalluban marked this pull request as draft December 23, 2024 16:15
@smalluban smalluban requested a review from chrmod December 23, 2024 16:22
@chrmod
Copy link
Member

chrmod commented Jan 8, 2025

Screenshots for reference:
Screenshot 2025-01-08 at 13 24 00
Screenshot 2025-01-08 at 13 24 51

Screenshot 2025-01-08 at 13 24 44 Zrzut ekranu 2025-01-10 o 12 38 59

Copy link
Member

@chrmod chrmod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great so far!

'support_ticket[subject]',
`[GBE] Broken page report: ${msg.url}`,
);
formData.append('support_ticket[message]', msg.description);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should pass the product version via the form. Until it is supported by the website lets add it to the message.

Lets consider if we want to add also:

  • list of detected activities (no urls)
  • extension settings
  • block list version (checksums)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to miss it, I'll add the extension version via the subject. It might be easier to spot or filter out.

The message body has a limit of 5k characters. We can shorten it to 4k for a space of 1k for additional metadata. We can add a list of tracker IDs (from stats), extension settings are important from the privacy section only. The block list might be tricky as it requires all checksums of all lists, but I will try to generate them.

src/background/broken-page-report.js Show resolved Hide resolved
}
});

sendResponse();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we add some error handling so in case of a problem we let people know they can report the problem via the website?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. That's technically easy, I will add a message after error handling, like "Error... However, you can always report the broken page via our [website form]"

@smalluban smalluban force-pushed the feat-report-broken-page branch from 6df993b to 5daf8e8 Compare January 10, 2025 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants