feat(#9489): collect telemetry for offline freetext searching

shared-libs/search/src/generate-search-requests.js

@@ -191,7 +191,7 @@ const sortByLastVisitedDate = () => {
 const makeCombinedParams = (freetextRequest, typeKey) => {
   const type = typeKey[0];
   const params = {};
-  if (freetextRequest.key) {
+  if (freetextRequest.params.key) {
     params.key = [ type, freetextRequest.params.key[0] ];
   } else {
     params.startkey = [ type, freetextRequest.params.startkey[0] ];

tests/e2e/default/enketo/pregnancy-danger-sign-follow-up.wdio-spec.js

@@ -11,7 +11,7 @@ describe('Pregnancy danger sign follow-up form', () => {
   const person = personFactory.build();
 
   const fillPregnancyDangerSignFollowUpForm = async (attendToVisit, hasDangerSigns) => {
-    await genericForm.selectContact(person.name);
+    await genericForm.selectContact(person.name, 'What is the patient\'s name?');
     await genericForm.nextPage();
     await commonEnketoPage.selectRadioButton('Did the woman visit the health facility as recommended?', attendToVisit);
     await commonEnketoPage.selectRadioButton('Is she still experiencing any danger signs?', hasDangerSigns);

tests/e2e/default/telemetry/forms/select_contact_telemetry.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<h:html xmlns="http://www.w3.org/2002/xforms" xmlns:h="http://www.w3.org/1999/xhtml" xmlns:ev="http://www.w3.org/2001/xml-events" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:jr="http://openrosa.org/javarosa" xmlns:orx="http://openrosa.org/xforms">
+    <h:head>
+        <h:title>Select contact by type and without type</h:title>
+        <model>
+            <itext>
+                <translation lang="en">
+                    <text id="/data/select_contact_by_type:label">
+                        <value>Select the contact by type</value>
+                    </text>
+                    <text id="/data/select_contact_without_type:label">
+                        <value>Select the contact without type</value>
+                    </text>
+                </translation>
+            </itext>
+            <instance>
+                <data id="select_contact_telemetry" prefix="J1!select_contact_telemetry!" delimiter="#" version="2024-10-30 16-00">
+                   <select_contact_by_type/>
+                   <select_contact_without_type/>
+                    <meta tag="hidden">
+                        <instanceID/>
+                    </meta>
+                </data>
+            </instance>
+            <bind nodeset="/data/select_contact_by_type" type="db:person"/>
+            <bind nodeset="/data/select_contactselect_contact_without_type"/>
+        </model>
+    </h:head>
+    <h:body class="pages">
+        <group appearance="field-list" ref="/data">
+            <input appearance="select-contact" ref="/data/select_contact_by_type">
+                <label ref="jr:itext('/data/select_contact_by_type:label')"/>
+            </input>
+            <input appearance="select-contact" ref="/data/select_contact_without_type">
+                <label ref="jr:itext('/data/select_contact_without_type:label')"/>
+            </input>
+        </group>
+    </h:body>
+</h:html>

tests/e2e/default/telemetry/telemetry.wdio-spec.js

@@ -1,3 +1,4 @@
+const { Key } = require('webdriverio');
 const commonPage = require('@page-objects/default/common/common.wdio.page');
 const utils = require('@utils');
 const moment = require('moment');
@@ -6,46 +7,82 @@ const placeFactory = require('@factories/cht/contacts/place');
 const personFactory = require('@factories/cht/contacts/person');
 const { faker: Faker } = require('@faker-js/faker');
 const userFactory = require('@factories/cht/users/users');
+const searchPage = require('@page-objects/default/search/search.wdio.page');
+const contactPage = require('@page-objects/default/contacts/contacts.wdio.page');
+const reportsPage = require('@page-objects/default/reports/reports.wdio.page');
+const pregnancyFactory = require('@factories/cht/reports/pregnancy');
+const genericForm = require('@page-objects/default/enketo/generic-form.wdio.page');
+const fs = require('fs');
 const { BRANCH, TAG } = process.env;
 
-const setupUser = () => {
+describe('Telemetry', () => {
   const places = placeFactory.generateHierarchy();
-  const districtHospital = places.get('district_hospital');
+  const clinic = places.get('clinic');
+  const patient = personFactory.build({
+    phone: '+12068881234',
+    parent: { _id: clinic._id, parent: clinic.parent },
+  });
+
+  const healthCenter = places.get('health_center');
   const contact = personFactory.build({
-    name: Faker.name.firstName(),
-    parent: { _id: districtHospital._id },
+    name: Faker.person.firstName(),
+    parent: { _id: healthCenter._id },
+    phone: '+9779841299392',
   });
   const user = userFactory.build({
     username: Faker.internet.userName().toLowerCase().replace(/[^0-9a-zA-Z_]/g, ''),
     password: 'Secret_1',
-    place: districtHospital._id,
+    place: healthCenter._id,
     contact: contact._id,
     known: true,
   });
+  const pregnancyReport = pregnancyFactory.build({
+    fields: {
+      patient_id: patient.patient_id,
+      patient_uuid: patient._id,
+      name: patient.name,
+    },
+    contact: {
+      _id: contact._id,
+      parent: contact.parent,
+    },
+    from: contact.phone,
+  });
+  let reportDocs;
 
-  return {
-    docs: [
-      ...places.values(),
-      contact,
-    ],
-    user,
-  };
-};
-
-describe('Telemetry', () => {
   const DATE_FORMAT = 'YYYY-MM-DD';
   const TELEMETRY_PREFIX = 'telemetry';
-  let user;
-  let docs;
+  const todayDBName = `${TELEMETRY_PREFIX}-${moment().format(DATE_FORMAT)}-${user.username}`;
 
   before(async () => {
-    ({ docs, user } = setupUser());
-    await utils.saveDocs(docs);
+    const selectContactTelemetryForm = utils.deepFreeze({
+      _id: 'form:select_contact_telemetry',
+      internalId: 'select_contact_telemetry',
+      title: 'Select contact by type and without type',
+      type: 'form',
+      _attachments: {
+        xml: {
+          content_type: 'application/octet-stream',
+          data: Buffer
+            .from(fs.readFileSync(`${__dirname}/forms/select_contact_telemetry.xml`, 'utf8'))
+            .toString('base64'),
+        },
+      },
+    });
+
+    await utils.saveDocIfNotExists(selectContactTelemetryForm);
+    await utils.saveDocs([...places.values(), contact, patient]);
+    reportDocs = await utils.saveDocs([pregnancyReport]);
     await utils.createUsers([user]);
     await loginPage.login(user);
     await commonPage.waitForPageLoaded();
   });
 
+  after(async () => {
+    await utils.deleteUsers([user]);
+    await utils.revertDb([/^form:(?!select_contact_telemetry)/], true);
+  });
+
   it('should record telemetry', async () => {
     const yesterday = moment().subtract(1, 'day');
     const yesterdayDBName = `${TELEMETRY_PREFIX}-${yesterday.format(DATE_FORMAT)}-${user.username}`;
@@ -82,4 +119,89 @@ describe('Telemetry', () => {
     const version = TAG || utils.escapeBranchName(BRANCH) || clientDdoc.build_info.base_version;
     expect(clientDdoc.build_info.version).to.include(version);
   });
+
+  describe('search matches telemetry', () => {
+    afterEach(async () => {
+      // eslint-disable-next-line no-undef
+      await browser.execute((dbName) => window.PouchDB(dbName).destroy(), todayDBName);
+    });
+
+    const getTelemetryEntryByKey = async (key) => {
+      const todayTelemetryDocs = await browser.execute(async (dbName) => {
+        // eslint-disable-next-line no-undef
+        const docs = await window.PouchDB(dbName).allDocs({ include_docs: true });
+        return docs.rows.filter(row => row.doc.key.startsWith('search_match'));
+      }, todayDBName);
+      return todayTelemetryDocs.filter(row => row.doc.key === key);
+    };
+
+    it('should record telemetry for contact searches', async () => {
+      await commonPage.goToPeople();
+
+      const [firstName, lastName] = patient.name.split(' ');
+      const phone = patient.phone;
+      const patient_id = patient.patient_id;
+      const searchTerms = [firstName, lastName, phone, patient_id, `patient_id:${patient_id}`];
+      for (const searchTerm of searchTerms) {
+        await searchPage.performSearch(searchTerm);
+        await contactPage.selectLHSRowByText(patient.name, false);
+        await searchPage.clearSearch();
+      }
+
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:name')).to.have.lengthOf(2);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:phone')).to.have.lengthOf(1);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:patient_id')).to.have.lengthOf(1);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:patient_id:$value')).to.have.lengthOf(1);
+    });
+
+    it('should record telemetry for reports searches', async () => {
+      await commonPage.goToReports();
+
+      const [firstName, lastName] = patient.name.split(' ');
+      const phone = contact.phone;
+      const patient_id = patient.patient_id;
+      const searchTerms = [firstName, lastName, phone, patient_id, `patient_id:${patient_id}`];
+      for (const searchTerm of searchTerms) {
+        await searchPage.performSearch(searchTerm);
+        await reportsPage.openReport(reportDocs[0].id);
+        await searchPage.clearSearch();
+      }
+
+      expect(await getTelemetryEntryByKey('search_match:reports_by_freetext:fields.name')).to.have.lengthOf(2);
+      expect(await getTelemetryEntryByKey('search_match:reports_by_freetext:from')).to.have.lengthOf(1);
+      expect(await getTelemetryEntryByKey('search_match:reports_by_freetext:fields.patient_id')).to.have.lengthOf(1);
+      expect(await getTelemetryEntryByKey('search_match:reports_by_freetext:patient_id:$value')).to.have.lengthOf(1);
+    });
+
+    it('should record telemetry for contact searches from the select2 component', async () => {
+      await browser.url(`/#/contacts/${patient._id}/report/select_contact_telemetry`);
+      await commonPage.waitForPageLoaded();
+
+      const [firstName, lastName] = patient.name.split(' ');
+      const searchTerms = [firstName, lastName, patient.phone, `phone:${patient.phone}`];
+
+      for (const searchTerm of searchTerms) {
+        await genericForm.selectContact(patient.name, 'Select the contact by type', searchTerm);
+        await genericForm.clearSelectedContact('Select the contact by type');
+      }
+
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_type_freetext:name')).to.have.lengthOf(2);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_type_freetext:phone')).to.have.lengthOf(1);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_type_freetext:phone:$value')).to.have.lengthOf(1);
+
+      const searchField = await $('.select2-search__field');
+      if (await searchField.isDisplayed()) {
+        await browser.keys(Key.Escape);
+      }
+
+      for (const searchTerm of searchTerms) {
+        await genericForm.selectContact(patient.name, 'Select the contact without type', searchTerm);
+        await genericForm.clearSelectedContact('Select the contact without type');
+      }
+
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:name')).to.have.lengthOf(2);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:phone')).to.have.lengthOf(1);
+      expect(await getTelemetryEntryByKey('search_match:contacts_by_freetext:phone:$value')).to.have.lengthOf(1);
+    });
+  });
 });

tests/page-objects/default/enketo/generic-form.wdio.page.js

@@ -11,6 +11,7 @@ const validationErrors = () => $$('.invalid-required');
 const waitForValidationErrorsToDisappear = () => browser.waitUntil(async () => !(await validationErrors()).length);
 const waitForValidationErrors = () => browser.waitUntil(async () => (await validationErrors()).length);
 const fieldByName = (formId, name) => $(`#report-form [name="/${formId}/${name}"]`);
+const select2Selection = (label) => $(`label*=${label}`).$('.select2-selection');
 
 const nextPage = async (numberOfPages = 1, waitForLoad = true) => {
   if (waitForLoad) {
@@ -29,19 +30,27 @@ const nextPage = async (numberOfPages = 1, waitForLoad = true) => {
   }
 };
 
-const selectContact = async (contactName) => {
-  const select2Selection = () => $('label*=What is the patient\'s name?').$('.select2-selection');
-  await (await select2Selection()).click();
+const selectContact = async (contactName, label, searchTerm = '') => {
   const searchField = await $('.select2-search__field');
-  await searchField.setValue(contactName);
-  const contact = await $('.name');
+  if (!await searchField.isDisplayed()) {
+    await (await select2Selection(label)).click();
+  }
+
+  await searchField.setValue(searchTerm || contactName);
+  await $('.select2-results__option.loading-results').waitForDisplayed({ reverse: true });
+  const contact = await $(`.name*=${contactName}`);
   await contact.waitForDisplayed();
   await contact.click();
+
   await browser.waitUntil(async () => {
-    return (await (await select2Selection()).getText()).toLowerCase().endsWith(contactName.toLowerCase());
+    return (await (await select2Selection(label)).getText()).toLowerCase().endsWith(contactName.toLowerCase());
   });
 };
 
+const clearSelectedContact = async (label) => {
+  await (await select2Selection(label)).$('.select2-selection__clear').click();
+};
+
 const submitForm = async ({ waitForPageLoaded = true, ignoreValidationErrors = false } = {}) => {
   await formTitle().click();
   if (!ignoreValidationErrors) {
@@ -101,6 +110,7 @@ module.exports = {
   nameField,
   fieldByName,
   selectContact,
+  clearSelectedContact,
   cancelForm,
   submitForm,
   currentFormView,