add "Daily" frequency for email notifications (#1925)

* add "Daily" frequency for email notifications

* add tests for daily digest email

* convert default email digest frequecy to weekly

* fix tests

* remove stale console.log

* remove stale import

Author: jicruz96

components/EditProfilePage/EditProfilePage.tsx

@@ -3,7 +3,7 @@ import Router from "next/router"
 import { useState } from "react"
 import { TabPane } from "react-bootstrap"
 import TabContainer from "react-bootstrap/TabContainer"
-import { useAuth } from "../auth"
+import { Frequency, useAuth } from "../auth"
 import { Container, Row, Spinner } from "../bootstrap"
 import {
   Profile,
@@ -87,16 +87,16 @@ export function EditProfileForm({
 
   const [formUpdated, setFormUpdated] = useState(false)
   const [settingsModal, setSettingsModal] = useState<"show" | null>(null)
-  const [notifications, setNotifications] = useState<
-    "Weekly" | "Monthly" | "None"
-  >(notificationFrequency ? notificationFrequency : "Monthly")
+  const [notifications, setNotifications] = useState<Frequency>(
+    notificationFrequency || "Weekly"
+  )
   const [isProfilePublic, setIsProfilePublic] = useState<false | true>(
     isPublic ? isPublic : false
   )
 
   const onSettingsModalOpen = () => {
     setSettingsModal("show")
-    setNotifications(notificationFrequency ? notificationFrequency : "Monthly")
+    setNotifications(notificationFrequency || "Weekly")
     setIsProfilePublic(isPublic ? isPublic : false)
   }
 

components/EditProfilePage/ProfileSettingsModal.tsx

@@ -15,7 +15,7 @@ type Props = Pick<ModalProps, "show" | "onHide"> & {
   role: Role
   setIsProfilePublic: Dispatch<SetStateAction<false | true>>
   notifications: Frequency
-  setNotifications: Dispatch<SetStateAction<"Weekly" | "Monthly" | "None">>
+  setNotifications: Dispatch<SetStateAction<Frequency>>
   onSettingsModalClose: () => void
 }
 

components/Newsfeed/Newsfeed.tsx

@@ -2,7 +2,7 @@ import ErrorPage from "next/error"
 import { Timestamp } from "firebase/firestore"
 import { useTranslation } from "next-i18next"
 import { useEffect, useState } from "react"
-import { useAuth } from "../auth"
+import { Frequency, useAuth } from "../auth"
 import { Col, Row, Spinner } from "../bootstrap"
 import { Profile, useProfile, usePublicProfile } from "../db"
 import { NotificationProps, Notifications } from "./NotificationProps"
@@ -142,9 +142,9 @@ export default function Newsfeed() {
     }: Profile = profile
 
     const [settingsModal, setSettingsModal] = useState<"show" | null>(null)
-    const [notifications, setNotifications] = useState<
-      "Weekly" | "Monthly" | "None"
-    >(notificationFrequency ? notificationFrequency : "Weekly")
+    const [notifications, setNotifications] = useState<Frequency>(
+      notificationFrequency ? notificationFrequency : "Weekly"
+    )
     const [isProfilePublic, setIsProfilePublic] = useState<false | true>(
       isPublic ? isPublic : false
     )

components/ProfilePage/ProfileHeader.tsx

@@ -1,7 +1,7 @@
 import { useTranslation } from "next-i18next"
 import { useContext, useState } from "react"
 import { useMediaQuery } from "usehooks-ts"
-import { useAuth } from "../auth"
+import { Frequency, useAuth } from "../auth"
 import { Profile, useProfile } from "../db"
 import { EditProfileButton, ProfileButtons } from "./ProfileButtons"
 import { Header, ProfileDisplayName } from "./StyledProfileComponents"
@@ -30,16 +30,16 @@ export const ProfileHeader = ({
   }: Profile = profile
 
   const [settingsModal, setSettingsModal] = useState<"show" | null>(null)
-  const [notifications, setNotifications] = useState<
-    "Weekly" | "Monthly" | "None"
-  >(notificationFrequency ? notificationFrequency : "Monthly")
+  const [notifications, setNotifications] = useState<Frequency>(
+    notificationFrequency || "Weekly"
+  )
   const [isProfilePublic, setIsProfilePublic] = useState<false | true>(
     isPublic ? isPublic : false
   )
 
   const onSettingsModalOpen = () => {
     setSettingsModal("show")
-    setNotifications(notificationFrequency ? notificationFrequency : "Monthly")
+    setNotifications(notificationFrequency || "Weekly")
     setIsProfilePublic(isPublic ? isPublic : false)
   }
 

components/auth/hooks.test.ts

@@ -26,7 +26,7 @@ describe.skip("useCreateUserWithEmailAndPassword", () => {
       fullName: info.fullName,
       role: "user",
       public: false,
-      notificationFrequency: "Monthly",
+      notificationFrequency: "Weekly",
       email: info.email
     })
   })

functions/src/auth/types.ts

@@ -24,7 +24,7 @@ export const Claim = Record({
 })
 export type Claim = Static<typeof Claim>
 
-export const Frequency = Union(L("Weekly"), L("Monthly"), L("None"))
+export const Frequency = Union(L("Weekly"), L("Monthly"), L("Daily"), L("None"))
 export type Frequency = Static<typeof Frequency>
 
 export const OrgCategories = [

functions/src/email/helpers.ts

@@ -1,3 +1,4 @@
+import { Frequency } from "../auth/types"
 import { BillDigest } from "../notifications/emailTypes"
 
 export function addCounts() {
@@ -35,7 +36,7 @@ export function minusFour(value: number) {
   return result
 }
 
-export function noUpdatesFormat(aString: string) {
+export function noUpdatesFormat(aString: Frequency) {
   let result = ""
   switch (aString) {
     case "Monthly":

functions/src/notifications/deliverNotifications.ts

@@ -275,6 +275,6 @@ const renderToHtmlString = (digestData: NotificationEmailDigest) => {
 
 // Firebase Functions
 export const deliverNotifications = functions.pubsub
-  .schedule("47 9 1 * 2") // 9:47 AM on the first day of the month and on Tuesdays
+  .schedule("47 9 * * *") // 9:47 AM every day
   .timeZone("America/New_York")
   .onRun(deliverEmailNotifications)

functions/src/notifications/helpers.test.ts

@@ -79,6 +79,18 @@ describe("getNextDigestAt", () => {
     )
     consoleSpy.mockRestore()
   })
+
+  it("should return the day after for daily frequency", () => {
+    // Set a fixed date: March 15, 2025
+    const fixedDate = new Date(2025, 2, 15)
+    // Next day.
+    const expectedDate = new Date(2025, 2, 16)
+
+    jest.setSystemTime(fixedDate)
+
+    const result = getNextDigestAt("Daily")
+    expect(result).toEqual(Timestamp.fromDate(expectedDate))
+  })
 })
 
 describe("getNotificationStartDate", () => {
@@ -97,4 +109,12 @@ describe("getNotificationStartDate", () => {
     const result = getNotificationStartDate("Monthly", fixedDate)
     expect(result).toEqual(expectedDate)
   })
+
+  it("should return the previous day for daily frequency", () => {
+    const fixedDate = Timestamp.fromDate(new Date(2025, 2, 1))
+    const expectedDate = Timestamp.fromDate(new Date(2025, 1, 28))
+
+    const result = getNotificationStartDate("Daily", fixedDate)
+    expect(result).toEqual(expectedDate)
+  })
 })

functions/src/notifications/helpers.ts

@@ -6,7 +6,8 @@ import {
   setDate,
   previousTuesday,
   nextTuesday,
-  subMonths
+  subMonths,
+  addDays
 } from "date-fns"
 
 import { JSDOM } from "jsdom"
@@ -23,6 +24,9 @@ export const getNextDigestAt = (notificationFrequency: Frequency) => {
       const nextMonthFirst = setDate(addMonths(now, 1), 1)
       nextDigestAt = Timestamp.fromDate(nextMonthFirst)
       break
+    case "Daily":
+      nextDigestAt = Timestamp.fromDate(addDays(now, 1))
+      break
     case "None":
       nextDigestAt = null
       break
@@ -45,6 +49,8 @@ export const getNotificationStartDate = (
       const firstOfMonth = setDate(now.toDate(), 1)
       const previousFirstOfMonth = subMonths(firstOfMonth, 1)
       return Timestamp.fromDate(previousFirstOfMonth)
+    case "Daily":
+      return Timestamp.fromDate(addDays(now.toDate(), -1))
     // We can safely fallthrough here because if the user has no notification frequency set,
     // we won't even send a notification
     default: