Merge pull request #443 from tidepool-org/WEB-2965-exclude-days

WEB-2965 - Exclude Days with no insulin data in Basics

Author: henry-tp

data/print/fixtures.js

@@ -52,7 +52,6 @@ export const basicsData = {
   timePrefs,
   bgPrefs,
   metaData,
-  query: { excludeDaysWithoutBolus: true },
   data: {
     current: {
       endpoints: {

package.json

@@ -4,7 +4,7 @@
     "node": "20.8.0"
   },
   "packageManager": "[email protected]",
-  "version": "1.45.0-web-3418-redirect-oauth.2",
+  "version": "1.45.0-web-2965-exclude-days.2",
   "description": "Tidepool data visualization for diabetes device data.",
   "keywords": [
     "data visualization"

src/modules/print/BasicsPrintView.js

@@ -145,7 +145,7 @@ class BasicsPrintView extends PrintView {
     this.renderCalendarSection({
       title: {
         text: this.sections.boluses.title,
-        subText: _.get(this.data, 'query.excludeDaysWithoutBolus') ? t('(days with no boluses have been excluded)') : false,
+        subText: t('(days with no insulin data have been excluded)'),
       },
       data: this.aggregationsByDate.boluses.byDate,
       type: 'bolus',
@@ -648,10 +648,7 @@ class BasicsPrintView extends PrintView {
       const xPos = pos.x + padding.left;
       const yPos = pos.y + padding.top;
 
-      const isEmptyBolusDay = color === this.colors.bolus && count === 0;
-      const isExcludedBolusDay = isEmptyBolusDay && _.get(this.data, 'query.excludeDaysWithoutBolus', false);
-
-      this.setFill((type === 'outOfRange' || isExcludedBolusDay) ? this.colors.lightGrey : 'black', 1);
+      this.setFill((type === 'outOfRange') ? this.colors.lightGrey : 'black', 1);
 
       this.doc
         .fontSize(this.extraSmallFontSize)

src/utils/StatUtil.js

@@ -6,6 +6,7 @@ import { getTotalBasalFromEndpoints, getBasalGroupDurationsFromEndpoints } from
 import { getTotalBolus } from './bolus';
 import { cgmSampleFrequency, classifyBgValue } from './bloodglucose';
 import { BGM_DATA_KEY, MGDL_UNITS, MGDL_PER_MMOLL, MS_IN_DAY, MS_IN_MIN } from './constants';
+import { formatLocalizedFromUTC } from './datetime';
 
 /* eslint-disable lodash/prefer-lodash-method, no-underscore-dangle, no-param-reassign */
 
@@ -24,8 +25,8 @@ export class StatUtil {
     this.bgUnits = _.get(dataUtil, 'bgPrefs.bgUnits');
     this.bgSource = _.get(dataUtil, 'bgSources.current', BGM_DATA_KEY);
     this.activeDays = dataUtil.activeEndpoints.activeDays;
-    this.bolusDays = dataUtil.activeEndpoints.bolusDays || this.activeDays;
     this.endpoints = dataUtil.activeEndpoints.range;
+    this.timePrefs = _.get(dataUtil, 'timePrefs');
 
     this.log('activeDays', this.activeDays);
     this.log('bgSource', this.bgSource);
@@ -82,16 +83,24 @@ export class StatUtil {
     const rawBasalData = this.dataUtil.sort.byTime(this.dataUtil.filter.byType('basal').top(Infinity));
     const basalData = this.dataUtil.addBasalOverlappingStart(_.cloneDeep(rawBasalData));
 
+    // Create a list of all dates for which we have at least one datum
+    const uniqueDatumDates = new Set([
+      ...bolusData.map(datum => formatLocalizedFromUTC(datum.time, this.timePrefs, 'YYYY-MM-DD')),
+      ...rawBasalData.map(datum => formatLocalizedFromUTC(datum.time, this.timePrefs, 'YYYY-MM-DD')),
+    ]);
+
+    const activeDaysWithInsulinData = uniqueDatumDates.size;
+
     const basalBolusData = {
       basal: basalData.length
         ? parseFloat(getTotalBasalFromEndpoints(basalData, this.endpoints))
         : NaN,
       bolus: bolusData.length ? getTotalBolus(bolusData) : NaN,
     };
 
-    if (this.bolusDays > 1) {
-      basalBolusData.basal = basalBolusData.basal / this.bolusDays;
-      basalBolusData.bolus = basalBolusData.bolus / this.bolusDays;
+    if (activeDaysWithInsulinData > 1) {
+      basalBolusData.basal = basalBolusData.basal / activeDaysWithInsulinData;
+      basalBolusData.bolus = basalBolusData.bolus / activeDaysWithInsulinData;
     }
 
     return basalBolusData;
@@ -101,6 +110,14 @@ export class StatUtil {
     const wizardData = this.dataUtil.filter.byType('wizard').top(Infinity);
     const foodData = this.dataUtil.filter.byType('food').top(Infinity);
 
+    // Create a list of all dates for which we have at least one datum
+    const uniqueDatumDates = new Set([
+      ...wizardData.map(datum => formatLocalizedFromUTC(datum.time, this.timePrefs, 'YYYY-MM-DD')),
+      ...foodData.map(datum => formatLocalizedFromUTC(datum.time, this.timePrefs, 'YYYY-MM-DD')),
+    ]);
+
+    const activeDaysWithCarbData = uniqueDatumDates.size;
+
     const wizardCarbs = _.reduce(
       wizardData,
       (result, datum) => {
@@ -132,10 +149,10 @@ export class StatUtil {
       exchanges: wizardCarbs.exchanges,
     };
 
-    if (this.activeDays > 1) {
+    if (activeDaysWithCarbData > 1) {
       carbs = {
-        grams: carbs.grams / this.activeDays,
-        exchanges: carbs.exchanges / this.activeDays,
+        grams: carbs.grams / activeDaysWithCarbData,
+        exchanges: carbs.exchanges / activeDaysWithCarbData,
       };
     }
 

src/utils/basics/data.js

@@ -377,7 +377,6 @@ export function basicsText(patient, data, stats, aggregations) {
       },
     },
     metaData,
-    query,
     timePrefs,
   } = data;
 
@@ -386,9 +385,7 @@ export function basicsText(patient, data, stats, aggregations) {
   let basicsString = textUtil.buildDocumentHeader('Basics');
   basicsString += textUtil.buildDocumentDates();
 
-  if (_.get(query, 'excludeDaysWithoutBolus')) {
-    basicsString += textUtil.buildTextLine(t('Days with no boluses have been excluded from bolus calculations'));
-  }
+  basicsString += textUtil.buildTextLine(t('Days with no insulin data have been excluded from calculations'));
 
   basicsString += utils.statsText(stats, textUtil, bgPrefs);
 

src/utils/stat.js

@@ -318,15 +318,15 @@ export const getStatAnnotations = (data, type, opts = {}) => {
 
     case commonStats.averageDailyDose:
       if (days > 1) {
-        annotations.push(t('**Avg. Daily Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view.'));
+        annotations.push(t('**Avg. Daily Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view for which we have insulin data.'));
       } else {
         annotations.push(t('**Daily Insulin:** All basal and bolus insulin delivery (in Units) added together.'));
       }
       break;
 
     case commonStats.carbs:
       if (days > 1) {
-        annotations.push(t('**Avg. Daily Carbs**: All carb entries added together, then divided by the number of days in this view. Note, these entries come from either bolus wizard events, or Apple Health records.'));
+        annotations.push(t('**Avg. Daily Carbs**: All carb entries added together, then divided by the number of days in this view for which we have carb data. Note, these entries come from either bolus wizard events, or Apple Health records.'));
       } else {
         annotations.push(t('**Total Carbs**: All carb entries from bolus wizard events or Apple Health records added together.'));
       }
@@ -385,11 +385,11 @@ export const getStatAnnotations = (data, type, opts = {}) => {
 
     case commonStats.totalInsulin:
       if (days > 1) {
-        annotations.push(t('**Total Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view'));
+        annotations.push(t('**Total Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view for which we have insulin data'));
       } else {
         annotations.push(t('**Total Insulin:** All basal and bolus insulin delivery (in Units) added together'));
       }
-      annotations.push(t('**How we calculate this:**\n\n**(%)** is the respective total of basal or bolus delivery divided by total insulin delivered for this time period.'));
+      annotations.push(t('**How we calculate this:**\n\n**(%)** is the respective total of basal or bolus delivery divided by total insulin delivered for the time period for which we have insulin data.'));
       break;
 
     default:

test/modules/print/BasicsPrintView.test.js

@@ -232,7 +232,7 @@ describe('BasicsPrintView', () => {
       sinon.assert.calledWithMatch(Renderer.renderCalendarSection, {
         title: {
           text: Renderer.sections.boluses.title,
-          subText: '(days with no boluses have been excluded)',
+          subText: '(days with no insulin data have been excluded)',
         },
         data: Renderer.aggregationsByDate.boluses.byDate,
         type: 'bolus',

test/utils/StatUtil.test.js

@@ -423,6 +423,15 @@ describe('StatUtil', () => {
       });
     });
 
+    it('calculates insulin delivery using only data-populated days when viewing more than 1 day', () => {
+      filterEndpoints(twoDayEndpoints);
+      statUtil.activeDays = 7; // data only exists for 2 days; this should not impact the calculation
+      expect(statUtil.getBasalBolusData()).to.eql({
+        basal: 0.75,
+        bolus: 7.5,
+      });
+    });
+
     context('basal delivery overlaps endpoints', () => {
       it('should include the portion of delivery of a basal datum that overlaps the start endpoint', () => {
         statUtil.dataUtil.addData([basalDatumOverlappingStart], patientId);
@@ -482,6 +491,15 @@ describe('StatUtil', () => {
         total: 7,
       });
     });
+
+    it('calculates avg daily carbs using only data-populated days when viewing more than 1 day', () => {
+      filterEndpoints(twoDayEndpoints);
+      statUtil.activeDays = 7; // data only exists for 2 days; this should not impact the calculation
+      expect(statUtil.getCarbsData()).to.eql({
+        carbs: { grams: 21.5, exchanges: 1 },
+        total: 7,
+      });
+    });
   });
 
   describe('getCoefficientOfVariationData', () => {

test/utils/basics/data.test.js

@@ -589,7 +589,6 @@ describe('basics data utils', () => {
       },
       bgPrefs: bgPrefs[MGDL_UNITS],
       timePrefs,
-      query: { excludeDaysWithoutBolus: true },
       metaData: {
         devices: [
           { id: 'deviceWithLabelId', label: 'Device With Label' },
@@ -691,7 +690,7 @@ describe('basics data utils', () => {
 
     it('should add a note regarding excluded basics bolus days', () => {
       dataUtils.basicsText(patient, data, stats, aggregations);
-      sinon.assert.calledWith(textUtilStub.buildTextLine, 'Days with no boluses have been excluded from bolus calculations');
+      sinon.assert.calledWith(textUtilStub.buildTextLine, 'Days with no insulin data have been excluded from calculations');
     });
 
     it('should build the basics stats section', () => {

test/utils/stat.test.js

@@ -872,7 +872,7 @@ describe('stat', () => {
 
       it('should return annotations for `averageDailyDose` stat when viewing multiple days of data', () => {
         expect(stat.getStatAnnotations(data, commonStats.averageDailyDose, multiDayOpts)).to.have.ordered.members([
-          '**Avg. Daily Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view.',
+          '**Avg. Daily Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view for which we have insulin data.',
         ]);
       });
     });
@@ -887,7 +887,7 @@ describe('stat', () => {
 
       it('should return annotations for `carbs` stat when viewing multiple days of data', () => {
         expect(stat.getStatAnnotations(data, commonStats.carbs, multiDayOpts)).to.have.ordered.members([
-          '**Avg. Daily Carbs**: All carb entries added together, then divided by the number of days in this view. Note, these entries come from either bolus wizard events, or Apple Health records.',
+          '**Avg. Daily Carbs**: All carb entries added together, then divided by the number of days in this view for which we have carb data. Note, these entries come from either bolus wizard events, or Apple Health records.',
           'Derived from _**10**_ carb entries.',
         ]);
       });
@@ -1033,14 +1033,14 @@ describe('stat', () => {
       it('should return annotations for `totalInsulin` stat when viewing a single day of data', () => {
         expect(stat.getStatAnnotations(data, commonStats.totalInsulin, singleDayOpts)).to.have.ordered.members([
           '**Total Insulin:** All basal and bolus insulin delivery (in Units) added together',
-          '**How we calculate this:**\n\n**(%)** is the respective total of basal or bolus delivery divided by total insulin delivered for this time period.',
+          '**How we calculate this:**\n\n**(%)** is the respective total of basal or bolus delivery divided by total insulin delivered for the time period for which we have insulin data.',
         ]);
       });
 
       it('should return annotations for `totalInsulin` stat when viewing multiple days of data', () => {
         expect(stat.getStatAnnotations(data, commonStats.totalInsulin, multiDayOpts)).to.have.ordered.members([
-          '**Total Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view',
-          '**How we calculate this:**\n\n**(%)** is the respective total of basal or bolus delivery divided by total insulin delivered for this time period.',
+          '**Total Insulin:** All basal and bolus insulin delivery (in Units) added together, divided by the number of days in this view for which we have insulin data',
+          '**How we calculate this:**\n\n**(%)** is the respective total of basal or bolus delivery divided by total insulin delivered for the time period for which we have insulin data.',
         ]);
       });
     });