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 chrome://rewards-internals to assist with support #1174

Closed
LaurenWags opened this issue Sep 18, 2018 · 32 comments · Fixed by brave/brave-core#1139
Closed

Add chrome://rewards-internals to assist with support #1174

LaurenWags opened this issue Sep 18, 2018 · 32 comments · Fixed by brave/brave-core#1139

Comments

@LaurenWags
Copy link
Member

Description

Per discussion in b-c triage meeting, we should add some Brave Rewards information to chrome://version page to assist with supporting users. Some items are:

  • wallet paymentId (this is used for support when users have wallet issues)
  • wallet status such as contribution in progress, etc (since this is not displayed on chrome://rewards page)

cc @davidtemkin @NejcZdovc @brave/legacy_qa for additional ideas on Rewards items to be displayed

@kjozwiak
Copy link
Member

kjozwiak commented Sep 19, 2018

Maybe have a field that lets us know if the private key has been corrupted or not? Rather then having users check their keys and trying to explain what a corrupted key should look like, we could have something in chrome://versions that basically says:

  • rewards backup key: OK or rewards backup key: corrupted

Unless of course, the use case changes for Rewards and this isn't valid anymore.

I'm not sure how much work this will take, but we should try adding as much useful information as possible. It will make support a lot easier and users can just copy that section from chrome://versions and paste it into support issues. This will make it a lot easier to pin point the issue rather than going back on forth for days trying to retrieve relevant information. Firefox's about:support is a good example.

@LaurenWags
Copy link
Member Author

It doesn't look like we're showing the Last Contributed Date (for Brave Auto Contribute) anywhere on Rewards page, maybe that's a candidate to show as well?

@davidtemkin
Copy link

I agree @LaurenWags -- that should go here as support info

@srirambv
Copy link
Contributor

I would suggest adding the details to About Brave rather than chrome://version only because its relates more to how we request About Brave info. Also its easeir to do it from hamburger menu and chrome://version doesn't have an easy shortcut on the UI, unless we add a shortcut similar to Brave pages

@davidtemkin
Copy link

I generally agree, but If we do that @srirambv , we would need to hide it under a "support info" link, don't want to surface this info at the top level of "about Brave"

@kjozwiak
Copy link
Member

kjozwiak commented Sep 19, 2018

I personally think we should keep chrome://settings/help (About Brave) as clean as possible as that's where users will be redirected when checking for updates. I'm not sure if it's a good idea to have a wall of text with a bunch of debugging information on that page. The update page should be as clean as possible IMO.

System information should always go into a single area. Asking users to grab information from chrome://settings/help (About Brave) & chrome://version doesn't make sense. Easier to head into one area like chrome://version and having everything there.

I think Firefox does it best with about:support. It's nicely organized with categories etc.. When doing support, it's really easy to ask someone to head into about:support and copy a specific category.

@bbondy
Copy link
Member

bbondy commented Sep 22, 2018

See about:adblock for an example of a page that we added for some extra information for support. Mainly to see if regional adblocking is in use or not.
We could do something similar.

@NejcZdovc NejcZdovc modified the milestones: Releasable builds 0.55.x, 1.0, 1.x Backlog Sep 22, 2018
@rebron rebron added priority/P4 Planned work. We expect to get to it "soon". priority/P3 The next thing for us to work on. It'll ride the trains. and removed priority/P4 Planned work. We expect to get to it "soon". labels Sep 28, 2018
@bsclifton
Copy link
Member

bsclifton commented Sep 28, 2018

@NejcZdovc @ryanml @jasonrsadler would we be able to get this in before 1.0? 😊 Would definitely help with troubleshooting

@NejcZdovc
Copy link
Contributor

@bsclifton probably not

@NejcZdovc NejcZdovc modified the milestones: 1.x Backlog, 1.0 Oct 22, 2018
@davidtemkin
Copy link

We need to find a way to get this, or something like it, in before 1.0. We do not want to be live with millions of users on rewards with no clear way of supporting them. cc: @mrose17 as it is part of the reliability/diagnosability/supportability project.

@bbondy bbondy modified the milestones: 1.0, 1.x Backlog Oct 30, 2018
@mrose17
Copy link
Member

mrose17 commented Oct 31, 2018

my goal is to work on this with @tmancey's help and to have it into the development traincycle with the other brave ads work that we are doing.

@NejcZdovc NejcZdovc added this to the 0.63.x - Nightly milestone Feb 27, 2019
@bridiver
Copy link
Contributor

bridiver commented Mar 1, 2019

@davidtemkin adding a link for this to chrome://version requires a lot of patching and doesn't seem necessary or even desirable really since it's designed for QA and other "advanced" users. Is it really necessary?

@bridiver
Copy link
Contributor

bridiver commented Mar 1, 2019

if we want a link somewhere it makes much more sense to me to have it in the rewards UI and that doesn't require any patching

@davidtemkin
Copy link

@bridiver What's important isn't where it goes. What we need is diagnostic information that a user can share with us to diagnose problems with Brave Rewards , that can easily be found and copy/pasted without inordinate effort. It can go in the Rewards UI; we'd need to figure out where/how exactly.

@bbondy
Copy link
Member

bbondy commented Mar 1, 2019

Let's split this PR in 2 so we can land the important part that everyone agrees on without further discussion. Then PR the rest for a second issue to discuss the 2 possibilities.

@NejcZdovc
Copy link
Contributor

I agree. So let's remove link from chrome://version and create separate issue for it.

cc @emerick @kjozwiak @LaurenWags

@kjozwiak
Copy link
Member

kjozwiak commented Mar 1, 2019

I agree. So let's remove link from chrome://version and create separate issue for it.

cc @emerick @kjozwiak @LaurenWags

Sounds good 👍 Created #3538.

@bridiver
Copy link
Contributor

bridiver commented Mar 1, 2019

@davidtemkin my thought was just to move the link from brave://version to brave://rewards

@emerick
Copy link
Contributor

emerick commented Mar 1, 2019

The page is currently a static snapshot in time and doesn't dynamically update itself as data changes (other than if Rewards is enabled/disabled). Do we need to update dynamically or is a "snapshot" view acceptable? Another alternative could be a Refresh button, so it's obvious that the view is a snapshot.

cc: @bbondy @davidtemkin

@LaurenWags
Copy link
Member Author

I think we do need some way to refresh this as users can restore wallets, so if the data is a snapshot it sounds like it could potentially be out of sync with what their actual wallet info is.

@kjozwiak
Copy link
Member

kjozwiak commented Mar 3, 2019

Agreed with @LaurenWags. Making it dynamic is probably ideal. It will make support more complicated as we'll also need to make sure that the data that was given to us is actually the current state and not a snapshot of a previous state which might not be as useful. Could lead to confusion in terms of support.

I'm ok with having a "refresh" button if updating the information automatically is more difficult to implement. We can always ask users to hit the refresh button before submitting the data when they're receiving support. However, there's still a risk of users not listening and sharing data that was from an old Reward state if they don't hit that refresh button.

@NejcZdovc
Copy link
Contributor

@emerick correct me if I am wrong, but doesn't data update if you reload a page? I think we don't need refresh button if that is the case.

@srirambv
Copy link
Contributor

srirambv commented Mar 4, 2019

@NejcZdovc @emerick @bridiver can't we have a brave://rewards-internals page for logging and other debug info which is dynamic? Personally i feel rewards page is cramped up as it is and probably not a wise idea to have anymore on that page

Never mind saw that @emerick is already working on it in brave/brave-core#1139

@emerick
Copy link
Contributor

emerick commented Mar 4, 2019

@NejcZdovc Strangely enough, the data on the page only updates if you create a new tab; pressing the browser Reload button isn't enough to initiate it. It's relatively easy for me to add a "Refresh" button to the page, so will do that for now and then we can think about making it more dynamic down the line.

@btlechowski
Copy link

btlechowski commented Mar 20, 2019

Verification passed on

Brave 0.63.14 Chromium: 73.0.3683.75 (Official Build) dev (64-bit)
Revision 909ee014fcea6828f9a610e6716145bc0b3ebf4a-refs/branch-heads/3683@{#803}
OS Windows 10 OS Build 17134.523

Used test plan from brave/brave-core#1139
brave://rewards-internals/ works fine
brave://version/ does not link to brave://rewards-internals/. Logged #3806

Verification passed on

Brave 0.63.15 Chromium: 73.0.3683.75 (Official Build) dev (64-bit)
Revision 909ee014fcea6828f9a610e6716145bc0b3ebf4a-refs/branch-heads/3683@{#803}
OS Linux

Verified passed with

Brave 0.63.21 Chromium: 73.0.3683.75 (Official Build) dev(64-bit)
Revision 909ee014fcea6828f9a610e6716145bc0b3ebf4a-refs/branch-heads/3683@{#803}
OS Mac OS X
  • Verified navigating directly to brave://rewards-internals displayed Key Info Seed (valid) and Wallet Payment ID. Verified Refresh button updated info after restoring a wallet.

@kjozwiak kjozwiak changed the title add Brave Rewards information to chrome://version page Add chrome://rewards-internals to assist with support Apr 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.