6598 - Add training cards

[latin-panda]

Description

This PR:

• Extends Enketo service to work with modals and save completed trainings.
• Adds a new modal component, "training cards", to load Enketo training forms.
• Extends XML Forms service to subscribe to training forms and react when new trainings are added.
• Adds test coverage for all new code.

Ticket: #6598

Code review checklist

• Readable: Concise, well named, follows the style guide, documented if necessary.
• Documented: Configuration and user documentation on cht-docs
• Tested: Unit and/or e2e where appropriate
• Internationalised: All user facing text
• Backwards compatible: Works with existing data and configuration or includes a migration. Any breaking changes documented in the release notes.

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

[latin-panda]

Hi @garethbowen, I think it'd be good to have feedback at this point.
The only thing pending is telemetry (next thing I'll be working) and any feedback the team gives today's night.
Thanks before hand
Edit: We're still trying to get a partner to implement this FR, so we still don't know if it's going to be 3.15.x. For now I've set master as base, once we know then I'll update the PR.

[garethbowen]

Sorry I'm not available to review this this week. I'll have a look next week if you haven't found another volunteer by then!

[latin-panda]

Hi @dianabarsan, do you have time to provide feedback? :)

[garethbowen]

Sorry for the delay here. I've given it a quick once over, but certainly not a full review. Happy to talk more about some of these concepts, particularly modal vs page, and db performance issues.

[garethbowen]

Awesome!

I've put a few mostly minor suggestions inline.

This will also need a happy day end-to-end test in webdriverio so we have automatic regression testing.

[garethbowen]

I've come up with a couple of other questions overnight while thinking about this...

1. Have you tested what happens if the training form has a long page? Does the modal get a scrollbar, or does the modal overflow and the window gets a scrollbar?
2. Have you thought about purging at all? Will existing purging rules eventually purge the successful completion reports and prompt the user to train again?
3. If the user cancels the training will they be prompted to do it again next time the app loads?
4. If there are multiple trainings for the user to go through, will the next one show up when they finish the first one? Do they have to reload to get the next one?

[latin-panda]

Have you tested what happens if the training form has a long page? Does the modal get a scrollbar, or does the modal overflow and the window gets a scrollbar?

Yes, the modal has scroll, but the team will advice to keep pages short as part of the best practices when designing trainings.

Have you thought about purging at all? Will existing purging rules eventually purge the successful completion reports and prompt the user to train again?

Yes, because we're letting training to behave as reports then the docs can be purged, the purge function will need to exclude trainings to prevent that. Also trainings can have a duration in days, so even if the completed training is deleted, it won't display to the user if the training has expired.

If the user cancels the training will they be prompted to do it again next time the app loads?

Yes, trainings will display when the app re/loads or if a new training is downloaded and it's set to display immediately. I haven't implemented an interval to show trainings again after X minutes, thinking to not disturb the user during other tasks, but this idea isn't completely discarded in the MVP yet, we'll observe user behaviours.

If there are multiple trainings for the user to go through, will the next one show up when they finish the first one? Do they have to reload to get the next one?

Trainings are display one at the time on re/load

Thanks for the questions, I'm going to link the team here in case there's a reconsideration or new ideas :)

[latin-panda]

I took the topic to the team (care team channel) and these are the take aways for each topic:

Have you tested what happens if the training form has a long page? Does the modal get a scrollbar, or does the modal overflow and the window gets a scrollbar?

A/ Long content: We should always aim for concise content and for now we can control this. We are willing to iterate more to improve experience after the test proves this solution is effective.

Have you thought about purging at all? Will existing purging rules eventually purge the successful completion reports and prompt the user to train again?

A/ Purging: Good one to consider later, but it shouldn’t block this test.

If the user cancels the training will they be prompted to do it again next time the app loads?

A/ Canceling: If a user cancels the training it makes sense to show it to them again on reload (instead of after x minutes), we want to observe the user behaviour.

If there are multiple trainings for the user to go through, will the next one show up when they finish the first one? Do they have to reload to get the next one?

A/ Multiple trainings: We control this for the test.

Linking here the other topic about when to display trainings for traceability with team discussion.

[garethbowen]

Awesome work! This is a really exciting feature.

Two suggestions inline, but approved pending those fixes.