feat(#9542): implement CouchDB Nouveau

[m5r]

Description

• npm run local-images
• COUCHDB_USER=admin COUCHDB_PASSWORD=pass docker compose -f ./local-build/cht-couchdb.yml -f ./local-build/cht-couchdb-override.yml up -d

Put this into ./local-build/cht-couchdb-override.yml:

services:
  couchdb:
    ports:
      - "5984:5984"
      - "5986:5986"

  nouveau:
    ports:
      - "5987:5987"
      - "5989:5989"

Query the indexes like so:

for contacts:

await fetch(
  'http://localhost:5984/medic/_design/medic-nouveau/_nouveau/contacts_by_freetext',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`,
    },
    body: JSON.stringify({
      q: 'name:asha', // 
      // possible 'sort' values are 'cht_sort_order' and '-cht_sort_order'. 'cht_sort_order' puts the dead and muted contacts last (current behavior of the contacts views), and '-cht_sort_order' puts them first
      sort: 'cht_sort_order',
      limit: 50,
      include_docs: true,
    }),
  },
);

for contacts by type:

await fetch(
  'http://localhost:5984/medic/_design/medic-nouveau/_nouveau/contacts_by_freetext',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`,
    },
    body: JSON.stringify({
      q: 'kianga AND cht_contact_type:district_hospital',
      sort: 'cht_sort_order',
      limit: 50,
      include_docs: true,
    }),
  },
);

for reports:

await fetch(
  'http://localhost:5984/medic/_design/medic-nouveau/_nouveau/reports_by_freetext',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`,
    },
    body: JSON.stringify({
      q: 'ali',
      limit: 50,
      include_docs: true,
    }),
  },
);

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.