Merge pull request #472 from tidepool-org/WEB-2016-ciq-pump-settings-targets-annotations

[WEB-2016] CIQ pump settings annotations

Author: clintonium-119

package.json

@@ -4,7 +4,7 @@
     "node": "20.8.0"
   },
   "packageManager": "[email protected]",
-  "version": "1.46.0-web-3501-range-thresholds.5",
+  "version": "1.46.0-web-2016-ciq-pump-settings-targets-annotations.2",
   "description": "Tidepool data visualization for diabetes device data.",
   "keywords": [
     "data visualization"
@@ -73,6 +73,7 @@
     "react-collapse": "5.1.1",
     "react-dimensions": "1.3.1",
     "react-dom": "16.14.0",
+    "react-i18next": "13.3.1",
     "react-markdown": "8.0.7",
     "react-motion": "0.5.2",
     "react-redux": "8.1.3",

src/components/settings/Tandem.css

@@ -105,6 +105,14 @@
   composes: bolusHeaderBackground settingsHeader from './settings.css';
 }
 
+.annotations {
+  margin-left: 40px;
+  margin-right: 40px;
+  margin-top: 30px;
+  font-size: 14px;
+  font-weight: 500;
+}
+
 @media print {
 
   .title {

src/components/settings/Tandem.js

@@ -29,6 +29,8 @@ import { MGDL_UNITS, MMOLL_UNITS } from '../../utils/constants';
 import { deviceName, insulinSettings } from '../../utils/settings/data';
 import * as tandemData from '../../utils/settings/tandemData';
 import { tandemText } from '../../utils/settings/textData';
+import { isControlIQ } from '../../utils/device';
+import { Trans } from 'react-i18next';
 
 import i18next from 'i18next';
 const t = i18next.t.bind(i18next);
@@ -83,6 +85,14 @@ const Tandem = (props) => {
             columns={settingsColumns}
             tableStyle={styles.settingsTableInverted}
           />
+
+          {isControlIQ(pumpSettings) && (
+            <div className={styles.annotations}>
+              <Trans i18nKey="tandem.annotations">
+                * - The numbers displayed here are the user-defined values. During automation, Tandem Control-IQ uses its own preset Insulin Duration and Target BG. However users can set different values for these parameters that <strong>only</strong> apply in manual mode.
+              </Trans>
+            </div>
+          )}
         </CollapsibleContainer>
       </div>
     );

src/modules/print/SettingsPrintView.js

@@ -35,7 +35,7 @@ import {
   target,
 } from '../../utils/settings/nonTandemData';
 
-import { getPumpVocabulary } from '../../utils/device';
+import { getPumpVocabulary, isControlIQ } from '../../utils/device';
 
 import {
   basalSchedules as profileSchedules,
@@ -206,6 +206,26 @@ class SettingsPrintView extends PrintView {
       this.renderInsulinSettings(this.latestPumpUpload.settings, schedule.name);
       this.doc.moveDown();
     });
+
+    if (isControlIQ(this.latestPumpUpload.settings)) {
+      this.setFill(this.colors.grey);
+
+      this.doc
+        .font(this.font)
+        .text(t('* - The numbers displayed here are the user-defined values. During automation, Tandem Control-IQ uses its own preset Insulin Duration and Target BG. However users can set different values for these parameters that '), {
+          continued: true,
+          lineGap: 4,
+        })
+        .font(this.boldFont)
+        .text(t('only'), {
+          continued: true,
+        })
+        .font(this.font)
+        .text(t(' apply in manual mode.'));
+
+      this.setFill();
+      this.doc.moveDown();
+    }
   }
 
   renderPumpSettings() {

src/utils/device.js

@@ -42,7 +42,7 @@ export function isTidepoolLoop(datum = {}) {
 }
 
 /**
- * Check to see datum is from Twiist Loop
+ * Check to see if datum is from Twiist Loop
 */
 export function isTwiistLoop(datum = {}) {
   if (datum.type === 'upload') {
@@ -52,6 +52,13 @@ export function isTwiistLoop(datum = {}) {
   return (/^com.dekaresearch.twiist/).test(_.get(datum, 'origin.name', datum?.client?.name || ''));
 }
 
+/**
+ * Check to see if datum is from Control-IQ
+ */
+export function isControlIQ(datum = {}) {
+  return _.get(datum, 'deviceId', '').indexOf('tandemCIQ') === 0;
+}
+
 /**
  * Check to see if datum is from a known Loop device
  */
@@ -68,7 +75,7 @@ export function isLoop(datum = {}) {
  */
 export function isAutomatedBasalDevice(manufacturer, pumpSettingsOrUpload = {}, deviceModel) {
   return _.includes(_.get(AUTOMATED_BASAL_DEVICE_MODELS, deviceName(manufacturer), []), deviceModel)
-    || (manufacturer === 'tandem' && _.get(pumpSettingsOrUpload, 'deviceId', '').indexOf('tandemCIQ') === 0)
+    || (manufacturer === 'tandem' && isControlIQ(pumpSettingsOrUpload))
     || isLoop(pumpSettingsOrUpload);
 }
 
@@ -79,7 +86,7 @@ export function isAutomatedBasalDevice(manufacturer, pumpSettingsOrUpload = {},
  * @returns {Boolean}
  */
 export function isAutomatedBolusDevice(manufacturer, pumpSettingsOrUpload = {}) {
-  return (manufacturer === 'tandem' && _.get(pumpSettingsOrUpload, 'deviceId', '').indexOf('tandemCIQ') === 0)
+  return (manufacturer === 'tandem' && isControlIQ(pumpSettingsOrUpload))
     || isDIYLoop(pumpSettingsOrUpload);
 }
 
@@ -90,7 +97,7 @@ export function isAutomatedBolusDevice(manufacturer, pumpSettingsOrUpload = {})
  * @returns {Boolean}
  */
 export function isSettingsOverrideDevice(manufacturer, pumpSettingsOrUpload = {}) {
-  return (manufacturer === 'tandem' && _.get(pumpSettingsOrUpload, 'deviceId', '').indexOf('tandemCIQ') === 0)
+  return (manufacturer === 'tandem' && isControlIQ(pumpSettingsOrUpload))
   || isLoop(pumpSettingsOrUpload);
 }
 

src/utils/settings/data.js

@@ -20,7 +20,7 @@ import i18next from 'i18next';
 
 import * as datetime from '../datetime';
 import * as format from '../format';
-import { getPumpVocabulary, isLoop } from '../device';
+import { getPumpVocabulary, isControlIQ, isLoop } from '../device';
 
 import {
   MAX_BOLUS,
@@ -432,7 +432,7 @@ export function insulinSettings(settings, manufacturer, scheduleName) {
   const rows = [
     { setting: deviceLabels[MAX_BASAL], value: maxBasal ? `${maxBasal} U/hr` : '-' },
     { setting: deviceLabels[MAX_BOLUS], value: maxBolus ? `${maxBolus} U` : '-' },
-    { setting: deviceLabels[INSULIN_DURATION], value: insulinDuration ? `${insulinDuration} hrs` : '-' },
+    { setting: deviceLabels[INSULIN_DURATION] + (isControlIQ(settings) ? '*' : ''), value: insulinDuration ? `${insulinDuration} hrs` : '-' },
   ];
 
   if (isLoop(settings)) {

src/utils/settings/tandemData.js

@@ -14,8 +14,12 @@
  * not, you can obtain one from Tidepool Project at tidepool.org.
  * == BSD2 LICENSE ==
  */
+import i18next from 'i18next';
+
+import { isControlIQ } from '../device';
 import * as data from './data';
 
+const t = i18next.t.bind(i18next);
 /**
  * basalSchedules
  * @param  {Object} settings    object with basal schedule properties
@@ -61,31 +65,31 @@ function basalRows(schedule, settings, units) {
  * basalColumns
  * @private
  */
-function basalColumns(styles = {}, units) {
+function basalColumns(styles = {}, units, CIQAnnotation = false) {
   return [
     { key: 'start',
       label: 'Start time' },
     { key: 'rate',
       label: {
-        main: 'Basal Rates',
+        main: t('Basal Rates'),
         secondary: 'U/hr',
       },
       className: styles.basalScheduleHeader },
     { key: 'bgTarget',
       label: {
-        main: 'Target BG',
+        main: t('Target BG') + (CIQAnnotation ? '*' : ''),
         secondary: units,
       },
       className: styles.bolusSettingsHeader },
     { key: 'carbRatio',
       label: {
-        main: 'Carb Ratio',
+        main: t('Carb Ratio'),
         secondary: 'g/U',
       },
       className: styles.bolusSettingsHeader },
     { key: 'insulinSensitivity',
       label: {
-        main: 'Correction Factor',
+        main: t('Correction Factor'),
         secondary: `${units}/U`,
       },
       className: styles.bolusSettingsHeader },
@@ -106,7 +110,7 @@ export function basal(schedule, settings, units, styles = {}) {
     scheduleName: schedule.name,
     activeAtUpload: (schedule.name === settings.activeSchedule),
     title: scheduleLabel(schedule.name, settings.activeSchedule),
-    columns: basalColumns(styles, units),
+    columns: basalColumns(styles, units, isControlIQ(settings)),
     rows: basalRows(schedule, settings, units),
   };
 }

test/components/settings/Tandem.test.js

@@ -22,6 +22,8 @@ import { mount, shallow } from 'enzyme';
 
 import CollapsibleContainer from '../../../src/components/settings/common/CollapsibleContainer';
 import Tandem from '../../../src/components/settings/Tandem';
+import styles from '../../../src/components/settings/Tandem.css';
+import { formatClassesAsSelector } from '../../helpers/cssmodules';
 import { MGDL_UNITS, MMOLL_UNITS } from '../../../src/utils/constants';
 import { formatDecimalNumber } from '../../../src/utils/format';
 
@@ -190,4 +192,22 @@ describe('Tandem', () => {
       expect(insulinSettingsTable.find('tr').at(1).text()).contains('4:05 hrs');
     });
   });
+
+  describe('Tandem C-IQ annotation', () => {
+    let mounted;
+
+    before(() => {
+      props.pumpSettings = { ...flatrateData, deviceId: 'tandemCIQ123' };
+      props.bgUnits = MMOLL_UNITS;
+      props.openedSections = { [flatrateData.activeSchedule]: true };
+      mounted = mount(
+        <Tandem {...props} />
+      );
+    });
+
+    it('should render an annotation', () => {
+      const annotation = mounted.find(formatClassesAsSelector(styles.annotations)).hostNodes().at(0);
+      expect(annotation.text()).contains('Tandem Control-IQ uses its own preset');
+    });
+  });
 });

test/modules/print/SettingsPrintView.test.js

@@ -388,6 +388,12 @@ describe('SettingsPrintView', () => {
       // ensure it's rendering 2 tables for each schedule
       sinon.assert.callCount(Renderer.renderTable, schedules.length * 2);
     });
+
+    it('should render an annotation for Tandem C-IQ data', () => {
+      Renderer = createRenderer({ ...data.tandemFlatrate, deviceId: 'tandemCIQ123' }, opts, MGDL_UNITS);
+      Renderer.renderTandemProfiles();
+      sinon.assert.calledWithMatch(Renderer.doc.text, sinon.match('Tandem Control-IQ uses its own preset'));
+    });
   });
 
   describe('renderPumpSettings', () => {

test/utils/device.test.js

@@ -182,6 +182,23 @@ describe('device utility functions', () => {
     });
   });
 
+  describe('isControlIQ', () => {
+    it('should return `true` for a deviceId starting with tandemCIQ', () => {
+      const datum = { deviceId: 'tandemCIQ123456' };
+      expect(device.isControlIQ(datum)).to.be.true;
+    });
+
+    it('should return `false` for a deviceId not starting with tandemCIQ', () => {
+      const datum = { deviceId: 'tandem123456' };
+      expect(device.isControlIQ(datum)).to.be.false;
+    });
+
+    it('should return `false` for a datum without a deviceId', () => {
+      const datum = {};
+      expect(device.isControlIQ(datum)).to.be.false;
+    });
+  });
+
   describe('isLoop', () => {
     it('should return `true` for a matching pattern within `origin.name` for DIY Loop or Tidepool Loop', () => {
       const diyLoop = { origin: { name: 'com.loopkit.Loop' } };