G4.114 Update validation feedback shown to the user

[carolyncaron]

Branch

g4.114-updateValidationFeedback

Groups

Group 4 - API | Services | Plugins

Describe

This issue is meant to address the overall design of how validation statuses and messages get relayed back to the user.

This is where the current design is at previous to our current milestone for this module:

Design

We (@laceysanderson, @reynoldtan, @ruobinLiu and I) held a meeting to discuss what we'd like to see, both in terms of how it should look for all importers, and specifically the needs of the Traits Importer. These are the things we decided that can begin to be implemented and we can reconvene as needed:

• Update the feedback "engine" to expect a render array from each feedback item (which may include feedback from 1+ validators)
• To update the processValidationMessages() method in TraitsImporter to format the messages we want the user to see. We may need to entertain additional methods either in the TraitsImporter class or to the individual validator classes to prevent the code from being too overwhelming
• We think that continuing to use status icons (representing pass/fail/todo) are helpful and even colour-coding if applicable