feat(#8074): add filter by parent to db-object widget

[latin-panda]

Description

• This feature is applied when using the appearance:descendant-of-current-contact
• The scope remains for forms that are opened in the contact tab; it takes the contact ID from the URL.
• It uses the CouchDB view contact_by_parent in combination with the contact type.

Usage

type	name	label:en	appearance
string	a-person	select a person	select-contact type-person descendant-of-current-contact

#8074

CHT Docs PR

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.

Compose URLs

If Build CI hasn't passed, these may 404:

• Core
• CouchDB Single
• CouchDB Cluster

License

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

[latin-panda]

@jkuester I still need to complete the e2e, but I wanted your feedback on this work. I tried not to make big changes in the code and to keep it simple for app builders.

[latin-panda]

@Benmuiruri @tatilepizs, welcome to review as well.

@tatilepizs, do you think waiting for Enketo's e2e refactor is better? I'm still trying to figure out how to check the dropdown options.

[tatilepizs]

Hey,

do you think waiting for Enketo's e2e refactor is better?

Depending on the urgency of this feature. I sent the PR to review yesterday, and I expect feedback until next year because a lot of us will be on vacation these last weeks of the year. So I don't think that the PR will be merged soon.

I'm still trying to figure out how to check the dropdown options.

I didn't add a common option to validate dropdowns because I think that only one test that we have right now contains the dropdown widget.
This is the tests (enketo-widgets.wdio-spec.js) and this is the page object file (enketo-widgets.wdio.page.js) that evaluates the widget.
If you think that it will be a good idea to include a dropdown selector in the common ones please let me know and we can do it 😄

Thank you @latin-panda

[jkuester]

Code looks great! 🤩 Very clean and well tested!

One concern I have is around the naming of with-same-parent. To me, that sounds like it will be filtering the searchable contacts to be limited to siblings of the contact in context (the ones that have the same parent as the current contact). However, with this implementation, it is actually limiting the searchable contacts to children of the contact in context (and all their descendants).

An appearance name more like descendant-of-current-contact would make more sense to me (not a huge fan of that name either, but it seems more accurate and I have not been able to think of a better one)....

Also, just a reminder that we definitely want to update the docs to describe this functionality!

[latin-panda]

@michaelkohn What do you think about Josh's idea of using descendant-of-current-contact instead of with-same-parent?

IMO, it's long but descriptive. I prefer things to be descriptive :)

[latin-panda]

I was struggling with this e2e being flaky, this seems to work.

[tatilepizs]

Thank you @latin-panda for adding the e2e test.
I just left a comment in place.

[jkuester]

LGTM!

[Benmuiruri]

Awesome work!

[latin-panda]

@tatilepizs When you have time, can you please review this again?

[tatilepizs]

It looks good @latin-panda, thank you!! 🌟