CareKit
CareKit copied to clipboard
carekit-apple
Implemented TaskCategory entity #355
Addresses issue #355.
A new TaskCategory entity was introduced. This feature helps to organize OCKTasks in categories. This way the user can categorize the tasks by a medical condition, by the type of action, or in any other way they want.
Database modifications
New entities
TaskCategory
...
- title
- asset (image name)
- notes array (contains the list of textual notes created by the practitioners or the patient)
New relationships
TaskCategory -> CarePlan
CarePlan ->> TaskCategory
TaskCategory ->> Task
Task -> TaskCategory
-> has one
->> ... has many
Considerations
-
Shouldn't we add an "Uncategorized" TaskCategory that will always be there and all the Tasks that are not associated with any TaskCategory will be displayed when this "Uncategorized" TaskCategory is selected? ... Currently, the taskCategory property is optional. To implement the "Uncategorized" TaskCategory would mean adding a special logic for this use-case. A more generic solution is to solve this issue upon task creation. If you create a new task, you'll choose a category. In no category is selected, there will be the default "Uncategorized" TaskCategory. But this logic is something to be decided by the end-user (the programmer of a particular app). Some apps might not want to categorize the tasks, so the default category would render no benefit.
-
Nesting of the categories ... It's a bit tricky because Swift structs cannot be nested directly (to prevent infinite loop upon initialization). The alternative is to use IDs. Is this something that is desirable? What is the best way to achieve nesting?
-
Gravirawson's suggestion https://github.com/carekit-apple/CareKit/issues/355#issuecomment-584300892: create an OCKCategory instead of OCKTaskCategory for CarePlans and other use-cases. ... What would be the use-case for the care plan category? Could be the same category reused in multiple different entities?
-
Should the TaskCategory to Task relationship be many-to-many instead? ... This would provide more flexibility. Right now, I only have one task category per task for simplicity's sake. The many-to-many would enable to filter tasks by different sets of categories. This is especially useful for the implementation of the "All tasks" category (that we can include in the list of categories).
TaskCategory ->> Task
Task ->> TaskCategory
-
What is the best way to integrate this new functionality in terms of UI? ... Really an open question for debate. I created a very basic category selection view controller that in turn presents the daily list of tasks filtered by a task category. Should the filtering happen on the main screen? Or would a completely different UI be more appropriate? The original idea was to create the same drill-down experience as in the Apple Health app.
-
Should we keep the notes array in the OCKTaskCategory?
@erik-apple for some reason the CI is giving me a failure in some of the unit tests, although they pass when I run them locally. Are you able to reproduce?
✗ testTaskQueryOnPastDateReturnsPastVersionOfATask, XCTAssertTrue failed - Expected to get 1 task, but got 0
✗ testTaskQueryOnPastDateReturnsPastVersionOfATask, XCTAssertTrue failed
Yes, that’s a known issue. We’ve noticed that it happens at a certain time of day, and only on Travis’s CI servers. We are unable to reproduce it locally as well.
If you wait a couple hours and rerun the tests they will pass. Don’t worry about it for now though, we’ll ensure they pass before we merge.
@erik-apple Hi Erik, it's been awhile, would you mind giving me some guidance so that I can make all required alterations to get this PR merged? Thanks in advance!