feat(#6543): adds api-side support for users with multiple facilities

[dianabarsan]

Description

Covers:

• support for downloading and uploading doc permissions when a user has multiple facilities
• new users v3 api to add a user with multiple facilities
• new users v3 api to update a user to add multiple facilities
• updated users shared library to support multiple facilities
• updated recent users search api to support multiple facilities

Implementation details:

• when creating a user with multiple facilities, the contact has to be within one of the facilities
• /v3/users accepts the same payload and /v1/users
• /v3/users does not create facilities, only accepts an array of uuids of existing facilities
• /v3/users does not create a contact

Does not cover:

• validation to ensure all facilities are of the same type. We can add this, but right now it's not implemented

#6543

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]

@dianabarsan this is great! Thanks a lot
I left few comments as I was reading to understand the changes

I tested the app and seems to work fine for users with 1 facility and with more than one:

contact list

contact details

breadcrumbs

open in a tab

I was able to create and update users:

Create

When I change or add a facility to the user, my session expires, then I login, I still the see the old stuff, but after sync, I see the facilities updated.

[latin-panda]

Suggested change

	const getCommonFieldsUpdates = (userDoc, data) => {
	getRolesUpdates(data);
	if (data.roles) {
	userDoc.roles = data.roles;
	}
	const setCommonFieldsUpdates = (userDoc, data) => {
	const roles = getRolesUpdates(data);
	if (roles) {
	userDoc.roles = roles;
	}

[Benmuiruri]

We need to update the create-user URL to point to v3

[latin-panda]

@Benmuiruri, I think you can use v3 for single user, and keep v2 for multiple users.

[latin-panda]

Please feel free to dismiss my review to not block this PR 🙂

[Benmuiruri]

Hi @dianabarsan Jenni's comment suggests we should not change the URL for create-user to v3 and instead use createMultipleUsers .

However, that's not correct since the createMultipleUsers is for bulk uploading users... just a heads up on that.

[dianabarsan]

Hi @Benmuiruri

We are not going to change the bulk create in this iteration to support multiple facilities.

[Benmuiruri]

That's okay. But as it is... When I create a new user it goes to the v2 URL and fails

[dianabarsan]

Can you send the bulk request to v2 and the single request to v3?

[Benmuiruri]

For the most part all looks good. Just a question, how does the api handle an empty array for the place ?

There's the create-meta-db test in my branch that is returning code 400 with This user cannot have multiple places when place is set as an empty string

[dianabarsan]

Great point @Benmuiruri . I'll handle this case as well.

[Benmuiruri]

Hi @dianabarsan I believe this is ready to merge after Jenni and I reviewed it. Please rebase and merge if all is good so that I can rebase and merge Jenni's branches and my branches. Thanks.

[dianabarsan]

I think I added one more commit after your last review, that validates that the places list is correct, so we handle:

There's the create-meta-db test in my #9128 that is returning code 400 with This user cannot have multiple places when place is set as an empty string

The response is still 400 I believe, but this edge case is handled in code and tested for.

[Benmuiruri]

Thanks for adding the empty facility array check

@latin-panda is away.