feat(#9231): add filter in aggregate targets (#9317)

Co-authored-by: Jennifer Q <[email protected]>
Co-authored-by: Tatiana Lépiz Soto <[email protected]>
Co-authored-by: Rafa <[email protected]>

Author: 4 people

api/resources/translations/messages-en.properties

@@ -349,6 +349,7 @@ analytics.target.aggregates.reported = Reported
 analytics.target.aggregates.select.error = Error loading target aggregate.
 analytics.target.aggregates.supervisees.meeting.goal = CHWs meeting goal
 analytics.target.aggregates.total = Total
+analytics.target.aggregates.reporting_period = Reporting period
 analytics.target.goal = Goal
 analytics.target.goal.help = If you don't want to display a goal enter a value of "-1".
 analytics.target.icon = Icon
@@ -1327,6 +1328,7 @@ targets.pnc_registrations.title = PNC registrations
 targets.pnc_visits.title = PNC visits
 targets.pregnancy_registrations.title = New pregnancies
 targets.this_month.subtitle = This month
+targets.last_month.subtitle = Last month
 targets.vaccines_given.title = Vaccines given
 task.date = Due date
 task.days.left = {DAYS, plural, one{1 day left} other{\# days left}}

api/resources/translations/messages-es.properties

@@ -349,6 +349,7 @@ analytics.target.aggregates.reported = Reportado
 analytics.target.aggregates.select.error = Error al cargar el objetivo consolidado.
 analytics.target.aggregates.supervisees.meeting.goal = Promotores de salud comunitaria que alcanzaron la meta.
 analytics.target.aggregates.total = Total
+analytics.target.aggregates.reporting_period = Periodo del informe
 analytics.target.goal = Meta
 analytics.target.goal.help = Si no desea mostrar una meta, ingrese el valor de "-1".
 analytics.target.icon = Icono
@@ -638,7 +639,7 @@ email.invalid = Dirección de correo electrónico no válida.
 empty = El mensaje esta en blanco, por favor reenvielo. Si continua teniendo problemas, informe a su supervisor.
 enketo.constraint.invalid = Valor no permitido
 enketo.constraint.required = Este campo es obligatorio
-enketo.drawwidget.annotation = anotación
+enketo.drawwidget.annotation = anotación
 enketo.drawwidget.drawing = dibujo
 enketo.drawwidget.signature = firma
 enketo.error.max_attachment_size = Los archivos subidos exceden el límite de tamaño total. Suba archivos más pequeños.
@@ -1327,6 +1328,7 @@ targets.pnc_registrations.title = Registros de CP
 targets.pnc_visits.title = Visitas de CP
 targets.pregnancy_registrations.title = Nuevos embarazos
 targets.this_month.subtitle = Este mes
+targets.last_month.subtitle = El mes pasado
 targets.vaccines_given.title = Vacunas administradas
 task.date = Fecha límite
 task.days.left = {DAYS, plural, one{falta 1 día} other{faltan \# dias}}

api/resources/translations/messages-fr.properties

@@ -349,6 +349,7 @@ analytics.target.aggregates.reported = Signalé
 analytics.target.aggregates.select.error = Erreur lors du chargement de l'agrégat objectif.
 analytics.target.aggregates.supervisees.meeting.goal = ASC qui ont atteint l'objectif
 analytics.target.aggregates.total = Total
+analytics.target.aggregates.reporting_period = Période des rapports
 analytics.target.goal = But
 analytics.target.goal.help = Si vous ne souhaitez pas afficher d'objectif, saisissez la valeur "-1".
 analytics.target.icon = Icone
@@ -1327,6 +1328,7 @@ targets.pnc_registrations.title = Enregistrements CPoN
 targets.pnc_visits.title = Visites CPoN
 targets.pregnancy_registrations.title = Nouvelles grossesses
 targets.this_month.subtitle = Ce mois
+targets.last_month.subtitle = Le mois dernier
 targets.vaccines_given.title = Vaccins donnés
 task.date = Date d'échéance
 task.days.left = {JOURS, plural, one{1 jour restant} other{\# jours restants}}

api/resources/translations/messages-id.properties

@@ -344,6 +344,7 @@ analytics.target.aggregates.reported =
 analytics.target.aggregates.select.error = 
 analytics.target.aggregates.supervisees.meeting.goal = 
 analytics.target.aggregates.total = 
+analytics.target.aggregates.reporting_period = Periode pelaporan
 analytics.target.goal = Tujuan
 analytics.target.goal.help = 
 analytics.target.icon = Icon
@@ -1244,6 +1245,7 @@ targets.pnc_registrations.title =
 targets.pnc_visits.title = 
 targets.pregnancy_registrations.title = Kehamilan terdaftar
 targets.this_month.subtitle = Bulan ini
+targets.last_month.subtitle = Bulan sebelumnya
 targets.vaccines_given.title = Vaksin yang diberikan
 task.date = Batas Tanggal Terakhir
 task.days.left = 

api/resources/translations/messages-ne.properties

@@ -348,6 +348,7 @@ analytics.target.aggregates.reported =
 analytics.target.aggregates.select.error = 
 analytics.target.aggregates.supervisees.meeting.goal = 
 analytics.target.aggregates.total = 
+analytics.target.aggregates.reporting_period = रिपोर्टिङ अवधि
 analytics.target.goal = 
 analytics.target.goal.help = 
 analytics.target.icon = 
@@ -1253,7 +1254,8 @@ targets.past_3mos.subtitle =
 targets.pnc_registrations.title = 
 targets.pnc_visits.title = 
 targets.pregnancy_registrations.title = 
-targets.this_month.subtitle = 
+targets.this_month.subtitle = यो महिना
+targets.last_month.subtitle = अघिल्लो महिना
 targets.vaccines_given.title = 
 task.date = अनुमानित मिति
 task.days.left = 

api/resources/translations/messages-sw.properties

@@ -349,6 +349,7 @@ analytics.target.aggregates.reported = Imeripotiwa
 analytics.target.aggregates.select.error = Hitilafu katika kupakia jumla ya malengo
 analytics.target.aggregates.supervisees.meeting.goal = Wafanyikazi wa afya wa Jamii wanafikisha lengo
 analytics.target.aggregates.total = Jumla
+analytics.target.aggregates.reporting_period = Kipindi cha kuripoti
 analytics.target.goal = Lengo
 analytics.target.goal.help = Ikiwa hutaki kuonyesha lengo weka thamani ya "-1"
 analytics.target.icon = Ikoni
@@ -1327,6 +1328,7 @@ targets.pnc_registrations.title = Usajili wa PNC
 targets.pnc_visits.title = Ziara za PNC
 targets.pregnancy_registrations.title = Mimba mpya
 targets.this_month.subtitle = Mwezi huu
+targets.last_month.subtitle = Mwezi uliopita
 targets.vaccines_given.title = Chanjo iliyopewa
 task.date = Tarehe ya kukamilisha
 task.days.left = {DAYS, plural, one{Imesalia siku 1} other{Zimesalia siku \#}}

shared-libs/calendar-interval/src/index.js

@@ -50,6 +50,11 @@ const getInterval = (intervalStartDate, referenceDate = moment()) => {
   };
 };
 
+const getPreviousInterval = (intervalStartDate, referenceDate = moment()) => {
+  referenceDate = referenceDate.clone().subtract(1, 'month');
+  return getInterval(intervalStartDate, referenceDate);
+};
+
 module.exports = {
   // Returns the timestamps of the start and end of the current calendar interval
   // @param {Number} [intervalStartDate=1] - day of month when interval starts (1 - 31)
@@ -59,6 +64,17 @@ module.exports = {
   // [12-31 -> 01-30], [01-31 -> 02-[28|29]], [03-01 -> 03-30], [03-31 -> 04-30], [05-01 -> 05-30], [05-31 - 06-30]
   getCurrent: (intervalStartDate) => getInterval(intervalStartDate),
 
+  /** Returns the timestamps of the start and the end of the previous calendar interval
+   *  intervalStartDate: Number. Day of the month when interval starts
+   *  referenceDate: Date.
+   */
+  getPrevious: (intervalStartDate, referenceDate) => {
+    if (referenceDate) {
+      return getPreviousInterval(intervalStartDate, moment(referenceDate));
+    }
+    return getPreviousInterval(intervalStartDate);
+  },
+
   /**
    * Returns the timestamps of the start and end of the a calendar interval that contains a reference date
    * @param {Number} [intervalStartDate=1] - day of month when interval starts (1 - 31)

shared-libs/calendar-interval/test/index.js

@@ -252,6 +252,80 @@ describe('CalendarInterval', () => {
     });
   });
 
+  describe('getPrevious', () => {
+    it('returns 1st of previous month when month start is 1', () => {
+      clock = sinon.useFakeTimers(moment('2024-07-15 21:10:01').valueOf());
+      chai.expect(service.getPrevious(1)).to.deep.equal({
+        start: moment('2024-06-01 00:00:00').valueOf(),
+        end: moment('2024-06-30 23:59:59:999').valueOf(),
+      });
+      clock.restore();
+    });
+
+    it('returns 1st of previous month when reference date is provided', () => {
+      const referenceDate = '2024-07-15';
+      chai.expect(service.getPrevious(1, referenceDate)).to.deep.equal({
+        start: moment('2024-06-01 00:00:00').valueOf(),
+        end: moment('2024-06-30 23:59:59:999').valueOf(),
+      });
+    });
+
+    it('returns 1st of previous month when reference date provided is in the future', () => {
+      const referenceDate = '2025-07-15';
+      chai.expect(service.getPrevious(1, referenceDate)).to.deep.equal({
+        start: moment('2025-06-01 00:00:00').valueOf(),
+        end: moment('2025-06-30 23:59:59:999').valueOf(),
+      });
+    });
+
+    it('returns n-th of the previous month when month start is n <= current date', () => {
+      clock = sinon.useFakeTimers(moment('2018-03-20 21:10:01').valueOf());
+      chai.expect(service.getPrevious(15)).to.deep.equal({
+        start: moment('2018-02-15 00:00:00').valueOf(),
+        end: moment('2018-03-14 23:59:59:999').valueOf(),
+      });
+      clock.restore();
+    });
+
+    it('returns n-th of two months ago when month start is n > current date', () => {
+      clock = sinon.useFakeTimers(moment('2018-03-10 21:10:01').valueOf());
+      chai.expect(service.getPrevious(20)).to.deep.equal({
+        start: moment('2018-01-20 00:00:00').valueOf(),
+        end: moment('2018-02-19 23:59:59:999').valueOf(),
+      });
+      clock.restore();
+    });
+
+    it('returns correct previous period when incorrect start date values', () => {
+      clock = sinon.useFakeTimers(moment('2018-02-10').valueOf());
+      [null, undefined, -1, 'date', false, 0, 35].forEach((invalidStart) => {
+        chai.expect(service.getPrevious(invalidStart)).to.deep.equal({
+          start: moment('2018-01-01 00:00:00').valueOf(),
+          end: moment('2018-01-31 23:59:59:999').valueOf(),
+        });
+      });
+      clock.restore();
+    });
+
+    it('returns correct previous period when start date same as current date', () => {
+      clock = sinon.useFakeTimers(moment('2018-04-15').valueOf());
+      chai.expect(service.getPrevious(15)).to.deep.equal({
+        start: moment('2018-03-15 00:00:00').valueOf(),
+        end: moment('2018-04-14 23:59:59:999').valueOf(),
+      });
+      clock.restore();
+    });
+
+    it('returns correct start date in previous month if month has 30 days', () => {
+      clock = sinon.useFakeTimers(moment('2018-05-15').valueOf());
+      chai.expect(service.getPrevious(31)).to.deep.equal({
+        start: moment('2018-03-31 00:00:00').valueOf(),
+        end: moment('2018-04-30 23:59:59:999').valueOf(),
+      });
+      clock.restore();
+    });
+  });
+
   describe('getInterval', () => {
     it('returns 1st of current month when month start is not set or incorrect', () => {
       let timestamp;

tests/e2e/default/targets/config/target-aggregates.js

@@ -0,0 +1,68 @@
+const TARGETS_DEFAULT_CONFIG = [
+  {
+    id: 'count_no_goal',
+    type: 'count',
+    title: 'count no goal',
+    aggregate: true,
+    subtitle_translation_key: 'targets.all_time.subtitle'
+  },
+  {
+    id: 'count_with_goal',
+    type: 'count',
+    title: 'count with goal',
+    goal: 20,
+    aggregate: true,
+    subtitle_translation_key: 'targets.all_time.subtitle'
+  },
+  {
+    id: 'percent_no_goal',
+    type: 'percent',
+    title: 'percent no goal',
+    aggregate: true,
+    subtitle_translation_key: 'targets.all_time.subtitle'
+  },
+  {
+    id: 'percent_with_goal',
+    type: 'percent',
+    title: 'percent with goal',
+    aggregate: true, goal: 80,
+    subtitle_translation_key: 'targets.this_month.subtitle'
+  },
+  {
+    id: 'percent_achieved',
+    type: 'percent',
+    title: 'percent achieved',
+    aggregate: true, goal: 10,
+    subtitle_translation_key: 'targets.this_month.subtitle'
+  },
+];
+
+const TARGETS_CONFIG_WITH_AND_WITHOUT_AGGREGATES = [
+  { id: 'not_aggregate', type: 'count', title: 'my task' },
+  { id: 'also_not_aggregate', type: 'count', title: 'my task' },
+  { id: 'also_also_not_aggregate', type: 'count', title: 'my task', aggregate: false },
+  ...TARGETS_DEFAULT_CONFIG
+];
+
+const EXPECTED_DEFAULTS_TARGETS = [
+  { id: 'count_no_goal', title: 'count no goal', progressBar: false, goal: false, counter: '25' },
+  { id: 'count_with_goal', title: 'count with goal', progressBar: true, goal: 20, counter: '0 of 5' },
+  { id: 'percent_no_goal', title: 'percent no goal', progressBar: true, goal: false, counter: '50%' },
+  { id: 'percent_with_goal', title: 'percent with goal', progressBar: true, goal: '80%', counter: '5 of 5' },
+  { id: 'percent_achieved', title: 'percent achieved', progressBar: true, goal: '10%', counter: '5 of 5' },
+];
+
+const EXPECTED_TARGETS_NO_PROGRESS = [
+  { id: 'count_no_goal', title: 'count no goal', counter: '0', progressBar: false, goal: false },
+  { id: 'count_with_goal', title: 'count with goal', counter: '0 of 5', progressBar: true, goal: 20 },
+  { id: 'percent_no_goal', title: 'percent no goal', counter: '0%', progressBar: true, goal: false },
+  { id: 'percent_with_goal', title: 'percent with goal', counter: '0 of 5', progressBar: true, goal: '80%' },
+  { id: 'percent_achieved', title: 'percent achieved', counter: '0 of 5', progressBar: true, goal: '10%',  },
+];
+
+module.exports = {
+  TARGETS_DEFAULT_CONFIG,
+  TARGETS_CONFIG_WITH_AND_WITHOUT_AGGREGATES,
+  EXPECTED_DEFAULTS_TARGETS,
+  EXPECTED_TARGETS_NO_PROGRESS,
+};