Release 1.55.0 to master

package.json

@@ -4,7 +4,7 @@
     "node": "20.8.0"
   },
   "packageManager": "yarn@3.6.4",
-  "version": "1.54.0",
+  "version": "1.55.0",
   "description": "Tidepool data visualization for diabetes device data.",
   "keywords": [
     "data visualization"

src/index.js

@@ -60,6 +60,8 @@ import {
   getLocalizedCeiling,
   getOffset,
   getTimezoneFromTimePrefs,
+  getChartDateBoundFormat,
+  CHART_DATE_BOUND_FORMAT,
 } from './utils/datetime';
 
 import { deviceName } from './utils/settings/data';
@@ -157,6 +159,8 @@ const utils = {
     getLocalizedCeiling,
     getOffset,
     getTimezoneFromTimePrefs,
+    getChartDateBoundFormat,
+    CHART_DATE_BOUND_FORMAT,
   },
   stat: {
     bankersRound,

src/utils/DataUtil.js

@@ -1480,9 +1480,14 @@ export class DataUtil {
           ps => ps.time <= latestPumpData.time
         );
       } else {
+        // Clock drift on user's device may cause pumpSettings datum to have LATER timestamp than upload
+        // datum. The maximum time deviation that the Uploader allows between the user's device and Tidepool
+        // server time is 15 minutes, so we search up to 15 minutes into the future for the pumpSettings datum
+        const UPLOADER_TIME_DEVIATION_TOLERANCE = 15 * MS_IN_MIN;
+
         pumpSettingsForUpload = _.filter(
           pumpSettingsForUpload,
-          ps => ps.time <= latestPumpUpload.time
+          ps => ps.time <= (latestPumpUpload.time + UPLOADER_TIME_DEVIATION_TOLERANCE)
         );
       }
 

src/utils/basics/data.js

@@ -405,7 +405,7 @@ export function basicsText(patient, data, stats, aggregations, copyAsTextMetadat
   const textUtil = new utils.TextUtil(patient, endpoints.range, timePrefs, copyAsTextMetadata);
 
   let basicsString = textUtil.buildDocumentHeader('Basics');
-  basicsString += textUtil.buildDocumentDates();
+  basicsString += textUtil.buildDocumentDates({ showPartialDates: true });
 
   basicsString += textUtil.buildTextLine(t('Days with no insulin data have been excluded from calculations'));
 

src/utils/datetime.js

@@ -166,7 +166,9 @@ export function formatDiagnosisDate(patient) {
  * formatDateRange
  * @param {String|Date} startDate - A moment-compatible date object or string
  * @param {String|Date} endDate - A moment-compatible date object or string
- * @param {String} format - Optional. The moment format string to parse startDate and endDate with
+ * @param {String} dateParseFormat - Optional. The moment format string to parse startDate and endDate with
+ *
+ * @return {String} formatted date range for display
  */
 export function formatDateRange(startDate, endDate, dateParseFormat, monthFormat = 'MMM') {
   const start = moment.utc(startDate, dateParseFormat);
@@ -182,6 +184,36 @@ export function formatDateRange(startDate, endDate, dateParseFormat, monthFormat
   return formattedRange;
 }
 
+export const CHART_DATE_BOUND_FORMAT = {
+  DATE_AND_TIME: 'MMM D, YYYY (h:mm A)',
+  DATE_ONLY: 'MMM D, YYYY',
+};
+
+/**
+ * getChartDateBoundFormat
+ * @param {Object} startDate - a moment time object
+ * @param {Object} endDate - a moment time object
+ *
+ * @return {String} a moment time format (e.g 'MMM D, YYYY')
+ */
+export function getChartDateBoundFormat(startDate, endDate) {
+  if (!endDate) return CHART_DATE_BOUND_FORMAT.DATE_ONLY;
+
+  const isStartDateMidnight = (startDate?.hours() === 0 && startDate?.minutes() === 0) ||
+                              (startDate?.hours() === 23 && startDate?.minutes() >= 59);
+
+  const isEndDateMidnight = (endDate?.hours() === 0 && endDate?.minutes() === 0) ||
+                            (endDate?.hours() === 23 && endDate?.minutes() >= 59);
+
+  const isMatchingDateBounds = isStartDateMidnight && isEndDateMidnight;
+
+  if (!isMatchingDateBounds) {
+    return CHART_DATE_BOUND_FORMAT.DATE_AND_TIME;
+  }
+
+  return CHART_DATE_BOUND_FORMAT.DATE_ONLY;
+}
+
 /**
  * formatDuration
  * @param {Number} duration - positive integer duration in milliseconds

src/utils/text/TextUtil.js

@@ -1,18 +1,17 @@
 import _ from 'lodash';
 import table from 'text-table';
 import i18next from 'i18next';
+import moment from 'moment-timezone';
 
 import {
   formatBirthdate,
   formatCurrentDate,
-  formatDateRange,
   formatDiagnosisDate,
-  getOffset,
   getTimezoneFromTimePrefs,
+  getChartDateBoundFormat,
+  CHART_DATE_BOUND_FORMAT,
 } from '../datetime';
 
-import { MS_IN_MIN } from '../constants';
-
 import { getPatientFullName } from '../misc';
 
 const t = i18next.t.bind(i18next);
@@ -60,17 +59,29 @@ export class TextUtil {
     );
   };
 
-  buildDocumentDates = () => {
+  buildDocumentDates = (opts = {}) => {
+    const { showPartialDates = false } = opts;
+
     const timezone = getTimezoneFromTimePrefs(this.timePrefs);
 
-    // endpoint is exclusive, so need to subtract a millisecond from formatted range end date
-    let start = this.endpoints[0];
-    let end = this.endpoints[1] - 1;
+    const [start, end] = this.endpoints;
+    const startDate = moment.utc(start).tz(timezone);
+    const endDate = moment.utc(end).tz(timezone);
+
+    const dtMask = showPartialDates
+      ? getChartDateBoundFormat(startDate, endDate)
+      : CHART_DATE_BOUND_FORMAT.DATE_ONLY;
+
+    // When showing dates only, we subtract 1ms from the end date because the end timestamp
+    // represents midnight of the following day, but we want to display the last included day.
+    // E.g. Jan 10 (12:00 AM) - Jan 20 (12:00 AM) should render as Jan 10 - Jan 19
+    if (dtMask === CHART_DATE_BOUND_FORMAT.DATE_ONLY) {
+      endDate.subtract(1, 'ms');
+    }
 
-    start = start - getOffset(start, timezone) * MS_IN_MIN;
-    end = end - getOffset(end, timezone) * MS_IN_MIN;
+    const formattedRange = `${startDate.format(dtMask)} - ${endDate.format(dtMask)}`;
 
-    return `\nReporting Period: ${formatDateRange(start, end)}\n`;
+    return `\n${t('Reporting Period')}: ${formattedRange}\n`;
   };
 
   buildTextLine = (text = '') => (_.isPlainObject(text) ? `${text.label}: ${text.value}\n` : `${text}\n`);

src/utils/trends/data.js

@@ -103,7 +103,7 @@ export function trendsText(patient, data, stats, chartPrefs, copyAsTextMetadata)
   const textUtil = new utils.TextUtil(patient, endpoints.range, timePrefs, copyAsTextMetadata);
   let trendsString = textUtil.buildDocumentHeader('Trends');
 
-  trendsString += textUtil.buildDocumentDates();
+  trendsString += textUtil.buildDocumentDates({ showPartialDates: true });
 
   const excludedDays = _.map(_.keys(_.pickBy(chartPrefs.activeDays, day => day === false)), _.capitalize).join(', ');
   if (excludedDays.length) trendsString += textUtil.buildTextLine({ label: 'Excluded Days', value: excludedDays });

test/utils/DataUtil.test.js

@@ -3746,7 +3746,7 @@ describe('DataUtil', () => {
       expect(dataUtil.latestPumpUpload.settings.uploadId).to.equal('upload-A');
     });
 
-    it('should not select pumpSettings more recent than the latest pump data used to determine the upload', () => {
+    it('should not select pumpSettings with timestamps more than 15 minutes later than the latest upload', () => {
       const uploadA = { ...uploadData[0], uploadId: 'upload-A' };
 
       const basal = {
@@ -3765,7 +3765,7 @@ describe('DataUtil', () => {
       const pumpSettingsNew = {
         type: 'pumpSettings',
         uploadId: 'upload-A',
-        time: basal.time + 1000, // newer than basal
+        time: basal.time + (16 * MS_IN_MIN), // 16 minutes
         id: 'ps-new',
       };
 
@@ -3793,6 +3793,53 @@ describe('DataUtil', () => {
       expect(dataUtil.latestPumpUpload.settings.id).to.equal('ps-old');
     });
 
+    it('should select pumpSettings with timestamps up to 15 minutes later than the latest upload', () => {
+      const uploadA = { ...uploadData[0], uploadId: 'upload-A' };
+
+      const basal = {
+        type: 'basal',
+        time: Date.parse(uploadA.deviceTime) + 1000,
+        uploadId: 'upload-A',
+      };
+
+      const pumpSettingsOld = {
+        type: 'pumpSettings',
+        uploadId: 'upload-A',
+        time: basal.time - 1000,
+        id: 'ps-old',
+      };
+
+      const pumpSettingsNew = {
+        type: 'pumpSettings',
+        uploadId: 'upload-A',
+        time: basal.time + (12 * MS_IN_MIN), // 12 minutes
+        id: 'ps-new',
+      };
+
+      initDataUtil([
+        uploadA,
+        basal,
+        pumpSettingsOld,
+        pumpSettingsNew,
+      ]);
+
+      dataUtil.pumpSettingsDatumsByIdMap = {
+        [pumpSettingsOld.id]: pumpSettingsOld,
+        [pumpSettingsNew.id]: pumpSettingsNew,
+      };
+
+      dataUtil.latestDatumByType = {
+        ...dataUtil.latestDatumByType,
+        basal,
+      };
+
+      dataUtil.setLatestPumpUpload();
+
+      expect(dataUtil.latestPumpUpload).to.be.an('object');
+      expect(dataUtil.latestPumpUpload.settings).to.be.an('object');
+      expect(dataUtil.latestPumpUpload.settings.id).to.equal('ps-new');
+    });
+
     it('should fall back to traditional pump upload logic when no pumpSettings data is available', () => {
       // Clear any existing pumpSettings data
       delete dataUtil.latestDatumByType.pumpSettings;

test/utils/text/TextUtil.test.js

@@ -129,9 +129,33 @@ describe('TextUtil', () => {
   });
 
   describe('buildDocumentDates', () => {
-    it('should print the document reporting period', () => {
+    it('should print the dates only when bounds are midnight', () => {
+      const result = textUtil.buildDocumentDates({ showPartialDates: true });
+
+      expect(result).to.equal('\nReporting Period: Feb 1, 2019 - Feb 19, 2019\n');
+    });
+
+    it('should print the dates and times when bounds are not midnight', () => {
+      const testEndpoints = [
+        Date.parse('2019-02-01T08:00:00.000Z'), // Feb 01 @ 3 AM
+        Date.parse('2019-02-20T08:00:00.000Z'), // Feb 20 @ 3 AM
+      ];
+      textUtil = new TextUtil(patient, testEndpoints, timePrefs, copyAsTextMetadata);
+
+      const result = textUtil.buildDocumentDates({ showPartialDates: true });
+
+      expect(result).to.equal('\nReporting Period: Feb 1, 2019 (3:00 AM) - Feb 20, 2019 (3:00 AM)\n');
+    });
+
+    it('should print the document reporting period (with inclusive end date)', () => {
+      const testEndpoints = [
+        Date.parse('2019-02-01T08:00:00.000Z'), // Feb 01 @ 3 AM
+        Date.parse('2019-02-20T08:00:00.000Z'), // Feb 20 @ 3 AM
+      ];
+      textUtil = new TextUtil(patient, testEndpoints, timePrefs, copyAsTextMetadata);
       const result = textUtil.buildDocumentDates();
-      expect(result).to.equal('\nReporting Period: Feb 1 - Feb 19, 2019\n');
+
+      expect(result).to.equal('\nReporting Period: Feb 1, 2019 - Feb 20, 2019\n');
     });
   });