feat: metric digest granular date formatting

sweetr-dev · Dec 6, 2024 · 5ed4530 · 5ed4530
1 parent c8dda68
commit 5ed4530
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 18 deletions.
diff --git a/apps/api/src/app/digests/services/digest-team-metrics.service.ts b/apps/api/src/app/digests/services/digest-team-metrics.service.ts
@@ -12,19 +12,14 @@ import {
   DigestMetricType,
   MetricLineElements,
 } from "./digest-team-metrics.types";
-import {
-  endOfDay,
-  format,
-  millisecondsToHours,
-  startOfDay,
-  sub,
-} from "date-fns";
+import { DurationUnit, endOfDay, format, startOfDay, sub } from "date-fns";
 import { Frequency } from "@prisma/client";
 import * as averageMetricsService from "../../metrics/services/average-metrics.service";
-import { AverageMetricFilters } from "../../metrics/services/average-metrics.service";
 import { all, capitalize } from "radash";
 import { getPullRequestSize } from "../../github/services/github-pull-request-tracking.service";
 import { UTCDate } from "@date-fns/utc";
+import { formatMsDuration } from "../../../lib/date";
+import { AverageMetricFilters } from "../../metrics/services/average-metrics.types";
 
 export const sendTeamMetricsDigest = async (digest: DigestWithRelations) => {
   const { slackClient } = await getWorkspaceSlackClient(digest.workspaceId);
@@ -133,6 +128,15 @@ const getDigestMessageBlocks = async (
 ): Promise<AnyBlock[]> => {
   const { latest, previous } = getChartFilters(digest);
 
+  const dateFormatter: DurationUnit[] = [
+    "years",
+    "months",
+    "weeks",
+    "days",
+    "hours",
+    "minutes",
+  ];
+
   return [
     {
       type: "header",
@@ -189,7 +193,7 @@ const getDigestMessageBlocks = async (
           type: "rich_text_section",
           elements: getMetricLineElements({
             label: "⏱️ PR Cycle Time",
-            value: `${millisecondsToHours(Number(metrics.cycleTime.latest.value))} hours`,
+            value: `${formatMsDuration(Number(metrics.cycleTime.latest.value), dateFormatter)}`,
             change: metrics.cycleTime.change,
           }),
         },
@@ -200,29 +204,32 @@ const getDigestMessageBlocks = async (
               type: "rich_text_section",
               elements: getMetricLineElements({
                 label: "Time to First Review",
-                value: `${millisecondsToHours(
-                  Number(metrics.timeForFirstReview.latest.value)
-                )} hours`,
+                value: `${formatMsDuration(
+                  Number(metrics.timeForFirstReview.latest.value),
+                  dateFormatter
+                )}`,
                 change: metrics.timeForFirstReview.change,
               }),
             },
             {
               type: "rich_text_section",
               elements: getMetricLineElements({
                 label: "Time to Approve",
-                value: `${millisecondsToHours(
-                  Number(metrics.timeForApproval.latest.value)
-                )} hours`,
+                value: `${formatMsDuration(
+                  Number(metrics.timeForApproval.latest.value),
+                  dateFormatter
+                )}`,
                 change: metrics.timeForApproval.change,
               }),
             },
             {
               type: "rich_text_section",
               elements: getMetricLineElements({
                 label: "Time to Merge",
-                value: `${millisecondsToHours(
-                  Number(metrics.timeToMerge.latest.value)
-                )} hours`,
+                value: `${formatMsDuration(
+                  Number(metrics.timeToMerge.latest.value),
+                  dateFormatter
+                )}`,
                 change: metrics.timeToMerge.change,
               }),
             },

diff --git a/apps/api/src/lib/date.ts b/apps/api/src/lib/date.ts
@@ -1,7 +1,10 @@
 import {
   differenceInBusinessDays,
   differenceInMilliseconds,
+  DurationUnit,
   endOfDay,
+  formatDuration,
+  intervalToDuration,
   isSameDay,
   isWeekend,
   parseISO,
@@ -14,6 +17,18 @@ export const parseNullableISO = (
   date: string | null | undefined
 ): Date | null => (date ? parseISO(date) : null);
 
+export const formatMsDuration = (
+  durationInMs: number,
+  format?: DurationUnit[]
+) => {
+  const duration = intervalToDuration({
+    start: new Date(Date.now() - durationInMs),
+    end: new Date(),
+  });
+
+  return formatDuration(duration, { format, delimiter: ", " });
+};
+
 export const differenceInBusinessMilliseconds = (
   startDate: Date,
   endDate: Date