From 26dfe80347b8ae7904fbf92b851ae9969f6b2c21 Mon Sep 17 00:00:00 2001
From: Dominik Hryshaiev <domhryshaiev@gmail.com>
Date: Sun, 26 Jan 2025 20:34:16 +0100
Subject: [PATCH] fix(habits): get_longest_streak db fn returns correct data
 (#152)

---
 src/components/calendar-month/NoteDialog.tsx  |  4 ++
 .../habit/habits-page/HabitLastEntryCell.tsx  | 23 ++++++--
 .../habits-page/HabitLongestStreakCell.tsx    | 36 ++++++++++---
 .../habit/habits-page/HabitsPage.tsx          | 20 +++++--
 .../habits-page/HabitsTotalEntriesCell.tsx    |  4 +-
 src/models/occurrence.model.ts                |  8 ++-
 src/services/occurrences.service.ts           | 16 +++---
 supabase/database.types.ts                    | 15 +++---
 ...36_rewrite_get_longest_streak_function.sql | 53 +++++++++++++++++++
 9 files changed, 140 insertions(+), 39 deletions(-)
 create mode 100644 supabase/migrations/20250126165836_rewrite_get_longest_streak_function.sql

diff --git a/src/components/calendar-month/NoteDialog.tsx b/src/components/calendar-month/NoteDialog.tsx
index 417ba3c..f926a55 100644
--- a/src/components/calendar-month/NoteDialog.tsx
+++ b/src/components/calendar-month/NoteDialog.tsx
@@ -45,6 +45,10 @@ const NoteDialog = ({ open, onClose, date }: NoteDialogProps) => {
     if (existingNote?.content && !content) {
       setContent(existingNote.content);
     }
+
+    return () => {
+      setContent('');
+    };
   }, [existingNote, content]);
 
   const handleSubmit: MouseEventHandler<HTMLButtonElement> = async (event) => {
diff --git a/src/components/habit/habits-page/HabitLastEntryCell.tsx b/src/components/habit/habits-page/HabitLastEntryCell.tsx
index 89c6557..72c8ee0 100644
--- a/src/components/habit/habits-page/HabitLastEntryCell.tsx
+++ b/src/components/habit/habits-page/HabitLastEntryCell.tsx
@@ -1,6 +1,12 @@
+import { Tooltip } from '@nextui-org/react';
 import { getLatestHabitOccurrenceTimestamp } from '@services';
 import { capitalizeFirstLetter } from '@utils';
-import { formatDistanceStrict, formatRelative, isThisWeek } from 'date-fns';
+import {
+  format,
+  formatDistanceStrict,
+  formatRelative,
+  isThisWeek,
+} from 'date-fns';
 import { enGB } from 'date-fns/locale';
 import React from 'react';
 
@@ -39,11 +45,18 @@ const HabitLastEntryCell = ({ id }: { id: number }) => {
   };
 
   return latestOccurrenceTimestamp ? (
-    <p>
-      {capitalizeFirstLetter(formatRelativeDate(latestOccurrenceTimestamp))}
-    </p>
+    <Tooltip
+      content={format(new Date(latestOccurrenceTimestamp), 'MMMM do, y')}
+      color="primary"
+      showArrow
+      offset={12}
+    >
+      <span>
+        {capitalizeFirstLetter(formatRelativeDate(latestOccurrenceTimestamp))}
+      </span>
+    </Tooltip>
   ) : (
-    <p className="text-gray-400">None</p>
+    <span className="text-gray-400">None</span>
   );
 };
 
diff --git a/src/components/habit/habits-page/HabitLongestStreakCell.tsx b/src/components/habit/habits-page/HabitLongestStreakCell.tsx
index 39aa0d7..d7ce09b 100644
--- a/src/components/habit/habits-page/HabitLongestStreakCell.tsx
+++ b/src/components/habit/habits-page/HabitLongestStreakCell.tsx
@@ -1,21 +1,41 @@
+import type { Streak } from '@models';
+import { Tooltip } from '@nextui-org/react';
 import { getLongestHabitStreak } from '@services';
 import React from 'react';
 
+const options: Intl.DateTimeFormatOptions = {
+  weekday: 'short',
+  year: 'numeric',
+  month: 'short',
+  day: 'numeric',
+};
+
+const dateTimeFormat = new Intl.DateTimeFormat('en', options);
+
 const HabitLongestStreakCell = ({ id }: { id: number }) => {
-  const [longestStreakLength, setLongestStreakLength] = React.useState<
-    number | null
-  >(null);
+  const [longestStreak, setLongestStreak] = React.useState<Streak>({
+    streakLength: null,
+    streakStart: null,
+    streakEnd: null,
+  });
 
   React.useEffect(() => {
-    getLongestHabitStreak(id).then((streakLength) => {
-      setLongestStreakLength(streakLength);
+    getLongestHabitStreak(id).then((longestStreak) => {
+      setLongestStreak(longestStreak);
     });
   }, [id]);
 
-  return longestStreakLength ? (
-    <p>{longestStreakLength} days</p>
+  const range = dateTimeFormat.formatRange(
+    new Date(longestStreak.streakStart || 0),
+    new Date(longestStreak.streakEnd || 0)
+  );
+
+  return longestStreak.streakLength ? (
+    <Tooltip content={range} color="primary" showArrow offset={12}>
+      <span>{longestStreak.streakLength} days</span>
+    </Tooltip>
   ) : (
-    <p className="text-gray-400">None</p>
+    <span className="text-gray-400">None</span>
   );
 };
 
diff --git a/src/components/habit/habits-page/HabitsPage.tsx b/src/components/habit/habits-page/HabitsPage.tsx
index df031c1..3d78104 100644
--- a/src/components/habit/habits-page/HabitsPage.tsx
+++ b/src/components/habit/habits-page/HabitsPage.tsx
@@ -28,7 +28,13 @@ import HabitLastEntryCell from './HabitLastEntryCell';
 import HabitLongestStreakCell from './HabitLongestStreakCell';
 import HabitsTotalEntriesCell from './HabitsTotalEntriesCell';
 
-const habitColumns = [
+type Column = {
+  key: string;
+  label: string;
+  align?: 'start' | 'center' | 'end';
+};
+
+const habitColumns: Column[] = [
   {
     key: 'icon',
     label: 'Icon',
@@ -56,10 +62,12 @@ const habitColumns = [
   {
     key: 'total-entries',
     label: 'Total entries',
+    align: 'center',
   },
   {
     key: 'actions',
     label: 'Actions',
+    align: 'end',
   },
 ];
 
@@ -101,7 +109,7 @@ const HabitsPage = () => {
 
   return (
     <>
-      <h1 className="mx-auto my-4 text-3xl font-bold text-gray-800 dark:text-gray-300">
+      <h1 className="mx-auto mb-4 mt-8 text-3xl font-bold text-gray-800 dark:text-gray-300">
         Your habits
       </h1>
       <Table
@@ -116,7 +124,9 @@ const HabitsPage = () => {
       >
         <TableHeader columns={habitColumns}>
           {(column) => (
-            <TableColumn key={column.key}>{column.label}</TableColumn>
+            <TableColumn key={column.key} align={column.align || 'start'}>
+              {column.label}
+            </TableColumn>
           )}
         </TableHeader>
         <TableBody emptyContent="No habits yet">
@@ -145,11 +155,11 @@ const HabitsPage = () => {
               <TableCell>
                 <HabitLongestStreakCell id={habit.id} />
               </TableCell>
-              <TableCell>
+              <TableCell align="center">
                 <HabitsTotalEntriesCell id={habit.id} />
               </TableCell>
               <TableCell>
-                <div className="flex gap-2">
+                <div className="flex justify-end gap-2">
                   <Tooltip content="Edit habit">
                     <Button
                       isIconOnly
diff --git a/src/components/habit/habits-page/HabitsTotalEntriesCell.tsx b/src/components/habit/habits-page/HabitsTotalEntriesCell.tsx
index 78b35b8..c46fe77 100644
--- a/src/components/habit/habits-page/HabitsTotalEntriesCell.tsx
+++ b/src/components/habit/habits-page/HabitsTotalEntriesCell.tsx
@@ -9,9 +9,9 @@ const HabitsTotalEntriesCell = ({ id }: { id: number }) => {
   }, [id]);
 
   return entriesCount ? (
-    <p>{entriesCount}</p>
+    <span>{entriesCount}</span>
   ) : (
-    <p className="text-gray-400">–</p>
+    <span className="text-gray-400">–</span>
   );
 };
 
diff --git a/src/models/occurrence.model.ts b/src/models/occurrence.model.ts
index 7914219..098ff58 100644
--- a/src/models/occurrence.model.ts
+++ b/src/models/occurrence.model.ts
@@ -1,11 +1,17 @@
 import type { CalendarDay } from '@helpers';
 import type { CamelCasedPropertiesDeep } from 'type-fest';
 
-import type { TablesInsert, Tables } from '../../supabase/database.types';
+import type {
+  TablesInsert,
+  Tables,
+  CompositeTypes,
+} from '../../supabase/database.types';
 
 import { type Habit } from './habit.model';
 import { type Trait } from './trait.model';
 
+export type Streak = CamelCasedPropertiesDeep<CompositeTypes<'streak_info'>>;
+
 type BaseOccurrence = CamelCasedPropertiesDeep<Tables<'occurrences'>>;
 
 type OccurrenceHabit = Pick<Habit, 'name' | 'iconPath'>;
diff --git a/src/services/occurrences.service.ts b/src/services/occurrences.service.ts
index b454753..5d43b95 100644
--- a/src/services/occurrences.service.ts
+++ b/src/services/occurrences.service.ts
@@ -1,5 +1,5 @@
 import { cacheOccurrences, occurrencesCache, supabaseClient } from '@helpers';
-import type { Occurrence, OccurrencesInsert } from '@models';
+import type { Occurrence, OccurrencesInsert, Streak } from '@models';
 import {
   transformClientEntity,
   transformServerEntities,
@@ -89,22 +89,18 @@ export const getLatestHabitOccurrenceTimestamp = async (habitId: number) => {
   return timestamp;
 };
 
-export const getLongestHabitStreak = async (habitId: number) => {
+export const getLongestHabitStreak = async (
+  habitId: number
+): Promise<Streak> => {
   const { error, data } = await supabaseClient.rpc('get_longest_streak', {
-    habit_identifier: habitId,
+    p_habit_id: habitId,
   });
 
   if (error) {
     throw new Error(error.message);
   }
 
-  if (!data?.length) {
-    return null;
-  }
-
-  const [{ streak_length: streakLength }] = data;
-
-  return streakLength;
+  return transformServerEntity(data);
 };
 
 export const getHabitTotalEntries = async (habitId: number) => {
diff --git a/supabase/database.types.ts b/supabase/database.types.ts
index 5570348..ecfd7f6 100644
--- a/supabase/database.types.ts
+++ b/supabase/database.types.ts
@@ -913,21 +913,20 @@ export type Database = {
     Functions: {
       get_longest_streak: {
         Args: {
-          habit_identifier: number
+          p_habit_id: number
         }
-        Returns: {
-          habit_id: number
-          streak_start: string
-          streak_end: string
-          streak_length: number
-        }[]
+        Returns: Database["public"]["CompositeTypes"]["streak_info"]
       }
     }
     Enums: {
       [_ in never]: never
     }
     CompositeTypes: {
-      [_ in never]: never
+      streak_info: {
+        streak_length: number | null
+        streak_start: number | null
+        streak_end: number | null
+      }
     }
   }
   storage: {
diff --git a/supabase/migrations/20250126165836_rewrite_get_longest_streak_function.sql b/supabase/migrations/20250126165836_rewrite_get_longest_streak_function.sql
new file mode 100644
index 0000000..1c282a7
--- /dev/null
+++ b/supabase/migrations/20250126165836_rewrite_get_longest_streak_function.sql
@@ -0,0 +1,53 @@
+DROP FUNCTION IF EXISTS get_longest_streak(integer);
+DROP TYPE IF EXISTS streak_info;
+
+CREATE TYPE streak_info AS (
+    streak_length integer,
+    streak_start date,
+    streak_end date
+);
+
+CREATE OR REPLACE FUNCTION get_longest_streak(p_habit_id integer)
+RETURNS streak_info AS $$
+DECLARE
+    result streak_info;
+BEGIN
+    WITH daily_occurrences AS (
+        SELECT DISTINCT DATE(to_timestamp(timestamp/1000)) as occurrence_date
+        FROM occurrences
+        WHERE habit_id = p_habit_id
+        ORDER BY occurrence_date
+    ),
+    streaks AS (
+        SELECT
+            occurrence_date,
+            occurrence_date - (ROW_NUMBER() OVER (ORDER BY occurrence_date))::integer AS streak_group
+        FROM daily_occurrences
+    ),
+    streak_lengths AS (
+        SELECT
+            streak_group,
+            COUNT(*) as streak_length,
+            MIN(occurrence_date) as streak_start,
+            MAX(occurrence_date) as streak_end
+        FROM streaks
+        GROUP BY streak_group
+    )
+    SELECT
+        streak_length,
+        streak_start,
+        streak_end
+    INTO result
+    FROM streak_lengths
+    ORDER BY streak_length DESC
+    LIMIT 1;
+
+    IF result.streak_length IS NULL THEN
+        result.streak_length := 0;
+        result.streak_start := NULL;
+        result.streak_end := NULL;
+    END IF;
+
+    RETURN result;
+END;
+$$ LANGUAGE plpgsql;
\ No newline at end of file