Evaluation Form Validation - Part 1

[r-bartlett-gsa]

User story

As a challenge manager, in order to ensure that a valid form is available for the evaluators to use, I would like a form to be validated for errors and valid logic before it is saved.

Acceptance Criteria:

• When a challenge manager saves the form:
  • All required fields must be provided
  • The form must be assigned to a challenge / challenge phase that is not closed we still need to assign a closed phase that doesn't have a form defined yet
  • The form must have at least one evaluation criteria
    • If weighted scale is used, then a total weight for all criteria must add up to 100
  • The form is not saved if it does not pass required field validation
• If the form contains missing required fields of invalid information an inline error message is displayed, and if the form is saved with any invalid information, an error message is displayed at the top of the page, Evaluation Form Validation - Part 2 #296
• A challenge manager can cancel the form and the form is not saved
• The form is auto saved only when the form is in editing mode and all required fields are provided

Development tasks:

• Update evaluation_forms model with required data #188
• validate weighted scoring criteria #204

Definition of Done

Doing (dev team)

• Code complete
• Code is organized appropriately
• Any known trade offs are documented in the associated GH issue
• Code is documented, modules, shared functions, etc.
• Automated testing has been added or updated in response to changes in this PR
• The feature is smoke tested to confirm it meets requirements
• Database changes have been peer reviewed for index changes and performance bottlenecks
• PR that changes or adds UI
  • include a screenshot of the WAVE report for the altered pages
  • Confirm changes were validated for mobile responsiveness
• PR approved / Peer reviewed
• Security scans passed
• Automate accessibility tests passed
• Build process and deployment is automated and repeatable
• Feature toggles if appropriate
• Deploy to staging
• Move card to testing column in the board

---

Staging

• Usability testing: mobile and desktop (Tracy or Marni)
• Accessibility tested (Marni)
  • Keyboard navigation
  • Focus confirmed
  • Color contrast compliance
  • Screen reader testing
• Cross browser testing - UI rendering is performant on below listed devices/browsers (Tracy or Marni)
  • Windows/Chrome
  • Windows/Edge
  • Mac/Chrome
  • Mac/Safari
  • iOS/Safari
• AC review (Renata)
• Deploy to production (production-like environment for eval capability) (dev team)
• Move to production column in the board

---

Production

• User and security documentation has been reviewed for necessary updates (Renata/Tracy/Dev team)
• PO / PM approved (Jarah or Renata)
• AC is met and it works as expected (Jarah or Renata)
• Move to done column in the board (Jarah or Renata)

[r-bartlett-gsa]

---

[r-bartlett-gsa]

@stepchud Testing feedback moved from #61

• Form validation error message is not displayed for missing form fields if any of the criteria fields are missing/incorrect
• Inline error notifications are not shown for criteria fields (the message is not the same as for the other fields and it disappears after clicking anywhere on the screen)
• Cancelation modal is not displayed

New feedback:

• When creating a new form, if there's any validation error when saving the form, scoring type option get removed/hidden. This does not happen if editing an existing form. See Tracy's video in the below comment.
  • Additionally, if validation error is resolved, it allows to save the form with Scale Options hidden. Reopening that saved form, Scale Options display again how they were initially entered in.
• Form title and criteria title character limit is not validated at 150 characters

[TCKapGrp]

Hi @r-bartlett-gsa , I know this one is sitting at AC fail right now, but ran into this during testing of other cards. When validating the form and there are errors, the rating scale options drop off the form. Didn't want this to get lost as it doesn't seem to be an expected result. See video: https://drive.google.com/file/d/1f6V2k5NV5pCt0pNypgl32xfiorp2sM9Q/view?usp=drive_link

[r-bartlett-gsa]

Thank you @TCKapGrp I added this finding the list above.

[r-bartlett-gsa]

Just for the record, the following character limits should apply to form fields:

• Form title: 150
• Evaluation instructions: 3000
• Criteria title: 150
• Criteria description: 1000

(Discussed in #160)

[stepchud]

The form is auto saved only when the form is in editing mode and all required fields are provided

@r-bartlett-gsa is this still a requirement for this Story?

[r-bartlett-gsa]

The form is auto saved only when the form is in editing mode and all required fields are provided

@r-bartlett-gsa is this still a requirement for this Story?

@stepchud Let's leave it out for now.