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

UI suggestions for updating and validating #192

Open
nsheff opened this issue Jul 7, 2023 · 0 comments
Open

UI suggestions for updating and validating #192

nsheff opened this issue Jul 7, 2023 · 0 comments
Milestone

Comments

@nsheff
Copy link
Contributor

nsheff commented Jul 7, 2023

There are 2 tasks a user can do with their sample table: 1) save; 2) validate.

There are also 2 ways we can design the UI: 1) Task happens automatically on change; or 2) User must click a button to perform action.

Right now, we are doing this:

  1. For the save task, we require the user to click "Save" (not automatic).
  2. For validate, we do it automatically, on change.

One reason we made save require clicking is that it's an expensive operation that overwrites the entire project. However, with the most recent database update, samples are now stored in an independent table. This allows us to update individual samples atomically. Therefore, we should change the UI to use an onChange, send the changed sample (the raw in the table) to an endpoint to update just that sample.

Advantages:

  1. This will eliminate the need to click "save", making the UI more streamlined.
  2. This will improve performance, by only updating a sample.

For validate, though, we currently require sending the whole project, so therefore it's a more expensive task, so it's expensive to do with onChange the way it is now.

Proposed solution

If we could validate individual samples, then individual samples could be validated using the save endpoint, onchange. they could be both saved and validated on change. Eido in fact already offers a way to validate individual samples. Therefore, we could in fact just send the sample row a single time, onChange, and it could be 1) validated as a sample; and 2) saved. An equivalent thing could happen for validating the project config only, when that changes.

Then, for entire project validation, I propose the user must trigger with a button press.

I think this is probably the best way to implement the UI.

@nsheff nsheff changed the title UI suggesitons for updating and validating UI suggestions for updating and validating Jul 7, 2023
@nsheff nsheff added this to the v0.11.x milestone Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant