CarnegieLearningWeb / UpGrade

Framework for adding A/B testing to education applications
https://www.upgradeplatform.org/
BSD 3-Clause "New" or "Revised" License
26 stars 13 forks source link

Researcher needs to validate experiment design when saving an experiment to ensure valid data for the client application. #402

Open mswartzCL opened 2 years ago

mswartzCL commented 2 years ago

User Story

Acceptance Criteria

Design - Link to design

Context Metadata Model Context Metadata Gist

zackcl commented 2 years ago

I don't think we need to validate the context metadata and provide feedback (e.g. showing error icons) when creating an experiment though the stepper UI because the fields that need validation (e.g. Site, Target, Condition) can be completed using the combo box, and the available options will be pulled from the metadata so it guarantees the validation anyway (unless the user intentionally wants to use invalid values). So I think we should validate an experiment and provide feedback after it is created or updated (in the detail page), and not during the creation or editing process (in the stepper UI).

mswartzCL commented 2 years ago

@zackcl Based on our conversation today about validation in the stepper and edit modals vs. displayed on the experiment detail, I am going to refine and combine stories #402 and #403.

mswartzCL commented 2 years ago

@zackcl What do you think about this user story now?

zackcl commented 2 years ago

@mswartzCL Thanks for updating the story. I think that looks good although I think we might want to still let the user know if the Context Metadata for an AppContext does not exist while the validation checkbox is enabled. Maybe we can show an error icon next to the experiment name (just like when validation failed) to indicate that something is wrong. Otherwise, the user might think that the Context Metadata exists and has been validated.

Experiment Detail - Overview (mismatch Inactive) 10