Merge pull request #477 from tidepool-org/WEB-3698-dosing-decision-bolus-normal

[BACK-3698/BACK-3697] Updates to dosing decision model

Author: clintonium-119

data/types.js

@@ -426,8 +426,8 @@ export class DosingDecision extends Common {
       }],
       deviceTime: this.makeDeviceTime(),
       reason: 'normalBolus',
-      recommendedBolus: { amount: '2' },
-      requestedBolus: { amount: '1.5' },
+      recommendedBolus: { normal: '2' },
+      requestedBolus: { normal: '1.5' },
       units: MGDL_UNITS,
     });
 

package.json

@@ -4,7 +4,7 @@
     "node": "20.8.0"
   },
   "packageManager": "[email protected]",
-  "version": "1.47.0-web-3688-twiist-suppressed-basal-data.2",
+  "version": "1.46.1-web-3698-dosing-decision-bolus-normal",
   "description": "Tidepool data visualization for diabetes device data.",
   "keywords": [
     "data visualization"

src/utils/DataUtil.js

@@ -226,6 +226,16 @@ export class DataUtil {
       d.sampleInterval = sampleInterval;
     }
 
+    // Use normal instead of deprecated amount for recommendedBolus and requestedBolus
+    if (d.type === 'dosingDecision') {
+      _.each([d.recommendedBolus, d.requestedBolus], (bolus) => {
+        if (_.isObject(bolus)) {
+          bolus.normal = _.get(bolus, 'normal', _.get(bolus, 'amount'));
+          delete bolus.amount;
+        }
+      });
+    }
+
     // We validate datums before converting the time and deviceTime to hammerTime integers,
     // as we want to validate that they are valid ISO date strings
     this.validateDatumIn(d);
@@ -258,7 +268,7 @@ export class DataUtil {
     }
 
     // Populate mappings to be used for 2-way join of boluses and dosing decisions
-    if (d.type === 'dosingDecision' && _.includes(['normalBolus', 'simpleBolus', 'watchBolus'], d.reason)) {
+    if (d.type === 'dosingDecision' && _.includes(['normalBolus', 'simpleBolus', 'watchBolus', 'oneButtonBolus'], d.reason)) {
       this.bolusDosingDecisionDatumsByIdMap[d.id] = d;
     }
 
@@ -325,7 +335,7 @@ export class DataUtil {
       );
 
       const sortedProximateDosingDecisions = _.orderBy(proximateDosingDecisions, ({ time }) => Math.abs(time - d.time), 'asc');
-      const dosingDecisionWithMatchingNormal = _.find(sortedProximateDosingDecisions, dosingDecision => dosingDecision.requestedBolus?.amount === d.normal);
+      const dosingDecisionWithMatchingNormal = _.find(sortedProximateDosingDecisions, dosingDecision => dosingDecision.requestedBolus?.normal === d.normal);
       d.dosingDecision = dosingDecisionWithMatchingNormal || sortedProximateDosingDecisions[0];
 
       if (d.dosingDecision) {
@@ -334,7 +344,7 @@ export class DataUtil {
         d.dosingDecision.pumpSettings = this.pumpSettingsDatumsByIdMap[associatedPumpSettingsId];
 
         // Translate relevant dosing decision data onto expected bolus fields
-        d.expectedNormal = d.dosingDecision.requestedBolus?.amount;
+        d.expectedNormal = d.dosingDecision.requestedBolus?.normal;
         d.carbInput = d.dosingDecision.food?.nutrition?.carbohydrate?.net;
         d.bgInput = _.last(d.dosingDecision.bgHistorical || [])?.value;
         d.insulinOnBoard = d.dosingDecision.insulinOnBoard?.amount;
@@ -740,6 +750,7 @@ export class DataUtil {
     if (d.type === 'dosingDecision') {
       this.normalizeDatumBgUnits(d, ['bgTargetSchedule'], ['low', 'high']);
       this.normalizeDatumBgUnits(d, ['bgForecast'], ['value']);
+      this.normalizeDatumBgUnits(d, ['bgHistorical'], ['value']);
       this.normalizeDatumBgUnits(d, ['smbg'], ['value']);
       if (_.isObject(d.pumpSettings)) this.normalizeDatumOut(d.pumpSettings, fields);
     }

src/utils/bolus.js

@@ -127,7 +127,7 @@ export function getRecommended(insulinEvent) {
     return NaN;
   }
   const netRecommendation = event.recommendedBolus
-    ? _.get(event, ['recommendedBolus', 'amount'], null)
+    ? _.get(event, ['recommendedBolus', 'normal'], null)
     : _.get(event, ['recommended', 'net'], null);
 
   if (netRecommendation !== null) {
@@ -369,7 +369,7 @@ export function isUnderride(insulinEvent) {
 export function isCorrection(insulinEvent) {
   const recommended = insulinEvent.dosingDecision
     ? {
-      correction: _.get(insulinEvent, 'dosingDecision.recommendedBolus.amount'),
+      correction: _.get(insulinEvent, 'dosingDecision.recommendedBolus.normal'),
       carb: _.get(insulinEvent, 'dosingDecision.food.nutrition.carbohydrate.net', 0),
     }
     : _.get(insulinEvent, 'wizard.recommended', insulinEvent.recommended);

stories/data/DataUtil.js

@@ -287,6 +287,7 @@ stories.add('Query Generator', (opts, props) => {
       ...computedFields,
       associations: 'associations',
       bgForecast: 'bgForecast',
+      bgHistorical: 'bgHistorical',
       bgTargetSchedule: 'bgTargetSchedule',
       bolus: 'bolus',
       food: 'food',

test/utils/DataUtil.test.js

@@ -972,17 +972,18 @@ describe('DataUtil', () => {
       it('should add the datum to the `bolusDosingDecisionDatumsByIdMap`', () => {
         dataUtil.validateDatumIn = sinon.stub().returns(true);
 
-        const acceptableReasons = ['normalBolus', 'simpleBolus', 'watchBolus'];
-        const dosingDecisionReasons = ['loop', 'normalBolus', 'simpleBolus', 'watchBolus'];
+        const acceptableReasons = ['normalBolus', 'simpleBolus', 'watchBolus', 'oneButtonBolus'];
+        const dosingDecisionReasons = ['loop', 'normalBolus', 'simpleBolus', 'watchBolus', 'oneButtonBolus'];
         _.each(dosingDecisionReasons, (reason, index) => {
           dataUtil.normalizeDatumIn({ type: 'dosingDecision', id: `ID${index}`, reason });
         });
 
         // the 'loop' reason datum should not be added
-        expect(_.keys(dataUtil.bolusDosingDecisionDatumsByIdMap)).to.have.lengthOf(3);
+        expect(_.keys(dataUtil.bolusDosingDecisionDatumsByIdMap)).to.have.lengthOf(4);
         expect(dataUtil.bolusDosingDecisionDatumsByIdMap.ID1.reason).to.eql(acceptableReasons[0]);
         expect(dataUtil.bolusDosingDecisionDatumsByIdMap.ID2.reason).to.eql(acceptableReasons[1]);
         expect(dataUtil.bolusDosingDecisionDatumsByIdMap.ID3.reason).to.eql(acceptableReasons[2]);
+        expect(dataUtil.bolusDosingDecisionDatumsByIdMap.ID4.reason).to.eql(acceptableReasons[3]);
       });
     });
 
@@ -1050,7 +1051,7 @@ describe('DataUtil', () => {
         time: Date.parse('2024-02-02T10:05:00.000Z'),
         origin: { name: 'org.tidepool.Loop' },
         associations: [{ reason: 'pumpSettings', id: 'pumpSettings1' }],
-        requestedBolus: { amount: 12 },
+        requestedBolus: { normal: 12 },
         insulinOnBoard: { amount: 4 },
         food: { nutrition: { carbohydrate: { net: 30 } } },
         bgHistorical: [
@@ -2016,6 +2017,13 @@ describe('DataUtil', () => {
         sinon.assert.calledWithMatch(dataUtil.normalizeDatumBgUnits, datum, ['bgForecast'], ['value']);
       });
 
+      it('should call `normalizeDatumBgUnits` on bgHistorical field objects', () => {
+        sinon.spy(dataUtil, 'normalizeDatumBgUnits');
+        const datum = { type: 'dosingDecision' };
+        dataUtil.normalizeDatumOut(datum);
+        sinon.assert.calledWithMatch(dataUtil.normalizeDatumBgUnits, datum, ['bgHistorical'], ['value']);
+      });
+
       it('should call `normalizeDatumBgUnits` on smbg field objects', () => {
         sinon.spy(dataUtil, 'normalizeDatumBgUnits');
         const datum = { type: 'dosingDecision' };

test/utils/bolus.test.js

@@ -303,7 +303,7 @@ const withDosingDecision = {
   insulinOnBoard: 2.654,
   dosingDecision: {
     recommendedBolus: {
-      amount: 2.8,
+      normal: 2.8,
     },
     insulinOnBoard: {
       amount: 2.2354,
@@ -321,7 +321,7 @@ const withDosingDecisionOverride = {
   dosingDecision: {
     ...withDosingDecision.dosingDecision,
     recommendedBolus: {
-      amount: withDosingDecision.normal - 0.5,
+      normal: withDosingDecision.normal - 0.5,
     },
   },
 };
@@ -331,7 +331,7 @@ const withDosingDecisionUnderride = {
   dosingDecision: {
     ...withDosingDecision.dosingDecision,
     recommendedBolus: {
-      amount: withDosingDecision.normal + 0.5,
+      normal: withDosingDecision.normal + 0.5,
     },
   },
 };
@@ -340,7 +340,7 @@ const withDosingDecisionCorrection = {
   ...withDosingDecision,
   dosingDecision: {
     ...withDosingDecision.dosingDecision,
-    recommendedBolus: { amount: 0.5 },
+    recommendedBolus: { normal: 0.5 },
     food: { nutrition: { carbohydrate: { net: 0 } } },
   },
 };
@@ -552,9 +552,9 @@ describe('bolus utilities', () => {
       expect(bolusUtils.getRecommended(withNetRec)).to.equal(net);
     });
 
-    it('should return `amount` rec when `amount` rec exists on dosing decision', () => {
-      const { recommendedBolus: { amount } } = withDosingDecision.dosingDecision;
-      expect(bolusUtils.getRecommended(withDosingDecision)).to.equal(amount);
+    it('should return `normal` rec when `normal` rec exists on dosing decision', () => {
+      const { recommendedBolus } = withDosingDecision.dosingDecision;
+      expect(bolusUtils.getRecommended(withDosingDecision)).to.equal(recommendedBolus.normal);
     });
 
     it('should return 0 when no bolus recommended, even if overridden', () => {