From e472d918cf1ef51e7b3c1e23cfc2360e1a0fcd92 Mon Sep 17 00:00:00 2001
From: Michael Lange <dingoeatingfuzz@gmail.com>
Date: Wed, 30 May 2018 14:30:45 -0700
Subject: [PATCH] Account for the 0 case in format-duration

---
 ui/app/utils/format-duration.js             | 21 +++++++++++++++++++--
 ui/tests/unit/utils/format-duration-test.js |  5 +++++
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/ui/app/utils/format-duration.js b/ui/app/utils/format-duration.js
index 2ed5f238d..2f8ea1b72 100644
--- a/ui/app/utils/format-duration.js
+++ b/ui/app/utils/format-duration.js
@@ -15,6 +15,9 @@ const allUnits = [
 export default function formatDuration(duration = 0, units = 'ns') {
   const durationParts = {};
 
+  // Moment only handles up to millisecond precision.
+  // Microseconds and nanoseconds need to be handled first,
+  // then Moment can take over for all larger units.
   if (units === 'ns') {
     durationParts.nanoseconds = duration % 1000;
     durationParts.microseconds = Math.floor((duration % 1000000) / 1000);
@@ -24,8 +27,13 @@ export default function formatDuration(duration = 0, units = 'ns') {
     duration = Math.floor(duration / 1000);
   }
 
-  const momentDuration = moment.duration(duration, ['ns', 'mms'].includes(units) ? 'ms' : units);
+  let momentUnits = units;
+  if (units === 'ns' || units === 'mms') {
+    momentUnits = 'ms';
+  }
+  const momentDuration = moment.duration(duration, momentUnits);
 
+  // Get the count of each time unit that Moment handles
   allUnits
     .filterBy('inMoment')
     .mapBy('name')
@@ -33,6 +41,8 @@ export default function formatDuration(duration = 0, units = 'ns') {
       durationParts[unit] = momentDuration[unit]();
     });
 
+  // Format each time time bucket as a string
+  // e.g., { years: 5, seconds: 30 } -> [ '5 years', '30s' ]
   const displayParts = allUnits.reduce((parts, unitType) => {
     if (durationParts[unitType.name]) {
       const count = durationParts[unitType.name];
@@ -43,5 +53,12 @@ export default function formatDuration(duration = 0, units = 'ns') {
     return parts;
   }, []);
 
-  return displayParts.join(' ');
+  if (displayParts.length) {
+    return displayParts.join(' ');
+  }
+
+  // When the duration is 0, show 0 in terms of `units`
+  const unitTypeForUnits = allUnits.findBy('suffix', units);
+  const suffix = unitTypeForUnits.pluralizable ? units.pluralize() : units;
+  return `0${unitTypeForUnits.pluralizable ? ' ' : ''}${suffix}`;
 }
diff --git a/ui/tests/unit/utils/format-duration-test.js b/ui/tests/unit/utils/format-duration-test.js
index 1e38c222a..c4867590f 100644
--- a/ui/tests/unit/utils/format-duration-test.js
+++ b/ui/tests/unit/utils/format-duration-test.js
@@ -21,3 +21,8 @@ test('The units option allows for units coarser than nanoseconds', function(asse
   assert.equal(formatDuration(1200, 's'), expectation2, expectation2);
   assert.equal(formatDuration(32, 'd'), expectation3, expectation3);
 });
+
+test('When duration is 0, 0 is shown in terms of the units provided to the function', function(assert) {
+  assert.equal(formatDuration(0), '0ns', 'formatDuration(0) -> 0ns');
+  assert.equal(formatDuration(0, 'year'), '0 years', 'formatDuration(0, "year") -> 0 years');
+});