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

probe-mobile-Android: add UI support for displaying OONI Run link descriptors #2471

Open
hellais opened this issue May 9, 2023 · 6 comments · May be fixed by ooni/probe-ios#520, ooni/probe-android#582 or ooni/probe-ios#533

Comments

@hellais
Copy link
Member

hellais commented May 9, 2023

This issue is only about implement the UI part which takes in an OONI Run link descriptor and renders the appropriate test card in the dashboard view. See: "3.0 OONI Run descriptor": https://github.com/ooni/spec/blob/master/backends/bk-005-ooni-run-v2.md#30-ooni-run-descriptor.

It does not involve actually scheduling the test for autorun, nor running it through manual runs.

@hellais
Copy link
Member Author

hellais commented Aug 9, 2023

A prototype of this is implemented in the mobile app.

We made a list of improvements to implement as a next iteration, which is:

  • When you tap on an OONI Run link which includes a list of URLs, the list of URLs should be displayed inside of the Run screen. Possibly it can be an indented list under the name of the test.
  • The primary action after having clicked on an OONI Run link should be “Install”. Following that it should redirect the user over the to test overview page where they can at that point initiate the actual run of the test.
  • Probably as part of the install workflow, we should have 2 checkboxes above it, which allow the user to choose if they should accept updates automatically for the run link or not and if the run link should be part of autorun. The default settings should be to not accept updates automatically and for it to be part of autorun. We can tweak the default following the usability study.
  • It should be possible for somebody to install an OONI Run link even if there is a background test currently running. At the moment when I click on an OONI Run link and there is a test already running it tells me that I cannot run it until it finished.
  • We should include space for displaying the long description in this page too (am I correct that what is currently shown is just the short description?)
  • We should display somewhere the author of the OONI Run link
  • Support for icon should be added
  • We should be sure something weird doesn’t happen when the short description is too long as we don’t have control over that. If we can’t render properly short descriptions longer than X chars, we should enforce server-side/client-side validation on the maximum length to prevent breakage
  • Displaying results which come from tests with inputs and without are tricky. I think when that happens we might want to introduce an intermediate page which shows the summary level information for the tested URLs and only when tapping on the row do you get the details. Similarly to how we do it in the result listing page for the websites test group
  • The fact we are using the experimental animation here, made me thing of the fact that maybe we want to have a set of lottie animation strings that OONI Run link creators can pick from and opt for displaying here. Alternatively, for OONI Run links we can just display a big icon of the icon the user picked instead of an animation.
  • This is probably already an issue in the app, but if you go to the test results screen, but you haven’t run a test yet, you will get an error. This is not so nice and we should probably have a better zero state for a test which is currently in progress. It stay in that state until the test is complete so as to prevent confusion with believing that a result has finished running, while it’s still in progress
  • Maybe we should have a pattern here for displaying summary level information also for OONI Run links. At a bare minimum it would be nice to have the total count of individual measurements that were run. This would also make these rows more consistent with the other rows making it clearer that they are tappable and there is something inside of them. (this is a long standing issue that people don’t get that these rows are tappable)
  • Maybe the OONI Run link descriptor should include the ability to pick the hex code of the color used for displaying the OONI Run link row

@hellais
Copy link
Member Author

hellais commented Aug 9, 2023

@aanorbel can you update the above list with what has been done and what is still missing?

@hellais
Copy link
Member Author

hellais commented Aug 9, 2023

In order to consider this epic done we should have landed ooni/probe-android#582 into a staging branch for ooni run v2 and all future work will happen as branches targeting this staging branch.

@aanorbel aanorbel linked a pull request Aug 9, 2023 that will close this issue
29 tasks
@aanorbel
Copy link

Probably as part of the install workflow, we should have 2 checkboxes above it, which allow the user to choose if they should accept updates automatically for the run link or not and if the run link should be part of autorun. The default settings should be to not accept updates automatically and for it to be part of autorun. We can tweak the default following the usability study.

ooni/probe-android#599

@jbonisteel
Copy link
Contributor

Initial support is there, need to update UI based on designs. Will meet with designer on the 9th and make updates after that

@agrabeli
Copy link
Member

agrabeli commented Nov 20, 2023

I tried testing the latest version which includes details under each card (such as Websites), and my main feedback is that based on the new UI, the Run button is not very visible and "hard" to find. Even though I'm an OONI Probe / OONI Run power user, at first I had difficulty understanding how to run the Websites test, and I had to go back and forth several times. Only after a few minutes did I realize that the Run button was hidden in gray (?) at the bottom right corner.

As I imagine that other users may face the same difficulty, I'd suggest that we make the Run button more visible. Maybe we can add it as a big blue button at the top?

@jbonisteel jbonisteel changed the title probe-mobile: add UI support for displaying OONI Run link descriptors probe-mobile-Android: add UI support for displaying OONI Run link descriptors Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment